# OR15 - Retrieve order export files once asynchronous export is complete (OR13). DescriptionRetrieve each chunk of an order export file via the URL generated once the asynchronous export is complete. Call FrequencyRecommended usage: Once per file URL returned by OR14, after COMPLETED statusMaximum usage: Once per file URL returned by OR14, after COMPLETED status Endpoint: GET /dynamic-url/The+URL+is+retrieved+from+OR14+output/OR15 Security: Front-Bearer-Token, OAuth-2 ## Security: - `Front-Bearer-Token` (unknown) http bearer JWT - `OAuth-2` (unknown) oauth2 ## Response 200: - `200` (unknown) OK ## Response 200 fields (application/json): - `orders` (array, required) List of orders - `orders.acceptance_decision_date` (string) The date where the shop decided to accept or refuse the order. Null when the order was automatically refused or accepted. - `orders.can_cancel` (boolean, required) Indicate if the order can be cancelled - `orders.can_evaluate` (boolean, required) Indicates if the order can be evaluated by the customer - `orders.can_shop_ship` (boolean, required) Indicates if shops can or cannot ship orders - `orders.channel` (object) - `orders.channel.code` (string, required) Channel code - `orders.channel.label` (string, required) Channel label - `orders.commercial_id` (string, required) Commercial order's identifier - `orders.commissionable` (boolean) Indicates if the order is commissionable. Only available when the platform follows a mixed commission model - `orders.created_date` (string, required) Order's creation date - `orders.currency_iso_code` (string, required) Shop's currency (iso format) Enum: `"AED"`, `"ARS"`, `"AUD"`, `"BAM"`, `"BGN"`, `"BHD"`, `"BRL"`, `"CAD"`, `"CHF"`, `"CLP"`, `"CNY"`, `"COP"`, `"CZK"`, `"DKK"`, `"EGP"`, `"EUR"`, `"GBP"`, `"GEL"`, `"GTQ"`, `"HKD"`, `"HRK"`, `"HUF"`, `"IDR"`, `"ILS"`, `"INR"`, `"IQD"`, `"JOD"`, `"JPY"`, `"KES"`, `"KRW"`, `"KWD"`, `"LKR"`, `"MAD"`, `"MGA"`, `"MXN"`, `"MYR"`, `"NGN"`, `"NOK"`, `"NZD"`, `"OMR"`, `"PEN"`, `"PHP"`, `"PKR"`, `"PLN"`, `"QAR"`, `"RON"`, `"RSD"`, `"RUB"`, `"SAR"`, `"SEK"`, `"SGD"`, `"TND"`, `"TRY"`, `"THB"`, `"TWD"`, `"UAH"`, `"USD"`, `"UYU"`, `"UZS"`, `"VND"`, `"ZAR"` - `orders.customer` (object, required) - `orders.customer.accounting_contact` (object) - `orders.customer.accounting_contact.civility` (string) Customer contact's civility - `orders.customer.accounting_contact.customer_id` (string, required) Customer contact's identifier - `orders.customer.accounting_contact.email` (string, required) Customer contact's email - `orders.customer.accounting_contact.firstname` (string, required) Customer contact's firstname - `orders.customer.accounting_contact.lastname` (string, required) Customer contact's lastname - `orders.customer.accounting_contact.locale` (string) Customer contact's locale - `orders.customer.billing_address` (object, required) - `orders.customer.billing_address.city` (string, required) Address city - `orders.customer.billing_address.civility` (string) Civility of the person associated with the address - `orders.customer.billing_address.company` (string) Company of the person associated with the address - `orders.customer.billing_address.company_2` (string) Second company information of the person associated with the address - `orders.customer.billing_address.country` (string, required) Address country - `orders.customer.billing_address.country_iso_code` (string, required) Country ISO 3166-1 code of the address Enum: `"AFG"`, `"ALA"`, `"ALB"`, `"DZA"`, `"ASM"`, `"AND"`, `"AGO"`, `"AIA"`, `"ATA"`, `"ATG"`, `"ARG"`, `"ARM"`, `"ABW"`, `"AUS"`, `"AUT"`, `"AZE"`, `"BHS"`, `"BHR"`, `"BGD"`, `"BRB"`, `"BLR"`, `"BEL"`, `"BLZ"`, `"BEN"`, `"BMU"`, `"BTN"`, `"BOL"`, `"BES"`, `"BIH"`, `"BWA"`, `"BVT"`, `"BRA"`, `"IOT"`, `"BRN"`, `"BGR"`, `"BFA"`, `"BDI"`, `"KHM"`, `"CMR"`, `"CAN"`, `"CPV"`, `"CYM"`, `"CAF"`, `"TCD"`, `"CHL"`, `"CHN"`, `"CXR"`, `"CCK"`, `"COL"`, `"COM"`, `"COG"`, `"COD"`, `"COK"`, `"CRI"`, `"CIV"`, `"HRV"`, `"CUB"`, `"CUW"`, `"CYP"`, `"CZE"`, `"DNK"`, `"DJI"`, `"DMA"`, `"DOM"`, `"ECU"`, `"EGY"`, `"SLV"`, `"GNQ"`, `"ERI"`, `"EST"`, `"ETH"`, `"FLK"`, `"FRO"`, `"FJI"`, `"FIN"`, `"FRA"`, `"GUF"`, `"PYF"`, `"ATF"`, `"GAB"`, `"GMB"`, `"GEO"`, `"DEU"`, `"GHA"`, `"GIB"`, `"GRC"`, `"GRL"`, `"GRD"`, `"GLP"`, `"GUM"`, `"GTM"`, `"GGY"`, `"GIN"`, `"GNB"`, `"GUY"`, `"HTI"`, `"HMD"`, `"VAT"`, `"HND"`, `"HKG"`, `"HUN"`, `"ISL"`, `"IND"`, `"IDN"`, `"IRQ"`, `"IRL"`, `"IMN"`, `"ISR"`, `"ITA"`, `"JAM"`, `"JPN"`, `"JEY"`, `"JOR"`, `"KAZ"`, `"KEN"`, `"KIR"`, `"KOR"`, `"KWT"`, `"KGZ"`, `"LAO"`, `"LVA"`, `"LBN"`, `"LSO"`, `"LBR"`, `"LBY"`, `"LIE"`, `"LTU"`, `"LUX"`, `"MAC"`, `"MKD"`, `"MDG"`, `"MWI"`, `"MYS"`, `"MDV"`, `"MLI"`, `"MLT"`, `"MHL"`, `"MTQ"`, `"MRT"`, `"MUS"`, `"MYT"`, `"MEX"`, `"FSM"`, `"MDA"`, `"MCO"`, `"MNG"`, `"MNE"`, `"MSR"`, `"MAR"`, `"MOZ"`, `"MMR"`, `"NAM"`, `"NRU"`, `"NPL"`, `"NLD"`, `"NCL"`, `"NZL"`, `"NIC"`, `"NER"`, `"NGA"`, `"NIU"`, `"NFK"`, `"MNP"`, `"NOR"`, `"OMN"`, `"PAK"`, `"PLW"`, `"PSE"`, `"PAN"`, `"PNG"`, `"PRY"`, `"PER"`, `"PHL"`, `"PCN"`, `"POL"`, `"PRT"`, `"PRI"`, `"QAT"`, `"REU"`, `"ROU"`, `"RUS"`, `"RWA"`, `"BLM"`, `"SHN"`, `"KNA"`, `"LCA"`, `"MAF"`, `"SPM"`, `"VCT"`, `"WSM"`, `"SMR"`, `"STP"`, `"SAU"`, `"SEN"`, `"SRB"`, `"SYC"`, `"SLE"`, `"SGP"`, `"SXM"`, `"SVK"`, `"SVN"`, `"SLB"`, `"SOM"`, `"ZAF"`, `"SGS"`, `"SSD"`, `"ESP"`, `"LKA"`, `"SUR"`, `"SJM"`, `"SWZ"`, `"SWE"`, `"CHE"`, `"TWN"`, `"TJK"`, `"TZA"`, `"THA"`, `"TLS"`, `"TGO"`, `"TKL"`, `"TON"`, `"TTO"`, `"TUN"`, `"TUR"`, `"TKM"`, `"TCA"`, `"TUV"`, `"UGA"`, `"UKR"`, `"ARE"`, `"GBR"`, `"USA"`, `"UMI"`, `"URY"`, `"UZB"`, `"VUT"`, `"VEN"`, `"VNM"`, `"VGB"`, `"VIR"`, `"WLF"`, `"YEM"`, `"ZMB"`, `"ZWE"` - `orders.customer.billing_address.firstname` (string) First name of the person associated with the address - `orders.customer.billing_address.lastname` (string, required) Last name of the person associated with the address - `orders.customer.billing_address.phone` (string) Phone - `orders.customer.billing_address.phone_secondary` (string) Phone secondary - `orders.customer.billing_address.state` (string) Address state - `orders.customer.billing_address.street_1` (string, required) First information line of the address street, mandatory except if country_iso_code = "JPN". - `orders.customer.billing_address.street_2` (string) Second information line of the address street - `orders.customer.billing_address.zip_code` (string) Address zip code - `orders.customer.civility` (string) Customer's civility - `orders.customer.customer_id` (string, required) Customer's identifier - `orders.customer.delivery_contact` (object) - `orders.customer.delivery_contact.civility` (string) Customer contact's civility - `orders.customer.delivery_contact.customer_id` (string, required) Customer contact's identifier - `orders.customer.delivery_contact.email` (string, required) Customer contact's email - `orders.customer.delivery_contact.firstname` (string, required) Customer contact's firstname - `orders.customer.delivery_contact.lastname` (string, required) Customer contact's lastname - `orders.customer.delivery_contact.locale` (string) Customer contact's locale - `orders.customer.email` (string, required) Customer's email - `orders.customer.firstname` (string, required) Customer's first name - `orders.customer.lastname` (string, required) Customer's last name - `orders.customer.locale` (string) Customer's locale - `orders.customer.organization` (object) - `orders.customer.organization.address` (object) - `orders.customer.organization.address.city` (string, required) Address city - `orders.customer.organization.address.country_iso_code` (string, required) Country ISO 3166-1 code of the address, used by Mirakl to format the address (back office, delivery bill, invoices...) and to adapt the address validation to the country (see zip_code field) Enum: `"AFG"`, `"ALA"`, `"ALB"`, `"DZA"`, `"ASM"`, `"AND"`, `"AGO"`, `"AIA"`, `"ATA"`, `"ATG"`, `"ARG"`, `"ARM"`, `"ABW"`, `"AUS"`, `"AUT"`, `"AZE"`, `"BHS"`, `"BHR"`, `"BGD"`, `"BRB"`, `"BLR"`, `"BEL"`, `"BLZ"`, `"BEN"`, `"BMU"`, `"BTN"`, `"BOL"`, `"BES"`, `"BIH"`, `"BWA"`, `"BVT"`, `"BRA"`, `"IOT"`, `"BRN"`, `"BGR"`, `"BFA"`, `"BDI"`, `"KHM"`, `"CMR"`, `"CAN"`, `"CPV"`, `"CYM"`, `"CAF"`, `"TCD"`, `"CHL"`, `"CHN"`, `"CXR"`, `"CCK"`, `"COL"`, `"COM"`, `"COG"`, `"COD"`, `"COK"`, `"CRI"`, `"CIV"`, `"HRV"`, `"CUB"`, `"CUW"`, `"CYP"`, `"CZE"`, `"DNK"`, `"DJI"`, `"DMA"`, `"DOM"`, `"ECU"`, `"EGY"`, `"SLV"`, `"GNQ"`, `"ERI"`, `"EST"`, `"ETH"`, `"FLK"`, `"FRO"`, `"FJI"`, `"FIN"`, `"FRA"`, `"GUF"`, `"PYF"`, `"ATF"`, `"GAB"`, `"GMB"`, `"GEO"`, `"DEU"`, `"GHA"`, `"GIB"`, `"GRC"`, `"GRL"`, `"GRD"`, `"GLP"`, `"GUM"`, `"GTM"`, `"GGY"`, `"GIN"`, `"GNB"`, `"GUY"`, `"HTI"`, `"HMD"`, `"VAT"`, `"HND"`, `"HKG"`, `"HUN"`, `"ISL"`, `"IND"`, `"IDN"`, `"IRQ"`, `"IRL"`, `"IMN"`, `"ISR"`, `"ITA"`, `"JAM"`, `"JPN"`, `"JEY"`, `"JOR"`, `"KAZ"`, `"KEN"`, `"KIR"`, `"KOR"`, `"KWT"`, `"KGZ"`, `"LAO"`, `"LVA"`, `"LBN"`, `"LSO"`, `"LBR"`, `"LBY"`, `"LIE"`, `"LTU"`, `"LUX"`, `"MAC"`, `"MKD"`, `"MDG"`, `"MWI"`, `"MYS"`, `"MDV"`, `"MLI"`, `"MLT"`, `"MHL"`, `"MTQ"`, `"MRT"`, `"MUS"`, `"MYT"`, `"MEX"`, `"FSM"`, `"MDA"`, `"MCO"`, `"MNG"`, `"MNE"`, `"MSR"`, `"MAR"`, `"MOZ"`, `"MMR"`, `"NAM"`, `"NRU"`, `"NPL"`, `"NLD"`, `"NCL"`, `"NZL"`, `"NIC"`, `"NER"`, `"NGA"`, `"NIU"`, `"NFK"`, `"MNP"`, `"NOR"`, `"OMN"`, `"PAK"`, `"PLW"`, `"PSE"`, `"PAN"`, `"PNG"`, `"PRY"`, `"PER"`, `"PHL"`, `"PCN"`, `"POL"`, `"PRT"`, `"PRI"`, `"QAT"`, `"REU"`, `"ROU"`, `"RUS"`, `"RWA"`, `"BLM"`, `"SHN"`, `"KNA"`, `"LCA"`, `"MAF"`, `"SPM"`, `"VCT"`, `"WSM"`, `"SMR"`, `"STP"`, `"SAU"`, `"SEN"`, `"SRB"`, `"SYC"`, `"SLE"`, `"SGP"`, `"SXM"`, `"SVK"`, `"SVN"`, `"SLB"`, `"SOM"`, `"ZAF"`, `"SGS"`, `"SSD"`, `"ESP"`, `"LKA"`, `"SUR"`, `"SJM"`, `"SWZ"`, `"SWE"`, `"CHE"`, `"TWN"`, `"TJK"`, `"TZA"`, `"THA"`, `"TLS"`, `"TGO"`, `"TKL"`, `"TON"`, `"TTO"`, `"TUN"`, `"TUR"`, `"TKM"`, `"TCA"`, `"TUV"`, `"UGA"`, `"UKR"`, `"ARE"`, `"GBR"`, `"USA"`, `"UMI"`, `"URY"`, `"UZB"`, `"VUT"`, `"VEN"`, `"VNM"`, `"VGB"`, `"VIR"`, `"WLF"`, `"YEM"`, `"ZMB"`, `"ZWE"` - `orders.customer.organization.address.state` (string) Address state - `orders.customer.organization.address.street_1` (string, required) First information line of the address street - `orders.customer.organization.address.street_2` (string) Second information line of the address street - `orders.customer.organization.address.zip_code` (string, required) Address zip code, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay - `orders.customer.organization.electronic_address` (string) Identifier of the customer organization used to route and deliver e-invoices. It is also known as 'Routing Identifier' or 'PEPPOL Participant ID' - `orders.customer.organization.identification_number` (string) Number used to identify the customer organization as an established business in a country. E.g: SIRET number in France, NIF in Spain. Required for new organizations. - `orders.customer.organization.name` (string) Name of the organization. Required for new organizations. - `orders.customer.organization.organization_id` (string, required) Customer's organization id (from the operator's system) - `orders.customer.organization.phone_number` (string) Phone number of the customer organization - `orders.customer.organization.tax_identification_number` (string) Tax identification number of the organization. - `orders.customer.shipping_address` (object, required) - `orders.customer.shipping_address.additional_info` (string) Additional information for the shipping address - `orders.customer.shipping_address.city` (string, required) Address city - `orders.customer.shipping_address.civility` (string) Civility of the person associated with the address - `orders.customer.shipping_address.company` (string) Company of the person associated with the address - `orders.customer.shipping_address.company_2` (string) Second company information of the person associated with the address - `orders.customer.shipping_address.country` (string, required) Address country - `orders.customer.shipping_address.country_iso_code` (string, required) Country ISO 3166-1 code of the address Enum: `"AFG"`, `"ALA"`, `"ALB"`, `"DZA"`, `"ASM"`, `"AND"`, `"AGO"`, `"AIA"`, `"ATA"`, `"ATG"`, `"ARG"`, `"ARM"`, `"ABW"`, `"AUS"`, `"AUT"`, `"AZE"`, `"BHS"`, `"BHR"`, `"BGD"`, `"BRB"`, `"BLR"`, `"BEL"`, `"BLZ"`, `"BEN"`, `"BMU"`, `"BTN"`, `"BOL"`, `"BES"`, `"BIH"`, `"BWA"`, `"BVT"`, `"BRA"`, `"IOT"`, `"BRN"`, `"BGR"`, `"BFA"`, `"BDI"`, `"KHM"`, `"CMR"`, `"CAN"`, `"CPV"`, `"CYM"`, `"CAF"`, `"TCD"`, `"CHL"`, `"CHN"`, `"CXR"`, `"CCK"`, `"COL"`, `"COM"`, `"COG"`, `"COD"`, `"COK"`, `"CRI"`, `"CIV"`, `"HRV"`, `"CUB"`, `"CUW"`, `"CYP"`, `"CZE"`, `"DNK"`, `"DJI"`, `"DMA"`, `"DOM"`, `"ECU"`, `"EGY"`, `"SLV"`, `"GNQ"`, `"ERI"`, `"EST"`, `"ETH"`, `"FLK"`, `"FRO"`, `"FJI"`, `"FIN"`, `"FRA"`, `"GUF"`, `"PYF"`, `"ATF"`, `"GAB"`, `"GMB"`, `"GEO"`, `"DEU"`, `"GHA"`, `"GIB"`, `"GRC"`, `"GRL"`, `"GRD"`, `"GLP"`, `"GUM"`, `"GTM"`, `"GGY"`, `"GIN"`, `"GNB"`, `"GUY"`, `"HTI"`, `"HMD"`, `"VAT"`, `"HND"`, `"HKG"`, `"HUN"`, `"ISL"`, `"IND"`, `"IDN"`, `"IRQ"`, `"IRL"`, `"IMN"`, `"ISR"`, `"ITA"`, `"JAM"`, `"JPN"`, `"JEY"`, `"JOR"`, `"KAZ"`, `"KEN"`, `"KIR"`, `"KOR"`, `"KWT"`, `"KGZ"`, `"LAO"`, `"LVA"`, `"LBN"`, `"LSO"`, `"LBR"`, `"LBY"`, `"LIE"`, `"LTU"`, `"LUX"`, `"MAC"`, `"MKD"`, `"MDG"`, `"MWI"`, `"MYS"`, `"MDV"`, `"MLI"`, `"MLT"`, `"MHL"`, `"MTQ"`, `"MRT"`, `"MUS"`, `"MYT"`, `"MEX"`, `"FSM"`, `"MDA"`, `"MCO"`, `"MNG"`, `"MNE"`, `"MSR"`, `"MAR"`, `"MOZ"`, `"MMR"`, `"NAM"`, `"NRU"`, `"NPL"`, `"NLD"`, `"NCL"`, `"NZL"`, `"NIC"`, `"NER"`, `"NGA"`, `"NIU"`, `"NFK"`, `"MNP"`, `"NOR"`, `"OMN"`, `"PAK"`, `"PLW"`, `"PSE"`, `"PAN"`, `"PNG"`, `"PRY"`, `"PER"`, `"PHL"`, `"PCN"`, `"POL"`, `"PRT"`, `"PRI"`, `"QAT"`, `"REU"`, `"ROU"`, `"RUS"`, `"RWA"`, `"BLM"`, `"SHN"`, `"KNA"`, `"LCA"`, `"MAF"`, `"SPM"`, `"VCT"`, `"WSM"`, `"SMR"`, `"STP"`, `"SAU"`, `"SEN"`, `"SRB"`, `"SYC"`, `"SLE"`, `"SGP"`, `"SXM"`, `"SVK"`, `"SVN"`, `"SLB"`, `"SOM"`, `"ZAF"`, `"SGS"`, `"SSD"`, `"ESP"`, `"LKA"`, `"SUR"`, `"SJM"`, `"SWZ"`, `"SWE"`, `"CHE"`, `"TWN"`, `"TJK"`, `"TZA"`, `"THA"`, `"TLS"`, `"TGO"`, `"TKL"`, `"TON"`, `"TTO"`, `"TUN"`, `"TUR"`, `"TKM"`, `"TCA"`, `"TUV"`, `"UGA"`, `"UKR"`, `"ARE"`, `"GBR"`, `"USA"`, `"UMI"`, `"URY"`, `"UZB"`, `"VUT"`, `"VEN"`, `"VNM"`, `"VGB"`, `"VIR"`, `"WLF"`, `"YEM"`, `"ZMB"`, `"ZWE"` - `orders.customer.shipping_address.firstname` (string) First name of the person associated with the address - `orders.customer.shipping_address.internal_additional_info` (string) Internal additional information for the shipping address - `orders.customer.shipping_address.lastname` (string, required) Last name of the person associated with the address - `orders.customer.shipping_address.phone` (string) Phone - `orders.customer.shipping_address.phone_secondary` (string) Phone secondary - `orders.customer.shipping_address.state` (string) Address state - `orders.customer.shipping_address.street_1` (string, required) First information line of the address street, mandatory except if country_iso_code = "JPN". - `orders.customer.shipping_address.street_2` (string) Second information line of the address street - `orders.customer.shipping_address.zip_code` (string) Address zip code - `orders.customer_debited_date` (string) The payment's date of the order by the customer - `orders.customer_directly_pays_seller` (boolean) True if order is paid directly to seller. False otherwise. - `orders.delivery_date` (object) - `orders.delivery_date.earliest` (string, required) Earliest order delivery date - `orders.delivery_date.latest` (string, required) Latest order delivery date - `orders.discount_campaigns` (array) List of discount campaigns applied to one or more order lines in this order.This field aggregates all unique discount campaigns present across all order lines.Empty or absent if no discount campaigns were applied to any order line. - `orders.discount_campaigns.identifier` (string, required) The unique identifier of the discount campaign - `orders.fulfillment` (object, required) - `orders.fulfillment.center` (object, required) - `orders.fulfillment.center.code` (string, required) Center code - `orders.fully_refunded` (boolean, required) Refunds have been requested and their cumulated amounts correspond to the sum of all remaining active order lines. - `orders.has_customer_message` (boolean, required) Indicate if the customer has sent a message related to this order - `orders.has_incident` (boolean, required) Indicate if order has incident on at least one order line - `orders.has_invoice` (boolean, required) Is an invoice available for this order. - `orders.imprint_number` (string) The payment's imprint number given in OR01 input - `orders.invoice_details` (object) - `orders.invoice_details.document_details` (array) Invoice document information - `orders.invoice_details.document_details.format` (string) Accounting document format Enum: `"PDF"`, `"cXML"` - `orders.invoice_details.payment_terms` (object) - `orders.invoice_details.payment_terms.days` (integer, required) Number of days - `orders.invoice_details.payment_terms.type` (string, required) Payment terms type.Possible values: END_OF_MONTH: payment is due after a number of calendar days following the invoice issue date, at the end of the given month. NET: payment is due after a number of calendar days following the invoice issue date. Enum: `"END_OF_MONTH"`, `"NET"` - `orders.last_updated_date` (string, required) Order's last updated date - `orders.leadtime_to_ship` (integer, required) Order's lead time to ship, in calendar days. - `orders.order_additional_fields` (array) Order's custom fields - `orders.order_additional_fields.code` (string, required) Custom field's code - `orders.order_additional_fields.type` (string) Custom field's type Enum: `"STRING"`, `"DATE"`, `"NUMERIC"`, `"BOOLEAN"`, `"LINK"`, `"REGEX"`, `"TEXTAREA"`, `"LIST"`, `"MULTIPLE_VALUES_LIST"` Enum: "BOOLEAN", "DATE", "LINK", "LIST", "MULTIPLE_VALUES_LIST", "NUMERIC", "REGEX", "STRING", "TEXTAREA" - `orders.order_id` (string, required) Order's identifier - `orders.order_lines` (array, required) Order lines - `orders.order_lines.can_open_incident` (boolean, required) Indicate if an incident can be opened on the order line - `orders.order_lines.can_refund` (boolean, required) Indicate whether the order line full amount can be refunded - `orders.order_lines.cancelations` (array, required) List of the cancellations - `orders.order_lines.cancelations.amount` (number) Cancellation's amount - `orders.order_lines.cancelations.amount_breakdown` (object) - `orders.order_lines.cancelations.amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.cancelations.amount_breakdown.parts.amount` (number, required) Part's amount. The sum of each part's amount is equal to the total amount. - `orders.order_lines.cancelations.amount_breakdown.parts.commissionable` (boolean) Should this amount be applied to the sellers commissions calculation. - `orders.order_lines.cancelations.amount_breakdown.parts.debitable_from_customer` (boolean) Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file.If false, the amount is not taken into account when generating the debit file. - `orders.order_lines.cancelations.amount_breakdown.parts.payable_to_shop` (boolean) Should this amount be paid to the shop. If true, the amount is taken into account when generating the shop payment voucher.If false, the amount is not taken into account when generating the shop payment voucher. - `orders.order_lines.cancelations.commission_amount` (number, required) Cancellation's commission amount - `orders.order_lines.cancelations.commission_taxes` (array, required) Cancellation's commission taxes - `orders.order_lines.cancelations.commission_taxes.amount` (number, required) Tax amount - `orders.order_lines.cancelations.commission_taxes.code` (string, required) Tax code - `orders.order_lines.cancelations.commission_total_amount` (number, required) The total commission amount of the cancellation (commission amount + commission taxes) - `orders.order_lines.cancelations.created_date` (string, required) Cancellation's creation date - `orders.order_lines.cancelations.eco_contributions` (array) List of eco-contribution amounts and corresponding producer identifiers, if applicable Only available if the operator activates the circular economy information collection. - `orders.order_lines.cancelations.eco_contributions.epr_category_code` (string, required) Extended Producer Responsibility category - `orders.order_lines.cancelations.eco_contributions.producer_id` (string, required) Producer identifier of the eco-contribution. - `orders.order_lines.cancelations.eco_contributions.producer_id_owner` (string, required) Owner of the producerId - `orders.order_lines.cancelations.eco_contributions.total_amount` (number) Total amount of the eco-contribution - `orders.order_lines.cancelations.eco_contributions.unit_amount` (number) Unit amount of the eco-contribution - `orders.order_lines.cancelations.fees` (array) List of fees canceled on the order line - `orders.order_lines.cancelations.fees.amount` (number, required) Fee amount - `orders.order_lines.cancelations.fees.code` (string, required) Fee code - `orders.order_lines.cancelations.funding` (object) - `orders.order_lines.cancelations.funding.customer` (object, required) - `orders.order_lines.cancelations.funding.customer.fees` (object, required) - `orders.order_lines.cancelations.funding.customer.fees.breakdown` (array, required) The details of the customer funding applying on fees - `orders.order_lines.cancelations.funding.customer.offer` (object, required) - `orders.order_lines.cancelations.funding.customer.offer.breakdown` (array, required) The details of the customer funding applying on the order line offer - `orders.order_lines.cancelations.funding.customer.shipping` (object, required) - `orders.order_lines.cancelations.funding.customer.shipping.breakdown` (array, required) The details of the customer funding applying on the shipping - `orders.order_lines.cancelations.funding.customer.total_amount` (number, required) The total amount of the customer funding - `orders.order_lines.cancelations.funding.customer.total_tax_amount` (number, required) The total amount of taxes of the customer funding - `orders.order_lines.cancelations.funding.operator` (object, required) - `orders.order_lines.cancelations.funding.operator.fees` (object, required) - `orders.order_lines.cancelations.funding.operator.fees.breakdown` (array, required) The details of the operator funding applying on fees - `orders.order_lines.cancelations.funding.operator.offer` (object, required) - `orders.order_lines.cancelations.funding.operator.offer.breakdown` (array, required) The details of the operator funding applying on the order line offer - `orders.order_lines.cancelations.funding.operator.shipping` (object, required) - `orders.order_lines.cancelations.funding.operator.shipping.breakdown` (array, required) The details of the operator funding applying on the shipping - `orders.order_lines.cancelations.funding.operator.total_amount` (number, required) The total amount of the operator funding - `orders.order_lines.cancelations.funding.operator.total_tax_amount` (number, required) The total amount of taxes of the operator funding - `orders.order_lines.cancelations.id` (string, required) Cancellation's id - `orders.order_lines.cancelations.purchase_information` (object) - `orders.order_lines.cancelations.purchase_information.purchase_commission_on_fees` (object) - `orders.order_lines.cancelations.purchase_information.purchase_commission_on_fees.total_amount` (number, required) Cancelation’s purchase commission total amount on fees - `orders.order_lines.cancelations.purchase_information.purchase_commission_on_price` (number, required) Cancelation’s purchase commission amount - `orders.order_lines.cancelations.purchase_information.purchase_commission_on_shipping` (number, required) Cancelation’s purchase commission amount on shipping - `orders.order_lines.cancelations.purchase_information.purchase_fee_amount` (object) - `orders.order_lines.cancelations.purchase_information.purchase_fee_amount.total_amount` (number, required) Cancelation’s purchase fee total amount - `orders.order_lines.cancelations.purchase_information.purchase_price` (number, required) Cancelation’s purchase price excluding shipping charges and fees - `orders.order_lines.cancelations.purchase_information.purchase_shipping_price` (number, required) Cancelation’s purchase shipping charges - `orders.order_lines.cancelations.quantity` (integer) The quantity of products canceled (This quantity is informative only) - `orders.order_lines.cancelations.reason_code` (string) Cancellation reason's code - `orders.order_lines.cancelations.shipping_amount` (number) Cancellation's shipping amount - `orders.order_lines.cancelations.shipping_amount_breakdown` (object) - `orders.order_lines.cancelations.shipping_amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.cancelations.shipping_amount_breakdown.parts.amount` (number, required) Part's amount. The sum of each part's amount is equal to the total amount. - `orders.order_lines.cancelations.shipping_amount_breakdown.parts.commissionable` (boolean) Should this amount be applied to the sellers commissions calculation. - `orders.order_lines.cancelations.shipping_amount_breakdown.parts.debitable_from_customer` (boolean) Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file.If false, the amount is not taken into account when generating the debit file. - `orders.order_lines.cancelations.shipping_amount_breakdown.parts.payable_to_shop` (boolean) Should this amount be paid to the shop. If true, the amount is taken into account when generating the shop payment voucher.If false, the amount is not taken into account when generating the shop payment voucher. - `orders.order_lines.cancelations.shipping_taxes` (array) The taxes on the shipping price - `orders.order_lines.cancelations.shipping_taxes.amount` (number, required) Tax amount - `orders.order_lines.cancelations.shipping_taxes.amount_breakdown` (object) - `orders.order_lines.cancelations.shipping_taxes.amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.cancelations.shipping_taxes.code` (string, required) Tax code - `orders.order_lines.cancelations.shipping_taxes.purchase_tax` (object) - `orders.order_lines.cancelations.shipping_taxes.purchase_tax.purchase_amount` (number, required) Purchase tax amount - `orders.order_lines.cancelations.shipping_taxes.purchase_tax.purchase_rate` (number) Purchase tax rate - `orders.order_lines.cancelations.shipping_taxes.rate` (number) Tax rate - `orders.order_lines.cancelations.taxes` (array) The taxes on the price - `orders.order_lines.cancelations.taxes.amount` (number, required) Tax amount - `orders.order_lines.cancelations.taxes.amount_breakdown` (object) - `orders.order_lines.cancelations.taxes.amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.cancelations.taxes.code` (string, required) Tax code - `orders.order_lines.cancelations.taxes.purchase_tax` (object) - `orders.order_lines.cancelations.taxes.purchase_tax.purchase_amount` (number, required) Purchase tax amount - `orders.order_lines.cancelations.taxes.purchase_tax.purchase_rate` (number) Purchase tax rate - `orders.order_lines.cancelations.taxes.rate` (number) Tax rate - `orders.order_lines.category_code` (string, required) Category code of the product associated with the order line - `orders.order_lines.category_label` (string, required) Category label of the product associated with the order line - `orders.order_lines.commission_fee` (number, required) Order line's commission fee - `orders.order_lines.commission_rate_vat` (number, required) Commission tax rate applied for the order line Please use commission_taxes instead. If multi-taxes are applied to this order, this field will return the rate of the first tax applied. - `orders.order_lines.commission_taxes` (array) Commission taxes - `orders.order_lines.commission_taxes.amount` (number, required) Tax amount - `orders.order_lines.commission_taxes.code` (string, required) Tax code - `orders.order_lines.commission_taxes.rate` (number, required) Tax rate, as a percentage (between 0 and 100) - `orders.order_lines.commission_vat` (number, required) Commission tax of the order line Please use commission_taxes instead. If multi-taxes are applied to this order, this field will return the amount of the first tax applied. - `orders.order_lines.created_date` (string, required) Order line's creation date - `orders.order_lines.debited_date` (string) Order line's debited date - `orders.order_lines.description` (string, required) Order line's description - `orders.order_lines.discount_campaign` (object) - `orders.order_lines.discount_campaign.identifier` (string, required) The unique identifier of the discount campaign - `orders.order_lines.eco_contributions` (array) List of eco-contribution amounts and corresponding producer identifiers, if applicable Only available if the operator activates the circular economy information collection. - `orders.order_lines.eco_contributions.epr_category_code` (string, required) Extended Producer Responsibility category - `orders.order_lines.eco_contributions.producer_id` (string, required) Producer identifier of the eco-contribution. - `orders.order_lines.eco_contributions.producer_id_owner` (string, required) Owner of the producerId - `orders.order_lines.eco_contributions.total_amount` (number) Total amount of the eco-contribution - `orders.order_lines.eco_contributions.unit_amount` (number) Unit amount of the eco-contribution - `orders.order_lines.fees` (array) List of fees applied on the order line - `orders.order_lines.fees.amount` (number, required) Fee amount - `orders.order_lines.fees.code` (string, required) Fee code - `orders.order_lines.funding` (object) - `orders.order_lines.funding.customer` (object, required) - `orders.order_lines.funding.customer.fees` (object, required) - `orders.order_lines.funding.customer.fees.breakdown` (array, required) The details of the customer funding applying on fees - `orders.order_lines.funding.customer.fees.breakdown.amount` (number, required) The amount funded by the payment method - `orders.order_lines.funding.customer.fees.breakdown.method` (string, required) The payment method - `orders.order_lines.funding.customer.offer` (object, required) - `orders.order_lines.funding.customer.offer.breakdown` (array, required) The details of the customer funding applying on the order line offer - `orders.order_lines.funding.customer.offer.breakdown.amount` (number, required) The amount funded by the payment method - `orders.order_lines.funding.customer.offer.breakdown.method` (string, required) The payment method - `orders.order_lines.funding.customer.shipping` (object, required) - `orders.order_lines.funding.customer.shipping.breakdown` (array, required) The details of the customer funding applying on the shipping - `orders.order_lines.funding.customer.shipping.breakdown.amount` (number, required) The amount funded by the payment method - `orders.order_lines.funding.customer.shipping.breakdown.method` (string, required) The payment method - `orders.order_lines.funding.customer.total_amount` (number, required) The total amount of the customer funding - `orders.order_lines.funding.customer.total_tax_amount` (number, required) The total amount of taxes of the customer funding - `orders.order_lines.funding.operator` (object, required) - `orders.order_lines.funding.operator.fees` (object, required) - `orders.order_lines.funding.operator.fees.breakdown` (array, required) The details of the operator funding applying on fees - `orders.order_lines.funding.operator.fees.breakdown.amount` (number, required) The amount funded by the payment method - `orders.order_lines.funding.operator.fees.breakdown.method` (string, required) The payment method - `orders.order_lines.funding.operator.offer` (object, required) - `orders.order_lines.funding.operator.offer.breakdown` (array, required) The details of the operator funding applying on the order line offer - `orders.order_lines.funding.operator.offer.breakdown.amount` (number, required) The amount funded by the payment method - `orders.order_lines.funding.operator.offer.breakdown.method` (string, required) The payment method - `orders.order_lines.funding.operator.shipping` (object, required) - `orders.order_lines.funding.operator.shipping.breakdown` (array, required) The details of the operator funding applying on the shipping - `orders.order_lines.funding.operator.shipping.breakdown.amount` (number, required) The amount funded by the payment method - `orders.order_lines.funding.operator.shipping.breakdown.method` (string, required) The payment method - `orders.order_lines.funding.operator.total_amount` (number, required) The total amount of the operator funding - `orders.order_lines.funding.operator.total_tax_amount` (number, required) The total amount of taxes of the operator funding - `orders.order_lines.last_updated_date` (string, required) Order line's last updated date - `orders.order_lines.measurement` (object) - `orders.order_lines.measurement.actual_measurement` (number) Actual measurement on the order line - `orders.order_lines.measurement.adjustment_limit` (number) Adjustment limit of the order line - `orders.order_lines.measurement.measurement_unit` (string) Measurement unit of the order line Enum: `"GRAM"`, `"KILOGRAM"`, `"TON"`, `"POUND"`, `"OUNCE"`, `"MILLILITER"`, `"CENTILITER"`, `"CUBIC_METER"`, `"LITER"`, `"GALLON"`, `"FLUID_OUNCE"`, `"PINT"`, `"BARREL"`, `"CENTIMETER"`, `"METER"`, `"INCH"`, `"FEET"`, `"SQUARE_CENTIMETER"`, `"SQUARE_METER"`, `"SQUARE_INCH"`, `"SQUARE_FOOT"`, `"PIECE"` See deprecated valuesDeprecated values: `"USgal"`, `"bbl"`, `"cl"`, `"cm"`, `"cm2"`, `"floz"`, `"ft"`, `"ft2"`, `"g"`, `"in"`, `"in2"`, `"kg"`, `"l"`, `"lb"`, `"m"`, `"m2"`, `"m3"`, `"ml"`, `"oz"`, `"pt"`, `"t"` - `orders.order_lines.measurement.ordered_measurement` (number) Total measurement ordered on the order line - `orders.order_lines.offer_id` (integer, required) Associated offer's id - `orders.order_lines.offer_sku` (string, required) Associated offer sku (this is the sku of the offer defined by the shop) - `orders.order_lines.offer_state_code` (string, required) State of the offer associated with the order line - `orders.order_lines.order_line_additional_fields` (array, required) List of custom fields - `orders.order_lines.order_line_additional_fields.code` (string, required) Custom field's code - `orders.order_lines.order_line_additional_fields.type` (string) Custom field's type Enum: `"STRING"`, `"DATE"`, `"NUMERIC"`, `"BOOLEAN"`, `"LINK"`, `"REGEX"`, `"TEXTAREA"`, `"LIST"`, `"MULTIPLE_VALUES_LIST"` Enum: "BOOLEAN", "DATE", "LINK", "LIST", "MULTIPLE_VALUES_LIST", "NUMERIC", "REGEX", "STRING", "TEXTAREA" - `orders.order_lines.order_line_id` (string, required) Order line's identifier - `orders.order_lines.order_line_index` (integer, required) Order line's index in the order - `orders.order_lines.order_line_state` (string, required) Order line's state Enum: `"STAGING"`, `"WAITING_ACCEPTANCE"`, `"WAITING_DEBIT"`, `"WAITING_DEBIT_PAYMENT"`, `"SHIPPING"`, `"SHIPPED"`, `"TO_COLLECT"`, `"RECEIVED"`, `"CLOSED"`, `"REFUSED"`, `"CANCELED"`, `"INCIDENT_OPEN"`, `"REFUNDED"` See deprecated valuesDeprecated values: `"WAITING_REFUND"`, `"WAITING_REFUND_PAYMENT"` - `orders.order_lines.order_line_state_reason_code` (string) Reason's code of the order line's state - `orders.order_lines.order_line_state_reason_label` (string) Reason's label of the order line's state - `orders.order_lines.origin_unit_price` (number) The original unit price of the offer associated with the order line - `orders.order_lines.price` (number, required) Order line's price without shipping price - `orders.order_lines.price_additional_info` (string) Price's additional information of the offer - `orders.order_lines.price_amount_breakdown` (object) - `orders.order_lines.price_amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.price_amount_breakdown.parts.amount` (number, required) Part's amount. The sum of each part's amount is equal to the total amount. - `orders.order_lines.price_amount_breakdown.parts.commissionable` (boolean) Should this amount be applied to the sellers commissions calculation. - `orders.order_lines.price_amount_breakdown.parts.debitable_from_customer` (boolean) Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file.If false, the amount is not taken into account when generating the debit file. - `orders.order_lines.price_amount_breakdown.parts.payable_to_shop` (boolean) Should this amount be paid to the shop. If true, the amount is taken into account when generating the shop payment voucher.If false, the amount is not taken into account when generating the shop payment voucher. - `orders.order_lines.price_unit` (number, required) Unit price for the offer associated with the order line - `orders.order_lines.product_medias` (array, required) List of all product's media associated to the order line - `orders.order_lines.product_medias.media_url` (string, required) Media URL - `orders.order_lines.product_medias.mime_type` (string, required) Media MIME Type (.jpg, .png ...) - `orders.order_lines.product_medias.type` (string, required) Media TYPE (small, large...) - `orders.order_lines.product_shop_sku` (string) Shop SKU of the product associated with the order line - `orders.order_lines.product_sku` (string, required) SKU of the product associated with the order line - `orders.order_lines.product_title` (string, required) Title of the product associated with the order line - `orders.order_lines.promotions` (array) List of promotions - `orders.order_lines.promotions.apportioned` (boolean, required) true when the promotion's reward amount is divided and allocated proportionally to multiple order lines.false when the entire reward amount is allocated to one order line, or when the same discount percentage is applied to several order lines (one-step percentage off promotions). - `orders.order_lines.promotions.campaign` (object) - `orders.order_lines.promotions.campaign.identifier` (string, required) The identifier of the promotion campaign. - `orders.order_lines.promotions.configuration` (object, required) - `orders.order_lines.promotions.configuration.amount_off` (number) The amount off of the promotion. Only applicable when promotion is of type AMOUNT_OFF, null otherwise. - `orders.order_lines.promotions.configuration.free_items_quantity` (integer) The free item target quantity of the promotion. Only applicable when promotion is of type FREE_ITEMS, null otherwise. - `orders.order_lines.promotions.configuration.internal_description` (string, required) Promotion's Internal description, set by the shop at creation - `orders.order_lines.promotions.configuration.percentage_off` (number) The percentage off of the promotion. Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise. - `orders.order_lines.promotions.configuration.reduced_unit_price` (number) The new offer’s unit price triggered by the promotion. Only applicable when promotion is of type REDUCED_UNIT_PRICE, null otherwise. - `orders.order_lines.promotions.configuration.type` (string, required) Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET) Enum: `"AMOUNT_OFF"`, `"FREE_ITEMS"`, `"PERCENTAGE_OFF"`, `"REDUCED_UNIT_PRICE"` See deprecated valuesDeprecated values: `"ALL"` - `orders.order_lines.promotions.deduced_amount` (number, required) Promotion's amount for this line. - `orders.order_lines.promotions.id` (string, required) Promotion's id, defined by the shop - `orders.order_lines.promotions.offered_quantity` (integer) The quantity of free items offered by the promotion for this line. Only applicable when promotion is of type FREE_ITEMS, null otherwise. - `orders.order_lines.promotions.promo_code` (string) Promo code associated to the promotion - `orders.order_lines.purchase_information` (object) - `orders.order_lines.purchase_information.purchase_commission_on_fees` (object) - `orders.order_lines.purchase_information.purchase_commission_on_fees.total_amount` (number, required) Purchase order line’s commission total amount on fees - `orders.order_lines.purchase_information.purchase_commission_on_price` (number, required) Purchase order line’s commission amount - `orders.order_lines.purchase_information.purchase_commission_on_shipping` (number, required) Purchase order line’s commission amount on shipping - `orders.order_lines.purchase_information.purchase_fee_amount` (object) - `orders.order_lines.purchase_information.purchase_fee_amount.total_amount` (number, required) Purchase order line’s fee total amount - `orders.order_lines.purchase_information.purchase_price` (number, required) Purchase order line’s price excluding shipping charges and fees - `orders.order_lines.purchase_information.purchase_shipping_price` (number, required) Purchase order line’s shipping charges - `orders.order_lines.purchase_information.purchase_unit_price` (number, required) Purchase unit price computed from the given offer price - `orders.order_lines.quantity` (integer, required) Product's quantity for the order line - `orders.order_lines.received_date` (string) Product's date of receipt - `orders.order_lines.refunds` (array, required) List of the refunds - `orders.order_lines.refunds.amount` (number) Refund's amount - `orders.order_lines.refunds.amount_breakdown` (object) - `orders.order_lines.refunds.amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.refunds.amount_breakdown.parts.amount` (number, required) Part's amount. The sum of each part's amount is equal to the total amount. - `orders.order_lines.refunds.amount_breakdown.parts.commissionable` (boolean) Should this amount be applied to the sellers commissions calculation. - `orders.order_lines.refunds.amount_breakdown.parts.debitable_from_customer` (boolean) Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file.If false, the amount is not taken into account when generating the debit file. - `orders.order_lines.refunds.amount_breakdown.parts.payable_to_shop` (boolean) Should this amount be paid to the shop. If true, the amount is taken into account when generating the shop payment voucher.If false, the amount is not taken into account when generating the shop payment voucher. - `orders.order_lines.refunds.commission_amount` (number, required) Refund's commission amount - `orders.order_lines.refunds.commission_tax_amount` (number, required) The commission tax amount of the refund Please use commission_taxes instead. If multi-taxes are applied to this refund, this field will return the amount of the first tax applied. - `orders.order_lines.refunds.commission_taxes` (array, required) Refund's commission taxes - `orders.order_lines.refunds.commission_taxes.amount` (number, required) Tax amount - `orders.order_lines.refunds.commission_taxes.code` (string, required) Tax code - `orders.order_lines.refunds.commission_total_amount` (number, required) The total commission amount of the refund (commission amount + commission taxes) - `orders.order_lines.refunds.created_date` (string, required) Refund's creation date - `orders.order_lines.refunds.eco_contributions` (array) List of eco-contribution amounts and corresponding producer identifiers, if applicable Only available if the operator activates the circular economy information collection. - `orders.order_lines.refunds.eco_contributions.epr_category_code` (string, required) Extended Producer Responsibility category - `orders.order_lines.refunds.eco_contributions.producer_id` (string, required) Producer identifier of the eco-contribution. - `orders.order_lines.refunds.eco_contributions.producer_id_owner` (string, required) Owner of the producerId - `orders.order_lines.refunds.eco_contributions.total_amount` (number) Total amount of the eco-contribution - `orders.order_lines.refunds.eco_contributions.unit_amount` (number) Unit amount of the eco-contribution - `orders.order_lines.refunds.fees` (array) List of fees refunded on the order line - `orders.order_lines.refunds.fees.amount` (number, required) Fee amount - `orders.order_lines.refunds.fees.code` (string, required) Fee code - `orders.order_lines.refunds.funding` (object) - `orders.order_lines.refunds.funding.customer` (object, required) - `orders.order_lines.refunds.funding.customer.fees` (object, required) - `orders.order_lines.refunds.funding.customer.fees.breakdown` (array, required) The details of the customer funding applying on fees - `orders.order_lines.refunds.funding.customer.offer` (object, required) - `orders.order_lines.refunds.funding.customer.offer.breakdown` (array, required) The details of the customer funding applying on the order line offer - `orders.order_lines.refunds.funding.customer.shipping` (object, required) - `orders.order_lines.refunds.funding.customer.shipping.breakdown` (array, required) The details of the customer funding applying on the shipping - `orders.order_lines.refunds.funding.customer.total_amount` (number, required) The total amount of the customer funding - `orders.order_lines.refunds.funding.customer.total_tax_amount` (number, required) The total amount of taxes of the customer funding - `orders.order_lines.refunds.funding.operator` (object, required) - `orders.order_lines.refunds.funding.operator.fees` (object, required) - `orders.order_lines.refunds.funding.operator.fees.breakdown` (array, required) The details of the operator funding applying on fees - `orders.order_lines.refunds.funding.operator.offer` (object, required) - `orders.order_lines.refunds.funding.operator.offer.breakdown` (array, required) The details of the operator funding applying on the order line offer - `orders.order_lines.refunds.funding.operator.shipping` (object, required) - `orders.order_lines.refunds.funding.operator.shipping.breakdown` (array, required) The details of the operator funding applying on the shipping - `orders.order_lines.refunds.funding.operator.total_amount` (number, required) The total amount of the operator funding - `orders.order_lines.refunds.funding.operator.total_tax_amount` (number, required) The total amount of taxes of the operator funding - `orders.order_lines.refunds.id` (string, required) Refund's id - `orders.order_lines.refunds.order_refund_id` (string, required) The group identifier of the refunds created at the same time on the order - `orders.order_lines.refunds.purchase_information` (object) - `orders.order_lines.refunds.purchase_information.purchase_commission_on_fees` (object) - `orders.order_lines.refunds.purchase_information.purchase_commission_on_fees.total_amount` (number, required) Refund’s purchase commission total amount on fees - `orders.order_lines.refunds.purchase_information.purchase_commission_on_price` (number, required) Refund’s purchase commission amount - `orders.order_lines.refunds.purchase_information.purchase_commission_on_shipping` (number, required) Refund’s purchase commission amount on shipping - `orders.order_lines.refunds.purchase_information.purchase_fee_amount` (object) - `orders.order_lines.refunds.purchase_information.purchase_fee_amount.total_amount` (number, required) Refund’s purchase fee total amount - `orders.order_lines.refunds.purchase_information.purchase_price` (number, required) Refund’s purchase price excluding shipping charges and fees - `orders.order_lines.refunds.purchase_information.purchase_shipping_price` (number, required) Refund’s purchase shipping charges - `orders.order_lines.refunds.quantity` (integer, required) The quantity of products refunded (This quantity is informative only). - `orders.order_lines.refunds.reason_code` (string, required) Reason's code of the refund - `orders.order_lines.refunds.refund_state` (string, required) Refund's state Enum: `"WAITING_REFUND_TAX_CONFIRMATION"`, `"WAITING_REFUND"`, `"WAITING_REFUND_PAYMENT"`, `"REFUNDED"` - `orders.order_lines.refunds.shipping_amount` (number) Refund's shipping amount - `orders.order_lines.refunds.shipping_amount_breakdown` (object) - `orders.order_lines.refunds.shipping_amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.refunds.shipping_amount_breakdown.parts.amount` (number, required) Part's amount. The sum of each part's amount is equal to the total amount. - `orders.order_lines.refunds.shipping_amount_breakdown.parts.commissionable` (boolean) Should this amount be applied to the sellers commissions calculation. - `orders.order_lines.refunds.shipping_amount_breakdown.parts.debitable_from_customer` (boolean) Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file.If false, the amount is not taken into account when generating the debit file. - `orders.order_lines.refunds.shipping_amount_breakdown.parts.payable_to_shop` (boolean) Should this amount be paid to the shop. If true, the amount is taken into account when generating the shop payment voucher.If false, the amount is not taken into account when generating the shop payment voucher. - `orders.order_lines.refunds.shipping_taxes` (array) The taxes on the shipping price - `orders.order_lines.refunds.shipping_taxes.amount` (number, required) Tax amount - `orders.order_lines.refunds.shipping_taxes.amount_breakdown` (object) - `orders.order_lines.refunds.shipping_taxes.amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.refunds.shipping_taxes.code` (string, required) Tax code - `orders.order_lines.refunds.shipping_taxes.purchase_tax` (object) - `orders.order_lines.refunds.shipping_taxes.purchase_tax.purchase_amount` (number, required) Purchase tax amount - `orders.order_lines.refunds.shipping_taxes.purchase_tax.purchase_rate` (number) Purchase tax rate - `orders.order_lines.refunds.shipping_taxes.rate` (number) Tax rate - `orders.order_lines.refunds.state` (string, required) Refund's stateWarning: This field has been deprecated and will not contain newer states added to refunds. Use refund_state insteadEnum: `"WAITING_REFUND"`, `"WAITING_REFUND_PAYMENT"`, `"REFUNDED"` - `orders.order_lines.refunds.tax_legal_notice` (string) The legal notice applying to the refunded order line’s taxes - `orders.order_lines.refunds.taxes` (array) The taxes on the price - `orders.order_lines.refunds.taxes.amount` (number, required) Tax amount - `orders.order_lines.refunds.taxes.amount_breakdown` (object) - `orders.order_lines.refunds.taxes.amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.refunds.taxes.code` (string, required) Tax code - `orders.order_lines.refunds.taxes.purchase_tax` (object) - `orders.order_lines.refunds.taxes.purchase_tax.purchase_amount` (number, required) Purchase tax amount - `orders.order_lines.refunds.taxes.purchase_tax.purchase_rate` (number) Purchase tax rate - `orders.order_lines.refunds.taxes.rate` (number) Tax rate - `orders.order_lines.refunds.transaction_date` (string) The transaction date of the refund payment - `orders.order_lines.refunds.transaction_number` (string) The transaction number of the refund payment - `orders.order_lines.shipped_date` (string) Order line's shipped date - `orders.order_lines.shipping_from` (object) - `orders.order_lines.shipping_from.address` (object) - `orders.order_lines.shipping_from.address.city` (string) Address City - `orders.order_lines.shipping_from.address.country_iso_code` (string, required) Address Country ISO 3166-1 alpha-3 code (3 letters country code) - `orders.order_lines.shipping_from.address.state` (string) Address State - `orders.order_lines.shipping_from.address.street_1` (string) First information line of the address street - `orders.order_lines.shipping_from.address.street_2` (string) Second information line of the address street - `orders.order_lines.shipping_from.address.zip_code` (string) Address zip code - `orders.order_lines.shipping_from.warehouse` (object) - `orders.order_lines.shipping_from.warehouse.code` (string) The code of the warehouse - `orders.order_lines.shipping_price` (number, required) Total price of the order line's shipping price - `orders.order_lines.shipping_price_additional_unit` (number) Additional price of the shipping price unit - `orders.order_lines.shipping_price_amount_breakdown` (object) - `orders.order_lines.shipping_price_amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.shipping_price_amount_breakdown.parts.amount` (number, required) Part's amount. The sum of each part's amount is equal to the total amount. - `orders.order_lines.shipping_price_amount_breakdown.parts.commissionable` (boolean) Should this amount be applied to the sellers commissions calculation. - `orders.order_lines.shipping_price_amount_breakdown.parts.debitable_from_customer` (boolean) Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file.If false, the amount is not taken into account when generating the debit file. - `orders.order_lines.shipping_price_amount_breakdown.parts.payable_to_shop` (boolean) Should this amount be paid to the shop. If true, the amount is taken into account when generating the shop payment voucher.If false, the amount is not taken into account when generating the shop payment voucher. - `orders.order_lines.shipping_price_unit` (number) Unit price of the shipping price - `orders.order_lines.shipping_taxes` (array) List of taxes applied on shipping charges - `orders.order_lines.shipping_taxes.amount` (number, required) Tax amount - `orders.order_lines.shipping_taxes.amount_breakdown` (object) - `orders.order_lines.shipping_taxes.amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.shipping_taxes.amount_breakdown.parts.amount` (number, required) Part's amount. The sum of each part's amount is equal to the total amount. - `orders.order_lines.shipping_taxes.amount_breakdown.parts.commissionable` (boolean) Should this amount be applied to the sellers commissions calculation. - `orders.order_lines.shipping_taxes.amount_breakdown.parts.debitable_from_customer` (boolean) Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file.If false, the amount is not taken into account when generating the debit file. - `orders.order_lines.shipping_taxes.amount_breakdown.parts.payable_to_shop` (boolean) Should this amount be paid to the shop. If true, the amount is taken into account when generating the shop payment voucher.If false, the amount is not taken into account when generating the shop payment voucher. - `orders.order_lines.shipping_taxes.code` (string, required) Tax code - `orders.order_lines.shipping_taxes.purchase_tax` (object) - `orders.order_lines.shipping_taxes.purchase_tax.purchase_amount` (number, required) Purchase tax amount - `orders.order_lines.shipping_taxes.purchase_tax.purchase_rate` (number) Purchase tax rate - `orders.order_lines.shipping_taxes.rate` (number) Tax rate - `orders.order_lines.shipping_taxes.tax_calculation_rule` (string, required) The type of automated calculation done during a partial refund or cancellation.Possible values:- none: No calculation will be done in case of partial refund or cancellation. You must provide the amount of tax you want to refund or cancel when you request a refund or cancellation. Otherwise, the tax will not get refunded/cancelled.- proportional_to_amount: Mirakl will automatically calculate the proportional tax amount when a refund or cancellation is requested. You do not need to provide the amount of this tax when you request a refund or cancellation. Enum: `"PROPORTIONAL_TO_AMOUNT"`, `"NONE"` - `orders.order_lines.tax_legal_notice` (string) The legal notice applying to the order line’s taxes - `orders.order_lines.tax_recalculation_required` (boolean, required) True if the taxes of the order line must be recalculated. False otherwise - `orders.order_lines.taxes` (array) List of taxes applied on product price - `orders.order_lines.taxes.amount` (number, required) Tax amount - `orders.order_lines.taxes.amount_breakdown` (object) - `orders.order_lines.taxes.amount_breakdown.parts` (array, required) The parts which constitute the total amount. Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED. - `orders.order_lines.taxes.amount_breakdown.parts.amount` (number, required) Part's amount. The sum of each part's amount is equal to the total amount. - `orders.order_lines.taxes.amount_breakdown.parts.commissionable` (boolean) Should this amount be applied to the sellers commissions calculation. - `orders.order_lines.taxes.amount_breakdown.parts.debitable_from_customer` (boolean) Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file.If false, the amount is not taken into account when generating the debit file. - `orders.order_lines.taxes.amount_breakdown.parts.payable_to_shop` (boolean) Should this amount be paid to the shop. If true, the amount is taken into account when generating the shop payment voucher.If false, the amount is not taken into account when generating the shop payment voucher. - `orders.order_lines.taxes.code` (string, required) Tax code - `orders.order_lines.taxes.origin_unit_amount` (number) The original tax amount of the offer associated with the order line before a discount or a promotion - `orders.order_lines.taxes.purchase_tax` (object) - `orders.order_lines.taxes.purchase_tax.purchase_amount` (number, required) Purchase tax amount - `orders.order_lines.taxes.purchase_tax.purchase_rate` (number) Purchase tax rate - `orders.order_lines.taxes.rate` (number) Tax rate - `orders.order_lines.taxes.tax_calculation_rule` (string, required) The type of automated calculation done during a partial refund or cancellation.Possible values:- none: No calculation will be done in case of partial refund or cancellation. You must provide the amount of tax you want to refund or cancel when you request a refund or cancellation. Otherwise, the tax will not get refunded/cancelled.- proportional_to_amount: Mirakl will automatically calculate the proportional tax amount when a refund or cancellation is requested. You do not need to provide the amount of this tax when you request a refund or cancellation. Enum: `"PROPORTIONAL_TO_AMOUNT"`, `"NONE"` - `orders.order_lines.total_commission` (number, required) Order line's total commission (sum of the commission fee and the commission vat) - `orders.order_lines.total_price` (number, required) Order line's price with shipping price and fees. - `orders.order_refunds` (array) The list of refunds aggregated by group identifierAvailable when feature ‘order level tax calculation’ is enabled - `orders.order_refunds.order_refund_id` (string, required) The group identifier of the refunds created at the same time on the order - `orders.order_refunds.taxes` (array) Total amount of refunded taxes aggregated per tax code and rate - `orders.order_refunds.taxes.code` (string, required) Order tax code - `orders.order_refunds.taxes.rate` (number) Order tax rate - `orders.order_refunds.taxes.total_amount` (number, required) Order total refunded tax amount for product and shipping, for a defined tax code and rate - `orders.order_state` (string, required) Order's state Enum: `"STAGING"`, `"WAITING_ACCEPTANCE"`, `"WAITING_DEBIT"`, `"WAITING_DEBIT_PAYMENT"`, `"SHIPPING"`, `"SHIPPED"`, `"TO_COLLECT"`, `"RECEIVED"`, `"CLOSED"`, `"REFUSED"`, `"CANCELED"` See deprecated valuesDeprecated values: `"WAITING_REFUND"`, `"WAITING_REFUND_PAYMENT"` - `orders.order_state_reason_code` (string) Reason's code of the order state - `orders.order_state_reason_label` (string) Reason's label of the order state - `orders.order_tax_mode` (string, required) 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 order.Possible values: TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) 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. Enum: `"TAX_INCLUDED"`, `"TAX_EXCLUDED"` - `orders.order_taxes` (array) Total amount of taxes aggregated per tax code and rateAvailable when feature ‘order level tax calculation’ is enabled - `orders.order_taxes.code` (string, required) Order tax code - `orders.order_taxes.rate` (number) Order tax rate - `orders.order_taxes.total_amount` (number, required) Order total tax amount for product and shipping, for a defined tax code and rate - `orders.pay_out_psp_code` (string, required) PSP code for Pay-out Enum: `"NOT_SPECIFIED"`, `"MANGOPAY"`, `"MIRAKL_PAYOUT"`, `"OPERATOR"` - `orders.paymentType` (string, required) Warning: this field has been replaced by payment_type and will be removed soon. - `orders.payment_destination` (object) - `orders.payment_destination.@type` (string) Enum: `"IBAN"` Enum: "IBAN" - `orders.payment_destination.payment_reference` (string) The payment reference for bank transfer - `orders.payment_duration` (integer) The payment's duration (i.e. the delay after which the order is supposed to be paid), in days.Only applicable for PAY_ON_DUE_DATE orders, null otherwise.Note that this field has currently no impact on the order workflow, it is provided for information purposes. - `orders.payment_type` (string) The payment's type used by the customer to pay this order - `orders.payment_workflow` (string) The payment workflow followed by the order Enum: `"PAY_ON_ACCEPTANCE"`, `"PAY_ON_DELIVERY"`, `"PAY_ON_DUE_DATE"`, `"PAY_ON_SHIPMENT"`, `"NO_CUSTOMER_PAYMENT_CONFIRMATION"` - `orders.price` (number, required) Order's price (sum of order line's price) - `orders.promotions` (object) - `orders.promotions.applied_promotions` (array, required) The promotions applied on this order - `orders.promotions.applied_promotions.apportioned` (boolean, required) true when the promotion's reward amount is divided and allocated proportionally to multiple order lines.false when the entire reward amount is allocated to one order line, or when the same discount percentage is applied to several order lines (one-step percentage off promotions). - `orders.promotions.applied_promotions.campaign` (object) - `orders.promotions.applied_promotions.campaign.identifier` (string, required) The identifier of the promotion campaign. - `orders.promotions.applied_promotions.configuration` (object, required) - `orders.promotions.applied_promotions.configuration.amount_off` (number) The amount off of the promotion. Only applicable when promotion is of type AMOUNT_OFF, null otherwise. - `orders.promotions.applied_promotions.configuration.free_items_quantity` (integer) The free item target quantity of the promotion. Only applicable when promotion is of type FREE_ITEMS, null otherwise. - `orders.promotions.applied_promotions.configuration.internal_description` (string, required) Promotion's Internal description, set by the shop at creation - `orders.promotions.applied_promotions.configuration.percentage_off` (number) The percentage off of the promotion. Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise. - `orders.promotions.applied_promotions.configuration.reduced_unit_price` (number) The new offer’s unit price triggered by the promotion. Only applicable when promotion is of type REDUCED_UNIT_PRICE, null otherwise. - `orders.promotions.applied_promotions.configuration.type` (string, required) Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET) Enum: `"AMOUNT_OFF"`, `"FREE_ITEMS"`, `"PERCENTAGE_OFF"`, `"REDUCED_UNIT_PRICE"` See deprecated valuesDeprecated values: `"ALL"` - `orders.promotions.applied_promotions.deduced_amount` (number, required) Promotion's amount for this line. - `orders.promotions.applied_promotions.id` (string, required) Promotion's id, defined by the shop - `orders.promotions.applied_promotions.offered_quantity` (integer) The quantity of free items offered by the promotion for this line. Only applicable when promotion is of type FREE_ITEMS, null otherwise. - `orders.promotions.applied_promotions.promo_code` (string) Promo code associated to the promotion - `orders.promotions.total_deduced_amount` (number, required) The total amount deduced on this order thanks to the promotions - `orders.quote_id` (string) Quote's id from which the order has been placed, or null if it was not from a quote - `orders.references` (object) - `orders.references.order_reference_for_customer` (string) Order reference for customer - `orders.references.order_reference_for_seller` (string) Order reference for seller - `orders.shipping_carrier_code` (string) Shipping carrier code (associated with the Shipping company label) - `orders.shipping_carrier_standard_code` (string) Shipping carrier standard code (associated with the shipping carrier code) - `orders.shipping_company` (string) Shipping company - `orders.shipping_deadline` (string) Order's shipping deadline - `orders.shipping_price` (number, required) Order's shipping price (sum of order line's shipping price) - `orders.shipping_pudo_id` (string) PickUp DropOff (PUDO) point identifier - `orders.shipping_tracking` (string) Shipping tracking - `orders.shipping_tracking_url` (string) Shipping tracking url - `orders.shipping_type_code` (string, required) Code of shipping's type - `orders.shipping_type_label` (string, required) Label of shipping's type - `orders.shipping_type_standard_code` (string) Shipping type's standard code - `orders.shipping_zone_code` (string, required) Code of shipping's zone - `orders.shipping_zone_label` (string, required) Label of shipping's zone - `orders.shop_id` (integer, required) Shop's identifier - `orders.shop_name` (string, required) Shop's name - `orders.total_commission` (number, required) Order's total commission (sum of the order line's total commission) - `orders.total_price` (number, required) Total order's price (sum of the order's price with shipping price and fees). - `orders.transaction_date` (string) Payment's transaction date - `orders.transaction_number` (string) Payment's transaction number - `orders.waiting_funding_confirmation` (boolean) True if the order is awaiting a funding update (dependent on 'Pause the order debit workflow when funding must be updated' operator toggle activation). False otherwise. - `orders.waiting_tax_confirmation` (boolean) True if the order is awaiting a tax confirmation (dependent on 'Pause the order debit workflow when taxes must be recalculated' operator toggle activation). False otherwise. ## Response 200 examples: - `Complete example with value types (application/json)` (unknown)