Order Status

The order status API can be used to determine where a submitted order sits within the quote flow.

To utilize this endpoint, you must provide the "referenceId:" as a path parameter. This "referenceId:" field is the same as "quoteReferenceId:" field submitted through the POST/order/create endpoint.

The response for the Order Status endpoint will show whether the order has a status of either "ordercreated" or "orderprocessing"

ordercreated - This status means that the order you submitted through the POST/order/create contained all the necessary information and has been sent to the carrier. This will only be allowed to happen if the "readyToDispatch": field = "Yes" and all the required information has been filled out.

orderprocessing - This status means that a submitted order has been received by MyCarrier but has yet to be submitted to a carrier.

To know why an order may not have been created, or what information is still needed to fully process the order, you can refer to the "logs" field under "statusHistories" array in the response body of the Order Status endpoint. This will provide both errors and warnings. Errors represent issues that prevent an order form being processed while warnings represent issues which could complicate fulfilling a shipment on the carrier-side. Logs will appear like this in the response:

"logs": [  
                    {  
                        "type": "error",  
                        "message": "Error - The location entered could not be found"  
                    },  
                    {  
                        "type": "warning",  
                        "message": "Warning - Carrier is empty"  
                    },  
                    {  
                        "type": "error",  
                        "message": "Error - Commodity Weight is required"  
                    }  
                ]\