Locations
Represents the location where the physical good resides.
|
Field |
Description |
|---|---|
|
Activatable |
Whether this location can be reactivated. |
|
Address verified |
Whether the location address has been verified. |
|
Deactivatable |
Whether this location can be deactivated. |
|
Deactivated at |
The date and time that the location was deactivated at. |
|
Deletable |
Whether this location can be deleted. |
|
Fulfills online orders |
Whether this location can fulfill online orders. |
|
Has active inventory |
Whether this location has active inventory. |
|
Has unfulfilled orders |
Whether this location has orders that need to be fulfilled. |
|
Id |
A globally-unique ID. |
|
Is active |
Whether the location is active. |
|
Legacy resource id |
The ID of the corresponding resource in the REST Admin API. |
|
Name |
The name of the location. |
|
Ships inventory |
Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. |
Locations / Address
The address of this location.
|
Field |
Description |
|---|---|
|
City |
The city of the location. |
|
Country |
The country of the location. |
|
Country code |
The two-letter country code of the location. |
|
First line |
The first line of the address for the location. |
|
Formatted |
A formatted version of the location address. |
|
Latitude |
The latitude coordinates of the location. |
|
Longitude |
The longitude coordinates of the location. |
|
Phone |
The phone number of the location. |
|
Province |
The province of the location. |
|
Province code |
The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada. |
|
Second line |
The second line of the address for the location. |
|
Zip |
The ZIP code of the location. |
Locations / Inventory levels
A list of the quantities of the inventory items that can be stocked at this location.
|
Field |
Description |
|---|---|
|
Can deactivate |
Whether the inventory items associated with the inventory level can be deactivated. |
|
Created at |
The date and time when the inventory level was created. |
|
Deactivation alert |
Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated. |
|
Updated at |
The date and time when the inventory level was updated. |
Locations / Inventory levels / Item
Inventory item associated with the inventory level.
|
Field |
Description |
|---|---|
|
Inventory item id |
A globally-unique ID. |
Locations / Inventory levels / Location
Location associated with the inventory level.
|
Field |
Description |
|---|---|
|
Activatable |
Whether this location can be reactivated. |
|
Address verified |
Whether the location address has been verified. |
|
Deactivatable |
Whether this location can be deactivated. |
|
Deactivated at |
Date and time the location was deactivated (null if location is still active). |
|
Deletable |
Whether this location can be deleted. |
|
Fulfills online orders |
Indicates whether this location can fulfill online orders. |
|
Has active inventory |
Indicates whether or not this location has active inventory. |
|
Has unfulfilled orders |
Indicates whether or not this location has unfulfilled orders. |
|
ID |
Globally unique ID. |
|
Is active |
Whether the location is active. |
|
Legacy resource ID |
The ID of the corresponding resource in the REST Admin API. |
|
Name |
The name of the location. |
|
Ships inventory |
Indicates whether or not this location is used for calculating shipping rates. |
Locations / Inventory levels / Quantities
Quantities for the requested names.
|
Field |
Description |
|---|---|
|
Name |
The name that identifies the inventory quantity. |
|
Quantity |
The quantity for the quantity name. |
|
Updated at |
When the quantity was last updated. |
Locations / Metafields
A list of metafields that belong to the resource.
|
Field |
Description |
|---|---|
|
Description |
The description of a metafield. |
|
Key |
The key name for a metafield. |
|
Legacy resource ID |
The ID of the corresponding resource in the REST Admin API. |
|
Metafield ID |
Globally unique ID. |
|
Namespace |
The namespace for a metafield. |
|
Owner type |
Owner type of a metafield visible to the Storefront API. |
|
Type |
The type of data that the metafield stores in the value field. |
|
Value |
The value of a metafield. |