Shopify

shopify

Shopify is an e-commerce platform. This toolkit is GraphQL-first for new Admin API automations while retaining legacy REST compatibility actions for older workflows and numeric-ID interoperability

Ecommerce Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (28)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add product to custom collectionSHOPIFY_ADD_PRODUCT_TO_COLLECTIONAcción

Adds a product to an existing *custom collection*, optionally specifying its `position` if the collection is manually sorted.

Parámetros de entrada

positioninteger
Optional 1-based position if the custom collection is manually sorted; product is added to the end if unspecified or collection isn't manually sorted.
product_idintegerObligatorio
Identifier of the product to add.
collection_idintegerObligatorio
Identifier of the *custom collection*.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Count product imagesSHOPIFY_COUNT_PRODUCT_IMAGESAcción

Retrieves the total count of images for a shopify product, useful for inventory management or display logic; the provided `product id` must exist in the store.

Parámetros de entrada

product_idstringObligatorio
The unique identifier for the Shopify product whose images are to be counted.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a custom collectionSHOPIFY_CREATE_CUSTOM_COLLECTIONAcción

Creates a new custom collection in a shopify store, requiring a unique title for manually curated product groupings (e.g., 'new arrivals', 'seasonal specials').

Parámetros de entrada

titlestringObligatorio
Unique title for the custom collection, visible to customers and used for product organization.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CustomerSHOPIFY_CREATE_CUSTOMERAcción

Tool to create a new customer in shopify. use when you need to add a new customer record to the store.

Parámetros de entrada

notestring
An optional note about the customer.
tagsstring
A comma-separated string of tags to associate with the customer.
emailstringObligatorioemail
The customer's unique email address.
phonestring
The customer's phone number (E.164 format recommended).
passwordstring
The customer's password. If provided, password_confirmation is also required.
addressesobject[]
A list of addresses for the customer.
last_namestring
The customer's last name.
first_namestring
The customer's first name.
verified_emailboolean
Whether the customer has verified their email address.
send_email_inviteboolean
If true, sends the customer an email invite to create an account.
send_email_welcomeboolean
Whether to send the customer a welcome email. Defaults to true. If send_email_invite is true, this can be set to false.
password_confirmationstring
Confirmation of the customer's password. Required if password is provided.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an orderSHOPIFY_CREATE_ORDERAcción

Creates a new order in shopify, typically requiring line items; if `customer id` is provided, it must correspond to an existing customer.

Parámetros de entrada

currencystring
The three-letter ISO 4217 currency code for the amounts in the order (e.g., USD, CAD, EUR).
total_taxnumber
The total amount of tax for the order. This should be a numeric value representing the sum of all taxes.
line_itemsobject[]Obligatorio
A list of line item objects, each representing an item in the order. Each object should specify at least a `variant_id` (or `product_id`) and `quantity`. Other common fields include `price` and `title`. At least one line item is required.
customer_idstring
The unique identifier of the customer associated with this order. If provided, the order will be linked to this customer. This field is optional.
transactionsobject[]
A list of transaction objects associated with the order, typically representing payment information. Each object usually includes `kind` (e.g., 'sale', 'authorization'), `amount`, `status`, and `gateway`.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a productSHOPIFY_CREATE_PRODUCTAcción

Creates a new product in a shopify store; a product title is generally required.

Parámetros de entrada

titlestring
The title of the product, typically required by Shopify.
vendorstring
The name of the product's vendor or manufacturer.
variantsobject[]
Product variants. Common keys include 'price', 'sku', 'option1', 'option2', 'inventory_quantity'. At least one variant is typically required; if not provided, Shopify might create a default one.
body_htmlstring
A detailed description of the product, which can include HTML formatting for rich text.
product_typestring
A category for the product, used for filtering and organizing products in Shopify.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Product ImageSHOPIFY_CREATE_PRODUCT_IMAGEAcción

Tool to create a new product image for a given product. use when you need to add an image to a product by providing the image source url or attachment.

Parámetros de entrada

imageobjectObligatorio
An object containing the image details.
product_idstringObligatorio
The ID of the product to associate the image with.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete custom collectionSHOPIFY_DELETE_CUSTOM_COLLECTIONAcción

Permanently deletes a custom collection from a shopify store using its `collection id`; this action is irreversible and requires a valid, existing `collection id`.

Parámetros de entrada

collection_idstringObligatorio
The unique identifier for the custom collection that needs to be deleted. This ID is a numerical string assigned by Shopify when the collection is created.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a productSHOPIFY_DELETE_PRODUCTAcción

Deletes a specific, existing product from a shopify store using its unique product id; this action is irreversible.

Parámetros de entrada

idstring
The unique identifier of the Shopify product to be deleted. This ID is essential for targeting the correct product for removal.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete product imageSHOPIFY_DELETE_PRODUCT_IMAGEAcción

Deletes a specific image from a product in shopify, requiring the `product id` of an existing product and the `image id` of an image currently associated with that product.

Parámetros de entrada

image_idstringObligatorio
The unique identifier of the specific product image to be deleted.
product_idstringObligatorio
The unique identifier of the product from which the image is to be deleted.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All CustomersSHOPIFY_GET_ALL_CUSTOMERSAcción

Retrieves customer records from a shopify store, with options for filtering, selecting specific fields, and paginating through the results.

Parámetros de entrada

idsstring[]
A list of specific customer IDs to retrieve. If empty, all customers (matching other filters) will be retrieved.
limitinteger
The maximum number of customers to retrieve. Defaults to 50, with a maximum value of 250.
fieldsstring
A comma-separated list of customer fields to include in the response (e.g., 'id,email,first_name'). By default, all fields are returned.
since_idstring
Retrieve only customers with an ID greater than this specified ID. This is used for paginating through results.
created_at_maxstring
Filter customers created before or on this date. Format: YYYY-MM-DD or ISO 8601 datetime string (e.g., '2023-10-26T10:00:00-05:00').
created_at_minstring
Filter customers created after or on this date. Format: YYYY-MM-DD or ISO 8601 datetime string (e.g., '2023-10-26T10:00:00-05:00').
updated_at_maxstring
Filter customers last updated before or on this date. Format: YYYY-MM-DD or ISO 8601 datetime string.
updated_at_minstring
Filter customers last updated after or on this date. Format: YYYY-MM-DD or ISO 8601 datetime string.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get collection by IDSHOPIFY_GET_COLLECTION_BY_IDAcción

Retrieves a specific shopify collection by its `collection id`, optionally filtering returned data to specified `fields`.

Parámetros de entrada

fieldsstring
Comma-separated list of fields to retrieve; if omitted, all fields are returned. E.g., 'id,title,handle'.
collection_idstringObligatorio
The unique identifier of the Shopify collection to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get collectsSHOPIFY_GET_COLLECTSAcción

Retrieves a list of collects from a shopify store, where a collect links a product to a custom collection.

Parámetros de entrada

limitinteger
Maximum number of collects to retrieve (1-250).
fieldsstring
Comma-separated list of fields to retrieve (e.g., `id,collection_id,product_id`); if unspecified, all fields are returned.
since_idinteger
Retrieve only collects created after this ID, for pagination.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get collects countSHOPIFY_GET_COLLECTS_COUNTAcción

