Process status

Version 3 of the Retailer API has been deprecated. Please migrate to the V4 API as soon as possible.

Process status API

Process overview

Any data manipulation request - for example POST, PUT, or DELETE - sent to our retailer API will be handled asynchronously. When we receive your request, we store it internally into a queue. The retailer API is constantly working from the queue to handle all requests. All requests are stored in a specific sequence. Based on the amount of requests in the queue, the time taken to execute your request may vary. Once your request is first in line, we will forward it to another internal service within our landscape. This works as follows:

  1. When we receive your request, we assign a process status ID to it. With this ID, you can request the status later in time. At this time, the message status is PENDING.

  2. Next we forward it to a downstream service. This results in an update of the process status to SUCCESS in case of a successful response, or FAILURE in case of a failure.

  3. If a downstream service is on temporarily unavailable or unable to process your request, we send it back to our internal queue to retry. The status remains as PENDING.

  4. In the case of an unexpected response, we retry your request 5 times every 5 minutes. If it fails 5 times in a row, the status will become FAILURE.

  5. Only when the process status becomes SUCCESS will you receive the entityId. Before that, the action was not yet executed or continuously failed, and therefore no entityId exists for POST requests.

  6. If the status becomes FAILURE, you can find the reason for the failure by examining the errorMessage field.

Whenever a request remains in the pending state for a longer period of time, we set the status to TIMEOUT. This means the downstream service was unable to process all the requests in a specified timeframe and therefore we timed out your request.

You can retry the request at a later time by repeating the original request.

Process flow

process status overview
Figure 1. Schematic of the process status feature

Lifetime

Process statuses are stored for a maximum of 2 days. You cannot request the process status for a process initiated longer than 2 days ago.