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 Storefront API Documentation.
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 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 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 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 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 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"