Update Order Status | Analog

Updates the order status

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

order_idstringRequired

Request

This endpoint expects an object.

statusenumRequired

Response

This endpoint returns an object.

idstring

Unique identifier for the order

storeobject

Store information associated with the order

customerobject

Customer who placed the order

statusenum

Current status of the order

priceinteger

Total price of the order in cents

taxinteger

Total tax amount in cents

itemslist of maps from strings to any

List of items in the order

ready_bydatetime

Requested ready time for the order

created_atdatetime

Time when the order was created

is_readboolean

Whether the order has been read

in_posboolean

Whether the order has been synced to POS

objectstring

Usually "Order" for an order object

customer_commentsstring or null

Optional comments from the customer

ready_atdatetime or null

Actual time when order was marked ready

completed_atdatetime or null

Time when the order was completed

payment_statusenum or null

Current status of the payment

Allowed values:

payment_methodenum or null

Method used for payment

Allowed values:

1	import requests
2
3	url = "https://api.getanalog.ai/v1/orders/order_123"
4
5	payload = { "status": "ACCEPTED" }
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": "1234",
3	"store": {
4	"created_at": "2024-01-15T09:30:00Z",
5	"id": "5678",
6	"name": {
7	"translations": {
8	"en": "Downtown Store"
9	}
10	},
11	"external_id": "store_ext_123"
12	},
13	"customer": {
14	"name": "John Doe",
15	"phone": "+1234567890"
16	},
17	"status": "ACCEPTED",
18	"price": 2995,
19	"tax": 245,
20	"items": [
21	{
22	"name": "Burger Combo",
23	"quantity": 2,
24	"price": 1495,
25	"tax": 123
26	}
27	],
28	"ready_by": "2024-01-15T12:30:00Z",
29	"created_at": "2024-01-15T09:30:00Z",
30	"is_read": true,
31	"in_pos": true,
32	"object": "Order",
33	"customer_comments": "No onions please",
34	"payment_status": "paid",
35	"payment_method": "PAY_BY_LINK"
36	}

Authentication

Path parameters

Request

Response

Errors