Reference an existing Location by its public location_id — obtain it from GET /locations or use the id returned by POST /locations. The location_id accepts either a merchant-defined custom ID (for source = manual) or a platform composite ID app-<platform>-<app_key>-<external_id> (for source = platform).

The PickupLocation model signifies a physical location where customers can visit and manually pick up their purchased products.Show all...

location_id

string

The public Location ID from the Location resource. Get it via GET /locations or use the id returned by POST /locations. Accepts either a merchant-defined custom ID (e.g. warehouse_1) for source = manual locations, or a platform composite ID app-<platform>-<app_key>-<external_id> for source = platform locations.

Example:

warehouse_1

address

AddressWithCoordinate

Address of the pickup location.

Example:

{"type":"business","street_1":"1234 Elm Street","street_2":"Apt 5","street_3":null,"city":"New York","state":"NY","postal_code":"10001","country_region":"USA","company":"My Company","first_name":"John","last_name":"Doe","email":"[email protected]","phone":"+13525554500","coordinate":{"latitude":43,"longitude":-75}}

type

string

The type of address.

Allowed values:

businessresidential

street_1

string

required

First line of the street address.

<= 256 characters

street_2

string or null

Second line of the street address.

<= 256 characters

street_3

string or null

Third line of the street address.

<= 256 characters

city

string

The location's city, town, or village.

<= 256 characters

state

string

required

The state or region of the location, such as a province, state, or prefecture.

<= 256 characters

postal_code

string

The postal code of the location (also known as zip code, postcode, Eircode, etc.).

<= 256 characters

country_region

string

required

The address country/region in ISO 3166-1 alpha-3 format.

Example:

USA

Match pattern:

^[A-Z]{3}$

company

string

The name of the company associated to the address.

<= 256 characters

first_name

string

The first name of the person associated to the address.

<= 256 characters

last_name

string

The last name of the person associated to the address.

<= 256 characters

string

The email address of the person associated to the address.

<= 256 characters

phone

string

The phone number of the person associated to the address.

<= 256 characters

coordinate

object

The coordinate of the address.

opening_hours

OpeningHours

Opening hours information of the pickup location.

sunday

OpeningHourPeriod

The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indicates whether the location is open on that particular day.

Example: