A Location represents a warehouse, store, or other physical place used for fulfillment, order processing, and pickup settings. Location resources are scoped to the organization and are not bound to a store.

string

read-onlyrequired

The unique identifier of the location. For locations created through Commerce API, this is the custom ID supplied when creating the location, or a system-generated UUID if no custom ID was provided. For ecommerce platform-sourced locations, the ID is returned in the format app-<platform>-<app_key>-<external_id>.

Example:

warehouse_1

name

string

required

The location name.

<= 256 characters

Example:

SF Warehouse

source

string

read-onlyrequired

The source of the location. manual means the location was created through Commerce API. platform means the location was imported from an ecommerce platform.

Allowed values:

manualplatform

Example:

manual

address

AddressWithCoordinate

required

The physical address and contact information of the location. For Location resources, first_name and last_name are joined into one contact name on write; on read, the full contact name is returned as first_name and last_name is empty. The type field is accepted by the schema but not used for Location resources — omit it on write; on read it is always empty.

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.

timezone_identifier

string

The name of the timezone where the location is located, as defined by the IANA timezone database standard.

<= 256 characters

Example:

America/New_York

opening_hours

OpeningHours

The regular opening hours of the 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: