Operations (sample payloads)

Main operations
Copy

Cancel fulfillment
Copy

Cancels a fulfillment.

Sample Input

1{
2    "fulfillment_id": 1234567890
3}

Sample Output

1{
2    "fulfillment": {
3        "id": 1234567890,
4        "order_id": 9876543210,
5        "status": "cancelled",
6        "location_id": 987654,
7        "created_at": "2023-05-15T10:30:00Z",
8        "service": "manual",
9        "updated_at": "2023-05-15T14:45:00Z",
10        "tracking_company": "UPS",
11        "shipment_status": null,
12        "origin_address": "123 Warehouse St, Shopify City, SC 12345",
13        "line_items": [
14            {
15                "id": 111222333,
16                "variant_id": 444555666,
17                "title": "Classic T-Shirt",
18                "quantity": 2,
19                "sku": "CTS-001",
20                "variant_title": "Blue / Medium",
21                "vendor": "Fashion Co.",
22                "fulfillment_service": "manual",
23                "product_id": 777888999,
24                "requires_shipping": true,
25                "taxable": true,
26                "gift_card": false,
27                "name": "Classic T-Shirt - Blue / Medium",
28                "variant_inventory_management": "shopify",
29                "properties": [],
30                "product_exists": true,
31                "fulfillable_quantity": 2,
32                "grams": 200,
33                "price": "29.99",
34                "total_discount": "0.00",
35                "fulfillment_status": "cancelled",
36                "price_set": {
37                    "shop_money": {
38                        "amount": "29.99",
39                        "currency_code": "USD"
40                    },
41                    "presentment_money": {
42                        "amount": "29.99",
43                        "currency_code": "USD"
44                    }
45                },
46                "total_discount_set": {
47                    "shop_money": {
48                        "amount": "0.00",
49                        "currency_code": "USD"
50                    },
51                    "presentment_money": {
52                        "amount": "0.00",
53                        "currency_code": "USD"
54                    }
55                },
56                "discount_allocations": [],
57                "duties": [],
58                "admin_graphql_api_id": "gid://shopify/LineItem/111222333",
59                "tax_lines": [
60                    {
61                        "channel_liable": false,
62                        "price": "2.40",
63                        "price_set": {
64                            "shop_money": {
65                                "amount": "2.40",
66                                "currency_code": "USD"
67                            },
68                            "presentment_money": {
69                                "amount": "2.40",
70                                "currency_code": "USD"
71                            }
72                        },
73                        "rate": 0.08,
74                        "title": "State Tax"
75                    }
76                ]
77            }
78        ],
79        "tracking_number": "1Z999AA1234567890",
80        "tracking_numbers": [
81            "1Z999AA1234567890"
82        ],
83        "tracking_url": "https://www.ups.com/track?loc=en_US&tracknum=1Z999AA1234567890",
84        "tracking_urls": [
85            "https://www.ups.com/track?loc=en_US&tracknum=1Z999AA1234567890"
86        ],
87        "receipt": {},
88        "name": "#1001.1",
89        "admin_graphql_api_id": "gid://shopify/Fulfillment/1234567890"
90    }
91}

Cancel order
Copy

Cancels an order. Orders that have a fulfillment object can't be canceled.

Sample Input

1{
2    "order_id": 4567890123,
3    "amount": "150.00",
4    "reason": "customer",
5    "email": true
6}

Sample Output

1{
2    "order": {
3        "id": 4567890123,
4        "admin_graphql_api_id": "gid://shopify/Order/4567890123",
5        "app_id": 1234567,
6        "browser_ip": "192.168.1.1",
7        "buyer_accepts_marketing": true,
8        "cancel_reason": "customer",
9        "cancelled_at": "2023-06-15T10:30:00Z",
10        "cart_token": "abc123xyz456",
11        "checkout_id": 9876543210,
12        "checkout_token": "def789uvw012",
13        "closed_at": null,
14        "confirmed": true,
15        "contact_email": "customer@example.com",
16        "created_at": "2023-06-14T15:00:00Z",
17        "currency": "USD",
18        "current_subtotal_price": "150.00",
19        "current_total_discounts": "0.00",
20        "current_total_price": "150.00",
21        "current_total_tax": "0.00",
22        "customer_locale": "en-US",
23        "email": "customer@example.com",
24        "financial_status": "refunded",
25        "fulfillment_status": null,
26        "name": "#1001",
27        "note": null,
28        "number": 1001,
29        "order_number": 1001,
30        "order_status_url": "https://shop.example.com/order/abcdef123456",
31        "payment_gateway_names": [
32            "shopify_payments"
33        ],
34        "phone": "+1-555-123-4567",
35        "presentment_currency": "USD",
36        "processed_at": "2023-06-14T15:05:00Z",
37        "subtotal_price": "150.00",
38        "tags": "",
39        "tax_lines": [],
40        "taxes_included": false,
41        "test": false,
42        "token": "abcdef123456",
43        "total_discounts": "0.00",
44        "total_line_items_price": "150.00",
45        "total_outstanding": "0.00",
46        "total_price": "150.00",
47        "total_tax": "0.00",
48        "total_tip_received": "0.00",
49        "total_weight": 500,
50        "updated_at": "2023-06-15T10:30:00Z",
51        "user_id": null,
52        "billing_address": {
53            "first_name": "John",
54            "last_name": "Doe",
55            "address1": "123 Main St",
56            "city": "Anytown",
57            "province": "State",
58            "country": "United States",
59            "zip": "12345",
60            "phone": "+1-555-123-4567"
61        },
62        "customer": {
63            "id": 123456789,
64            "email": "customer@example.com",
65            "first_name": "John",
66            "last_name": "Doe",
67            "phone": "+1-555-123-4567"
68        },
69        "line_items": [
70            {
71                "id": 987654321,
72                "admin_graphql_api_id": "gid://shopify/LineItem/987654321",
73                "fulfillable_quantity": 1,
74                "fulfillment_status": null,
75                "gift_card": false,
76                "grams": 500,
77                "name": "Sample Product",
78                "price": "150.00",
79                "product_id": 1122334455,
80                "quantity": 1,
81                "sku": "SAMPLE-001",
82                "title": "Sample Product",
83                "total_discount": "0.00",
84                "variant_id": 9988776655
85            }
86        ],
87        "refunds": [
88            {
89                "id": 112233445,
90                "created_at": "2023-06-15T10:30:00Z",
91                "note": "Customer cancellation",
92                "processed_at": "2023-06-15T10:30:00Z",
93                "restock": true,
94                "user_id": 99887766,
95                "transactions": [
96                    {
97                        "id": 778899001,
98                        "amount": "150.00",
99                        "kind": "refund",
100                        "status": "success"
101                    }
102                ]
103            }
104        ],
105        "shipping_address": {
106            "first_name": "John",
107            "last_name": "Doe",
108            "address1": "123 Main St",
109            "city": "Anytown",
110            "province": "State",
111            "country": "United States",
112            "zip": "12345",
113            "phone": "+1-555-123-4567"
114        }
115    },
116    "notice": "Order successfully cancelled."
117}

Close order
Copy

Closes an order.

Sample Input

1{
2    "order_id": 4495678901234
3}

Sample Output

1{
2    "order": {
3        "id": 4495678901234,
4        "admin_graphql_api_id": "gid://shopify/Order/4495678901234",
5        "app_id": 580111,
6        "browser_ip": "203.0.113.1",
7        "buyer_accepts_marketing": true,
8        "cancel_reason": null,
9        "cancelled_at": null,
10        "cart_token": "68778783ad298f1c80c3bafcddeea02f",
11        "checkout_id": 901234567890123,
12        "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
13        "client_details": {
14            "accept_language": "en-US,en;q=0.9",
15            "browser_height": "900",
16            "browser_ip": "203.0.113.1",
17            "browser_width": "1440",
18            "session_hash": "3b0dfbk72aj9j2ee05tl3i5qsm",
19            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
20        },
21        "closed_at": "2023-04-15T10:00:00-04:00",
22        "confirmed": true,
23        "contact_email": "john.doe@example.com",
24        "created_at": "2023-04-14T09:30:00-04:00",
25        "currency": "USD",
26        "current_subtotal_price": "100.00",
27        "current_total_discounts": "0.00",
28        "current_total_price": "110.00",
29        "current_total_tax": "10.00",
30        "email": "john.doe@example.com",
31        "financial_status": "paid",
32        "fulfillment_status": "fulfilled",
33        "name": "#1001",
34        "note": null,
35        "number": 1001,
36        "order_number": 1001,
37        "order_status_url": "https://shop.example.com/order/abcdefghijklmnop",
38        "payment_gateway_names": [
39            "shopify_payments"
40        ],
41        "phone": "+1-555-555-5555",
42        "presentment_currency": "USD",
43        "processed_at": "2023-04-14T09:35:00-04:00",
44        "subtotal_price": "100.00",
45        "tags": "",
46        "tax_lines": [
47            {
48                "price": "10.00",
49                "rate": 0.1,
50                "title": "State Tax"
51            }
52        ],
53        "taxes_included": false,
54        "test": false,
55        "token": "abcdefghijklmnopqrstuvwxyz",
56        "total_discounts": "0.00",
57        "total_line_items_price": "100.00",
58        "total_price": "110.00",
59        "total_tax": "10.00",
60        "total_weight": 500,
61        "updated_at": "2023-04-15T10:00:00-04:00",
62        "user_id": null,
63        "billing_address": {
64            "first_name": "John",
65            "last_name": "Doe",
66            "address1": "123 Billing St",
67            "city": "New York",
68            "province": "New York",
69            "country": "United States",
70            "zip": "10001",
71            "phone": "+1-555-555-5555",
72            "name": "John Doe",
73            "country_code": "US",
74            "province_code": "NY"
75        },
76        "customer": {
77            "id": 5678901234,
78            "email": "john.doe@example.com",
79            "first_name": "John",
80            "last_name": "Doe",
81            "phone": "+1-555-555-5555"
82        },
83        "line_items": [
84            {
85                "id": 9876543210,
86                "title": "Sample Product",
87                "quantity": 1,
88                "price": "100.00",
89                "sku": "SAMPLE001",
90                "variant_id": 98765432109,
91                "vendor": "Sample Vendor",
92                "fulfillment_status": "fulfilled",
93                "product_id": 87654321098,
94                "requires_shipping": true,
95                "taxable": true,
96                "gift_card": false,
97                "total_discount": "0.00"
98            }
99        ],
100        "shipping_address": {
101            "first_name": "John",
102            "last_name": "Doe",
103            "address1": "456 Shipping St",
104            "city": "New York",
105            "province": "New York",
106            "country": "United States",
107            "zip": "10001",
108            "phone": "+1-555-555-5555",
109            "name": "John Doe",
110            "country_code": "US",
111            "province_code": "NY"
112        },
113        "shipping_lines": [
114            {
115                "id": 3456789012,
116                "title": "Standard Shipping",
117                "price": "0.00",
118                "code": "Standard",
119                "source": "shopify"
120            }
121        ]
122    }
123}

Complete draft order
Copy

Complete a draft order, transitioning it to an order.

Sample Input

1{
2    "draft_order_id": 123456789,
3    "payment_pending": true
4}

Sample Output

1{
2    "draft_order": {
3        "id": 123456789,
4        "note": "Customer requested express shipping",
5        "email": "customer@example.com",
6        "taxes_included": false,
7        "currency": "USD",
8        "invoice_sent_at": "2023-05-15T10:30:00Z",
9        "created_at": "2023-05-14T15:45:00Z",
10        "updated_at": "2023-05-15T10:30:00Z",
11        "tax_exempt": false,
12        "completed_at": "2023-05-15T10:30:00Z",
13        "name": "#D123",
14        "status": "completed",
15        "line_items": [
16            {
17                "id": 987654321,
18                "variant_id": 12345,
19                "product_id": 67890,
20                "title": "Premium T-Shirt",
21                "variant_title": "Large / Blue",
22                "sku": "TSHIRT-L-BLUE",
23                "vendor": "Fashion Co.",
24                "quantity": 2,
25                "requires_shipping": true,
26                "taxable": true,
27                "gift_card": false,
28                "fulfillment_service": "manual",
29                "grams": 200,
30                "tax_lines": [
31                    {
32                        "channel_liable": false,
33                        "price": "4.00",
34                        "price_set": {
35                            "shop_money": {
36                                "amount": "4.00",
37                                "currency_code": "USD"
38                            },
39                            "presentment_money": {
40                                "amount": "4.00",
41                                "currency_code": "USD"
42                            }
43                        },
44                        "rate": 0.08,
45                        "title": "State Tax"
46                    }
47                ],
48                "applied_discount": null,
49                "name": "Premium T-Shirt - Large / Blue",
50                "properties": [],
51                "custom": false,
52                "price": "25.00",
53                "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/987654321"
54            }
55        ],
56        "shipping_address": {
57            "first_name": "John",
58            "address1": "123 Main St",
59            "phone": "555-123-4567",
60            "city": "Anytown",
61            "zip": "12345",
62            "province": "State",
63            "country": "United States",
64            "last_name": "Doe",
65            "address2": "",
66            "company": "",
67            "latitude": "40.7128",
68            "longitude": "-74.0060",
69            "name": "John Doe",
70            "country_code": "US",
71            "province_code": "NY"
72        },
73        "billing_address": {
74            "first_name": "John",
75            "address1": "123 Main St",
76            "phone": "555-123-4567",
77            "city": "Anytown",
78            "zip": "12345",
79            "province": "State",
80            "country": "United States",
81            "last_name": "Doe",
82            "address2": "",
83            "company": "",
84            "latitude": "40.7128",
85            "longitude": "-74.0060",
86            "name": "John Doe",
87            "country_code": "US",
88            "province_code": "NY"
89        },
90        "invoice_url": "https://shop.example.com/invoice/123456789",
91        "applied_discount": null,
92        "order_id": 987654321,
93        "shipping_line": {
94            "title": "Standard Shipping",
95            "custom": false,
96            "handle": "shopify-Standard%20Shipping-10.00",
97            "price": "10.00"
98        },
99        "tax_lines": [],
100        "tags": "sale, summer",
101        "note_attributes": [],
102        "total_price": "64.00",
103        "subtotal_price": "50.00",
104        "total_tax": "4.00",
105        "payment_terms": null,
106        "admin_graphql_api_id": "gid://shopify/DraftOrder/123456789"
107    }
108}

Count customers
Copy

Returns the number of customers in your store.

Sample Input

1{
2    "created_at_min": "2023-01-01T00:00:00Z",
3    "created_at_max": "2023-06-30T23:59:59Z",
4    "updated_at_min": "2023-03-15T12:00:00Z",
5    "updated_at_max": "2023-06-30T23:59:59Z"
6}

Sample Output

1{
2    "count": 1250
3}

Count fulfillments for an Order by ID
Copy

Returns the number of fulfillments associated with an order.

Sample Input

1{
2    "order_id": 4567890123,
3    "created_at_min": "2023-05-01T00:00:00Z",
4    "created_at_max": "2023-05-31T23:59:59Z",
5    "updated_at_min": "2023-05-15T00:00:00Z",
6    "updated_at_max": "2023-05-31T23:59:59Z"
7}

Sample Output

1{
2    "count": 3
3}

