Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
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/refund?shop_id=0' \
-H 'Content-Type: application/json' \
-d '{
"order_tax_mode": "string",
"refunds": [
{
"amount": 0,
"currency_iso_code": "string",
"excluded_from_shipment": true,
"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"
}
]
}
]
}'OK
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 refund.
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. { "order_tax_mode": "string", "refunds": [ { … } ] }
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" }