Update shipping origin (shipping_from
) information on order lines.
A maximum of 100 order lines can be sent at once.
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. 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" }
Use this API to query the order export status after an API OR13 call.
Until the export via API OR13 is complete, the status returned by API OR14 is PENDING
.
You must call API OR14 until you get the COMPLETED
status which correspond to a completed and successful export from API OR13.
The URLs in API OR14 response contain all the files from API OR13 export.
Browse those urls and query them using the GET method.
In case of error, the status is FAILED
.
In case of export canceled, the status is CANCELED
.
curl -i -X GET \
'https://your-instance.mirakl.net/api/orders/async-export/status/{tracking_id}?shop_id=0'
{ "last_updated": "2019-08-24T14:15:22Z", "status": "string", "urls": [ "string" ] }