Get order by ID

GET /purchase-order/:orderId

Returns a single order data from a previously placed order.

Request

Path Parameters

orderId stringrequired

Order's identifier

Header Parameters

Authorization stringrequired

Authorization cookie, obtained from OAuth 2 endpoint

Responses

Successful operation

application/json

Schema
Example (from schema)

Schema

acceptance_decision_date date-time

The date where the shop decided to accept or refuse the order. Null when the order was automatically refused or accepted.

can_cancel boolean

Indicate if the order can be cancelled

can_evaluate boolean

Indicates if the order can be evaluated by the customer

can_shop_ship boolean

Indicates if shops can or cannot ship orders

channel

object

The channel of the commercial's order

code string

Channel code

label string

Channel label

commercial_id string

Commercial order's identifier

commissionable boolean

Indicates if the order is commissionable. Only available when the platform follows a mixed commission model

created_date date-time

Order's creation date

currency_iso_code string

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

civility string

Possible values: <= 20 characters

Customer contact's civility

customer_id string

Possible values: <= 50 characters

Customer contact's identifier

email string

Possible values: <= 255 characters

Customer contact's email

firstname string

Possible values: <= 255 characters

Customer contact's firstname

lastname string

Possible values: <= 255 characters

Customer contact's lastname

locale string

Customer contact's locale

billing_address

object

Customer's billing address

city string

Address city

civility string

Civility of the person associated with the address

company string

Company of the person associated with the address

company_2 string

Second company information of the person associated with the address

country string

Address country

country_iso_code string

Country ISO 3166-1 code of the address

firstname string

First name of the person associated with the address

lastname string

Last name of the person associated with the address

phone string

Phone

phone_secondary string

Phone secondary

state string

Address state

street_1 string

First information line of the address street

street_2 string

Second information line of the address street

zip_code string

Address zip code

civility string

Customer's civility

customer_id string

Customer's identifier

delivery_contact

object

Data related to the delivery contact in the organization

civility string

Possible values: <= 20 characters

Customer contact's civility

customer_id string

Possible values: <= 50 characters

Customer contact's identifier

email string

Possible values: <= 255 characters

Customer contact's email

firstname string

Possible values: <= 255 characters

Customer contact's firstname

lastname string

Possible values: <= 255 characters

Customer contact's lastname

locale string

Customer contact's locale

email string

Customer's email

firstname string

Customer's first name

lastname string

Customer's last name

locale string

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.

city string

Possible values: <= 255 characters

Address city

country_iso_code string

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)

state string

Possible values: <= 255 characters

Address state

street_1 string

Possible values: <= 255 characters

First information line of the address street

street_2 string

Possible values: <= 255 characters

Second information line of the address street

zip_code string

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

identification_number string

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.

name string

Possible values: <= 255 characters

Name of the organization. Required for new organizations.

organization_id string

Possible values: <= 50 characters

Customer's organization id (from the operator's system)

tax_identification_number string

Possible values: <= 255 characters

Tax identification number of the organization.

shipping_address

object

Customer's shipping address

additional_info string

Additional information for the shipping address

city string

Address city

civility string

Civility of the person associated with the address

company string

Company of the person associated with the address

company_2 string

Second company information of the person associated with the address

country string

Address country

country_iso_code string

Country ISO 3166-1 code of the address

firstname string

First name of the person associated with the address

internal_additional_info string

Internal additional information for the shipping address

lastname string

Last name of the person associated with the address

phone string

Phone

phone_secondary string

Phone secondary

state string

Address state

street_1 string

First information line of the address street

street_2 string

Second information line of the address street

zip_code string

Address zip code

customer_debited_date date-time

The payment's date of the order by the customer

customer_directly_pays_seller boolean

True if order is paid directly to seller. False otherwise.

delivery_date

object

Expected order delivery date

earliest date-time

Earliest order delivery date

latest date-time

Latest order delivery date

fulfillment

object

Fulfillment information

