Webhooks

Base URL

Request Method

POST

Headers

name
value
Content-Type
application/json
X-Hmac-Sha256
{body-hash}
X-Shop-Domain
store-name.com

Endpoints

path
description
/orders/create
when order created
/orders/update
when order updated
/orders/delete
when order deleted
/customers/create
when customer created
/customers/update
when customer updated
/customers/delete
when customer deleted
/products/create
when product created
/products/update
when product updated
/products/delete
when product deleted
/collections/create
when collection created
/collections/update
when collection updated
/collections/delete
when collection deleted
/app/uninstalled
when convertedin app uninstalled

Request Body

Order

1
{
2
"id": 450789469,
3
"closed_at": null,
4
"confirmed": true,
5
"contact_email": "[email protected]",
6
"created_at": "2008-01-10T11:00:00-05:00",
7
"currency": "USD",
8
"customer_locale": null,
9
"discount_codes": [
10
{
11
"code": "TENOFF",
12
"amount": "10.00",
13
"type": "fixed_amount"
14
}
15
],
16
"email": "[email protected]",
17
"financial_status": "partially_refunded",
18
"fulfillment_status": null,
19
"landing_site": "http://www.example.com?source=abc",
20
"landing_site_ref": "abc",
21
"name": "#1001",
22
"note": null,
23
"number": 1,
24
"order_number": 1001,
25
"order_status_url": "https://apple.myshopify.com/690933842/orders/b1946ac92492d2347c6235b4d2611184/authenticate?key=imasecretipod",
26
"payment_gateway_names": [
27
"bogus"
28
],
29
"phone": "+557734881234",
30
"presentment_currency": "USD",
31
"processed_at": "2008-01-10T11:00:00-05:00",
32
"processing_method": "direct",
33
"reference": "fhwdgads",
34
"referring_site": "http://www.otherexample.com",
35
"source_identifier": "fhwdgads",
36
"source_name": "web",
37
"source_url": null,
38
"subtotal_price": "597.00",
39
"tags": "",
40
"taxes_included": false,
41
"total_discounts": "10.00",
42
"total_line_items_price": "597.00",
43
"total_price": "598.94",
44
"total_price_usd": "598.94",
45
"total_tax": "11.94",
46
"total_tip_received": "0.00",
47
"total_weight": 0,
48
"updated_at": "2008-01-10T11:00:00-05:00",
49
"billing_address": {
50
"first_name": "Bob",
51
"address1": "Chestnut Street 92",
52
"phone": "555-625-1199",
53
"city": "Louisville",
54
"zip": "40202",
55
"province": "Kentucky",
56
"country": "United States",
57
"last_name": "Norman",
58
"address2": "",
59
"company": null,
60
"latitude": 45.41634,
61
"longitude": -75.6868,
62
"name": "Bob Norman",
63
"country_code": "US",
64
"province_code": "KY"
65
},
66
"customer": {
67
"id": 207119551,
68
"email": "[email protected]",
69
"accepts_marketing": false,
70
"created_at": "2021-10-01T17:01:53-04:00",
71
"updated_at": "2021-10-01T17:01:53-04:00",
72
"first_name": "Bob",
73
"last_name": "Norman",
74
"orders_count": 1,
75
"state": "disabled",
76
"total_spent": "199.65",
77
"last_order_id": 450789469,
78
"note": null,
79
"verified_email": true,
80
"multipass_identifier": null,
81
"tax_exempt": false,
82
"phone": "+16136120707",
83
"tags": "",
84
"last_order_name": "#1001",
85
"currency": "USD",
86
"accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
87
"marketing_opt_in_level": null,
88
"tax_exemptions": [],
89
"admin_graphql_api_id": "gid://shopify/Customer/207119551",
90
"default_address": {
91
"id": 207119551,
92
"customer_id": 207119551,
93
"first_name": null,
94
"last_name": null,
95
"company": null,
96
"address1": "Chestnut Street 92",
97
"address2": "",
98
"city": "Louisville",
99
"province": "Kentucky",
100
"country": "United States",
101
"zip": "40202",
102
"phone": "555-625-1199",
103
"name": "",
104
"province_code": "KY",
105
"country_code": "US",
106
"country_name": "United States",
107
"default": true
108
}
109
},
110
"line_items": [
111
{
112
"id": 466157049,
113
"fulfillable_quantity": 0,
114
"fulfillment_status": null,
115
"name": "IPod Nano - 8gb - green",
116
"price": "199.00",
117
"product_exists": true,
118
"product_id": 632910392,
119
"quantity": 1,
120
"title": "IPod Nano - 8gb",
121
"total_discount": "0.00",
122
"variant_id": 39072856,
123
"variant_title": "green",
124
"vendor": null
125
}
126
]
127
}
Copied!

Product

