Update Order

API operation: Open the endpoint in Scalar

Use PUT /orders/{order} to update an order. The current public operation is Order.update.put.

The integer path parameter is {order}.

The fields accepted and status transitions depend on the caller and project configuration. Follow the operation request schema and applicable authorization policy.

For an acceptance transition with status=8, include external_driver_id and external_driver_name. Other permitted transitions have their own requirements. Treat driver-company authentication as a credential and keep it out of examples.

const response = await ordering.orders(orderId).save(changes);

This SDK syntax is historical. Confirm the package and version before using it.

OpenAPI reference

Operation: PUT /orders/{order}

Path parameters

Name	Type	Required	Description
order	integer	Yes	—

Header parameters

Name	Type	Required	Description
User-Agent	string	No	—
X-Forwarded-For	string	No	—
X-Internal-Product-X	string	No	—
X-APP-X	string	No	—

Request body fields

Name	Type	Required
business_id	integer	No
comment	string | null	No
customer	string	No
customer_id	integer	No
delivered_at	any	No
delivered_in	integer	No
delivery_datetime	string	No
delivery_position	integer | null	No
delivery_type	integer	No
delivery_zone_id	integer | null	No
delivery_zone_price	number	No
driver_company_id	integer | null	No
driver_id	integer | null	No
driver_tip	number	No
eta_drive_time	integer	No
eta_time	integer	No
external_driver_id	string	No
external_driver_name	string	No
external_driver_phone	any	No
external_driver_photo	string	No
external_id	string	No
fraud_message	string | null	No
fraud_status	string | null	No
location	object | string	No
manual_driver_assignment_comment	string | null	No
meta_location	string	No
mode	string	No
offer_id	integer	No
order_group_id	integer | null	No
pay_data	string	No
paymethod_id	integer	No
prepared_in	integer	No
priority	any	No
products	string	No
reasons	string	No
refund_data	any	No
reject_reason	string	No
spot_number	number	No
status	integer | string	No
track_url	string | null	No
vehicle	string	No

Responses

Code	Description
200	OK (Envelope)
400	Bad Request (ErrorResponse)
401	Unauthorized
404	Not Found
429	Too Many Requests (ErrorResponse)
500	Internal Server Error (ErrorResponse)
503	Service Unavailable (ErrorResponse)

Open this operation in the API reference