Create Location

post

https://sandbox.api.deliverysolutions.co/api/v2/store

Use this API to create a location.

📘

The storeExternalId must be unique since it's used to identify the pickup location. Several of our APIs use this id to associate the pickup location for a specific operation.

Pickup instructions can be overridden at the order level while placing an order.

Multiple providers can be assigned to a location.

Response

Property	Type	Description
_id	string	Delivery Solutions' internal unique ID for the location.
active	boolean	The pickup location can be marked as active or inactive using the true/false flag. Default is true (pickup location is enabled).
name	string	Name of the pickup location.
storeExternalId	string	It's a unique id by which your systems can identify the pickup location. Most of our APIs use this id to associate the pickup location for a specific operation..
contact	Contact	The contact details for the location. Only the name, phone number and email fields are stored for a location.
address	Address	Address of the pickup location.
timeZone	string	Timezone in which the pickup location is present. This is calculated based on the address that you have provided.
currencyCode	string	ISO 4217 alphabetical code, e.g. `USD`.
pickupInstructions	string	Pickup instructions for the pickup location.
returnStoreId	string	The configured return ID for the pickup location, for when an order needs to be returned to a different location.
DSPs	Array of Providers	List of providers configured for the pickup location.
dspAttributes	Object containing Provider Config Attributes	Provider attributes configured for the pickup location, when necessary for certain providers.
createdAt	string	The time when the pickup location was created in Delivery Solutions, in ISO 8601 format
lastUpdatedAt	string	The time when the pickup location was last updated, in ISO 8601 format.
additionalContacts	Array of Store Contact	Additional contact details for a store
tags	Array of string	Identifiers that can be used for finding and sorting relevant information.

Body Params

name

string

required

Name of the pickup location

storeExternalId

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

brandExternalId

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

active

boolean

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

currencyCode

string

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

pickupInstructions

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

returnStoreId

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

Response

201201

400400

403403