Count locations
Copy

Returns a count of locations.

Sample Input

1{}

Sample Output

1{
2    "count": 3
3}

Count orders
Copy

Returns the number of orders in your store.

Sample Input

1{
2    "status": "open",
3    "financial_status": "paid",
4    "fulfillment_status": "partial",
5    "created_at_min": "2023-01-01T00:00:00Z",
6    "created_at_max": "2023-06-30T23:59:59Z",
7    "updated_at_min": "2023-05-01T00:00:00Z",
8    "updated_at_max": "2023-06-30T23:59:59Z"
9}

Sample Output

1{
2    "count": 157
3}

Count products
Copy

Returns the number of products in your store.

Sample Input

1{
2    "published_status": "published",
3    "vendor": "Nike",
4    "product_type": "Shoes",
5    "collection_id": 12345678,
6    "created_at_min": "2023-01-01T00:00:00Z",
7    "created_at_max": "2023-06-30T23:59:59Z",
8    "updated_at_min": "2023-03-15T00:00:00Z",
9    "updated_at_max": "2023-06-30T23:59:59Z",
10    "published_at_min": "2023-04-01T00:00:00Z",
11    "published_at_max": "2023-06-30T23:59:59Z"
12}

Sample Output

1{
2    "count": 42
3}

Create account activation url
Copy

Creates a new account activation url.

Sample Input

1{
2    "customer_id": 4495743123456
3}

Sample Output

1{
2    "account_activation_url": "https://myshop.myshopify.com/account/activate/7f0e7cff-1234-5678-9abc-1234567890ab/8a9b0c1d-2345-6789-0123-4567890abcde"
3}

Create customer
Copy

Creates a new customer.

Sample Input

1{
2    "first_name": "John",
3    "last_name": "Doe",
4    "email": "john.doe@example.com",
5    "phone": "+1-555-123-4567",
6    "verified_email": true,
7    "addresses": [
8        {
9            "address1": "123 Main St",
10            "city": "Anytown",
11            "province": "Ontario",
12            "country_code": "CA",
13            "zip": "A1A 1A1",
14            "default": true
15        }
16    ],
17    "currency": "CAD",
18    "note": "Preferred customer",
19    "tags": [
20        "loyal",
21        "vip"
22    ],
23    "tax_exempt": false,
24    "metafields": [
25        {
26            "namespace": "custom",
27            "key": "loyalty_points",
28            "type_and_value": {
29                "number_integer": 100
30            },
31            "description": "Customer loyalty points"
32        }
33    ]
34}

Sample Output

1{
2    "customer": {
3        "id": 1234567890,
4        "email": "john.doe@example.com",
5        "created_at": "2023-05-15T10:00:00-04:00",
6        "updated_at": "2023-05-15T10:00:00-04:00",
7        "first_name": "John",
8        "last_name": "Doe",
9        "orders_count": 0,
10        "state": "enabled",
11        "total_spent": "0.00",
12        "last_order_id": null,
13        "note": "Preferred customer",
14        "verified_email": true,
15        "multipass_identifier": null,
16        "tax_exempt": false,
17        "tags": "loyal, vip",
18        "last_order_name": null,
19        "currency": "CAD",
20        "phone": "+1-555-123-4567",
21        "addresses": [
22            {
23                "id": 9876543210,
24                "customer_id": 1234567890,
25                "first_name": "John",
26                "last_name": "Doe",
27                "company": null,
28                "address1": "123 Main St",
29                "address2": null,
30                "city": "Anytown",
31                "province": "Ontario",
32                "country": "Canada",
33                "zip": "A1A 1A1",
34                "phone": "+1-555-123-4567",
35                "name": "John Doe",
36                "province_code": "ON",
37                "country_code": "CA",
38                "country_name": "Canada",
39                "default": true
40            }
41        ],
42        "tax_exemptions": [],
43        "email_marketing_consent": {
44            "state": "subscribed",
45            "opt_in_level": "single_opt_in",
46            "consent_updated_at": "2023-05-15T10:00:00-04:00"
47        },
48        "sms_marketing_consent": {
49            "state": "not_subscribed",
50            "opt_in_level": null,
51            "consent_updated_at": null,
52            "consent_collected_from": "OTHER"
53        },
54        "admin_graphql_api_id": "gid://shopify/Customer/1234567890",
55        "default_address": {
56            "id": 9876543210,
57            "customer_id": 1234567890,
58            "first_name": "John",
59            "last_name": "Doe",
60            "company": null,
61            "address1": "123 Main St",
62            "address2": null,
63            "city": "Anytown",
64            "province": "Ontario",
65            "country": "Canada",
66            "zip": "A1A 1A1",
67            "phone": "+1-555-123-4567",
68            "name": "John Doe",
69            "province_code": "ON",
70            "country_code": "CA",
71            "country_name": "Canada",
72            "default": true
73        }
74    }
75}

Create draft order
Copy

Create a draft order.

Sample Input

1{
2    "draft_order_line_items": [
3        {
4            "variant_id": 12345678,
5            "quantity": 2
6        },
7        {
8            "title": "Custom T-Shirt",
9            "price": "29.99",
10            "quantity": 1,
11            "grams": 200,
12            "sku": "CUSTOM-TS-001",
13            "taxable": true,
14            "requires_shipping": true,
15            "applied_discount": {
16                "value_type": "percentage",
17                "value": "10",
18                "description": "Loyalty discount",
19                "title": "10% Off"
20            },
21            "properties": [
22                {
23                    "name": "Color",
24                    "value": "Blue"
25                },
26                {
27                    "name": "Size",
28                    "value": "Large"
29                }
30            ]
31        }
32    ],
33    "applied_discount": {
34        "value_type": "fixed_amount",
35        "value": "5.00",
36        "description": "Summer sale discount",
37        "title": "$5 Off"
38    },
39    "customer": {
40        "id": "6789012"
41    },
42    "use_customer_default_address": true,
43    "shipping_line": {
44        "title": "Standard Shipping",
45        "price": "9.99"
46    },
47    "note": "Please gift wrap the items."
48}

Sample Output

1{
2    "draft_order": {
3        "id": 1234567890,
4        "note": "Please gift wrap the items.",
5        "email": "customer@example.com",
6        "taxes_included": false,
7        "currency": "USD",
8        "invoice_sent_at": null,
9        "created_at": "2023-06-15T10:00:00-04:00",
10        "updated_at": "2023-06-15T10:00:00-04:00",
11        "tax_exempt": false,
12        "completed_at": null,
13        "name": "#D1234",
14        "status": "open",
15        "line_items": [
16            {
17                "id": 9876543210,
18                "variant_id": 12345678,
19                "product_id": 87654321,
20                "title": "Sample Product",
21                "variant_title": "Blue / Large",
22                "sku": "SAMPLE-PROD-001",
23                "vendor": "Sample Vendor",
24                "quantity": 2,
25                "requires_shipping": true,
26                "taxable": true,
27                "gift_card": false,
28                "fulfillment_service": "manual",
29                "grams": 400,
30                "tax_lines": [
31                    {
32                        "channel_liable": false,
33                        "price": "4.80",
34                        "price_set": {
35                            "shop_money": {
36                                "amount": "4.80",
37                                "currency_code": "USD"
38                            },
39                            "presentment_money": {
40                                "amount": "4.80",
41                                "currency_code": "USD"
42                            }
43                        },
44                        "rate": 0.08,
45                        "title": "State Tax"
46                    }
47                ],
48                "applied_discount": null,
49                "name": "Sample Product - Blue / Large",
50                "properties": [],
51                "custom": false,
52                "price": "59.99",
53                "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/9876543210"
54            },
55            {
56                "id": 9876543211,
57                "variant_id": null,
58                "product_id": null,
59                "title": "Custom T-Shirt",
60                "variant_title": null,
61                "sku": "CUSTOM-TS-001",
62                "vendor": null,
63                "quantity": 1,
64                "requires_shipping": true,
65                "taxable": true,
66                "gift_card": false,
67                "fulfillment_service": "manual",
68                "grams": 200,
69                "tax_lines": [
70                    {
71                        "channel_liable": false,
72                        "price": "2.16",
73                        "price_set": {
74                            "shop_money": {
75                                "amount": "2.16",
76                                "currency_code": "USD"
77                            },
78                            "presentment_money": {
79                                "amount": "2.16",
80                                "currency_code": "USD"
81                            }
82                        },
83                        "rate": 0.08,
84                        "title": "State Tax"
85                    }
86                ],
87                "applied_discount": {
88                    "description": "Loyalty discount",
89                    "value": "10",
90                    "title": "10% Off",
91                    "amount": "3.00",
92                    "value_type": "percentage"
93                },
94                "name": "Custom T-Shirt",
95                "properties": [
96                    {
97                        "name": "Color",
98                        "value": "Blue"
99                    },
100                    {
101                        "name": "Size",
102                        "value": "Large"
103                    }
104                ],
105                "custom": true,
106                "price": "29.99",
107                "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/9876543211"
108            }
109        ],
110        "shipping_address": {
111            "first_name": "John",
112            "address1": "123 Main St",
113            "phone": "555-123-4567",
114            "city": "Anytown",
115            "zip": "12345",
116            "province": "State",
117            "country": "United States",
118            "last_name": "Doe",
119            "address2": "",
120            "company": "",
121            "latitude": "40.7128",
122            "longitude": "-74.0060",
123            "name": "John Doe",
124            "country_code": "US",
125            "province_code": "NY"
126        },
127        "billing_address": {
128            "first_name": "John",
129            "address1": "123 Main St",
130            "phone": "555-123-4567",
131            "city": "Anytown",
132            "zip": "12345",
133            "province": "State",
134            "country": "United States",
135            "last_name": "Doe",
136            "address2": "",
137            "company": "",
138            "latitude": "40.7128",
139            "longitude": "-74.0060",
140            "name": "John Doe",
141            "country_code": "US",
142            "province_code": "NY"
143        },
144        "invoice_url": "https://www.example.com/invoice",
145        "applied_discount": {
146            "description": "Summer sale discount",
147            "value": "5.00",
148            "title": "$5 Off",
149            "amount": "5.00",
150            "value_type": "fixed_amount"
151        },
152        "order_id": null,
153        "shipping_line": {
154            "title": "Standard Shipping",
155            "custom": true,
156            "handle": null,
157            "price": "9.99"
158        },
159        "tax_lines": [
160            {
161                "price": "6.96",
162                "rate": 0.08,
163                "title": "State Tax"
164            }
165        ],
166        "tags": "",
167        "note_attributes": [],
168        "total_price": "151.93",
169        "subtotal_price": "146.97",
170        "total_tax": "6.96",
171        "admin_graphql_api_id": "gid://shopify/DraftOrder/1234567890"
172    }
173}

Create fulfillment
Copy

Creates a new fulfillment.

Sample Input

1{
2    "line_items_by_fulfillment_order": [
3        {
4            "fulfillment_order_id": 1234567890,
5            "fulfillment_order_line_items": [
6                {
7                    "id": 9876543210,
8                    "quantity": 2
9                },
10                {
11                    "id": 8765432109,
12                    "quantity": 1
13                }
14            ]
15        }
16    ],
17    "message": "Your order has been shipped!",
18    "notify_customer": true,
19    "origin_address": {
20        "address1": "123 Warehouse St",
21        "address2": "Unit 5",
22        "city": "Toronto",
23        "country_code": "CA",
24        "province_code": "ON",
25        "zip": "M5V 2B7"
26    },
27    "tracking_info": {
28        "company": "FedEx",
29        "number": "1234567890123",
30        "url": "https://www.fedex.com/tracking?tracknumbers=1234567890123"
31    }
32}

Sample Output

1{
2    "fulfillment": {
3        "id": 3456789012,
4        "order_id": 2345678901,
5        "status": "success",
6        "created_at": "2023-04-15T10:00:00-04:00",
7        "service": "manual",
8        "updated_at": "2023-04-15T10:00:00-04:00",
9        "tracking_company": "FedEx",
10        "shipment_status": "in_transit",
11        "location_id": 4567890123,
12        "origin_address": "123 Warehouse St, Unit 5, Toronto ON M5V 2B7, Canada",
13        "line_items": [
14            {
15                "id": 9876543210,
16                "variant_id": 5678901234,
17                "title": "T-shirt",
18                "quantity": 2,
19                "sku": "TS-001",
20                "variant_title": "Blue / Medium",
21                "vendor": "Fashion Co.",
22                "fulfillment_service": "manual",
23                "product_id": 6789012345,
24                "requires_shipping": true,
25                "taxable": true,
26                "gift_card": false,
27                "name": "T-shirt - Blue / Medium",
28                "variant_inventory_management": "shopify",
29                "properties": [],
30                "product_exists": true,
31                "fulfillable_quantity": 2,
32                "grams": 200,
33                "price": "29.99",
34                "total_discount": "0.00",
35                "fulfillment_status": "fulfilled",
36                "price_set": {
37                    "shop_money": {
38                        "amount": "29.99",
39                        "currency_code": "USD"
40                    },
41                    "presentment_money": {
42                        "amount": "29.99",
43                        "currency_code": "USD"
44                    }
45                },
46                "total_discount_set": {
47                    "shop_money": {
48                        "amount": "0.00",
49                        "currency_code": "USD"
50                    },
51                    "presentment_money": {
52                        "amount": "0.00",
53                        "currency_code": "USD"
54                    }
55                },
56                "discount_allocations": [],
57                "duties": [],
58                "admin_graphql_api_id": "gid://shopify/LineItem/9876543210",
59                "tax_lines": []
60            },
61            {
62                "id": 8765432109,
63                "variant_id": 6789012345,
64                "title": "Jeans",
65                "quantity": 1,
66                "sku": "JN-001",
67                "variant_title": "Black / 32",
68                "vendor": "Fashion Co.",
69                "fulfillment_service": "manual",
70                "product_id": 7890123456,
71                "requires_shipping": true,
72                "taxable": true,
73                "gift_card": false,
74                "name": "Jeans - Black / 32",
75                "variant_inventory_management": "shopify",
76                "properties": [],
77                "product_exists": true,
78                "fulfillable_quantity": 1,
79                "grams": 500,
80                "price": "59.99",
81                "total_discount": "0.00",
82                "fulfillment_status": "fulfilled",
83                "price_set": {
84                    "shop_money": {
85                        "amount": "59.99",
86                        "currency_code": "USD"
87                    },
88                    "presentment_money": {
89                        "amount": "59.99",
90                        "currency_code": "USD"
91                    }
92                },
93                "total_discount_set": {
94                    "shop_money": {
95                        "amount": "0.00",
96                        "currency_code": "USD"
97                    },
98                    "presentment_money": {
99                        "amount": "0.00",
100                        "currency_code": "USD"
101                    }
102                },
103                "discount_allocations": [],
104                "duties": [],
105                "admin_graphql_api_id": "gid://shopify/LineItem/8765432109",
106                "tax_lines": []
107            }
108        ],
109        "tracking_number": 1234567890123,
110        "tracking_numbers": [
111            "1234567890123"
112        ],
113        "tracking_url": "https://www.fedex.com/tracking?tracknumbers=1234567890123",
114        "tracking_urls": [
115            "https://www.fedex.com/tracking?tracknumbers=1234567890123"
116        ],
117        "receipt": {},
118        "name": "#1001.1",
119        "admin_graphql_api_id": "gid://shopify/Fulfillment/3456789012"
120    }
121}

Create inventory level
Copy

Connects an inventory item to a location by creating an inventory level at that location.

Sample Input

1{
2    "inventory_item_id": 12345678,
3    "location_id": 987654,
4    "relocate_if_necessary": true
5}

Sample Output

1{
2    "inventory_level": {
3        "inventory_item_id": 12345678,
4        "location_id": 987654,
5        "available": 100,
6        "updated_at": "2023-05-15T14:30:00Z",
7        "admin_graphql_api_id": "gid://shopify/InventoryLevel/12345678?location_id=987654"
8    }
9}

Create inventory level for item at location
Copy

Sets the inventory level for an inventory item at a location. If the specified location is not connected, it will be automatically connected first.

Sample Input

1{
2    "inventory_item_id": 12345678,
3    "location_id": 987654,
4    "available": 100,
5    "disconnect_if_necessary": false
6}

Sample Output

1{
2    "inventory_level": {
3        "inventory_item_id": 12345678,
4        "location_id": 987654,
5        "available": 100,
6        "updated_at": "2023-05-15T14:30:00Z",
7        "admin_graphql_api_id": "gid://shopify/InventoryLevel/12345678?location_id=987654"
8    }
9}

Create metafield
Copy

Creates a new metafield for the specified resource.

Sample Input

1{
2    "resource_type": {
3        "type": "products",
4        "id": 4567890123
5    },
6    "namespace": "product_details",
7    "key": "material",
8    "type_and_value": {
9        "single_line_text_field": "100% Cotton"
10    },
11    "description": "Material composition of the product"
12}

Sample Output

1{
2    "metafield": {
3        "id": 987654321,
4        "namespace": "product_details",
5        "key": "material",
6        "value": "100% Cotton",
7        "description": "Material composition of the product",
8        "owner_id": 4567890123,
9        "created_at": "2023-06-15T10:30:00Z",
10        "updated_at": "2023-06-15T10:30:00Z",
11        "owner_resource": "product",
12        "type": "single_line_text_field",
13        "admin_graphql_api_id": "gid://shopify/Metafield/987654321"
14    }
15}

Create new product image
Copy

Create a new product image with included image data as attachment

Sample Input

1{
2    "attachment": {
3        "name": "product_image.jpg",
4        "content": "base64_encoded_image_data_here"
5    },
6    "product_id": 1234567890
7}

Sample Output

1{
2    "image": {
3        "id": 987654321,
4        "product_id": 1234567890,
5        "position": 1,
6        "created_at": "2023-05-15T10:30:00Z",
7        "updated_at": "2023-05-15T10:30:00Z",
8        "alt": "Product image",
9        "width": 1200,
10        "height": 800,
11        "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/product_image.jpg",
12        "variant_ids": [],
13        "admin_graphql_api_id": "gid://shopify/ProductImage/987654321"
14    }
15}

Create product
Copy

Creates a new product. To add product variants via the create product variant operation, please define the variant possibilities by explicitly defining all of the options (max 3).

Sample Input

1{
2    "title": "Eco-friendly Water Bottle",
3    "vendor": "GreenLife",
4    "product_type": "Drinkware",
5    "body_html": "<p>Stay hydrated with our eco-friendly water bottle. Made from sustainable materials, this bottle keeps your drinks cold for hours.</p>",
6    "add_tags": [
7        "eco-friendly",
8        "sustainable",
9        "reusable"
10    ],
11    "published": true,
12    "options": [
13        {
14            "name": "Color",
15            "values": [
16                "Blue",
17                "Green",
18                "Pink"
19            ]
20        },
21        {
22            "name": "Size",
23            "values": [
24                "500ml",
25                "750ml"
26            ]
27        }
28    ],
29    "variants": [
30        {
31            "option1": "Blue",
32            "option2": "500ml",
33            "price": 19.99,
34            "sku": "ECO-WB-B-500",
35            "inventory_management": "shopify",
36            "inventory_policy": "deny",
37            "weight": 300,
38            "weight_unit": "g"
39        },
40        {
41            "option1": "Blue",
42            "option2": "750ml",
43            "price": 24.99,
44            "sku": "ECO-WB-B-750",
45            "inventory_management": "shopify",
46            "inventory_policy": "deny",
47            "weight": 400,
48            "weight_unit": "g"
49        },
50        {
51            "option1": "Green",
52            "option2": "500ml",
53            "price": 19.99,
54            "sku": "ECO-WB-G-500",
55            "inventory_management": "shopify",
56            "inventory_policy": "deny",
57            "weight": 300,
58            "weight_unit": "g"
59        },
60        {
61            "option1": "Green",
62            "option2": "750ml",
63            "price": 24.99,
64            "sku": "ECO-WB-G-750",
65            "inventory_management": "shopify",
66            "inventory_policy": "deny",
67            "weight": 400,
68            "weight_unit": "g"
69        },
70        {
71            "option1": "Pink",
72            "option2": "500ml",
73            "price": 19.99,
74            "sku": "ECO-WB-P-500",
75            "inventory_management": "shopify",
76            "inventory_policy": "deny",
77            "weight": 300,
78            "weight_unit": "g"
79        },
80        {
81            "option1": "Pink",
82            "option2": "750ml",
83            "price": 24.99,
84            "sku": "ECO-WB-P-750",
85            "inventory_management": "shopify",
86            "inventory_policy": "deny",
87            "weight": 400,
88            "weight_unit": "g"
89        }
90    ],
91    "metafields": [
92        {
93            "namespace": "product_info",
94            "key": "material",
95            "type_and_value": {
96                "single_line_text_field": "Recycled stainless steel"
97            },
98            "description": "Material used to make the water bottle"
99        },
100        {
101            "namespace": "product_info",
102            "key": "insulation_time",
103            "type_and_value": {
104                "number_integer": 24
105            },
106            "description": "Number of hours the bottle keeps drinks cold"
107        }
108    ]
109}

Sample Output

1{
2    "product": {
3        "id": 7890123456,
4        "title": "Eco-friendly Water Bottle",
5        "body_html": "<p>Stay hydrated with our eco-friendly water bottle. Made from sustainable materials, this bottle keeps your drinks cold for hours.</p>",
6        "vendor": "GreenLife",
7        "product_type": "Drinkware",
8        "created_at": "2023-06-01T10:00:00-04:00",
9        "handle": "eco-friendly-water-bottle",
10        "updated_at": "2023-06-01T10:00:00-04:00",
11        "published_at": "2023-06-01T10:00:00-04:00",
12        "template_suffix": null,
13        "status": "active",
14        "published_scope": "web",
15        "tags": "eco-friendly, reusable, sustainable",
16        "admin_graphql_api_id": "gid://shopify/Product/7890123456",
17        "variants": [
18            {
19                "id": 43210987654,
20                "product_id": 7890123456,
21                "title": "Blue / 500ml",
22                "price": "19.99",
23                "sku": "ECO-WB-B-500",
24                "position": 1,
25                "inventory_policy": "deny",
26                "compare_at_price": null,
27                "fulfillment_service": "manual",
28                "inventory_management": "shopify",
29                "option1": "Blue",
30                "option2": "500ml",
31                "option3": null,
32                "created_at": "2023-06-01T10:00:00-04:00",
33                "updated_at": "2023-06-01T10:00:00-04:00",
34                "taxable": true,
35                "barcode": null,
36                "grams": 300,
37                "image_id": null,
38                "weight": 300,
39                "weight_unit": "g",
40                "inventory_item_id": 43210987654,
41                "inventory_quantity": 100,
42                "old_inventory_quantity": 100,
43                "requires_shipping": true,
44                "admin_graphql_api_id": "gid://shopify/ProductVariant/43210987654"
45            },
46            {
47                "id": 43210987655,
48                "product_id": 7890123456,
49                "title": "Blue / 750ml",
50                "price": "24.99",
51                "sku": "ECO-WB-B-750",
52                "position": 2,
53                "inventory_policy": "deny",
54                "compare_at_price": null,
55                "fulfillment_service": "manual",
56                "inventory_management": "shopify",
57                "option1": "Blue",
58                "option2": "750ml",
59                "option3": null,
60                "created_at": "2023-06-01T10:00:00-04:00",
61                "updated_at": "2023-06-01T10:00:00-04:00",
62                "taxable": true,
63                "barcode": null,
64                "grams": 400,
65                "image_id": null,
66                "weight": 400,
67                "weight_unit": "g",
68                "inventory_item_id": 43210987655,
69                "inventory_quantity": 100,
70                "old_inventory_quantity": 100,
71                "requires_shipping": true,
72                "admin_graphql_api_id": "gid://shopify/ProductVariant/43210987655"
73            }
74        ],
75        "options": [
76            {
77                "id": 9876543210,
78                "product_id": 7890123456,
79                "name": "Color",
80                "position": 1,
81                "values": [
82                    "Blue",
83                    "Green",
84                    "Pink"
85                ]
86            },
87            {
88                "id": 9876543211,
89                "product_id": 7890123456,
90                "name": "Size",
91                "position": 2,
92                "values": [
93                    "500ml",
94                    "750ml"
95                ]
96            }
97        ],
98        "images": [],
99        "image": null
100    }
101}

Create product image with image URL
Copy

Create a new product image with a given image URL.

Sample Input

1{
2    "src": "https://example.com/images/blue-t-shirt.jpg",
3    "product_id": 1234567890
4}

Sample Output

1{
2    "image": {
3        "id": 9876543210,
4        "product_id": 1234567890,
5        "position": 1,
6        "created_at": "2023-06-15T10:30:00Z",
7        "updated_at": "2023-06-15T10:30:00Z",
8        "alt": "Blue T-Shirt",
9        "width": 800,
10        "height": 600,
11        "src": "https://cdn.shopify.com/s/files/1/0123/4567/8901/products/blue-t-shirt.jpg",
12        "variant_ids": [],
13        "admin_graphql_api_id": "gid://shopify/ProductImage/9876543210"
14    }
15}

Create product variant
Copy

Creates a new product variant. Please note that in order to use this operation, the variant options must already be defined on the product.

Sample Input

1{
2    "product_id": 1234567890,
3    "option1": "Blue",
4    "option2": "Large",
5    "option3": "Cotton",
6    "price": 29.99,
7    "compare_at_price": "39.99",
8    "barcode": "978020137962",
9    "fulfillment_service": "manual",
10    "sku": "BLC-LRG-CTN-001",
11    "taxable": true,
12    "tax_code": "PC040111",
13    "weight_unit": "kg",
14    "weight": 0.5,
15    "image_id": 9876543210,
16    "inventory_management": "shopify",
17    "inventory_policy": "deny"
18}

Sample Output

1{
2    "variant": {
3        "id": 31234567890,
4        "product_id": 1234567890,
5        "title": "Blue / Large / Cotton",
6        "price": "29.99",
7        "sku": "BLC-LRG-CTN-001",
8        "position": 1,
9        "inventory_policy": "deny",
10        "compare_at_price": "39.99",
11        "fulfillment_service": "manual",
12        "inventory_management": "shopify",
13        "option1": "Blue",
14        "option2": "Large",
15        "option3": "Cotton",
16        "created_at": "2023-05-15T10:00:00-04:00",
17        "updated_at": "2023-05-15T10:00:00-04:00",
18        "taxable": true,
19        "barcode": "978020137962",
20        "grams": 500,
21        "weight": 0.5,
22        "weight_unit": "kg",
23        "inventory_item_id": 41234567890,
24        "inventory_quantity": 100,
25        "old_inventory_quantity": 100,
26        "requires_shipping": true,
27        "admin_graphql_api_id": "gid://shopify/ProductVariant/31234567890",
28        "image_id": "9876543210"
29    }
30}

Delete customer
Copy

Deletes a customer.

Sample Input

1{
2    "customer_id": 4815162342
3}

Sample Output

1{
2    "deleted": true
3}

Delete inventory level
Copy

Deletes an inventory level of an inventory item at a location..

Sample Input

1{
2    "inventory_item_id": 12345678,
3    "location_id": 987654
4}

Sample Output

1{
2    "deleted": true
3}

Delete metafield
Copy

Delete a specific metafield

Sample Input

1{
2    "resource_type": {
3        "type": "products",
4        "id": 4567890123
5    },
6    "metafield_id": 9876543210
7}

Sample Output

1{
2    "deleted": true
3}

Delete order
Copy

Deletes an order.

Sample Input

1{
2    "order_id": 4495743123
3}

Sample Output

1{
2    "deleted": true
3}

Delete product
Copy

Deletes product with given ID.

Sample Input

1{
2    "product_id": 1234567890
3}

Sample Output

1{
2    "success": true
3}

Delete product variant
Copy

Deletes a product variant by ID

Sample Input

1{
2    "variant_id": 12345678,
3    "product_id": 87654321
4}

Sample Output

1{
2    "success": true
3}

Get collection
Copy

Retrieves a collection.

Sample Input

1{
2    "collection_id": 1234567890
3}

Sample Output

1{
2    "collection": {
3        "id": 1234567890,
4        "handle": "summer-collection-2023",
5        "title": "Summer Collection 2023",
6        "updated_at": "2023-06-15T10:30:00Z",
7        "body_html": "<p>Discover our latest summer styles for 2023!</p>",
8        "published_at": "2023-05-01T09:00:00Z",
9        "sort_order": "alpha-asc",
10        "template_suffix": "summer-collection",
11        "products_count": 50,
12        "collection_type": "custom",
13        "published_scope": "web",
14        "admin_graphql_api_id": "gid://shopify/Collection/1234567890"
15    }
16}

Get customer
Copy

Returns information about a customer.

Sample Input

1{
2    "customer_id": 1234567890,
3    "fields": [
4        "id",
5        "email",
6        "first_name",
7        "last_name",
8        "phone",
9        "tags"
10    ]
11}

Sample Output

1{
2    "customer": {
3        "id": 1234567890,
4        "email": "johndoe@example.com",
5        "first_name": "John",
6        "last_name": "Doe",
7        "phone": "+1-555-123-4567",
8        "tags": "VIP, Loyalty Program"
9    }
10}

Get fulfillment
Copy

Returns information about a fulfillment.

Sample Input

1{
2    "order_id": 4495673524,
3    "fulfillment_id": 3456789012,
4    "fields": [
5        "id",
6        "order_id",
7        "status",
8        "tracking_number",
9        "tracking_url",
10        "line_items"
11    ]
12}

Sample Output

