Pickup Location

Model for Pickup Location

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

Unique ID of the pickup location generated in your system and configured in our system.

contact

Contact (Location)

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.

currencyCode

string

ISO 4127 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.

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.