OF53 - Poll the status of an asynchronous offer export (OF52)

Request

Description

Retrieve the status for an OF52 offer export.
When the export is complete, the URLs to retrieve the files are returned.

Call Frequency

Recommended usage: Once per minute until you get an error or a success

Maximum usage: Every 10 seconds

Security

Shop-API-Key(Required scopes: ROLE_PARTNER_OFFER_READROLE_SHOP_ADMIN)

Path

tracking_idstringrequired

The asynchronous offer export id

Query

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/offers/export/async/status/{tracking_id}?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

errorobject

Specific error if the status is FAILED

last_updatedstring, (date-time)

The last update date of the export

statusstring

Current status of the export, can be PENDING, FAILED or COMPLETED

urlsArray of strings

List of generated urls to call to download each generated chunks

Response

{
  "last_updated": "2021-09-23T08:14:06.095Z",
  "status": "PENDING"
}