Order details is an object linked to a specific order that represents additional information such as prices, duties, etc.
Note:
- If the merchant_* fields are not provided, they will be computed automatically.
- The non merchant_* fields are mandatory if you are using ZigZag for returns.
- The total_order_price_excl_tax_amount & total_order_price_incl_tax_amount are used on Shipup dashboards and can help you better understand your marketing's performance with Shipup.
| FIELD | DESCRIPTION |
|---|---|
| currency_code string (ISO 4217) | The currency in which the customer paid their order. Defaults to your account's currency. |
| total_order_price_excl_tax_amount string (ex: "20.00" for 20€) | The total order cost (incl. tax) the customer paid (including discounts). |
| total_order_price_incl_tax_amount string (ex: "20.00" for 20€) | The total order cost (excl. tax) the customer paid (including discounts). |
| vat_amount string (ex: "20.00" for 20€) | The VAT the customer paid. |
| shipping_cost_amount string (ex: "20.00" for 20€) | The shipping cost paid by the customer. |
| duty_paid_amount string (ex: "20.00" for 20€) | The duties already paid by the customer. |
| merchant_currency_code string (ISO 4217 ) | The main currency of your account. Used to display values in a single currency in your Analytics. |
| merchant_total_order_price_excl_tax_amount string (ex: "20.00" for 20€) | The total order cost (incl. tax) in your account's currency. |
| merchant_total_order_price_incl_tax_amount string (ex: "20.00" for 20€) | The total order cost (excl. tax) in your account's currency. |
| merchant_vat_amount string (ex: "20.00" for 20€) | The VAT in your account's currency. |
| merchant_shipping_cost_amount string (ex: "20.00" for 20€) | The shipping cost in your account's currency.. |
| merchant_duty_paid_amount string (ex: "20.00" for 20€) | The duties already paid in your account's currency. |
Disclaimer
The order details are being currently implemented, you can already send the information to us, but you won't be able to use it right away. Our team will keep you posted as soon as we have more info about it.