Shopify Component
Manage customers, products, and orders in your Shopify platform
Component key: shopify
Description
Shopify is a multinational e-commerce company. They offer a subscription-based software that allows anyone to set up an online store and sell their products. This component allows you to manage the products and customers connected to your Shopify account.
API Documentation
This component was built using the Shopify GraphQL Admin API Reference.
Example Shopify Integration
An example Shopify integration is available in our GitHub examples repo. You can import the integration definition and try it out yourself.
The example integration consists of four flows that demonstrate how to interact with the Shopify API:
-
Initial Product Sync runs when an instance of the integration is deployed. It loops over Shopify's paginated API, fetching pages of products and sending all products to an "Acme API" (you'll insert your own API there).
-
Product Update Listener subscribes to
product/create,product/updateandproduct/deleteevents from Shopify. Whenever a user creates, updates, or deletes a product in Shopify, the integration receives a webhook request from Shopify and sends the create, update or delete to the "Acme API". -
List Inventory Levels fetches inventory levels for all products in Shopify at a particular location which the user specified as part of the deployment process. The flow is triggered synchronously, so the caller will receive a response with a JSON body containing the inventory levels.
-
Create New Product is a flow that creates a new product in Shopify. To invoke the flow, you can send a POST request to the flow's webhook endpoint with a format that looks like this:
{
"name": "Green T-Shirt",
"description": "A green t-shirt",
"product_type": "T-Shirt",
"vendor": "Acme"
}
This example integration's OAuth connection is configured to redirect to a local server running on port 3001 when authentication is complete. See the video under Shopify OAuth 2.0 for more information.
Connections
Admin API Access Token
An admin API access token can be used for testing purposes as you develop your integration. You can create an access token from the API credentials tab of a private Shopify app that you create.
Before publishing an integration for customers, we recommend you switch to OAuth 2.0 authentication to give your users a single button-click experience.
| Input | Default | Notes | Example |
|---|---|---|---|
Admin API Access Token password / Required adminApiAccessToken | Generate from the 'API credentials' tab of a private Shopify app that you own | shpat_00000000000000000000000000000000 | |
Host string / Required host | YOUR-SHOPIFY-DOMAIN.myshopify.com | The domain of your Shopify platform, without the https:// | YOUR-SHOPIFY-DOMAIN.myshopify.com |
Shopify OAuth 2.0
The Shopify component authenticates requests through OAuth 2.0. Information on how to generate an OAuth 2.0 app with Shopify can be found in their documentation
- Navigate to the Configuration section of your created app. In the Allowed redirection URL(s) enter
https://oauth2.prismatic.io/callbackfor US based integrations.- For integrations outside the US refer to this guide to find your region’s Callback URL.
For information on what Scopes you should request, see the Shopify documentation.
Shopify Authentication Requirements
Unlike other apps, Shopify requires that your users initiate the OAuth flow from Shopify. That means that your frontend app will need to handle an installation request from Shopify. Additionally, each store has a distinct OAuth 2.0 authorization and token URLs, so your app will need to set those dynamically after receiving an installation request from Shopify.
An example of how to handle Shopify requests in a ReactJS app is available in the embedded repository on GitHub - see https://github.com/prismatic-io/embedded/pull/74.
- authenticate.tsx handles the initial installation request from Shopify, verifying that the request is valid by checking the request's HMAC signature.
It then redirects a user to
/shopify/install. - shopify/install.tsx checks if the user has an existing instance of your Shopify integration. If not, one is created. The user's authorization URL and token URL are automatically set based on the store's domain. The user is then sent to Shopify to authorize your app.
- shopify/configure.tsx is where the user is redirected after authorizing your app. The user already completed the OAuth process, and can proceed with the remainder of the setup process.
| Input | Default | Notes | Example |
|---|---|---|---|
Authorize URL string / Required authorizeUrl | https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/authorize | The OAuth 2.0 Authorization URL for Shopify | |
API Key string / Required clientId | Obtain this by creating an app at https://partners.shopify.com/ | ||
API Secret password / Required clientSecret | Obtain this by creating an app at https://partners.shopify.com/ | ||
Host string / Required host | YOUR-SHOPIFY-DOMAIN.myshopify.com | The domain of your Shopify platform, without the https:// | YOUR-SHOPIFY-DOMAIN.myshopify.com |
Scopes string scopes | read_customers read_draft_orders read_fulfillments read_inventory read_orders read_products read_locations write_customers write_draft_orders write_fulfillments write_inventory write_orders write_products write_locations | A space-delimited set of one or more scopes to get the user's permission to access. A list of all scopes is available at https://shopify.dev/api/usage/access-scopes#authenticated-access-scopes | |
Token URL string / Required tokenUrl | https://YOUR-SHOPIFY-DOMAIN.myshopify.com/admin/oauth/access_token | The OAuth 2.0 Token URL for Shopify |
Triggers
Event Topic Webhook
Set event based webhooks and get notified when these event types are created, updated, or deleted. | key: eventTopicWebhookGql
| Input | Notes | Example |
|---|---|---|
Secret Key string / Required secret_key | The Shopify app's client secret, viewable from the Partner Dashboard. | |
Connection connection / Required shopifyConnection | ||
Webhook Topic string / Required Value List webhookTopics | The topic for the webhook. This is the event that will trigger the webhook. | APP_PURCHASES_ONE_TIME_UPDATE |
Event Topic Webhook (Deprecated)
Set event based webhooks and get notified when these event types are created, updated, or deleted. This version of the trigger is being deprecated. Please replace trigger with Event Topic Webhook. | key: eventTopicWebhook
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connectionInput | ||
Secret Key string / Required secret_key | The Shopify app's client secret, viewable from the Partner Dashboard | |
Event Topic Name string / Required Value List webhookTopic | Event that triggers the webhook. | products/create |
Webhook
Receive and validate webhook requests from Shopify for webhooks you configure. | key: webhook
| Input | Notes |
|---|---|
Secret Key string / Required secret_key | The Shopify app's client secret, viewable from the Partner Dashboard |
You can configure a Shopify webhook to send information to a Prismatic webhook URL under certain conditions (a "Customer" is created, a "Order" is shipped, etc.).
A full list of configurable operations is available on the Shopify Docs
Data Sources
Select Customers
A picklist of all customers. | key: listCustomers | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required shopifyConnection |
Select Fulfillment Orders
A picklist of all fulfillment orders. | key: listFulfillmentOrders | type: picklist
| Input | Notes | Example |
|---|---|---|
Order ID string / Required orderId | Provide the unique ID of the order. | 450789469 |
Connection connection / Required shopifyConnection |
Select Fulfillments
A picklist of all fulfillments. | key: listFulfillments | type: picklist
| Input | Notes | Example |
|---|---|---|
Order ID string / Required orderId | Provide the unique ID of the order. | 450789469 |
Connection connection / Required shopifyConnection |
Select Locations
A picklist of all locations. | key: listLocations | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required shopifyConnection |
Select Orders
A picklist of all orders. | key: listOrders | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required shopifyConnection |
Select Products
A picklist of all products. | key: listProducts | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required shopifyConnection |
Actions
Cancel Order
Cancel an existing order. | key: cancelOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Notify Customer boolean notifyCustomer | false | Whether the customer should be notified of the cancellation. | |
Order ID string / Required orderId | Provide the unique ID of the order. | 10079785100 or gid://shopify/Order/10079785100 | |
Reason string / Required reason | The reason for the cancellation. | CUSTOMER | |
Refund boolean / Required refund | false | Whether to refund the amount paid by the customer. | |
Restock boolean / Required restock | false | Whether to restock the inventory committed to the order. | |
Connection connection / Required shopifyConnection | |||
Staff Note string staffNote | A staff-facing note about the order cancellation. This is not visible to the customer. | This is a staff note. |
{
"data": {
"job": {
"id": "gid://shopify/Job/d3dcd8af-2cb6-4995-ab04-634a21891234",
"done": false
},
"orderCancelUserErrors": [],
"userErrors": []
}
}
Close Order
Closes a completed order. | key: closeOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Order ID string / Required orderId | Provide the unique ID of the order. | 10079785100 or gid://shopify/Order/10079785100 | |
Connection connection / Required shopifyConnection |
{
"data": {
"order": {
"id": "gid://shopify/Order/1234567890123",
"name": "#1234",
"app": {
"id": "gid://shopify/App/9876543210987"
},
"clientIp": "0.0.0.0",
"customerAcceptsMarketing": false,
"cancelReason": null,
"cancelledAt": null,
"closedAt": null,
"confirmationNumber": "ABC123XYZ",
"confirmed": true,
"createdAt": "2024-12-08T11:29:38Z",
"currencyCode": "USD",
"currentSubtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalAdditionalFeesSet": null,
"currentTotalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"currentTotalDutiesSet": null,
"currentTotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"customerLocale": "en",
"discountCodes": [],
"dutiesIncluded": false,
"email": "example@example.com",
"estimatedTaxes": false,
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"retailLocation": null,
"merchantBusinessEntity": {
"id": "gid://shopify/BusinessEntity/1122334455667"
},
"merchantOfRecordApp": null,
"note": "Example note",
"originalTotalAdditionalFeesSet": null,
"originalTotalDutiesSet": null,
"paymentGatewayNames": [
"manual"
],
"phone": null,
"poNumber": null,
"presentmentCurrencyCode": "USD",
"processedAt": "2024-12-08T11:29:38Z",
"sourceIdentifier": "example-source-id",
"sourceName": "9876543210987",
"registeredSourceUrl": null,
"subtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"tags": [],
"taxExempt": true,
"taxLines": [],
"taxesIncluded": false,
"test": false,
"totalCashRoundingAdjustment": {
"paymentSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"refundSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
}
},
"totalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"totalOutstandingSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalShippingPriceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTipReceivedSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalWeight": "5000",
"updatedAt": "2024-12-08T11:29:39Z",
"billingAddress": {
"address1": "123 Example St",
"address2": null,
"name": "John Doe",
"lastName": "Doe",
"company": null,
"phone": null,
"zip": "12345",
"country": "United States",
"countryCodeV2": "US",
"province": "California",
"provinceCode": "CA"
},
"customer": {
"id": "gid://shopify/Customer/4567890123456",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"phone": null
},
"lineItems": {
"nodes": [
{
"id": "gid://shopify/LineItem/2345678901234",
"currentQuantity": 3,
"unfulfilledQuantity": 3,
"isGiftCard": false,
"name": "Sample Product",
"originalUnitPriceSet": {
"shopMoney": {
"amount": "16.67",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "16.67",
"currencyCode": "USD"
}
},
"product": null,
"quantity": 3,
"requiresShipping": true,
"sku": "EX123",
"taxable": true,
"title": "Sample Product",
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"variant": null,
"vendor": "Example Vendor",
"taxLines": [
{
"channelLiable": false,
"priceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"rate": 0.05,
"title": "Example Tax"
}
],
"duties": [],
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 0
}
}
]
}
]
},
"paymentTerms": null,
"refunds": [],
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": null,
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
}
},
"userErrors": []
}
}
Complete Draft Order
Mark a draft order as complete. | key: completeDraftOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Draft Order Id string / Required draftOrderId | Provide a value for the unique ID of the draft order. | 916042021234 or gid://shopify/DraftOrder/916042021234 | |
Connection connection / Required shopifyConnection |
{
"data": {
"draftOrder": {
"id": "gid://shopify/DraftOrder/1234567890123",
"note2": "Sample Note",
"email": "example@email.com",
"taxesIncluded": false,
"currencyCode": "USD",
"invoiceSentAt": null,
"createdAt": "2024-12-31T07:30:32Z",
"updatedAt": "2024-12-31T07:30:33Z",
"taxExempt": true,
"completedAt": "2024-12-31T07:30:33Z",
"name": "#D123",
"status": "COMPLETED",
"lineItems": {
"nodes": [
{
"id": "gid://shopify/DraftOrderLineItem/9876543210987",
"variant": null,
"product": null,
"title": "Example Product",
"variantTitle": null,
"sku": null,
"vendor": null,
"quantity": 3,
"requiresShipping": false,
"taxable": true,
"isGiftCard": false,
"fulfillmentService": {
"type": "MANUAL"
},
"weight": {
"unit": "KILOGRAMS",
"value": 2
},
"taxLines": [
{
"channelLiable": null,
"priceSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"rate": 0.05,
"ratePercentage": 5,
"source": "Shopify",
"title": "Example State Tax"
}
],
"appliedDiscount": {
"title": "Promo",
"value": 10,
"valueType": "PERCENTAGE",
"description": "Seasonal Discount",
"amountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
},
"name": "Example Product",
"custom": true,
"originalUnitPriceSet": {
"shopMoney": {
"currencyCode": "USD",
"amount": "20.00"
}
}
}
]
},
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"billingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"invoiceUrl": "https://example-store.myshopify.com/123456/invoices/abcdef123456",
"appliedDiscount": null,
"order": {
"id": "gid://shopify/Order/8765432109876"
},
"shippingLine": null,
"taxLines": [],
"tags": [],
"totalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"subtotalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"paymentTerms": null,
"customer": {
"id": "gid://shopify/Customer/1234567890123",
"email": "example@email.com",
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2024-12-31T07:30:33Z",
"firstName": "John",
"lastName": "Doe",
"numberOfOrders": "5",
"state": "ENABLED",
"amountSpent": {
"amount": "500.00",
"currencyCode": "USD"
},
"lastOrder": {
"id": "gid://shopify/Order/8765432109876",
"name": "#5678"
},
"note": null,
"verifiedEmail": true,
"multipassIdentifier": null,
"taxExempt": false,
"tags": [],
"phone": "123-456-7890",
"taxExemptions": [],
"emailMarketingConsent": {
"marketingState": "SUBSCRIBED",
"consentUpdatedAt": null
},
"smsMarketingConsent": null,
"defaultAddress": {
"id": "gid://shopify/MailingAddress/9876543210987",
"firstName": "John",
"lastName": "Doe",
"company": "Example Corp",
"address1": "123 Example St",
"address2": "Apt 101",
"city": "Example City",
"province": "California",
"country": "United States",
"zip": "12345",
"phone": "123-456-7890",
"name": "John Doe",
"provinceCode": "CA",
"countryCodeV2": "US"
}
}
},
"userErrors": []
}
}
Connect Inventory Item To Location
Connect an existing Inventory Item to an existing Location. | key: connectInventoryLevelGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Inventory Item Id string / Required itemId | Provide a unique ID of a Inventory Item. | gid://shopify/InventoryItem/43933612241234 | |
Location ID string / Required locationId | The ID of the location that the inventory level belongs to. | 346779380 or gid://shopify/Location/346779380 | |
Connection connection / Required shopifyConnection |
{
"data": {
"inventoryLevel": {
"id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076",
"item": {
"id": "gid://shopify/InventoryItem/43729076"
},
"location": {
"id": "gid://shopify/Location/346779380"
},
"quantities": [
{
"name": "available",
"quantity": 0
}
],
"updatedAt": "2024-11-07T20:59:45Z"
},
"userErrors": []
}
}
Count Collections
Count all available collections. | key: countCollectionsGql
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"count": 5
}
}
Count Customers
Retrieve a count of all the customers connected to your platform. | key: countCustomersGql
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"count": 20
}
}
Count Draft Orders
Returns a count of all draft orders. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change. | key: countDraftOrdersGql
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"count": 5
}
}
Count Location
Count the number of locations enabled on your platform. | key: countLocationsGql
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"count": 10
}
}
Count Orders
Returns a count of all orders. | key: countOrdersGql
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"count": 58
}
}
Count Product Images
Count all product images connected to your platform. | key: countProductImagesGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Connection connection / Required shopifyConnection |
{
"data": {
"count": 5
}
}
Count Products
Count all Products in your account. | key: countProducts
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"count": 5
},
"headers": {
"date": "Wed, 27 Mar 2024 00:52:16 GMT",
"content-type": "application/json; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close",
"x-sorting-hat-podid": "152",
"x-sorting-hat-shopid": "12345678912",
"vary": "Accept-Encoding, Accept",
"referrer-policy": "origin-when-cross-origin",
"x-frame-options": "DENY",
"x-shopid": "12345678912",
"x-shardid": "152",
"x-stats-userid": "",
"x-stats-apiclientid": "6511123",
"x-stats-apipermissionid": "429538082969",
"x-shopify-api-version": "2023-04",
"x-shopify-api-version-warning": "https://shopify.dev/concepts/about-apis/versioning",
"http_x_shopify_shop_api_call_limit": "3/40",
"x-shopify-shop-api-call-limit": "3/40",
"strict-transport-security": "max-age=7889238",
"x-request-id": "4c63b1a7-fdc1-4113-a2d5-46f6c883c1d9-123456",
"server-timing": "processing;dur=57, cfRequestDuration;dur=134.000063",
"x-shopify-stage": "production",
"content-security-policy": "default-src 'self' data: blob: 'unsafe-inline' 'unsafe-eval' https://* shopify-pos://*; block-all-mixed-content; child-src 'self' https://* shopify-pos://*; connect-src 'self' wss://* https://*; frame-ancestors 'none'; img-src 'self' data: blob: https:; script-src https://cdn.shopify.com https://cdn.shopifycdn.net https://checkout.shopifycs.com https://api.stripe.com https://mpsnare.iesnare.com https://appcenter.intuit.com https://www.paypal.com https://js.braintreegateway.com https://c.paypal.com https://maps.googleapis.com https://www.google-analytics.com https://v.shopify.com 'self' 'unsafe-inline' 'unsafe-eval'; upgrade-insecure-requests; report-uri /csp-report?source%5Baction%5D=show&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Fcollects&source%5Bsection%5D=admin_api&source%5Buuid%5D=4c63b1a7-fdc1-4113-a2d5-46f6c883c1d9-123456",
"x-content-type-options": "nosniff",
"x-download-options": "noopen",
"x-permitted-cross-domain-policies": "none",
"x-xss-protection": "1; mode=block; report=/xss-report?source%5Baction%5D=show&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Fcollects&source%5Bsection%5D=admin_api&source%5Buuid%5D=4c63b1a7-fdc1-4113-a2d5-46f6c883c1d9-123456",
"x-envoy-upstream-service-time": "59",
"x-dc": "gcp-northamerica-northeast2,gcp-us-central1",
"cf-cache-status": "DYNAMIC",
"report-to": "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=bSI8sLfHnRK2xdtpDsJLmjZsjNiEF9jW2sYK9naPjTlyeKLJ8DBSsj00CktG5DIPBht7esrQCCPe61VrMCWdM6dW3uCwmngxHy8iJi8Caumvx65uVDdkSQIZOZGV5hvWmbubfOW9xyg7HkPcf8sAQcv3\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
"nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
"server": "cloudflare",
"cf-ray": "86ab65927cbbe283-ORD",
"alt-svc": "h3=\":443\"; ma=86400"
}
}
}
Count Variants
Count all product variants. | key: countVariantsGql
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"count": 12
}
}
Create Account Activation URL
Create an account activation URL for an existing customer. | key: createAccountActivationURLGql
| Input | Default | Notes | Example |
|---|---|---|---|
Customer string / Required customerIdGql | Provide a value for the unique ID of the customer. | 5940139491234 or gid://shopify/Customer/5940139491234 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection |
{
"data": {
"accountActivationUrl": "https://activation.example.com",
"userErrors": []
}
}
Create Customer
Create a new customer. | key: createCustomer
| Input | Default | Notes | Example |
|---|---|---|---|
Address List code / Required addressList | Provide a JSON array containing address objects | ||
Currency Format string currency | Provide a valid currency format | USD | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Email string / Required email | Provide a string value for the email of the customer. | someone@example.com | |
Values string Key Value List fieldValues | The names of the fields and their values to use when creating/updating a record. You can use this input to specify the key and value of any property that is not already in Prismatic. | ||
First Name string / Required firstName | Provide a string value for the first name | John | |
Last Name string / Required lastName | Provide a string value for the last name of the customer. | Doe | |
Metafields code metafields | Provide a JSON array containing metadata objects. | ||
Notes string notes | Provide a value for a note on the customer. | This is an example note. | |
Phone string phone | Provide a value for the phone number of the customer. | +18005555454 | |
Connection connection / Required shopifyConnection | |||
Tags string Value List tags | For each list item, provide a string you would like to tag the product with. | Style | |
Tax Exempt boolean taxExempt | false | Determines if the customer is tax exempt. | |
Verified Email boolean / Required verifiedEmail | false | This flag will enable emails to be sent to the customer. |
{
"data": {
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"accepts_marketing": false,
"created_at": "2023-07-11T18:25:37-04:00",
"updated_at": "2023-07-11T18:25:37-04:00",
"first_name": "Bob",
"last_name": "Norman",
"orders_count": 1,
"state": "disabled",
"total_spent": "199.65",
"last_order_id": 450789469,
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"tags": "Léon, Noël",
"last_order_name": "#1001",
"currency": "USD",
"phone": "+16136120707",
"addresses": [
{
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
],
"accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
"marketing_opt_in_level": null,
"tax_exemptions": [],
"email_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": null,
"consent_updated_at": "2004-06-13T11:57:11-04:00"
},
"sms_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": "single_opt_in",
"consent_updated_at": "2023-07-11T18:25:37-04:00",
"consent_collected_from": "OTHER"
},
"admin_graphql_api_id": "gid://shopify/Customer/207119551",
"default_address": {
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
}
}
}
Create Draft Orders
Create a new draft order. | key: createDraftOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. This is a JSON object. | ||
Customer string / Required customerIdGql | Provide a value for the unique ID of the customer. | 5940139491234 or gid://shopify/Customer/5940139491234 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Line items code / Required lineItems | Provide a JSON array containing line item objects. | ||
Note string note | Provide a value for the note on the draft order. | Test draft order | |
Connection connection / Required shopifyConnection | |||
Tags string Value List tags | Provide a list of tags for the draft order. | Style | |
Tax Exempt boolean taxExempt | false | Whether or not taxes are exempt for the draft order. | |
Use Customer Address boolean / Required useCustomerAddress | true | This flag determines if the order will use the customers default address. |
{
"data": {
"userErrors": [],
"draftOrder": {
"id": "gid://shopify/DraftOrder/1234567890123",
"note2": "Sample Note",
"email": "example@email.com",
"taxesIncluded": false,
"currencyCode": "USD",
"invoiceSentAt": null,
"createdAt": "2024-12-31T07:30:32Z",
"updatedAt": "2024-12-31T07:30:33Z",
"taxExempt": true,
"completedAt": "2024-12-31T07:30:33Z",
"name": "#D123",
"status": "COMPLETED",
"lineItems": {
"nodes": [
{
"id": "gid://shopify/DraftOrderLineItem/9876543210987",
"variant": null,
"product": null,
"title": "Example Product",
"variantTitle": null,
"sku": null,
"vendor": null,
"quantity": 3,
"requiresShipping": false,
"taxable": true,
"isGiftCard": false,
"fulfillmentService": {
"type": "MANUAL"
},
"weight": {
"unit": "KILOGRAMS",
"value": 2
},
"taxLines": [
{
"channelLiable": null,
"priceSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"rate": 0.05,
"ratePercentage": 5,
"source": "Shopify",
"title": "Example State Tax"
}
],
"appliedDiscount": {
"title": "Promo",
"value": 10,
"valueType": "PERCENTAGE",
"description": "Seasonal Discount",
"amountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
},
"name": "Example Product",
"custom": true,
"originalUnitPriceSet": {
"shopMoney": {
"currencyCode": "USD",
"amount": "20.00"
}
}
}
]
},
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"billingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"invoiceUrl": "https://example-store.myshopify.com/123456/invoices/abcdef123456",
"appliedDiscount": null,
"order": {
"id": "gid://shopify/Order/8765432109876"
},
"shippingLine": null,
"taxLines": [],
"tags": [],
"totalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"subtotalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"paymentTerms": null,
"customer": {
"id": "gid://shopify/Customer/1234567890123",
"email": "example@email.com",
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2024-12-31T07:30:33Z",
"firstName": "John",
"lastName": "Doe",
"numberOfOrders": "5",
"state": "ENABLED",
"amountSpent": {
"amount": "500.00",
"currencyCode": "USD"
},
"lastOrder": {
"id": "gid://shopify/Order/8765432109876",
"name": "#5678"
},
"note": null,
"verifiedEmail": true,
"multipassIdentifier": null,
"taxExempt": false,
"tags": [],
"phone": "123-456-7890",
"taxExemptions": [],
"emailMarketingConsent": {
"marketingState": "SUBSCRIBED",
"consentUpdatedAt": null
},
"smsMarketingConsent": null,
"defaultAddress": {
"id": "gid://shopify/MailingAddress/9876543210987",
"firstName": "John",
"lastName": "Doe",
"company": "Example Corp",
"address1": "123 Example St",
"address2": "Apt 101",
"city": "Example City",
"province": "California",
"country": "United States",
"zip": "12345",
"phone": "123-456-7890",
"name": "John Doe",
"provinceCode": "CA",
"countryCodeV2": "US"
}
}
}
}
}
Create Fulfillment Service
Create a fulfillment service. | key: createFulfillmentServiceGql
| Input | Default | Notes | Example |
|---|---|---|---|
Callback URL string / Required callbackUrl | The callback URL that the fulfillment service has registered for request. | https://example.com | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Fulfillment Service Name string / Required fulfillmentServiceName | The name of the fulfillment service. | MyFulfillmentService | |
Inventory Management boolean inventoryManagement | false | Whether the fulfillment services tracks product inventory and provides updates to Shopify. | |
Connection connection / Required shopifyConnection | |||
Tracking Support boolean trackingSupport | false | Whether the fulfillment service supports tracking numbers for packages. |
{
"data": {
"fulfillmentService": {
"id": "gid://shopify/FulfillmentService/1234567890?id=true",
"serviceName": "ExampleFulfillmentService",
"handle": "examplefulfillmentservice",
"location": {
"id": "gid://shopify/Location/0987654321"
},
"callbackUrl": "https://example.com/",
"trackingSupport": false,
"inventoryManagement": false,
"permitsSkuSharing": false
},
"userErrors": []
}
}
Create Order
Create a new order. | key: createOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Order Data code / Required orderData | JSON data to be sent as the Order payload. | ||
Connection connection / Required shopifyConnection |
{
"data": {
"order": {
"id": "gid://shopify/Order/1234567890123",
"name": "#1234",
"app": {
"id": "gid://shopify/App/9876543210987"
},
"clientIp": "0.0.0.0",
"customerAcceptsMarketing": false,
"cancelReason": null,
"cancelledAt": null,
"closedAt": null,
"confirmationNumber": "ABC123XYZ",
"confirmed": true,
"createdAt": "2024-12-08T11:29:38Z",
"currencyCode": "USD",
"currentSubtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalAdditionalFeesSet": null,
"currentTotalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"currentTotalDutiesSet": null,
"currentTotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"customerLocale": "en",
"discountCodes": [],
"dutiesIncluded": false,
"email": "example@example.com",
"estimatedTaxes": false,
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"retailLocation": null,
"merchantBusinessEntity": {
"id": "gid://shopify/BusinessEntity/1122334455667"
},
"merchantOfRecordApp": null,
"note": "Example note",
"originalTotalAdditionalFeesSet": null,
"originalTotalDutiesSet": null,
"paymentGatewayNames": [
"manual"
],
"phone": null,
"poNumber": null,
"presentmentCurrencyCode": "USD",
"processedAt": "2024-12-08T11:29:38Z",
"sourceIdentifier": "example-source-id",
"sourceName": "9876543210987",
"registeredSourceUrl": null,
"subtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"tags": [],
"taxExempt": true,
"taxLines": [],
"taxesIncluded": false,
"test": false,
"totalCashRoundingAdjustment": {
"paymentSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"refundSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
}
},
"totalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"totalOutstandingSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalShippingPriceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTipReceivedSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalWeight": "5000",
"updatedAt": "2024-12-08T11:29:39Z",
"billingAddress": {
"address1": "123 Example St",
"address2": null,
"name": "John Doe",
"lastName": "Doe",
"company": null,
"phone": null,
"zip": "12345",
"country": "United States",
"countryCodeV2": "US",
"province": "California",
"provinceCode": "CA"
},
"customer": {
"id": "gid://shopify/Customer/4567890123456",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"phone": null
},
"lineItems": {
"nodes": [
{
"id": "gid://shopify/LineItem/2345678901234",
"currentQuantity": 3,
"unfulfilledQuantity": 3,
"isGiftCard": false,
"name": "Sample Product",
"originalUnitPriceSet": {
"shopMoney": {
"amount": "16.67",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "16.67",
"currencyCode": "USD"
}
},
"product": null,
"quantity": 3,
"requiresShipping": true,
"sku": "EX123",
"taxable": true,
"title": "Sample Product",
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"variant": null,
"vendor": "Example Vendor",
"taxLines": [
{
"channelLiable": false,
"priceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"rate": 0.05,
"title": "Example Tax"
}
],
"duties": [],
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 0
}
}
]
}
]
},
"paymentTerms": null,
"refunds": [],
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": null,
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
}
},
"userErrors": []
}
}
Create Product
Create a new product. | key: createProductGql
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. This is a JSON object. | ||
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Description HTML string / Required descriptionHtml | Provide an HTML string for the description of the product. | <p>This is an example product.</p> | |
Image Alt Text string imageAlt | Provide the alt text for the image of the product. | Alt text | |
Image URL string imageUrl | Provide a URL for the image of the product. | https://example.com/image.jpg | |
Product Status string / Required productStatus | Specify the status of the product. | ||
Product Type string / Required productType | Provide a value for the type of product. | T-shirt | |
Connection connection / Required shopifyConnection | |||
Tags string Value List tags | Provide a list of tags for the product. | Style | |
Title string / Required title | Provide a string value for the title of the product. | Example Product | |
Vendor string / Required vendor | Provide a value for the vendor of the product. | Burton inc. |
{
"data": {
"product": {
"id": 1234567890123,
"title": "Example Product",
"body_html": "<p>This is an example product.</p>",
"vendor": "Example Vendor",
"product_type": "Example Category",
"created_at": "2025-01-07T00:00:00Z",
"handle": "example-product-1",
"updated_at": "2025-01-07T00:00:01Z",
"published_at": null,
"template_suffix": null,
"tags": "example-tag",
"status": "ACTIVE",
"admin_graphql_api_id": "gid://shopify/Product/1234567890123",
"variants": [
{
"id": 9876543210987,
"product_id": 1234567890123,
"title": "Example Variant",
"price": "10.00",
"position": 1,
"inventory_policy": "DENY",
"compare_at_price": null,
"created_at": "2025-01-07T00:00:01Z",
"updated_at": "2025-01-07T00:00:01Z",
"taxable": true,
"barcode": "123456789012",
"requires_shipping": true,
"sku": "EX-001",
"weight": 1,
"weight_unit": "POUNDS",
"inventory_item_id": 11223344556677,
"inventory_quantity": 100,
"admin_graphql_api_id": "gid://shopify/ProductVariant/9876543210987"
}
],
"options": [
{
"id": 99887766554433,
"product_id": 1234567890123,
"name": "Size",
"position": 1,
"values": [
"Small",
"Medium",
"Large"
]
}
],
"images": [
{
"id": 66554433221100,
"alt": "Example Image",
"position": 1,
"product_id": 1234567890123,
"created_at": "2025-01-07T00:00:00Z",
"updated_at": "2025-01-07T00:00:01Z",
"admin_graphql_api_id": "gid://shopify/MediaImage/66554433221100",
"width": null,
"height": null,
"src": null
}
],
"image": {
"id": 66554433221100,
"alt": "Example Image",
"product_id": 1234567890123,
"created_at": "2025-01-07T00:00:00Z",
"updated_at": "2025-01-07T00:00:01Z",
"admin_graphql_api_id": "gid://shopify/MediaImage/66554433221100",
"width": null,
"height": null,
"src": null
}
}
}
}
Create Product Image
Create a new image on an existing product. | key: createProductImageGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Image Alt Text string / Required imageAlt | Provide the alt text for the image. | Alt text | |
Image URL string / Required imageURL | Provide the URL of the image. | https://example.com/image.jpg | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Connection connection / Required shopifyConnection |
{
"data": {
"media": [
{
"id": "gid://shopify/MediaImage/1072273196",
"alt": "Alt text.",
"status": "UPLOADED",
"image": null
}
],
"mediaUserErrors": []
}
}
Create Variant
Create a new variant of the provided product. | key: createVariantGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Connection connection / Required shopifyConnection | |||
Variant code / Required variant | Provide a JSON object containing the variant data. |
{
"data": {
"productVariants": [
{
"id": "gid://shopify/ProductVariant/1070325177",
"title": "Golden",
"selectedOptions": [
{
"name": "Title",
"value": "Golden"
}
]
}
],
"userErrors": []
}
}
Create Webhook
Creates a webhook for the desired topic in your Shopify store. | key: createWebhook
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Post URL string / Required postUrl | Provide a string value for the URL the newly created webhook will post to. You can use this input to configure your Shopify trigger. | someurl.com | |
Connection connection / Required shopifyConnection | |||
Webhook Format string / Required webhookFormat | json | Provide a string value for the format you would like your webhook to return. | |
Webhook Topic string / Required webhookTopic | Provide a string value for the topic you would like to point your webhook at. You can chose from the list found in the Shopify docs: https://shopify.dev/docs/api/admin-rest/2023-04/resources/webhook#event-topics | products/create |
{
"data": {
"webhook": {
"id": 8099884584,
"address": "pubsub://projectName:topicName",
"topic": "customers/update",
"created_at": "2024-03-14T13:45:35-04:00",
"updated_at": "2024-03-14T13:45:35-04:00",
"format": "json",
"fields": [],
"metafield_namespaces": [],
"api_version": "unstable",
"private_metafield_namespaces": []
}
}
}
Delete Collection
Delete a collection by ID. | key: deleteCollectionGql
| Input | Default | Notes | Example |
|---|---|---|---|
Collection ID string / Required collectionId | Provide a unique ID of a collection. | gid://shopify/Collection/841564295 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection |
{
"data": {
"deletedCollectionId": "gid://shopify/Collection/123456789012",
"userErrors": []
}
}
Delete Customer
Delete an existing customer. | key: deleteCustomerGql
| Input | Default | Notes | Example |
|---|---|---|---|
Customer string / Required customerIdGql | Provide a value for the unique ID of the customer. | 5940139491234 or gid://shopify/Customer/5940139491234 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection |
{
"data": {}
}
Delete Draft Order
Delete the information and metadata of a Draft Order. | key: deleteDraftOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Draft Order Id string / Required draftOrderId | Provide a value for the unique ID of the draft order. | 916042021234 or gid://shopify/DraftOrder/916042021234 | |
Connection connection / Required shopifyConnection |
{
"data": {
"deletedId": "gid://shopify/DraftOrder/276395349",
"userErrors": []
}
}
Delete Fulfillment Service
Deletes an existing fulfillment service. | key: deleteFulfillmentServiceGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Fulfillment Service ID string / Required fulfillmentServiceId | Provide the unique ID of the fulfillment service. | gid://shopify/FulfillmentService/18961920?id=true | |
Connection connection / Required shopifyConnection |
{
"data": {
"deletedId": "gid://shopify/FulfillmentService/198258461",
"userErrors": []
}
}
Delete Instance Webhooks
Delete all webhooks related to this instance. | key: deleteInstanceWebhooks
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
Delete Inventory Levels
Delete the information and metadata of an Inventory Level. | key: deleteInventoryLevelsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Inventory Level Id string / Required levelId | Provide a unique ID of an Inventory Level. | gid://shopify/InventoryLevel/820859520?inventory_item_id=826867926 | |
Connection connection / Required shopifyConnection |
{
"data": {
"userErrors": []
}
}
Delete Metafield
Delete a resource metafield. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change. | key: deleteMetafieldGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Key string / Required key | Provide the key of the metafield to delete. | myKey | |
Namespace string / Required namespace | Provide the namespace of the metafield to delete. | global | |
Owner ID string / Required ownerId | Provide the owner ID of the metafield to delete. | gid://shopify/Product/20995642 | |
Connection connection / Required shopifyConnection |
{
"data": {
"deletedMetafields": [
{
"key": "today",
"namespace": "inventory",
"ownerId": "gid://shopify/Product/20995642"
}
],
"userErrors": []
}
}
Delete Order
Delete an existing order by Id. | key: deleteOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Order ID string / Required orderId | Provide the unique ID of the order. | 10079785100 or gid://shopify/Order/10079785100 | |
Connection connection / Required shopifyConnection |
{
"data": {
"deletedId": "gid://shopify/Order/776341364",
"userErrors": []
}
}
Delete Product
Delete an existing product. | key: deleteProductGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Connection connection / Required shopifyConnection |
{
"data": {
"productDelete": {
"deletedProductId": "gid://shopify/Product/108828309",
"userErrors": []
}
}
}
Delete Product Image
Delete the information and metadata of a product image connected to your platform. | key: deleteProductImageGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Image ID string / Required imageId | Provide a unique ID of a product image. | gid://shopify/MediaImage/916933471 | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Connection connection / Required shopifyConnection |
{
"data": {
"deletedMediaIds": [
"gid://shopify/MediaImage/730211239"
],
"deletedProductImageIds": [
"gid://shopify/ProductImage/916933471"
],
"mediaUserErrors": []
}
}
Delete Variant
Delete an existing variant by Id. | key: deleteVariantGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Connection connection / Required shopifyConnection | |||
Variant ID string / Required variantId | Provide a unique ID of a variant. | gid://shopify/ProductVariant/1070325177 |
{
"data": {
"product": {
"id": "gid://shopify/Product/20995642",
"title": "Element"
},
"userErrors": []
}
}
Delete Webhook
Delete a webhook by ID. | key: deleteWebhook
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection | |||
Webhook ID string / Required webhookId | The ID of an existing webhook | 450789469 |
{
"data": {}
}
Get Collection
Get a collection by Id. | key: getCollectionGql
| Input | Default | Notes | Example |
|---|---|---|---|
Collection ID string / Required collectionId | Provide a unique ID of a collection. | gid://shopify/Collection/841564295 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection |
{
"data": {
"collection": {
"id": "gid://shopify/Collection/123456789012",
"description": "Example description",
"descriptionHtml": "<p>Example description in HTML</p>",
"handle": "example-collection-handle",
"products": {
"nodes": [
{
"descriptionHtml": "<p>Example product description</p>",
"category": "Example Category",
"createdAt": "2023-01-01T12:00:00Z",
"description": "Example product description",
"featuredMedia": {
"alt": "Example alt text",
"id": "gid://shopify/MediaImage/987654321098",
"preview": {
"image": {
"url": "https://cdn.example.com/images/example.jpg",
"width": 200,
"height": 300,
"id": "gid://shopify/ImageSource/654321987654"
}
},
"status": "READY"
},
"handle": "example-product-handle",
"id": "gid://shopify/Product/1234567890123",
"priceRangeV2": {
"maxVariantPrice": {
"amount": "50.0",
"currencyCode": "USD"
},
"minVariantPrice": {
"amount": "10.0",
"currencyCode": "USD"
}
},
"productType": "Example Type",
"publishedAt": "2023-01-01T12:00:00Z",
"status": "ACTIVE",
"tags": [
"Example Tag 1",
"Example Tag 2"
],
"title": "Example Product Title",
"totalInventory": 100,
"vendor": "Example Vendor Name"
}
]
},
"productsCount": {
"count": 10
},
"sortOrder": "MANUAL",
"title": "Example Collection Title"
}
}
}
Get Customer
Get a customers information and metadata by Id. | key: getCustomer
| Input | Default | Notes | Example |
|---|---|---|---|
Customer string / Required customerId | Provide a value for the unique ID of the customer. | 207119551 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection |
{
"data": {
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"accepts_marketing": false,
"created_at": "2023-07-11T18:25:37-04:00",
"updated_at": "2023-07-11T18:25:37-04:00",
"first_name": "Bob",
"last_name": "Norman",
"orders_count": 1,
"state": "disabled",
"total_spent": "199.65",
"last_order_id": 450789469,
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"tags": "Léon, Noël",
"last_order_name": "#1001",
"currency": "USD",
"phone": "+16136120707",
"addresses": [
{
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
],
"accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
"marketing_opt_in_level": null,
"tax_exemptions": [],
"email_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": null,
"consent_updated_at": "2004-06-13T11:57:11-04:00"
},
"sms_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": "single_opt_in",
"consent_updated_at": "2023-07-11T18:25:37-04:00",
"consent_collected_from": "OTHER"
},
"admin_graphql_api_id": "gid://shopify/Customer/207119551",
"default_address": {
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
}
}
}
Get Draft Order
Get the information and metadata of a Draft Order. | key: getDraftOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Draft Order Id string / Required draftOrderId | Provide a value for the unique ID of the draft order. | 916042021234 or gid://shopify/DraftOrder/916042021234 | |
Connection connection / Required shopifyConnection |
{
"data": {
"draftOrder": {
"id": "gid://shopify/DraftOrder/1234567890123",
"note2": "Sample Note",
"email": "example@email.com",
"taxesIncluded": false,
"currencyCode": "USD",
"invoiceSentAt": null,
"createdAt": "2024-12-31T07:30:32Z",
"updatedAt": "2024-12-31T07:30:33Z",
"taxExempt": true,
"completedAt": "2024-12-31T07:30:33Z",
"name": "#D123",
"status": "COMPLETED",
"lineItems": {
"nodes": [
{
"id": "gid://shopify/DraftOrderLineItem/9876543210987",
"variant": null,
"product": null,
"title": "Example Product",
"variantTitle": null,
"sku": null,
"vendor": null,
"quantity": 3,
"requiresShipping": false,
"taxable": true,
"isGiftCard": false,
"fulfillmentService": {
"type": "MANUAL"
},
"weight": {
"unit": "KILOGRAMS",
"value": 2
},
"taxLines": [
{
"channelLiable": null,
"priceSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"rate": 0.05,
"ratePercentage": 5,
"source": "Shopify",
"title": "Example State Tax"
}
],
"appliedDiscount": {
"title": "Promo",
"value": 10,
"valueType": "PERCENTAGE",
"description": "Seasonal Discount",
"amountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
}
},
"name": "Example Product",
"custom": true,
"originalUnitPriceSet": {
"shopMoney": {
"currencyCode": "USD",
"amount": "20.00"
}
}
}
]
},
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"billingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": "123-456-7890",
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": "Apt 101",
"company": "Example Corp",
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
},
"invoiceUrl": "https://example-store.myshopify.com/123456/invoices/abcdef123456",
"appliedDiscount": null,
"order": {
"id": "gid://shopify/Order/8765432109876"
},
"shippingLine": null,
"taxLines": [],
"tags": [],
"totalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"subtotalPriceSet": {
"shopMoney": {
"amount": "60.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.0",
"currencyCode": "USD"
}
},
"paymentTerms": null,
"customer": {
"id": "gid://shopify/Customer/1234567890123",
"email": "example@email.com",
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2024-12-31T07:30:33Z",
"firstName": "John",
"lastName": "Doe",
"numberOfOrders": "5",
"state": "ENABLED",
"amountSpent": {
"amount": "500.00",
"currencyCode": "USD"
},
"lastOrder": {
"id": "gid://shopify/Order/8765432109876",
"name": "#5678"
},
"note": null,
"verifiedEmail": true,
"multipassIdentifier": null,
"taxExempt": false,
"tags": [],
"phone": "123-456-7890",
"taxExemptions": [],
"emailMarketingConsent": {
"marketingState": "SUBSCRIBED",
"consentUpdatedAt": null
},
"smsMarketingConsent": null,
"defaultAddress": {
"id": "gid://shopify/MailingAddress/9876543210987",
"firstName": "John",
"lastName": "Doe",
"company": "Example Corp",
"address1": "123 Example St",
"address2": "Apt 101",
"city": "Example City",
"province": "California",
"country": "United States",
"zip": "12345",
"phone": "123-456-7890",
"name": "John Doe",
"provinceCode": "CA",
"countryCodeV2": "US"
}
}
}
}
}
Get Fulfillment
Get the information and metadata of a fulfillment enabled on your platform. | key: getFulfillmentGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Fulfillment Id string / Required fulfillmentId | Provide a unique ID of a fulfillment. | 5154544124321 or gid://shopify/Fulfillment/5154544124321 | |
Connection connection / Required shopifyConnection |
{
"data": {
"fulfillment": {
"id": "gid://shopify/Fulfillment/1234567890",
"order": {
"id": "gid://shopify/Order/9876543210"
},
"status": "SUCCESS",
"createdAt": "2024-12-30T12:00:00Z",
"updatedAt": "2024-12-31T08:00:00Z",
"service": {
"type": "MANUAL"
},
"trackingInfo": [
{
"company": "FedEx",
"number": "987654321012",
"url": "https://www.fedex.com/fedextrack/?tracknumbers=987654321012"
}
],
"location": {
"id": "gid://shopify/Location/1122334455"
},
"originAddress": {
"address1": "500 Example Blvd",
"address2": "Suite 400",
"city": "Example City",
"countryCode": "US",
"provinceCode": "CA",
"zip": "90001"
},
"fulfillmentLineItems": {
"nodes": [
{
"id": "gid://shopify/FulfillmentLineItem/5432109876",
"lineItem": {
"title": "Example Product A",
"quantity": 1,
"originalUnitPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 1
}
}
],
"duties": [],
"discountedTotalSet": {
"shopMoney": {
"amount": "45.00"
}
},
"variant": {
"title": "Variant A",
"id": "gid://shopify/ProductVariant/11223344",
"price": "50.00",
"product": {
"id": "gid://shopify/Product/55667788"
}
},
"requiresShipping": true,
"vendor": "Example Vendor",
"sku": "EXM-001",
"taxable": true,
"isGiftCard": false,
"name": "Example Product A"
}
},
{
"id": "gid://shopify/FulfillmentLineItem/6543210987",
"lineItem": {
"title": "Example Product B",
"quantity": 2,
"originalUnitPriceSet": {
"shopMoney": {
"amount": "30.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "30.00",
"currencyCode": "USD"
}
},
"totalDiscountSet": {
"shopMoney": {
"amount": "3.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "3.00",
"currencyCode": "USD"
}
},
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "3.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 2
}
}
],
"duties": [],
"discountedTotalSet": {
"shopMoney": {
"amount": "57.00"
}
},
"variant": {
"title": "Variant B",
"id": "gid://shopify/ProductVariant/22334455",
"price": "30.00",
"product": {
"id": "gid://shopify/Product/66778899"
}
},
"requiresShipping": true,
"vendor": "Example Vendor",
"sku": "EXM-002",
"taxable": true,
"isGiftCard": false,
"name": "Example Product B"
}
}
]
},
"name": "F-1001"
}
}
}
Get Fulfillment Order
Retrieve a specific fulfillment order. | key: getFulfillmentOrder
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Fulfillment Order ID string / Required fulfillmentOrderId | Provide a unique ID of a fulfillment order | 1046000820 | |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"fulfillment_order": {
"id": 1046000819,
"shop_id": 548380009,
"order_id": 450789469,
"assigned_location_id": 24826418,
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1046000803,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@mail.example.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "+1(502)-459-2181",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1058737560,
"shop_id": 548380009,
"fulfillment_order_id": 1046000819,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"international_duties": null,
"fulfill_at": null,
"fulfill_by": null,
"fulfillment_holds": [],
"created_at": "2024-01-02T09:11:20-05:00",
"updated_at": "2024-01-02T09:11:20-05:00",
"delivery_method": null,
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 24826418,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
}
}
Get Fulfillment Service
Retrieve a fulfillment service enabled on your platform by its ID. | key: getFulfillmentServiceGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Fulfillment Service ID string / Required fulfillmentServiceId | Provide the unique ID of the fulfillment service. | gid://shopify/FulfillmentService/18961920?id=true | |
Connection connection / Required shopifyConnection |
{
"data": {
"fulfillmentService": {
"id": "gid://shopify/FulfillmentService/1234567890?id=true",
"serviceName": "ExampleFulfillmentService",
"handle": "examplefulfillmentservice",
"location": {
"id": "gid://shopify/Location/0987654321"
},
"callbackUrl": "https://example.com/",
"trackingSupport": false,
"inventoryManagement": false,
"permitsSkuSharing": false
}
}
}
Get Inventory Item
Get the information and metadata of an Inventory Item enabled on your platform. | key: getInventoryItemsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Inventory Item Id string / Required itemId | Provide a unique ID of a Inventory Item. | gid://shopify/InventoryItem/43933612241234 | |
Connection connection / Required shopifyConnection |
{
"data": {
"inventoryItem": {
"id": "gid://shopify/InventoryItem/12345678901234",
"sku": "EXAMPLE-SKU",
"createdAt": "2022-01-01T12:00:00Z",
"updatedAt": "2024-12-01T15:30:00Z",
"requiresShipping": true,
"unitCost": {
"amount": "10.0",
"currencyCode": "USD"
},
"countryCodeOfOrigin": null,
"provinceCodeOfOrigin": null,
"harmonizedSystemCode": null,
"tracked": false,
"countryHarmonizedSystemCodes": {
"nodes": []
}
}
}
}
Get Inventory Levels
Get the information and metadata of an Inventory Level. | key: getInventoryLevelsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Inventory Level Id string / Required levelId | Provide a unique ID of an Inventory Level. | gid://shopify/InventoryLevel/100340760123?inventory_item_id=43933612245123 | |
Connection connection / Required shopifyConnection |
{
"data": {
"inventoryLevel": {
"id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076",
"item": {
"id": "gid://shopify/InventoryItem/43729076"
},
"location": {
"id": "gid://shopify/Location/346779380"
},
"quantities": [
{
"name": "available",
"quantity": 0
}
],
"updatedAt": "2024-11-07T20:59:45Z"
}
}
}
Get Location
Get the information and metadata of a location enabled on your platform. | key: getLocationsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Location ID string / Required locationId | The ID of the location that the inventory level belongs to. | 346779380 or gid://shopify/Location/346779380 | |
Connection connection / Required shopifyConnection |
{
"data": {
"location": {
"id": "gid://shopify/Location/12345678901",
"name": "123 Example St Suite 100",
"address": {
"address1": "123 Example St Suite 100",
"address2": null,
"city": "Example City",
"zip": "12345",
"province": "Example State",
"country": "Example Country",
"phone": "",
"countryCode": "EX",
"provinceCode": "ES"
},
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2022-01-01T10:00:00Z",
"isActive": true
}
}
}
Get Order
Get the information and metadata about an order. | key: getOrderGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Order ID string / Required orderId | Provide the unique ID of the order. | 10079785100 or gid://shopify/Order/10079785100 | |
Connection connection / Required shopifyConnection |
{
"data": {
"order": {
"id": "gid://shopify/Order/1234567890123",
"name": "#1234",
"app": {
"id": "gid://shopify/App/9876543210987"
},
"clientIp": "0.0.0.0",
"customerAcceptsMarketing": false,
"cancelReason": null,
"cancelledAt": null,
"closedAt": null,
"confirmationNumber": "ABC123XYZ",
"confirmed": true,
"createdAt": "2024-12-08T11:29:38Z",
"currencyCode": "USD",
"currentSubtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalAdditionalFeesSet": null,
"currentTotalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"currentTotalDutiesSet": null,
"currentTotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"customerLocale": "en",
"discountCodes": [],
"dutiesIncluded": false,
"email": "example@example.com",
"estimatedTaxes": false,
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"retailLocation": null,
"merchantBusinessEntity": {
"id": "gid://shopify/BusinessEntity/1122334455667"
},
"merchantOfRecordApp": null,
"note": "Example note",
"originalTotalAdditionalFeesSet": null,
"originalTotalDutiesSet": null,
"paymentGatewayNames": [
"manual"
],
"phone": null,
"poNumber": null,
"presentmentCurrencyCode": "USD",
"processedAt": "2024-12-08T11:29:38Z",
"sourceIdentifier": "example-source-id",
"sourceName": "9876543210987",
"registeredSourceUrl": null,
"subtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"tags": [],
"taxExempt": true,
"taxLines": [],
"taxesIncluded": false,
"test": false,
"totalCashRoundingAdjustment": {
"paymentSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"refundSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
}
},
"totalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"totalOutstandingSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalShippingPriceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTipReceivedSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalWeight": "5000",
"updatedAt": "2024-12-08T11:29:39Z",
"billingAddress": {
"address1": "123 Example St",
"address2": null,
"name": "John Doe",
"lastName": "Doe",
"company": null,
"phone": null,
"zip": "12345",
"country": "United States",
"countryCodeV2": "US",
"province": "California",
"provinceCode": "CA"
},
"customer": {
"id": "gid://shopify/Customer/4567890123456",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"phone": null
},
"lineItems": {
"nodes": [
{
"id": "gid://shopify/LineItem/2345678901234",
"currentQuantity": 3,
"unfulfilledQuantity": 3,
"isGiftCard": false,
"name": "Sample Product",
"originalUnitPriceSet": {
"shopMoney": {
"amount": "16.67",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "16.67",
"currencyCode": "USD"
}
},
"product": null,
"quantity": 3,
"requiresShipping": true,
"sku": "EX123",
"taxable": true,
"title": "Sample Product",
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"variant": null,
"vendor": "Example Vendor",
"taxLines": [
{
"channelLiable": false,
"priceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"rate": 0.05,
"title": "Example Tax"
}
],
"duties": [],
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 0
}
}
]
}
]
},
"paymentTerms": null,
"refunds": [],
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": null,
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
}
}
}
}
Get Order (Deprecated)
Get the information and metadata about an order. This version of the action is being deprecated. Please replace action with Get Order. | key: getOrder
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Order ID string / Required orderId | Provide the unique ID of the order. | 450789469 | |
Connection connection / Required shopifyConnection |
{
"data": {
"order": {
"id": 450789469,
"admin_graphql_api_id": "gid://shopify/Order/450789469",
"app_id": null,
"browser_ip": "0.0.0.0",
"buyer_accepts_marketing": false,
"cancel_reason": null,
"cancelled_at": null,
"cart_token": "68778783ad298f1c80c3bafcddeea02f",
"checkout_id": 901414060,
"checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
"client_details": {
"accept_language": null,
"browser_height": null,
"browser_ip": "0.0.0.0",
"browser_width": null,
"session_hash": null,
"user_agent": null
},
"closed_at": null,
"confirmation_number": null,
"confirmed": true,
"contact_email": "bob.norman@mail.example.com",
"created_at": "2008-01-10T11:00:00-05:00",
"currency": "USD",
"current_subtotal_price": "195.67",
"current_subtotal_price_set": {
"shop_money": {
"amount": "195.67",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.67",
"currency_code": "USD"
}
},
"current_total_additional_fees_set": null,
"current_total_discounts": "3.33",
"current_total_discounts_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
},
"current_total_duties_set": null,
"current_total_price": "199.65",
"current_total_price_set": {
"shop_money": {
"amount": "199.65",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.65",
"currency_code": "USD"
}
},
"current_total_tax": "3.98",
"current_total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"customer_locale": null,
"device_id": null,
"discount_codes": [
{
"code": "TENOFF",
"amount": "10.00",
"type": "fixed_amount"
}
],
"duties_included": false,
"email": "bob.norman@mail.example.com",
"estimated_taxes": false,
"financial_status": "partially_refunded",
"fulfillment_status": null,
"landing_site": "http://www.example.com?source=abc",
"landing_site_ref": "abc",
"location_id": null,
"merchant_business_entity_id": "MTU0ODM4MDAwOQ",
"merchant_of_record_app_id": null,
"name": "#1001",
"note": null,
"note_attributes": [
{
"name": "custom engraving",
"value": "Happy Birthday"
},
{
"name": "colour",
"value": "green"
}
],
"number": 1,
"order_number": 1001,
"order_status_url": "https://jsmith.myshopify.com/548380009/orders/b1946ac92492d2347c6235b4d2611184/authenticate?key=imasecretipod",
"original_total_additional_fees_set": null,
"original_total_duties_set": null,
"payment_gateway_names": [
"bogus"
],
"phone": "+557734881234",
"po_number": "ABC123",
"presentment_currency": "USD",
"processed_at": "2008-01-10T11:00:00-05:00",
"reference": "fhwdgads",
"referring_site": "http://www.otherexample.com",
"source_identifier": "fhwdgads",
"source_name": "web",
"source_url": null,
"subtotal_price": "597.00",
"subtotal_price_set": {
"shop_money": {
"amount": "597.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "597.00",
"currency_code": "USD"
}
},
"tags": "",
"tax_exempt": false,
"tax_lines": [
{
"price": "11.94",
"rate": 0.06,
"title": "State Tax",
"price_set": {
"shop_money": {
"amount": "11.94",
"currency_code": "USD"
},
"presentment_money": {
"amount": "11.94",
"currency_code": "USD"
}
},
"channel_liable": null
}
],
"taxes_included": false,
"test": false,
"token": "b1946ac92492d2347c6235b4d2611184",
"total_cash_rounding_payment_adjustment_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_cash_rounding_refund_adjustment_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_discounts": "10.00",
"total_discounts_set": {
"shop_money": {
"amount": "10.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "10.00",
"currency_code": "USD"
}
},
"total_line_items_price": "597.00",
"total_line_items_price_set": {
"shop_money": {
"amount": "597.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "597.00",
"currency_code": "USD"
}
},
"total_outstanding": "0.00",
"total_price": "598.94",
"total_price_set": {
"shop_money": {
"amount": "598.94",
"currency_code": "USD"
},
"presentment_money": {
"amount": "598.94",
"currency_code": "USD"
}
},
"total_shipping_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_tax": "11.94",
"total_tax_set": {
"shop_money": {
"amount": "11.94",
"currency_code": "USD"
},
"presentment_money": {
"amount": "11.94",
"currency_code": "USD"
}
},
"total_tip_received": "0.00",
"total_weight": 0,
"updated_at": "2008-01-10T11:00:00-05:00",
"user_id": null,
"billing_address": {
"first_name": "Bob",
"address1": "Chestnut Street 92",
"phone": "+1(502)-459-2181",
"city": "Louisville",
"zip": "40202",
"province": "Kentucky",
"country": "United States",
"last_name": "Norman",
"address2": "",
"company": null,
"latitude": 45.41634,
"longitude": -75.6868,
"name": "Bob Norman",
"country_code": "US",
"province_code": "KY"
},
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"created_at": "2025-01-02T11:29:59-05:00",
"updated_at": "2025-01-02T11:29:59-05:00",
"first_name": "Bob",
"last_name": "Norman",
"state": "disabled",
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"phone": "+16136120707",
"email_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": null,
"consent_updated_at": "2004-06-13T11:57:11-04:00"
},
"sms_marketing_consent": {
"state": "not_subscribed",
"opt_in_level": "single_opt_in",
"consent_updated_at": "2024-01-01T07:00:00-05:00",
"consent_collected_from": "OTHER"
},
"tags": "Léon, Noël",
"currency": "USD",
"tax_exemptions": [],
"admin_graphql_api_id": "gid://shopify/Customer/207119551",
"default_address": {
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
},
"discount_applications": [
{
"target_type": "line_item",
"type": "discount_code",
"value": "10.0",
"value_type": "fixed_amount",
"allocation_method": "across",
"target_selection": "all",
"code": "TENOFF"
}
],
"fulfillments": [
{
"id": 255858046,
"admin_graphql_api_id": "gid://shopify/Fulfillment/255858046",
"created_at": "2025-01-02T11:29:59-05:00",
"location_id": 655441491,
"name": "#1001.0",
"order_id": 450789469,
"origin_address": {},
"receipt": {
"testcase": true,
"authorization": "123456"
},
"service": "manual",
"shipment_status": null,
"status": "failure",
"tracking_company": "USPS",
"tracking_number": "1Z1234512345123456",
"tracking_numbers": [
"1Z1234512345123456"
],
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456",
"tracking_urls": [
"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456"
],
"updated_at": "2025-01-02T11:29:59-05:00",
"line_items": [
{
"id": 466157049,
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - green",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008GREEN",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 39072856,
"variant_inventory_management": "shopify",
"variant_title": "green",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.34",
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
}
]
}
],
"line_items": [
{
"id": 466157049,
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - green",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008GREEN",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 39072856,
"variant_inventory_management": "shopify",
"variant_title": "green",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.34",
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
},
{
"id": 518995019,
"admin_graphql_api_id": "gid://shopify/LineItem/518995019",
"attributed_staffs": [],
"current_quantity": 1,
"fulfillable_quantity": 1,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - red",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008RED",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 49148385,
"variant_inventory_management": "shopify",
"variant_title": "red",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.33",
"amount_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
},
{
"id": 703073504,
"admin_graphql_api_id": "gid://shopify/LineItem/703073504",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - black",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008BLACK",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 457924702,
"variant_inventory_management": "shopify",
"variant_title": "black",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.33",
"amount_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
}
],
"payment_terms": null,
"refunds": [
{
"id": 509562969,
"admin_graphql_api_id": "gid://shopify/Refund/509562969",
"created_at": "2025-01-02T11:29:59-05:00",
"note": "it broke during shipping",
"order_id": 450789469,
"processed_at": "2025-01-02T11:29:59-05:00",
"restock": true,
"total_additional_fees_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_duties_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"user_id": 548380009,
"order_adjustments": [],
"transactions": [
{
"id": 179259969,
"admin_graphql_api_id": "gid://shopify/OrderTransaction/179259969",
"amount": "209.00",
"authorization": "authorization-key",
"created_at": "2005-08-05T12:59:12-04:00",
"currency": "USD",
"device_id": null,
"error_code": null,
"gateway": "bogus",
"kind": "refund",
"location_id": null,
"message": null,
"order_id": 450789469,
"parent_id": 801038806,
"payment_id": "#1001.3",
"processed_at": "2005-08-05T12:59:12-04:00",
"receipt": {},
"source_name": "web",
"status": "success",
"test": false,
"user_id": null
}
],
"refund_line_items": [
{
"id": 104689539,
"line_item_id": 703073504,
"location_id": 487838322,
"quantity": 1,
"restock_type": "legacy_restock",
"subtotal": 195.66,
"subtotal_set": {
"shop_money": {
"amount": "195.66",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.66",
"currency_code": "USD"
}
},
"total_tax": 3.98,
"total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"line_item": {
"id": 703073504,
"admin_graphql_api_id": "gid://shopify/LineItem/703073504",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - black",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008BLACK",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 457924702,
"variant_inventory_management": "shopify",
"variant_title": "black",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.33",
"amount_set": {
"shop_money": {
"amount": "3.33",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.33",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
}
},
{
"id": 709875399,
"line_item_id": 466157049,
"location_id": 487838322,
"quantity": 1,
"restock_type": "legacy_restock",
"subtotal": 195.67,
"subtotal_set": {
"shop_money": {
"amount": "195.67",
"currency_code": "USD"
},
"presentment_money": {
"amount": "195.67",
"currency_code": "USD"
}
},
"total_tax": 3.98,
"total_tax_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"line_item": {
"id": 466157049,
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"attributed_staffs": [],
"current_quantity": 0,
"fulfillable_quantity": 0,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 200,
"name": "IPod Nano - 8gb - green",
"price": "199.00",
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 632910392,
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"quantity": 1,
"requires_shipping": true,
"sku": "IPOD2008GREEN",
"taxable": true,
"title": "IPod Nano - 8gb",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 39072856,
"variant_inventory_management": "shopify",
"variant_title": "green",
"vendor": null,
"tax_lines": [
{
"channel_liable": null,
"price": "3.98",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"rate": 0.06,
"title": "State Tax"
}
],
"duties": [],
"discount_allocations": [
{
"amount": "3.34",
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
},
"discount_application_index": 0
}
]
}
}
],
"duties": [],
"additional_fees": []
}
],
"shipping_address": {
"first_name": "Bob",
"address1": "Chestnut Street 92",
"phone": "+1(502)-459-2181",
"city": "Louisville",
"zip": "40202",
"province": "Kentucky",
"country": "United States",
"last_name": "Norman",
"address2": "",
"company": null,
"latitude": 45.41634,
"longitude": -75.6868,
"name": "Bob Norman",
"country_code": "US",
"province_code": "KY"
},
"shipping_lines": [
{
"id": 369256396,
"carrier_identifier": null,
"code": "Free Shipping",
"discounted_price": "0.00",
"discounted_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"is_removed": false,
"phone": null,
"price": "0.00",
"price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"requested_fulfillment_service_id": null,
"source": "shopify",
"title": "Free Shipping",
"tax_lines": [],
"discount_allocations": []
}
]
}
}
}
Get Product
Get the information and metadata of a product by Id. | key: getProduct
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Product ID string / Required productId | Provide a value for the product Id. | 74020090 | |
Connection connection / Required shopifyConnection |
{
"data": {
"product": {
"id": 632910392,
"title": "IPod Nano - 8GB",
"body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
"vendor": "Apple",
"product_type": "Cult Products",
"created_at": "2023-07-11T17:47:36-04:00",
"handle": "ipod-nano",
"updated_at": "2023-07-11T17:47:36-04:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"presentment_prices": [
{
"price": {
"amount": "199.00",
"currency_code": "USD"
},
"compare_at_price": null
}
],
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810"
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1689112056",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1689112056",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
}
}
}
Get Product Image
Get the information and metadata of a product image connected to your platform. | key: getProductImageGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Image ID string / Required imageId | Provide a unique ID of a product image. Use only the ID number. | 916933471 | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Connection connection / Required shopifyConnection |
{
"data": {
"image": {
"alt": "image",
"id": "gid://shopify/MediaImage/32285801283737",
"mediaContentType": "IMAGE",
"status": "READY",
"preview": {
"image": {
"altText": "image",
"height": 300,
"id": "gid://shopify/ImageSource/32307802603673",
"originalSrc": "https://cdn.shopify.com/s/files/1/0606/2820/5721/files/300.jpg?v=123456",
"url": "https://cdn.shopify.com/s/files/1/0606/2820/5721/files/300.jpg?v=123456",
"width": 200,
"src": "https://cdn.shopify.com/s/files/1/0606/2820/5721/files/300.jpg?v=123456"
},
"status": "READY"
}
}
}
}
Get Shop Configuration
Retrieve the shop's current configuration. | key: getShopConfig
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"shop": {
"id": 548380009,
"name": "John Smith Test Store",
"email": "j.smith@example.com",
"domain": "shop.apple.com",
"province": "California",
"country": "US",
"address1": "1 Infinite Loop",
"zip": "95014",
"city": "Cupertino",
"source": null,
"phone": "1231231234",
"latitude": 45.45,
"longitude": -75.43,
"primary_locale": "en",
"address2": "Suite 100",
"created_at": "2007-12-31T19:00:00-05:00",
"updated_at": "2024-02-14T10:58:03-05:00",
"country_code": "US",
"country_name": "United States",
"currency": "USD",
"customer_email": "customers@apple.com",
"timezone": "(GMT-05:00) Eastern Time (US & Canada)",
"iana_timezone": "America/New_York",
"shop_owner": "John Smith",
"money_format": "${{amount}}",
"money_with_currency_format": "${{amount}} USD",
"weight_unit": "lb",
"province_code": "CA",
"taxes_included": null,
"auto_configure_tax_inclusivity": null,
"tax_shipping": null,
"county_taxes": true,
"plan_display_name": "Shopify Plus",
"plan_name": "enterprise",
"has_discounts": true,
"has_gift_cards": true,
"myshopify_domain": "jsmith.myshopify.com",
"google_apps_domain": null,
"google_apps_login_enabled": null,
"money_in_emails_format": "${{amount}}",
"money_with_currency_in_emails_format": "${{amount}} USD",
"eligible_for_payments": true,
"requires_extra_payments_agreement": false,
"password_enabled": false,
"has_storefront": true,
"finances": true,
"primary_location_id": 655441491,
"checkout_api_supported": true,
"multi_location_enabled": true,
"setup_required": false,
"pre_launch_enabled": false,
"enabled_presentment_currencies": [
"USD"
],
"transactional_sms_disabled": false,
"marketing_sms_consent_enabled_at_checkout": false
}
}
}
}
Get Variant
Get the information or metadata of a variant by Id. | key: getVariantGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection | |||
Variant ID string / Required variantId | Provide a unique ID of a variant. | gid://shopify/ProductVariant/1070325177 |
{
"data": {
"productVariant": {
"id": "gid://shopify/ProductVariant/43729076",
"title": "151cm",
"availableForSale": true,
"barcode": "12345678",
"compareAtPrice": "20.00",
"createdAt": "2024-11-12T15:54:57Z"
}
}
}
List Collections
List all collections enabled on your platform. | key: listCollectionsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Page Offset Cursor string endCursor | Provide a cursor to offset the results. This is used to get the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Fetch All boolean fetchAll | false | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | |
Limit string / Required limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 20 |
Connection connection / Required shopifyConnection |
{
"data": {
"collections": [
{
"id": "gid://shopify/Collection/123456789012",
"description": "Example description",
"descriptionHtml": "<p>Example description in HTML</p>",
"handle": "example-collection-handle",
"products": {
"nodes": [
{
"descriptionHtml": "<p>Example product description</p>",
"category": "Example Category",
"createdAt": "2023-01-01T12:00:00Z",
"description": "Example product description",
"featuredMedia": {
"alt": "Example alt text",
"id": "gid://shopify/MediaImage/987654321098",
"preview": {
"image": {
"url": "https://cdn.example.com/images/example.jpg",
"width": 200,
"height": 300,
"id": "gid://shopify/ImageSource/654321987654"
}
},
"status": "READY"
},
"handle": "example-product-handle",
"id": "gid://shopify/Product/1234567890123",
"priceRangeV2": {
"maxVariantPrice": {
"amount": "50.0",
"currencyCode": "USD"
},
"minVariantPrice": {
"amount": "10.0",
"currencyCode": "USD"
}
},
"productType": "Example Type",
"publishedAt": "2023-01-01T12:00:00Z",
"status": "ACTIVE",
"tags": [
"Example Tag 1",
"Example Tag 2"
],
"title": "Example Product Title",
"totalInventory": 100,
"vendor": "Example Vendor Name"
}
]
},
"productsCount": {
"count": 10
},
"sortOrder": "MANUAL",
"title": "Example Collection Title"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Currencies
List all currencies enabled on your platform. | key: listCurrenciesGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Page Offset Cursor string endCursor | Provide a cursor to offset the results. This is used to get the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Fetch All boolean fetchAll | false | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | |
Limit string / Required limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 20 |
Connection connection / Required shopifyConnection |
{
"data": {
"currencies": [
{
"currencyCode": "CAD",
"rateUpdatedAt": "2018-01-24T00:01:01Z",
"enabled": false
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Customers
List all customers connected to your platform. | key: listCustomers
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Get All Data boolean getAlldata | false | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | |
Limit string limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 20 |
Page Offset Token string pageInfo | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"customers": [
{
"id": 8000000000000,
"email": "example@example.com",
"created_at": "2025-01-07T09:32:23Z",
"updated_at": "2025-01-07T09:32:23Z",
"first_name": "John",
"last_name": "Doe",
"state": "DISABLED",
"last_order_id": null,
"note": null,
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"tags": "",
"last_order_name": null,
"phone": "+18000000000",
"addresses": [
{
"id": null,
"customer_id": 8000000000000,
"first_name": "Jane",
"last_name": "Smith",
"company": "Example Corp",
"address1": "456 Oak Avenue",
"address2": "Suite 12",
"city": "Metropolis",
"province": "California",
"country": "United States",
"zip": "90210",
"phone": "555-000-0000",
"name": "Jane Smith",
"province_code": "CA",
"country_code": "US",
"country_name": "United States"
}
],
"tax_exemptions": [],
"email_marketing_consent": {
"state": "NOT_SUBSCRIBED",
"opt_in_level": "SINGLE_OPT_IN",
"consent_updated_at": null
},
"sms_marketing_consent": {
"state": "NOT_SUBSCRIBED",
"opt_in_level": "SINGLE_OPT_IN",
"consent_updated_at": null,
"consent_collected_from": "OTHER"
},
"admin_graphql_api_id": "gid://shopify/Customer/8000000000000",
"default_address": {
"id": null,
"customer_id": 8000000000000,
"first_name": "Jane",
"last_name": "Smith",
"company": "Example Corp",
"address1": "456 Oak Avenue",
"address2": "Suite 12",
"city": "Metropolis",
"province": "California",
"country": "United States",
"zip": "90210",
"phone": "555-000-0000",
"name": "Jane Smith",
"province_code": "CA",
"country_code": "US",
"country_name": "United States"
}
}
]
},
"pagination": {
"next": {
"page_info": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "next"
}
},
"pageInfo": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "rel=\"next\""
}
}
List Draft Orders
List all draft orders. | key: listDraftOrders
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Get All Data boolean getAlldata | false | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | |
Limit string limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 20 |
Page Offset Token string pageInfo | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"draft_orders": [
{
"id": 1234567890,
"note": null,
"email": "example@example.com",
"taxes_included": false,
"currency": "USD",
"invoice_sent_at": null,
"created_at": "2022-02-16T18:49:34Z",
"updated_at": "2022-02-16T18:49:34Z",
"tax_exempt": false,
"completed_at": null,
"name": "#D1",
"status": "OPEN",
"line_items": [
{
"id": 9876543210,
"variant_id": null,
"product_id": null,
"title": "Example Product",
"variant_title": null,
"sku": "EXAMPLE-SKU",
"vendor": "Example Vendor",
"quantity": 1,
"requires_shipping": true,
"taxable": true,
"gift_card": false,
"fulfillment_service": "MANUAL",
"tax_lines": [
{
"channel_liable": null,
"rate": 0.045,
"title": "Example State Tax",
"price_set": {
"shop_money": {
"amount": "0.54",
"currency_code": "USD"
}
},
"price": "0.54"
}
],
"applied_discount": null,
"name": "Example Line Item",
"custom": true,
"original_unit_price": "12.0",
"admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/9876543210"
}
],
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"address1": "123 Example St",
"address2": null,
"city": "Example City",
"province": "Example Province",
"country": "Example Country",
"zip": "12345",
"phone": "123-456-7890"
},
"billing_address": {
"first_name": "Jane",
"last_name": "Smith",
"address1": "456 Example Ave",
"address2": null,
"city": "Example City",
"province": "Example Province",
"country": "Example Country",
"zip": "67890",
"phone": "987-654-3210"
},
"invoice_url": "https://example-store.myshopify.com/invoices/exampleInvoiceId",
"applied_discount": null,
"order_id": null,
"shipping_line": null,
"tax_lines": [
{
"rate": 0.045,
"rate_percentage": 4.5,
"source": null,
"price_set": {
"shop_money": {
"amount": "0.54",
"currency_code": "USD"
}
},
"price": "0.54",
"channel_liable": null,
"title": "Example State Tax"
}
],
"tags": "",
"total_price": "12.78",
"subtotal_price": "12.0",
"total_tax": "0.78",
"payment_terms": null,
"customer": {
"id": 1122334455,
"email": "customer@example.com",
"first_name": "Alice",
"last_name": "Johnson",
"phone": "111-222-3333"
},
"admin_graphql_api_id": "gid://shopify/DraftOrder/1234567890"
}
]
},
"pagination": {
"next": {
"page_info": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "next"
}
},
"pageInfo": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "rel=\"next\""
}
}
List Fulfillment Orders
Retrieves a list of fulfillment orders for a specific order. | key: listFulfillmentOrders
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Order ID string / Required orderId | Provide the unique ID of the order. | 450789469 | |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"fulfillment_orders": [
{
"id": 1234567890123,
"order_id": 1234567890123,
"request_status": "UNSUBMITTED",
"status": "OPEN",
"supported_actions": [
"HOLD",
"SPLIT"
],
"destination": {
"id": 1234567890123,
"address1": null,
"address2": null,
"city": null,
"company": null,
"country": null,
"email": "test@example.com",
"first_name": null,
"last_name": null,
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1234567890123,
"quantity": 1,
"line_item_id": 1234567890123,
"inventory_item_id": 1234567890123,
"variant_id": 1234567890123
}
],
"international_duties": null,
"fulfill_at": "2024-11-13T16:00:00Z",
"fulfill_by": null,
"fulfillment_holds": [],
"created_at": "2024-11-13T16:57:40Z",
"updated_at": "2024-11-13T16:57:40Z",
"delivery_method": {
"id": 1234567890123,
"method_type": "SHIPPING",
"min_delivery_date_time": null,
"max_delivery_date_time": null,
"additional_information": {
"instructions": null,
"phone": null
},
"service_code": "custom",
"source_reference": null,
"branded_promise": null,
"presented_name": "Shipping"
},
"assigned_location": {
"address1": "REDACTED",
"address2": null,
"city": "Sioux Falls",
"country_code": "US",
"location_id": 1234567890123,
"name": "REDACTED",
"phone": "",
"province": "South Dakota",
"zip": "57108"
},
"merchant_requests": []
}
]
},
"pagination": {
"next": {
"page_info": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "next"
}
},
"pageInfo": "YXJyYXljb25uZWN0aW9uOjA=",
"rel": "rel=\"next\""
}
}
List Fulfillment Services
List all fulfillment services enabled on your platform. | key: listFulfillmentServicesGql
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
{
"data": {
"fulfillmentServices": [
{
"id": "gid://shopify/FulfillmentService/1234567890?id=true",
"serviceName": "ExampleFulfillmentService",
"handle": "examplefulfillmentservice",
"location": {
"id": "gid://shopify/Location/0987654321"
},
"callbackUrl": "https://example.com/",
"trackingSupport": false,
"inventoryManagement": false,
"permitsSkuSharing": false
}
]
}
}
List Fulfillments
List all fulfillments enabled on your platform. | key: listFulfillments
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Get All Data boolean getAlldata | false | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | |
Limit string limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 20 |
Order ID string / Required orderId | Provide the unique ID of the order. | 450789469 | |
Page Offset Token string pageInfo | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"fulfillments": [
{
"id": 1234567890123,
"order_id": 9876543210987,
"status": "SUCCESS",
"created_at": "2025-01-14T22:03:11Z",
"service": "MANUAL",
"updated_at": "2025-01-14T22:03:11Z",
"tracking_company": null,
"location_id": 123456789012,
"origin_address": null,
"line_items": [
{
"id": 2345678901234,
"variant_id": null,
"title": "Sample product",
"quantity": 2,
"sku": null,
"variant_title": null,
"vendor": "",
"product_id": null,
"requires_shipping": false,
"taxable": true,
"gift_card": false,
"name": "Sample product",
"price": {
"amount": "19.99",
"currencyCode": "USD"
},
"total_discount": {
"amount": "5.00",
"currencyCode": "USD"
},
"fulfillment_status": "fulfilled",
"price_set": {
"shop_money": {
"amount": "19.99",
"currency_code": "USD"
},
"presentment_money": {
"amount": "19.99",
"currency_code": "USD"
}
},
"total_discount_set": {
"shop_money": {
"amount": "5.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "5.00",
"currency_code": "USD"
}
},
"discount_allocations": [
{
"amount": "5.00",
"discount_application_index": 0,
"amount_set": {
"shop_money": {
"amount": "5.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "5.00",
"currency_code": "USD"
}
}
}
],
"duties": [],
"admin_graphql_api_id": "gid://shopify/FulfillmentLineItem/2345678901234"
}
],
"tracking_number": null,
"tracking_numbers": [],
"tracking_url": null,
"tracking_urls": [],
"name": "#9999-F1",
"admin_graphql_api_id": "gid://shopify/Fulfillment/1234567890123"
}
]
}
}
}
List Inventory Items
List all Inventory Items enabled on your platform. | key: listInventoryItemsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Page Offset Cursor string endCursor | Provide a cursor to offset the results. This is used to get the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Fetch All boolean fetchAll | false | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | |
Limit string / Required limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 20 |
Query string query | The query to filter the inventory items. | id:>=30322695 | |
Connection connection / Required shopifyConnection |
{
"data": {
"inventoryItems": [
{
"id": "gid://shopify/InventoryItem/12345678901234",
"sku": "EXAMPLE-SKU",
"createdAt": "2022-01-01T12:00:00Z",
"updatedAt": "2024-12-01T15:30:00Z",
"requiresShipping": true,
"unitCost": {
"amount": "10.0",
"currencyCode": "USD"
},
"countryCodeOfOrigin": null,
"provinceCodeOfOrigin": null,
"harmonizedSystemCode": null,
"tracked": false,
"countryHarmonizedSystemCodes": {
"nodes": []
}
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Inventory Levels At Location
List all Inventory Levels. | key: listInventoryLevelsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Page Offset Cursor string endCursor | Provide a cursor to offset the results. This is used to get the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Fetch All boolean fetchAll | false | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | |
Limit string / Required limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 20 |
Location ID string / Required locationId | The ID of the location that the inventory level belongs to. | 346779380 or gid://shopify/Location/346779380 | |
Connection connection / Required shopifyConnection |
{
"data": {
"inventoryLevels": [
{
"id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076",
"item": {
"id": "gid://shopify/InventoryItem/43729076"
},
"location": {
"id": "gid://shopify/Location/346779380"
},
"quantities": [
{
"name": "available",
"quantity": 0
}
],
"updatedAt": "2024-11-07T20:59:45Z"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Locations
List all locations enabled on your platform. | key: listLocationsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Page Offset Cursor string endCursor | Provide a cursor to offset the results. This is used to get the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Fetch All boolean fetchAll | false | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | |
Limit string / Required limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 20 |
Connection connection / Required shopifyConnection |
{
"data": {
"locations": [
{
"id": "gid://shopify/Location/12345678901",
"name": "123 Example St Suite 100",
"address": {
"address1": "123 Example St Suite 100",
"address2": null,
"city": "Example City",
"zip": "12345",
"province": "Example State",
"country": "Example Country",
"phone": "",
"countryCode": "EX",
"provinceCode": "ES"
},
"createdAt": "2022-01-01T10:00:00Z",
"updatedAt": "2022-01-01T10:00:00Z",
"isActive": true
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Metafields
List resource metafields. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change. | key: listMetafieldsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Page Offset Cursor string endCursor | Provide a cursor to offset the results. This is used to get the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Fetch All boolean fetchAll | false | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | |
Limit string / Required limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 20 |
Resource string / Required resource | Provide a unique ID of a resource. | gid://shopify/Product/20995642 | |
Connection connection / Required shopifyConnection |
{
"data": {
"metafields": [
{
"key": "myKey",
"value": "myValue",
"type": "single_line_text_field",
"namespace": "app--1234567",
"productId": "gid://shopify/Product/20995642",
"description": null,
"jsonValue": "myValue",
"createdAt": "2025-01-28T20:52:51Z",
"updatedAt": "2025-01-28T20:52:51Z"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Orders
List all orders. | key: listOrdersGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Page Offset Cursor string endCursor | Provide a cursor to offset the results. This is used to get the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Fetch All boolean fetchAll | false | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | |
Limit string / Required limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 20 |
Query string query | The query to filter the orders. | updated_at:>2019-12-01 | |
Connection connection / Required shopifyConnection |
{
"data": {
"orders": [
{
"id": "gid://shopify/Order/1234567890123",
"name": "#1234",
"app": {
"id": "gid://shopify/App/9876543210987"
},
"clientIp": "0.0.0.0",
"customerAcceptsMarketing": false,
"cancelReason": null,
"cancelledAt": null,
"closedAt": null,
"confirmationNumber": "ABC123XYZ",
"confirmed": true,
"createdAt": "2024-12-08T11:29:38Z",
"currencyCode": "USD",
"currentSubtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalAdditionalFeesSet": null,
"currentTotalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"currentTotalDutiesSet": null,
"currentTotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"currentTotalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"customerLocale": "en",
"discountCodes": [],
"dutiesIncluded": false,
"email": "example@example.com",
"estimatedTaxes": false,
"displayFinancialStatus": "PAID",
"displayFulfillmentStatus": "UNFULFILLED",
"retailLocation": null,
"merchantBusinessEntity": {
"id": "gid://shopify/BusinessEntity/1122334455667"
},
"merchantOfRecordApp": null,
"note": "Example note",
"originalTotalAdditionalFeesSet": null,
"originalTotalDutiesSet": null,
"paymentGatewayNames": [
"manual"
],
"phone": null,
"poNumber": null,
"presentmentCurrencyCode": "USD",
"processedAt": "2024-12-08T11:29:38Z",
"sourceIdentifier": "example-source-id",
"sourceName": "9876543210987",
"registeredSourceUrl": null,
"subtotalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"tags": [],
"taxExempt": true,
"taxLines": [],
"taxesIncluded": false,
"test": false,
"totalCashRoundingAdjustment": {
"paymentSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"refundSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
}
},
"totalDiscountsSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"totalOutstandingSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"shopMoney": {
"amount": "50.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "50.00",
"currencyCode": "USD"
}
},
"totalShippingPriceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTaxSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalTipReceivedSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"totalWeight": "5000",
"updatedAt": "2024-12-08T11:29:39Z",
"billingAddress": {
"address1": "123 Example St",
"address2": null,
"name": "John Doe",
"lastName": "Doe",
"company": null,
"phone": null,
"zip": "12345",
"country": "United States",
"countryCodeV2": "US",
"province": "California",
"provinceCode": "CA"
},
"customer": {
"id": "gid://shopify/Customer/4567890123456",
"displayName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"phone": null
},
"lineItems": {
"nodes": [
{
"id": "gid://shopify/LineItem/2345678901234",
"currentQuantity": 3,
"unfulfilledQuantity": 3,
"isGiftCard": false,
"name": "Sample Product",
"originalUnitPriceSet": {
"shopMoney": {
"amount": "16.67",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "16.67",
"currencyCode": "USD"
}
},
"product": null,
"quantity": 3,
"requiresShipping": true,
"sku": "EX123",
"taxable": true,
"title": "Sample Product",
"totalDiscountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"variant": null,
"vendor": "Example Vendor",
"taxLines": [
{
"channelLiable": false,
"priceSet": {
"shopMoney": {
"amount": "0.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "0.00",
"currencyCode": "USD"
}
},
"rate": 0.05,
"title": "Example Tax"
}
],
"duties": [],
"discountAllocations": [
{
"allocatedAmountSet": {
"shopMoney": {
"amount": "5.00",
"currencyCode": "USD"
},
"presentmentMoney": {
"amount": "5.00",
"currencyCode": "USD"
}
},
"discountApplication": {
"index": 0
}
}
]
}
]
},
"paymentTerms": null,
"refunds": [],
"shippingAddress": {
"firstName": "John",
"address1": "123 Example St",
"phone": null,
"city": "Example City",
"zip": "12345",
"province": "California",
"country": "United States",
"lastName": "Doe",
"address2": null,
"company": null,
"latitude": null,
"longitude": null,
"name": "John Doe",
"countryCodeV2": "US",
"provinceCode": "CA"
}
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Orders (Deprecated)
List all orders. This version of the action is being deprecated. Please replace action with List Orders. | key: listOrders
| Input | Default | Notes | Example |
|---|---|---|---|
Attribution App ID string attributionAppId | Show orders attributed to a certain app, specified by the app ID. | current | |
Ids string commaSeparatedIds | Retrieve only orders specified by a comma-separated list of order IDs. | 450789469,39072856 | |
Created At Min string created_at_min | Show orders created at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 | |
Created At Max string createdAtMax | Show orders created at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Fields string fields | Retrieve only certain fields, specified by a comma-separated list of fields names. | id,currency | |
Financial Status string financialStatus | Filter orders by their financial status. | authorized | |
Fulfillment Status string fulfillmentStatus | Filter orders by their fulfillment status. | shipped | |
Get All Data boolean getAlldata | false | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | |
Limit string limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 20 |
Status string orderStatus | Filter orders by their status. | open | |
Page Offset Token string pageInfo | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Processed At Max string processedAtMax | Show orders imported at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 | |
Processed At Min string processedAtMin | Show orders imported at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 | |
Connection connection / Required shopifyConnection | |||
Since Id string sinceId | Show orders after the specified ID. | 450789469 | |
Updated At Max string updatedAtMax | Show orders last updated at or before date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 | |
Updated At Min string updatedAtMin | Show orders last updated at or after date. ISO 8601 format like 2021-10-01 or 2021-10-01T00:00:00-04:00 for exact time. | 2021-10-01 |
{
"data": {
"data": {
"orders": [
{
"id": 12345678912345,
"admin_graphql_api_id": "gid://shopify/Order/12345678912345",
"app_id": 123456,
"browser_ip": "192.168.0.1",
"buyer_accepts_marketing": false,
"cancel_reason": null,
"cancelled_at": null,
"cart_token": null,
"checkout_id": 30873867714713,
"checkout_token": "c0a38ddd2c577019041f04b17fe53761",
"client_details": {
"accept_language": null,
"browser_height": null,
"browser_ip": "192.168.0.1",
"browser_width": null,
"session_hash": null,
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36"
},
"closed_at": null,
"company": null,
"confirmed": true,
"contact_email": null,
"created_at": "2024-03-06T14:31:14-07:00",
"currency": "USD",
"current_subtotal_price": "0.00",
"current_subtotal_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"current_total_additional_fees_set": null,
"current_total_discounts": "0.00",
"current_total_discounts_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"current_total_duties_set": null,
"current_total_price": "0.00",
"current_total_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"current_total_tax": "0.00",
"current_total_tax_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"customer_locale": "en",
"device_id": null,
"discount_codes": [],
"email": "",
"estimated_taxes": false,
"financial_status": "paid",
"fulfillment_status": null,
"landing_site": null,
"landing_site_ref": null,
"location_id": 65947994123,
"merchant_of_record_app_id": null,
"name": "#1157",
"note": null,
"note_attributes": [],
"number": 157,
"order_number": 1157,
"order_status_url": "https://test-store.myshopify.com/60628201234/orders/abcdef12345/authenticate?key=e79e76cb7634bee51d1d70fd8fbf2840",
"original_total_additional_fees_set": null,
"original_total_duties_set": null,
"payment_gateway_names": [],
"phone": null,
"presentment_currency": "USD",
"processed_at": "2024-03-06T14:31:13-07:00",
"reference": "6b89108234e53714356e05091234567",
"referring_site": null,
"source_identifier": "6b89108234e53714356e05091234567",
"source_name": "shopify_draft_order",
"source_url": null,
"subtotal_price": "0.00",
"subtotal_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"tags": "",
"tax_lines": [],
"taxes_included": false,
"test": false,
"token": "abcdef12345",
"total_discounts": "0.00",
"total_discounts_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_line_items_price": "0.00",
"total_line_items_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_outstanding": "0.00",
"total_price": "0.00",
"total_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_shipping_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_tax": "0.00",
"total_tax_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_tip_received": "0.00",
"total_weight": 0,
"updated_at": "2024-03-06T14:31:15-07:00",
"user_id": 987654321,
"billing_address": null,
"customer": null,
"discount_applications": [],
"fulfillments": [],
"line_items": [
{
"id": 456789123,
"admin_graphql_api_id": "gid://shopify/LineItem/456789123",
"fulfillable_quantity": 1,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 0,
"name": "Shirt - Blue / Small",
"price": "0.00",
"price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 7733213712345,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "",
"taxable": true,
"title": "Shirt",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 43449939394713,
"variant_inventory_management": null,
"variant_title": "Blue / Small",
"vendor": "Acme",
"tax_lines": [],
"duties": [],
"discount_allocations": []
},
{
"id": 13397695332505,
"admin_graphql_api_id": "gid://shopify/LineItem/13397695332505",
"fulfillable_quantity": 1,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 0,
"name": "Shirt - Black / Small",
"price": "0.00",
"price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"product_exists": true,
"product_id": 7733213712345,
"properties": [],
"quantity": 1,
"requires_shipping": true,
"sku": "",
"taxable": true,
"title": "Shirt",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"variant_id": 43449939427481,
"variant_inventory_management": null,
"variant_title": "Black / Small",
"vendor": "Acme",
"tax_lines": [],
"duties": [],
"discount_allocations": []
}
],
"payment_terms": null,
"refunds": [],
"shipping_address": null,
"shipping_lines": []
}
]
},
"pagination": {
"previous": {
"limit": "2",
"page_info": "eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456",
"rel": "previous",
"url": "https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456"
},
"next": {
"limit": "2",
"page_info": "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd",
"rel": "next",
"url": "https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd"
}
},
"pageInfo": "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd",
"rel": "rel=\"next\"",
"headers": {
"date": "Tue, 26 Mar 2024 23:31:56 GMT",
"content-type": "application/json; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close",
"x-sorting-hat-podid": "152",
"x-sorting-hat-shopid": "60628201234",
"vary": "Accept-Encoding, Accept",
"referrer-policy": "origin-when-cross-origin",
"x-frame-options": "DENY",
"x-shopid": "60628201234",
"x-shardid": "152",
"x-stats-userid": "",
"x-stats-apiclientid": "6511233",
"x-stats-apipermissionid": "429538012345",
"x-shopify-api-version": "2023-04",
"x-shopify-api-version-warning": "https://shopify.dev/concepts/about-apis/versioning",
"http_x_shopify_shop_api_call_limit": "1/40",
"x-shopify-shop-api-call-limit": "1/40",
"link": "<https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456>; rel=\"previous\", <https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd>; rel=\"next\"",
"strict-transport-security": "max-age=7889238",
"x-request-id": "da004e10-b646-4c9a-b340-74537e4a066b-12346",
"server-timing": "processing;dur=78, cfRequestDuration;dur=137.999773",
"x-shopify-stage": "production",
"content-security-policy": "default-src 'self' data: blob: 'unsafe-inline' 'unsafe-eval' https://* shopify-pos://*; block-all-mixed-content; child-src 'self' https://* shopify-pos://*; connect-src 'self' wss://* https://*; frame-ancestors 'none'; img-src 'self' data: blob: https:; script-src https://cdn.shopify.com https://cdn.shopifycdn.net https://checkout.shopifycs.com https://api.stripe.com https://mpsnare.iesnare.com https://appcenter.intuit.com https://www.paypal.com https://js.braintreegateway.com https://c.paypal.com https://maps.googleapis.com https://www.google-analytics.com https://v.shopify.com 'self' 'unsafe-inline' 'unsafe-eval'; upgrade-insecure-requests; report-uri /csp-report?source%5Baction%5D=index&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin_api&source%5Buuid%5D=da004e10-b646-4c9a-b340-74537e4a066b-12346",
"x-content-type-options": "nosniff",
"x-download-options": "noopen",
"x-permitted-cross-domain-policies": "none",
"x-xss-protection": "1; mode=block; report=/xss-report?source%5Baction%5D=index&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin_api&source%5Buuid%5D=da004e10-b646-4c9a-b340-74537e4a066b-12346",
"x-envoy-upstream-service-time": "81",
"x-dc": "gcp-us-central1,gcp-us-central1",
"cf-cache-status": "DYNAMIC",
"report-to": "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=uu1FyX%2B%2BP%2FEeJ6ZHU0JrkwDut31f4GbXULyxPQ8i1mdykz%2BFk%2FwIDraEoru0w7h173cXMiZLoz3pdLbFSkF0j5TnUkEXI94jinI0gmj3dMjX9LzrXPnEJ%2Bb1HqTUMc41db0xG72h%2FmGe%2F3W8OPrtdVF7\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
"nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
"server": "cloudflare",
"cf-ray": "86aaefe76d1710b6-ORD",
"alt-svc": "h3=\":443\"; ma=86400"
}
}
}
List Product Images
List all product images connected to your platform. | key: listProductImages
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Product ID string / Required productId | Provide a value for the product Id. | 74020090 | |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"images": [
{
"id": 12345678901234,
"alt": "sample alt text",
"position": 0,
"product_id": 9876543210987,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:01Z",
"admin_graphql_api_id": "gid://shopify/MediaImage/12345678901234",
"width": 100,
"height": 150,
"src": "https://example.com/images/sample.jpg"
}
]
}
}
}
List Products
List all products connected to your platform. | key: listProducts
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Get All Data boolean getAlldata | false | API is limited to 250 records per page max, turn this on to get all data from all pages. When turned on, the limit input will be ignored. | |
Limit string limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. If not provided, the default limit is 50. To get more than 250 results, turn the 'Get All Data' toggle on. | 20 |
Page Offset Token string pageInfo | Provide the page offset token for the given object's results. This is a unique ID used to access a certain page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Connection connection / Required shopifyConnection |
{
"data": {
"data": {
"products": [
{
"id": 632910392,
"title": "IPod Nano - 8GB",
"body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
"vendor": "Apple",
"product_type": "Cult Products",
"created_at": "2023-07-11T17:47:36-04:00",
"handle": "ipod-nano",
"updated_at": "2023-07-11T17:47:36-04:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"status": "active",
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"admin_graphql_api_id": "gid://shopify/Product/632910392",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Pink",
"option2": null,
"option3": null,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 808950810,
"inventory_quantity": 10,
"old_inventory_quantity": 10,
"presentment_prices": [
{
"price": {
"amount": "199.00",
"currency_code": "USD"
},
"compare_at_price": null
}
],
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810"
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1689112056",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
],
"image": {
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2023-07-11T17:47:36-04:00",
"updated_at": "2023-07-11T17:47:36-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1689112056",
"variant_ids": [],
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
}
}
]
},
"pagination": {
"previous": {
"limit": "2",
"page_info": "eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456",
"rel": "previous",
"url": "https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456"
},
"next": {
"limit": "2",
"page_info": "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd",
"rel": "next",
"url": "https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd"
}
},
"pageInfo": "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd",
"rel": "rel=\"next\"",
"headers": {
"date": "Tue, 26 Mar 2024 23:31:56 GMT",
"content-type": "application/json; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close",
"x-sorting-hat-podid": "152",
"x-sorting-hat-shopid": "60628201234",
"vary": "Accept-Encoding, Accept",
"referrer-policy": "origin-when-cross-origin",
"x-frame-options": "DENY",
"x-shopid": "60628201234",
"x-shardid": "152",
"x-stats-userid": "",
"x-stats-apiclientid": "6511233",
"x-stats-apipermissionid": "429538012345",
"x-shopify-api-version": "2023-04",
"x-shopify-api-version-warning": "https://shopify.dev/concepts/about-apis/versioning",
"http_x_shopify_shop_api_call_limit": "1/40",
"x-shopify-shop-api-call-limit": "1/40",
"link": "<https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6NTMyNjQwNDQ4NTI3MywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzE6MTQuNDMxO123456>; rel=\"previous\", <https://test-store.myshopify.com/admin/api/2023-04/resource?limit=2&page_info=eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NTMyNjQwNDMyMTQzMywibGFzdF92YWx1ZSI6IjIwMjQtMDMtMDYgMjE6MzA6NTYuOTY1NDYabcd>; rel=\"next\"",
"strict-transport-security": "max-age=7889238",
"x-request-id": "da004e10-b646-4c9a-b340-74537e4a066b-12346",
"server-timing": "processing;dur=78, cfRequestDuration;dur=137.999773",
"x-shopify-stage": "production",
"content-security-policy": "default-src 'self' data: blob: 'unsafe-inline' 'unsafe-eval' https://* shopify-pos://*; block-all-mixed-content; child-src 'self' https://* shopify-pos://*; connect-src 'self' wss://* https://*; frame-ancestors 'none'; img-src 'self' data: blob: https:; script-src https://cdn.shopify.com https://cdn.shopifycdn.net https://checkout.shopifycs.com https://api.stripe.com https://mpsnare.iesnare.com https://appcenter.intuit.com https://www.paypal.com https://js.braintreegateway.com https://c.paypal.com https://maps.googleapis.com https://www.google-analytics.com https://v.shopify.com 'self' 'unsafe-inline' 'unsafe-eval'; upgrade-insecure-requests; report-uri /csp-report?source%5Baction%5D=index&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin_api&source%5Buuid%5D=da004e10-b646-4c9a-b340-74537e4a066b-12346",
"x-content-type-options": "nosniff",
"x-download-options": "noopen",
"x-permitted-cross-domain-policies": "none",
"x-xss-protection": "1; mode=block; report=/xss-report?source%5Baction%5D=index&source%5Bapp%5D=Shopify&source%5Bcontroller%5D=admin%2Forders&source%5Bsection%5D=admin_api&source%5Buuid%5D=da004e10-b646-4c9a-b340-74537e4a066b-12346",
"x-envoy-upstream-service-time": "81",
"x-dc": "gcp-us-central1,gcp-us-central1",
"cf-cache-status": "DYNAMIC",
"report-to": "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=uu1FyX%2B%2BP%2FEeJ6ZHU0JrkwDut31f4GbXULyxPQ8i1mdykz%2BFk%2FwIDraEoru0w7h173cXMiZLoz3pdLbFSkF0j5TnUkEXI94jinI0gmj3dMjX9LzrXPnEJ%2Bb1HqTUMc41db0xG72h%2FmGe%2F3W8OPrtdVF7\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
"nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
"server": "cloudflare",
"cf-ray": "86aaefe76d1710b6-ORD",
"alt-svc": "h3=\":443\"; ma=86400"
}
}
}
List Variants
List all variants connected to the provided product. | key: listVariantsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Page Offset Cursor string endCursor | Provide a cursor to offset the results. This is used to get the next page of results. | eyJkaXJlY3Rpb24iOiJwcmV2IiwibGFzdF9pZCI6OTAyOTk2ODAwMzM1NCwibGFzdF92YWx1ZSI6IlRoZSBDb2xsZWN0aW9uIFNub3dib2FyZDogTGlxdWlkIn0 | |
Fetch All boolean fetchAll | false | API is limited to 250 records per page max, turn this ON to get all data from all pages. When turned ON, the 'Limit' and 'Page Offset Cursor' inputs are ignored. | |
Limit string / Required limit | 50 | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 250. To get more than 250 results, turn the 'Fetch All' toggle ON. | 20 |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 | |
Connection connection / Required shopifyConnection |
{
"data": {
"productVariants": [
{
"id": "gid://shopify/ProductVariant/30322695",
"title": "151cm"
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "YXJyYXljb25uZWN0aW9uOjA="
}
}
}
List Webhooks
List all webhooks or webhooks for this instance. | key: listWebhooks
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection | ||
Show only instance webhooks boolean showOnlyInstanceWebhooks | true | Show only webhooks that point to this instance |
{
"data": [
{
"id": 4759306,
"address": "https://apple.com",
"topic": "orders/create",
"created_at": "2024-03-14T13:44:21-04:00",
"updated_at": "2024-03-14T13:44:21-04:00",
"format": "json",
"fields": [],
"metafield_namespaces": [],
"api_version": "unstable",
"private_metafield_namespaces": []
}
]
}
Raw Request
Send raw GraphQL request to Shopify. | key: graphQlRawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string / Required apiVersion | 2024-10 | Shopify versions its API. See https://shopify.dev/docs/api/release-notes for a list of available versions. | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Query or Mutation code / Required query | GraphQL query or mutation. See Shopify's GraphQL API documentation for examples. Ex: { shop { name } } | ||
Variables string Key Value List variables | Variables to pass to the query or mutation. | key1: value1, key2: value2 | |
Variables Object code variablesObject | Variables to pass to the query or mutation. |
Raw Request (Deprecated)
Send raw HTTP request to Shopify. This version of the action uses REST and is being deprecated. Please replace action with the Raw Request utilizing GraphQL. | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string / Required apiVersion | 2024-10 | Shopify versions its API. See https://shopify.dev/docs/api/release-notes for a list of available versions. | |
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. Specify 0 for no retries. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | |
Return Headers boolean returnHeaders | false | Return response headers in the output object. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | Input the path only (/users/current.json), The base URL is already included (https://YOUR-DOMAIN.myshopify.com/admin/api/API-VERSION). For example, to connect to https://YOUR-DOMAIN.myshopify.com/admin/api/API-VERSION/users/current.json, only /users/current.json is entered in this field. | /users/current.json | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. |
Set Metafield
Set a resource metafield. Note: This action currently utilizes an unstable version of the Shopify Admin GraphQL API and is subject to change. | key: setMetafieldGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Key string / Required key | Provide a key for the metafield. | myKey | |
Namespace string namespace | Provide a namespace for the metafield. | global | |
Owner ID string / Required ownerId | Provide a unique ID of the owner of the metafield. | gid://shopify/Product/20995642 | |
Connection connection / Required shopifyConnection | |||
Type string type | Provide a type for the metafield. Required when there is no corresponding definition for the given namespace, key, and owner resource type. | single_line_text_field | |
Value string / Required value | Provide a value for the metafield. | myValue |
{
"data": {
"metafields": [
{
"key": "myKey",
"value": "myValue",
"type": "single_line_text_field",
"namespace": "app--1234567",
"productId": "gid://shopify/Product/20995642",
"description": null,
"jsonValue": "myValue",
"createdAt": "2025-01-28T20:52:51Z",
"updatedAt": "2025-01-28T20:52:51Z"
}
],
"userErrors": []
}
}
Update Customer
Update the information and metadata of an existing customer by Id. | key: updateCustomerGql
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. This is a JSON object. | ||
Address List code addressListGql | Provide a JSON array containing address objects. | ||
Customer string / Required customerIdGql | Provide a value for the unique ID of the customer. | 5940139491234 or gid://shopify/Customer/5940139491234 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Email string email | Provide a string value for the email of the customer. | someone@example.com | |
First Name string firstName | Provide a string value for the first name | John | |
Last Name string lastName | Provide a string value for the last name of the customer. | Doe | |
Metafields code metafields | Provide a JSON array containing metadata objects. | ||
Notes string notes | Provide a value for a note on the customer. | This is an example note. | |
Phone string phone | Provide a value for the phone number of the customer. | +18005555454 | |
Connection connection / Required shopifyConnection | |||
Tags string Value List tags | For each list item, provide a string you would like to tag the product with. | Style | |
Tax Exempt string taxExempt | Determines if the customer is tax exempt. |
{
"data": {
"userErrors": [],
"customer": {
"id": "gid://shopify/Customer/8000000000000",
"email": "example@example.com",
"createdAt": "2025-01-07T09:32:23Z",
"updatedAt": "2025-01-07T09:32:23Z",
"firstName": "John",
"lastName": "Doe",
"state": "DISABLED",
"lastOrder": null,
"note": null,
"verifiedEmail": true,
"multipassIdentifier": null,
"taxExempt": false,
"tags": [],
"phone": "+18000000000",
"addresses": [
{
"id": "gid://shopify/MailingAddress/9000000000000?model_name=CustomerAddress",
"firstName": "Jane",
"lastName": "Smith",
"company": "Example Corp",
"address1": "456 Oak Avenue",
"address2": "Suite 12",
"city": "Metropolis",
"province": "California",
"country": "United States",
"zip": "90210",
"phone": "555-000-0000",
"name": "Jane Smith",
"provinceCode": "CA",
"countryCodeV2": "US"
}
],
"taxExemptions": [],
"emailMarketingConsent": {
"marketingState": "NOT_SUBSCRIBED",
"marketingOptInLevel": "SINGLE_OPT_IN",
"consentUpdatedAt": null
},
"smsMarketingConsent": {
"marketingState": "NOT_SUBSCRIBED",
"marketingOptInLevel": "SINGLE_OPT_IN",
"consentUpdatedAt": null,
"consentCollectedFrom": "OTHER"
},
"defaultAddress": {
"id": "gid://shopify/MailingAddress/9000000000000?model_name=CustomerAddress",
"firstName": "Jane",
"lastName": "Smith",
"company": "Example Corp",
"address1": "456 Oak Avenue",
"address2": "Suite 12",
"city": "Metropolis",
"province": "California",
"country": "United States",
"zip": "90210",
"phone": "555-000-0000",
"name": "Jane Smith",
"provinceCode": "CA",
"countryCodeV2": "US"
}
}
}
}
Update Fulfillment Service
Modify an existing fulfillment service. | key: updateFulfillmentServiceGql
| Input | Default | Notes | Example |
|---|---|---|---|
Callback URL string callbackUrl | The callback URL that the fulfillment service has registered for request. | https://example.com | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Fulfillment Service ID string / Required fulfillmentServiceId | Provide the unique ID of the fulfillment service. | gid://shopify/FulfillmentService/18961920?id=true | |
Fulfillment Service Name string fulfillmentServiceName | The name of the fulfillment service. | MyFulfillmentService | |
Inventory Management string inventoryManagement | Whether the fulfillment services tracks product inventory and provides updates to Shopify. | ||
Connection connection / Required shopifyConnection | |||
Tracking Support string trackingSupport | Whether the fulfillment service supports tracking numbers for packages. |
{
"data": {
"fulfillmentService": {
"id": "gid://shopify/FulfillmentService/1234567890?id=true",
"serviceName": "ExampleFulfillmentService",
"handle": "examplefulfillmentservice",
"location": {
"id": "gid://shopify/Location/0987654321"
},
"callbackUrl": "https://example.com/",
"trackingSupport": false,
"inventoryManagement": false,
"permitsSkuSharing": false
},
"userErrors": []
}
}
Update Inventory Item
Update the information and metadata of an Inventory Item enabled on your platform. | key: updateInventoryItemsGql
| Input | Default | Notes | Example |
|---|---|---|---|
Cost string cost | Unit cost associated with the inventory item, the currency is the shop's default currency. | 1.00 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Inventory Item Id string / Required itemId | Provide a unique ID of a Inventory Item. | gid://shopify/InventoryItem/43933612241234 | |
Connection connection / Required shopifyConnection | |||
SKU string sku | The SKU (stock keeping unit) of the inventory item. | 97802837847 | |
Tracked string tracked | Whether the inventory item is tracked. |
{
"data": {
"inventoryItem": {
"id": "gid://shopify/InventoryItem/12345678901234",
"sku": "EXAMPLE-SKU",
"createdAt": "2022-01-01T12:00:00Z",
"updatedAt": "2024-12-01T15:30:00Z",
"requiresShipping": true,
"unitCost": {
"amount": "10.0",
"currencyCode": "USD"
},
"countryCodeOfOrigin": null,
"provinceCodeOfOrigin": null,
"harmonizedSystemCode": null,
"tracked": false,
"countryHarmonizedSystemCodes": {
"nodes": []
}
},
"userErrors": []
}
}
Update Product
Update the information and metadata of an existing product by Id. | key: updateProductGql
| Input | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. This is a JSON object. | ||
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Description HTML string descriptionHtml | Provide an HTML string for the description of the product. | <p>This is an example product.</p> | |
Image Alt Text string imageAlt | Provide the alt text for the image of the product. | Alt text | |
Image URL string imageUrl | Provide a URL for the image of the product. | https://example.com/image.jpg | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Product Status string productStatus | Specify the status of the product. | ||
Product Type string productType | Provide a value for the type of product. | T-shirt | |
Connection connection / Required shopifyConnection | |||
Tags string Value List tags | For each list item, provide a string you would like to tag the product with. | Style | |
Title string title | Provide a string value for the title of the product. | Example Product | |
Vendor string vendor | Provide a value for the vendor of the product. | Burton inc. |
{
"data": {
"product": {
"id": "gid://shopify/Product/912855135",
"title": "Helmet Nova",
"media": {
"nodes": [
{
"alt": "Gray helmet for bikers",
"mediaContentType": "IMAGE",
"preview": {
"status": "UPLOADED"
}
}
]
}
},
"userErrors": []
}
}
Update Variant
Update the information and metadata of an existing product variant by Id. | key: updateVariantGql
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Product ID string / Required productId | Provide a value for the product Id. | 108828309 or gid://shopify/Product/108828309 | |
Connection connection / Required shopifyConnection | |||
Update Variant code / Required updateVariant | Provide a JSON object containing the variant data to update. |
{
"data": {
"product": {
"id": "gid://shopify/Product/20995642"
},
"productVariants": null,
"userErrors": [
{
"field": [
"variants",
"0",
"id"
],
"message": "Product variant does not exist"
}
]
}
}