1
{
2
"id": 632910392,
3
"title": "IPod Nano - 8GB",
4
"content": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
5
"vendor": "Apple",
6
"created_at": "2021-10-01T16:42:46-04:00",
7
"handle": "ipod-nano",
8
"updated_at": "2021-10-01T16:42:46-04:00",
9
"published_at": "2007-12-31T19:00:00-05:00",
10
"available": true,
11
"tags": "Emotive, Flash Memory, MP3, Music",
12
"variants": [
13
{
14
"id": 808950810,
15
"product_id": 632910392,
16
"title": "Pink",
17
"price": "199.00",
18
"sku": "IPOD2008PINK",
19
"position": 1,
20
"compare_at_price": null,
21
"created_at": "2021-10-01T16:42:46-04:00",
22
"updated_at": "2021-10-01T16:42:46-04:00",
23
"barcode": "1234_pink",
24
"grams": 567,
25
"image_id": 562641783,
26
"weight": 1.25,
27
"weight_unit": "lb",
28
"inventory_quantity": 10
29
},
30
{
31
"id": 49148385,
32
"product_id": 632910392,
33
"title": "Red",
34
"price": "199.00",
35
"sku": "IPOD2008RED",
36
"position": 2,
37
"compare_at_price": null,
38
"created_at": "2021-10-01T16:42:46-04:00",
39
"updated_at": "2021-10-01T16:42:46-04:00",
40
"barcode": "1234_red",
41
"grams": 567,
42
"image_id": null,
43
"weight": 1.25,
44
"weight_unit": "lb",
45
"inventory_quantity": 20
46
}
47
],
48
"options": [
49
{
50
"id": 594680422,
51
"product_id": 632910392,
52
"name": "Color",
53
"position": 1,
54
"values": [
55
"Pink",
56
"Red"
57
]
58
}
59
],
60
"images": [
61
{
62
"id": 850703190,
63
"product_id": 632910392,
64
"position": 1,
65
"created_at": "2021-10-01T16:42:46-04:00",
66
"updated_at": "2021-10-01T16:42:46-04:00",
67
"alt": null,
68
"width": 123,
69
"height": 456,
70
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1633120966",
71
"variant_ids": []
72
},
73
{
74
"id": 562641783,
75
"product_id": 632910392,
76
"position": 2,
77
"created_at": "2021-10-01T16:42:46-04:00",
78
"updated_at": "2021-10-01T16:42:46-04:00",
79
"alt": null,
80
"width": 123,
81
"height": 456,
82
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1633120966",
83
"variant_ids": [
84
808950810
85
]
86
}
87
],
88
"image": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1633120966"
89
}
Copied!

Customer

1
{
2
"id": 207119551,
3
"email": "[email protected]",
4
"accepts_marketing": false,
5
"created_at": "2021-10-01T16:52:26-04:00",
6
"updated_at": "2021-10-01T16:52:26-04:00",
7
"first_name": "Bob",
8
"last_name": "Norman",
9
"orders_count": 1,
10
"state": "disabled",
11
"total_spent": "199.65",
12
"last_order_id": 450789469,
13
"verified_email": true,
14
"phone": "+16136120707",
15
"last_order_name": "#1001",
16
"currency": "USD",
17
"addresses": [
18
{
19
"id": 207119551,
20
"customer_id": 207119551,
21
"first_name": null,
22
"last_name": null,
23
"company": null,
24
"address1": "Chestnut Street 92",
25
"address2": "",
26
"city": "Louisville",
27
"province": "Kentucky",
28
"country": "United States",
29
"zip": "40202",
30
"phone": "555-625-1199",
31
"name": "",
32
"province_code": "KY",
33
"country_code": "US",
34
"country_name": "United States",
35
"default": true
36
}
37
],
38
"default_address": {
39
"id": 207119551,
40
"customer_id": 207119551,
41
"first_name": null,
42
"last_name": null,
43
"company": null,
44
"address1": "Chestnut Street 92",
45
"address2": "",
46
"city": "Louisville",
47
"province": "Kentucky",
48
"country": "United States",
49
"zip": "40202",
50
"phone": "555-625-1199",
51
"name": "",
52
"province_code": "KY",
53
"country_code": "US",
54
"country_name": "United States",
55
"default": true
56
}
57
}
Copied!

Collection

1
{
2
"id": 841564295,
3
"taxonomy": "Category > Sub Category",
4
"handle": "ipods",
5
"title": "IPods",
6
"updated_at": "2008-02-01T19:00:00-05:00",
7
"content": "<p>The best selling ipod ever</p>",
8
"published_at": "2008-02-01T19:00:00-05:00",
9
"available": true,
10
"image": {
11
"created_at": "2021-10-01T17:17:03-04:00",
12
"alt": "MP3 Player 8gb",
13
"width": 123,
14
"height": 456,
15
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1633123023"
16
}
17
}
Copied!
Last modified 24d ago