1{
2    "fulfillment": {
3        "id": 3456789012,
4        "order_id": 4495673524,
5        "status": "success",
6        "tracking_number": "1Z999AA1123456789",
7        "tracking_url": "https://www.ups.com/track?loc=en_US&tracknum=1Z999AA1123456789",
8        "line_items": [
9            {
10                "id": 9876543210,
11                "variant_id": 40123456789,
12                "title": "Classic T-Shirt",
13                "quantity": 2,
14                "price": "29.99",
15                "sku": "TSHIRT-001",
16                "variant_title": "Large / Blue",
17                "vendor": "Fashion Co.",
18                "fulfillment_service": "manual",
19                "product_id": 1234567890,
20                "requires_shipping": true,
21                "taxable": true,
22                "gift_card": false,
23                "name": "Classic T-Shirt - Large / Blue",
24                "variant_inventory_management": "shopify",
25                "properties": [],
26                "product_exists": true,
27                "fulfillable_quantity": 2,
28                "grams": 200,
29                "total_discount": "0.00",
30                "fulfillment_status": "fulfilled",
31                "price_set": {
32                    "shop_money": {
33                        "amount": "29.99",
34                        "currency_code": "USD"
35                    },
36                    "presentment_money": {
37                        "amount": "29.99",
38                        "currency_code": "USD"
39                    }
40                },
41                "total_discount_set": {
42                    "shop_money": {
43                        "amount": "0.00",
44                        "currency_code": "USD"
45                    },
46                    "presentment_money": {
47                        "amount": "0.00",
48                        "currency_code": "USD"
49                    }
50                },
51                "discount_allocations": [],
52                "admin_graphql_api_id": "gid://shopify/LineItem/9876543210",
53                "tax_lines": [
54                    {
55                        "title": "State Tax",
56                        "price": "2.40",
57                        "rate": 0.08,
58                        "channel_liable": false,
59                        "price_set": {
60                            "shop_money": {
61                                "amount": "2.40",
62                                "currency_code": "USD"
63                            },
64                            "presentment_money": {
65                                "amount": "2.40",
66                                "currency_code": "USD"
67                            }
68                        }
69                    }
70                ]
71            }
72        ]
73    }
74}

Get fulfillment orders by orderid
Copy

Get FulfillmentOrders for a given Order ID

Sample Input

1{
2    "order_id": 4567890123
3}

Sample Output

1{
2    "fulfillment_orders": [
3        {
4            "id": 1234567890,
5            "shop_id": 9876543210,
6            "order_id": 4567890123,
7            "assigned_location_id": 5678901234,
8            "request_status": "submitted",
9            "status": "open",
10            "supported_actions": [],
11            "destination": "123 Main St, Anytown, USA",
12            "line_items": [
13                {
14                    "id": 2345678901,
15                    "shop_id": 9876543210,
16                    "fulfillment_order_id": 1234567890,
17                    "quantity": 2,
18                    "line_item_id": 3456789012,
19                    "inventory_item_id": 4567890123,
20                    "fulfillable_quantity": 2,
21                    "variant_id": 5678901234
22                }
23            ],
24            "fulfill_at": "2023-05-15T10:00:00Z",
25            "fulfill_by": "2023-05-17T18:00:00Z",
26            "international_duties": "null",
27            "fulfillment_holds": [],
28            "delivery_method": "standard",
29            "assigned_location": {
30                "address1": "456 Warehouse Ave",
31                "address2": "Unit 789",
32                "city": "Logistics City",
33                "country_code": "US",
34                "location_id": 5678901234,
35                "name": "Main Fulfillment Center",
36                "phone": "555-123-4567",
37                "province": "CA",
38                "zip": "90210"
39            },
40            "merchant_requests": []
41        }
42    ]
43}

Get inventory item
Copy

Returns a single inventory item by ID.

Sample Input

1{
2    "inventory_item_id": 12345678
3}

Sample Output

1{
2    "inventory_item": {
3        "id": 12345678,
4        "sku": "PROD-001",
5        "created_at": "2023-05-15T10:30:00Z",
6        "updated_at": "2023-05-20T14:45:00Z",
7        "requires_shipping": true,
8        "cost": "15.99",
9        "country_code_of_origin": "US",
10        "province_code_of_origin": "CA",
11        "harmonized_system_code": 610910,
12        "tracked": true,
13        "country_harmonized_system_codes": [
14            {
15                "country_code": "US",
16                "harmonized_system_code": "6109.10.0000"
17            },
18            {
19                "country_code": "CA",
20                "harmonized_system_code": "6109.10.00"
21            }
22        ],
23        "admin_graphql_api_id": "gid://shopify/InventoryItem/12345678"
24    }
25}

Get Location
Copy

Returns a single location by its ID.

Sample Input

1{
2    "location_id": 1234567890
3}

Sample Output

1{
2    "location": {
3        "id": 1234567890,
4        "name": "Downtown Store",
5        "address1": "123 Main Street",
6        "address2": "Suite 100",
7        "city": "New York",
8        "zip": "10001",
9        "province": "New York",
10        "country": "United States",
11        "phone": "+1 (212) 555-1234",
12        "created_at": "2023-05-15T10:00:00-04:00",
13        "updated_at": "2023-05-15T10:00:00-04:00",
14        "country_code": "US",
15        "country_name": "United States",
16        "province_code": "NY",
17        "legacy": false,
18        "active": true,
19        "admin_graphql_api_id": "gid://shopify/Location/1234567890"
20    }
21}

Get Location inventory levels
Copy

Returns a list of inventory levels for a location.

Sample Input

1{
2    "location_id": 1234567890
3}

Sample Output

1{
2    "inventory_levels": [
3        {
4            "inventory_item_id": 9876543210,
5            "location_id": 1234567890,
6            "available": 42,
7            "updated_at": "2023-05-15T10:30:00Z",
8            "admin_graphql_api_id": "gid://shopify/InventoryLevel/9876543210?location_id=1234567890"
9        },
10        {
11            "inventory_item_id": 9876543211,
12            "location_id": 1234567890,
13            "available": 15,
14            "updated_at": "2023-05-15T09:45:00Z",
15            "admin_graphql_api_id": "gid://shopify/InventoryLevel/9876543211?location_id=1234567890"
16        },
17        {
18            "inventory_item_id": 9876543212,
19            "location_id": 1234567890,
20            "available": 78,
21            "updated_at": "2023-05-15T11:15:00Z",
22            "admin_graphql_api_id": "gid://shopify/InventoryLevel/9876543212?location_id=1234567890"
23        }
24    ]
25}

Get metafield by ID
Copy

Return's a metafield data by ID (for a given resource).

Sample Input

1{
2    "resource_type": {
3        "type": "products",
4        "id": 4567890123
5    },
6    "metafield_id": 987654321
7}

Sample Output

1{
2    "metafield": {
3        "id": 987654321,
4        "namespace": "custom",
5        "key": "material",
6        "value": "cotton",
7        "description": "Material of the product",
8        "owner_id": 4567890123,
9        "created_at": "2023-05-15T10:30:00Z",
10        "updated_at": "2023-05-15T10:30:00Z",
11        "owner_resource": "product",
12        "type": "string",
13        "admin_graphql_api_id": "gid://shopify/Metafield/987654321"
14    }
15}

Get order
Copy

Returns information about an order.

Sample Input

1{
2    "order_id": 4495678901234,
3    "fields": [
4        "id",
5        "email",
6        "total_price",
7        "currency",
8        "financial_status",
9        "fulfillment_status",
10        "created_at",
11        "updated_at"
12    ]
13}

Sample Output

1{
2    "order": {
3        "id": 4495678901234,
4        "email": "customer@example.com",
5        "total_price": "199.99",
6        "currency": "USD",
7        "financial_status": "paid",
8        "fulfillment_status": "fulfilled",
9        "created_at": "2023-06-01T10:00:00-04:00",
10        "updated_at": "2023-06-01T14:30:00-04:00"
11    }
12}

Get product
Copy

Returns information about a product.

Sample Input

1{
2    "product_id": 1234567890,
3    "fields": [
4        "id",
5        "title",
6        "body_html",
7        "vendor",
8        "product_type",
9        "created_at",
10        "variants",
11        "images"
12    ]
13}

Sample Output

1{
2    "product": {
3        "id": 1234567890,
4        "title": "Classic Cotton T-Shirt",
5        "body_html": "<p>A comfortable and versatile cotton t-shirt for everyday wear.</p>",
6        "vendor": "Fashion Basics",
7        "product_type": "Apparel",
8        "created_at": "2023-05-15T10:00:00-04:00",
9        "variants": [
10            {
11                "id": 12345678901,
12                "product_id": 1234567890,
13                "title": "Small / White",
14                "price": "19.99",
15                "sku": "CTN-TS-S-WHT",
16                "position": 1,
17                "inventory_policy": "deny",
18                "compare_at_price": "24.99",
19                "fulfillment_service": "manual",
20                "inventory_management": "shopify",
21                "option1": "Small",
22                "option2": "White",
23                "option3": null,
24                "created_at": "2023-05-15T10:00:00-04:00",
25                "updated_at": "2023-05-15T10:00:00-04:00",
26                "taxable": true,
27                "barcode": "123456789012",
28                "grams": 200,
29                "image_id": 23456789012,
30                "weight": 0.2,
31                "weight_unit": "kg",
32                "inventory_item_id": 12345678901,
33                "inventory_quantity": 50,
34                "old_inventory_quantity": 50,
35                "requires_shipping": true,
36                "admin_graphql_api_id": "gid://shopify/ProductVariant/12345678901"
37            }
38        ],
39        "images": [
40            {
41                "id": 23456789012,
42                "product_id": 1234567890,
43                "position": 1,
44                "created_at": "2023-05-15T10:00:00-04:00",
45                "updated_at": "2023-05-15T10:00:00-04:00",
46                "width": 1000,
47                "height": 1000,
48                "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/classic-tshirt-white.jpg",
49                "variant_ids": [
50                    12345678901
51                ],
52                "admin_graphql_api_id": "gid://shopify/ProductImage/23456789012"
53            }
54        ]
55    }
56}

Get product variant
Copy

Returns a product variant by ID

Sample Input

1{
2    "variant_id": 12345678,
3    "fields": [
4        "id",
5        "product_id",
6        "title",
7        "price",
8        "sku",
9        "inventory_quantity"
10    ]
11}

Sample Output

1{
2    "variant": {
3        "id": 12345678,
4        "product_id": 9876543,
5        "title": "Small / Blue",
6        "price": "29.99",
7        "sku": "PROD-BLU-S",
8        "inventory_quantity": 50
9    }
10}

Get shop configuration
Copy

Returns information about your shop.

Sample Input

1{}

Sample Output

1{
2    "shop": {
3        "id": 12345678,
4        "name": "My Awesome Shop",
5        "email": "owner@myawesomeshop.com",
6        "domain": "myawesomeshop.myshopify.com",
7        "province": "Ontario",
8        "country": "Canada",
9        "address1": "123 Main St",
10        "zip": "M5V 2T6",
11        "city": "Toronto",
12        "source": "shopify",
13        "phone": "+1 (555) 123-4567",
14        "latitude": 43.6532,
15        "longitude": -79.3832,
16        "primary_locale": "en",
17        "address2": "Suite 101",
18        "created_at": "2021-01-01T00:00:00Z",
19        "updated_at": "2023-04-15T12:30:45Z",
20        "country_code": "CA",
21        "country_name": "Canada",
22        "currency": "CAD",
23        "customer_email": "support@myawesomeshop.com",
24        "timezone": "(GMT-05:00) Eastern Time (ET)",
25        "iana_timezone": "America/Toronto",
26        "shop_owner": "Jane Doe",
27        "money_format": "${{amount}}",
28        "money_with_currency_format": "${{amount}} CAD",
29        "weight_unit": "kg",
30        "province_code": "ON",
31        "taxes_included": false,
32        "tax_shipping": true,
33        "county_taxes": false,
34        "plan_display_name": "Shopify",
35        "plan_name": "enterprise",
36        "has_discounts": true,
37        "has_gift_cards": true,
38        "myshopify_domain": "myawesomeshop.myshopify.com",
39        "money_in_emails_format": "${{amount}}",
40        "money_with_currency_in_emails_format": "${{amount}} CAD",
41        "eligible_for_payments": true,
42        "requires_extra_payments_agreement": false,
43        "password_enabled": false,
44        "has_storefront": true,
45        "eligible_for_card_reader_giveaway": false,
46        "finances": true,
47        "primary_location_id": 987654,
48        "cookie_consent_level": "implicit",
49        "visitor_tracking_consent_preference": "allow_all",
50        "checkout_api_supported": true,
51        "multi_location_enabled": true,
52        "setup_required": false,
53        "pre_launch_enabled": false,
54        "enabled_presentment_currencies": [
55            "CAD",
56            "USD",
57            "EUR"
58        ]
59    }
60}

List abandoned checkouts
Copy

Retrieve a list of abandoned checkouts.

Sample Input

1{
2    "created_at_min": "2023-05-01T00:00:00Z",
3    "created_at_max": "2023-05-31T23:59:59Z",
4    "status": "open",
5    "limit": 2
6}

Sample Output

1{
2    "checkouts": [
3        {
4            "id": 450789469,
5            "token": "b1946ac92492d2347c6235b4d2611184",
6            "cart_token": "68778783ad298f1c80c3bafcddeea02f",
7            "email": "john.doe@example.com",
8            "gateway": "stripe",
9            "buyer_accepts_marketing": true,
10            "created_at": "2023-05-15T10:00:00Z",
11            "updated_at": "2023-05-15T10:15:00Z",
12            "landing_site": "/products/summer-collection",
13            "note": "Please gift wrap",
14            "note_attributes": [
15                {
16                    "name": "Gift",
17                    "value": "Yes"
18                }
19            ],
20            "referring_site": "https://www.google.com",
21            "shipping_lines": [
22                {
23                    "code": "Standard",
24                    "price": "10.00",
25                    "title": "Standard Shipping",
26                    "source": "shopify"
27                }
28            ],
29            "taxes_included": false,
30            "total_weight": 1000,
31            "currency": "USD",
32            "completed_at": null,
33            "closed_at": null,
34            "user_id": null,
35            "location_id": null,
36            "source_identifier": null,
37            "source_url": null,
38            "device_id": null,
39            "phone": "+1234567890",
40            "customer_locale": "en-US",
41            "line_items": [
42                {
43                    "product_id": 632910392,
44                    "variant_id": 39072856,
45                    "title": "Summer T-Shirt",
46                    "variant_title": "Blue / Medium",
47                    "sku": "SUMM-TSHIRT-BLU-M",
48                    "vendor": "Summer Apparel",
49                    "quantity": 2,
50                    "price": "29.99",
51                    "grams": 200,
52                    "requires_shipping": true,
53                    "taxable": true,
54                    "gift_card": false,
55                    "fulfillment_service": "manual",
56                    "properties": null,
57                    "applied_discounts": [],
58                    "discount_allocations": []
59                }
60            ],
61            "name": "#ABC123",
62            "source": "web",
63            "abandoned_checkout_url": "https://shop.myshopify.com/cart/b1946ac92492d2347c6235b4d2611184",
64            "discount_codes": [],
65            "tax_lines": [
66                {
67                    "price": "6.00",
68                    "rate": 0.1,
69                    "title": "State Tax",
70                    "channel_liable": null
71                }
72            ],
73            "source_name": "web",
74            "presentment_currency": "USD",
75            "buyer_accepts_sms_marketing": false,
76            "sms_marketing_phone": null,
77            "total_discounts": "0.00",
78            "total_line_items_price": "59.98",
79            "total_price": "75.98",
80            "total_tax": "6.00",
81            "subtotal_price": "59.98",
82            "total_duties": "0.00",
83            "billing_address": {
84                "first_name": "John",
85                "last_name": "Doe",
86                "address1": "123 Billing St",
87                "city": "New York",
88                "province": "New York",
89                "country": "United States",
90                "zip": "10001",
91                "phone": "+1234567890",
92                "name": "John Doe",
93                "country_code": "US",
94                "province_code": "NY"
95            },
96            "shipping_address": {
97                "first_name": "John",
98                "last_name": "Doe",
99                "address1": "456 Shipping Ave",
100                "city": "New York",
101                "province": "New York",
102                "country": "United States",
103                "zip": "10002",
104                "phone": "+1234567890",
105                "name": "John Doe",
106                "country_code": "US",
107                "province_code": "NY"
108            },
109            "customer": {
110                "id": 4563774,
111                "email": "john.doe@example.com",
112                "created_at": "2023-01-01T00:00:00Z",
113                "updated_at": "2023-05-15T10:15:00Z",
114                "first_name": "John",
115                "last_name": "Doe",
116                "orders_count": 5,
117                "state": "enabled",
118                "total_spent": "500.00",
119                "last_order_id": 1234567890,
120                "note": "Loyal customer",
121                "verified_email": true,
122                "tax_exempt": false,
123                "tags": "VIP, repeat-customer",
124                "last_order_name": "#1000",
125                "currency": "USD",
126                "phone": "+1234567890",
127                "tax_exemptions": [],
128                "email_marketing_consent": {
129                    "state": "subscribed",
130                    "opt_in_level": "single_opt_in",
131                    "consent_updated_at": "2023-01-01T00:00:00Z"
132                },
133                "sms_marketing_consent": {
134                    "state": "not_subscribed",
135                    "opt_in_level": null,
136                    "consent_updated_at": null,
137                    "consent_collected_from": "OTHER"
138                },
139                "admin_graphql_api_id": "gid://shopify/Customer/4563774"
140            }
141        }
142    ]
143}

