API Reference

Create Service Area

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

A service area is a geographical region within your delivery scope. For example, you might have a different delivery speed, price, or availability in some areas based on their distance from your fulfillment center.

You can include up to 57001 zip codes in each service area.

Response (Output) Params
ParameterDescription
success
boolean
Indicates whether the service completed successfully.

false - the service failed.
true - the service succeeded
message
string
If an error occurred, a message indicating the error is included.
rc
integer
If an error occurred, the return code is included.
id
integer
The Bringg ID for this service area.
external_id
string
Your system's ID for this service area.
name
string
The display name of this service area.
next_page_cursor
integer
The ID to retrieve the next page of results.
polygon
array_string
The coordinates that form the polygon that defines the service area.
zipcodes
array_string
The list of zipcodes defining the geographical area of the service area.
zipcode_reached_limit
boolean
Bringg displays up to 57001 zip codes per service area.

false - below limit.
true - above limit.
Language