Skip to content
Products
/
/
/
OF02 - Get information an...

OF02 - Get information and statistics about an offer import

Request

Call Frequency
Recommended usage: After each OF01 call, every 5 minutes
Maximum usage: Once per minute
Read More
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_OFFER_WRITEROLE_PARTNER_OFFER_TRACKING_READ)
Path
importinteger, (int64)required

Import identifier

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/imports/{import}?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
date_createdstring, (date-time)required

Import creation date

has_error_reportbooleanrequired

Indicate if an error report exists

import_idinteger, (int64)required

Import ID

lines_in_errorinteger, (int32)required

Total count of lines in error

lines_in_pendinginteger, (int32)required

Total count of lines in pending

lines_in_successinteger, (int32)required

Total count of lines in success

lines_readinteger, (int32)required

Total count of lines read

modestringrequired

Import mode

Enum: "NORMAL", "REPLACE"

See deprecated values

Deprecated values: "PARTIAL_UPDATE"

offer_deletedinteger, (int32)required

Total count of deleted offers

offer_insertedinteger, (int32)required

Total count of inserted offers

offer_updatedinteger, (int32)required

Total count of updated offers

reason_statusstringrequired

Import status reason

statusstringrequired

Import status

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

typestringrequireddeprecated

Will be remove in a future version

Enum: "AUTO", "MIRAKL", "AMAZON"

Response
{
  "date_created": "2019-04-01T15:16:31Z",
  "has_error_report": false,
  "import_id": 2035,
  "lines_in_error": 0,
  "lines_in_pending": 0,
  "lines_in_success": 1,
  "lines_read": 1,
  "mode": "NORMAL",
  "offer_deleted": 0,
  "offer_inserted": 1,
  "offer_updated": 0,
  "status": "COMPLETE"
}