Retrieves the total count of collects (product-to-collection associations) in a shopify store.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get custom collectionsSHOPIFY_GET_CUSTOM_COLLECTIONSAcción

Retrieves a list of custom collections from a shopify store, optionally filtered by ids, product id, or handle.

Parámetros de entrada

idsstring
A comma-separated string of custom collection IDs to retrieve.
limitinteger
The maximum number of custom collections to return (between 1 and 250).
handlestring
Filter results by the custom collection's unique, human-readable string identifier (e.g., 'summer-specials').
product_idinteger
Filter results to custom collections that contain a specific product ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get custom collections countSHOPIFY_GET_CUSTOM_COLLECTIONS_COUNTAcción

Retrieves the total number of custom collections in a shopify store.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CustomerSHOPIFY_GET_CUSTOMERAcción

Retrieves detailed information for a specific customer from a shopify store, provided their valid and existing `customer id`.

Parámetros de entrada

customer_idstringObligatorio
The unique identifier for the customer in Shopify.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get customer ordersSHOPIFY_GET_CUSTOMER_ORDERSAcción

Retrieves all orders for a specific, existing customer in shopify using their unique customer id.

Parámetros de entrada

customer_idstringObligatorio
Unique identifier for the customer whose orders are to be retrieved.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get order listSHOPIFY_GET_ORDER_LISTAcción

Retrieves a list of orders from shopify using default api settings and filters.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get order by idSHOPIFY_GET_ORDERSBY_IDAcción

Retrieves a specific shopify order by its unique id, which must correspond to an existing order.

Parámetros de entrada

fieldsstring
Comma-separated list of fields to include in the response (e.g., 'id,line_items').
order_idstringObligatorio
The unique identifier of the Shopify order to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get productSHOPIFY_GET_PRODUCTAcción

Retrieves details for an existing shopify product using its unique product id.

Parámetros de entrada

product_idstringObligatorio
The unique identifier of the Shopify product to be retrieved.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get product imageSHOPIFY_GET_PRODUCT_IMAGEAcción

Retrieves detailed information for a specific product image, identified by its id and its associated product id, from a shopify store.

Parámetros de entrada

image_idstringObligatorio
The unique numerical identifier of the image associated with the product.
product_idstringObligatorio
The unique numerical identifier of the Shopify product.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Product ImagesSHOPIFY_GET_PRODUCT_IMAGESAcción

Retrieves all images for a shopify product, specified by its `product id` which must correspond to an existing product.

Parámetros de entrada

fieldsstring
A comma-separated list of fields to include in the response. Available fields include: id, product_id, position, created_at, updated_at, alt, width, height, src.
since_idstring
Restricts the results to product images created after the specified image ID. Useful for pagination.
product_idstringObligatorio
The unique identifier of the Shopify product for which to retrieve images.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get productsSHOPIFY_GET_PRODUCTSAcción

Retrieves a list of products from a shopify store.

Parámetros de entrada

idsstring
A comma-separated string of product IDs to retrieve. If this field is not provided (i.e., defaults to `None`), all products will be fetched.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get products countSHOPIFY_GET_PRODUCTS_COUNTAcción

Retrieves the total, unfiltered count of all products in a shopify store.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get products in collectionSHOPIFY_GET_PRODUCTS_IN_COLLECTIONAcción

Retrieves all products within a specified shopify collection, requiring a valid `collection id`.

Parámetros de entrada

limitinteger
Maximum number of products to retrieve.
collection_idstringObligatorio
Identifier for the Shopify collection. Often found in the collection's Shopify admin URL.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Shop DetailsSHOPIFY_GET_SHOP_DETAILSAcción

Retrieves comprehensive administrative information about the authenticated shopify store, as defined by the shopify api.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update OrderSHOPIFY_UPDATE_ORDERAcción

Updates the phone number for an existing shopify order, identified by its id; pass `phone=none` to remove the current phone number.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the Shopify order whose phone number is to be updated.
phonestring
The new phone number for the order. E.164 format (e.g., '+15551234567') is recommended for international numbers. An empty string `''` may also be used to clear it, depending on Shopify API behavior.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Triggers (45)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

Bulk Operation FinishedSHOPIFY_BULK_OPERATION_FINISHEDTrigger

Triggers when a bulk operation started by this app finishes, whether it completed, failed, was canceled or expired. Shopify sends no result URL on this event; read `currentBulkOperation` to get one.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
GraphQL global id of the bulk operation, e.g. `gid://shopify/BulkOperation/8318582423710`.
completed_atstring
When the operation finished, ISO 8601.
created_atstring
When the operation was started, ISO 8601.
error_codestring
Why the operation failed, e.g. `ACCESS_DENIED`, `INTERNAL_SERVER_ERROR`, `TIMEOUT`. Null when it succeeded.
statusstring
How the operation ended: `completed`, `failed`, `canceled` or `expired`.
typestring
What the operation did: `query` for a bulk read, `mutation` for a bulk write.

Instrucciones

- Connect Shopify through OAuth. Shopify signs every delivery with the app's client secret, which only an OAuth auth config holds. - The connected account needs the access scope the topic requires, granted when the store installs the app. - Deleting the trigger in Composio does not remove the subscription from Shopify. To stop delivery, remove the app in the Shopify admin under Settings -> Apps and sales channels. - Sample deliveries from `shopify app webhook trigger` name the placeholder store `shop.myshopify.com`, so they reach no trigger. Test with a real change in the store.

Collection CreatedSHOPIFY_COLLECTION_CREATEDTrigger

Triggers when a collection is created. Automated collections carry `rules` and `disjunctive`; manual ones omit both.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The collection's GraphQL global id, e.g. `gid://shopify/Collection/349572300958`.
body_htmlstring
The collection description, as HTML.
disjunctiveboolean
For an automated collection, whether a product needs to match any rule (`true`) or every rule (`false`). Absent on manual collections.
handlestring
URL slug for the collection, unique within the store.
idintegerObligatorio
Shopify's numeric id for the collection.
published_atstring
When the collection was published to its sales channels, ISO 8601.
published_scopestring
Where the collection is published: `web` for the online store only, `global` for every channel.
rulesobject[]
Conditions selecting the collection's products. Present only on automated collections; absent when the merchant curates by hand.
sort_orderstring
How products are ordered inside the collection, e.g. `most-relevant`, `best-selling`, `manual`.
template_suffixstring
Suffix of the theme template rendering this collection. Null when the default template is used.
titlestring
The collection's name.
updated_atstring
When the collection was last modified, ISO 8601.

Instrucciones

Collection DeletedSHOPIFY_COLLECTION_DELETEDTrigger

Triggers when a collection is deleted. Shopify sends only the collection's ids and publication scope, not its title, rules or products.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The deleted collection's GraphQL global id.
idintegerObligatorio
Numeric id of the deleted collection.
published_scopestring
Where the collection had been published: `web` for the online store only, `global` for every channel.

Instrucciones

Collection UpdatedSHOPIFY_COLLECTION_UPDATEDTrigger

