Mirakl Marketplace APIs (latest-release)

Languages
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

Messages

Operations

Offers

Operations

Orders

Operations

List orders with pagination

Request

Pagination is enabled by default. For large requests, use asynchronous order export APIs OR13, OR14 and OR15 instead.

Query
order_idsstring<= 100

A comma-separated list of order's identifiers

order_references_for_customerstring<= 100

A comma-separated list of order references for customer

order_references_for_sellerstring<= 100

A comma-separated list of order references for seller

order_state_codesstring

A comma-separated list of order state's codes

channel_codesstring<= 100

A comma-separated list of channel codes

only_null_channelboolean

Return only orders without channel. If true, ignore the channel_codes

Default false
start_datestring(date-time)

Start creation date for filtering

end_datestring(date-time)

End creation date for filtering

start_update_datestring(date-time)

Start update date for filtering. Mirakl will subtract a time delta to ensure no orders are missed due to network and/or software latency.

end_update_datestring(date-time)

End update date for filtering

customer_debitedboolean

Order paid by customer

payment_workflowstring

Payment workflow of an order

has_incidentboolean

If true returns only orders with incidents in progress, if false returns orders without incidents in progress

Default "all"
fulfillment_center_codeArray of strings<= 100

Code of the fulfillment center

order_tax_modestring

Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.
Possible values:

  • TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) do not include taxes.
  • TAX_INCLUDED: the price fields include the tax amount.
  • If this query parameter is not specified, the default order tax mode of the platform is used.
  • 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.

    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/orders?channel_codes=string&customer_debited=true&end_date=2019-08-24T14%3A15%3A22Z&end_update_date=2019-08-24T14%3A15%3A22Z&fulfillment_center_code=string&has_incident=all&locale=string&max=0&offset=0&only_null_channel=false&order=string&order_ids=string&order_references_for_customer=string&order_references_for_seller=string&order_state_codes=string&order_tax_mode=string&payment_workflow=string&shop_id=0&sort=string&start_date=2019-08-24T14%3A15%3A22Z&start_update_date=2019-08-24T14%3A15%3A22Z'

    Responses

    OK

    Bodyapplication/json
    ordersArray of objects(OR11_Response_200_Orders)

    List of orders

    total_countinteger(int32)

    Total count of orders

    Response
    application/json
    { "orders": [ { … } ], "total_count": 0 }

    Update order line shipping origin

    Request

    Update shipping origin (shipping_from) information on order lines.

    A maximum of 100 order lines can be sent at once.

    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.

    Bodyapplication/json
    order_linesArray of objects(OR07_Request_OrderLines)[ 1 .. 100 ] items

    Order lines to be updated, maximum number of order lines per call: 100

    curl -i -X PUT \
      'https://your-instance.mirakl.net/api/orders/shipping_from?shop_id=0' \
      -H 'Content-Type: application/json' \
      -d '{
        "order_lines": [
          {
            "id": "string",
            "shipping_from": {
              "address": {
                "city": "string",
                "country_iso_code": "string",
                "state": "string",
                "street_1": "string",
                "street_2": "string",
                "zip_code": "string"
              },
              "warehouse": {
                "code": "string"
              }
            }
          }
        ]
      }'

    Responses

    OK

    Bodyapplication/json
    order_linesArray of objects(OR07_Response_200_OrderLines)

    A list containing each order line of the request, stating if the update was performed or failed.

    Response
    application/json
    { "order_lines": [ { … } ] }

    Export orders asynchronously

    Request

    The API returns a tracking id to be used to query API OR14.
    Mirakl recommends to use API OR13 instead of API OR11 as it can handle very large volumes of data.
    You must give at least one date range filter: created or last updated date.
    API OR13 supports the chunk of the export file into multiple files in order to:

    • respect a maximum megabyte weight using the megabytes_per_chunk parameter.
    • respect a maximum amount of exported items using the items_per_chunk parameter.

    Only one export request can be created for the same shop account.
    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.

    Bodyapplication/json
    channel_codesArray of strings[ 0 .. 100 ] items

    A list of channel codes

    end_datestring(date-time)

    End order creation date for filtering. Must be used with start_date.

    end_update_datestring(date-time)

    End order update date for filtering. Must be used with start_update_date.

    fulfillment_center_codesstring[ 0 .. 100 ] characters

    Code of the fulfillment center

    items_per_chunkinteger(int64)[ 10000 .. 1000000 ]

    Maximum number of items included in the generated files

    Default 1000000
    megabytes_per_chunkinteger(int64)[ 10 .. 1024 ]

    Maximum mega bytes weight for generated files

    Default 512
    only_null_channelboolean

    Return only orders without channel. If true, ignore the channel_codes

    Default false
    order_state_codesArray of strings[ 0 .. 100 ] items

    A list of order state's codes

    order_tax_modestring

    Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.
    Possible values:

    • TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) do not include taxes.
    • TAX_INCLUDED: the price fields include the tax amount.
  • If this query parameter is not specified, the default order tax mode of the platform is used.
  • start_datestring(date-time)

    Start order creation date for filtering. Must be used with end_date.

    start_update_datestring(date-time)

    Start order update date for filtering. Mirakl will subtract a time delta to ensure no orders are missed due to network and/or software latency. Must be used with end_update_date.

    curl -i -X POST \
      'https://your-instance.mirakl.net/api/orders/async-export?locale=string&shop_id=0' \
      -H 'Content-Type: application/json' \
      -d '{
        "channel_codes": [
          "string"
        ],
        "end_date": "2019-08-24T14:15:22Z",
        "end_update_date": "2019-08-24T14:15:22Z",
        "fulfillment_center_codes": "string",
        "items_per_chunk": 1000000,
        "megabytes_per_chunk": 512,
        "only_null_channel": false,
        "order_state_codes": [
          "string"
        ],
        "order_tax_mode": "string",
        "start_date": "2019-08-24T14:15:22Z",
        "start_update_date": "2019-08-24T14:15:22Z"
      }'

    Responses

    Asynchronous order export tracking creation success

    Bodyapplication/json
    tracking_idstring

    Id to poll in order to track the export's progress

    Response
    application/json
    { "tracking_id": "string" }

    Incidents

    Operations

    Picklists

    Operations

    Promotions

    Operations

    Users

    Operations

    Returns

    Operations

    Multiple shipments

    Operations