Get Service Area

Get the details of a particular service area.

📘

This endpoint uses query params

Instead of sending a payload, include the id or external_id in the endpoint URL. For example:

https://developer-api.bringg.com/services/<service-id>/<secret-1>/<secret-2>/?id=12345https://developer-api.bringg.com/services/<service-id>/<secret-1>/<secret-2>/?external_id=v123
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.
Query Params
int32

Bringg's unique ID for the service area. Required if no external_id.

string

Your ID for the service area. Required if no id.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json