Ship-to address (header and line levels)

Element type: Required

Endpoints/models used: AddressesModel

Your integration must provide a way for users to enter a ship-to(destination) address at the header or line levels of a transaction. If specified at the header level, the address applies to all lines on the transaction; if specified at the line level, the address applies only to that line in the transaction. For users, this is an optional field because not all transactions will be shipped to a location.

A ship-to address is added to your application using the shipTo field in the AddressesModel at the header or line level.

View example:

{
  "addresses": {
    "shipFrom": {
      "line1": "2000 Main Street",
      "city": "Irvine",
      "region": "CA",
      "country": "US",
      "postalCode": "92614"
    },
    "shipTo": {
      "line1": "1100 2nd Ave",
      "city": "Seattle",
      "region": "WA",
      "country": "US",
      "postalCode": "98101"
    }
  },
  ...
}