List collection products
Copy

Returns the products associated with a collection.

Sample Input

1{
2    "collection_id": 123456789,
3    "limit": 50
4}

Sample Output

1{
2    "products": [
3        {
4            "id": 1234567890,
5            "title": "Classic T-Shirt",
6            "body_html": "<p>A comfortable and stylish classic t-shirt.</p>",
7            "vendor": "Fashion Co.",
8            "product_type": "Apparel",
9            "created_at": "2023-05-01T10:00:00Z",
10            "handle": "classic-t-shirt",
11            "updated_at": "2023-05-15T14:30:00Z",
12            "published_at": "2023-05-02T09:00:00Z",
13            "template_suffix": null,
14            "published_scope": "web",
15            "tags": "cotton, casual, summer",
16            "admin_graphql_api_id": "gid://shopify/Product/1234567890",
17            "options": [
18                {
19                    "id": 1111111,
20                    "product_id": 1234567890,
21                    "name": "Size",
22                    "position": 1
23                },
24                {
25                    "id": 2222222,
26                    "product_id": 1234567890,
27                    "name": "Color",
28                    "position": 2
29                }
30            ],
31            "images": [
32                {
33                    "id": 11111111,
34                    "product_id": 1234567890,
35                    "position": 1,
36                    "created_at": "2023-05-01T10:05:00Z",
37                    "updated_at": "2023-05-01T10:05:00Z",
38                    "alt": "Classic T-Shirt - White",
39                    "width": 1000,
40                    "height": 1000,
41                    "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/classic-t-shirt-white.jpg",
42                    "variant_ids": [
43                        12345,
44                        12346
45                    ],
46                    "admin_graphql_api_id": "gid://shopify/ProductImage/11111111"
47                }
48            ],
49            "image": {
50                "id": 11111111,
51                "product_id": 1234567890,
52                "position": 1,
53                "created_at": "2023-05-01T10:05:00Z",
54                "updated_at": "2023-05-01T10:05:00Z",
55                "alt": "Classic T-Shirt - White",
56                "width": 1000,
57                "height": 1000,
58                "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/classic-t-shirt-white.jpg",
59                "variant_ids": [
60                    12345,
61                    12346
62                ],
63                "admin_graphql_api_id": "gid://shopify/ProductImage/11111111"
64            }
65        }
66    ],
67    "next_page": "eyJsYXN0X2lkIjoxMjM0NTY3ODkwLCJsYXN0X3ZhbHVlIjoiQ2xhc3NpYyBULVNoaXJ0In0=",
68    "previous_page": null
69}

List collects
Copy

Returns a shop's custom collections. NOTE: This operation no longer returns smart collections.

Sample Input

1{
2    "configuration": {
3        "since_id": 12345678
4    },
5    "fields": [
6        "collection_id",
7        "product_id",
8        "position"
9    ],
10    "limit": 50
11}

Sample Output

1{
2    "collects": [
3        {
4            "id": 12345679,
5            "collection_id": 987654,
6            "product_id": 123456,
7            "featured": false,
8            "created_at": "2023-05-01T10:00:00Z",
9            "updated_at": "2023-05-01T10:00:00Z",
10            "position": 1,
11            "sort_value": "0001"
12        },
13        {
14            "id": 12345680,
15            "collection_id": 987654,
16            "product_id": 123457,
17            "featured": true,
18            "created_at": "2023-05-01T10:05:00Z",
19            "updated_at": "2023-05-01T10:05:00Z",
20            "position": 2,
21            "sort_value": "0002"
22        }
23    ],
24    "next_page": "eyJsYXN0X2lkIjoxMjM0NTY4MCwibGFzdF92YWx1ZSI6IjAwMDIifQ=="
25}

List customers
Copy

Returns a list of customers.

Sample Input

1{
2    "configuration": {
3        "created_at_min": "2023-01-01T00:00:00Z",
4        "updated_at_max": "2023-06-30T23:59:59Z"
5    },
6    "fields": [
7        "id",
8        "email",
9        "first_name",
10        "last_name",
11        "orders_count",
12        "total_spent"
13    ],
14    "limit": 2
15}

Sample Output

1{
2    "customers": [
3        {
4            "id": 1234567890,
5            "email": "john.doe@example.com",
6            "first_name": "John",
7            "last_name": "Doe",
8            "orders_count": 5,
9            "total_spent": "543.21"
10        },
11        {
12            "id": 9876543210,
13            "email": "jane.smith@example.com",
14            "first_name": "Jane",
15            "last_name": "Smith",
16            "orders_count": 3,
17            "total_spent": "298.76"
18        }
19    ],
20    "next_page": "eyJsYXN0X2lkIjo5ODc2NTQzMjEwLCJsYXN0X3ZhbHVlIjoiSmFuZSJ9",
21    "previous_page": null
22}

List fulfillments for an Order by ID
Copy

Returns a list of fulfillments associated with an order.

Sample Input

1{
2    "order_id": 4495673524,
3    "configuration": {
4        "since_id": 3456789012,
5        "created_at_min": "2023-05-01T00:00:00Z",
6        "created_at_max": "2023-05-31T23:59:59Z"
7    },
8    "fields": [
9        "id",
10        "order_id",
11        "status",
12        "tracking_number",
13        "tracking_company"
14    ],
15    "limit": 2
16}

Sample Output

1{
2    "fulfillments": [
3        {
4            "id": 3456789013,
5            "order_id": 4495673524,
6            "status": "success",
7            "tracking_number": "1Z999AA1123456789",
8            "tracking_company": "UPS"
9        },
10        {
11            "id": 3456789014,
12            "order_id": 4495673524,
13            "status": "pending",
14            "tracking_number": "9405511202555594341442",
15            "tracking_company": "USPS"
16        }
17    ]
18}

List inventory items
Copy

Returns a list of inventory items.

Sample Input

1{
2    "configuration": {
3        "ids": [
4            123456789,
5            987654321
6        ]
7    },
8    "limit": 50
9}

Sample Output

1{
2    "inventory_items": [
3        {
4            "id": 123456789,
5            "sku": "PROD-001",
6            "created_at": "2023-05-01T10:00:00Z",
7            "updated_at": "2023-05-15T14:30:00Z",
8            "requires_shipping": true,
9            "cost": "15.99",
10            "country_code_of_origin": "US",
11            "province_code_of_origin": "CA",
12            "harmonized_system_code": "610910",
13            "tracked": true,
14            "country_harmonized_system_codes": [
15                "610910",
16                "610990"
17            ],
18            "admin_graphql_api_id": "gid://shopify/InventoryItem/123456789"
19        },
20        {
21            "id": 987654321,
22            "sku": "PROD-002",
23            "created_at": "2023-05-02T11:30:00Z",
24            "updated_at": "2023-05-16T09:45:00Z",
25            "requires_shipping": true,
26            "cost": "24.99",
27            "country_code_of_origin": "CN",
28            "province_code_of_origin": "GD",
29            "harmonized_system_code": "620342",
30            "tracked": true,
31            "country_harmonized_system_codes": [
32                "620342",
33                "620349"
34            ],
35            "admin_graphql_api_id": "gid://shopify/InventoryItem/987654321"
36        }
37    ],
38    "next_page": "eyJsYXN0X2lkIjo5ODc2NTQzMjEsImxhc3RfdmFsdWUiOiI5ODc2NTQzMjEifQ==",
39    "previous_page": null
40}

List inventory levels
Copy

Returns a list of inventory levels.

Sample Input

1{
2    "configuration": {
3        "location_ids": [
4            1234,
5            5678
6        ],
7        "inventory_item_ids": [
8            9876,
9            5432
10        ]
11    },
12    "limit": 50
13}

Sample Output

1{
2    "inventory_levels": [
3        {
4            "inventory_item_id": 9876,
5            "location_id": 1234,
6            "available": 100,
7            "updated_at": "2023-05-15T10:30:00Z",
8            "admin_graphql_api_id": "gid://shopify/InventoryLevel/1234?inventory_item_id=9876"
9        },
10        {
11            "inventory_item_id": 5432,
12            "location_id": 5678,
13            "available": 75,
14            "updated_at": "2023-05-14T15:45:00Z",
15            "admin_graphql_api_id": "gid://shopify/InventoryLevel/5678?inventory_item_id=5432"
16        }
17    ],
18    "next_page": "eyJsYXN0X2lkIjoxMjM0NTY3ODk=",
19    "previous_page": null
20}

List locations
Copy

Returns a list of locations.

Sample Input

1{}

Sample Output

1{
2    "locations": [
3        {
4            "id": 1234567890,
5            "name": "Main Store",
6            "address1": "123 Main Street",
7            "address2": "Suite 100",
8            "city": "New York",
9            "zip": "10001",
10            "province": "New York",
11            "country": "United States",
12            "phone": "+1 (212) 555-1234",
13            "created_at": "2023-01-15T09:00:00-05:00",
14            "updated_at": "2023-06-01T14:30:00-05:00",
15            "country_code": "US",
16            "country_name": "United States",
17            "province_code": "NY",
18            "legacy": false,
19            "active": true,
20            "admin_graphql_api_id": "gid://shopify/Location/1234567890",
21            "localized_country_name": "United States",
22            "localized_province_name": "New York"
23        },
24        {
25            "id": 9876543210,
26            "name": "Warehouse",
27            "address1": "456 Industrial Parkway",
28            "address2": null,
29            "city": "Chicago",
30            "zip": "60607",
31            "province": "Illinois",
32            "country": "United States",
33            "phone": "+1 (312) 555-6789",
34            "created_at": "2023-02-01T10:15:00-06:00",
35            "updated_at": "2023-05-15T11:45:00-06:00",
36            "country_code": "US",
37            "country_name": "United States",
38            "province_code": "IL",
39            "legacy": false,
40            "active": true,
41            "admin_graphql_api_id": "gid://shopify/Location/9876543210",
42            "localized_country_name": "United States",
43            "localized_province_name": "Illinois"
44        }
45    ]
46}

List metafields
Copy

Retrieve a list of metafields for a specified resource

Sample Input

1{
2    "resource_type": {
3        "type": "products",
4        "id": 4567890123
5    },
6    "namespace": "product_details",
7    "key": "material",
8    "type": "single_line_text_field",
9    "fields": [
10        "id",
11        "key",
12        "namespace",
13        "value"
14    ],
15    "limit": 10,
16    "since_id": 123456789,
17    "created_at_min": "2023-01-01T00:00:00Z",
18    "updated_at_max": "2023-06-30T23:59:59Z"
19}

Sample Output

1{
2    "metafields": [
3        {
4            "id": 123456790,
5            "key": "material",
6            "namespace": "product_details",
7            "value": "cotton"
8        },
9        {
10            "id": 123456791,
11            "key": "color",
12            "namespace": "product_details",
13            "value": "blue"
14        },
15        {
16            "id": 123456792,
17            "key": "size",
18            "namespace": "product_details",
19            "value": "medium"
20        }
21    ]
22}

List orders
Copy

Returns a list of orders.

Sample Input

1{
2    "configuration": {
3        "status": "open",
4        "financial_status": "paid",
5        "fulfillment_status": "shipped",
6        "created_at_min": "2023-01-01T00:00:00Z",
7        "created_at_max": "2023-12-31T23:59:59Z",
8        "updated_at_min": "2023-06-01T00:00:00Z",
9        "updated_at_max": "2023-06-30T23:59:59Z"
10    },
11    "fields": [
12        "id",
13        "email",
14        "created_at",
15        "total_price",
16        "financial_status",
17        "fulfillment_status"
18    ],
19    "limit": 10
20}

Sample Output

1{
2    "orders": [
3        {
4            "id": 4567890123,
5            "email": "customer@example.com",
6            "created_at": "2023-06-15T10:30:00Z",
7            "total_price": "129.99",
8            "financial_status": "paid",
9            "fulfillment_status": "shipped"
10        },
11        {
12            "id": 4567890124,
13            "email": "anothercustomer@example.com",
14            "created_at": "2023-06-16T14:45:00Z",
15            "total_price": "79.50",
16            "financial_status": "paid",
17            "fulfillment_status": "shipped"
18        }
19    ],
20    "next_page": "eyJsYXN0X2lkIjo0NTY3ODkwMTI0LCJsYXN0X3ZhbHVlIjoiMjAyMy0wNi0xNlQxNDo0NTowMFoifQ==",
21    "previous_page": null
22}

List product images
Copy

Returns a list of product images.

Sample Input

1{
2    "configuration": {
3        "product_id": 4378702671934
4    },
5    "fields": [
6        "id",
7        "product_id",
8        "position",
9        "src",
10        "width",
11        "height"
12    ],
13    "limit": 10
14}

Sample Output

1{
2    "images": [
3        {
4            "id": 31234567890,
5            "product_id": 4378702671934,
6            "position": 1,
7            "created_at": "2023-05-15T10:30:00-04:00",
8            "updated_at": "2023-05-15T10:30:00-04:00",
9            "alt": "Front view of blue t-shirt",
10            "width": 1000,
11            "height": 1000,
12            "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/blue-tshirt-front.jpg?v=1589234567",
13            "variant_ids": [
14                39987654321
15            ],
16            "admin_graphql_api_id": "gid://shopify/ProductImage/31234567890"
17        },
18        {
19            "id": 31234567891,
20            "product_id": 4378702671934,
21            "position": 2,
22            "created_at": "2023-05-15T10:31:00-04:00",
23            "updated_at": "2023-05-15T10:31:00-04:00",
24            "alt": "Back view of blue t-shirt",
25            "width": 1000,
26            "height": 1000,
27            "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/blue-tshirt-back.jpg?v=1589234568",
28            "variant_ids": [
29                39987654321
30            ],
31            "admin_graphql_api_id": "gid://shopify/ProductImage/31234567891"
32        }
33    ]
34}

