MCP Server for Shopify

Build 25.0.9440

Locations

Lists active inventory locations used for stock, fulfillment, and pickup.

Table-Specific Information

Select

The server uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The server processes other filters client-side within the server.

  • 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 '=' comparison operator.
  • IncludeLegacy supports the '=' comparison operator.
  • Namespace supports the '=, IN' comparison operators.
  • Key supports the '=, IN' comparison operators.
  • Value supports the '=, IN' comparison operators.

For example, the following queries are processed server-side: 

  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
  SELECT * FROM Locations WHERE Namespace = 'Val1'
  SELECT * FROM Locations WHERE Key = 'Val1'
  SELECT * FROM Locations WHERE Value = 'Val1'

Insert

The following columns can be used to create a new record:

Name, FulfillsOnlineOrders, AddressAddress1, AddressAddress2, AddressCity, AddressPhone, AddressZip, AddressCountryCode, AddressProvinceCode

Update

The following columns can be updated:

Name, IsActive, FulfillsOnlineOrders, AddressAddress1, AddressAddress2, AddressCity, AddressPhone, AddressZip, AddressCountryCode, AddressProvinceCode

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally unique Id for the location.

LegacyResourceId String True

The Id of the corresponding resource in the REST Admin API.

Name String False

The name of the location, such as a store, office, or warehouse.

Activatable Bool True

Indicates whether the location can be reactivated.

Deactivatable Bool True

Indicates whether the location can be deactivated.

Deletable Bool True

Indicates whether the location can be deleted.

AddressVerified Bool True

Indicates whether the location's address has been verified.

DeactivatedAt String True

The date and time when the location was deactivated. For example, 3:30 p.m. on September 7, 2019 (UTC) is represented as '2019-09-07T15:30:00Z'.

IsActive Bool False

Indicates whether the location is active.

ShipsInventory Bool True

Indicates whether the location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.

IsFulfillmentService Bool True

Indicates whether the location functions as a fulfillment service.

FulfillsOnlineOrders Bool False

Indicates whether the location can fulfill online orders.

HasActiveInventory Bool True

Indicates whether the location has active inventory.

HasUnfulfilledOrders Bool True

Indicates whether the location has unfulfilled orders.

CreatedAt Datetime True

The date and time when the location was created.

UpdatedAt Datetime True

The date and time when the location was last updated.

AddressAddress1 String False

The first line of the location's address.

AddressAddress2 String False

The second line of the location's address.

AddressCity String False

The city from the address of the location (for example, 'Toronto').

AddressCountry String True

The country from the address of the location, returned as the country name (for example, 'Canada').

AddressFormatted String True

The formatted address of the location.

AddressLatitude Double True

The latitude coordinate of the location.

AddressLongitude Double True

The longitude coordinate of the location.

AddressPhone String False

The phone number associated with the location.

AddressProvince String True

The province, state, or region of the location.

AddressZip String False

The ZIP or postal code of the location.

AddressCountryCode String False

The ISO country code of the location.

The allowed values are AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MK, ML, MM, MN, MO, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PS, PT, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW, ZZ.

AddressProvinceCode String False

The ISO code for the province, state, or district of the location.

FulfillmentServiceId String True

The Id of the fulfillment service linked to the location.

LocalPickupSettingsV2Instructions String True

Additional instructions for customers using local pickup.

LocalPickupSettingsV2PickupTime String True

The estimated pickup time displayed to customers at checkout.

IncludeInactive Bool True

If true, also includes locations that have been deactivated.

IncludeLegacy Bool True

If true, also includes legacy fulfillment service locations.

Namespace String True

The container the metafield belongs to. If not specified, the app-reserved namespace is used.

Key String True

The key for the metafield.

Value String True

The value of the metafield.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9440