Locations
Returns a list of active inventory locations.
Select
The add-in uses the Shopify API to process WHERE clause conditions built with the following column and operator. 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 operators.
- 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 = 123
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 = 123
SELECT * FROM Locations WHERE IncludeLegacy = 123
Insert
Insert statements are mapped to the 'locationAdd' GraphQL mutation.
The following columns can be used to create a new record:
Name, FulfillsOnlineOrders, AddressAddress1, AddressAddress2, AddressCity, AddressPhone, AddressZip, AddressCountryCode, AddressProvinceCode
Update
Update statements are mapped to the 'locationEdit' GraphQL mutation.
The following columns can be updated:
Id, Name, IsActive, FulfillsOnlineOrders, AddressAddress1, AddressAddress2, AddressCity, AddressPhone, AddressZip, AddressCountryCode, AddressProvinceCode
Delete
Delete statements are mapped to the 'locationDelete' GraphQL mutation.
You can delete entries by specifying the Id
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
A globally-unique ID. | |
LegacyResourceId | String | True |
The ID of the corresponding resource in the REST Admin API. | |
Name | String | False |
The name of the location. | |
Activatable | Bool | True |
Whether this location can be reactivated. | |
Deactivatable | Bool | True |
Whether this location can be deactivated. | |
Deletable | Bool | True |
Whether this location can be deleted. | |
AddressVerified | Bool | True |
Whether the location address has been verified. | |
DeactivatedAt | String | True |
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 | False |
Whether the location is active. | |
ShipsInventory | Bool | True |
Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. | |
FulfillsOnlineOrders | Bool | False |
Whether this location can fulfill online orders. | |
HasActiveInventory | Bool | True |
Whether this location has active inventory. | |
HasUnfulfilledOrders | Bool | True |
Whether this location has orders that need to be fulfilled. | |
AddressAddress1 | String | False |
The first line of the address for the location. | |
AddressAddress2 | String | False |
The second line of the address for the location. | |
AddressCity | String | False |
The city of the location. | |
AddressCountry | String | True |
The country of the location. | |
AddressFormatted | String | True |
A formatted version of the address for the location. | |
AddressLatitude | Double | True |
The latitude coordinates of the location. | |
AddressLongitude | Double | True |
The longitude coordinates of the location. | |
AddressPhone | String | False |
The phone number of the location. | |
AddressProvince | String | True |
The province of the location. | |
AddressZip | String | False |
The ZIP code of the location. | |
AddressCountryCode | String | False |
The country code of the location. | |
AddressProvinceCode | String | False |
The code for the province, state, or district of the address of the location. | |
FulfillmentServiceId | String | True |
The ID of the fulfillment service. | |
LocalPickupSettingsV2Instructions | String | True |
Additional instructions or information related to the local pickup. | |
LocalPickupSettingsV2PickupTime | String | True |
The estimated pickup time to show customers at checkout. | |
IncludeInactive | Bool | True |
If true, also include the locations that are deactivated. | |
IncludeLegacy | Bool | True |
If true, also include the legacy locations of fulfillment services. |