List products
Copy

Returns a list of products.

Sample Input

1{
2    "configuration": {
3        "published_status": "published",
4        "vendor": "Nike",
5        "product_type": "Shoes",
6        "created_at_min": "2023-01-01T00:00:00Z",
7        "updated_at_max": "2023-06-30T23:59:59Z"
8    },
9    "fields": [
10        "id",
11        "title",
12        "vendor",
13        "product_type",
14        "variants",
15        "images"
16    ],
17    "limit": 2
18}

Sample Output

1{
2    "products": [
3        {
4            "id": 1234567890,
5            "title": "Air Max 270",
6            "vendor": "Nike",
7            "product_type": "Shoes",
8            "variants": [
9                {
10                    "id": 12345678901,
11                    "product_id": 1234567890,
12                    "title": "Air Max 270 - Black / Size 9",
13                    "price": "150.00",
14                    "sku": "AM270-BLK-9",
15                    "position": 1,
16                    "inventory_quantity": 50,
17                    "weight": 300,
18                    "weight_unit": "g"
19                },
20                {
21                    "id": 12345678902,
22                    "product_id": 1234567890,
23                    "title": "Air Max 270 - White / Size 10",
24                    "price": "150.00",
25                    "sku": "AM270-WHT-10",
26                    "position": 2,
27                    "inventory_quantity": 35,
28                    "weight": 300,
29                    "weight_unit": "g"
30                }
31            ],
32            "images": [
33                {
34                    "id": 11111111111,
35                    "product_id": 1234567890,
36                    "position": 1,
37                    "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/air-max-270-black.jpg",
38                    "width": 1000,
39                    "height": 1000
40                },
41                {
42                    "id": 22222222222,
43                    "product_id": 1234567890,
44                    "position": 2,
45                    "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/air-max-270-white.jpg",
46                    "width": 1000,
47                    "height": 1000
48                }
49            ]
50        },
51        {
52            "id": 2345678901,
53            "title": "React Infinity Run",
54            "vendor": "Nike",
55            "product_type": "Shoes",
56            "variants": [
57                {
58                    "id": 23456789012,
59                    "product_id": 2345678901,
60                    "title": "React Infinity Run - Blue / Size 8",
61                    "price": "160.00",
62                    "sku": "RIR-BLU-8",
63                    "position": 1,
64                    "inventory_quantity": 40,
65                    "weight": 280,
66                    "weight_unit": "g"
67                }
68            ],
69            "images": [
70                {
71                    "id": 33333333333,
72                    "product_id": 2345678901,
73                    "position": 1,
74                    "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/react-infinity-run-blue.jpg",
75                    "width": 1200,
76                    "height": 1200
77                }
78            ]
79        }
80    ],
81    "next_page": "eyJsYXN0X2lkIjoyMzQ1Njc4OTAxLCJsYXN0X3ZhbHVlIjoiUmVhY3QgSW5maW5pdHkgUnVuIn0="
82}

Open order
Copy

Opens an order.

Sample Input

1{
2    "order_id": 4495678901234
3}

Sample Output

1{
2    "order": {
3        "id": 4495678901234,
4        "admin_graphql_api_id": "gid://shopify/Order/4495678901234",
5        "app_id": 580111,
6        "browser_ip": "203.0.113.1",
7        "buyer_accepts_marketing": true,
8        "cancel_reason": null,
9        "cancelled_at": null,
10        "cart_token": "68778783ad298f1c80c3bafcddeea02f",
11        "checkout_id": 901234567890123,
12        "checkout_token": "bd5a8aa1ecd019dd3520ff791ee3a24c",
13        "client_details": {
14            "accept_language": "en-US,en;q=0.9",
15            "browser_height": "969",
16            "browser_ip": "203.0.113.1",
17            "browser_width": "1920",
18            "session_hash": "3b0dfbk72aj9j2ee05tl82j3ch",
19            "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
20        },
21        "closed_at": null,
22        "confirmed": true,
23        "contact_email": "john.doe@example.com",
24        "created_at": "2023-04-15T10:00:00-04:00",
25        "currency": "USD",
26        "current_subtotal_price": "199.00",
27        "current_subtotal_price_set": {
28            "shop_money": {
29                "amount": "199.00",
30                "currency_code": "USD"
31            },
32            "presentment_money": {
33                "amount": "199.00",
34                "currency_code": "USD"
35            }
36        },
37        "current_total_discounts": "0.00",
38        "current_total_price": "214.92",
39        "current_total_tax": "15.92",
40        "customer_locale": "en-US",
41        "email": "john.doe@example.com",
42        "financial_status": "paid",
43        "fulfillment_status": null,
44        "name": "#1001",
45        "note": null,
46        "number": 1,
47        "order_number": 1001,
48        "order_status_url": "https://shop.example.com/order/abcdefghijklmnop",
49        "payment_gateway_names": [
50            "shopify_payments"
51        ],
52        "phone": "+1-555-555-5555",
53        "presentment_currency": "USD",
54        "processed_at": "2023-04-15T10:00:00-04:00",
55        "subtotal_price": "199.00",
56        "tags": "",
57        "tax_lines": [
58            {
59                "price": "15.92",
60                "rate": 0.08,
61                "title": "State Tax"
62            }
63        ],
64        "taxes_included": false,
65        "test": false,
66        "token": "abcdefghijklmnopqrstuvwxyz01234",
67        "total_discounts": "0.00",
68        "total_line_items_price": "199.00",
69        "total_outstanding": "0.00",
70        "total_price": "214.92",
71        "total_tax": "15.92",
72        "total_tip_received": "0.00",
73        "total_weight": 500,
74        "updated_at": "2023-04-15T10:05:00-04:00",
75        "user_id": null,
76        "billing_address": {
77            "first_name": "John",
78            "address1": "123 Billing St",
79            "phone": "555-555-5555",
80            "city": "Billingsville",
81            "zip": "12345",
82            "province": "NY",
83            "country": "United States",
84            "last_name": "Doe",
85            "address2": null,
86            "company": "ACME Inc",
87            "latitude": 40.7128,
88            "longitude": -74.006,
89            "name": "John Doe",
90            "country_code": "US",
91            "province_code": "NY"
92        },
93        "customer": {
94            "id": 5678901234,
95            "email": "john.doe@example.com",
96            "created_at": "2023-01-01T00:00:00-05:00",
97            "updated_at": "2023-04-15T10:00:00-04:00",
98            "first_name": "John",
99            "last_name": "Doe",
100            "state": "enabled",
101            "note": null,
102            "verified_email": true,
103            "tax_exempt": false,
104            "phone": "+1-555-555-5555",
105            "tags": "",
106            "currency": "USD"
107        },
108        "line_items": [
109            {
110                "id": 8901234567890,
111                "admin_graphql_api_id": "gid://shopify/LineItem/8901234567890",
112                "fulfillable_quantity": 1,
113                "fulfillment_service": "manual",
114                "fulfillment_status": null,
115                "gift_card": false,
116                "grams": 500,
117                "name": "Example Product",
118                "price": "199.00",
119                "price_set": {
120                    "shop_money": {
121                        "amount": "199.00",
122                        "currency_code": "USD"
123                    },
124                    "presentment_money": {
125                        "amount": "199.00",
126                        "currency_code": "USD"
127                    }
128                },
129                "product_exists": true,
130                "product_id": 6789012345,
131                "properties": [],
132                "quantity": 1,
133                "requires_shipping": true,
134                "sku": "EXAMPLE-SKU-123",
135                "taxable": true,
136                "title": "Example Product",
137                "total_discount": "0.00",
138                "variant_id": 40987654321,
139                "variant_title": null,
140                "vendor": "Example Vendor"
141            }
142        ],
143        "shipping_address": {
144            "first_name": "John",
145            "address1": "123 Shipping St",
146            "phone": "555-555-5555",
147            "city": "Shippingville",
148            "zip": "54321",
149            "province": "NY",
150            "country": "United States",
151            "last_name": "Doe",
152            "address2": null,
153            "company": null,
154            "latitude": 40.7128,
155            "longitude": -74.006,
156            "name": "John Doe",
157            "country_code": "US",
158            "province_code": "NY"
159        },
160        "shipping_lines": [
161            {
162                "id": 3456789012,
163                "carrier_identifier": "fedex",
164                "code": "FedEx Ground",
165                "delivery_category": null,
166                "discounted_price": "0.00",
167                "phone": null,
168                "price": "0.00",
169                "source": "shopify",
170                "title": "FedEx Ground"
171            }
172        ]
173    }
174}

Search customers
Copy

Returns a list of customers matching the search query.

Sample Input

1{
2    "configuration": {
3        "query": "John country:Canada",
4        "sort_by": "last_order_date",
5        "sort_order": "DESC"
6    },
7    "fields": [
8        "id",
9        "email",
10        "first_name",
11        "last_name",
12        "state",
13        "tags"
14    ],
15    "limit": 2
16}

Sample Output

1{
2    "customers": [
3        {
4            "id": 4563217890,
5            "email": "john.doe@example.com",
6            "first_name": "John",
7            "last_name": "Doe",
8            "state": "enabled",
9            "tags": "VIP, repeat customer"
10        },
11        {
12            "id": 4563217891,
13            "email": "john.smith@example.com",
14            "first_name": "John",
15            "last_name": "Smith",
16            "state": "enabled",
17            "tags": "new customer"
18        }
19    ],
20    "next_page": "eyJsYXN0X2lkIjo0NTYzMjE3ODkxLCJsYXN0X3ZhbHVlIjoiMjAyMy0wNS0xNVQxNDozMDowMC0wNDowMCJ9",
21    "previous_page": null
22}

Send account invite
Copy

Sends an account invite to a customer.

Sample Input

1{
2    "customer_id": 4495743123,
3    "from": "store@example.com",
4    "to": "newcustomer@example.com",
5    "bcc": [
6        "manager@example.com",
7        "support@example.com"
8    ],
9    "subject": "Welcome to Our Store - Activate Your Account",
10    "custom_message": "We're excited to have you join our community! Click the link below to activate your account and start shopping."
11}

Sample Output

1{
2    "customer_invite": {
3        "to": "newcustomer@example.com",
4        "from": "store@example.com",
5        "subject": "Welcome to Our Store - Activate Your Account",
6        "custom_message": "We're excited to have you join our community! Click the link below to activate your account and start shopping.",
7        "bcc": [
8            "manager@example.com",
9            "support@example.com"
10        ]
11    }
12}

Send draft order invoice
Copy

Send an invoice for the draft order.

Sample Input

1{
2    "draft_order_id": 123456789,
3    "to": "customer@example.com",
4    "from": "sales@myshop.com",
5    "bcc": [
6        "manager@myshop.com",
7        "accounting@myshop.com"
8    ],
9    "subject": "Your Draft Order Invoice from MyShop",
10    "custom_message": "Thank you for your order! Please find your invoice attached. If you have any questions, don't hesitate to contact us."
11}

Sample Output

1{
2    "draft_order_invoice": {
3        "to": "customer@example.com",
4        "from": "sales@myshop.com",
5        "subject": "Your Draft Order Invoice from MyShop",
6        "custom_message": "Thank you for your order! Please find your invoice attached. If you have any questions, don't hesitate to contact us.",
7        "bcc": [
8            "manager@myshop.com",
9            "accounting@myshop.com"
10        ]
11    }
12}

Update customer
Copy

Updates a new customer.

Sample Input

1{
2    "customer_id": 4366245384,
3    "first_name": "John",
4    "last_name": "Doe",
5    "email": "john.doe@example.com",
6    "phone": "+1-555-123-4567",
7    "verified_email": true,
8    "addresses": [
9        {
10            "address1": "123 Main St",
11            "address2": "Apt 4B",
12            "city": "New York",
13            "province": "New York",
14            "country": "United States",
15            "zip": "10001",
16            "phone": "+1-555-987-6543",
17            "default": true
18        }
19    ],
20    "currency": "USD",
21    "note": "Preferred customer",
22    "tags": [
23        "VIP",
24        "Loyalty Program"
25    ],
26    "tax_exempt": false
27}

Sample Output

1{
2    "customer": {
3        "id": 4366245384,
4        "email": "john.doe@example.com",
5        "first_name": "John",
6        "last_name": "Doe",
7        "phone": "+1-555-123-4567",
8        "verified_email": true,
9        "created_at": "2023-05-01T10:00:00-04:00",
10        "updated_at": "2023-05-15T14:30:00-04:00",
11        "orders_count": 5,
12        "state": "enabled",
13        "total_spent": "1250.00",
14        "last_order_id": 1234567890,
15        "note": "Preferred customer",
16        "tax_exempt": false,
17        "tags": "VIP, Loyalty Program",
18        "last_order_name": "#1001",
19        "currency": "USD",
20        "addresses": [
21            {
22                "id": 5678901234,
23                "customer_id": 4366245384,
24                "first_name": "John",
25                "last_name": "Doe",
26                "address1": "123 Main St",
27                "address2": "Apt 4B",
28                "city": "New York",
29                "province": "New York",
30                "country": "United States",
31                "zip": "10001",
32                "phone": "+1-555-987-6543",
33                "name": "John Doe",
34                "province_code": "NY",
35                "country_code": "US",
36                "country_name": "United States",
37                "default": true
38            }
39        ],
40        "tax_exemptions": [],
41        "email_marketing_consent": {
42            "state": "subscribed",
43            "opt_in_level": "single_opt_in",
44            "consent_updated_at": "2023-05-15T14:30:00-04:00"
45        },
46        "sms_marketing_consent": {
47            "state": "not_subscribed",
48            "opt_in_level": "single_opt_in",
49            "consent_updated_at": null,
50            "consent_collected_from": "OTHER"
51        },
52        "admin_graphql_api_id": "gid://shopify/Customer/4366245384",
53        "default_address": {
54            "id": 5678901234,
55            "customer_id": 4366245384,
56            "first_name": "John",
57            "last_name": "Doe",
58            "address1": "123 Main St",
59            "address2": "Apt 4B",
60            "city": "New York",
61            "province": "New York",
62            "country": "United States",
63            "zip": "10001",
64            "phone": "+1-555-987-6543",
65            "name": "John Doe",
66            "province_code": "NY",
67            "country_code": "US",
68            "country_name": "United States",
69            "default": true
70        }
71    }
72}

Update draft order
Copy

Update a draft order.

Sample Input

1{
2    "draft_order_id": 123456789,
3    "draft_order_line_items": [
4        {
5            "variant_id": 987654321,
6            "quantity": 2
7        },
8        {
9            "title": "Custom T-Shirt",
10            "price": "29.99",
11            "quantity": 1,
12            "grams": 200,
13            "sku": "CTS-001",
14            "taxable": true,
15            "requires_shipping": true,
16            "applied_discount": {
17                "value_type": "percentage",
18                "value": "10",
19                "description": "Summer Sale",
20                "title": "10% Off"
21            },
22            "properties": [
23                {
24                    "name": "Color",
25                    "value": "Blue"
26                },
27                {
28                    "name": "Size",
29                    "value": "Large"
30                }
31            ]
32        }
33    ],
34    "applied_discount": {
35        "value_type": "fixed_amount",
36        "value": "5.00",
37        "description": "Loyalty Discount",
38        "title": "$5 Off"
39    },
40    "customer": {
41        "id": "9876543210"
42    },
43    "shipping_line": {
44        "title": "Standard Shipping",
45        "price": "9.99"
46    },
47    "note": "Please gift wrap the items."
48}

