Locations
Returns a list of active inventory locations.
View-Specific Information
Select
The add-in uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The add-in processes other filters client-side within the add-in.
- Id supports the '=,IN' comparison operators.
- Name supports the '=,!=' comparison operators.
- IsActive supports the '=,!=' comparison operators.
- AddressAddress1 supports the '=,!=' comparison operators.
- AddressAddress2 supports the '=,!=' comparison operators.
- AddressCity supports the '=,!=' comparison operators.
- AddressCountry supports the '!=' comparison operator.
- AddressProvince supports the '=,!=' comparison operators.
- AddressZip supports the '=,!=' comparison operators.
- IncludeInactive supports the '=,IN' comparison operators.
- IncludeLegacy supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Locations
SELECT * FROM Locations WHERE Id = 'Val1'
SELECT * FROM Locations WHERE Name = 'Val1'
SELECT * FROM Locations WHERE IsActive = true
SELECT * FROM Locations WHERE AddressAddress1 = 'Val1'
SELECT * FROM Locations WHERE AddressAddress2 = 'Val1'
SELECT * FROM Locations WHERE AddressCity = 'Val1'
SELECT * FROM Locations WHERE AddressCountry != 'Val1'
SELECT * FROM Locations WHERE AddressProvince = 'Val1'
SELECT * FROM Locations WHERE AddressZip = 'Val1'
SELECT * FROM Locations WHERE IncludeInactive = true
SELECT * FROM Locations WHERE IncludeLegacy = true
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| Name | String | The name of the location. | |
| Activatable | Bool | Whether this location can be reactivated. | |
| Deactivatable | Bool | Whether this location can be deactivated. | |
| Deletable | Bool | Whether this location can be deleted. | |
| AddressVerified | Bool | Whether the location address has been verified. | |
| DeactivatedAt | String | The date and time that the location was deactivated at. For example, 3: 30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as '2019-09-07T15: 50: 00Z'. | |
| IsActive | Bool | Whether the location is active. | |
| ShipsInventory | Bool | Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
| FulfillsOnlineOrders | Bool | Whether this location can fulfill online orders. | |
| HasActiveInventory | Bool | Whether this location has active inventory. | |
| HasUnfulfilledOrders | Bool | Whether this location has orders that need to be fulfilled. | |
| AddressAddress1 | String | The first line of the address for the location. | |
| AddressAddress2 | String | The second line of the address for the location. | |
| AddressCity | String | The city of the location. | |
| AddressCountry | String | The country of the location. | |
| AddressFormatted | String | A formatted version of the address for the location. | |
| AddressLatitude | Double | The latitude coordinates of the location. | |
| AddressLongitude | Double | The longitude coordinates of the location. | |
| AddressPhone | String | The phone number of the location. | |
| AddressProvince | String | The province of the location. | |
| AddressZip | String | The ZIP code of the location. | |
| AddressCountryCode | String | The country code of the location. | |
| AddressProvinceCode | String | The code for the province, state, or district of the address of the location. | |
| FulfillmentServiceId | String | The ID of the fulfillment service. | |
| LocalPickupSettingsV2Instructions | String | Additional instructions or information related to the local pickup. | |
| LocalPickupSettingsV2PickupTime | String | The estimated pickup time to show customers at checkout. | |
| IncludeInactive | Bool | If true, also include the locations that are deactivated. | |
| IncludeLegacy | Bool | If true, also include the legacy locations of fulfillment services. |