Update a single order
Definition
In some specific cases, you might need to add information on a specific order which you cannot update within the defined workflow, using the other endpoints.
In such instance, this endpoint can be useful and gives you the possibility to update certain fields other endpoints would not allow you to.
Fields which can be updated via other endpoints are not available within the endpoint (e.g: order-line statuses). Always ensure you follow the standard workflow and use this endpoint to handle edge cases.
❗ IMPORTANT ❗ This endpoint should not be used to update the statuses an order's lines (confirm/cancel/ship/refund). For this, please use the order-lines related endpoints.
Endpoint
Update an order
PATCH | /merchant/orders/{order-id} |
|---|---|
Description | Update additional content on a given order object. |
Required scope | order_manager |
Path parameters | - order-id: Neteven identifier for the order object |
Returns | a status message from the API for that specific request. |
Endpoint specific errors
Response HTTP Header code : 404
Cause: The order id submitted was not recognized (it doesn't exist on your account).
Actionable : Ensure that the order_id sent as a path parameter is correct. Order id can be retrieved using the get /merchant/orders or get /merchant/orders/new endpoints. Do NOT retry the same call without verifying the validity of the order-id used as a path parameter.
It is very unlikely that you will encounter this error during the production phase, since you are retrieving the order-id to use as a path parameter from a GET /merchant/orders endpoint.
Example:
{ "message": "order {order-id} not recognized", "code": 404, "title": "Not Found }
Response HTTP Header code : 404
Cause: The order line id submitted does not match with that order.
Actionable : Ensure that the order line id sent in the request body is the correct one for this order (it should be an order line id that you retrieve from within the given order id, in the GET /merchant/orders endpoints). Order id can be retrieved using the get /merchant/orders or get /merchant/orders/new endpoints. Do NOT retry the same call without verifying the validity of the order-id used as a path parameter.
Example:
{ "message": "order_line_id {order_line_id} doesn't exist for this order {order_id}", "code": 404, "title": "Not Found }
API reference
more information on parameters, responses and content in the API Reference