Sample Output

1{
2    "draft_order": {
3        "id": 123456789,
4        "note": "Please gift wrap the items.",
5        "email": "customer@example.com",
6        "taxes_included": false,
7        "currency": "USD",
8        "invoice_sent_at": null,
9        "created_at": "2023-06-15T10:00:00Z",
10        "updated_at": "2023-06-15T10:15:00Z",
11        "tax_exempt": false,
12        "completed_at": null,
13        "name": "#D123",
14        "status": "open",
15        "line_items": [
16            {
17                "id": 1122334455,
18                "variant_id": "987654321",
19                "product_id": "112233",
20                "title": "Sample Product",
21                "variant_title": "Blue / Large",
22                "sku": "SP-001-BL",
23                "vendor": "Sample Vendor",
24                "quantity": 2,
25                "requires_shipping": true,
26                "taxable": true,
27                "gift_card": false,
28                "fulfillment_service": "manual",
29                "grams": 400,
30                "tax_lines": [],
31                "applied_discount": null,
32                "name": "Sample Product - Blue / Large",
33                "properties": [],
34                "custom": false,
35                "price": "49.99",
36                "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/1122334455"
37            },
38            {
39                "id": 2233445566,
40                "variant_id": null,
41                "product_id": null,
42                "title": "Custom T-Shirt",
43                "variant_title": null,
44                "sku": "CTS-001",
45                "vendor": null,
46                "quantity": 1,
47                "requires_shipping": true,
48                "taxable": true,
49                "gift_card": false,
50                "fulfillment_service": "manual",
51                "grams": 200,
52                "tax_lines": [],
53                "applied_discount": {
54                    "description": "Summer Sale",
55                    "value": "10",
56                    "title": "10% Off",
57                    "amount": "3.00",
58                    "value_type": "percentage"
59                },
60                "name": "Custom T-Shirt",
61                "properties": [
62                    {
63                        "name": "Color",
64                        "value": "Blue"
65                    },
66                    {
67                        "name": "Size",
68                        "value": "Large"
69                    }
70                ],
71                "custom": true,
72                "price": "29.99",
73                "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2233445566"
74            }
75        ],
76        "shipping_address": {
77            "first_name": "John",
78            "last_name": "Doe",
79            "address1": "123 Main St",
80            "address2": "",
81            "city": "Anytown",
82            "province": "State",
83            "country": "United States",
84            "zip": "12345",
85            "phone": "555-123-4567",
86            "name": "John Doe",
87            "country_code": "US",
88            "province_code": "ST"
89        },
90        "billing_address": {
91            "first_name": "John",
92            "last_name": "Doe",
93            "address1": "123 Main St",
94            "address2": "",
95            "city": "Anytown",
96            "province": "State",
97            "country": "United States",
98            "zip": "12345",
99            "phone": "555-123-4567",
100            "name": "John Doe",
101            "country_code": "US",
102            "province_code": "ST"
103        },
104        "invoice_url": "https://shop.myshopify.com/draft_orders/123456789/invoice",
105        "applied_discount": {
106            "description": "Loyalty Discount",
107            "value": "5.00",
108            "title": "$5 Off",
109            "amount": "5.00",
110            "value_type": "fixed_amount"
111        },
112        "order_id": null,
113        "shipping_line": {
114            "title": "Standard Shipping",
115            "custom": true,
116            "handle": null,
117            "price": "9.99"
118        },
119        "tax_lines": [
120            {
121                "title": "State Tax",
122                "price": "10.50",
123                "rate": 0.06,
124                "channel_liable": false
125            }
126        ],
127        "tags": "",
128        "note_attributes": [],
129        "total_price": "137.96",
130        "subtotal_price": "122.47",
131        "total_tax": "10.50",
132        "admin_graphql_api_id": "gid://shopify/DraftOrder/123456789",
133        "customer": {
134            "id": 9876543210,
135            "email": "customer@example.com",
136            "created_at": "2023-01-01T00:00:00Z",
137            "updated_at": "2023-06-15T10:15:00Z",
138            "first_name": "John",
139            "last_name": "Doe",
140            "orders_count": 5,
141            "state": "enabled",
142            "total_spent": "500.00",
143            "last_order_id": 11223344,
144            "note": "",
145            "verified_email": true,
146            "multipass_identifier": null,
147            "tax_exempt": false,
148            "tags": "",
149            "last_order_name": "#1001",
150            "currency": "USD",
151            "phone": "555-123-4567",
152            "tax_exemptions": [],
153            "email_marketing_consent": {
154                "state": "subscribed",
155                "opt_in_level": "single_opt_in",
156                "consent_updated_at": "2023-01-01T00:00:00Z"
157            },
158            "sms_marketing_consent": null,
159            "admin_graphql_api_id": "gid://shopify/Customer/9876543210"
160        }
161    }
162}

Update fulfillment tracking information
Copy

Updates tracking information for a fulfillment.

Sample Input

1{
2    "fulfillment_id": 1234567890,
3    "notify_customer": true,
4    "tracking_company": "FedEx",
5    "tracking_number": "1234567890123456",
6    "tracking_url": "https://www.fedex.com/tracking?tracknumbers=1234567890123456"
7}

Sample Output

1{
2    "fulfillment": {
3        "id": 1234567890,
4        "order_id": 9876543210,
5        "status": "success",
6        "created_at": "2023-05-15T10:00:00Z",
7        "service": "manual",
8        "updated_at": "2023-05-15T10:30:00Z",
9        "tracking_company": "FedEx",
10        "tracking_number": "1234567890123456",
11        "tracking_numbers": [
12            "1234567890123456"
13        ],
14        "tracking_url": "https://www.fedex.com/tracking?tracknumbers=1234567890123456",
15        "tracking_urls": [
16            "https://www.fedex.com/tracking?tracknumbers=1234567890123456"
17        ],
18        "name": "#1001.1",
19        "location_id": 987654,
20        "origin_address": {
21            "address1": "123 Warehouse St",
22            "address2": "",
23            "city": "Anytown",
24            "province_code": "CA",
25            "country_code": "US",
26            "zip": "12345"
27        },
28        "line_items": [
29            {
30                "id": 1122334455,
31                "variant_id": 2233445566,
32                "title": "Sample Product",
33                "quantity": 1,
34                "sku": "SAMPLE-001",
35                "variant_title": "Blue / Large",
36                "vendor": "Sample Vendor",
37                "fulfillment_service": "manual",
38                "product_id": 3344556677,
39                "requires_shipping": true,
40                "taxable": true,
41                "gift_card": false,
42                "name": "Sample Product - Blue / Large",
43                "variant_inventory_management": "shopify",
44                "properties": [],
45                "product_exists": true,
46                "fulfillable_quantity": 1,
47                "grams": 500,
48                "price": "49.99",
49                "total_discount": "0.00",
50                "fulfillment_status": "fulfilled",
51                "price_set": {
52                    "shop_money": {
53                        "amount": "49.99",
54                        "currency_code": "USD"
55                    },
56                    "presentment_money": {
57                        "amount": "49.99",
58                        "currency_code": "USD"
59                    }
60                },
61                "total_discount_set": {
62                    "shop_money": {
63                        "amount": "0.00",
64                        "currency_code": "USD"
65                    },
66                    "presentment_money": {
67                        "amount": "0.00",
68                        "currency_code": "USD"
69                    }
70                },
71                "discount_allocations": [],
72                "duties": [],
73                "admin_graphql_api_id": "gid://shopify/LineItem/1122334455",
74                "tax_lines": []
75            }
76        ],
77        "receipt": {},
78        "admin_graphql_api_id": "gid://shopify/Fulfillment/1234567890"
79    }
80}

Update inventory item
Copy

Updates an existing inventory item.

Sample Input

1{
2    "inventory_item_id": 12345678,
3    "sku": "PROD-001-BLU",
4    "created_at": "2023-05-15T10:00:00Z",
5    "updated_at": "2023-05-20T14:30:00Z",
6    "requires_shipping": true,
7    "cost": "15.99",
8    "tracked": true
9}

Sample Output

1{
2    "inventory_item": {
3        "id": 12345678,
4        "sku": "PROD-001-BLU",
5        "created_at": "2023-05-15T10:00:00Z",
6        "updated_at": "2023-05-20T14:30:00Z",
7        "requires_shipping": true,
8        "cost": "15.99",
9        "country_code_of_origin": "US",
10        "province_code_of_origin": "CA",
11        "harmonized_system_code": 610910,
12        "tracked": true,
13        "country_harmonized_system_codes": [
14            {
15                "country_code": "US",
16                "harmonized_system_code": "6109.10.0000"
17            }
18        ],
19        "admin_graphql_api_id": "gid://shopify/InventoryItem/12345678"
20    }
21}

Update inventory level
Copy

Updates a new inventory level of an inventory item at a single location.

Sample Input

1{
2    "inventory_item_id": 12345678,
3    "location_id": 987654,
4    "available_adjustment": 10
5}

Sample Output

1{
2    "inventory_level": {
3        "inventory_item_id": 12345678,
4        "location_id": 987654,
5        "available": 110,
6        "updated_at": "2023-05-15T14:30:22Z",
7        "admin_graphql_api_id": "gid://shopify/InventoryLevel/12345678?location_id=987654"
8    }
9}

Update metafield
Copy

Updates a metafield specified by ID

Sample Input

1{
2    "resource_type": {
3        "type": "products",
4        "id": 4567890123
5    },
6    "metafield_id": 987654321,
7    "type_and_value": {
8        "single_line_text_field": "Updated product information"
9    },
10    "description": "Additional product details"
11}

Sample Output

1{
2    "metafield": {
3        "id": 987654321,
4        "namespace": "custom",
5        "key": "product_info",
6        "value": "Updated product information",
7        "description": "Additional product details",
8        "owner_id": 4567890123,
9        "created_at": "2023-06-15T10:00:00-04:00",
10        "updated_at": "2023-06-15T14:30:00-04:00",
11        "owner_resource": "product",
12        "admin_graphql_api_id": "gid://shopify/Metafield/987654321"
13    }
14}

Update order
Copy

Updates an order.

Sample Input

1{
2    "order_id": 4495656534198,
3    "email": "john.doe@example.com",
4    "phone": "+1-555-123-4567",
5    "note": "Please gift wrap the items.",
6    "tags": [
7        "VIP",
8        "Repeat Customer"
9    ],
10    "shipping_address": {
11        "first_name": "John",
12        "last_name": "Doe",
13        "address1": "123 Main St",
14        "city": "Anytown",
15        "province": "California",
16        "country": "United States",
17        "zip": "12345",
18        "phone": "+1-555-987-6543"
19    },
20    "metafields": [
21        {
22            "namespace": "custom",
23            "key": "gift_message",
24            "type_and_value": {
25                "single_line_text_field": "Happy Birthday!"
26            },
27            "description": "Gift message for the order"
28        }
29    ]
30}

Sample Output

1{
2    "order": {
3        "id": 4495656534198,
4        "email": "john.doe@example.com",
5        "closed_at": null,
6        "created_at": "2023-04-20T15:30:00-04:00",
7        "updated_at": "2023-04-20T15:35:00-04:00",
8        "number": 1001,
9        "note": "Please gift wrap the items.",
10        "token": "abcdef123456",
11        "gateway": "shopify_payments",
12        "total_price": "100.00",
13        "subtotal_price": "90.00",
14        "total_tax": "10.00",
15        "currency": "USD",
16        "financial_status": "paid",
17        "confirmed": true,
18        "total_discounts": "0.00",
19        "total_line_items_price": "90.00",
20        "cart_token": "abc123def456",
21        "buyer_accepts_marketing": false,
22        "name": "#1001",
23        "referring_site": "",
24        "landing_site": "/",
25        "cancelled_at": null,
26        "cancel_reason": null,
27        "total_price_usd": "100.00",
28        "checkout_token": "xyz789",
29        "reference": null,
30        "user_id": null,
31        "location_id": null,
32        "source_identifier": null,
33        "source_url": null,
34        "processed_at": "2023-04-20T15:30:00-04:00",
35        "device_id": null,
36        "phone": "+1-555-123-4567",
37        "customer_locale": "en-US",
38        "line_items": [
39            {
40                "id": 10721928782006,
41                "variant_id": 39072856121526,
42                "title": "Sample Product",
43                "quantity": 1,
44                "sku": "SAMPLE001",
45                "variant_title": null,
46                "vendor": "Sample Vendor",
47                "fulfillment_service": "manual",
48                "product_id": 6164751573158,
49                "requires_shipping": true,
50                "taxable": true,
51                "gift_card": false,
52                "name": "Sample Product",
53                "variant_inventory_management": "shopify",
54                "properties": [],
55                "product_exists": true,
56                "fulfillable_quantity": 1,
57                "grams": 200,
58                "price": "90.00",
59                "total_discount": "0.00",
60                "fulfillment_status": null
61            }
62        ],
63        "shipping_lines": [
64            {
65                "id": 3270942613686,
66                "title": "Standard Shipping",
67                "price": "10.00",
68                "code": "Standard",
69                "source": "shopify",
70                "phone": null,
71                "carrier_identifier": null,
72                "requested_fulfillment_service_id": null
73            }
74        ],
75        "billing_address": {
76            "first_name": "John",
77            "address1": "123 Main St",
78            "phone": "+1-555-987-6543",
79            "city": "Anytown",
80            "zip": "12345",
81            "province": "California",
82            "country": "United States",
83            "last_name": "Doe",
84            "address2": null,
85            "company": null,
86            "latitude": 40.7128,
87            "longitude": -74.006,
88            "name": "John Doe",
89            "country_code": "US",
90            "province_code": "CA"
91        },
92        "shipping_address": {
93            "first_name": "John",
94            "address1": "123 Main St",
95            "phone": "+1-555-987-6543",
96            "city": "Anytown",
97            "zip": "12345",
98            "province": "California",
99            "country": "United States",
100            "last_name": "Doe",
101            "address2": null,
102            "company": null,
103            "latitude": 40.7128,
104            "longitude": -74.006,
105            "name": "John Doe",
106            "country_code": "US",
107            "province_code": "CA"
108        },
109        "fulfillments": [],
110        "client_details": {
111            "browser_ip": "192.0.2.1",
112            "accept_language": "en-US,en;q=0.9",
113            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36",
114            "session_hash": null,
115            "browser_width": null,
116            "browser_height": null
117        },
118        "refunds": [],
119        "payment_details": {
120            "credit_card_bin": "424242",
121            "avs_result_code": null,
122            "cvv_result_code": null,
123            "credit_card_number": "•••• •••• •••• 4242",
124            "credit_card_company": "Visa"
125        },
126        "customer": {
127            "id": 5301472485558,
128            "email": "john.doe@example.com",
129            "accepts_marketing": false,
130            "created_at": "2023-04-20T15:30:00-04:00",
131            "updated_at": "2023-04-20T15:35:00-04:00",
132            "first_name": "John",
133            "last_name": "Doe",
134            "orders_count": 1,
135            "state": "disabled",
136            "total_spent": "100.00",
137            "last_order_id": 4495656534198,
138            "note": null,
139            "verified_email": true,
140            "multipass_identifier": null,
141            "tax_exempt": false,
142            "phone": "+1-555-123-4567",
143            "tags": "VIP, Repeat Customer",
144            "last_order_name": "#1001",
145            "currency": "USD",
146            "accepts_marketing_updated_at": "2023-04-20T15:30:00-04:00"
147        },
148        "tags": "VIP, Repeat Customer",
149        "metafields": [
150            {
151                "id": 20710700212406,
152                "namespace": "custom",
153                "key": "gift_message",
154                "value": "Happy Birthday!",
155                "type": "single_line_text_field",
156                "description": "Gift message for the order"
157            }
158        ]
159    }
160}

