This document describes different order and shipment statuses used by Glue service. Note that status handling might be slightly different between version 2 and 3 of the Glue API. However, we are trying to maintain integrity of statuses even in case where Retailer and Supplier are using different versions of the APIs.
Intermediate statuses indicate that orders are in fulfillment process, whereas final status indicate if an order was processed successfully or not. Once the order has the final status it should not have any further updates.
Shipments API allows to use statuses other than those below but it is not recommended as it may result unwanted behaviour in overall process.
Status value is case sensitive, it should be always written as described below, written with capital as a first
letter with exception of orderRouted
.
Status | Description | Order | Shipment | V2 | V3 | Final status of the order? |
---|---|---|---|---|---|---|
Draft |
Order status is draft when order is created through Glue UI and it has not been placed yet. Currently used with Posti’s warehouse service. |
x | x | FALSE | ||
Accepted |
When order was sent to Glue and it passed validations then order status is If an order do not pass validations, then the order is rejected by the API and it’s not created to Glue. |
x | x | FALSE | ||
orderRouted |
If creation of the shipment to supplier was successful then status is changed to |
x | x | FALSE | ||
Routed |
If creation of the shipment to supplier was successful then status is changed to |
x | x | FALSE | ||
Created |
If creation of the shipment to supplier was successful then status is changed to Shipment with status |
x | x | x | FALSE | |
Submitted |
If Posti has exported the shipment to external systems like WMS, ALSO or Tradeplace and export was successful
then status is changed to |
x | x | x | FALSE | |
Viewed |
If order was viewed by supplier using Glue UI. Supplier’s should also update the status to
|
x | x | x | x | FALSE |
Picking |
Intermediate/additional status that reflects the current status of the order in the workflow. If order is processed using Glue UI then this status is used. Suppliers who are using APIs to processes orders are not obligated to update to this status. |
x | x | x | x | FALSE |
Packing |
Intermediate/additional status that reflects the current status of the order in the workflow. If order is processed using Glue UI then this status is used. Suppliers who are using APIs to processes orders are not obligated to update to this status. |
x | x | x | x | FALSE |
Error |
When routing order to supplier (inside Glue) or exporting to external systems like WMS, ALSO or Tradeplace
and export fails then order status is changed to |
x | x | x | x | FALSE |
On Hold |
Status applies to warehouse service sales orders. If order contains products that have balance 0 or less then order status is updated to “On hold”. This means that warehouse cant process the order until principal has not made purchase order to order new goods to warehouse. |
x | x | x | x | FALSE |
Receiving |
Status applies to warehouse service purchase orders. |
x | x | x | x | FALSE |
Cancelled |
When supplier cant deliver the order (for example out of stock etc.) or any other process errors on suppliers
side the order status is changed to |
x | x | x | TRUE | |
Delivered Partially |
When order was split to multiple suppliers and one of them delivers their part of the order then the order
status is changed to |
x | x | x | FALSE | |
Delivered |
When order has been delivered by all suppliers (even if one delivered their shipment and other cancelled their
shipment) then final status of the order is set to
Order should have updated values for deliveredQuantity. We cannot say if all products have
been
delivered if deliveredQuantity is missing and the status is |
x | x | x | x | TRUE |
Following picture shows service logic for status handling:
Error code | Description |
---|---|
200 OK | |
207 Multi-Status (WebDAV) (RFC 4918) | Shipment data update was successful but we were unable to send shipment data to nShift (Unifaun). Error code is returned to you. |
400 Bad request | Invalid JSON format or missing values. |
401 Unauthorized | There is something wrong with you oAuth token. Refresh it and try again. |
404 Not found | Requested object was not found. |
409 Conflict | Order with same externalId already exists. |
500 Internal Server Error |
Returned for internal server errors. If the error isn't resolved within a 5 to 10 minutes please contact Support for additional assistance to resolve the problem. Most probably we are making upgrade to our service to make it better for you! |
503 Service Unavailable |
Returned for internal server errors. If the error isn't resolved within a 5 to 10 minutes please contact Support for additional assistance to resolve the problem. Most probably we are making upgrade to our service to make it better for you! |
504 Gateway Timeout |
Returned for internal server errors. If the error isn't resolved within a 5 to 10 minutes please contact Support for additional assistance to resolve the problem. Most probably we are making upgrade to our service to make it better for you! |