Place order
POST/purchase-order
This endpoint can be used to place order.
It will return one or several sub-orders, if the products provided are sold by different suppliers. One order will be created by supplier.
About order IDs, we generate them on our side.
You must wait for our API response returning an OK response before eventually storing the order on your side, because the order creation can be rejected by our system.
Request
Header Parameters
Authorization cookie, obtained from OAuth 2 endpoint
- application/json
Body
required
Order data to be placed
Array [
]
Array [
]
customer
Customer
required
Customer object
Mega code of the organization, unique identifier of the company.
Customer's email.
Customer's firstname.
Customer's lastname.
Customer's profession.
Customer’s billing address id selected.
Customer’s delivery address id selected.
Possible values: [fr_fr, be_fr, be_nl, de_de, es_es, pt_pt, nl_nl, pl_pl, uk_en]
Locale of user in Magento.
Possible values: [FR-FR, BE-BE, BL-BL, DE-DE, ES-ES, PT-PT, NL-NL, PL-PL, UK-UK]
Code of the customer shipping zone.
shops
PlaceOrderShop[]
Array of shop related info. \n Contains delivery instruction, delivery date in case of delivery-rounds chosen as delivery method.
Unique id of the shop.
Delivery instructions for the seller.
Shipping date in case the customer has selected 'Delivery round' method. Mandatory if delivery-rounds is selected.
items
PlaceOrderItem[]
required
Array of offer/quantity
Unique id of offer.
Quantity related to offer.
Possible values: [delivery-rounds, STD, SDD, EXP, SERVICES, extra-shipping-fee, punch_out]
Shipping type code.
Product instructions.
Responses
- 200
- 400
- 401
- 503
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
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.Array [
- BOOLEAN
- DATE
- LINK
- LIST
- MULTIPLE_VALUES_LIST
- NUMERIC
- REGEX
- STRING
- TEXTAREA
]
Array [
Array [
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
- BOOLEAN
- DATE
- LINK
- LIST
- MULTIPLE_VALUES_LIST
- NUMERIC
- REGEX
- STRING
- TEXTAREA
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
]
Array [
Array [
]
]
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.Array [
]
- IBAN
Array [
]
]
orders
object[]
List of orders
The date where the shop decided to accept or refuse the order. Null when the order was automatically refused or accepted.
Indicate if the order can be cancelled
Indicates if the order can be evaluated by the customer
Indicates if shops can or cannot ship orders
channel
object
The channel of the commercial's order
Channel code
Channel label
Commercial order's identifier
Indicates if the order is commissionable. Only available when the platform follows a mixed commission model
Order's creation date
Shop's currency (iso format)
customer
object
Information of the customer who ordered
accounting_contact
object
Data related to the accounting contact in the organization
Possible values: <= 20 characters
Customer contact's civility
Possible values: <= 50 characters
Customer contact's identifier
Possible values: <= 255 characters
Customer contact's email
Possible values: <= 255 characters
Customer contact's firstname
Possible values: <= 255 characters
Customer contact's lastname
Customer contact's locale
billing_address
object
Customer's billing address
Address city
Civility of the person associated with the address
Company of the person associated with the address
Second company information of the person associated with the address
Address country
Country ISO 3166-1 code of the address
First name of the person associated with the address
Last name of the person associated with the address
Phone
Phone secondary
Address state
First information line of the address street
Second information line of the address street
Address zip code
Customer's civility
Customer's identifier
delivery_contact
object
Data related to the delivery contact in the organization
Possible values: <= 20 characters
Customer contact's civility
Possible values: <= 50 characters
Customer contact's identifier
Possible values: <= 255 characters
Customer contact's email
Possible values: <= 255 characters
Customer contact's firstname
Possible values: <= 255 characters
Customer contact's lastname
Customer contact's locale
Customer's email
Customer's first name
Customer's last name
Customer's locale
organization
object
Data related to the organization that created the order (B2B transactions)
address
object
Address of the organization. Required for new organizations.
Possible values: <= 255 characters
Address city
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)
Possible values: <= 255 characters
Address state
Possible values: <= 255 characters
First information line of the address street
Possible values: <= 255 characters
Second information line of the address street
Possible values: <= 255 characters
Address zip code, mandatory except for: Chile, Peru, Hong-Kong, Qatar, Bahrain, Saudi Arabia, Oman, Kuwait, Egypt or United Arab Emirates
Possible values: <= 255 characters
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.
Possible values: <= 255 characters
Name of the organization. Required for new organizations.
Possible values: <= 50 characters
Customer's organization id (from the operator's system)
Possible values: <= 255 characters
Tax identification number of the organization.
shipping_address
object
Customer's shipping address
Additional information for the shipping address
Address city
Civility of the person associated with the address
Company of the person associated with the address
Second company information of the person associated with the address
Address country
Country ISO 3166-1 code of the address
First name of the person associated with the address
Internal additional information for the shipping address
Last name of the person associated with the address
Phone
Phone secondary
Address state
First information line of the address street
Second information line of the address street
Address zip code
The payment's date of the order by the customer
True if order is paid directly to seller. False otherwise.
delivery_date
object
Expected order delivery date
Earliest order delivery date
Latest order delivery date
fulfillment
object
Fulfillment information
center
object
Fulfillment center code
Center code
Refunds have been requested and their cumulated amounts correspond to the sum of all remaining active order lines.
Indicate if the customer has sent a message related to this order
Indicate if order has incident on at least one order line
Is an invoice available for this order.
The payment's imprint number given in OR01 input
invoice_details
object
Invoice information linked to the order
document_details
object[]
Invoice document information
Accounting document format
payment_terms
object
Payment terms
Number of days
Payment terms type.
Possible values:
Order's last updated date
order_additional_fields
object[]
Order's additional fields
Additional field's code
type
string
Possible values: [BOOLEAN, DATE, LINK, LIST, MULTIPLE_VALUES_LIST, NUMERIC, REGEX, STRING, TEXTAREA]
Additional field's type
Additional field's value
Additional field's value
Additional field's value
Additional field's value
Values of the additional field
Additional field's value
Additional field's value
Additional field's value
Additional field's value
Order's identifier
order_lines
object[]
Order lines
Indicate if an incident can be opened on the order line
Indicate whether the order line full amount can be refunded
cancelations
object[]
List of the cancellations
Cancellation's amount
amount_breakdown
object
The breakdown of the cancellation's amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Cancellation's commission amount
commission_taxes
object[]
Cancellation's commission taxes
Tax amount
Tax code
The total commission amount of the cancellation (commission amount + commission taxes)
Cancellation's creation date
eco_contributions
object[]
List of eco-contribution amounts and corresponding producer identifiers, if applicable
Only available if the operator activates the circular economy information collection.
Extended Producer Responsibility category
Producer identifier of the eco-contribution.
Owner of the producerId
Total amount of the eco-contribution
Unit amount of the eco-contribution
fees
object[]
List of fees canceled on the order line
Fee amount
Fee code
funding
object
The funding details of the cancelation
customer
object
The customer funding canceled
fees
object
The customer funding applying on fees
breakdown
object[]
The details of the customer funding applying on fees
The amount funded by the payment method
The payment method
offer
object
The customer funding applying on the order line offer
breakdown
object[]
The details of the customer funding applying on the order line offer
The amount funded by the payment method
The payment method
shipping
object
The customer funding applying on the shipping
breakdown
object[]
The details of the customer funding applying on the shipping
The amount funded by the payment method
The payment method
The total amount of the customer funding
The total amount of taxes of the customer funding
operator
object
The operator funding canceled
fees
object
The operator funding applying on fees
breakdown
object[]
The details of the operator funding applying on fees
The amount funded by the payment method
The payment method
offer
object
The operator funding applying on the order line offer
breakdown
object[]
The details of the operator funding applying on the order line offer
The amount funded by the payment method
The payment method
shipping
object
The operator funding applying on the shipping
breakdown
object[]
The details of the operator funding applying on the shipping
The amount funded by the payment method
The payment method
The total amount of the operator funding
The total amount of taxes of the operator funding
Cancellation's id
purchase_information
object
Cancelation’s purchase information
Only available for One Creditor offers
purchase_commission_on_fees
object
Cancelation’s purchase commission total amount on fees
Cancelation’s purchase commission total amount on fees
Cancelation’s purchase commission amount
Cancelation’s purchase commission amount on shipping
purchase_fee_amount
object
Cancelation’s purchase fees
Cancelation’s purchase fee total amount
Cancelation’s purchase price excluding shipping charges and fees
Cancelation’s purchase shipping charges
The quantity of products canceled (This quantity is informative only)
Cancellation reason's code
Cancellation's shipping amount
shipping_amount_breakdown
object
The breakdown of the cancellation's shipping amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
shipping_taxes
object[]
The taxes on the shipping price
Tax amount
amount_breakdown
object
The breakdown of the tax amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Tax code
purchase_tax
object
Purchase tax information
Purchase tax amount
Purchase tax rate
Tax rate
taxes
object[]
The taxes on the price
Tax amount
amount_breakdown
object
The breakdown of the tax amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Tax code
purchase_tax
object
Purchase tax information
Purchase tax amount
Purchase tax rate
Tax rate
Category code of the product associated with the order line
Category label of the product associated with the order line
Order line's commission fee
commission_taxes
object[]
Commission taxes
Tax amount
Tax code
Tax rate, as a percentage (between 0 and 100)
Order line's creation date
Order line's debited date
Order line's description
eco_contributions
object[]
List of eco-contribution amounts and corresponding producer identifiers, if applicable
Only available if the operator activates the circular economy information collection.
Extended Producer Responsibility category
Producer identifier of the eco-contribution.
Owner of the producerId
Total amount of the eco-contribution
Unit amount of the eco-contribution
fees
object[]
List of fees applied on the order line
Fee amount
Fee code
funding
object
The funding details of the order line
customer
object
The customer funding applying on the order line
fees
object
The customer funding applying on fees
breakdown
object[]
The details of the customer funding applying on fees
The amount funded by the payment method
The payment method
offer
object
The customer funding applying on the order line offer
breakdown
object[]
The details of the customer funding applying on the order line offer
The amount funded by the payment method
The payment method
shipping
object
The customer funding applying on the shipping
breakdown
object[]
The details of the customer funding applying on the shipping
The amount funded by the payment method
The payment method
The total amount of the customer funding
The total amount of taxes of the customer funding
operator
object
The operator funding applying on the order line
fees
object
The operator funding applying on fees
breakdown
object[]
The details of the operator funding applying on fees
The amount funded by the payment method
The payment method
offer
object
The operator funding applying on the order line offer
breakdown
object[]
The details of the operator funding applying on the order line offer
The amount funded by the payment method
The payment method
shipping
object
The operator funding applying on the shipping
breakdown
object[]
The details of the operator funding applying on the shipping
The amount funded by the payment method
The payment method
The total amount of the operator funding
The total amount of taxes of the operator funding
Order line's last updated date
measurement
object
Measurement information of the order line
Actual measurement on the order line
Adjustment limit of the order line
Measurement unit of the order line
Total measurement ordered on the order line
Associated offer's id
Associated offer sku (this is the sku of the offer defined by the shop)
State of the offer associated with the order line
order_line_additional_fields
object[]
List of additional fields
Additional field's code
type
string
Possible values: [BOOLEAN, DATE, LINK, LIST, MULTIPLE_VALUES_LIST, NUMERIC, REGEX, STRING, TEXTAREA]
Additional field's type
Additional field's value
Additional field's value
Additional field's value
Additional field's value
Values of the additional field
Additional field's value
Additional field's value
Additional field's value
Additional field's value
Order line's identifier
Order line's index in the order
Order line's state
Reason's code of the order line's state
Reason's label of the order line's state
The original unit price of the offer associated with the order line
Order line's price without shipping price
Price's additional information of the offer
price_amount_breakdown
object
The breakdown of the price, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Unit price for the offer associated with the order line
product_medias
object[]
List of all product's media associated to the order line
Media URL
Media MIME Type (.jpg, .png ...)
Media TYPE (small, large...)
Sku of the product associated with the order line
Title of the product associated with the order line
promotions
object[]
List of promotions
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).
campaign
object
Promotion campaign information, when applicable.
The identifier of the promotion campaign.
configuration
object
Configuration used to calculate the applied promotion
The amount off of the promotion.
Only applicable when promotion is of type AMOUNT_OFF, null otherwise.
The free item target quantity of the promotion.
Only applicable when promotion is of type FREE_ITEMS, null otherwise.
Promotion's Internal description, set by the shop at creation
The percentage off of the promotion.
Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise.
Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET)
Promotion's amount for this line.
Promotion's id, defined by the shop
The quantity of free items offered by the promotion for this line.
Only applicable when promotion is of type FREE_ITEMS, null otherwise.
Promo code associated to the promotion
purchase_information
object
Purchase information
Only available for One Creditor offers
purchase_commission_on_fees
object
Purchase order line’s commission on fees
Purchase order line’s commission total amount on fees
Purchase order line’s commission amount
Purchase order line’s commission amount on shipping
purchase_fee_amount
object
Purchase order line’s fees
Purchase order line’s fee total amount
Purchase order line’s price excluding shipping charges and fees
Purchase order line’s shipping charges
Purchase unit price computed from the given offer price
Product's quantity for the order line
Product's date of receipt
refunds
object[]
List of the refunds
Refund's amount
amount_breakdown
object
The breakdown of the refund's amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Refund's commission amount
commission_taxes
object[]
Refund's commission taxes
Tax amount
Tax code
The total commission amount of the refund (commission amount + commission taxes)
Refund's creation date
eco_contributions
object[]
List of eco-contribution amounts and corresponding producer identifiers, if applicable
Only available if the operator activates the circular economy information collection.
Extended Producer Responsibility category
Producer identifier of the eco-contribution.
Owner of the producerId
Total amount of the eco-contribution
Unit amount of the eco-contribution
fees
object[]
List of fees refunded on the order line
Fee amount
Fee code
funding
object
The funding details of the refund
customer
object
The customer funding refunded
fees
object
The customer funding applying on fees
breakdown
object[]
The details of the customer funding applying on fees
The amount funded by the payment method
The payment method
offer
object
The customer funding applying on the order line offer
breakdown
object[]
The details of the customer funding applying on the order line offer
The amount funded by the payment method
The payment method
shipping
object
The customer funding applying on the shipping
breakdown
object[]
The details of the customer funding applying on the shipping
The amount funded by the payment method
The payment method
The total amount of the customer funding
The total amount of taxes of the customer funding
operator
object
The operator funding refunded
fees
object
The operator funding applying on fees
breakdown
object[]
The details of the operator funding applying on fees
The amount funded by the payment method
The payment method
offer
object
The operator funding applying on the order line offer
breakdown
object[]
The details of the operator funding applying on the order line offer
The amount funded by the payment method
The payment method
shipping
object
The operator funding applying on the shipping
breakdown
object[]
The details of the operator funding applying on the shipping
The amount funded by the payment method
The payment method
The total amount of the operator funding
The total amount of taxes of the operator funding
Refund's id
The group identifier of the refunds created at the same time on the order
purchase_information
object
Refund’s purchase information
Only available for One Creditor offers
purchase_commission_on_fees
object
Refund’s purchase commission amount on fees
Refund’s purchase commission total amount on fees
Refund’s purchase commission amount
Refund’s purchase commission amount on shipping
purchase_fee_amount
object
Refund’s purchase fees
Refund’s purchase fee total amount
Refund’s purchase price excluding shipping charges and fees
Refund’s purchase shipping charges
The quantity of products refunded (This quantity is informative only).
Reason's code of the refund
Refund's state
Refund's shipping amount
shipping_amount_breakdown
object
The breakdown of the refund's shipping amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
shipping_taxes
object[]
The taxes on the shipping price
Tax amount
amount_breakdown
object
The breakdown of the tax amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Tax code
purchase_tax
object
Purchase tax information
Purchase tax amount
Purchase tax rate
Tax rate
Refund's state
The legal notice applying to the refunded order line’s taxes
taxes
object[]
The taxes on the price
Tax amount
amount_breakdown
object
The breakdown of the tax amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Tax code
purchase_tax
object
Purchase tax information
Purchase tax amount
Purchase tax rate
Tax rate
The transaction date of the refund payment
The transaction number of the refund payment
Order line's shipped date
shipping_from
object
Shipping origin (country, full address or warehouse) of the order line
address
object
The address from where the offer is shipped
Address City
Address Country ISO 3166-1 alpha-3 code (3 letters country code)
Address State
First information line of the address street
Second information line of the address street
Address zip code
warehouse
object
The warehouse from where the offer is shipped
The code of the warehouse
Total price of the order line's shipping price
shipping_price_amount_breakdown
object
The breakdown of the shipping price, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
shipping_taxes
object[]
List of taxes applied on shipping charges
Tax amount
amount_breakdown
object
The breakdown of the tax amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Tax code
purchase_tax
object
Purchase tax information
Purchase tax amount
Purchase tax rate
Tax rate
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.
The legal notice applying to the order line’s taxes
True if the taxes of the order line must be recalculated. False otherwise
taxes
object[]
List of taxes applied on product price
Tax amount
amount_breakdown
object
The breakdown of the tax amount, only available when advanced features are enabled
parts
object[]
Possible values: >= 1, <= 2147483647
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.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be applied to the sellers commissions calculation.
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.
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.
Tax code
The original tax amount of the offer associated with the order line before a discount or a promotion
purchase_tax
object
Purchase tax information
Purchase tax amount
Purchase tax rate
Tax rate
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.
Order line's total commission (sum of the commission fee and the commission vat)
Order line's price with shipping price and fees.
order_refunds
object[]
The list of refunds aggregated by group identifier
Available when feature ‘order level tax calculation’ is enabled
The group identifier of the refunds created at the same time on the order
taxes
object[]
Total amount of refunded taxes aggregated per tax code and rate
Order tax code
Order tax rate
Order total refunded tax amount for product and shipping, for a defined tax code and rate
Order's state
Reason's code of the order state
Reason's label of the order state
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:
order_taxes
object[]
Total amount of taxes aggregated per tax code and rate
Available when feature ‘order level tax calculation’ is enabled
Order tax code
Order tax rate
Order total tax amount for product and shipping, for a defined tax code and rate
payment_destination
object
Payment destination in case of bank transfer
@type
string
Possible values: [IBAN]
Bank account IBAN
The payment reference for bank transfer
The payment reference for bank transfer
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.
The payment's type used by the customer to pay this order
The payment workflow followed by the order
Order's price (sum of order line's price)
promotions
object
Promotions' summary applied to the order
applied_promotions
object[]
The promotions applied on this order
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).
campaign
object
Promotion campaign information, when applicable.
The identifier of the promotion campaign.
configuration
object
Configuration used to calculate the applied promotion
The amount off of the promotion.
Only applicable when promotion is of type AMOUNT_OFF, null otherwise.
The free item target quantity of the promotion.
Only applicable when promotion is of type FREE_ITEMS, null otherwise.
Promotion's Internal description, set by the shop at creation
The percentage off of the promotion.
Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise.
Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET)
Promotion's amount for this line.
Promotion's id, defined by the shop
The quantity of free items offered by the promotion for this line.
Only applicable when promotion is of type FREE_ITEMS, null otherwise.
Promo code associated to the promotion
The total amount deduced on this order thanks to the promotions
Quote's id from which the order has been placed, or null if it was not from a quote
references
object
Order references
Order reference for customer
Order reference for seller
Shipping carrier code (associated with the Shipping company label)
Shipping carrier standard code (associated with the shipping carrier code)
Shipping company
Order's shipping deadline
Order's shipping price (sum of order line's shipping price)
PickUp DropOff (PUDO) point identifier
Shipping tracking
Shipping tracking url
Code of shipping's type
Label of shipping's type
Shipping type's standard code
Code of shipping's zone
Label of shipping's zone
Shop's identifier
Shop's name
Order's total commission (sum of the order line's total commission)
Total order's price (sum of the order's price with shipping price and fees).
Payment's transaction date
Payment's transaction number
True if the order is in the 'waiting for tax confirmation' debit state (dependent on 'Hold debit workflow if taxes must be updated' operator toggle activation). False otherwise.
Total count of orders
{
"orders": [
{
"acceptance_decision_date": "2024-07-29T15:51:28.071Z",
"can_cancel": true,
"can_evaluate": true,
"can_shop_ship": true,
"channel": {
"code": "string",
"label": "string"
},
"commercial_id": "string",
"commissionable": true,
"created_date": "2024-07-29T15:51:28.071Z",
"currency_iso_code": "string",
"customer": {
"accounting_contact": {
"civility": "string",
"customer_id": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"locale": "string"
},
"billing_address": {
"city": "string",
"civility": "string",
"company": "string",
"company_2": "string",
"country": "string",
"country_iso_code": "string",
"firstname": "string",
"lastname": "string",
"phone": "string",
"phone_secondary": "string",
"state": "string",
"street_1": "string",
"street_2": "string",
"zip_code": "string"
},
"civility": "string",
"customer_id": "string",
"delivery_contact": {
"civility": "string",
"customer_id": "string",
"email": "string",
"firstname": "string",
"lastname": "string",
"locale": "string"
},
"email": "string",
"firstname": "string",
"lastname": "string",
"locale": "string",
"organization": {
"address": {
"city": "string",
"country_iso_code": "string",
"state": "string",
"street_1": "string",
"street_2": "string",
"zip_code": "string"
},
"identification_number": "string",
"name": "string",
"organization_id": "string",
"tax_identification_number": "string"
},
"shipping_address": {
"additional_info": "string",
"city": "string",
"civility": "string",
"company": "string",
"company_2": "string",
"country": "string",
"country_iso_code": "string",
"firstname": "string",
"internal_additional_info": "string",
"lastname": "string",
"phone": "string",
"phone_secondary": "string",
"state": "string",
"street_1": "string",
"street_2": "string",
"zip_code": "string"
}
},
"customer_debited_date": "2024-07-29T15:51:28.071Z",
"customer_directly_pays_seller": true,
"delivery_date": {
"earliest": "2024-07-29T15:51:28.071Z",
"latest": "2024-07-29T15:51:28.071Z"
},
"fulfillment": {
"center": {
"code": "string"
}
},
"fully_refunded": true,
"has_customer_message": true,
"has_incident": true,
"has_invoice": true,
"imprint_number": "string",
"invoice_details": {
"document_details": [
{
"format": "string"
}
],
"payment_terms": {
"days": 0,
"type": "string"
}
},
"last_updated_date": "2024-07-29T15:51:28.071Z",
"order_additional_fields": [
{
"code": "string",
"type": "string"
}
],
"order_id": "string",
"order_lines": [
{
"can_open_incident": true,
"can_refund": true,
"cancelations": [
{
"amount": 0,
"amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"commission_amount": 0,
"commission_taxes": [
{
"amount": 0,
"code": "string"
}
],
"commission_total_amount": 0,
"created_date": "2024-07-29T15:51:28.071Z",
"eco_contributions": [
{
"epr_category_code": "string",
"producer_id": "string",
"producer_id_owner": "string",
"total_amount": 0,
"unit_amount": 0
}
],
"fees": [
{
"amount": 0,
"code": "string"
}
],
"funding": {
"customer": {
"fees": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"offer": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"shipping": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"total_amount": 0,
"total_tax_amount": 0
},
"operator": {
"fees": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"offer": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"shipping": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"total_amount": 0,
"total_tax_amount": 0
}
},
"id": "string",
"purchase_information": {
"purchase_commission_on_fees": {
"total_amount": 0
},
"purchase_commission_on_price": 0,
"purchase_commission_on_shipping": 0,
"purchase_fee_amount": {
"total_amount": 0
},
"purchase_price": 0,
"purchase_shipping_price": 0
},
"quantity": 0,
"reason_code": "string",
"shipping_amount": 0,
"shipping_amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"shipping_taxes": [
{
"amount": 0,
"amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"code": "string",
"purchase_tax": {
"purchase_amount": 0,
"purchase_rate": 0
},
"rate": 0
}
],
"taxes": [
{
"amount": 0,
"amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"code": "string",
"purchase_tax": {
"purchase_amount": 0,
"purchase_rate": 0
},
"rate": 0
}
]
}
],
"category_code": "string",
"category_label": "string",
"commission_fee": 0,
"commission_taxes": [
{
"amount": 0,
"code": "string",
"rate": 0
}
],
"created_date": "2024-07-29T15:51:28.071Z",
"debited_date": "2024-07-29T15:51:28.071Z",
"description": "string",
"eco_contributions": [
{
"epr_category_code": "string",
"producer_id": "string",
"producer_id_owner": "string",
"total_amount": 0,
"unit_amount": 0
}
],
"fees": [
{
"amount": 0,
"code": "string"
}
],
"funding": {
"customer": {
"fees": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"offer": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"shipping": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"total_amount": 0,
"total_tax_amount": 0
},
"operator": {
"fees": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"offer": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"shipping": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"total_amount": 0,
"total_tax_amount": 0
}
},
"last_updated_date": "2024-07-29T15:51:28.071Z",
"measurement": {
"actual_measurement": 0,
"adjustment_limit": 0,
"measurement_unit": "string",
"ordered_measurement": 0
},
"offer_id": 0,
"offer_sku": "string",
"offer_state_code": "string",
"order_line_additional_fields": [
{
"code": "string",
"type": "string"
}
],
"order_line_id": "string",
"order_line_index": 0,
"order_line_state": "string",
"order_line_state_reason_code": "string",
"order_line_state_reason_label": "string",
"origin_unit_price": 0,
"price": 0,
"price_additional_info": "string",
"price_amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"price_unit": 0,
"product_medias": [
{
"media_url": "string",
"mime_type": "string",
"type": "string"
}
],
"product_sku": "string",
"product_title": "string",
"promotions": [
{
"apportioned": true,
"campaign": {
"identifier": "string"
},
"configuration": {
"amount_off": 0,
"free_items_quantity": 0,
"internal_description": "string",
"percentage_off": 0,
"type": "string"
},
"deduced_amount": 0,
"id": "string",
"offered_quantity": 0,
"promo_code": "string"
}
],
"purchase_information": {
"purchase_commission_on_fees": {
"total_amount": 0
},
"purchase_commission_on_price": 0,
"purchase_commission_on_shipping": 0,
"purchase_fee_amount": {
"total_amount": 0
},
"purchase_price": 0,
"purchase_shipping_price": 0,
"purchase_unit_price": 0
},
"quantity": 0,
"received_date": "2024-07-29T15:51:28.071Z",
"refunds": [
{
"amount": 0,
"amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"commission_amount": 0,
"commission_taxes": [
{
"amount": 0,
"code": "string"
}
],
"commission_total_amount": 0,
"created_date": "2024-07-29T15:51:28.071Z",
"eco_contributions": [
{
"epr_category_code": "string",
"producer_id": "string",
"producer_id_owner": "string",
"total_amount": 0,
"unit_amount": 0
}
],
"fees": [
{
"amount": 0,
"code": "string"
}
],
"funding": {
"customer": {
"fees": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"offer": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"shipping": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"total_amount": 0,
"total_tax_amount": 0
},
"operator": {
"fees": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"offer": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"shipping": {
"breakdown": [
{
"amount": 0,
"method": "string"
}
]
},
"total_amount": 0,
"total_tax_amount": 0
}
},
"id": "string",
"order_refund_id": "string",
"purchase_information": {
"purchase_commission_on_fees": {
"total_amount": 0
},
"purchase_commission_on_price": 0,
"purchase_commission_on_shipping": 0,
"purchase_fee_amount": {
"total_amount": 0
},
"purchase_price": 0,
"purchase_shipping_price": 0
},
"quantity": 0,
"reason_code": "string",
"refund_state": "string",
"shipping_amount": 0,
"shipping_amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"shipping_taxes": [
{
"amount": 0,
"amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"code": "string",
"purchase_tax": {
"purchase_amount": 0,
"purchase_rate": 0
},
"rate": 0
}
],
"tax_legal_notice": "string",
"taxes": [
{
"amount": 0,
"amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"code": "string",
"purchase_tax": {
"purchase_amount": 0,
"purchase_rate": 0
},
"rate": 0
}
],
"transaction_date": "2024-07-29T15:51:28.071Z",
"transaction_number": "string"
}
],
"shipped_date": "2024-07-29T15:51:28.071Z",
"shipping_from": {
"address": {
"city": "string",
"country_iso_code": "string",
"state": "string",
"street_1": "string",
"street_2": "string",
"zip_code": "string"
},
"warehouse": {
"code": "string"
}
},
"shipping_price": 0,
"shipping_price_amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"shipping_taxes": [
{
"amount": 0,
"amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"code": "string",
"purchase_tax": {
"purchase_amount": 0,
"purchase_rate": 0
},
"rate": 0,
"tax_calculation_rule": "string"
}
],
"tax_legal_notice": "string",
"tax_recalculation_required": true,
"taxes": [
{
"amount": 0,
"amount_breakdown": {
"parts": [
{
"amount": 0,
"commissionable": true,
"debitable_from_customer": true,
"payable_to_shop": true
}
]
},
"code": "string",
"origin_unit_amount": 0,
"purchase_tax": {
"purchase_amount": 0,
"purchase_rate": 0
},
"rate": 0,
"tax_calculation_rule": "string"
}
],
"total_commission": 0,
"total_price": 0
}
],
"order_refunds": [
{
"order_refund_id": "string",
"taxes": [
{
"code": "string",
"rate": 0,
"total_amount": 0
}
]
}
],
"order_state": "string",
"order_state_reason_code": "string",
"order_state_reason_label": "string",
"order_tax_mode": "string",
"order_taxes": [
{
"code": "string",
"rate": 0,
"total_amount": 0
}
],
"payment_destination": {
"@type": "string",
"payment_reference": "string"
},
"payment_duration": 0,
"payment_type": "string",
"payment_workflow": "string",
"price": 0,
"promotions": {
"applied_promotions": [
{
"apportioned": true,
"campaign": {
"identifier": "string"
},
"configuration": {
"amount_off": 0,
"free_items_quantity": 0,
"internal_description": "string",
"percentage_off": 0,
"type": "string"
},
"deduced_amount": 0,
"id": "string",
"offered_quantity": 0,
"promo_code": "string"
}
],
"total_deduced_amount": 0
},
"quote_id": "string",
"references": {
"order_reference_for_customer": "string",
"order_reference_for_seller": "string"
},
"shipping_carrier_code": "string",
"shipping_carrier_standard_code": "string",
"shipping_company": "string",
"shipping_deadline": "2024-07-29T15:51:28.071Z",
"shipping_price": 0,
"shipping_pudo_id": "string",
"shipping_tracking": "string",
"shipping_tracking_url": "string",
"shipping_type_code": "string",
"shipping_type_label": "string",
"shipping_type_standard_code": "string",
"shipping_zone_code": "string",
"shipping_zone_label": "string",
"shop_id": 0,
"shop_name": "string",
"total_commission": 0,
"total_price": 0,
"transaction_date": "2024-07-29T15:51:28.071Z",
"transaction_number": "string",
"waiting_tax_confirmation": true
}
],
"total_count": 0
}
Invalid input
Unauthorized
Mirakl is unavailable. We retried 5 times every 5 seconds. Please try again later