GuidesAPI Reference
Log In
API Reference

Create Service Area

Use service areas to assign orders to teams and set delivery rules based on the delivery address.

Body Params
string
required

Describes the service area. E.g. north shore, south shore, downtown. Entity's unique ID.

string

Your ID for the service area. Must be unique per merchant.

polygon
array

The coordinates that form the polygon that defines the service area. Coordinates for polygons should be floats and specified in [lat, lng] order. A service area can be defined by either zip codes or polygon.

polygon
zipcodes
array of strings

Defines the geographical area as the collection of zip codes. Must include either zip codes or polygon, not both.

zipcodes
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json