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: 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
Example Payload for Webhook
Example Payload for Webhook
{
"payload": {
"headers": {
"accept": "*/*",
"Content-Type": "application/json",
"User-Agent": "Shopify-Captain-Hook",
"X-Shopify-Api-Version": "unstable",
"X-Shopify-Shop-Domain": "example.myshopify.com",
"X-Shopify-Topic": "customers/create",
"X-Shopify-Webhook-Id": "example-webhook-id",
"Host": "hooks.example.prismatic.io"
},
"body": {
"data": {}
},
"rawBody": {
"data": {
"type": "Buffer",
"data": [
69,
120,
97,
109,
112,
108,
101
]
}
},
"queryParameters": null,
"webhookUrls": {
"Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA=="
},
"webhookApiKeys": {
"Flow 1": [
"abc-123"
]
},
"customer": {
"externalId": "customer-example-external-id",
"name": "John Doe"
}
}
}
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: cancelOrder
| 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 |
Example Payload for Cancel Order
Example Payload for Cancel Order
{
"data": {
"order": {
"id": 450789469,
"name": "#1001",
"total_price": "598.94",
"line_items": [
{
"id": 466157049,
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"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",
"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",
"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
}
]
}
]
},
"notice": "Order has been cancelled"
}
}
Close Order
Closes a completed order | key: closeOrder
| 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 |
Complete Draft Order
Mark a draft order as complete | key: completeDraftOrder
| 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 the unique ID of the order. | 450789469 | |
Connection connection / Required shopifyConnection |
Example Payload for Complete Draft Order
Example Payload for Complete Draft Order
{
"data": {
"data": {
"draft_order": {
"id": 994118539,
"note": "rush order",
"email": "bob.norman@mail.example.com",
"taxes_included": false,
"currency": "USD",
"invoice_sent_at": null,
"created_at": "2023-05-09T10:02:22-04:00",
"updated_at": "2023-05-09T10:02:22-04:00",
"tax_exempt": false,
"completed_at": null,
"name": "#D2",
"status": "open",
"line_items": [
{
"id": 994118539,
"variant_id": 39072856,
"product_id": 632910392,
"title": "IPod Nano - 8gb",
"variant_title": "green",
"sku": "IPOD2008GREEN",
"vendor": null,
"quantity": 1,
"requires_shipping": false,
"taxable": true,
"gift_card": false,
"fulfillment_service": "manual",
"grams": 567,
"tax_lines": [],
"applied_discount": null,
"name": "IPod Nano - 8gb - green",
"properties": [],
"custom": false,
"price": "199.00",
"admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/994118539"
}
],
"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"
},
"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"
},
"invoice_url": "https://jsmith.myshopify.com/548380009/invoices/ba8dcf6c022ccad3d47e3909e378e33f",
"applied_discount": {
"description": "$5promo",
"value": "5.0",
"title": null,
"amount": "5.00",
"value_type": "fixed_amount"
},
"order_id": null,
"shipping_line": {
"title": "UPS Ground",
"custom": false,
"handle": "ups-3-12.25",
"price": "12.25"
},
"tax_lines": [],
"tags": "Wholesale",
"note_attributes": [],
"total_price": "206.25",
"subtotal_price": "194.00",
"total_tax": "0.00",
"payment_terms": null,
"admin_graphql_api_id": "gid://shopify/DraftOrder/994118539",
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"accepts_marketing": false,
"created_at": "2023-05-09T10:02:22-04:00",
"updated_at": "2023-05-09T10:02:22-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",
"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-05-09T10:02:22-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
}
}
}
},
"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"
}
}
}
Connect Inventory Item To Location
Connect an existing Inventory Item to an existing Location | key: connectInventoryLevel
| 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 | r84963704502935 | |
Location ID string / Required locationId | The ID of the location that the inventory level belongs to. | 844681632 | |
Connection connection / Required shopifyConnection |
Example Payload for Connect Inventory Item To Location
Example Payload for Connect Inventory Item To Location
{
"data": {
"data": {
"inventory_level": {
"inventory_item_id": 457924702,
"location_id": 844681632,
"available": 0,
"updated_at": "2024-01-02T08:57:20-05:00",
"admin_graphql_api_id": "gid://shopify/InventoryLevel/844681632?inventory_item_id=457924702"
}
},
"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 Collects
Count all available collects | key: countCollects
| Input | Default | Notes | Example |
|---|---|---|---|
Collect Id string / Required collectId | Provide a unique ID of a collect | r84963704502935 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection |
Example Payload for Count Collects
Example Payload for Count Collects
{
"data": {
"data": {
"count": 2
},
"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 Customers
Retrieve a count of all the customers connected to your platform | key: countCustomers
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
Example Payload for Count Customers
Example Payload for Count Customers
{
"data": {
"count": 1
}
}
Count Draft Orders
Count all draft orders | key: countDraftOrders
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
Example Payload for Count Draft Orders
Example Payload for Count Draft Orders
{
"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 Location
Count the number of locations enabled on your platform | key: countLocations
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
Example Payload for Count Location
Example Payload for Count Location
{
"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 Orders
Returns a count of all orders | key: countOrders
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection | ||
Status string / Required status | Provide a status for the orders you want to be returned |
Example Payload for Count Orders
Example Payload for Count Orders
{
"data": {
"count": 1
}
}
Count Product Images
Count all product images connected to your platform | key: countProductImages
| 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 |
Example Payload for Count Product Images
Example Payload for Count Product Images
{
"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 Products
Count all Products in your account | key: countProducts
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Limit string limit | 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 Info 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 |
Example Payload for Count Products
Example Payload for Count Products
{
"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: countVariants
| 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 |
Example Payload for Count Variants
Example Payload for Count Variants
{
"data": {
"count": 1
}
}
Create Account Activation URL
Create an account activation URL for an existing customer | key: createAccountActivationURL
| 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 |
Example Payload for Create Account Activation URL
Example Payload for Create Account Activation URL
{
"data": {
"account_activation_url": "https://jsmith.myshopify.com/account/activate/207119551/b2b567478ce4eeec0e8caeb7e472c543-1689114132"
}
}
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. |
Example Payload for Create Customer
Example Payload for Create 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: createDraftOrder
| Input | Default | Notes | Example |
|---|---|---|---|
Customer string 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. | |
Line items code / Required lineItems | Provide a JSON array containing objects(line items). For more information on building line item objects, refer to the Shopify docs: https://shopify.dev/api/admin-rest/2021-10/resources/draftorder#post-draft-orders | ||
Connection connection / Required shopifyConnection | |||
Subtotal Price string subTotalPrice | The subtotal price of the order. | 398 | |
Taxes Included boolean / Required taxIncluded | false | This flag determines if tax is included in the total order price. | |
Total Price string totalPrice | The total price of the order. | 11.94 | |
Total Tax string totalTax | The total tax of the order. | 1.94 | |
Use Customer Default Address boolean useCustomerAddress | false | This flag determines if the order will use the customers default address. |
Example Payload for Create Draft Orders
Example Payload for Create Draft Orders
{
"data": {
"data": {
"draft_order": {
"id": 994118539,
"note": "rush order",
"email": "bob.norman@mail.example.com",
"taxes_included": false,
"currency": "USD",
"invoice_sent_at": null,
"created_at": "2023-05-09T10:02:22-04:00",
"updated_at": "2023-05-09T10:02:22-04:00",
"tax_exempt": false,
"completed_at": null,
"name": "#D2",
"status": "open",
"line_items": [
{
"id": 994118539,
"variant_id": 39072856,
"product_id": 632910392,
"title": "IPod Nano - 8gb",
"variant_title": "green",
"sku": "IPOD2008GREEN",
"vendor": null,
"quantity": 1,
"requires_shipping": false,
"taxable": true,
"gift_card": false,
"fulfillment_service": "manual",
"grams": 567,
"tax_lines": [],
"applied_discount": null,
"name": "IPod Nano - 8gb - green",
"properties": [],
"custom": false,
"price": "199.00",
"admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/994118539"
}
],
"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"
},
"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"
},
"invoice_url": "https://jsmith.myshopify.com/548380009/invoices/ba8dcf6c022ccad3d47e3909e378e33f",
"applied_discount": {
"description": "$5promo",
"value": "5.0",
"title": null,
"amount": "5.00",
"value_type": "fixed_amount"
},
"order_id": null,
"shipping_line": {
"title": "UPS Ground",
"custom": false,
"handle": "ups-3-12.25",
"price": "12.25"
},
"tax_lines": [],
"tags": "Wholesale",
"note_attributes": [],
"total_price": "206.25",
"subtotal_price": "194.00",
"total_tax": "0.00",
"payment_terms": null,
"admin_graphql_api_id": "gid://shopify/DraftOrder/994118539",
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"accepts_marketing": false,
"created_at": "2023-05-09T10:02:22-04:00",
"updated_at": "2023-05-09T10:02:22-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",
"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-05-09T10:02:22-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
}
}
}
},
"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"
}
}
}
Create Fulfillment Service
Create a fulfillment service. | key: createFulfillmentService
| Input | Default | Notes | Example |
|---|---|---|---|
Callback URL string callbackUrl | The callback URL that the fulfillment service has registered for request. | https://google.com | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Fulfillment Service Name string fulfillmentServiceName | The name of the fulfillment service. | MyFulfillmentService | |
Inventory Management boolean inventoryManagement | Whether the fulfillment services tracks product inventory and provides updates to Shopify. | ||
Permits SKU Sharing boolean permitsSkuSharing | Whether the fulfillment service can stock inventory alongside other locations. | ||
Requires Shipping Method boolean requiresShippingMethod | Whether the fulfillment service requires a shipping method to be specified. | ||
Connection connection / Required shopifyConnection | |||
Tracking Support boolean trackingSupport | Whether the fulfillment service supports tracking numbers for packages. |
Example Payload for Create Fulfillment Service
Example Payload for Create Fulfillment Service
{
"data": {
"fulfillment_service": {
"id": 1061774510,
"name": "Jupiter Fulfillment",
"email": null,
"service_name": "Jupiter Fulfillment",
"handle": "jupiter-fulfillment",
"fulfillment_orders_opt_in": true,
"include_pending_stock": false,
"provider_id": null,
"location_id": 1072404565,
"callback_url": "http://google.com/",
"tracking_support": true,
"inventory_management": true,
"admin_graphql_api_id": "gid://shopify/ApiFulfillmentService/1061774510",
"permits_sku_sharing": true
}
}
}
Create Metafield
Create a new metafield in your platform | key: createMetafield
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Description string description | Provide a description of the metafield value. | string | |
Key string / Required key | Provide a key for the metafield. | sponsor | |
Namespace string / Required namespace | Provide a namespace of the metafield. | my_fields | |
Connection connection / Required shopifyConnection | |||
Metafield Type string / Required type | Provide a type for the metafield. A list of all supported types can be found here: https://shopify.dev/apps/metafields/types | single_line_text_field | |
Value string / Required value | Provide a value for the metafield. | MyExample Sponsor |
Example Payload for Create Metafield
Example Payload for Create Metafield
{
"data": {
"data": {
"metafield": {
"id": 1069228982,
"namespace": "my_fields",
"key": "my_items",
"value": "{\"items\":[\"some item\"]}",
"description": null,
"owner_id": 548380009,
"created_at": "2024-01-02T09:09:54-05:00",
"updated_at": "2024-01-02T09:09:54-05:00",
"owner_resource": "shop",
"type": "json",
"admin_graphql_api_id": "gid://shopify/Metafield/1069228982"
}
},
"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"
}
}
}
Create Order
Create a new order | key: createOrder
| 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 |
Example Payload for Create Order
Example Payload for Create Order
{
"data": {
"order": {
"id": 1073459963,
"admin_graphql_api_id": "gid://shopify/Order/1073459963",
"app_id": 755357713,
"browser_ip": null,
"buyer_accepts_marketing": false,
"cancel_reason": null,
"cancelled_at": null,
"cart_token": null,
"checkout_id": null,
"checkout_token": null,
"client_details": null,
"closed_at": null,
"confirmation_number": "Z5NDCZ8N0",
"confirmed": true,
"contact_email": null,
"created_at": "2024-01-09T13:56:01-05:00",
"currency": "EUR",
"current_subtotal_price": "224.97",
"current_subtotal_price_set": {
"shop_money": {
"amount": "224.97",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "224.97",
"currency_code": "EUR"
}
},
"current_total_additional_fees_set": null,
"current_total_discounts": "0.00",
"current_total_discounts_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "EUR"
}
},
"current_total_duties_set": null,
"current_total_price": "238.47",
"current_total_price_set": {
"shop_money": {
"amount": "238.47",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "238.47",
"currency_code": "EUR"
}
},
"current_total_tax": "13.50",
"current_total_tax_set": {
"shop_money": {
"amount": "13.50",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "13.50",
"currency_code": "EUR"
}
},
"customer_locale": null,
"device_id": null,
"discount_codes": [],
"email": "",
"estimated_taxes": false,
"financial_status": "paid",
"fulfillment_status": null,
"landing_site": null,
"landing_site_ref": null,
"location_id": null,
"merchant_of_record_app_id": null,
"name": "#1002",
"note": null,
"note_attributes": [],
"number": 2,
"order_number": 1002,
"order_status_url": "https://jsmith.myshopify.com/548380009/orders/8800b154fc486b0c822b5002c3ed32cf/authenticate?key=4623f134ade1820ef93af9c280e6b4eb",
"original_total_additional_fees_set": null,
"original_total_duties_set": null,
"payment_gateway_names": [
""
],
"phone": null,
"po_number": null,
"presentment_currency": "EUR",
"processed_at": "2024-01-09T13:56:01-05:00",
"reference": null,
"referring_site": null,
"source_identifier": null,
"source_name": "755357713",
"source_url": null,
"subtotal_price": "224.97",
"subtotal_price_set": {
"shop_money": {
"amount": "224.97",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "224.97",
"currency_code": "EUR"
}
},
"tags": "",
"tax_exempt": false,
"tax_lines": [
{
"price": "13.50",
"rate": 0.06,
"title": "State tax",
"price_set": {
"shop_money": {
"amount": "13.50",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "13.50",
"currency_code": "EUR"
}
},
"channel_liable": false
}
],
"taxes_included": false,
"test": false,
"token": "8800b154fc486b0c822b5002c3ed32cf",
"total_discounts": "0.00",
"total_discounts_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "EUR"
}
},
"total_line_items_price": "224.97",
"total_line_items_price_set": {
"shop_money": {
"amount": "224.97",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "224.97",
"currency_code": "EUR"
}
},
"total_outstanding": "0.00",
"total_price": "238.47",
"total_price_set": {
"shop_money": {
"amount": "238.47",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "238.47",
"currency_code": "EUR"
}
},
"total_shipping_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "EUR"
}
},
"total_tax": "13.50",
"total_tax_set": {
"shop_money": {
"amount": "13.50",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "13.50",
"currency_code": "EUR"
}
},
"total_tip_received": "0.00",
"total_weight": 0,
"updated_at": "2024-01-09T13:56:01-05:00",
"user_id": null,
"billing_address": null,
"customer": null,
"discount_applications": [],
"fulfillments": [],
"line_items": [
{
"id": 1071823173,
"admin_graphql_api_id": "gid://shopify/LineItem/1071823173",
"current_quantity": 3,
"fulfillable_quantity": 3,
"fulfillment_service": "manual",
"fulfillment_status": null,
"gift_card": false,
"grams": 1300,
"name": "Big Brown Bear Boots",
"price": "74.99",
"price_set": {
"shop_money": {
"amount": "74.99",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "74.99",
"currency_code": "EUR"
}
},
"product_exists": false,
"product_id": null,
"properties": [],
"quantity": 3,
"requires_shipping": true,
"sku": null,
"taxable": true,
"title": "Big Brown Bear Boots",
"total_discount": "0.00",
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "EUR"
}
},
"variant_id": null,
"variant_inventory_management": null,
"variant_title": null,
"vendor": null,
"tax_lines": [
{
"channel_liable": false,
"price": "13.50",
"price_set": {
"shop_money": {
"amount": "13.50",
"currency_code": "EUR"
},
"presentment_money": {
"amount": "13.50",
"currency_code": "EUR"
}
},
"rate": 0.06,
"title": "State tax"
}
],
"duties": [],
"discount_allocations": []
}
],
"payment_terms": null,
"refunds": [],
"shipping_address": null,
"shipping_lines": []
}
}
}
Create Product
Create a new product | key: createProduct
| Input | Default | Notes | Example |
|---|---|---|---|
Body HTML string body | Shopify gives you the option to specify a body formatted in html to be displayed along the rest of the product information. | <strong>Try our classic fit!</strong> | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
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. | ||
Image URL string imageUrl | Provide a valid url containing the image for the product. | www.myimages.com/product1 | |
Product Type string / Required 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 / Required title | Provide a value for the title of the product | Classic T-shirt | |
Vendor string / Required vendor | Provide a value for the vendor of the product. | Burton inc. |
Example Payload for Create Product
Example Payload for Create Product
{
"data": {
"product": {
"id": 1072481093,
"title": "Burton Custom Freestyle 151",
"body_html": "<strong>Good snowboard!</strong>",
"vendor": "Burton",
"product_type": "Snowboard",
"created_at": "2024-03-21T10:52:29-04:00",
"handle": "burton-custom-freestyle-151",
"updated_at": "2024-03-21T10:52:29-04:00",
"published_at": null,
"template_suffix": null,
"published_scope": "web",
"tags": "",
"status": "draft",
"admin_graphql_api_id": "gid://shopify/Product/1072481093",
"variants": [
{
"id": 1070325095,
"product_id": 1072481093,
"title": "Default Title",
"price": "0.00",
"sku": "",
"position": 1,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": null,
"option1": "Default Title",
"option2": null,
"option3": null,
"created_at": "2024-03-21T10:52:29-04:00",
"updated_at": "2024-03-21T10:52:29-04:00",
"taxable": true,
"barcode": null,
"grams": 0,
"weight": 0,
"weight_unit": "lb",
"inventory_item_id": 1070325095,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"presentment_prices": [
{
"price": {
"amount": "0.00",
"currency_code": "USD"
},
"compare_at_price": null
}
],
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325095",
"image_id": null
}
],
"options": [
{
"id": 1064576574,
"product_id": 1072481093,
"name": "Title",
"position": 1,
"values": [
"Default Title"
]
}
],
"images": [],
"image": null
}
}
}
Create Product Image
Create a new image on an existing product | key: createProductImage
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Name string / Required fileName | Provide a name for the file | logo.gif | |
Image Alt string imageAlt | Provide a string of text to be displayed as an alternative if an image cannot be loaded. | This is example alt text. | |
Image Position string imagePosition | Provide a number for the position of the image. For example, providing 1 will set the default image for the product. | 1 | |
Image URL string / Required imageURL | Provide a URL for the image | http://example.com/rails_logo.gif | |
Product ID string / Required productId | Provide a value for the product Id. | 74020090 | |
Connection connection / Required shopifyConnection |
Example Payload for Create Product Image
Example Payload for Create Product Image
{
"data": {
"data": {
"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"
}
},
"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"
}
}
}
Create Variant
Create a new variant of the provided product | key: createVariant
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
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. | ||
Price string / Required price | Provide the price of the variant. | 1.00 | |
Product ID string / Required productId | Provide a value for the product Id. | 74020090 | |
Connection connection / Required shopifyConnection | |||
SKU string sku | Provide the sku(A stock-keeping unit) for the variant | 97802837847 | |
Variant Title string / Required variantTitle | Provide the variant title in relation to the base product. | Yellow | |
Weight string weight | Provide the weight of the variant (lbs) | 24.00 |
Example Payload for Create Variant
Example Payload for Create Variant
{
"data": {
"variant": {
"id": 1070325039,
"product_id": 632910392,
"title": "Yellow",
"price": "1.00",
"sku": "",
"position": 5,
"inventory_policy": "deny",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Yellow",
"option2": null,
"option3": null,
"created_at": "2024-01-02T09:12:05-05:00",
"updated_at": "2024-01-02T09:12:05-05:00",
"taxable": true,
"barcode": null,
"grams": 0,
"image_id": null,
"weight": 0,
"weight_unit": "lb",
"inventory_item_id": 1070325039,
"inventory_quantity": 0,
"old_inventory_quantity": 0,
"presentment_prices": [
{
"price": {
"amount": "1.00",
"currency_code": "USD"
},
"compare_at_price": null
}
],
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/1070325039"
}
}
}
Create Webhook
Creates a webhook for the desired topic in your Shopify store | key: createWebhook
| Input | Default | Notes | Example |
|---|---|---|---|
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 |
Example Payload for Create Webhook
Example Payload for Create Webhook
{
"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 Collect
Delete the information and metadata of a collect | key: deleteCollect
| Input | Default | Notes | Example |
|---|---|---|---|
Collect Id string / Required collectId | Provide a unique ID of a collect | r84963704502935 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection |
Example Payload for Delete Collect
Example Payload for Delete Collect
{
"data": {
"data": {},
"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"
}
}
}
Delete Customer
Delete an existing customer | key: deleteCustomer
| 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 |
Example Payload for Delete Customer
Example Payload for Delete Customer
{
"data": {}
}
Delete Draft Order
Delete the information and metadata of a Draft Order | key: deleteDraftOrder
| 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 the unique ID of the order. | 450789469 | |
Connection connection / Required shopifyConnection |
Example Payload for Delete Draft Order
Example Payload for Delete Draft Order
{
"data": {
"data": {},
"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"
}
}
}
Delete Fulfillment Service
Deletes an existing fulfillment service. | key: deleteFulfillmentService
| 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. | 39072856 | |
Connection connection / Required shopifyConnection |
Example Payload for Delete Fulfillment Service
Example Payload for Delete Fulfillment Service
{
"data": {}
}
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: deleteInventoryLevels
| 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 a Inventory Level | r84963704502935 | |
Connection connection / Required shopifyConnection |
Example Payload for Delete Inventory Levels
Example Payload for Delete Inventory Levels
{
"data": {
"data": {},
"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"
}
}
}
Delete Metafield
Delete the information and metadata of a metafield enabled on your platform | key: deleteMetafield
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
MetaField ID string / Required metaFieldId | Provide a unique ID of a metaField. | 534526895 | |
Connection connection / Required shopifyConnection |
Example Payload for Delete Metafield
Example Payload for Delete Metafield
{
"data": {
"data": {},
"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"
}
}
}
Delete Order
Delete an existing order by Id | key: deleteOrder
| 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 |
Example Payload for Delete Order
Example Payload for Delete Order
{
"data": {}
}
Delete Product
Delete an existing product | key: deleteProduct
| 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 |
Example Payload for Delete Product
Example Payload for Delete Product
{
"data": {}
}
Delete Product Image
Delete the information and metadata of a product image connected to your platform | key: deleteProductImage
| 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 | r84963704502935 | |
Product ID string / Required productId | Provide a value for the product Id. | 74020090 | |
Connection connection / Required shopifyConnection |
Example Payload for Delete Product Image
Example Payload for Delete Product Image
{
"data": {
"data": {},
"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"
}
}
}
Delete Variant
Delete an existing variant by Id | key: deleteVariant
| 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 | |||
Product Variant ID string / Required variantId | Provide the unique ID of the product variant. | 39072856 |
Example Payload for Delete Variant
Example Payload for Delete Variant
{
"data": {}
}
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 |
Example Payload for Delete Webhook
Example Payload for Delete Webhook
{
"data": {}
}
Get Collect
Get the information and metadata of a collect | key: getCollect
| Input | Default | Notes | Example |
|---|---|---|---|
Collect Id string / Required collectId | Provide a unique ID of a collect | r84963704502935 | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection |
Example Payload for Get Collect
Example Payload for Get Collect
{
"data": {
"data": {
"collect": {
"id": 455204334,
"collection_id": 841564295,
"product_id": 632910392,
"created_at": null,
"updated_at": null,
"position": 1,
"sort_value": "0000000001"
}
},
"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"
}
}
}
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 |
Example Payload for Get Customer
Example Payload for Get 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
}
}
}
}
Get Draft Order
Get the information and metadata of a Draft Order | key: getDraftOrder
| 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 the unique ID of the order. | 450789469 | |
Connection connection / Required shopifyConnection |
Example Payload for Get Draft Order
Example Payload for Get Draft Order
{
"data": {
"data": {
"draft_order": {
"id": 994118539,
"note": "rush order",
"email": "bob.norman@mail.example.com",
"taxes_included": false,
"currency": "USD",
"invoice_sent_at": null,
"created_at": "2023-05-09T10:02:22-04:00",
"updated_at": "2023-05-09T10:02:22-04:00",
"tax_exempt": false,
"completed_at": null,
"name": "#D2",
"status": "open",
"line_items": [
{
"id": 994118539,
"variant_id": 39072856,
"product_id": 632910392,
"title": "IPod Nano - 8gb",
"variant_title": "green",
"sku": "IPOD2008GREEN",
"vendor": null,
"quantity": 1,
"requires_shipping": false,
"taxable": true,
"gift_card": false,
"fulfillment_service": "manual",
"grams": 567,
"tax_lines": [],
"applied_discount": null,
"name": "IPod Nano - 8gb - green",
"properties": [],
"custom": false,
"price": "199.00",
"admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/994118539"
}
],
"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"
},
"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"
},
"invoice_url": "https://jsmith.myshopify.com/548380009/invoices/ba8dcf6c022ccad3d47e3909e378e33f",
"applied_discount": {
"description": "$5promo",
"value": "5.0",
"title": null,
"amount": "5.00",
"value_type": "fixed_amount"
},
"order_id": null,
"shipping_line": {
"title": "UPS Ground",
"custom": false,
"handle": "ups-3-12.25",
"price": "12.25"
},
"tax_lines": [],
"tags": "Wholesale",
"note_attributes": [],
"total_price": "206.25",
"subtotal_price": "194.00",
"total_tax": "0.00",
"payment_terms": null,
"admin_graphql_api_id": "gid://shopify/DraftOrder/994118539",
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"accepts_marketing": false,
"created_at": "2023-05-09T10:02:22-04:00",
"updated_at": "2023-05-09T10:02:22-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",
"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-05-09T10:02:22-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
}
}
}
},
"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"
}
}
}
Get Fulfillment
Get the information and metadata of a fulfillment enabled on your platform | key: getFulfillment
| 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 | r84963704502935 | |
Connection connection / Required shopifyConnection |
Example Payload for Get Fulfillment
Example Payload for Get Fulfillment
{
"data": {
"data": {
"fulfillment": {
"id": 255858046,
"order_id": 450789469,
"status": "failure",
"created_at": "2024-01-02T08:59:11-05:00",
"service": "manual",
"updated_at": "2024-01-02T08:59:11-05:00",
"tracking_company": "USPS",
"shipment_status": null,
"location_id": 655441491,
"origin_address": null,
"line_items": [
{
"id": 466157049,
"variant_id": 39072856,
"title": "IPod Nano - 8gb",
"quantity": 1,
"sku": "IPOD2008GREEN",
"variant_title": "green",
"vendor": null,
"fulfillment_service": "manual",
"product_id": 632910392,
"requires_shipping": true,
"taxable": true,
"gift_card": false,
"name": "IPod Nano - 8gb - green",
"variant_inventory_management": "shopify",
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"product_exists": true,
"fulfillable_quantity": 0,
"grams": 200,
"price": "199.00",
"total_discount": "0.00",
"fulfillment_status": null,
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"discount_allocations": [
{
"amount": "3.34",
"discount_application_index": 0,
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
}
}
],
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"duties": [],
"tax_lines": [
{
"price": "3.98",
"rate": 0.06,
"title": "State Tax",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"channel_liable": null
}
],
"fulfillment_line_item_id": 225088298
}
],
"tracking_number": "1Z2345",
"tracking_numbers": [
"1Z2345"
],
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345",
"tracking_urls": [
"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
],
"receipt": {
"testcase": true,
"authorization": "123456"
},
"name": "#1001.0",
"admin_graphql_api_id": "gid://shopify/Fulfillment/255858046"
}
},
"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"
}
}
}
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 |
Example Payload for Get Fulfillment Order
Example Payload for Get Fulfillment Order
{
"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": []
}
},
"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"
}
}
}
Get Fulfillment Service
Retrieve a fulfillment service enabled on your platform by its ID | key: getFulfillmentService
| 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. | 39072856 | |
Connection connection / Required shopifyConnection |
Example Payload for Get Fulfillment Service
Example Payload for Get Fulfillment Service
{
"data": {
"fulfillment_service": {
"id": 755357713,
"name": "Mars Fulfillment",
"email": null,
"service_name": "Mars Fulfillment",
"handle": "mars-fulfillment",
"fulfillment_orders_opt_in": true,
"include_pending_stock": false,
"provider_id": null,
"location_id": 24826418,
"callback_url": "http://google.com/",
"tracking_support": true,
"inventory_management": true,
"admin_graphql_api_id": "gid://shopify/ApiFulfillmentService/755357713"
}
}
}
Get Inventory Item
Get the information and metadata of an Inventory Item enabled on your platform | key: getInventoryItems
| 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 | r84963704502935 | |
Connection connection / Required shopifyConnection |
Example Payload for Get Inventory Item
Example Payload for Get Inventory Item
{
"data": {
"data": {
"inventory_item": {
"id": 808950810,
"sku": "IPOD2008PINK",
"created_at": "2024-01-02T09:28:43-05:00",
"updated_at": "2024-01-02T09:28:43-05:00",
"requires_shipping": true,
"cost": "25.00",
"country_code_of_origin": null,
"province_code_of_origin": null,
"harmonized_system_code": null,
"tracked": true,
"country_harmonized_system_codes": [],
"admin_graphql_api_id": "gid://shopify/InventoryItem/808950810"
}
},
"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"
}
}
}
Get Inventory Levels
Get the information and metadata of an Inventory Level | key: getInventoryLevels
| 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 a Inventory Level | r84963704502935 | |
Connection connection / Required shopifyConnection |
Example Payload for Get Inventory Levels
Example Payload for Get Inventory Levels
{
"data": {
"data": {
"inventory_level": {
"inventory_item_id": 457924702,
"location_id": 844681632,
"available": 0,
"updated_at": "2023-07-11T18:02:41-04:00",
"admin_graphql_api_id": "gid://shopify/InventoryLevel/844681632?inventory_item_id=457924702"
}
},
"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"
}
}
}
Get Location
Get the information and metadata of a location enabled on your platform | key: getLocations
| 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. | 844681632 | |
Connection connection / Required shopifyConnection |
Example Payload for Get Location
Example Payload for Get Location
{
"data": {
"data": {
"location": {
"id": 487838322,
"name": "Fifth Avenue AppleStore",
"address1": null,
"address2": null,
"city": null,
"zip": null,
"province": null,
"country": "US",
"phone": null,
"created_at": "2023-07-11T18:32:46-04:00",
"updated_at": "2023-07-11T18:32:46-04:00",
"country_code": "US",
"country_name": "United States",
"province_code": null,
"legacy": false,
"active": true,
"admin_graphql_api_id": "gid://shopify/Location/487838322"
}
},
"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"
}
}
}
Get Metafields
Get the information and metadata of a metafield enabled on your platform | key: getMetafield
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
MetaField ID string / Required metaFieldId | Provide a unique ID of a metaField. | 534526895 | |
Connection connection / Required shopifyConnection |
Example Payload for Get Metafields
Example Payload for Get Metafields
{
"data": {
"data": {
"metafield": {
"id": 721389482,
"namespace": "affiliates",
"key": "app_key",
"value": "app_key",
"description": null,
"owner_id": 548380009,
"created_at": "2024-01-02T08:59:11-05:00",
"updated_at": "2024-01-02T08:59:11-05:00",
"owner_resource": "shop",
"type": "string",
"admin_graphql_api_id": "gid://shopify/Metafield/721389482"
}
},
"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"
}
}
}
Get Order
Get the information and metadata about an 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 |
Example Payload for Get Order
Example Payload for Get Order
{
"data": {
"order": {
"id": 450789469,
"name": "#1001",
"total_price": "598.94",
"line_items": [
{
"id": 466157049,
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"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",
"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",
"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
}
]
}
]
}
}
}
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 |
Example Payload for Get Product
Example Payload for Get Product
{
"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: getProductImage
| 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 | r84963704502935 | |
Product ID string / Required productId | Provide a value for the product Id. | 74020090 | |
Connection connection / Required shopifyConnection |
Example Payload for Get Product Image
Example Payload for Get Product Image
{
"data": {
"data": {
"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"
}
},
"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"
}
}
}
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 |
Example Payload for Get Shop Configuration
Example Payload for Get Shop Configuration
{
"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
}
},
"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"
}
}
}
Get Variant
Get the information or metadata of a variant by Id | key: getVariant
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Connection connection / Required shopifyConnection | |||
Product Variant ID string / Required variantId | Provide the unique ID of the product variant. | 39072856 |
Example Payload for Get Variant
Example Payload for Get Variant
{
"data": {
"variant": {
"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": "2024-01-02T08:59:11-05:00",
"updated_at": "2024-01-02T08:59:11-05: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
}
],
"tax_code": "DA040000",
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/808950810"
}
}
}
GraphQL Raw Request
Send raw GraphQL request to Shopify | key: graphQlRawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string / Required apiVersion | 2023-04 | 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. |
List Collects
List all collects enabled on your platform | key: listCollects
| 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 | 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 Info 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 | |
Product ID string productId | Provide a productId to filter results. | 74020090 | |
Connection connection / Required shopifyConnection |
Example Payload for List Collects
Example Payload for List Collects
{
"data": {
"data": {
"collects": [
{
"id": 358268117,
"collection_id": 482865238,
"product_id": 632910392,
"created_at": null,
"updated_at": null,
"position": 1,
"sort_value": "0000000001"
}
]
},
"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 Currencies
List all currencies enabled on your platform | key: listCurrencies
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Connection connection / Required shopifyConnection |
Example Payload for List Currencies
Example Payload for List Currencies
{
"data": {
"data": {
"currencies": [
{
"currency": "CAD",
"rate_updated_at": "2018-01-23T19:01:01-05:00",
"enabled": true
},
{
"currency": "EUR",
"rate_updated_at": "2018-01-23T19:01:01-05:00",
"enabled": true
},
{
"currency": "JPY",
"rate_updated_at": "2018-01-23T19:01:01-05:00",
"enabled": true
}
]
}
}
}
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 | 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 Info 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 |
Example Payload for List Customers
Example Payload for List Customers
{
"data": {
"data": {
"customers": [
{
"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
}
}
}
]
},
"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 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 | 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 Info 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 |
Example Payload for List Draft Orders
Example Payload for List Draft Orders
{
"data": {
"data": {
"draft_orders": [
{
"id": 994118539,
"note": "rush order",
"email": "bob.norman@mail.example.com",
"taxes_included": false,
"currency": "USD",
"invoice_sent_at": null,
"created_at": "2023-05-09T10:02:22-04:00",
"updated_at": "2023-05-09T10:02:22-04:00",
"tax_exempt": false,
"completed_at": null,
"name": "#D2",
"status": "open",
"line_items": [
{
"id": 994118539,
"variant_id": 39072856,
"product_id": 632910392,
"title": "IPod Nano - 8gb",
"variant_title": "green",
"sku": "IPOD2008GREEN",
"vendor": null,
"quantity": 1,
"requires_shipping": false,
"taxable": true,
"gift_card": false,
"fulfillment_service": "manual",
"grams": 567,
"tax_lines": [],
"applied_discount": null,
"name": "IPod Nano - 8gb - green",
"properties": [],
"custom": false,
"price": "199.00",
"admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/994118539"
}
],
"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"
},
"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"
},
"invoice_url": "https://jsmith.myshopify.com/548380009/invoices/ba8dcf6c022ccad3d47e3909e378e33f",
"applied_discount": {
"description": "$5promo",
"value": "5.0",
"title": null,
"amount": "5.00",
"value_type": "fixed_amount"
},
"order_id": null,
"shipping_line": {
"title": "UPS Ground",
"custom": false,
"handle": "ups-3-12.25",
"price": "12.25"
},
"tax_lines": [],
"tags": "Wholesale",
"note_attributes": [],
"total_price": "206.25",
"subtotal_price": "194.00",
"total_tax": "0.00",
"payment_terms": null,
"admin_graphql_api_id": "gid://shopify/DraftOrder/994118539",
"customer": {
"id": 207119551,
"email": "bob.norman@mail.example.com",
"accepts_marketing": false,
"created_at": "2023-05-09T10:02:22-04:00",
"updated_at": "2023-05-09T10:02:22-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",
"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-05-09T10:02:22-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
}
}
}
]
},
"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 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 |
Example Payload for List Fulfillment Orders
Example Payload for List Fulfillment Orders
{
"data": {
"data": {
"fulfillment_orders": [
{
"id": 1046000823,
"shop_id": 548380009,
"order_id": 450789469,
"assigned_location_id": 24826418,
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1046000807,
"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": 1058737564,
"shop_id": 548380009,
"fulfillment_order_id": 1046000823,
"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:25-05:00",
"updated_at": "2024-01-02T09:11:25-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": []
}
]
},
"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"
}
}
}
List Fulfillment Services
List all fulfillment services enabled on your platform | key: listFulfillmentServices
| Input | Default | Notes |
|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. |
Scope string / Required scope | all | Specify which fulfillment services to retrieve. |
Connection connection / Required shopifyConnection |
Example Payload for List Fulfillment Services
Example Payload for List Fulfillment Services
{
"data": {
"fulfillment_services": [
{
"id": 611870435,
"name": "Venus Fulfillment",
"email": null,
"service_name": "Venus Fulfillment",
"handle": "venus-fulfillment",
"fulfillment_orders_opt_in": false,
"include_pending_stock": false,
"provider_id": null,
"location_id": 611870435,
"callback_url": null,
"tracking_support": true,
"inventory_management": true,
"admin_graphql_api_id": "gid://shopify/ApiFulfillmentService/611870435"
}
]
}
}
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 | 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 Info 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 |
Example Payload for List Fulfillments
Example Payload for List Fulfillments
{
"data": {
"data": {
"fulfillments": [
{
"id": 255858046,
"order_id": 450789469,
"status": "failure",
"created_at": "2024-01-02T08:59:11-05:00",
"service": "manual",
"updated_at": "2024-01-02T08:59:11-05:00",
"tracking_company": "USPS",
"shipment_status": null,
"location_id": 655441491,
"origin_address": null,
"line_items": [
{
"id": 466157049,
"variant_id": 39072856,
"title": "IPod Nano - 8gb",
"quantity": 1,
"sku": "IPOD2008GREEN",
"variant_title": "green",
"vendor": null,
"fulfillment_service": "manual",
"product_id": 632910392,
"requires_shipping": true,
"taxable": true,
"gift_card": false,
"name": "IPod Nano - 8gb - green",
"variant_inventory_management": "shopify",
"properties": [
{
"name": "Custom Engraving Front",
"value": "Happy Birthday"
},
{
"name": "Custom Engraving Back",
"value": "Merry Christmas"
}
],
"product_exists": true,
"fulfillable_quantity": 0,
"grams": 200,
"price": "199.00",
"total_discount": "0.00",
"fulfillment_status": null,
"price_set": {
"shop_money": {
"amount": "199.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "199.00",
"currency_code": "USD"
}
},
"total_discount_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"discount_allocations": [
{
"amount": "3.34",
"discount_application_index": 0,
"amount_set": {
"shop_money": {
"amount": "3.34",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.34",
"currency_code": "USD"
}
}
}
],
"admin_graphql_api_id": "gid://shopify/LineItem/466157049",
"duties": [],
"tax_lines": [
{
"price": "3.98",
"rate": 0.06,
"title": "State Tax",
"price_set": {
"shop_money": {
"amount": "3.98",
"currency_code": "USD"
},
"presentment_money": {
"amount": "3.98",
"currency_code": "USD"
}
},
"channel_liable": null
}
],
"fulfillment_line_item_id": 225088298
}
],
"tracking_number": "1Z2345",
"tracking_numbers": [
"1Z2345"
],
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345",
"tracking_urls": [
"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
],
"receipt": {
"testcase": true,
"authorization": "123456"
},
"name": "#1001.0",
"admin_graphql_api_id": "gid://shopify/Fulfillment/255858046"
}
]
},
"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 Inventory Items
List all Inventory Items enabled on your platform | key: listInventoryItems
| 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. | |
Ids string / Required Value List ids | For each item, provide an id of the inventory item to be returned in the response. | 39072856 | |
Limit string limit | 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 Info 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 |
Example Payload for List Inventory Items
Example Payload for List Inventory Items
{
"data": {
"data": {
"inventory_items": [
{
"id": 39072856,
"created_at": "2024-01-02T09:28:43-05:00",
"updated_at": "2024-01-02T09:28:43-05:00",
"requires_shipping": true,
"cost": "25.00",
"country_code_of_origin": null,
"province_code_of_origin": null,
"harmonized_system_code": null,
"tracked": true,
"country_harmonized_system_codes": [],
"admin_graphql_api_id": "gid://shopify/InventoryItem/39072856"
}
]
},
"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 Inventory Levels
Retrieves a list of inventory levels | key: listInventoryLevelsNoLocation
| 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. | |
Inventory Item IDs string inventoryItemIds | Comma-separated list of inventory item IDs. You must include this input, 'Location IDs', or both. | 49148385,49148386 | |
Limit string limit | 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 | |
Location IDs string locationIds | Comma-separated list of location IDs. You must include this input, Inventory Item IDs, or both. | 655441491,655441492 | |
Connection connection / Required shopifyConnection | |||
Updated At Min string updatedAtMin | Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00). | 2021-10-01 |
Example Payload for List Inventory Levels
Example Payload for List Inventory Levels
{
"data": {
"data": {
"inventory_levels": [
{
"inventory_item_id": 457924702,
"location_id": 844681632,
"available": 0,
"updated_at": "2023-07-11T18:02:41-04:00",
"admin_graphql_api_id": "gid://shopify/InventoryLevel/844681632?inventory_item_id=457924702"
}
]
},
"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 Inventory Levels At Location
List all Inventory Levels | key: listInventoryLevels
| 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 | 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 | |
Location ID string / Required locationId | The ID of the location that the inventory level belongs to. | 844681632 | |
Page Info 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 |
Example Payload for List Inventory Levels At Location
Example Payload for List Inventory Levels At Location
{
"data": {
"data": {
"inventory_levels": [
{
"inventory_item_id": 457924702,
"location_id": 844681632,
"available": 0,
"updated_at": "2023-07-11T18:02:41-04:00",
"admin_graphql_api_id": "gid://shopify/InventoryLevel/844681632?inventory_item_id=457924702"
}
]
},
"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 Locations
List all locations enabled on your platform | key: listLocations
| 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 | 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 Info 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 |
Example Payload for List Locations
Example Payload for List Locations
{
"data": {
"data": {
"locations": [
{
"id": 487838322,
"name": "Fifth Avenue AppleStore",
"address1": null,
"address2": null,
"city": null,
"zip": null,
"province": null,
"country": "US",
"phone": null,
"created_at": "2023-07-11T18:32:46-04:00",
"updated_at": "2023-07-11T18:32:46-04:00",
"country_code": "US",
"country_name": "United States",
"province_code": null,
"legacy": false,
"active": true,
"admin_graphql_api_id": "gid://shopify/Location/487838322"
}
]
},
"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 Metafields
List all metafields enabled on your platform | key: listMetafields
| 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 | 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 Info 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 |
Example Payload for List Metafields
Example Payload for List Metafields
{
"data": {
"data": {
"metafields": [
{
"id": "example",
"namespace": "example",
"key": "example",
"value": "example",
"description": "This is an example description.",
"owner_id": "example",
"created_at": "2022-03-31T21:33:14-07:00",
"updated_at": "2022-03-31T21:33:14-07:00",
"owner_resource": "shop",
"type": "ingle_line_text_field"
}
]
},
"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 Orders
List all 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 | 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 Info 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 |
Example Payload for List Orders
Example Payload for List Orders
{
"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 |
Example Payload for List Product Images
Example Payload for List Product Images
{
"data": {
"data": {
"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"
}
]
},
"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"
}
}
}
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 | 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 Info 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 |
Example Payload for List Products
Example Payload for List Products
{
"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: listVariants
| 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 | 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 Info 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 | |
Product ID string / Required productId | Provide a value for the product Id. | 74020090 | |
Connection connection / Required shopifyConnection |
Example Payload for List Variants
Example Payload for List Variants
{
"data": {
"data": {
"variants": [
{
"id": 39072856,
"product_id": 632910392,
"title": "Green",
"price": "199.00",
"sku": "IPOD2008GREEN",
"position": 3,
"inventory_policy": "continue",
"compare_at_price": null,
"fulfillment_service": "manual",
"inventory_management": "shopify",
"option1": "Green",
"option2": null,
"option3": null,
"created_at": "2024-01-02T08:59:11-05:00",
"updated_at": "2024-01-02T08:59:11-05:00",
"taxable": true,
"barcode": "1234_green",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_item_id": 39072856,
"inventory_quantity": 30,
"old_inventory_quantity": 30,
"presentment_prices": [
{
"price": {
"amount": "199.00",
"currency_code": "USD"
},
"compare_at_price": null
}
],
"requires_shipping": true,
"admin_graphql_api_id": "gid://shopify/ProductVariant/39072856"
}
]
},
"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 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 |
Example Payload for List Webhooks
Example Payload for List Webhooks
{
"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 HTTP request to Shopify | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
API Version string / Required apiVersion | 2023-04 | 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. |
Update Customer
Update the information and metadata of an existing customer by Id | key: updateCustomer
| 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 | |
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. | |
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. | ||
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. | |
Email string updateEmail | Provide a string value for the email of the customer | someone@example.com | |
First Name string updateFirstName | Provide a string value for the first name | John | |
Last Name string updateLastName | Provide a string value for the last name of the customer | Doe | |
Verified Email boolean / Required verifiedEmail | false | This flag will enable emails to be sent to the customer. |
Example Payload for Update Customer
Example Payload for Update 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
}
}
}
}
Update Fulfillment Service
Modify an existing fulfillment service. | key: updateFulfillmentService
| Input | Default | Notes | Example |
|---|---|---|---|
Callback URL string callbackUrl | The callback URL that the fulfillment service has registered for request. | https://google.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. | 39072856 | |
Fulfillment Service Name string fulfillmentServiceName | The name of the fulfillment service. | MyFulfillmentService | |
Inventory Management boolean inventoryManagement | Whether the fulfillment services tracks product inventory and provides updates to Shopify. | ||
Permits SKU Sharing boolean permitsSkuSharing | Whether the fulfillment service can stock inventory alongside other locations. | ||
Requires Shipping Method boolean requiresShippingMethod | Whether the fulfillment service requires a shipping method to be specified. | ||
Connection connection / Required shopifyConnection | |||
Tracking Support boolean trackingSupport | Whether the fulfillment service supports tracking numbers for packages. |
Example Payload for Update Fulfillment Service
Example Payload for Update Fulfillment Service
{
"data": {
"fulfillment_service": {
"id": 755357713,
"name": "Mars Fulfillment",
"email": null,
"service_name": "Mars Fulfillment",
"handle": "mars-fulfillment",
"fulfillment_orders_opt_in": true,
"include_pending_stock": false,
"provider_id": null,
"location_id": 24826418,
"callback_url": "http://google.com/",
"tracking_support": true,
"inventory_management": true,
"admin_graphql_api_id": "gid://shopify/ApiFulfillmentService/755357713"
}
}
}
Update Inventory Item
Update the information and metadata of an Inventory Item enabled on your platform | key: updateInventoryItems
| 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 | r84963704502935 | |
Price string price | Provide a new price for the item. | 1.00 | |
Connection connection / Required shopifyConnection | |||
SKU string sku | Provide the sku(A stock-keeping unit) for the variant | 97802837847 | |
Is Tracked boolean tracked | false | This field determines if the item is tracked. |
Example Payload for Update Inventory Item
Example Payload for Update Inventory Item
{
"data": {
"data": {
"inventory_item": {
"id": 808950810,
"sku": "new sku",
"created_at": "2024-01-02T09:28:43-05:00",
"updated_at": "2024-01-02T09:31:51-05:00",
"requires_shipping": true,
"cost": "25.00",
"country_code_of_origin": null,
"province_code_of_origin": null,
"harmonized_system_code": null,
"tracked": true,
"country_harmonized_system_codes": [],
"admin_graphql_api_id": "gid://shopify/InventoryItem/808950810"
}
},
"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"
}
}
}
Update Metafield
Update an existing metafield in your platform | key: updateMetafield
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
Description string description | Provide a description of the metafield value. | string | |
MetaField ID string / Required metaFieldId | Provide a unique ID of a metaField. | 534526895 | |
Connection connection / Required shopifyConnection | |||
Metafield Type string type | Provide a type for the metafield. A list of all supported types can be found here: https://shopify.dev/apps/metafields/types | single_line_text_field | |
Value string value | Provide a value for the metafield. | MyExample Sponsor |
Example Payload for Update Metafield
Example Payload for Update Metafield
{
"data": {
"data": {
"metafield": {
"value": "[\"something new\"]",
"owner_id": 548380009,
"namespace": "affiliates",
"key": "app_key",
"id": 721389482,
"description": null,
"created_at": "2024-01-02T08:59:11-05:00",
"updated_at": "2024-01-02T09:08:44-05:00",
"owner_resource": "shop",
"type": "list.single_line_text_field",
"admin_graphql_api_id": "gid://shopify/Metafield/721389482"
}
},
"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"
}
}
}
Update Product
Update the information and metadata of an existing product by Id | key: updateProduct
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
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. | ||
Image URL string imageUrl | Provide a valid url containing the image for the product. | www.myimages.com/product1 | |
Product ID string / Required productId | Provide a value for the product Id. | 74020090 | |
Product Status string productStatus | Specify if the product is active or in draft. | ||
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 / Required title | Provide a value for the title of the product | Classic T-shirt |
Example Payload for Update Product
Example Payload for Update Product
{
"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": "2024-03-21T10:50:49-04:00",
"handle": "ipod-nano",
"updated_at": "2024-03-21T10:53:13-04:00",
"published_at": "2007-12-31T19:00:00-05:00",
"template_suffix": null,
"published_scope": "web",
"tags": "Emotive, Flash Memory, MP3, Music",
"status": "active",
"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": "2024-03-21T10:50:49-04:00",
"updated_at": "2024-03-21T10:50:49-04:00",
"taxable": true,
"barcode": "1234_pink",
"grams": 567,
"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",
"image_id": 562641783
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red",
"Green",
"Black"
]
}
],
"images": [
{
"id": 850703190,
"alt": null,
"position": 1,
"product_id": 632910392,
"created_at": "2024-03-21T10:50:49-04:00",
"updated_at": "2024-03-21T10:50:49-04:00",
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1711032649",
"variant_ids": []
}
],
"image": {
"id": 850703190,
"alt": null,
"position": 1,
"product_id": 632910392,
"created_at": "2024-03-21T10:50:49-04:00",
"updated_at": "2024-03-21T10:50:49-04:00",
"admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1711032649",
"variant_ids": []
}
}
}
}
Update Variant
Update the information and metadata of an existing product variant by Id | key: updateVariant
| Input | Default | Notes | Example |
|---|---|---|---|
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
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. | ||
Connection connection / Required shopifyConnection | |||
SKU string sku | Provide the sku(A stock-keeping unit) for the variant | 97802837847 | |
Price string updatePrice | Provide the price of the variant. | 1.00 | |
Variant Title string updateVariantTitle | Provide the variant title in relation to the base product. | Yellow | |
Product Variant ID string / Required variantId | Provide the unique ID of the product variant. | 39072856 | |
Weight string weight | Provide the weight of the variant (lbs) | 24.00 |
Example Payload for Update Variant
Example Payload for Update Variant
{
"data": {
"variant": {
"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": "2024-01-02T08:59:11-05:00",
"updated_at": "2024-01-02T08:59:11-05: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"
}
}
}