Bol Order Response Reader
Summary of Changes: (The purpose of this table is to keep traceability and Product team to highlight the things that were changed into the scope, based on comments or discussions)
Date | Version | Created / Updated | Notes |
---|---|---|---|
10/05/2023 | v1.0 | Bogomil Pavlov | First publish |
15/09/2023 | v1.1 | Bogomil Pavlov | Full Reword to work with processStatusId |
Get the Status of a Feed
<v1.1>“Retrieve a list of process statuses, which shows information regarding previously executed PUT/POST/DELETE requests in descending order. You need to supply an entity id and event type. Please note: process status instances are only retained for a limited period of time after completion. Outside of this period, deleted process statuses will no longer be returned. Please handle this accordingly, by stopping any active polling for these statuses.”
We want to call all Marketplace Feeds with distinct marketplace Bol with Marketplace Feed > Status = "Processing"
API Call: GET https://api.bol.com/shared/process-status
API Doc: ReDoc
Query Parameters
process-status |
string
Example: process-status/987654321
Unique id which we use for reading the response |
---|
Sample Request:
API Call: GET https://api.bol.com/shared/process-status/832785609
Parameters Mapping:
Bol Field | Hemi Field | Comment |
---|---|---|
processStatusId |
Marketplace Feed > External ID |
Sample Response:
{
"processStatusId": "832785609",
"entityId": "4a7e756b-f367-48eb-8218-6998ce3d6e34",
"eventType": "CREATE_OFFER_EXPORT",
"description": "Create an offer export.",
"status": "SUCCESS",
"createTimestamp": "2023-08-28T22:20:34+02:00"
}
From the response we want to get the status
and errorMessage
.
If the external status is “PENDING“ we want to set the feed status as “Processing“.
If the external status is “SUCCESS“ o we want to set the status as “Completed“.
If the external status is “FAILURE” or “TIMEOUT” we want to set the status as “Completed“ and store the errorMessage
in relevant error message field</v1.1>