- 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.
|_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 and phone number 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. |
|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.|
|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.|