Skip to content
Products
/
/
/
P42 - Get the import stat...

P42 - Get the import status for a product import

Request

Call Frequency
Recommended usage: Once per minute until getting the import final status
Maximum usage: Once per minute
Read More
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_PRODUCT_WRITE)
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/products/imports/{import}?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
conversion_optionsobject

Options used for the conversion

conversion_typestring

Type of conversion applied on products

Enum: "AI_CONVERTER"

date_createdstring, (date-time)required

Import creation date

has_error_reportbooleanrequired

Returns true if error report is available. Value is filled when the import status is COMPLETE.

has_new_product_reportbooleanrequired

Returns true if new product report is available. Value is filled when the import status is COMPLETE.

has_transformation_error_reportboolean

Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE.

has_transformed_filebooleanrequired

Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE.

import_idinteger, (int64)required

Import identifier

import_statusstringrequired

Import status

Enum: "TRANSFORMATION_WAITING", "TRANSFORMATION_RUNNING", "TRANSFORMATION_FAILED", "WAITING", "RUNNING", "SENT", "COMPLETE", "CANCELLED", "FAILED"

integration_detailsobject

Integration details

reason_statusstring

A message explaining the reason of the import status, if relevant

shop_idinteger, (int64)required

Shop identifier

transform_lines_in_errorinteger, (int64)required

Total count of transformed lines in error

transform_lines_in_successinteger, (int64)required

Total count of transformed lines in success

transform_lines_readinteger, (int64)required

Total count of transformed lines read

transform_lines_with_warninginteger, (int64)required

Total count of transformed lines with warning

Response
{
  "date_created": "2019-04-05T12:56:21Z",
  "has_error_report": false,
  "has_new_product_report": false,
  "has_transformation_error_report": false,
  "has_transformed_file": true,
  "import_id": 2005,
  "import_status": "SENT",
  "shop_id": 2000,
  "transform_lines_in_error": 0,
  "transform_lines_in_success": 1,
  "transform_lines_read": 1,
  "transform_lines_with_warning": 0
}