On This Page
REST API

orderInformation. shipTo.locality

City of the shipping address.
When the field is not included in the request and the service defaults to the
orderInformation.billTo.locality
 field, and the value for this field is left blank in the Tax Detail Report.
Tax Calculation
The value in this field is used for tax calculations only when the
orderInformation.shipTo.administrativeArea
 and
orderInformation.shipTo.country
 API fields are present.
This field is available only on these processors:
AIBMS
,
American Express
,
American Express Direct
,
Asia, Middle East, and Africa Gateway
,
Atos
,
Bank of America ACH
,
Banque de France et Tresor Public
,
Barclays
,
BNP Paribas France
,
Chase Paymentech Solutions
,
Chase Paymentech Tandem
,
China UnionPay
,
Cielo
,
Citibank India
,
Comercio Latino
,
Credit Mutuel-CIC
,
Cybersource ACH Service
,
Cybersource Latin American Processing
,
Elavon
,
Elavon Americas
,
FDC Compass
,
FDC Germany
,
FDC Nashville Global
,
FDI Australia
,
FDMS Nashville
,
FDMS South
,
First Data Merchant Solutions
,
Getnet
,
GPN
,
HBoS
,
HSBC
,
JCN Gateway
,
Korean Cyber Payments
,
Lloyds-OmniPay
,
LloydsTSB Cardnet
,
Lynk
,
Moneris
,
OmniPay Direct
,
PayEase China Processing
,
Prosa
,
RBS WorldPay Atlanta
,
Rede
,
RuPay
,
SIX
,
Software Express
,
Streamline
,
TeleCheck
,
UATP
,
ValueLink
,
Vero
,
TSYS Acquiring Solutions
,
Visa Platform Connect
,
Worldpay VAP
,
Wells Fargo ACH
.

Specifications

  • Data Type:
     String
  • Data Length:
     40

Mapping Information

  • REST API Field:
    orderInformation.shipTo.locality
  • SCMP API Field:
    ship_to_city
  • Simple Order API Field:
    shipTo_city