Order's identifier
curl -i -X PUT \
'https://your-instance.mirakl.net/api/orders/{order_id}/cancel?shop_id=0'List of representations of cancellations to be created
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 and order total prices) do not include taxes.TAX_INCLUDED: the price fields include the tax amounts. curl -i -X PUT \
'https://your-instance.mirakl.net/api/orders/cancel?shop_id=0' \
-H 'Content-Type: application/json' \
-d '{
"cancelations": [
{
"amount": 0,
"currency_iso_code": "string",
"fees": [
{
"amount": 0,
"code": "string"
}
],
"order_line_id": "string",
"quantity": 0,
"reason_code": "string",
"shipping_amount": 0,
"shipping_taxes": [
{
"amount": 0,
"code": "string"
}
],
"taxes": [
{
"amount": 0,
"code": "string"
}
]
}
],
"order_tax_mode": "string"
}'OK
List of representations of created cancellations
Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the cancelation.
Possible values:
TAX_EXCLUDED: the price fields (amount, shipping amount) are expressed without tax (taxes should be added to these prices in order to get the full amount including taxes).TAX_INCLUDED: the price fields include the tax amount. { "cancelations": [ { … } ], "order_tax_mode": "string" }
Only specified custom field values will be updated.
In order to delete an custom field's value, set it to null or an empty string. Note that you may not delete the value of a required custom field value.
Output will return information on the status of the update attempt by giving:
curl -i -X PUT \
'https://your-instance.mirakl.net/api/orders/{order_id}/additional_fields?shop_id=0' \
-H 'Content-Type: application/json' \
-d '{
"order_additional_fields": [
{
"code": "string",
"type": "string"
}
],
"order_lines": [
{
"order_line_additional_fields": [
{
"code": "string",
"type": "string"
}
],
"order_line_id": "string"
}
]
}'{ "order_update_errors": { "errors": [ … ], "input": { … } }, "order_update_result": { "order_additional_fields": [ … ], "order_lines": [ … ] } }