List all document types

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

List all custom fields

Request

Query

entitiesstring

A comma separated list of entities on which the additional fields must apply. Accepted values are OFFER, SHOP, ORDER and ORDER_LINE. Ex: OFFER,SHOP.

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/additional_fields?entities=string&locale=string&shop_id=0'

Responses

Bodyapplication/json

additional_fieldsArray of objects(AF01_Response_200_AdditionalFields)

Response

application/json

{
  "additional_fields": [
    { … }
  ]
}

List all enabled channels

Request

Results are sorted by code

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.

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

Responses

Bodyapplication/json

channelsArray of objects(CH11_Response_200_Channels)

List of channels

Response

application/json

{
  "channels": [
    { … }
  ]
}

List currency codes and labels

Request

List currency codes and labels activated on the platform

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.

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

Responses

Bodyapplication/json

currenciesArray of objects(CUR01_Response_200_Currencies)

List of currencies

Response

application/json

{
  "currencies": [
    { … }
  ]
}

List all document types

Request

Query

entitiesstring

A comma separated list of values, representing the type of entities the document type should be related to. Accepted values are ORDER, SHOP. Ex: ORDER,SHOP

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/documents?entities=string&locale=string&shop_id=0'

Responses

Bodyapplication/json

documentsArray of objects(DO01_Response_200_Documents)

Document types

Response

application/json

{
  "documents": [
    { … }
  ]
}

List locale codes and labels

Request

List locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM system

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

Responses

Bodyapplication/json

localesArray of objects(L01_Response_200_Locales)

List of locales

Response

application/json

{
  "locales": [
    { … }
  ]
}

List offer conditions

Request

Sorted by sort index, set in the back-office

Query

activeboolean

Filter offer condition on their active status. If true, only active offer conditions are returned. If false, only inactive offer conditions are returned. If not specified, all offer conditions are returned.

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/offers/states?active=true&locale=string&shop_id=0'

Responses

Bodyapplication/json

offer_statesArray of objects(OF61_Response_200_OfferStates)

Offer conditions

Response

application/json

{
  "offer_states": [
    { … }
  ]
}

List platform configurations

Request

List platform configurations such as general information, modules and features activated.

Note: This configuration represents modules and major features enabled during platform setup. This differs from the PC02 API which export the platform business settings configurable by the operator in the back office.

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/platform/configuration?shop_id=0'

Responses

Bodyapplication/json

featuresobject(PC01_Response_200_Features)

modulesobject(PC01_Response_200_Modules)

platform_configurationobject(PC01_Response_200_PlatformConfiguration)

platform_namestring

Operator platform name

tenant_namestring

Tenant platform name

timezonestring

Platform timezone

Response

application/json

{
  "features": {
    "circular_economy_data_collection": true,
    "competitive_pricing_tool": true,
    "direct_payment_customer_store": { … },
    "disable_seller_alternative_carrier": true,
    "kyc_status_per_seller": true,
    "lead_time_to_ship_by_sellers_enabled": "string",
    "multi_currency": true,
    "no_reply_needed": true,
    "offer_prices_decimals": "string",
    "operator_csv_delimiter": "string",
    "order_conditions": { … },
    "order_tax_mode": "string",
    "order_workflows": { … },
    "payment_confirmation": true,
    "pricing": { … },
    "product_data_validation_by_channel": true,
    "shipment": { … },
    "shop_tax_options": { … },
    "tax_collection": { … },
    "tax_id_number": { … }
  },
  "modules": {
    "mirakl_catalog_integrator": true,
    "mirakl_catalog_manager": true,
    "mirakl_platform_services": true,
    "offer_management": true,
    "offer_management_mode": "string",
    "order_management": true,
    "order_management_mode": "string",
    "promotions": true,
    "quotes": true,
    "tax_manager": { … }
  },
  "platform_configuration": {
    "customer_model": { … },
    "platform_model": { … }
  },
  "platform_name": "string",
  "tenant_name": "string",
  "timezone": "string"
}

List reasons

Request

This API returns cancellation, refund, incident, and message reasons.
Reasons are sorted by type then sort index (set in the back-office)

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.

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

Responses

Bodyapplication/json

reasonsArray of objects(RE01_Response_200_Reasons)

List of reasons detailed

Response

application/json

{
  "reasons": [
    { … }
  ]
}

List all active shipping zones

Request

Results are sorted by index, set in the back-office

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.

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/shipping/zones?locale=string&shop_id=0'

Responses

Bodyapplication/json

shipping_zonesArray of objects(SH11_Response_200_ShippingZones)

List of shipping zones

Response

application/json

{
  "shipping_zones": [
    { … }
  ]
}

List all active shipping methods

Request

Results are sorted by index, set in the back-office

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.

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/shipping/types?locale=string&shop_id=0'

Responses

Bodyapplication/json

shipping_typesArray of objects(SH12_Response_200_ShippingTypes)

List of shipping types

Response

application/json

{
  "shipping_types": [
    { … }
  ]
}

List all carriers

Request

Results are sorted alphabetically by carrier label

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/shipping/carriers?shop_id=0'

Responses

Bodyapplication/json

carriersArray of objects(SH21_Response_200_Carriers)

List of carriers

Response

application/json

{
  "carriers": [
    { … }
  ]
}

List all logistic classes

Request

Results are sorted by index, set in the back-office

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.

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/shipping/logistic_classes?locale=string&shop_id=0'

Responses

Bodyapplication/json

logistic_classesArray of objects(SH31_Response_200_LogisticClasses)

List of logistic classes

Response

application/json

{
  "logistic_classes": [
    { … }
  ]
}

Health Check endpoint

Request

Use this endpoint to check that Mirakl Platform is up.
You can ignore the response body that is subject to change, checking the response code is enough.

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

Responses

Invoicing and Accounting

Operations

Products

Operations

Messages

Operations

Offers

Operations

Orders

Operations

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations