Financial Details
1. Financial details information
Sending a request to GET /openapi/v2/orders/{orderId} you will get in the response a payload with the property financialDetails.
The financialDetails contain the information on order and orderline levels and have the precalculated financial details. They consist on the following parameters:
shipping: it reflects general amount of shipping costs that the customer pays within an order / orderline.subTotal: it reflects the amount of an order / orderline, excluding shipping costs.total: it reflects the general amount of order / orderline, including shipping costs.originalSubTotal: it’s the same assubTotal, but without any modifier (like for example: discount or promotions).originalTotal: it’s the same astotal, but without any modifier (like for example: discount or promotions).
Order level
Deprecated values on order level –> they will be removed soon: tax, shippingCost, subTotal, total.
Snippet of response example on order level:
{
"orderId": "b7b796f7-4cac-43e6-9877-100dbc0a729b",
"orderNumber": "O22-521841319296",
"status": "shipped",
"created": ....
.....
"financialDetails": {
"promo": [],
"total": {
"net": {
"amount": 126.77,
"currency": "EUR"
},
"vat": {
"amount": 24.09,
"currency": "EUR"
},
"gross": {
"amount": 150.86,
"currency": "EUR"
}
},
"shipping": {
"net": {
"amount": 3,
"currency": "EUR"
},
"vat": {
"amount": 0.57,
"currency": "EUR"
},
"gross": {
"amount": 3.57,
"currency": "EUR"
}
},
"originalSubTotal": {
"net": {
"amount": 123.77,
"currency": "EUR"
},
"vat": {
"amount": 23.52,
"currency": "EUR"
},
"gross": {
"amount": 147.29,
"currency": "EUR"
}
},
"originalTotal": {
"net": {
"amount": 126.77,
"currency": "EUR"
},
"vat": {
"amount": 24.09,
"currency": "EUR"
},
"gross": {
"amount": 150.86,
"currency": "EUR"
}
},
"subTotal": {
"net": {
"amount": 123.77,
"currency": "EUR"
},
"vat": {
"amount": 24.09,
"currency": "EUR"
},
"gross": {
"amount": 147.29,
"currency": "EUR"
}
}
},
...
Orderline level
Deprecated values on order level, they will be removed soon: pricePerItem, tax, taxRate, subTotal, includedFee .
Additional parameters:
vatRate: it reflects the applied VAT rate for the orderline.unitPrice: it reflects unit price of the product within the orderline.originalUnitPriceit is the unitPrice but without any modifier (like for example: discount or promotions).includedFees: any fee included in the price, like for example"type": "ECO_FEE"(éco-participation for destination FR_MAIN). Please use this and ignoreincludedFeearray as it will be removed.
Snippet of response example on orderline level:
"orderLines": [
{
"orderLineId": "00f9ccdb-4e10-4ecc-a97c-e675351447fe",
"financialDetails": {
"promo": [],
"vatRate": 19,
"includedFees": [
{
"amount": 3.5,
"currency": "EUR",
"type": "ECO_FEE"
}
],
"unitPrice": {
"net": {
"amount": 123.77,
"currency": "EUR"
},
"vat": {
"amount": 23.52,
"currency": "EUR"
},
"gross": {
"amount": 147.29,
"currency": "EUR"
}
},
"shipping": {
"vatRate": 19,
"net": {
"amount": 3,
"currency": "EUR"
},
"vat": {
"amount": 0.57,
"currency": "EUR"
},
"gross": {
"amount": 3.57,
"currency": "EUR"
}
},
"originalUnitPrice": {
"net": {
"amount": 123.77,
"currency": "EUR"
},
"vat": {
"amount": 23.52,
"currency": "EUR"
},
"gross": {
"amount": 147.29,
"currency": "EUR"
}
},
"originalSubTotal": {
"net": {
"amount": 123.77,
"currency": "EUR"
},
"vat": {
"amount": 23.52,
"currency": "EUR"
},
"gross": {
"amount": 147.29,
"currency": "EUR"
}
},
"subTotal": {
"net": {
"amount": 123.77,
"currency": "EUR"
},
"vat": {
"amount": 23.52,
"currency": "EUR"
},
"gross": {
"amount": 147.29,
"currency": "EUR"
}
}
}
}
...