P41 - Import products to the operator information system

Products

P41 - Import products to the operator information system

Request

Description

Returns the import identifier to track the status of the import

Call Frequency

Recommended usage: Every hour, for each seller

Maximum usage: Every 15 minutes, for each seller

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_PRODUCT_WRITE)

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.

Bodymultipart/form-data

conversion_optionsobject

Options used for product file conversion when conversion_type is AI_CONVERTER

conversion_typestring

Product file conversion type. If Catalog Transformer is enabled but the conversionType is not specified, then the default configuration from the shop settings will be used

Enum: "AI_CONVERTER", "STANDARD"

filestring, (binary)required

Import file (CSV or XML or XLSX) to upload. Use multipart/form-data with name file

operator_formatboolean

Force the use of the operator product format

Default:false

curl -i -X POST \
  https://your-instance.mirakl.net/api/products/imports \
  -H 'Content-Type: multipart/form-data' \
  -F 'conversion_options="{\"ai_enrichment\":{\"status\":\"ENABLED\"},\"ai_rewrite\":{\"status\":\"ENABLED\"},\"ai_translation\":{\"status\":\"ENABLED\"}}";type=application/json' \
  -F 'conversion_type="\"AI_CONVERTER\"";type=application/json' \
  -F 'file=@path/to/file' \
  -F 'operator_format="true";type=application/json'

Responses

Created

Headers

Locationany

Pre-calculated URL to call to get the import status

Bodyapplication/json

import_idinteger, (int64)required

Import identifier

Response

{
  "import_id": 2035
}