Process status
Process status API endpoints
-
Retrieve process status: returns a single process status, detailing the progress of the initiated process.
-
Retrieve process statuses: retrieves a list of process statuses based on their IDs in bulk.
-
Retrieve process status by entityId: retrieves a process status by filtering on
entityIdandeventType.
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:
-
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. -
Next we forward it to a downstream service. This results in an update of the process status to
SUCCESSin case of a successful response, orFAILUREin case of a failure. -
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. -
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. -
Only when the process status becomes
SUCCESSwill you receive theentityId. Before that, the action was not yet executed or continuously failed, and therefore noentityIdexists forPOSTrequests. -
If the status becomes
FAILURE, you can find the reason for the failure by examining theerrorMessagefield.
|
Whenever a request remains at pending state for a longer period of time, we set the status to You can retry the request at a later time by repeating the original request. |