center

object

Fulfillment center code

code string

Center code

fully_refunded boolean

Refunds have been requested and their cumulated amounts correspond to the sum of all remaining active order lines.

has_customer_message boolean

Indicate if the customer has sent a message related to this order

has_incident boolean

Indicate if order has incident on at least one order line

has_invoice boolean

Is an invoice available for this order.

imprint_number string

The payment's imprint number given in OR01 input

invoice_details

object

Invoice information linked to the order

document_details

object[]

Invoice document information

Array [

format string

Accounting document format

]

payment_terms

object

Payment terms

days int32

Number of days

type string

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.

last_updated_date date-time

Order's last updated date

order_additional_fields

object[]

Order's additional fields

Array [

code string

Additional field's code

type

string

Possible values: [BOOLEAN, DATE, LINK, LIST, MULTIPLE_VALUES_LIST, NUMERIC, REGEX, STRING, TEXTAREA]

Additional field's type

value string

Additional field's value

]

order_id string

Order's identifier

order_lines

object[]

Order lines

Array [

can_open_incident boolean

Indicate if an incident can be opened on the order line

can_refund boolean

Indicate whether the order line full amount can be refunded

cancelations

object[]

List of the cancellations

Array [

amount number

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.

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

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.

]

commission_amount number

Cancellation's commission amount

commission_taxes

object[]

Cancellation's commission taxes

Array [

amount number

Tax amount

code string

Tax code

]

commission_total_amount number

The total commission amount of the cancellation (commission amount + commission taxes)

created_date date-time

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.

Array [

epr_category_code string

Extended Producer Responsibility category

producer_id string

Producer identifier of the eco-contribution.

producer_id_owner string

Owner of the producerId

total_amount number

Total amount of the eco-contribution

unit_amount number

Unit amount of the eco-contribution

]

fees

object[]

List of fees canceled on the order line

Array [

amount number

Fee amount

code string

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

Array [

amount number

The amount funded by the payment method

method string

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

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

shipping

object

The customer funding applying on the shipping

breakdown

object[]

The details of the customer funding applying on the shipping

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

total_amount number

The total amount of the customer funding

total_tax_amount number

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

Array [

amount number

The amount funded by the payment method

method string

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

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

shipping

object

The operator funding applying on the shipping

breakdown

object[]

The details of the operator funding applying on the shipping

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

total_amount number

The total amount of the operator funding

total_tax_amount number

The total amount of taxes of the operator funding

id string

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

total_amount number

Cancelation’s purchase commission total amount on fees

purchase_commission_on_price number

Cancelation’s purchase commission amount

purchase_commission_on_shipping number

Cancelation’s purchase commission amount on shipping

purchase_fee_amount

object

Cancelation’s purchase fees

total_amount number

Cancelation’s purchase fee total amount

purchase_price number

Cancelation’s purchase price excluding shipping charges and fees

purchase_shipping_price number

Cancelation’s purchase shipping charges

quantity int32

The quantity of products canceled (This quantity is informative only)

reason_code string

Cancellation reason's code

shipping_amount number

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

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

shipping_taxes

object[]

The taxes on the shipping price

Array [

amount number

Tax amount

amount_breakdown

object

The breakdown of the tax amount, only available when advanced features are enabled

parts

object[]

Possible values: >= 1, <= 2147483647

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

code string

Tax code

purchase_tax

object

Purchase tax information

purchase_amount number

Purchase tax amount

purchase_rate number

Purchase tax rate

rate number

Tax rate

]

taxes

object[]

The taxes on the price

Array [

amount number

Tax amount

amount_breakdown

object

The breakdown of the tax amount, only available when advanced features are enabled

parts

object[]

Possible values: >= 1, <= 2147483647

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

code string

Tax code

purchase_tax

object

Purchase tax information

purchase_amount number

Purchase tax amount

purchase_rate number

Purchase tax rate

rate number

Tax rate

]

category_code string

Category code of the product associated with the order line

category_label string

Category label of the product associated with the order line

commission_fee number

Order line's commission fee

commission_taxes

object[]

Commission taxes

Array [

amount number

Tax amount

code string

Tax code

rate number

Tax rate, as a percentage (between 0 and 100)

]

created_date date-time

Order line's creation date

debited_date date-time

Order line's debited date

description string

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.

Array [

epr_category_code string

Extended Producer Responsibility category

producer_id string

Producer identifier of the eco-contribution.

producer_id_owner string

Owner of the producerId

total_amount number

Total amount of the eco-contribution

unit_amount number

Unit amount of the eco-contribution

]

fees

object[]

List of fees applied on the order line

Array [

amount number

Fee amount

code string

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

Array [

amount number

The amount funded by the payment method

method string

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

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

shipping

object

The customer funding applying on the shipping

breakdown

object[]

The details of the customer funding applying on the shipping

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

total_amount number

The total amount of the customer funding

total_tax_amount number

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

Array [

amount number

The amount funded by the payment method

method string

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

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

shipping

object

The operator funding applying on the shipping

breakdown

object[]

The details of the operator funding applying on the shipping

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

total_amount number

The total amount of the operator funding

total_tax_amount number

The total amount of taxes of the operator funding

last_updated_date date-time

Order line's last updated date

measurement

object

Measurement information of the order line

actual_measurement number

Actual measurement on the order line

adjustment_limit number

Adjustment limit of the order line

measurement_unit string

Measurement unit of the order line

ordered_measurement number

Total measurement ordered on the order line

offer_id int64

Associated offer's id

offer_sku string

Associated offer sku (this is the sku of the offer defined by the shop)

offer_state_code string

State of the offer associated with the order line

order_line_additional_fields

object[]

List of additional fields

Array [

code string

Additional field's code

type

string

Possible values: [BOOLEAN, DATE, LINK, LIST, MULTIPLE_VALUES_LIST, NUMERIC, REGEX, STRING, TEXTAREA]

Additional field's type

value string

Additional field's value

]

order_line_id string

Order line's identifier

order_line_index int32

Order line's index in the order

order_line_state string

Order line's state

order_line_state_reason_code string

Reason's code of the order line's state

order_line_state_reason_label string

Reason's label of the order line's state

origin_unit_price number

The original unit price of the offer associated with the order line

price number

Order line's price without shipping price

price_additional_info string

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

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

price_unit number

Unit price for the offer associated with the order line

product_medias

object[]

List of all product's media associated to the order line

Array [

media_url string

Media URL

mime_type string

Media MIME Type (.jpg, .png ...)

type string

Media TYPE (small, large...)

]

product_sku string

Sku of the product associated with the order line

product_title string

Title of the product associated with the order line

promotions

object[]

List of promotions

Array [

apportioned boolean

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.

identifier string

The identifier of the promotion campaign.

configuration

object

Configuration used to calculate the applied promotion

amount_off number

The amount off of the promotion.
Only applicable when promotion is of type AMOUNT_OFF, null otherwise.

free_items_quantity int32

The free item target quantity of the promotion.
Only applicable when promotion is of type FREE_ITEMS, null otherwise.

internal_description string

Promotion's Internal description, set by the shop at creation

percentage_off number

The percentage off of the promotion.
Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise.

type string

Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET)

deduced_amount number

Promotion's amount for this line.

id string

Promotion's id, defined by the shop

offered_quantity int32

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 string

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

total_amount number

Purchase order line’s commission total amount on fees

purchase_commission_on_price number

Purchase order line’s commission amount

purchase_commission_on_shipping number

Purchase order line’s commission amount on shipping

purchase_fee_amount

object

Purchase order line’s fees

total_amount number

Purchase order line’s fee total amount

purchase_price number

Purchase order line’s price excluding shipping charges and fees

purchase_shipping_price number

Purchase order line’s shipping charges

purchase_unit_price number

Purchase unit price computed from the given offer price

quantity int32

Product's quantity for the order line

received_date date-time

Product's date of receipt

refunds

object[]

List of the refunds

Array [

amount number

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

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

commission_amount number

Refund's commission amount

commission_taxes

object[]

Refund's commission taxes

Array [

amount number

Tax amount

code string

Tax code

]

commission_total_amount number

The total commission amount of the refund (commission amount + commission taxes)

created_date date-time

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.

Array [

epr_category_code string

Extended Producer Responsibility category

producer_id string

Producer identifier of the eco-contribution.

producer_id_owner string

Owner of the producerId

total_amount number

Total amount of the eco-contribution

unit_amount number

Unit amount of the eco-contribution

]

fees

object[]

List of fees refunded on the order line

Array [

amount number

Fee amount

code string

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

Array [

amount number

The amount funded by the payment method

method string

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

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

shipping

object

The customer funding applying on the shipping

breakdown

object[]

The details of the customer funding applying on the shipping

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

total_amount number

The total amount of the customer funding

total_tax_amount number

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

Array [

amount number

The amount funded by the payment method

method string

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

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

shipping

object

The operator funding applying on the shipping

breakdown

object[]

The details of the operator funding applying on the shipping

Array [

amount number

The amount funded by the payment method

method string

The payment method

]

total_amount number

The total amount of the operator funding

total_tax_amount number

The total amount of taxes of the operator funding

id string

Refund's id

order_refund_id string

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

total_amount number

Refund’s purchase commission total amount on fees

purchase_commission_on_price number

Refund’s purchase commission amount

purchase_commission_on_shipping number

Refund’s purchase commission amount on shipping

purchase_fee_amount

object

Refund’s purchase fees

total_amount number

Refund’s purchase fee total amount

purchase_price number

Refund’s purchase price excluding shipping charges and fees

purchase_shipping_price number

Refund’s purchase shipping charges

quantity int32

The quantity of products refunded (This quantity is informative only).

reason_code string

Reason's code of the refund

refund_state string

Refund's state

shipping_amount number

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

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

shipping_taxes

object[]

The taxes on the shipping price

Array [

amount number

Tax amount

amount_breakdown

object

The breakdown of the tax amount, only available when advanced features are enabled

parts

object[]

Possible values: >= 1, <= 2147483647

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

code string

Tax code

purchase_tax

object

Purchase tax information

purchase_amount number

Purchase tax amount

purchase_rate number

Purchase tax rate

rate number

Tax rate

]

state stringdeprecated

Refund's state

tax_legal_notice string

The legal notice applying to the refunded order line’s taxes

taxes

object[]

The taxes on the price

Array [

amount number

Tax amount

amount_breakdown

object

The breakdown of the tax amount, only available when advanced features are enabled

parts

object[]

Possible values: >= 1, <= 2147483647

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

code string

Tax code

purchase_tax

object

Purchase tax information

purchase_amount number

Purchase tax amount

purchase_rate number

Purchase tax rate

rate number

Tax rate

]

transaction_date date-time

The transaction date of the refund payment

transaction_number string

The transaction number of the refund payment

]

shipped_date date-time

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

city string

Address City

country_iso_code string

Address Country ISO 3166-1 alpha-3 code (3 letters country code)

state string

Address State

street_1 string

First information line of the address street

street_2 string

Second information line of the address street

zip_code string

Address zip code

warehouse

object

The warehouse from where the offer is shipped

code string

The code of the warehouse

shipping_price number

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

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

shipping_taxes

object[]

List of taxes applied on shipping charges

Array [

amount number

Tax amount

amount_breakdown

object

The breakdown of the tax amount, only available when advanced features are enabled

parts

object[]

Possible values: >= 1, <= 2147483647

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

code string

Tax code

purchase_tax

object

Purchase tax information

purchase_amount number

Purchase tax amount

purchase_rate number

Purchase tax rate

rate number

Tax rate

tax_calculation_rule string

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.

]

tax_legal_notice string

The legal notice applying to the order line’s taxes

tax_recalculation_required boolean

True if the taxes of the order line must be recalculated. False otherwise

taxes

object[]

List of taxes applied on product price

Array [

amount number

Tax amount

amount_breakdown

object

The breakdown of the tax amount, only available when advanced features are enabled

parts

object[]

Possible values: >= 1, <= 2147483647

Array [

amount number

Part's amount. The sum of each part's amount is equal to the total amount.

commissionable boolean

Should this amount be applied to the sellers commissions calculation.

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.

payable_to_shop boolean

]

code string

Tax code

origin_unit_amount number

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_amount number

Purchase tax amount

purchase_rate number

Purchase tax rate

rate number

Tax rate

tax_calculation_rule string

]

total_commission number

Order line's total commission (sum of the commission fee and the commission vat)

total_price number

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

Array [

order_refund_id string

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

Array [

code string

Order tax code

rate number

Order tax rate

total_amount number

Order total refunded tax amount for product and shipping, for a defined tax code and rate

]

order_state string

Order's state

order_state_reason_code string

Reason's code of the order state

order_state_reason_label string

Reason's label of the order state

order_tax_mode string

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.

order_taxes

object[]

Total amount of taxes aggregated per tax code and rate
Available when feature ‘order level tax calculation’ is enabled

Array [

code string

Order tax code

rate number

Order tax rate

total_amount number

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]

IBAN

iban string

Bank account IBAN

@type string

payment_reference string

The payment reference for bank transfer

payment_reference string

The payment reference for bank transfer

payment_duration int32

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.

payment_type string

The payment's type used by the customer to pay this order

payment_workflow string

The payment workflow followed by the order

price number

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

Array [

apportioned boolean

campaign

object

Promotion campaign information, when applicable.

identifier string

The identifier of the promotion campaign.

configuration

object

Configuration used to calculate the applied promotion

amount_off number

The amount off of the promotion.
Only applicable when promotion is of type AMOUNT_OFF, null otherwise.

free_items_quantity int32

The free item target quantity of the promotion.
Only applicable when promotion is of type FREE_ITEMS, null otherwise.

internal_description string

Promotion's Internal description, set by the shop at creation

percentage_off number

The percentage off of the promotion.
Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise.

type string

Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET)

deduced_amount number

Promotion's amount for this line.

id string

Promotion's id, defined by the shop

offered_quantity int32

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 string

Promo code associated to the promotion

]

total_deduced_amount number

The total amount deduced on this order thanks to the promotions

quote_id string

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 string

Order reference for customer

order_reference_for_seller string

Order reference for seller

shipping_carrier_code string

Shipping carrier code (associated with the Shipping company label)

shipping_carrier_standard_code string

Shipping carrier standard code (associated with the shipping carrier code)

shipping_company string

Shipping company

shipping_deadline date-time

Order's shipping deadline

shipping_price number

Order's shipping price (sum of order line's shipping price)

shipping_pudo_id string

PickUp DropOff (PUDO) point identifier

shipping_tracking string

Shipping tracking

shipping_tracking_url string

Shipping tracking url

shipping_type_code string

Code of shipping's type

shipping_type_label string

Label of shipping's type

shipping_type_standard_code string

Shipping type's standard code

shipping_zone_code string

Code of shipping's zone

shipping_zone_label string

Label of shipping's zone

shop_id int64

Shop's identifier

shop_name string

Shop's name

total_commission number

Order's total commission (sum of the order line's total commission)

total_price number

Total order's price (sum of the order's price with shipping price and fees).

transaction_date date-time

Payment's transaction date

transaction_number string

Payment's transaction number

waiting_tax_confirmation boolean

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.

{
  "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
}

Get order by ID

/purchase-order/:orderId

Request​

Path Parameters

Header Parameters

Responses​

Request

Responses