You are viewing an old version of the API

All Versions

Update order

Beta

Updates an open Order by adding, replacing, or deleting fields.

Orders with a COMPLETED or CANCELED state cannot be updated.

An UpdateOrder request requires the following:

The order_id in the endpoint path, identifying the order to update.
The latest version of the order to update.
The sparse order containing only the fields to update and the version the update is being applied to.
If deleting fields, the dot notation paths identifying fields to clear.

To pay for an order, please refer to the Pay for Orders guide.

To learn more about the Orders API, see the Orders API Overview.

Required permissions: ORDERS_WRITE

Path Parameters

Name	Description
`location_id string` Required	The ID of the order's associated location.
`order_id string` Required	The ID of the order to update.

Name	Description
`order Order`	The sparse order containing only the fields to update and the version the update is being applied to.
`fields_to_clear string [ ]`	The dot notation paths fields to clear. For example, `line_items[uid].note` Read more about Deleting fields.
`idempotency_key string`	A value you specify that uniquely identifies this update request If you're unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version will be returned. See Idempotency for more information. Max Length 192

Name	Description
`order Order`	The updated Order.
`errors Error [ ]`	Any errors that occurred during the request.