Update product
Copy

Updates a product.

Sample Input

1{
2    "product_id": 1234567890,
3    "title_update": "Updated T-Shirt",
4    "vendor": "Fashion Co.",
5    "product_type": "Apparel",
6    "body_html": "<p>A comfortable and stylish t-shirt made from 100% organic cotton.</p>",
7    "add_tags": [
8        "summer",
9        "casual",
10        "eco-friendly"
11    ],
12    "published": true,
13    "published_at": "2023-06-15T10:00:00Z",
14    "template_suffix": "special-product",
15    "options": [
16        {
17            "name": "Size",
18            "values": [
19                "S",
20                "M",
21                "L",
22                "XL"
23            ]
24        },
25        {
26            "name": "Color",
27            "values": [
28                "White",
29                "Black",
30                "Blue"
31            ]
32        }
33    ],
34    "variants": [
35        {
36            "option1": "S",
37            "option2": "White",
38            "price": 29.99,
39            "compare_at_price": "34.99",
40            "sku": "TS-SW-001",
41            "inventory_management": "shopify",
42            "inventory_policy": "deny",
43            "weight": 200,
44            "weight_unit": "g"
45        }
46    ],
47    "metafields": [
48        {
49            "namespace": "custom",
50            "key": "material",
51            "type_and_value": {
52                "single_line_text_field": "100% Organic Cotton"
53            },
54            "description": "Material composition of the product"
55        }
56    ]
57}

Sample Output

1{
2    "product": {
3        "id": 1234567890,
4        "title": "Updated T-Shirt",
5        "body_html": "<p>A comfortable and stylish t-shirt made from 100% organic cotton.</p>",
6        "vendor": "Fashion Co.",
7        "product_type": "Apparel",
8        "created_at": "2023-06-01T09:00:00Z",
9        "handle": "updated-t-shirt",
10        "updated_at": "2023-06-15T10:05:00Z",
11        "published_at": "2023-06-15T10:00:00Z",
12        "template_suffix": "special-product",
13        "status": "active",
14        "published_scope": "web",
15        "tags": "summer, casual, eco-friendly",
16        "admin_graphql_api_id": "gid://shopify/Product/1234567890",
17        "variants": [
18            {
19                "id": 12345678901,
20                "product_id": 1234567890,
21                "title": "S / White",
22                "price": "29.99",
23                "sku": "TS-SW-001",
24                "position": 1,
25                "inventory_policy": "deny",
26                "compare_at_price": "34.99",
27                "fulfillment_service": "manual",
28                "inventory_management": "shopify",
29                "option1": "S",
30                "option2": "White",
31                "option3": null,
32                "created_at": "2023-06-01T09:00:00Z",
33                "updated_at": "2023-06-15T10:05:00Z",
34                "taxable": true,
35                "barcode": null,
36                "grams": 200,
37                "image_id": null,
38                "weight": 200,
39                "weight_unit": "g",
40                "inventory_item_id": 123456789012,
41                "inventory_quantity": 50,
42                "old_inventory_quantity": 50,
43                "requires_shipping": true,
44                "admin_graphql_api_id": "gid://shopify/ProductVariant/12345678901"
45            }
46        ],
47        "options": [
48            {
49                "id": 1234567,
50                "product_id": 1234567890,
51                "name": "Size",
52                "position": 1,
53                "values": [
54                    "S",
55                    "M",
56                    "L",
57                    "XL"
58                ]
59            },
60            {
61                "id": 1234568,
62                "product_id": 1234567890,
63                "name": "Color",
64                "position": 2,
65                "values": [
66                    "White",
67                    "Black",
68                    "Blue"
69                ]
70            }
71        ],
72        "images": [],
73        "image": null
74    }
75}

Update product variant
Copy

Update product variant. Please note that in order to use this operation, the variant options must already be defined on the product.

Sample Input

1{
2    "variant_id": 12345678,
3    "option1": "Large",
4    "option2": "Blue",
5    "option3": "Cotton",
6    "price": 29.99,
7    "compare_at_price": "39.99",
8    "barcode": "978-3-16-148410-0",
9    "fulfillment_service": "manual",
10    "sku": "LRGBLU-COT-001",
11    "taxable": true,
12    "tax_code": "P0000000",
13    "weight_unit": "kg",
14    "weight": 0.5,
15    "image_id": 87654321,
16    "inventory_management": "shopify",
17    "inventory_policy": "deny"
18}

Sample Output

1{
2    "variant": {
3        "id": 12345678,
4        "product_id": 98765432,
5        "title": "T-Shirt - Large / Blue / Cotton",
6        "price": "29.99",
7        "sku": "LRGBLU-COT-001",
8        "position": 1,
9        "inventory_policy": "deny",
10        "compare_at_price": "39.99",
11        "fulfillment_service": "manual",
12        "inventory_management": "shopify",
13        "option1": "Large",
14        "option2": "Blue",
15        "option3": "Cotton",
16        "created_at": "2023-05-15T10:00:00-04:00",
17        "updated_at": "2023-05-15T14:30:00-04:00",
18        "taxable": true,
19        "barcode": "978-3-16-148410-0",
20        "grams": 500,
21        "weight": 0.5,
22        "weight_unit": "kg",
23        "inventory_item_id": 123456789,
24        "inventory_quantity": 100,
25        "old_inventory_quantity": 100,
26        "requires_shipping": true,
27        "admin_graphql_api_id": "gid://shopify/ProductVariant/12345678",
28        "image_id": "87654321"
29    }
30}

DDL operations
Copy

List countries (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1{}

Sample Output

1[
2    {
3        "id": 359115382,
4        "name": "United States",
5        "code": "US",
6        "tax_name": "Federal Tax",
7        "tax": 0,
8        "provinces": [
9            {
10                "id": 879921427,
11                "country_id": 359115382,
12                "name": "California",
13                "code": "CA",
14                "tax_name": "State Tax",
15                "tax_type": null,
16                "shipping_zone_id": null,
17                "tax": 8.25,
18                "tax_percentage": 8.25
19            },
20            {
21                "id": 879921428,
22                "country_id": 359115382,
23                "name": "New York",
24                "code": "NY",
25                "tax_name": "State Tax",
26                "tax_type": null,
27                "shipping_zone_id": null,
28                "tax": 8.875,
29                "tax_percentage": 8.875
30            }
31        ]
32    },
33    {
34        "id": 359115383,
35        "name": "Canada",
36        "code": "CA",
37        "tax_name": "GST",
38        "tax": 5,
39        "provinces": [
40            {
41                "id": 879921429,
42                "country_id": 359115383,
43                "name": "Ontario",
44                "code": "ON",
45                "tax_name": "HST",
46                "tax_type": null,
47                "shipping_zone_id": null,
48                "tax": 13,
49                "tax_percentage": 13
50            },
51            {
52                "id": 879921430,
53                "country_id": 359115383,
54                "name": "British Columbia",
55                "code": "BC",
56                "tax_name": "PST",
57                "tax_type": null,
58                "shipping_zone_id": null,
59                "tax": 7,
60                "tax_percentage": 7
61            }
62        ]
63    }
64]

List customers (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1{}

Sample Output

1{
2    "customers": [
3        {
4            "id": 1234567890,
5            "email": "johndoe@example.com",
6            "first_name": "John",
7            "last_name": "Doe",
8            "phone": "+1-555-123-4567",
9            "accepts_marketing": true,
10            "created_at": "2023-05-01T10:00:00-04:00",
11            "updated_at": "2023-05-15T14:30:00-04:00",
12            "orders_count": 5,
13            "total_spent": "500.00",
14            "tags": [
15                "loyal",
16                "vip"
17            ],
18            "addresses": [
19                {
20                    "address1": "123 Main St",
21                    "city": "Anytown",
22                    "province": "ON",
23                    "country": "CA",
24                    "zip": "A1B 2C3"
25                }
26            ]
27        },
28        {
29            "id": 9876543210,
30            "email": "janesmith@example.com",
31            "first_name": "Jane",
32            "last_name": "Smith",
33            "phone": "+1-555-987-6543",
34            "accepts_marketing": false,
35            "created_at": "2023-04-15T09:30:00-04:00",
36            "updated_at": "2023-05-10T11:45:00-04:00",
37            "orders_count": 2,
38            "total_spent": "150.00",
39            "tags": [
40                "new"
41            ],
42            "addresses": [
43                {
44                    "address1": "456 Elm St",
45                    "city": "Other City",
46                    "province": "BC",
47                    "country": "CA",
48                    "zip": "X1Y 2Z3"
49                }
50            ]
51        }
52    ]
53}

List locations (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1{}

Sample Output

1{
2    "locations": [
3        {
4            "id": 1234567890,
5            "name": "Main Warehouse",
6            "address1": "123 Main Street",
7            "address2": "Suite 100",
8            "city": "New York",
9            "zip": "10001",
10            "province": "New York",
11            "country": "United States",
12            "phone": "212-555-1234",
13            "created_at": "2023-05-01T10:00:00-04:00",
14            "updated_at": "2023-05-15T14:30:00-04:00",
15            "country_code": "US",
16            "country_name": "United States",
17            "province_code": "NY",
18            "legacy": false,
19            "active": true
20        },
21        {
22            "id": 9876543210,
23            "name": "Downtown Store",
24            "address1": "456 Broadway",
25            "address2": null,
26            "city": "New York",
27            "zip": "10013",
28            "province": "New York",
29            "country": "United States",
30            "phone": "212-555-5678",
31            "created_at": "2023-05-02T09:00:00-04:00",
32            "updated_at": "2023-05-16T11:45:00-04:00",
33            "country_code": "US",
34            "country_name": "United States",
35            "province_code": "NY",
36            "legacy": false,
37            "active": true
38        }
39    ]
40}

List product images (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1{}

Sample Output

1{
2    "images": [
3        {
4            "id": 850703190,
5            "product_id": 632910392,
6            "position": 1,
7            "created_at": "2023-04-12T15:30:45-04:00",
8            "updated_at": "2023-04-12T15:30:45-04:00",
9            "alt": "Green t-shirt front view",
10            "width": 1000,
11            "height": 1000,
12            "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/green-tshirt-front.jpg",
13            "variant_ids": [
14                457924702
15            ]
16        },
17        {
18            "id": 850703191,
19            "product_id": 632910392,
20            "position": 2,
21            "created_at": "2023-04-12T15:31:15-04:00",
22            "updated_at": "2023-04-12T15:31:15-04:00",
23            "alt": "Green t-shirt back view",
24            "width": 1000,
25            "height": 1000,
26            "src": "https://cdn.shopify.com/s/files/1/0000/0000/products/green-tshirt-back.jpg",
27            "variant_ids": [
28                457924702
29            ]
30        }
31    ]
32}

Operations (sample payloads)

Main operationsCopy

Cancel fulfillmentCopy

Cancel orderCopy

Close orderCopy

Complete draft orderCopy

Count customersCopy

Count fulfillments for an Order by IDCopy

Count locationsCopy

Count ordersCopy

Count productsCopy

Create account activation urlCopy

Create customerCopy

Create draft orderCopy

Create fulfillmentCopy

Create inventory levelCopy

Create inventory level for item at locationCopy

Create metafieldCopy

Create new product imageCopy

Create productCopy

Create product image with image URLCopy

Create product variantCopy

Delete customerCopy

Delete inventory levelCopy

Delete metafieldCopy

Delete orderCopy

Delete productCopy

Delete product variantCopy

Get collectionCopy

Get customerCopy

Get fulfillmentCopy

Get fulfillment orders by orderidCopy

Get inventory itemCopy

Get LocationCopy

Get Location inventory levelsCopy

Get metafield by IDCopy

Get orderCopy

Get productCopy

Get product variantCopy

Get shop configurationCopy

List abandoned checkoutsCopy

List collection productsCopy

List collectsCopy

List customersCopy

List fulfillments for an Order by IDCopy

List inventory itemsCopy

List inventory levelsCopy

List locationsCopy

List metafieldsCopy

List ordersCopy

List product imagesCopy

List productsCopy

Open orderCopy

Search customersCopy

Send account inviteCopy

Send draft order invoiceCopy

Update customerCopy

Update draft orderCopy

Update fulfillment tracking informationCopy

Update inventory itemCopy

Update inventory levelCopy

Update metafieldCopy

Update orderCopy

Update productCopy

Update product variantCopy

DDL operationsCopy

List countries (DDL)Copy

List customers (DDL)Copy

List locations (DDL)Copy

List product images (DDL)Copy

Overview

Operations

Main operations
Copy

Cancel fulfillment
Copy

Cancel order
Copy

Close order
Copy

Complete draft order
Copy

Count customers
Copy

Count fulfillments for an Order by ID
Copy

Count locations
Copy

Count orders
Copy

Count products
Copy

Create account activation url
Copy

Create customer
Copy

Create draft order
Copy

Create fulfillment
Copy

Create inventory level
Copy

Create inventory level for item at location
Copy

Create metafield
Copy

Create new product image
Copy

Create product
Copy

Create product image with image URL
Copy

Create product variant
Copy

Delete customer
Copy

Delete inventory level
Copy

Delete metafield
Copy

Delete order
Copy

Delete product
Copy

Delete product variant
Copy

Get collection
Copy

Get customer
Copy

Get fulfillment
Copy

Get fulfillment orders by orderid
Copy

Get inventory item
Copy

Get Location
Copy

Get Location inventory levels
Copy

Get metafield by ID
Copy

Get order
Copy

Get product
Copy

Get product variant
Copy

Get shop configuration
Copy

List abandoned checkouts
Copy

List collection products
Copy

List collects
Copy

List customers
Copy

List fulfillments for an Order by ID
Copy

List inventory items
Copy

List inventory levels
Copy

List locations
Copy

List metafields
Copy

List orders
Copy

List product images
Copy

List products
Copy

Open order
Copy

Search customers
Copy

Send account invite
Copy

Send draft order invoice
Copy

Update customer
Copy

Update draft order
Copy

Update fulfillment tracking information
Copy

Update inventory item
Copy

Update inventory level
Copy

Update metafield
Copy

Update order
Copy

Update product
Copy

Update product variant
Copy

DDL operations
Copy

List countries (DDL)
Copy

List customers (DDL)
Copy

List locations (DDL)
Copy

List product images (DDL)
Copy