Update an Order
PUT/v2/orders/:orderID
You can only update custom data, shipping
, shipping_address
, and status of orders. All other settings in the order object are immutable.
This endpoint allows you to:
- Update an order number and external reference: You can update an existing order that does not have an
order_number
andexternal_ref
, modify theorder_number
andexternal_ref
values, or remove them by passing an empty value in theorder_number
andexternal_ref
fields. - Cancel an order: You can cancel an order only if it has not been fulfilled.
- Fulfill an order: You can fulfill a paid order only.
caution
You can update shipping
, shipping_address
, and status of an order only if the order is not fulfilled. You can use the refund API to refund an order only if the payment status is paid
. Canceling an order does not automatically refund a payment. You must refund the orders manually.
note
- This request is only accessible to client credentials token users with Seller Admin role.
- Non client credentials token users cannot access this endpoint. See Permissions.
- The
order_number
will appear as the invoice number in Authorize.net transactions.
Request
Responses
- 200
- 401
OK
Unauthorized