Triggers when a collection's own fields change, and also when a product is added to or removed from a manual collection. The body never lists the collection's products — read them with `SHOPIFY_LIST_COLLECTION_PRODUCTS`.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The collection's GraphQL global id, e.g. `gid://shopify/Collection/349572300958`.
body_htmlstring
The collection description, as HTML.
disjunctiveboolean
For an automated collection, whether a product needs to match any rule (`true`) or every rule (`false`). Absent on manual collections.
handlestring
URL slug for the collection, unique within the store.
idintegerObligatorio
Shopify's numeric id for the collection.
published_atstring
When the collection was published to its sales channels, ISO 8601.
published_scopestring
Where the collection is published: `web` for the online store only, `global` for every channel.
rulesobject[]
Conditions selecting the collection's products. Present only on automated collections; absent when the merchant curates by hand.
sort_orderstring
How products are ordered inside the collection, e.g. `most-relevant`, `best-selling`, `manual`.
template_suffixstring
Suffix of the theme template rendering this collection. Null when the default template is used.
titlestring
The collection's name.
updated_atstring
When the collection was last modified, ISO 8601.

Instrucciones

Customer Segment CreatedSHOPIFY_CUSTOMER_SEGMENT_CREATEDTrigger

Triggers when a customer segment is created. The body carries the segment's query, not the customers it selects.

Configuración

Sin parámetros.

Payload del evento

creationDatestring
When the segment was created, ISO 8601.
idintegerObligatorio
Shopify's numeric id for the segment.
lastEditDatestring
When the segment was last edited, ISO 8601.
namestring
Name the merchant gave the segment.
querystring
The segment's membership rule in Shopify's segment query language, e.g. `customer_account_status = 'DISABLED'`.

Instrucciones

Customer Segment DeletedSHOPIFY_CUSTOMER_SEGMENT_DELETEDTrigger

Triggers when a customer segment is deleted. Shopify sends only the segment id.

Configuración

Sin parámetros.

Payload del evento

idintegerObligatorio
Numeric id of the deleted customer segment.

Instrucciones

Customer Segment UpdatedSHOPIFY_CUSTOMER_SEGMENT_UPDATEDTrigger

Triggers when a customer segment is renamed or its query is edited. Customers entering or leaving a segment as they meet the query are not reported.

Configuración

Sin parámetros.

Payload del evento

creationDatestring
When the segment was created, ISO 8601.
idintegerObligatorio
Shopify's numeric id for the segment.
lastEditDatestring
When the segment was last edited, ISO 8601.
namestring
Name the merchant gave the segment.
querystring
The segment's membership rule in Shopify's segment query language, e.g. `customer_account_status = 'DISABLED'`.

Instrucciones

Discount Code AddedSHOPIFY_DISCOUNT_CODE_ADDEDTrigger

Triggers when a redeemable code is added to a discount, once per code. Discount Updated fires alongside it, because the discount's own record changes too.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
GraphQL global id of the discount the code belongs to.
redeem_codeobject
One redeemable code belonging to a discount.
updated_atstring
When the discount's code list changed, ISO 8601.

Instrucciones

Discount Code RemovedSHOPIFY_DISCOUNT_CODE_REMOVEDTrigger

Triggers when a redeemable code is removed from a discount, once per code. The code stops working immediately; the discount itself survives.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
GraphQL global id of the discount the code belongs to.
redeem_codeobject
One redeemable code belonging to a discount.
updated_atstring
When the discount's code list changed, ISO 8601.

Instrucciones

Discount CreatedSHOPIFY_DISCOUNT_CREATEDTrigger

Triggers when a discount is created, whether it applies automatically or through a code. The body is a summary — read the discount's value and conditions with `SHOPIFY_GRAPH_QL_DISCOUNTS`.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The discount's GraphQL global id, e.g. `gid://shopify/DiscountCodeNode/1577218769054`. Discounts have no numeric id on this topic, so this is the identifier to use with the Admin GraphQL API.
created_atstring
When the discount was created, ISO 8601.
statusstring
Where the discount is in its schedule: `ACTIVE`, `SCHEDULED` or `EXPIRED`. Arrives upper-cased.
titlestring
Name of the discount as the merchant sees it.
updated_atstring
When the discount was last modified, ISO 8601.

Instrucciones

Discount DeletedSHOPIFY_DISCOUNT_DELETEDTrigger

Triggers when a discount is deleted. Its codes stop working at the same moment and are not reported separately.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
GraphQL global id of the deleted discount. Discounts have no numeric id on this topic, so this is the only handle on it.
deleted_atstring
When the discount was deleted, ISO 8601. Shopify leaves this null in practice; use the delivery's own arrival time instead.

Instrucciones

Discount UpdatedSHOPIFY_DISCOUNT_UPDATEDTrigger

Triggers when a discount is edited, and when it reaches its scheduled start or end and `status` changes. Adding or removing a code fires this as well as the dedicated code triggers.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The discount's GraphQL global id, e.g. `gid://shopify/DiscountCodeNode/1577218769054`. Discounts have no numeric id on this topic, so this is the identifier to use with the Admin GraphQL API.
created_atstring
When the discount was created, ISO 8601.
statusstring
Where the discount is in its schedule: `ACTIVE`, `SCHEDULED` or `EXPIRED`. Arrives upper-cased.
titlestring
Name of the discount as the merchant sees it.
updated_atstring
When the discount was last modified, ISO 8601.

Instrucciones

Inventory Item CreatedSHOPIFY_INVENTORY_ITEM_CREATEDTrigger

Triggers when an inventory item is created, which Shopify does once per new product variant. It carries the variant's stock-keeping fields — SKU, cost, weight, customs — but no quantities.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The inventory item's GraphQL global id, e.g. `gid://shopify/InventoryItem/50334998462622`.
coststring
Unit cost the merchant records for margin reporting, as a decimal string in the shop's currency.
country_code_of_originstring
ISO 3166-1 alpha-2 country the item was made in.
country_harmonized_system_codesobject[]
HS tariff codes that override `harmonized_system_code` for particular destination countries.
created_atstring
When the inventory item was created, ISO 8601.
harmonized_system_codestring
HS tariff code used to calculate customs duty.
idintegerObligatorio
Shopify's numeric id for the inventory item.
province_code_of_originstring
Province or state the item was made in, where recorded.
requires_shippingboolean
Whether the item is physical and has to be shipped.
skustring
Stock keeping unit shared with the variant.
trackedboolean
Whether Shopify counts stock for this item. Untracked items never fire the inventory-level topics.
updated_atstring
When the inventory item was last modified, ISO 8601.
weight_unitstring
Unit `weight_value` is expressed in, e.g. `lb`, `kg`.
weight_valuenumber
Shipping weight of the item, in `weight_unit`.

Instrucciones

Inventory Item DeletedSHOPIFY_INVENTORY_ITEM_DELETEDTrigger

Triggers when an inventory item is deleted, which happens for each variant of a deleted product. Shopify sends the item's ids and customs fields only, not its SKU or cost.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The deleted inventory item's GraphQL global id.
country_code_of_originstring
ISO 3166-1 alpha-2 country the item was made in.
country_harmonized_system_codesobject[]
HS tariff codes that had overridden `harmonized_system_code` for particular destination countries.
harmonized_system_codestring
HS tariff code that had been set for customs.
idintegerObligatorio
Numeric id of the deleted inventory item.
province_code_of_originstring
Province or state the item was made in, where recorded.

