Get Location

Use this API to get the details of a location using the user-specified storeExternalId which is associated with a location.


The unique Delivery Solutions' _id can also be used in place of the storeExternalId. When doing so, directly provide the _id after /store/, without storeExternalId


_idstringDelivery Solutions' internal unique ID for the location.
activebooleanThe pick up location can be marked as active or inactive using the true/false flag. Default is true (pickup location is enabled).
namestringName of the pickup location.
storeExternalIdstringIt'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..
contactContactThe contact details for the location. Only the name, phone number and email fields are stored for a location.
addressAddressAddress of the pickup location.
timeZonestringTimezone in which the pickup location is present.
currencyCodestringISO 4217 alphabetical code, e.g. USD.
descriptionstringA short description of the pickup location.
pickupInstructionsstringPickup instructions for the pickup location.
returnStoreIdstringThe configured return ID for the pickup location, for when an order needs to be returned to a different location. ( In case of Shipping Carriers)
DSPsArray of ProvidersList of providers configured for the pickup location.
dspAttributesObject containing Provider Config AttributesProvider attributes configured for the pickup location, when necessary for certain providers.
labelConfigLabel ConfigLabel configuration for orders. Each order type has its own associated label configuration.
createdAtstringThe time when the pickup location was created in Delivery Solutions, in ISO 8601 format
lastUpdatedAtstringThe time when the pickup location was last updated, in ISO 8601 format.
additionalContactsArray of Store ContactAdditional contact details for a store
Click Try It! to start a request and see the response here!