Create Location

Use this API to create a location.

Body Params
string
required

Name of the pickup location

string
required

It's a unique id by which your systems can identify the pickup location. It's not editable after the creation of Pickup Location

string

It's a unique id that you have associated with the brand during its creation. If not provided, the default brand is chosen.

contact
object
required

Contact information for Pickup Location.

address
object
required

Address of the location

boolean

The pickup location can be marked as active or inactive using the true/false flag. Default is true (pickup location is enabled)

string

Currency code in ISO 4217 alphabetical format, e.g. USD. It inherits from Brand or Business if not provided.

string

Pickup instructions for the location. These instructions are given to drivers/customers coming to pick up the order. If not provided it will be inherited from Brand or Business.

DSPs
array of objects

List of the providers that should be assigned for the location

DSPs
string

In the case of shipping carriers, if the order can't be delivered then it's returned to the same Pickup Location. You can associate a different Pickup Location in such a case by entering the desired location's storeExternalId here.

additionalContacts
array of objects

To store additional contact details for a store

additionalContacts
tags
array of strings

Identifiers that can be used for finding and sorting relevant information.

tags
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json