Instrucciones

Inventory Item UpdatedSHOPIFY_INVENTORY_ITEM_UPDATEDTrigger

Triggers when an inventory item's stock-keeping fields change, such as its SKU, unit cost, weight or customs codes. Quantity changes are not here; those come through Inventory Level Updated.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The inventory item's GraphQL global id, e.g. `gid://shopify/InventoryItem/50334998462622`.
coststring
Unit cost the merchant records for margin reporting, as a decimal string in the shop's currency.
country_code_of_originstring
ISO 3166-1 alpha-2 country the item was made in.
country_harmonized_system_codesobject[]
HS tariff codes that override `harmonized_system_code` for particular destination countries.
created_atstring
When the inventory item was created, ISO 8601.
harmonized_system_codestring
HS tariff code used to calculate customs duty.
idintegerObligatorio
Shopify's numeric id for the inventory item.
province_code_of_originstring
Province or state the item was made in, where recorded.
requires_shippingboolean
Whether the item is physical and has to be shipped.
skustring
Stock keeping unit shared with the variant.
trackedboolean
Whether Shopify counts stock for this item. Untracked items never fire the inventory-level topics.
updated_atstring
When the inventory item was last modified, ISO 8601.
weight_unitstring
Unit `weight_value` is expressed in, e.g. `lb`, `kg`.
weight_valuenumber
Shipping weight of the item, in `weight_unit`.

Instrucciones

Inventory Level UpdatedSHOPIFY_INVENTORY_LEVEL_UPDATEDTrigger

Triggers when the quantity of an inventory item changes at a location, in either direction, once per location affected. Shopify sends the new `available` count but no delta.

Configuración

location_idinteger
Only deliver events for this Shopify location, as its numeric id. Use `SHOPIFY_LIST_LOCATIONS` to find location ids. Leave unset to deliver every location.

Payload del evento

admin_graphql_api_idstring
The inventory level's GraphQL global id, which carries the inventory item id as a query parameter.
availableinteger
Units available to sell at this location after the change. Null while Shopify is still settling the count.
inventory_item_idinteger
Numeric id of the inventory item. Join it to a variant's `inventory_item_id` to find the product.
location_idinteger
Numeric id of the location holding the stock.
updated_atstring
When the level was last changed, ISO 8601.

Instrucciones

Inventory Shipment CreatedSHOPIFY_INVENTORY_SHIPMENT_CREATEDTrigger

Triggers when a shipment is created against a stock transfer, once per consignment. It starts as `DRAFT` and moves on through Inventory Shipment In Transit and Inventory Shipment Items Received.

Configuración

Sin parámetros.

Payload del evento

happened_atstring
When the shipment was created, ISO 8601.
idstringObligatorio
GraphQL global id of the shipment, e.g. `gid://shopify/InventoryShipment/3256352926`. Shipments have no numeric id on this topic.
line_itemsobject[]
The shipment's lines and the units each one carries.
statusstring
Where the shipment stands, `DRAFT` when it is first created. Arrives upper-cased.
trackingobject
Carrier tracking recorded against an inventory shipment.

Instrucciones

Inventory Shipment In TransitSHOPIFY_INVENTORY_SHIPMENT_IN_TRANSITTrigger

Triggers when a stock shipment is marked in transit. Shopify sends the status change only, with no lines and no tracking.

Configuración

Sin parámetros.

Payload del evento

happened_atstring
When the shipment was marked in transit, ISO 8601.
idstringObligatorio
GraphQL global id of the shipment now in transit.
statusstring
Where the shipment stands, `IN_TRANSIT` on this event. Arrives upper-cased.

Instrucciones

Inventory Shipment Items ReceivedSHOPIFY_INVENTORY_SHIPMENT_ITEMS_RECEIVEDTrigger

Triggers when items from a stock shipment are received, once per receiving step. `status` reads `PARTIALLY_RECEIVED` until the last step, and each line carries its accepted and rejected counts before and after.

Configuración

Sin parámetros.

Payload del evento

happened_atstring
When the items were received, ISO 8601.
idstringObligatorio
GraphQL global id of the shipment being received.
items_receivedobject[]
The lines touched by this receipt, each with its counts before and after and what is still outstanding.
statusstring
Where the shipment stands after this step, e.g. `PARTIALLY_RECEIVED`, `RECEIVED`. Arrives upper-cased.

Instrucciones

Inventory Shipment Tracking UpdatedSHOPIFY_INVENTORY_SHIPMENT_TRACKING_UPDATEDTrigger

Triggers when the carrier tracking on a stock shipment is set or changed. The body carries the tracking as it now stands, not what it replaced.

Configuración

Sin parámetros.

Payload del evento

happened_atstring
When the tracking was changed, ISO 8601.
shipment_idstring
GraphQL global id of the shipment. This topic names the shipment as `shipment_id`, unlike the other shipment topics which use `id`.
updated_trackingobject
Carrier tracking recorded against an inventory shipment.

Instrucciones

Inventory Stocked At LocationSHOPIFY_INVENTORY_STOCKED_AT_LOCATIONTrigger

Triggers when an inventory item starts being stocked at a location. This is the item being activated there, not its quantity changing — later quantity changes come through Inventory Level Updated.

Configuración

location_idinteger
Only deliver events for this Shopify location, as its numeric id. Use `SHOPIFY_LIST_LOCATIONS` to find location ids. Leave unset to deliver every location.

Payload del evento

admin_graphql_api_idstring
The inventory level's GraphQL global id, which carries the inventory item id as a query parameter.
availableinteger
Units available to sell at this location after the change. Null while Shopify is still settling the count.
inventory_item_idinteger
Numeric id of the inventory item. Join it to a variant's `inventory_item_id` to find the product.
location_idinteger
Numeric id of the location holding the stock.
updated_atstring
When the level was last changed, ISO 8601.

Instrucciones

Inventory Transfer Ready To ShipSHOPIFY_INVENTORY_TRANSFER_READY_TO_SHIPTrigger

Triggers when a stock transfer between the merchant's locations is marked ready to ship, before any shipment exists against it. Its lines name transfer-line ids rather than products.

Configuración

Sin parámetros.

Payload del evento

happened_atstring
When the transfer was marked ready to ship, ISO 8601.
idstringObligatorio
GraphQL global id of the transfer, e.g. `gid://shopify/InventoryTransfer/6167298206`. Transfers have no numeric id on this topic.
line_itemsobject[]
The transfer's lines and the units each one moves.
statusstring
Where the transfer stands, `READY_TO_SHIP` on this event. Arrives upper-cased.

Instrucciones

Inventory Unstocked At LocationSHOPIFY_INVENTORY_UNSTOCKED_AT_LOCATIONTrigger

Triggers when an inventory item stops being stocked at a location, either because the merchant deactivated it there or because the product was deleted. The body is just the item and location ids.

Configuración

location_idinteger
Only deliver events for this Shopify location, as its numeric id. Use `SHOPIFY_LIST_LOCATIONS` to find location ids. Leave unset to deliver every location.

Payload del evento

inventory_item_idinteger
Numeric id of the inventory item that is no longer stocked here. Join it to a variant's `inventory_item_id` to find the product.
location_idinteger
Numeric id of the location that stopped stocking the item.

