Skip to navigation

Get Delivery Areas

View as Markdown

Lists the states and areas the store delivers to, for building an address form. Shoppers can still type an area that isn’t listed; Get Delivery Options says what applies.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Headers

channelstringRequired

Response

Successfully fetched delivery areas
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error