Order Notification

Payload

1 {
2   "id": "evt_12345",
3   "object": "event",
4   "api_version": "2025-02-11",
5   "created": "2025-02-17T22:15:23Z",
6   "type": "order.payment_status_changed",
7   "data": {
8     "object": {
9       "id": "order_12345",
10       "store": {
11         "created_at": "2025-02-17T20:11:04.514049",
12         "id": "store_12345",
13         "name": {
14           "translations": {
15             "en": "Store Name"
16           }
17         },
18         "external_id": "store_ext_12345",
19         "metadata": {}
20       },
21       "customer": {
22         "name": "Customer Name",
23         "phone": "+19043334444"
24       },
25       "status": "PENDING",
26       "price": 1525,
27       "tax": 0,
28       "items": [
29         {
30           "name": "Item Name",
31           "id": "item_12345",
32           "external_id": "item_ext_12345",
33           "quantity": 1,
34           "price": 1350,
35           "tax": 0,
36           "prep_time": null,
37           "customer_comments": null,
38           "selected_modifier_groups": [
39             {
40               "id": "modifier_group_12345",
41               "name": "Modifier Group Name",
42               "external_id": "modifier_group_ext_12345",
43               "selected_items": [
44                 {
45                   "id": "modifier_item_12345",
46                   "name": "Modifier Item Name",
47                   "external_id": "modifier_item_ext_12345",
48                   "price_change": 25,
49                   "tax_change": 0
50                 }
51               ]
52             },
53             {
54               "id": "modifier_group_12346",
55               "name": "Modifier Group Name 2",
56               "external_id": "modifier_group_ext_12346",
57               "selected_items": [
58                 {
59                   "id": "modifier_item_12346",
60                   "name": "Modifier Item Name 2",
61                   "external_id": "modifier_item_ext_12346",
62                   "price_change": 50,
63                   "tax_change": 0
64                 }
65               ]
66             }
67           ]
68         }
69       ],
70       "ready_by": "2025-02-17T22:14:37",
71       "created_at": "2025-02-17T22:14:37",
72       "object": "Order",
73       "customer_comments": null,
74       "ready_at": null,
75       "completed_at": null,
76       "payment_status": "paid",
77       "payment_method": "PAY_BY_LINK",
78       "merchant": {
79         "created_at": "2025-02-17T20:06:59.080007",
80         "id": "merchant_12345",
81         "name": {
82           "translations": {
83             "en": "Merchant Name"
84           }
85         },
86         "external_id": "merchant_ext_12345",
87         "metadata": {}
88       }
89     }
90   },
91   "order_detail_URL": "https://api.getanalog.ai/v1/orders/order_12345"
92 }

Triggered when an order's status changes, particularly when a payment status is updated to PAID. This webhook provides comprehensive details about the order including store information, order status, payment status, items, and customer details.

Payload

The payload of this webhook request is an object.

idstringRequired

objectstringRequired

Should be "event"

api_versionstringRequired

createddatetimeRequired

typestringRequired

dataobjectRequired

Contains the main 'object' with order details

order_detail_URLstringRequired

The URL to fetch the order details

Response

200

any

Return a 200 status to indicate that the data was received successfully.