API Reference

Create Service Area

A service area is a geographical region within your delivery scope. Use service areas to assign orders to teams and set delivery rules based on the delivery address. 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.

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

id

Int32

The unique ID for this record.

external_id

string

Your ID for this record.

name

string

The display name of this record.

polygon

array_string

The coordinates that form a polygon that defines the service area,formatted [lat, lng].

zipcodes

array_string

The zip codes included in the service area.

zipcode_reached_limit

boolean

Bringg displays up to 57001 zip codes per service area.

  • false - below limit.
  • true - above limit.
Language