Instrucciones

Location ActivatedSHOPIFY_LOCATION_ACTIVATEDTrigger

Triggers when a location is activated and can hold stock and fulfil orders again. Its previous stock is not restored; that arrives as Inventory Stocked At Location.

Configuración

Sin parámetros.

Payload del evento

activeboolean
Whether the location can hold stock and fulfil orders. Deactivating one leaves it on the store, unusable.
address1string
First line of the address.
address2string
Second line of the address.
admin_graphql_api_idstring
The location's GraphQL global id, e.g. `gid://shopify/Location/89748275358`.
citystring
City of the address.
countrystring
ISO 3166-1 alpha-2 country code, e.g. `CA`.
country_codestring
ISO 3166-1 alpha-2 country code, same as `country`.
country_namestring
Country name in full, e.g. `Canada`.
created_atstring
When the location was created, ISO 8601.
idintegerObligatorio
Shopify's numeric id for the location.
legacyboolean
Whether this is the implicit location Shopify created before multi-location inventory, rather than one the merchant added.
namestring
Name the merchant gave the location.
phonestring
Contact phone number for the location.
provincestring
Province or state name, e.g. `Ontario`.
province_codestring
Short province or state code, e.g. `ON`.
updated_atstring
When the location was last modified, ISO 8601.
zipstring
Postal or ZIP code.

Instrucciones

Location CreatedSHOPIFY_LOCATION_CREATEDTrigger

Triggers when a location is added to the store. A new location can hold inventory straight away, so this is the first sight of a `location_id` that will appear on the inventory triggers.

Configuración

Sin parámetros.

Payload del evento

activeboolean
Whether the location can hold stock and fulfil orders. Deactivating one leaves it on the store, unusable.
address1string
First line of the address.
address2string
Second line of the address.
admin_graphql_api_idstring
The location's GraphQL global id, e.g. `gid://shopify/Location/89748275358`.
citystring
City of the address.
countrystring
ISO 3166-1 alpha-2 country code, e.g. `CA`.
country_codestring
ISO 3166-1 alpha-2 country code, same as `country`.
country_namestring
Country name in full, e.g. `Canada`.
created_atstring
When the location was created, ISO 8601.
idintegerObligatorio
Shopify's numeric id for the location.
legacyboolean
Whether this is the implicit location Shopify created before multi-location inventory, rather than one the merchant added.
namestring
Name the merchant gave the location.
phonestring
Contact phone number for the location.
provincestring
Province or state name, e.g. `Ontario`.
province_codestring
Short province or state code, e.g. `ON`.
updated_atstring
When the location was last modified, ISO 8601.
zipstring
Postal or ZIP code.

Instrucciones

Location DeactivatedSHOPIFY_LOCATION_DEACTIVATEDTrigger

Triggers when a location is deactivated. It stays on the store with `active` reading `false`, but can no longer hold stock or fulfil orders.

Configuración

Sin parámetros.

Payload del evento

activeboolean
Whether the location can hold stock and fulfil orders. Deactivating one leaves it on the store, unusable.
address1string
First line of the address.
address2string
Second line of the address.
admin_graphql_api_idstring
The location's GraphQL global id, e.g. `gid://shopify/Location/89748275358`.
citystring
City of the address.
countrystring
ISO 3166-1 alpha-2 country code, e.g. `CA`.
country_codestring
ISO 3166-1 alpha-2 country code, same as `country`.
country_namestring
Country name in full, e.g. `Canada`.
created_atstring
When the location was created, ISO 8601.
idintegerObligatorio
Shopify's numeric id for the location.
legacyboolean
Whether this is the implicit location Shopify created before multi-location inventory, rather than one the merchant added.
namestring
Name the merchant gave the location.
phonestring
Contact phone number for the location.
provincestring
Province or state name, e.g. `Ontario`.
province_codestring
Short province or state code, e.g. `ON`.
updated_atstring
When the location was last modified, ISO 8601.
zipstring
Postal or ZIP code.

Instrucciones

Location DeletedSHOPIFY_LOCATION_DELETEDTrigger

Triggers when a location is deleted. Shopify sends only the location id, and a location must be deactivated first, so Location Deactivated normally arrives before it.

Configuración

Sin parámetros.

Payload del evento

idintegerObligatorio
Numeric id of the deleted location. This is the same id the inventory topics carry as `location_id`.

Instrucciones

Location UpdatedSHOPIFY_LOCATION_UPDATEDTrigger

Triggers when a location's own details change, such as its name, address or fulfilment settings. Activation and deactivation have their own triggers and are not reported here.

Configuración

Sin parámetros.

Payload del evento

activeboolean
Whether the location can hold stock and fulfil orders. Deactivating one leaves it on the store, unusable.
address1string
First line of the address.
address2string
Second line of the address.
admin_graphql_api_idstring
The location's GraphQL global id, e.g. `gid://shopify/Location/89748275358`.
citystring
City of the address.
countrystring
ISO 3166-1 alpha-2 country code, e.g. `CA`.
country_codestring
ISO 3166-1 alpha-2 country code, same as `country`.
country_namestring
Country name in full, e.g. `Canada`.
created_atstring
When the location was created, ISO 8601.
idintegerObligatorio
Shopify's numeric id for the location.
legacyboolean
Whether this is the implicit location Shopify created before multi-location inventory, rather than one the merchant added.
namestring
Name the merchant gave the location.
phonestring
Contact phone number for the location.
provincestring
Province or state name, e.g. `Ontario`.
province_codestring
Short province or state code, e.g. `ON`.
updated_atstring
When the location was last modified, ISO 8601.
zipstring
Postal or ZIP code.

Instrucciones

Market CreatedSHOPIFY_MARKET_CREATEDTrigger

Triggers when a market is created. New markets start as `draft` and sell nothing until they are activated, which arrives as Market Updated.

Configuración

Sin parámetros.

Payload del evento

idintegerObligatorio
Shopify's numeric id for the market.
namestring
Name the merchant gave the market.
statusstring
Whether the market is live: `active` sells to it, `draft` does not.
typestring
What the market is scoped by, e.g. `region`, `none` for a market with no regions assigned yet.

Instrucciones

Market UpdatedSHOPIFY_MARKET_UPDATEDTrigger

Triggers when a market is renamed, activated or otherwise changed. The body is a summary; the market's regions, currencies, domains and price lists are not included.

Configuración

Sin parámetros.

Payload del evento

idintegerObligatorio
Shopify's numeric id for the market.
namestring
Name the merchant gave the market.
statusstring
Whether the market is live: `active` sells to it, `draft` does not.
typestring
What the market is scoped by, e.g. `region`, `none` for a market with no regions assigned yet.

Instrucciones

Metafield Definition CreatedSHOPIFY_METAFIELD_DEFINITION_CREATEDTrigger

Triggers when a metafield definition is created, i.e. the schema for one custom field on a resource. Shopify follows every creation with a Metafield Definition Updated for the same definition moments later.

Configuración

Sin parámetros.

Payload del evento

