Skip to content
Products
/
/
/
STO02 - Get information a...

STO02 - Get information and statistics about an offer stock import

Request

Call Frequency
Recommended usage: After each STO01 call, every 5 minutes
Maximum usage: Once every 15 seconds
Read More
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_OFFER_STOCK_WRITE)
Path
import_idstringrequired

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/stock/imports/{import_id}/status?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_idstringrequired

Import ID

lines_in_errorinteger, (int32)

Total count of lines in error

lines_in_successinteger, (int32)

Total count of lines in success

shop_idinteger, (int64)required

Shop identifier

statusstringrequired

Import status

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

Response
{
  "date_created": "2023-03-28T09:34:42Z",
  "has_error_report": true,
  "import_id": "string",
  "lines_in_error": 0,
  "lines_in_success": 0,
  "shop_id": 0,
  "status": "WAITING"
}