Skip to main content

Update order status

Update order status

Path Parameters
id int32 — REQUIRED

The order id.

status int32 — REQUIRED

Possible values: [0, 1, 2, 3, 4, 5, 6, 7]

The order status to set.
0 = Undefined
1 = Completed
2 = Cancelled
3 = OnHold
4 = Inactive
5 = OutOfStock
6 = Backorder
7 = Pending

transactionId string — REQUIRED

A transaction id can be set here if status is set to pending.

secondaryTransactionId string — REQUIRED

A secondary transaction id, if any, can be set here if status is set to pending.

Responses
200

Ok.

Schema — OPTIONAL
Message string — OPTIONAL

A status message for the action taken.

Details string[] — OPTIONAL

Any validation messages for the data on the current action.

400

Bad request.

Schema — OPTIONAL
Message string — OPTIONAL

A status message for the action taken.

Details string[] — OPTIONAL

Any validation messages for the data on the current action.

404

Not found.

Schema — OPTIONAL
Message string — OPTIONAL

A status message for the action taken.

Details string[] — OPTIONAL

Any validation messages for the data on the current action.