DATE:
AUTHOR:
The Toast - API team
Orders API Objects, fields, and values

New administrativeArea value in orders API delivery addresses

DATE:
AUTHOR: The Toast - API team

The orders API DeliveryInfo object now includes an administrativeArea value. The administrativeArea value indicates the geographic or government division, larger than a city/town, for the delivery destination. For example, the name of a province, county, or region might be the administrativeArea value for a delivery address.

The new administrativeArea value is optional, not all delivery addresses include a regional area name other than a city. If you include the state value, you would not include an administrativeArea.

Use the following rules to choose either the new administrativeArea value or the existing state value for a delivery address when you create orders in the orders API.

  • If the country for the delivery address is the United States (U.S.) or Canada, use the state value for the U.S. state or Canadian province. Omit the administrativeArea value.

  • If the country for the delivery address is not the U.S. or Canada (anywhere else in the world), use the administrativeArea value. Include the string XX in the required state value.

Powered by LaunchNotes