Check status update request
Definition
Order status requests are asynchronous by design (they require the communication between Neteven and Marketplaces to ensure the requests are processed all the way through). Therefore, this endpoint is required to verify if the status change request was succesful or not.
Endpoint
Get order line status
GET | /merchant/orders/{order-id}/lines/{order-line-id}/status |
|---|---|
Description | Check the state of an asynchronous status update request made with PATCH merchant/orders/lines/{confirm - cancel - ship - refund}. |
Required scope | order_reader |
Returns | An order line status object, which indicates the current status of the order line, displays the pending or finished request if any. |
{
"order_line_id": 9811600,
"marketplace_order_line_id": "SANDBOX_7501319_1_002",
"merchant_order_line_id": "MyOwnID_for_9811700",
"sku": "HCAPLEONOI-TU",
"ean": "3606852811400",
"status_current": "TO SHIP", // the last valid status received by the Marketplace.
"status_request": {
"action_id": 618624727, // The Neteven internal ID of a given status change request
"action_label": "SHIPPING CONFIRMATION REQUEST", // the type of action
"date_start": "2021-10-06T18:46:17",
"date_end": "2021-10-06T19:00:11",
"state": "PENDING", //the state of the status change request.
"message": ""
}
}Endpoint specific errors
Path parameters errors
Invalid format of order-id / order-line-id
Response HTTP Header code : 400
Cause: The order id submitted is invalid.
Actionable : Ensure that the order_id / order_line_id sent as a path parameter is correct. These identifiers 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 / order-line-id used as a path parameter.
It is very unlikely that you will encounter this error during the production phase, since you are retrieving these identifiers from a GET /merchant/orders endpoint.
Examples:
{ "message": "Invalid value for 'order-id' query parameter: '{order_id}'. It must be an integer.", "code": 400, "title": "Bad Request" }
{ "message": "Invalid value for 'order-line-id' query parameter: '{order_line_id}'. It must be an integer.", "code": 400, "title": "Bad Request" }
Mismatch of order-id and order-line-id
Response HTTP Header code : 404
Cause: The order-id and/or order-line-id submitted are not found on your account (please note that both of these identifiers are unique identifiers).
Actionable : Ensure that the order-id and/or order-line-id sent as a path parameter exist on your account. Both of these identifiers can be retrieved using the get /merchant/orders or get /merchant/orders/new endpoints. Do NOT retry the same call without verifying that both exist on your account.
It is very unlikely that you will encounter this error during the production phase, since you are retrieving the order-line-id to use as a path parameter from a GET /merchant/orders endpoint.
Example:
{ "message": "Mismatch of order-id '{order_id}' and order-line-id '{order_line_id}'. Please ensure that both order-id and order-line-id are consistent and exist on your account.", "code": 404, "title": "Not Found" }
Marketplace does not exist/is inactive
Response HTTP Header code : 400
Cause: The order / order line you are trying to update is associated to a Marketplace that is not active on your account. This can happen if you deactivated a Marketplace AFTER orders where placed.
Actionable : Stop pulling these orders or reactivate the Marketplace in the Neteven user interface. Do NOT resubmit the same request until the corresponding Marketplace is active.
Example:
{ "message": "marketplace {sql_order_line.marketplace_id} non existant or inactive.", "code": 400, "title": "Bad Request" }
API reference
more information on parameters, responses and content in the API Reference