Mirakl Marketplace APIs (latest-release)

Servers

URL to be replaced by your Mirakl instance URL

https://your-instance.mirakl.net/

Stores

Operations

Platform Settings

Operations

Invoicing and Accounting

Operations

Products

Operations

List Catalog categories (parents and children) related to a Catalog category

Request

Query

hierarchystring

Catalog category code

max_levelinteger(int32)

Number of children catalog category levels to retrieve. If not specified, all child catalog categories are retrieved

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/hierarchies?hierarchy=string&max_level=0&shop_id=0'

Responses

Bodyapplication/json

hierarchiesArray of objects(H11_Response_200_Hierarchies)

List of hierarchies

Response

application/json

{
  "hierarchies": [
    { … }
  ]
}

Get products for a list of product references

Request

Note: this resource returns 100 products maximum
Results are sorted by product sku asc, then by product identifier type asc and then by product identifier asc

Query

product_referencesstring

List of the product's identifiers with type, (structure: "product_references=<productIdType>|<productId>,<productIdType>|<productId>, ...") where accepted <productIdType> are operator’s product references, like EAN or UPC for example. Note that SHOP_SKU or SKU are invalid <productIdType> for this API.

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.

localestring

<ISO-639>_<ISO-3166> ("en_US") or <ISO-639> ("en") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/products?locale=string&product_references=string&shop_id=0'

Responses

Bodyapplication/json

productsArray of objects(P31_Response_200_Products)

Products list

Response

application/json

{
  "products": [
    { … }
  ]
}

Get the import status for a product import

Request

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'

Responses

Bodyapplication/json

conversion_optionsobject(P42_Response_200_ConversionOptions)

conversion_typestring

Type of conversion applied on products

date_createdstring(date-time)

Import creation date

has_error_reportboolean

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

has_new_product_reportboolean

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

has_transformation_error_reportboolean

Returns true if transformation error report is available. Value is filled when the import is completed

has_transformed_fileboolean

Returns true if transformed file is available. Value is filled when the import is completed

import_idinteger(int64)

Import identifier

import_statusstring

Import status

integration_detailsobject(P42_Response_200_IntegrationDetails)

reason_statusstring

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

shop_idinteger(int64)

Shop identifier

transform_lines_in_errorinteger(int64)

Total count of transformed lines in error

transform_lines_in_successinteger(int64)

Total count of transformed lines in success

transform_lines_readinteger(int64)

Total count of transformed lines read

transform_lines_with_warninginteger(int64)

Total count of transformed lines with warning

Response

application/json

{
  "conversion_options": {
    "ai_enrichment": { … },
    "ai_rewrite": { … }
  },
  "conversion_type": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "has_error_report": true,
  "has_new_product_report": true,
  "has_transformation_error_report": true,
  "has_transformed_file": true,
  "import_id": 0,
  "import_status": "string",
  "integration_details": {
    "invalid_products": 0,
    "products_not_accepted_in_time": 0,
    "products_not_synchronized_in_time": 0,
    "products_reimported": 0,
    "products_successfully_synchronized": 0,
    "products_with_synchronization_issues": 0,
    "products_with_wrong_identifiers": 0,
    "rejected_products": 0
  },
  "reason_status": "string",
  "shop_id": 0,
  "transform_lines_in_error": 0,
  "transform_lines_in_success": 0,
  "transform_lines_read": 0,
  "transform_lines_with_warning": 0
}

Get the error report file for a product import ("Non-integrated products report")

Request

This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).

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}/error_report?shop_id=0'

Responses

Bodyapplication/octet-stream

string(binary)

Get the product integration report file for a product import ("Added products report")

Request

This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).

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}/new_product_report?shop_id=0'

Responses

Bodyapplication/octet-stream

string(binary)

Get the transformed file for a product import ("File in operator format")

Request

This API returns a CSV file.

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}/transformed_file?shop_id=0'

Responses

Bodytext/csv

string(binary)

Get the transformation error report file for a product import ("Source file error report")

Request

This API returns a CSV, XLSX or XML file, depending on the file format provided by the seller.

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}/transformation_error_report?shop_id=0'

Responses

Bodyapplication/octet-stream

string(binary)

Get information about product import statuses

Request

If the last_request_date param is not set the api returns all product imports.

Query

last_request_datestring(date-time)

Return only product imports that have changed since this date

statusstring

Product import status. One of CANCELLED, WAITING, RUNNING, SENT, COMPLETE, FAILED

has_transformed_fileboolean

If true returns only product import trackings with transformed file

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.

maxinteger(int32)

Maximum number of items returned per page

offsetinteger(int32)

Index of the first item (among all the results) in the returned page

sortstring

How the results should be sorted

orderstring

Sort direction

curl -i -X GET \
  'https://your-instance.mirakl.net/api/products/imports?has_transformed_file=true&last_request_date=2019-08-24T14%3A15%3A22Z&max=0&offset=0&order=string&shop_id=0&sort=string&status=string'

Responses

Bodyapplication/json

product_import_trackingsArray of objects(P51_Response_200_ProductImportTrackings)

List of product import status information

total_countinteger(int32)

Total count of product import status information

Response

application/json

{
  "product_import_trackings": [
    { … }
  ],
  "total_count": 0
}

Get the product attribute configuration

Request

Retrieves all attributes for parents and children of the requested hierarchy

Query

hierarchystring

Code of the hierarchy (category) for which to retrieve the attributes. If not specified, all attributes are retrieved.

max_levelinteger(int32)

Number of children hierarchy (category) levels to retrieve. If not specified, attributes from all children hierarchies are retrieved.

all_operator_attributesboolean

Set to "true" to get all the operator attributes.

Default false

with_rolesboolean

Set to "true" to get only the attributes that have roles.

Default false

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/attributes?all_operator_attributes=false&hierarchy=string&max_level=0&shop_id=0&with_roles=false'

Responses

Export success

Body

attributesArray of objects(PM11_Response_200_Attributes)

List of attributes

Response

{
  "attributes": [
    { … }
  ]
}

Get information about operator's value lists

Request

Query

codestring

The operator's values list code. If not specified, all values lists are retrieved

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/values_lists?code=string&shop_id=0'

Responses

Bodyapplication/json

values_listsArray of objects(VL11_Response_200_ValuesLists)

List of values list

Response

application/json

{
  "values_lists": [
    { … }
  ]
}

Messages

Operations

Offers

Operations

Orders

Operations

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations