API Process Status

After a request where data is modified, such as adjusting the price of an item or processing an order, it is important to always request a process status. A process status indicates whether such a request (POST, PUT, or DELETE request) has actually been successfully processed within the bol environment. In other words, the process status indicates whether your change has been processed.

For example, when you confirm a bol order from your own system, it doesn't mean the order has been immediately processed successfully by bol. Requests that modify data are first placed in a queue. The Retailer API constantly processes all requests from the queue. Depending on the number of requests in the queue, the time required to process a request can vary. When a request is at the front of the queue, we forward it to another internal service. A process status indicates whether a request has actually been successfully processed by our internal services.

When you request a process status, we return one of the following statuses: SUCCESS, FAILURE, PENDING, or TIMEOUT. Below is a brief explanation of the different statuses:

• SUCCESS indicates that a request has been successfully processed by us; you don't need to take any further action.
• FAILURE indicates that the request was not processed successfully. We always provide an explanation of why the change failed. Use the explanation in the FAILURE error message to adjust the request, if necessary.
• PENDING indicates that the request still needs further processing. Re-request the process status at a later time to receive the definitive status.
• If the system cannot process a request within a certain timeframe, we return the status TIMEOUT. For a TIMEOUT, you should resend the original request at a later time.

You can find more information about the process status here.