You will use the same Toast API endpoints across regions, but certain configurations and fields may vary. When offering your integration to new regions, use the guidance below to ensure your integration functions correctly.
|
Note |
|
Toast operates in Australia, Canada, Ireland, the United Kingdom, and the United States. Other locations may be added at a later time. |
To view restaurant location configuration information, send a
GET request to the /restaurants
endpoint of the restaurants API. The following values change depending on
the geographic region of a location:
-
In the
Locationobject, theadministrativeAreavalue is the name of the geographical region of the location. -
In the
Generalobject, thecurrencyCodevalue is the ISO-4217 currency code used at the location. Any monetary value returned from any Toast API will use thecurrencyCode.
When submitting orders to the orders API, consider regional variations in formatting.
-
If you include guest information when you create orders using the orders API, include a
phoneCountryCodevalue in theCustomerobject for non-US phone numbers. -
When updating the
DeliveryInfoobject in the orders API, use the guidance in the Orders developer guide to determine whether to use thestateoradministrativeAreavalue.
The Toast platform cannot process credit card payments in regions outside of the United States. Instead, use an alternative payment type when placing an order using the orders API.
When adding or updating employee phone number information in the
labor API, ensure that the phoneNumberCountryCode
value is accurate for the region of the employee's location.
If you have a loyalty integration, ensure that your integration can
accept the appropriate phone number length for LOYALTY_SEARCH
transactions.