access_onlyboolean
Whether the definition only grants access to metafields another owner defined, rather than defining them itself.
admin_filter_statusstring
Filterability as a status string, e.g. `not_filterable`. Shopify sends this alongside `admin_filterable_status`.
admin_filterableboolean
Whether staff can filter admin lists by this field.
admin_filterable_statusstring
Why the field is or is not filterable in the admin.
app_config_managedboolean
Whether an app owns the definition through its configuration, in which case staff cannot edit it.
created_atstring
When the definition was created, ISO 8601.
customer_accessstring
What customer-account surfaces may read the metafield, e.g. `none`, `read`.
deletingboolean
Whether Shopify is removing the definition and its metafields in the background.
descriptionstring
Help text shown to staff under the field.
idintegerObligatorio
Shopify's numeric id for the definition.
keystring
Key of the metafield within its namespace.
merchant_writeableboolean
Whether staff can edit the metafield in the admin.
namestring
Label shown to staff in the Shopify admin.
namespacestring
Namespace grouping the definition's metafields, e.g. `custom`. Namespace and key together identify a metafield on a resource.
option_linkableboolean
Whether product option values can be linked to this field's metaobject entries.
optionsobject[]
Validation rules the definition enforces on values written against it, such as a minimum or a regular expression.
owner_typestring
Resource the definition applies to, title-cased on this topic — `Product`, `Collection`, `Shop` — not the GraphQL enum casing.
pinned_positioninteger
Position of the field among those pinned to the top of the admin editor. `0` when it is not pinned.
smart_collection_conditionboolean
Whether the field can be used as a rule in an automated collection.
standard_template_idstring
Id of the Shopify standard definition this was created from, if the merchant picked one instead of defining their own.
storefront_readableboolean
Whether the Storefront API exposes the metafield.
type_namestring
Metafield type the definition enforces, e.g. `single_line_text_field`, `number_integer`.
unique_valuesboolean
Whether Shopify rejects a value already used on another resource.
updated_atstring
When the definition was last modified, ISO 8601.
use_as_collection_conditionboolean
Whether the merchant has turned the field on as an automated collection rule.
validation_statusstring
Whether existing metafields satisfy the definition's validations: `all_valid`, `in_progress` or `some_invalid`.

Instrucciones

Metafield Definition DeletedSHOPIFY_METAFIELD_DEFINITION_DELETEDTrigger

Triggers when a metafield definition is deleted. Shopify sends only its id, type class and creating app — no namespace, key or owner resource — so this trigger cannot offer the filters its create and update siblings do.

Configuración

Sin parámetros.

Payload del evento

idstringObligatorio
GraphQL global id of the deleted definition, e.g. `gid://shopify/MetafieldDefinition/254184521886`. The create and update topics send a numeric id instead; the digits at the end of this one are that same id.
typestring
Internal class name of the metafield type the definition used, e.g. `ShopifyMetafields::Types::SingleLineTextFieldType`. Not the `type_name` the create and update topics send.

Instrucciones

Metafield Definition UpdatedSHOPIFY_METAFIELD_DEFINITION_UPDATEDTrigger

Triggers when a metafield definition's name, description, validations, pinning or storefront access change. Values written into the metafields it defines are not reported.

Configuración

Sin parámetros.

Payload del evento

access_onlyboolean
Whether the definition only grants access to metafields another owner defined, rather than defining them itself.
admin_filter_statusstring
Filterability as a status string, e.g. `not_filterable`. Shopify sends this alongside `admin_filterable_status`.
admin_filterableboolean
Whether staff can filter admin lists by this field.
admin_filterable_statusstring
Why the field is or is not filterable in the admin.
app_config_managedboolean
Whether an app owns the definition through its configuration, in which case staff cannot edit it.
created_atstring
When the definition was created, ISO 8601.
customer_accessstring
What customer-account surfaces may read the metafield, e.g. `none`, `read`.
deletingboolean
Whether Shopify is removing the definition and its metafields in the background.
descriptionstring
Help text shown to staff under the field.
idintegerObligatorio
Shopify's numeric id for the definition.
keystring
Key of the metafield within its namespace.
merchant_writeableboolean
Whether staff can edit the metafield in the admin.
namestring
Label shown to staff in the Shopify admin.
namespacestring
Namespace grouping the definition's metafields, e.g. `custom`. Namespace and key together identify a metafield on a resource.
option_linkableboolean
Whether product option values can be linked to this field's metaobject entries.
optionsobject[]
Validation rules the definition enforces on values written against it, such as a minimum or a regular expression.
owner_typestring
Resource the definition applies to, title-cased on this topic — `Product`, `Collection`, `Shop` — not the GraphQL enum casing.
pinned_positioninteger
Position of the field among those pinned to the top of the admin editor. `0` when it is not pinned.
smart_collection_conditionboolean
Whether the field can be used as a rule in an automated collection.
standard_template_idstring
Id of the Shopify standard definition this was created from, if the merchant picked one instead of defining their own.
storefront_readableboolean
Whether the Storefront API exposes the metafield.
type_namestring
Metafield type the definition enforces, e.g. `single_line_text_field`, `number_integer`.
unique_valuesboolean
Whether Shopify rejects a value already used on another resource.
updated_atstring
When the definition was last modified, ISO 8601.
use_as_collection_conditionboolean
Whether the merchant has turned the field on as an automated collection rule.
validation_statusstring
Whether existing metafields satisfy the definition's validations: `all_valid`, `in_progress` or `some_invalid`.

Instrucciones

Product CreatedSHOPIFY_PRODUCT_CREATEDTrigger

Triggers when a product is created, from the admin, the API, an import or an app. A product with tracked inventory also fires Inventory Item Created and Inventory Stocked At Location.

Configuración

product_typestring
Only deliver products carrying this product type, as set on the product. Leave unset to deliver every type.
statusstring
Only deliver products in this state: `active`, `draft` or `archived`. Leave unset to deliver every state.

Payload del evento

admin_graphql_api_idstring
The product's GraphQL global id, e.g. `gid://shopify/Product/8860969205918`.
body_htmlstring
The product description, as HTML.
categoryobject
A product's node in Shopify's standard product taxonomy.
created_atstring
When the product was created, ISO 8601 with the shop's UTC offset.
handlestring
URL slug for the product, unique within the store, e.g. `merino-crew-neck`.
has_variants_that_requires_componentsboolean
Whether any variant is a bundle assembled from other products, which cannot be stocked directly.
idintegerObligatorio
Shopify's numeric id for the product.
imageobject
One image on a product.
imagesobject[]
Product images, in the order they appear on the product.
mediaobject[]
Images, videos and 3D models attached to the product.
optionsobject[]
The axes the variants vary along, such as Size or Colour.
product_typestring
The merchant's own product-type label, a free-text field.
published_atstring
When the product was published to its sales channels, ISO 8601. Null while it is unpublished.
published_scopestring
Where the product is published: `web` for the online store only, `global` for every channel.
statusstring
Whether the product is `active`, `draft` or `archived`. Only `active` products can be sold.
tagsstring
The product's tags as one comma-separated string, e.g. `new, sale`. Shopify sends this as text, not an array.
template_suffixstring
Suffix of the theme template rendering this product, e.g. `bold` for `product.bold.liquid`. Null when the default template is used.
titlestring
The product's name.
updated_atstring
When the product was last modified, ISO 8601.
variant_gidsobject[]
The same variants as GraphQL ids with their modification times — Shopify's own index for spotting which variant changed.
variantsobject[]
Every purchasable variant of the product.
vendorstring
Vendor or brand recorded on the product.

