https://your-instance.mirakl.net/
Return only orders without channel. If true
, ignore the channel_codes
Start update date for filtering. Mirakl will subtract a time delta to ensure no orders are missed due to network and/or software latency.
If true
returns only orders with incidents in progress, if false
returns orders without incidents in progress
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. Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
<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.
https://your-instance.mirakl.net/api/orders
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'
{ "orders": [ { … } ], "total_count": 0 }
https://your-instance.mirakl.net/api/orders/shipping_from
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"
}
}
}
]
}'
{ "order_lines": [ { … } ] }
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:
megabytes_per_chunk
parameter.items_per_chunk
parameter.Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
End order update date for filtering. Must be used with start_update_date
.
Maximum number of items included in the generated files
Maximum mega bytes weight for generated files
Return only orders without channel. If true
, ignore the channel_codes
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. https://your-instance.mirakl.net/api/orders/async-export
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"
}'
{ "tracking_id": "string" }