get https://sandbox.api.deliverysolutions.co/api/v2/store/getById/storeExternalId/
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 thestoreExternalId
. When doing so, directly provide the_id
after/store/
, withoutstoreExternalId
Response
Property | Type | Description |
---|---|---|
_id | string | Delivery Solutions' internal unique ID for the location. |
active | boolean | The pick up 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. |
currencyCode | string | ISO 4217 alphabetical code, e.g. USD . |
description | string | A short description of the pickup location. |
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. ( In case of Shipping Carriers) |
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. |
labelConfig | Label Config | Label configuration for orders. Each order type has its own associated label configuration. |
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. |