Instrucciones

Product DeletedSHOPIFY_PRODUCT_DELETEDTrigger

Triggers when a product is deleted. Shopify sends only the product id, and a product with tracked inventory also fires Inventory Unstocked At Location and Inventory Item Deleted per variant.

Configuración

Sin parámetros.

Payload del evento

idintegerObligatorio
Numeric id of the deleted product. The record is already gone, so this is the only handle on it — match it against your own copy.

Instrucciones

Product UpdatedSHOPIFY_PRODUCT_UPDATEDTrigger

Triggers when any field of a product changes, as one delivery per edit rather than one per field. It also fires when a variant's inventory quantity changes and when a metafield is written on the product, which makes it the highest-volume product trigger.

Configuración

product_typestring
Only deliver products carrying this product type, as set on the product. Leave unset to deliver every type.
statusstring
Only deliver products in this state: `active`, `draft` or `archived`. Leave unset to deliver every state.

Payload del evento

admin_graphql_api_idstring
The product's GraphQL global id, e.g. `gid://shopify/Product/8860969205918`.
body_htmlstring
The product description, as HTML.
categoryobject
A product's node in Shopify's standard product taxonomy.
created_atstring
When the product was created, ISO 8601 with the shop's UTC offset.
handlestring
URL slug for the product, unique within the store, e.g. `merino-crew-neck`.
has_variants_that_requires_componentsboolean
Whether any variant is a bundle assembled from other products, which cannot be stocked directly.
idintegerObligatorio
Shopify's numeric id for the product.
imageobject
One image on a product.
imagesobject[]
Product images, in the order they appear on the product.
mediaobject[]
Images, videos and 3D models attached to the product.
optionsobject[]
The axes the variants vary along, such as Size or Colour.
product_typestring
The merchant's own product-type label, a free-text field.
published_atstring
When the product was published to its sales channels, ISO 8601. Null while it is unpublished.
published_scopestring
Where the product is published: `web` for the online store only, `global` for every channel.
statusstring
Whether the product is `active`, `draft` or `archived`. Only `active` products can be sold.
tagsstring
The product's tags as one comma-separated string, e.g. `new, sale`. Shopify sends this as text, not an array.
template_suffixstring
Suffix of the theme template rendering this product, e.g. `bold` for `product.bold.liquid`. Null when the default template is used.
titlestring
The product's name.
updated_atstring
When the product was last modified, ISO 8601.
variant_gidsobject[]
The same variants as GraphQL ids with their modification times — Shopify's own index for spotting which variant changed.
variantsobject[]
Every purchasable variant of the product.
vendorstring
Vendor or brand recorded on the product.

Instrucciones

Product Variant Back In StockSHOPIFY_PRODUCT_VARIANT_BACK_IN_STOCKTrigger

Triggers when a variant's stock crosses back above zero across every location, not on every restock. It arrives a few seconds after the inventory change that caused it, so it is not ordered against Inventory Level Updated.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The variant's GraphQL global id, e.g. `gid://shopify/ProductVariant/48209618862238`. This is the id form the Admin GraphQL API takes.
barcodestring
Barcode, UPC, ISBN or GTIN recorded on the variant.
compare_at_pricestring
Price the variant is compared against to show a markdown, as a decimal string. Null when the variant is not on sale.
created_atstring
When the variant was created, ISO 8601 with the shop's UTC offset.
idintegerObligatorio
Shopify's numeric id for the variant.
image_idinteger
Numeric id of the product image assigned to this variant.
inventory_item_idinteger
Numeric id of the inventory item that holds this variant's stock. The join key to the inventory topics, which name the item rather than the variant.
inventory_policystring
What Shopify does once stock reaches zero: `deny` stops the sale, `continue` allows overselling.
inventory_quantityinteger
Units available across every location, after the event.
old_inventory_quantityinteger
Units available across every location before the event.
option1string
Value for the product's first option, e.g. `Small` when option one is `Size`.
option2string
Value for the product's second option, if it has one.
option3string
Value for the product's third option, if it has one.
positioninteger
1-based order of the variant within its product.
pricestring
Current price in the shop's currency, as a decimal string, e.g. `9.99`. Shopify sends money as strings to avoid float rounding.
product_idinteger
Numeric id of the product this variant belongs to.
skustring
The merchant's stock keeping unit for the variant.
taxableboolean
Whether tax is charged when the variant is sold.
titlestring
The variant's name, built from its option values, e.g. `Small / Blue`. Single-variant products get `Default Title`.
updated_atstring
When the variant was last modified, ISO 8601.

Instrucciones

Product Variant Out Of StockSHOPIFY_PRODUCT_VARIANT_OUT_OF_STOCKTrigger

Triggers when a variant's stock crosses to zero across every location, not on every sale. It arrives a few seconds after the inventory change that caused it, so it is not ordered against Inventory Level Updated.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The variant's GraphQL global id, e.g. `gid://shopify/ProductVariant/48209618862238`. This is the id form the Admin GraphQL API takes.
barcodestring
Barcode, UPC, ISBN or GTIN recorded on the variant.
compare_at_pricestring
Price the variant is compared against to show a markdown, as a decimal string. Null when the variant is not on sale.
created_atstring
When the variant was created, ISO 8601 with the shop's UTC offset.
idintegerObligatorio
Shopify's numeric id for the variant.
image_idinteger
Numeric id of the product image assigned to this variant.
inventory_item_idinteger
Numeric id of the inventory item that holds this variant's stock. The join key to the inventory topics, which name the item rather than the variant.
inventory_policystring
What Shopify does once stock reaches zero: `deny` stops the sale, `continue` allows overselling.
inventory_quantityinteger
Units available across every location, after the event.
old_inventory_quantityinteger
Units available across every location before the event.
option1string
Value for the product's first option, e.g. `Small` when option one is `Size`.
option2string
Value for the product's second option, if it has one.
option3string
Value for the product's third option, if it has one.
positioninteger
1-based order of the variant within its product.
pricestring
Current price in the shop's currency, as a decimal string, e.g. `9.99`. Shopify sends money as strings to avoid float rounding.
product_idinteger
Numeric id of the product this variant belongs to.
skustring
The merchant's stock keeping unit for the variant.
taxableboolean
Whether tax is charged when the variant is sold.
titlestring
The variant's name, built from its option values, e.g. `Small / Blue`. Single-variant products get `Default Title`.
updated_atstring
When the variant was last modified, ISO 8601.

Instrucciones

Shipping Profile CreatedSHOPIFY_SHIPPING_PROFILE_CREATEDTrigger

Triggers when a shipping profile is created. The body is a summary; the profile's zones, rates and products are not included.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The profile's GraphQL global id, e.g. `gid://shopify/DeliveryProfile/109752320158`.
defaultboolean
Whether this is the store's General profile, which covers every product no custom profile claims.
idintegerObligatorio
Shopify's numeric id for the shipping profile.
namestring
Name the merchant gave the profile.
profile_typestring
What the profile governs, e.g. `shipping`.
versioninteger
Revision counter Shopify increments on every edit to the profile.

