Location
read_locations access scope.read_locations access scope.:Supported actions: create, update, delete
Subscribe to field-level changes on the Location GraphQL Admin API object.
Each topic corresponds to a commerce resource that can exist independently within its domain. Child entities that depend on a parent within the same domain don't have their own topic. Instead, changes to child entities trigger a delivery on the parent topic. Calculated fields, derived fields, auto-updated timestamps, and cross-domain fields aren't available as triggers.
shopify.app.toml
Anchor to Supported triggersSupported triggers
Field-level triggers for Location subscriptions.
All triggers require the read_locations access scope. Those triggers that require additional scopes are documented where relevant. Deprecated triggers are listed last.
Subscriptions can include multiple triggers. Use the shopify-webhook-id header for deduplication when handling duplicate deliveries.
Custom queries aren't limited to Location. They can query the full GraphQL Admin API.
Fires when events involve the Location object.
The "create" and "delete" actions are only relevant within the context of this parent topic. Use to follow or replicate impacted data after a delete event. Define a custom query to retrieve specific fields from create events.
location.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under location, including nested triggers. Use a more specific trigger to limit events to the fields you need.
Variables:
Fires when the address field on the Location object changes.
location.address.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under location.address, including nested triggers. Use a more specific trigger to limit events to the fields you need.
Include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The address field represents the address of this location.
Variables:
Fires when the address1 field on the object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The address1 field represents the first line of the address for the location.
Variables:
Fires when the address2 field on the object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The address2 field represents the second line of the address for the location.
Variables:
Fires when the city field on the object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The city field represents the city of the location.
Variables:
Fires when the latitude field on the object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The latitude field represents the approximate latitude coordinates of the location.
Variables:
Fires when the longitude field on the object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The longitude field represents the approximate longitude coordinates of the location.
Variables:
Fires when the phone field on the object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The phone field represents the phone number of the location.
Variables:
Fires when the field on the object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The field represents the code for the province, state, or district of the address of the location.
Variables:
Fires when the zip field on the object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The zip field represents the ZIP code of the location.
Variables:
Fires when the field on the Location object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The field represents the date and time (ISO 8601 format) that the location was deactivated at.
Variables:
Fires when the field on the Location object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The field indicates whether this location can fulfill online orders.
Variables:
Fires when the field on the Location object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The field indicates whether the location is active.
Variables:
Fires when the metafield field on the Location object changes.
location.metafield(namespace: String!, key: String!).* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under location.metafield(namespace: String!, key: String!), including nested triggers. Use a more specific trigger to limit events to the fields you need.
Include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The metafield field represents a custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Variables: , ,
Fires when the metafield field on the Location object changes.
location.metafield(namespace: String!).* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under location.metafield(namespace: String!), including nested triggers. Use a more specific trigger to limit events to the fields you need.
Include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
This subscription omits the optional argument metafield.key.
The metafield field represents a custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Variables: , ,
Fires when the value field on the Metafield object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
The value field represents the data stored in the metafield.
Variables: , ,
Fires when the value field on the Metafield object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
This subscription omits the optional argument metafield.key.
The value field represents the data stored in the metafield.
Variables: , ,
Fires when the field on the Location object changes.
Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload.
You can trace the field in subsequent requests using .
Legacy field indicating this location was designated for shipping.
Variables: