Skip to content

OF04 - Get information and statistics about offer imports

Request

Call Frequency
Maximum usage: Once per minute
Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

  • dateCreated (Default) - Sort by creation date (desc by default)

Security
Operator-Bearer-Token or OAuth-2
Query
shop_idinteger, (int64)

Shop identifier

start_datestring, (date-time)

Start creation date for filtering

end_datestring, (date-time)

End creation date for filtering

statusstring

Offer import status

Enum:"WAITING_SYNCHRONIZATION_PRODUCT""WAITING""RUNNING""COMPLETE""FAILED"
modestring

Offer import mode

Enum:"NORMAL""REPLACE"
originsArray of strings

List of offer import origins for filtering. This parameter can be supplied multiple times (origins=API&origins=FTP...).

Items Enum:"API""FTP""SFTP""HTTP""HTTPS""FRONT""PENDING_OFFERS"
curl -i -X GET \
  'https://your-instance.mirakl.net/api/offers/imports?shop_id=0&start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z&status=WAITING_SYNCHRONIZATION_PRODUCT&mode=NORMAL&origins=API' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
dataArray of objectsrequired

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response
{ "data": [ { … }, { … } ], "next_page_token": "bGltaXQ9MiZhZnRlcj0yMDIxLTA1LTExJTIwMTY6NTA6MjUuNDczJnNvcnQ9ZGF0ZUNyZWF0ZWQsREVTQw==", "previous_page_token": null }