On This Page
REST API

orderInformation. shippingDetails.shipFromPostalCode

Postal code for the address from which the goods are shipped, which is used to establish nexus, and which is used to determine tax rules and rates applied to the transaction based on sourcing.
The default value is the postal code associated with your account. You can use this field to override the default setting. This
line-item
 field overrides the corresponding request-level field. The postal code must consist of 5 to 9 digits.
  • Canadian postal code
    : The six-digit format is
    [alpha][numeric][alpha][space] [numeric][alpha][numeric]
    Example: A1B 2C3
  • US postal code
    : The nine-digit format is
    [5 digits][dash][4 digits]
    .
    Example: 12345-6789
This field is available only on the
American Express Direct
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
FDMS South
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
 processors.
These processors have specific requirements:
American Express Direct
Before the postal code id sent to the processor, all non-alphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side.
Visa Platform Connect
This field is used to determine the nexus. The default is the postal code associated with your account. The postal code must consist of 5 to 9 digits.
Worldpay VAP
This field is used to determine the nexus. The default is the postal code associated with your account. The postal code must consist of 5 to 9 digits.

Specifications

  • Data Type:
     String
  • Data Length:
     10

Mapping Information

  • REST API Field:
    orderInformation.shippingDetails.shipFromPostalCode
  • SCMP API Field:
    ship_from_zip
  • Simple Order API Fields:
    • item_#_ shipFromPostalCode
    • shipFrom_postalCode

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.
  • American Express Direct
    :
     Does not apply
  • Chase Paymentech Solutions
    :
     Ship From ZIP/Postal Code
  • Elavon Americas
    :
     Ship From Postal / ZIP Code
  • FDC Compass
    :
     Ship From ZIP/Postal Code
  • FDC Nashville Global
    :
     Ship From ZIP
  • FDMS South
    :
     Does not apply
  • GPN
    :
     Ship From Postal/ZIP Code
  • OmniPay Direct
    :
     Ship From Postal / ZIP Code
  • RBS WorldPay Atlanta
    :
     Origin ZIP
  • TSYS Acquiring Solutions
    :
     Ship From Postal/ZIP Code
  • Visa Platform Connect
    :
     shipFromAddress
  • Worldpay VAP
    :
     shipFromPostalCode