Instrucciones

Shipping Profile DeletedSHOPIFY_SHIPPING_PROFILE_DELETEDTrigger

Triggers when a shipping profile is deleted. Unusually for a Shopify delete event the body is the whole profile, and the products it covered fall back to the store's General profile.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The profile's GraphQL global id, e.g. `gid://shopify/DeliveryProfile/109752320158`.
defaultboolean
Whether this is the store's General profile, which covers every product no custom profile claims.
idintegerObligatorio
Shopify's numeric id for the shipping profile.
namestring
Name the merchant gave the profile.
profile_typestring
What the profile governs, e.g. `shipping`.
versioninteger
Revision counter Shopify increments on every edit to the profile.

Instrucciones

Shipping Profile UpdatedSHOPIFY_SHIPPING_PROFILE_UPDATEDTrigger

Triggers when a shipping profile is renamed, or its zones, rates or product assignments change. Which of those changed is not reported, only that `version` advanced.

Configuración

Sin parámetros.

Payload del evento

admin_graphql_api_idstring
The profile's GraphQL global id, e.g. `gid://shopify/DeliveryProfile/109752320158`.
defaultboolean
Whether this is the store's General profile, which covers every product no custom profile claims.
idintegerObligatorio
Shopify's numeric id for the shipping profile.
namestring
Name the merchant gave the profile.
profile_typestring
What the profile governs, e.g. `shipping`.
versioninteger
Revision counter Shopify increments on every edit to the profile.

Instrucciones

Shop Settings UpdatedSHOPIFY_SHOP_SETTINGS_UPDATEDTrigger

Triggers when the store's own record changes — its address, currency, timezone, plan, tax or checkout settings. It also fires when a metafield on the store is written or deleted, with none of these fields moving.

Configuración

Sin parámetros.

Payload del evento

address1string
First line of the store's business address.
address2string
Second line of the store's business address.
auto_configure_tax_inclusivityboolean
Whether Shopify decides tax inclusivity per market rather than using one setting for the store.
checkout_api_supportedboolean
Whether the store may use the Checkout API.
citystring
City of the business address.
countrystring
ISO 3166-1 alpha-2 country code, e.g. `US`.
country_codestring
ISO 3166-1 alpha-2 country code, same as `country`.
country_namestring
Country name in full, e.g. `United States`.
county_taxesboolean
Whether county tax rates are applied on top of state rates.
created_atstring
When the store was created, ISO 8601.
currencystring
ISO 4217 code of the currency the store prices in, e.g. `USD`.
customer_emailstring
Address shoppers see as the sender and reply-to on store email.
domainstring
The store's primary customer-facing domain, which is the custom one once the merchant has connected it.
eligible_for_paymentsboolean
Whether the store may use Shopify Payments.
emailstring
The merchant's own contact address for account matters.
enabled_presentment_currenciesstring[]
Every currency shoppers may be shown prices in.
financesboolean
Whether financial data is available for the store.
google_apps_domainstring
Google Workspace domain linked to the store, where one is.
google_apps_login_enabledboolean
Whether staff sign in with that Google Workspace domain.
has_discountsboolean
Whether the store has ever created a discount.
has_gift_cardsboolean
Whether the store has ever issued a gift card.
has_storefrontboolean
Whether the store has an online storefront at all.
iana_timezonestring
The same timezone as an IANA name, e.g. `America/New_York`. Use this one for date arithmetic.
idintegerObligatorio
Shopify's numeric id for the store.
latitudenumber
Latitude Shopify geocoded from the business address.
longitudenumber
Longitude Shopify geocoded from the business address.
marketing_email_consent_enabled_at_checkoutboolean
Whether checkout offers shoppers email marketing consent.
marketing_sms_consent_enabled_at_checkoutboolean
Whether checkout offers shoppers SMS marketing consent.
money_formatstring
Liquid template the storefront renders prices with, e.g. `${{amount}}`.
money_in_emails_formatstring
Price template used in the store's email notifications.
money_with_currency_formatstring
Price template including the currency code.
money_with_currency_in_emails_formatstring
Email price template including the currency code.
multi_location_enabledboolean
Whether the store can stock inventory at more than one location.
myshopify_domainstring
The store's permanent `*.myshopify.com` domain. This never changes, unlike `domain`.
namestring
The store's name.
password_enabledboolean
Whether the storefront is behind a password page and closed to the public.
phonestring
The store's contact phone number.
plan_display_namestring
The plan's name as the merchant sees it, e.g. `Shopify`.
plan_namestring
Internal handle of the store's Shopify plan, e.g. `professional`.
pre_launch_enabledboolean
Whether the store is still in its pre-launch state.
primary_localestring
ISO code of the store's default language, e.g. `en`.
primary_location_idinteger
Numeric id of the location Shopify fulfils from by default. Joins to the `location_id` on the inventory topics.
provincestring
Province or state name of the business address.
province_codestring
Short province or state code, e.g. `ON`.
requires_extra_payments_agreementboolean
Whether Shopify needs an extra payments agreement before the store can take payments.
setup_requiredboolean
Whether Shopify still requires setup steps before selling.
shop_ownerstring
Name of the account owner.
sourcestring
How the store was signed up, where Shopify recorded it.
tax_shippingboolean
Whether tax is charged on shipping.
taxes_includedboolean
Whether product prices already include tax.
timezonestring
The store's timezone as Shopify displays it, e.g. `(GMT-05:00) Eastern Time (US & Canada)`.
transactional_sms_disabledboolean
Whether the store has turned off transactional SMS to shoppers.
updated_atstring
When the store's record was last modified, ISO 8601.
weight_unitstring
Default unit for product weights, e.g. `lb`, `kg`.
zipstring
Postal or ZIP code.

Instrucciones

Store Language AddedSHOPIFY_STORE_LANGUAGE_ADDEDTrigger

Triggers when a language is added to the store. It is normally added unpublished, so `published` reads `false` until the merchant makes it visible, which arrives as Store Language Updated.

Configuración

Sin parámetros.

Payload del evento

localestring
ISO language code for the language, e.g. `fr` or `pt-BR`. This is the identifier Shopify uses for the store's locales.
publishedboolean
Whether shoppers can browse the storefront in this language. A language can be added unpublished while translations are prepared.

Instrucciones

Store Language RemovedSHOPIFY_STORE_LANGUAGE_REMOVEDTrigger

Triggers when a language is removed from the store, taking its stored translations with it. `published` describes the language as it stood at removal.

Configuración

Sin parámetros.

Payload del evento

localestring
ISO language code for the language, e.g. `fr` or `pt-BR`. This is the identifier Shopify uses for the store's locales.
publishedboolean
Whether shoppers can browse the storefront in this language. A language can be added unpublished while translations are prepared.

Instrucciones

Store Language UpdatedSHOPIFY_STORE_LANGUAGE_UPDATEDTrigger

Triggers when a store language is published or unpublished. `published` is what changes; the language stays on the store either way.

Configuración

Sin parámetros.

Payload del evento

localestring
ISO language code for the language, e.g. `fr` or `pt-BR`. This is the identifier Shopify uses for the store's locales.
publishedboolean
Whether shoppers can browse the storefront in this language. A language can be added unpublished while translations are prepared.