| Events | Topics | Response Example |
|---|---|---|
| Collection | collections/create, collections/update |
{
"collection": {
"id": "0097cfc8-6ec3-40ed-ab9f-6f2231b705a6",
"title": "Collection",
"handle": "Collection",
"description": "",
"meta_title": "xxx",
"meta_description": "xxx",
"meta_keyword": "tag1,tag2,tag3",
"image": {
"src": "https://cdn.shoplazza.com/example.png",
"width": 480,
"height": 360,
"alt": "Image"
},
"sort_order": "alpha-asc",
"created_at": "2018-10-31T13:02:19-04:00",
"updated_at": "2018-10-31T13:02:19-04:00"
}
}
|
| collections/delete |
|
|
| Product | products/create, products/update |
{
"product":{
"id":"0510dace-34da-4555-a896-495e0cb1ed6e",
"title":"title1",
"brief": "title2",
"description": "product desc",
"vendor": "vendor 01",
"vendor_url": "http://www.baidu.com",
"has_only_default_variant":true,
"requires_shipping": true,
"taxable": true,
"inventory_tracking": true,
"inventory_policy": "inventory policy 1",
"inventory_quantity": 100,
"published": true,
"published_at": "2019-10-01 10:00:00 xxxx",
"created_at": "2019-10-01 10:00:00 xxxx",
"updated_at": "2019-10-01 10:00:00 xxxx",
"note": "xxx",
"meta_title": "xxx",
"meta_description": "xxx",
"meta_keyword": "tag1,tag2,tag3",
"handle": "title1",
"need_variant_image": true,
"image": {
"src":"https://oss.ali.com/abc.jpg",
"width":100,
"height":100,
"alt":""
},
"images": [
{
"id": "0510dace-34da-4555-a896-495e0cb1ed6e",
"product_id": "123456",
"position": 1,
"src": "https://cdn.shoplazza.com/example.png",
"width": 480,
"height": 360,
"alt": "Image",
"created_at": "2018-10-31T13:02:19-04:00",
"updated_at": "2018-10-31T13:02:19-04:00"
}
],
"options":[
{
"id":"0510dace-34da-4555-a896-495e0cb1ed6e",
"product_id": "123456",
"name":"color",
"position":1,
"values": ["red", "black"]
},
{
"id":"0510dace-34da-4555-a896-495e0cb1kkd8",
"product_id": "123456",
"name":"size",
"position":2,
"values":["32", "33"]
}
],
"variants":[
{
"id":"0510dace-34da-4555-a896-495e0cb1ed6e",
"product_id": "123456",
"position":1,
"title":"variants title",
"image":{
"src":"https://oss.ali.com/abc.jpg",
"width":100,
"height":100,
"alt":""
},
"price": 32,
"compare_at_price": 45,
"weight": 0.1,
"weight_unit":"kg",
"inventory_quantity": 33,
"sku": "20182002154567873574",
"barcode": "201213112",
"note": "xxx",
"option1": "red",
"option2": "M",
"option3": "",
"created_at": "2018-10-31T13:02:19-04:00",
"updated_at": "2018-10-31T13:02:19-04:00"
}
]
}
}
|
| products/delete |
{
"product": {
"id": "0510dace-34da-4555-a896-495e0cb1ed6e"
}
}
|
|
| Order |
orders/cancelled, orders/create, orders/fulfilled, orders/finished, orders/paid, orders/partially_fulfilled, orders/refunded, orders/update |
{
"order":{
"id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"created_at": "2014-04-25T16:15:47-04:00",
"updated_at": "2014-04-25T16:15:47-04:00",
"note": "abc",
"number": "ASD01245",
"total_price": "16.99",
"sub_total": "15.00",
"currency": "USD",
"financial_status": "waiting",
"status": "opened",
"canceled_at": null,
"cancel_reason": null,
"payment_method": "online",
"fulfillment_status": "waiting",
"customer_deleted_at": "2014-04-25T16:15:47-04:00",
"deleted_at": "2014-04-25T16:15:47-04:00",
"placed_at": "2014-04-25T16:15:47-04:00",
"tags": "a, b",
"discount_code": "",
"buyer_accepts_marketing": false,
"code_discount_total": "1.00",
"total_tip_received": "0.00",
"line_item_discount_total": "1.00",
"customer_note": "note",
"total_discount": "100.00",
"total_tax": "10.00",
"total_shipping": "1.00",
"line_items": [
{
"id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"product_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"product_title": "abc",
"variant_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"variant_title": "XXX",
"quantity": 10,
"note": "red",
"image": "http://www.a.com/xxx.jpg",
"price": 12.34,
"compare_at_price": 12.34,
"total": "12.34 USD",
"fulfillment_status": "waiting",
"sku": "xxx",
"weight": 1.23,
"weight_unit": "g",
"vendor": "XXX",
"product_handle": "abc",
"product_url": "http://www.a.com/abc",
"properties": [
{
"name": "color",
"value": "red"
}
]
}
],
"shipping_line": {
"name": "free"
},
"billing_address": {
"first_name": "Bob",
"last_name": "Norman",
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"zip": "40202",
"province": "Kentucky",
"country": "United States",
"company": null,
"latitude": 45.41634,
"longitude": -75.6868,
"name": "Bob Norman",
"country_code": "US",
"province_code": "KY",
"email": "[email protected]",
"area": "sz"
},
"shipping_address": {
"first_name": "Bob",
"last_name": "Norman",
"address1": "Chestnut Street 92",
"address2": "",
"phone": "555-625-1199",
"city": "Louisville",
"zip": "40202",
"province": "Kentucky",
"country": "United States",
"company": null,
"latitude": 45.41634,
"longitude": -75.6868,
"name": "Bob Norman",
"country_code": "US",
"province_code": "KY",
"phone_area_code": "80",
"area": "sz",
"email": "[email protected]"
},
"fulfillments": [
{
"id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"order_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"status": "waiting",
"created_at": "2018-11-02T12:30:10-04:00",
"updated_at": "2018-11-02T12:30:10-04:00",
"tracking_company": null,
"tracking_number": "1Z2345",
"tracking_company_code": "3306",
"line_items": [
{
"id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"product_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"product_title": "abc",
"variant_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"variant_title": "XXX",
"quantity": 10,
"note": "red",
"image": "http://www.a.com/xxx.jpg",
"price": 12.34,
"compare_at_price": 12.34,
"total": "12.34 USD",
"fulfillment_status": "waiting",
"sku": "xxx",
"weight": 1.23,
"weight_unit": "g",
"vendor": "XXX",
"product_handle": "abc",
"product_url": "http://www.a.com/abc",
"properties": [
{
"name": "color",
"value": "red"
},
{
"name": "color",
"value": "red"
}
]
}
]
}
],
"customer":{
"email": "[email protected]",
"created_at": "2018-11-02T12:30:10-04:00",
"updated_at": "2018-11-02T12:30:10-04:00",
"first_name": "Bob",
"last_name": "Norman",
"orders_count": 1,
"total_spent": "41.94",
"phone": "",
}
}
}
|
| orders/delete |
{
"order": {
"id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5"
}
}
|
|
| cart/create, cart/update |
{
"user_id": "f12245c0-7aa4-4cb2-9608-16032b08e72e",
"user_sign": null,
"currency_code": "USD",
"discount_applications": [{
"type": "discount_rebate",
"title": "100-99",
"discount_amount": 99,
"message": "",
"discount_message": "",
"discount_id": "53609819-f7ae-41c1-8fb1-e5f0ca1b6329",
"value_type": "fixed_amount",
"target_type": "line_item",
"apply_method": "",
"target_selection": "all",
"discount_type": "discount_rebate",
"entitled_product_list": [{
"product_id": "e0854d57-4da2-4538-b7bf-d24dfefa884f",
"variant_id": "2f193d62-ab46-49c3-b415-77b3bb895ca5",
"price": "111",
"trunk_price": "0",
"compare_at_price": "0",
"total_price": "111",
"quantity": 1,
"inventory_tracking": false,
"inventory_policy": "",
"inventory_quantity": 0,
"discount_applications": null,
"properties": ""
}, {
"product_id": "15c7c703-d418-47ad-afbd-12790f4559b0",
"variant_id": "9460470a-059a-47d2-a6f4-fbad19ff809e",
"price": "1",
"trunk_price": "0",
"compare_at_price": "0",
"total_price": "2",
"quantity": 2,
"inventory_tracking": false,
"inventory_policy": "",
"inventory_quantity": 0,
"discount_applications": null,
"properties": ""
}, {
"product_id": "ed9ccd32-ca60-4d08-975a-2c7d41e5f708",
"variant_id": "af2ca87b-169a-4dc3-b3ab-499733714f31",
"price": "49.99",
"trunk_price": "0",
"compare_at_price": "0",
"total_price": "49.99",
"quantity": 1,
"inventory_tracking": false,
"inventory_policy": "",
"inventory_quantity": 0,
"discount_applications": null,
"properties": ""
}]
}],
"line_items": [{
"id": "1063741801_d41d8cd98f00b204e9800998ecf8427e",
"item_id": "1063741801",
"properties": "",
"product_id": "e0854d57-4da2-4538-b7bf-d24dfefa884f",
"variant_id": "2f193d62-ab46-49c3-b415-77b3bb895ca5",
"quantity": 1,
"price": "111.00",
"trunk_price": "0",
"custom": false,
"parts_price": null,
"variant_title": "long",
"product_title": "2",
"product_handle": "2",
"discount_applications": [],
"taxable": false,
"requires_shipping": true,
"wholesale_price": [{
"min_quantity": 1,
"price": "111.00"
}]
}, {
"id": "1063741749_d41d8cd98f00b204e9800998ecf8427e",
"item_id": "1063741749",
"properties": "",
"product_id": "15c7c703-d418-47ad-afbd-12790f4559b0",
"variant_id": "9460470a-059a-47d2-a6f4-fbad19ff809e",
"quantity": 2,
"price": "1.00",
"trunk_price": "0",
"custom": false,
"parts_price": null,
"variant_title": "hotpink",
"product_title": "Solid Ruffle Neck Bubble Sleeve Pleated Top",
"product_handle": "solid-ruffle-neck-bubble-sleeve-pleated-top",
"discount_applications": [],
"taxable": false,
"requires_shipping": true,
"wholesale_price": [{
"min_quantity": 1,
"price": "1.00"
}]
}, {
"id": "1063741581_d41d8cd98f00b204e9800998ecf8427e",
"item_id": "1063741581",
"properties": "",
"product_id": "ed9ccd32-ca60-4d08-975a-2c7d41e5f708",
"variant_id": "af2ca87b-169a-4dc3-b3ab-499733714f31",
"quantity": 1,
"price": "49.99",
"trunk_price": "0",
"custom": false,
"parts_price": null,
"variant_title": "",
"product_title": "Jabra Move Wireless Stereo Headphones",
"product_handle": "maternity-rainbow-stripe-skinny-bodycon-dress_5027",
"discount_applications": [],
"taxable": false,
"requires_shipping": true,
"wholesale_price": [{
"min_quantity": 1,
"price": "49.99"
}]
}],
"total_price": "63.99",
"total_discount": "99.00",
"created_at": "2023-06-14T08:17:30Z",
"updated_at": "2023-06-14T08:17:30Z"
}
|
|
| Fulfillment | fulfillments/create, fulfillments/update |
{
"fulfillment": {
"id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"order_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"status": "waiting",
"created_at": "2018-11-02T12:30:10-04:00",
"updated_at": "2018-11-02T12:30:10-04:00",
"tracking_company": "",
"tracking_number": "1Z2345",
"tracking_company_code": "3306",
"line_items": [
{
"id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"product_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"product_title": "abc",
"variant_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
"variant_title": "XXX",
"quantity": 10,
"note": "red",
"image": "http://www.a.com/xxx.jpg",
"price": 12.34,
"compare_at_price": 12.34,
"total": "12.34 USD",
"fulfillment_status": "waiting",
"sku": "xxx",
"weight": 1.23,
"weight_unit": "g",
"vendor": "XXX",
"product_handle": "abc",
"product_url": "http://www.a.com/abc",
"properties": [
{
"name": "color",
"value": "red"
},
{
"name": "color",
"value": "red"
}
]
}
]
}
}
|
| Customer | customers/create, customers/update |
{
"customer": {
"id":"1dfa86e9-f3f4-4684-8eb6-05399ef19705",
"first_name":"Lee",
"last_name":"Le",
"name":"Lee Le",
"email":"[email protected]",
"phone":"15323233434",
"phone_area_code": "+86",
"accepts_marketing":false,
"orders_count": 10,
"total_spent": "100.10",
"tags": "",
"created_at": "2018-10-23T15:29:24-04:00",
"updated_at": "2018-10-23T15:29:24-04:00",
"default_address": {
"id": "2ffa86e9-f3f4-4684-84b6-05399ef19709",
"customer_id": "1dfa86e9-f3f4-4684-8eb6-05399ef19705",
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"phone_area_code": "+86",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
},
"addresses": [
{
"id": "2ffa86e9-f3f4-4684-84b6-05399ef19709",
"customer_id": "1dfa86e9-f3f4-4684-8eb6-05399ef19705",
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"phone_area_code": "+86",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
]
}
}
|
| customers/delete |
{
"customer": {
"id": "1dfa86e9-f3f4-4684-8eb6-05399ef19705"
}
}
|
|
| Store | app/uninstalled , app/expired |
{
"app": {
"id": 1,
"name": "enquiry",
"uid": "yAQSUe8l3hT8YFHNAZBIAnQ58HAWZ9FEf5ofELvLE0s",
"redirect_uri": "https://apps.example.com/oauth_callback/",
"scopes": "read_script_tags write_script_tags read_shop",
"icon": "/oss/operation/9ea4e43d0be77b367d3a6f403d10b6e3.svg",
"webhook_api_version": "2020-01",
"created_at": "2020-01-15T02:33:27Z",
"updated_at": "2020-01-15T02:33:27Z"
}
}
|
| Billing | ||
| app/purchases_one_time_update |
{
"application_id": "ITK6sdTeyZuxIoxHpNfxXPMe6BRx5mT8I1SUpBvi6i4",
"id": "404385691100624",
"name": "30yuan once order",
"price": "30",
"status": "active",
"store_id": 64434,
"test": false,
"updated_at": "2023-04-07T10:29:49Z"
}
|
|
| app/subscriptions_update |
{
"activated_on": "2023-04-07T00:00:00Z",
"application_id": "ITK6sdTeyZuxIoxHpNfxXPMe6BRx5mT8I1SUpBvi6i4",
"billing_on": "2023-05-07T00:00:00Z",
"cancelled_on": null,
"capped_amount": "30",
"id": "404385691100624",
"name": "30yuan per month",
"price": "30",
"status": "active",
"store_id": 64434,
"test": false,
"trial_days": 0,
"trial_ends_on": null,
"updated_at": "2023-04-07T10:29:49Z"
}
|
|
| app/subscriptions_approaching_capped_amount |
{
"activated_on": "2023-04-07T00:00:00Z",
"application_id": "ITK6sdTeyZuxIoxHpNfxXPMe6BRx5mT8I1SUpBvi6i4",
"billing_on": "2023-05-07T00:00:00Z",
"cancelled_on": null,
"capped_amount": "30",
"id": "404385691100624",
"name": "30yuan per month",
"stord_id": 64434,
"trial_ends_on": null,
"updated_at": "2023-04-07T10:29:49Z"
}
|