Mirakl Orders API
The Orders API from Mirakl — 34 operation(s) for orders.
Mirakl Orders API is one of 34 APIs that Mirakl publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 47 operations across 45 paths, and defines 608 schemas. It is described by OpenAPI 3.2.0.
Requests are made against 3 base URLs: https://miraklconnect.com/api/channel-platform, https://miraklconnect.com/api, https://your-instance.mirakl.net.
47 operations
45 paths
608 schemas
2 DELETE17 GET8 POST20 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 9
Mirakl Orders API declares
9 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (Bearer).
It accepts HTTP bearer tokens (JWT) (Front-Bearer-Token).
It supports OAuth 2.0 (OAuth-2) using the authorizationCode flow.
It accepts HTTP bearer tokens (JWT) (Operator-Bearer-Token).
It accepts HTTP bearer tokens (JWT) (operator_bearer_token).
An API key is passed in the header as Authorization (Shop-API-Key).
An API key is passed in the header as Authorization (shop_api_key).
An API key is passed in the header as Authorization (front_api_key).
An API key is passed in the header as Authorization (operator_api_key).
OAuth-2— For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partnersintegration/authenticatio…
Paths & Operations 47
Across 45 paths, the API surfaces 47 operations — 2 DELETE, 17 GET, 8 POST, 20 PUT. Each is listed below with its method, path, parameters, and response codes.
Orders 47
DELETE
/v1/orders/documents/{channel_document_id}
deleteOrderDocument - Delete order document
PUT
/v1/orders/actions/{action_id}
updateActionStatus - Update asynchronous action status
PUT
/v1/orders/anonymize-after
updateAnonymizeAfterDate - Update anonymization date for orders
POST
/v1/orders/{channel_order_id}/documents
uploadOrderDocument - Upload order document
POST
/v1/orders
upsertOrders - Upsert orders
PUT
/orders/{order_id}/acceptdeprecated
acceptOrderLines - Accept or refuse order lines
GET
/ordersdeprecated
listOrders - List Mirakl Connect orders
PUT
/v2/orders/{order_id}/accept
v2-acceptOrderLines - Accept or refuse order lines
POST
/v2/orders/{order_id}/cancel
v2-cancelOrderLines - Cancel order lines
GET
/v2/orders/{order_id}/documents
v2-downloadOrderDocuments - Download documents from an order
POST
/v2/orders/{order_id}/documents
v2-uploadOrderDocument - Upload a document for an order
GET
/v2/orders/actions/{action_id}
v2-getActionStatus - Track an asynchronous action request
GET
/v2/orders/tracking/{tracking_id}deprecated
v2-getOrderTracking - Retrieve tracking information
GET
/v2/orders/documents
v2-listOrderDocuments - List documents
GET
/v2/orders
v2-listOrders - List Mirakl Connect orders
POST
/v2/orders/{order_id}/refund
v2-refundOrderLines - Refund order lines
POST
/v2/orders/actions
v2-reportOrderActions - Log order action results and errors
PUT
/api/orders
OR04 - Patch update orders
GET
/api/orders
OR11 - List orders with pagination
PUT
/api/orders/shipping_from
OR07 - Update order line shipping origin
GET
/api/orders/{order_id}deprecated
OR12 - Get information about an order
POST
/api/orders/async-export
OR13 - Export orders asynchronously
GET
/api/orders/async-export/status/{tracking_id}
OR14 - Get the status of an asynchronous order export.
GET
/dynamic-url/The+URL+is+retrieved+from+OR14+output/OR15
OR15 - Retrieve order export files once asynchronous export is complete (OR13).
PUT
/api/orders/{order_id}/accept
OR21 - Accept or refuse order lines
PUT
/api/orders/{order_id}/tracking
OR23 - Update carrier tracking information for a specific order
PUT
/api/orders/{order_id}/ship
OR24 - Validate the shipment of an order
PUT
/api/orders/{order_id}/cancel
OR29 - Perform a full cancelation of an order
PUT
/api/orders/cancel
OR30 - Perform cancelations on order lines
PUT
/api/orders/{order_id}/additional_fields
OR31 - Update the custom fields of an order and its order lines
GET
/api/orders/{order_id}/messagesdeprecated
OR41 - List messages of an order
GET
/api/orders/{order_id}/evaluation
OR51 - Get the evaluation of an order
GET
/api/orders/documents
OR72 - Lists order's documents
GET
/api/orders/documents/download
OR73 - Download one or multiple documents attached to one or multiple orders
POST
/api/orders/{order_id}/documents
OR74 - Upload documents to attach to an order
GET
/api/orders/taxes
OR75 - List all the order taxes available on the platform
DELETE
/api/orders/documents/{document_id}
OR76 - Delete an order document
PUT
/api/orders/{order_id}/refunddeprecated
OR26 - Perform a refund of order lines of an order
PUT
/api/orders/refund
OR28 - Perform refunds on order lines
PUT
/api/orders/adjust
OR32 - Adjust order line
PUT
/api/mms/orders/{order_id}
SOR04 - Update an order
PUT
/api/mms/orders/{order_id}/accept
SOR21 - Accept an order
PUT
/api/mms/orders/{order_id}/refuse
SOR22 - Refuse an order
PUT
/api/mms/orders/{order_id}/consume
SOR25 - Consume an order
GET
/api/mms/orders/{order_id}/evaluation
SOR51 - Get the evaluation of an order
PUT
/api/mms/orders/{order_id}/refund
SOR28 - Request refund on order
GET
/api/mms/orders
SOR11 - List orders
Schemas 608
The contract defines 608 schemas that model the data the API accepts and returns. The most detailed are OR15_Response_200_Ext_FileStructure_Orders (63 properties), OR11_Response_200_Orders (63 properties), OR11_Response_200_Orders_2 (55 properties), OR15_Response_200_Ext_FileStructure_Orders_2 (55 properties). Each schema is shown below with its type and property counts.
ActionError
object
Detailed information about an error encountered during action processing
2 properties
2 required
CustomAttributeRequest
object
A custom attribute.
2 properties
2 required
CustomAttributesRequest
array
Custom attributes
Error
object
4 properties
2 required
AddressRequest
object
12 properties
3 required
TaxRequest
object
5 properties
2 required
ShippingInfoRequest
object
Shipping destination and logistics information for the order.
7 properties
BillingInfoRequest
object
Billing information for invoice and payment purposes. Optional.
1 property
FulfillmentRequest
object
2 properties
1 required
OrderRequest
object
12 properties
7 required
AdjustmentRequest
object
9 properties
7 required
Money
object
2 properties
2 required
UpdateAnonymizeAfterRequestItem
object
4 properties
3 required
OrderLineRequest
object
15 properties
10 required
UploadOrderDocumentMetadata
object
5 properties
3 required
UpdateActionRequest
object
Request payload for updating an asynchronous action's status
2 properties
1 required
UpdateAnonymizeAfterRequest
object
1 property
1 required
OriginRequest
object
2 properties
2 required
ProductRequest
object
3 properties
2 required
DocumentOriginRequest
object
3 properties
2 required
ErrorItem
object
3 properties
1 required
UpsertOrdersRequest
object
2 properties
2 required
Address
object
12 properties
3 required
ActionError_2
object
2 properties
2 required
ActionRequest
object
1 property
1 required
CustomAttributeResponse
object
A custom attribute.
3 properties
3 required
RefundedTaxRequest
object
2 properties
2 required
AcceptOrderLinesRequest
object
1 property
1 required
ActionItemRequest
object
6 properties
5 required
OrdersPageResponse
ActionCreatedResponse
object
1 property
1 required
Origin
object
6 properties
1 required
OrderTrackingErrorResponse
object
2 properties
2 required
ResourcesPage
object
2 properties
RefundRequest
object
8 properties
3 required
AsynchronousActionResponse
object
2 properties
1 required
CancelOrderLinesRequest
object
1 property
1 required
ActionsCreatedResponse
object
1 property
1 required
Fulfillment
object
2 properties
1 required
OrderDocumentsPageResponse
BillingInfo
object
1 property
Adjustment
object
10 properties
8 required
CancelRequest
object
8 properties
4 required
ActionResponse
object
5 properties
4 required
DocumentResponse
object
7 properties
6 required
OrderLineResponse
object
14 properties
13 required
Money_2
object
2 properties
2 required
ShippingInfo
object
7 properties
Tax
object
5 properties
2 required
AcceptOrderLine
object
2 properties
2 required
TaxAdjustment
object
2 properties
2 required
OrderResponse
object
14 properties
10 required
OrderProduct
object
2 properties
2 required
UploadOrderDocumentMetadata_2
object
3 properties
2 required
RefundOrderLinesRequest
object
1 property
1 required
OrderTrackingResponse
object
5 properties
4 required
CanceledTaxRequest
object
2 properties
2 required
ActionErrorResponse
object
2 properties
2 required
CustomAttributesResponse
array
Custom attributes
OrderDocumentResponse
OR75_Response_200
object
1 property
1 required
OR04_Response_200_UpdatedOrders_Updated_Customer
object
5 properties
OR15_Response_200_Ext_FileStructure_Orders_Customer_DeliveryContact
object
6 properties
4 required
OR11_Response_200_Orders_OrderLines_PriceAmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Customer_Offer
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes
object
5 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Offer
object
1 property
1 required
OR13_Request
object
18 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Operator_Offer
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_Channel
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Customer_Fees_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Shipping
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Offer
object
1 property
1 required
OR04_Request_Orders_InvoiceDetails
object
Invoice information linked to the order
2 properties
OR11_Response_200_Orders_OrderLines_ShippingTaxes
object
6 properties
3 required
OR11_Response_200_Orders_Customer_Organization_Address
object
6 properties
4 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_AmountBreakdown
object
1 property
1 required
OR04_Response_200_UpdatedOrders_Updated_Customer_AccountingContact
object
1 property
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown_Parts
object
4 properties
1 required
OR11_Response_200_Orders_Customer_BillingAddress
object
14 properties
5 required
OR11_Response_200_Orders_OrderLines_Taxes_PurchaseTax
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Promotions_Configuration
object
6 properties
2 required
OR11_Response_200_Orders_OrderLines_PurchaseInformation
object
7 properties
5 required
OR11_Response_200_Orders_InvoiceDetails
object
2 properties
OR11_Response_200_Orders_OrderLines_Refunds_Taxes
object
5 properties
2 required
OR11_Response_200_Orders_OrderLines_Refunds_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown
object
1 property
1 required
OR31_Response_200_OrderUpdateResult
object
2 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes
object
5 properties
2 required
OR30_Response_200_Cancelations_PurchaseInformation_PurchaseCommissionOnFees
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Operator_Shipping
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_Fulfillment_Center
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderRefunds
object
2 properties
1 required
OR11_Response_200_Orders_Fulfillment
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Funding_Operator_Offer
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_AmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Operator_Shipping_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_InvoiceDetails_PaymentTerms
object
2 properties
2 required
OR30_Response_200_Cancelations_Fees
object
2 properties
OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_ProductMedias
object
3 properties
3 required
OR30_Response_200_Cancelations_ShippingTaxes_AmountBreakdown
object
1 property
1 required
OR04_Response_200_UpdatedOrders_Updated_Customer_Organization
object
4 properties
OR15_Response_200_Ext_FileStructure_Orders_Customer
object
11 properties
6 required
OR30_Response_200_Cancelations_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Fees
object
2 properties
2 required
OR04_Response_200_UpdatedOrders_Updated_Customer_BillingAddress
object
14 properties
OR11_Response_200_Orders_Promotions_AppliedPromotions
object
7 properties
4 required
OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_PurchaseTax
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_PurchaseTax
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Taxes_PurchaseTax
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_EcoContributions
object
5 properties
3 required
OR04_Request_Orders_InvoiceDetails_PaymentTerms
object
Payment terms
2 properties
OR31_Response_200_OrderUpdateErrors_Errors
object
3 properties
3 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Shipping
object
1 property
1 required
OR11_Response_200_Orders_Promotions
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseCommissionOnFees
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Operator
object
5 properties
5 required
OR11_Response_200_Orders_Promotions_AppliedPromotions_Campaign
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_PurchaseTax
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Refunds_ShippingAmountBreakdown
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseFeeAmount
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines
object
53 properties
29 required
OR23_Request
object
5 properties
OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown_Parts
object
4 properties
1 required
OR30_Response_200_Cancelations_Taxes
object
5 properties
2 required
OR04_Response_200_UpdatedOrders_Updated_ShopStatistics
object
2 properties
OR11_Response_200_Orders_References
object
2 properties
OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Offer_Breakdown
object
2 properties
2 required
OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields
object
2 properties
1 required
OR74_Request_MultipartFormData_OrderDocuments_OrderDocuments
object
3 properties
2 required
OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer
object
5 properties
5 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Shipping_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_Customer_DeliveryContact
object
6 properties
4 required
OR21_Request
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_AmountBreakdown_Parts
object
4 properties
1 required
OR07_Request_OrderLines_ShippingFrom
object
Shipping origin (country, full address or warehouse) of the order line
2 properties
OR74_Response_200
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseCommissionOnFees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines
object
53 properties
29 required
OR15_Response_200_Ext_FileStructure_Orders
object
63 properties
30 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines_EcoContributions
object
5 properties
OR04_Response_200
object
1 property
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom
object
2 properties
OR31_Response_200_OrderUpdateResult_OrderAdditionalFields
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Shipping_Breakdown
object
2 properties
2 required
OR30_Response_200_Cancelations_ShippingTaxes_AmountBreakdown_Parts
object
4 properties
1 required
OR74_Request_MultipartFormData_OrderDocuments
object
1 property
1 required
OR31_Response_200
object
2 properties
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Shipping
object
1 property
1 required
OR30_Response_200_Cancelations_PurchaseInformation_PurchaseFeeAmount
object
1 property
1 required
OR11_Response_200_Orders_Fulfillment_Center
object
1 property
1 required
OR04_Request_Orders_InvoiceDetails_DocumentDetails
object
1 property
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation
object
6 properties
4 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Customer_Offer_Breakdown
object
2 properties
2 required
OR31_Request_OrderLines_OrderLineAdditionalFields
object
Order line custom fields
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation
object
7 properties
5 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines
object
4 properties
OR04_Request_Orders_Customer_AccountingContact
object
Data related to the delivery contact in the organization
1 property
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding
object
2 properties
2 required
OR04_Response_200_UpdatedOrders_Updated_PaymentDestination
object
2 properties
OR04_Response_200_UpdatedOrders_Updated_DeliveryDate
object
2 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown_Parts
object
4 properties
1 required
OR07_Response_200
object
1 property
OR11_Response_200_Orders_OrderLines_ShippingPriceAmountBreakdown
object
1 property
1 required
OR07_Response_200_OrderLines_Updated
object
2 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Operator_Offer
object
1 property
1 required
OR04_Request_Orders_Customer_DeliveryContact
object
Data related to the delivery contact in the organization
1 property
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Customer_Shipping
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_PurchaseTax
object
2 properties
1 required
OR04_Request_Orders_Customer_Organization
object
Data related to the organization that created the order (B2B transactions)
4 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_AmountBreakdown_Parts
object
4 properties
1 required
OR11_Response_200_Orders_OrderLines_ShippingFrom_Address
object
6 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations
object
17 properties
5 required
OR07_Response_200_OrderLines_Errors
object
3 properties
3 required
OR41_Response_200_Messages
object
22 properties
16 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Customer_Fees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_ShippingAmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Customer_Fees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Promotions_Campaign
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Customer
object
5 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_DeliveryDate
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Fees
object
2 properties
2 required
OR51_Response_200_Reply
object
3 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_Customer_Organization_Address
object
6 properties
4 required
OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown_Parts
object
4 properties
1 required
OR31_Request_OrderLines
object
Order lines custom fields
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Customer_Fees_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes
object
6 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes
object
5 properties
2 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines_Refunds_EcoContributions
object
5 properties
OR11_Response_200_Orders_OrderLines_Refunds_Taxes_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom_Warehouse
object
1 property
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_CommissionTaxes
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_ShippingFrom
object
2 properties
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Shipping_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Operator_Offer
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Funding_Customer
object
5 properties
5 required
OR12_Response_200_Customer_BillingAddress
object
13 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Measurement
object
4 properties
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Fees
object
1 property
1 required
OR11_Response_200_Orders_Customer_ShippingAddress
object
16 properties
5 required
OR11_Response_200_Orders_OrderLines_Funding_Operator_Shipping_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_PriceAmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Operator_Shipping
object
1 property
1 required
OR13_Response_200
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_Promotions
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Funding
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_EcoContributions
object
5 properties
3 required
OR11_Response_200_Orders_OrderLines_Funding_Operator_Offer_Breakdown
object
2 properties
2 required
OR21_Request_OrderLines
object
List of representations of order line for acceptance
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding
object
2 properties
2 required
OR30_Request_Cancelations
object
List of representations of cancellations to be created
9 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingPriceAmountBreakdown
object
1 property
1 required
OR07_Response_200_OrderLines_Updated_Warehouse
object
1 property
OR74_Response_200_OrderDocuments_Input
object
2 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseFeeAmount
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Shipping_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_CommissionTaxes
object
3 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseFeeAmount
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails_PaymentTerms
object
2 properties
2 required
OR30_Response_200_Cancelations_Taxes_AmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions
object
7 properties
4 required
OR11_Response_200_Orders_OrderLines_Taxes_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Operator_Fees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseFeeAmount
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Operator_Shipping_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_EcoContributions
object
5 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Operator_Fees
object
1 property
1 required
OR11_Response_200_Orders_DeliveryDate
object
2 properties
2 required
OR31_Request_OrderAdditionalFields
object
Order line custom fields
2 properties
1 required
OR11_Response_200_Orders_OrderLines_CommissionTaxes
object
3 properties
3 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Fees
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes
object
7 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown
object
1 property
1 required
OR31_Response_200_OrderUpdateErrors_Input
object
2 properties
OR04_Response_200_UpdatedOrders_Errors
object
3 properties
3 required
OR11_Response_200_Orders_OrderLines_Funding_Operator_Fees_Breakdown
object
2 properties
2 required
OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails_DocumentDetails
object
1 property
OR04_Response_200_UpdatedOrders_Updated_Customer_ShippingAddress
object
16 properties
OR04_Response_200_UpdatedOrders_Updated_Customer_Organization_Address
object
6 properties
OR04_Request_Orders_Customer_Organization_Address
object
Address of the organization
6 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_Fulfillment
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingAmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingAmountBreakdown
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Fees
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Customer_Shipping
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Funding_Customer_Shipping
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Taxes_AmountBreakdown_Parts
object
4 properties
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingAmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Operator
object
5 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Customer
object
5 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_OrderRefunds_Taxes
object
3 properties
2 required
OR12_Response_200_OrderLines_OrderLineAdditionalFields
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ProductMedias
object
3 properties
3 required
OR75_Response_200_Taxes
object
6 properties
5 required
OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Fees
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_DiscountCampaigns
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Fees_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_ShippingFrom_Warehouse
object
1 property
OR11_Response_200_Orders_OrderTaxes
object
3 properties
2 required
OR11_Response_200_Orders_OrderLines_Fees
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_PurchaseTax
object
2 properties
1 required
OR30_Response_200_Cancelations_ShippingTaxes
object
5 properties
2 required
OR12_Response_200_OrderLines
object
33 properties
32 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines_Refunds
object
2 properties
OR11_Response_200_Orders_OrderLines_ShippingTaxes_AmountBreakdown
object
1 property
1 required
OR11_Response_200_Orders_Customer_Organization
object
5 properties
1 required
OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseCommissionOnFees
object
1 property
1 required
OR04_Request_Orders_Customer_BillingAddress
object
Customer billing address
14 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes
object
5 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseCommissionOnFees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Funding_Customer_Offer
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Operator_Offer_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_Customer_ShippingAddress
object
16 properties
5 required
OR74_Request_MultipartFormData_OrderDocuments_OrderDocuments_Entity
object
Document entity. Should only be used with the return feature and not for any other kind of documents.
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Operator_Fees_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes
object
5 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_AmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions
object
7 properties
4 required
OR11_Response_200_Orders_OrderLines_Cancelations_Fees
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingAmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Operator_Offer_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_ShippingTaxes_AmountBreakdown_Parts
object
4 properties
1 required
OR11_Response_200_Orders
object
63 properties
30 required
OR11_Response_200_Orders_OrderLines_Funding_Customer_Fees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Funding_Customer_Shipping_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_DiscountCampaigns
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_AmountBreakdown_Parts
object
4 properties
1 required
OR31_Request
object
2 properties
OR30_Response_200_Cancelations_EcoContributions
object
5 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Customer_Shipping_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails_DocumentDetails
object
1 property
OR72_Response_200
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_PaymentDestination
object
2 properties
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Fees_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Customer_Shipping_Breakdown
object
2 properties
2 required
OR30_Response_200_Cancelations_ShippingAmountBreakdown_Parts
object
4 properties
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Offer
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Fees_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_DiscountCampaign
object
1 property
1 required
OR12_Response_200
object
30 properties
27 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_EcoContributions
object
5 properties
3 required
OR11_Response_200_Orders_OrderLines_Refunds_EcoContributions
object
5 properties
3 required
OR04_Response_200_UpdatedOrders
object
3 properties
OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_PurchaseTax
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Funding_Operator
object
5 properties
5 required
OR51_Response_200_Assessments
object
3 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails
object
2 properties
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Offer
object
1 property
1 required
OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails
object
2 properties
OR11_Response_200_Orders_OrderLines_Cancelations_CommissionTaxes
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_ShippingTaxes_PurchaseTax
object
2 properties
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation
object
6 properties
4 required
OR07_Request_OrderLines_ShippingFrom_Address
object
The address from where the offer is shipped
6 properties
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Fees
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator
object
5 properties
5 required
OR12_Response_200_Customer_ShippingAddress
object
15 properties
5 required
OR11_Response_200_Orders_OrderLines_Cancelations_Taxes
object
5 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Customer_Offer
object
1 property
1 required
OR30_Response_200_Cancelations
object
14 properties
5 required
OR11_Response_200_Orders_InvoiceDetails_DocumentDetails
object
1 property
OR15_Response_200_Ext_FileStructure_Orders_Customer_BillingAddress
object
14 properties
5 required
OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails_PaymentTerms
object
2 properties
OR04_Request_Orders
object
Orders to be updated, maximum number of orders per call: 100
8 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Operator_Fees
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions_Campaign
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator
object
5 properties
5 required
OR11_Response_200_Orders_OrderLines_DiscountCampaign
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingPriceAmountBreakdown_Parts
object
4 properties
1 required
OR30_Response_200_Cancelations_ShippingAmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Customer_Shipping
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Customer_Offer
object
1 property
1 required
OR04_Request_Orders_PaymentDestination
object
Payment destination in case of bank transfer
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_AmountBreakdown_Parts
object
4 properties
1 required
OR11_Response_200_Orders_Customer
object
11 properties
6 required
OR11_Response_200_Orders_OrderLines_Funding_Customer_Fees_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_ShippingPriceAmountBreakdown_Parts
object
4 properties
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Offer_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_PurchaseTax
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_Customer_Organization
object
5 properties
1 required
OR12_Response_200_Customer
object
7 properties
6 required
OR07_Request_OrderLines
object
Order lines to be updated, maximum number of order lines per call: 100
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Refunds
object
24 properties
11 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds
object
24 properties
11 required
OR11_Response_200_Orders_OrderLines_Refunds_Taxes_AmountBreakdown_Parts
object
4 properties
1 required
OR14_Response_200
object
3 properties
2 required
OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_PurchaseTax
object
2 properties
1 required
OR30_Request_Cancelations_Taxes
object
The taxes to be canceled on the shipping price (this field is required if the order has shipping taxes). When feature 'order level tax calculation' is enabled…
2 properties
OR41_Response_200
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PriceAmountBreakdown
object
1 property
1 required
OR11_Response_200
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Customer
object
5 properties
5 required
OR11_Response_200_Orders_OrderRefunds
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_CommissionTaxes
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Operator_Shipping_Breakdown
object
2 properties
2 required
OR07_Response_200_OrderLines
object
3 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PriceAmountBreakdown_Parts
object
4 properties
1 required
OR11_Response_200_Orders_OrderLines_Taxes
object
7 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer
object
5 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions_Campaign
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Cancelations_ShippingAmountBreakdown
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Promotions
object
7 properties
4 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Customer_Offer_Breakdown
object
2 properties
2 required
OR07_Request_OrderLines_ShippingFrom_Warehouse
object
The warehouse from where the offer is shipped
1 property
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_AmountBreakdown
object
1 property
1 required
OR04_Request_Orders_ShopStatistics
object
Information about order exclusion from seller statistics
2 properties
1 required
OR11_Response_200_Orders_Channel
object
2 properties
2 required
OR07_Response_200_OrderLines_Updated_Address
object
6 properties
1 required
OR30_Response_200_Cancelations_AmountBreakdown_Parts
object
4 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation
object
6 properties
4 required
OR11_Response_200_Orders_Promotions_AppliedPromotions_Configuration
object
6 properties
2 required
OR04_Request_Orders_Customer
object
Customer information of the order (billing address)
5 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Operator_Fees_Breakdown
object
2 properties
2 required
OR04_Response_200_UpdatedOrders_Updated
object
10 properties
OR11_Response_200_Orders_OrderLines_Refunds_CommissionTaxes
object
2 properties
2 required
OR04_Request_Orders_References
object
Order references
2 properties
OR11_Response_200_Orders_OrderRefunds_Taxes
object
3 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_Customer_AccountingContact
object
6 properties
4 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Fees_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_OrderTaxes
object
3 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown
object
1 property
1 required
OR31_Response_200_OrderUpdateErrors
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom_Address
object
6 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_PurchaseTax
object
2 properties
1 required
OR30_Response_200_Cancelations_PurchaseInformation
object
6 properties
4 required
OR11_Response_200_Orders_OrderLines_Cancelations_ShippingAmountBreakdown_Parts
object
4 properties
1 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines_Cancelations_EcoContributions
object
5 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Customer_Shipping_Breakdown
object
2 properties
2 required
OR07_Request
object
1 property
1 required
OR74_Response_200_OrderDocuments_Errors
object
3 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Funding_Operator
object
5 properties
5 required
OR30_Response_200
object
2 properties
2 required
OR30_Request_Cancelations_Fees
object
The fees to be canceled
2 properties
OR41_Response_200_Messages_Documents
object
5 properties
3 required
OR11_Response_200_Orders_OrderLines_Funding_Operator_Fees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_AmountBreakdown_Parts
object
4 properties
1 required
OR04_Request
object
1 property
1 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines_Cancelations
object
2 properties
OR11_Response_200_Orders_OrderLines_Funding_Customer_Offer_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations
object
17 properties
5 required
OR31_Response_200_OrderUpdateErrors_Input_OrderLines
object
2 properties
1 required
OR74_Response_200_OrderDocuments
object
2 properties
1 required
OR04_Response_200_UpdatedOrders_Updated_Customer_DeliveryContact
object
1 property
OR51_Response_200
object
10 properties
8 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Operator_Shipping
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_EcoContributions
object
5 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Customer_Fees_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Measurement
object
4 properties
OR30_Request
object
2 properties
1 required
OR30_Response_200_Cancelations_Taxes_PurchaseTax
object
2 properties
1 required
OR11_Response_200_Orders_Customer_AccountingContact
object
6 properties
4 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Fees
object
1 property
1 required
OR04_Request_Orders_Customer_ShippingAddress
object
Customer shipping address
16 properties
OR31_Response_200_OrderUpdateResult_OrderLines
object
2 properties
1 required
OR30_Request_Cancelations_ShippingTaxes
object
The taxes to be canceled on the shipping price (this field is required if the order has shipping taxes). When feature 'order level tax calculation' is enabled…
2 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Customer_Offer_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation
object
6 properties
4 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions_Configuration
object
6 properties
2 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Shipping
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Offer_Breakdown
object
2 properties
2 required
OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions_Configuration
object
6 properties
2 required
OR72_Response_200_OrderDocuments
object
6 properties
4 required
OR30_Response_200_Cancelations_Taxes_AmountBreakdown
object
1 property
1 required
OR11_Response_200_Orders_PaymentDestination
object
2 properties
OR30_Response_200_Cancelations_ShippingTaxes_PurchaseTax
object
2 properties
1 required
OR11_Response_200_Orders_OrderAdditionalFields
object
2 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes
object
5 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Offer_Breakdown
object
2 properties
2 required
OR11_Response_200_Orders_OrderLines_Cancelations_AmountBreakdown
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Funding_Operator_Offer_Breakdown
object
2 properties
2 required
OR04_Response_200_UpdatedOrders_Updated_References
object
2 properties
OR15_Response_200_Ext_FileStructure_Orders_References
object
2 properties
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Customer_Fees
object
1 property
1 required
OR11_Response_200_Orders_OrderLines_Funding_Operator_Shipping
object
1 property
1 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Funding_Operator_Fees_Breakdown
object
2 properties
2 required
OR28_Response_200_Refunds_Taxes
object
5 properties
2 required
OR32_Response_200_OrderLinesAdjusted
object
5 properties
OR28_Response_200_Refunds_AmountBreakdown_Parts
object
4 properties
1 required
OR28_Response_200_Refunds_ShippingTaxes_PurchaseTax
object
2 properties
1 required
OR26_Request_OrderLines
object
List of order line's representations
2 properties
2 required
OR28_Request_Refunds_ShippingTaxes
object
The taxes to be refunded on the shipping price This field is required if the order has shipping taxes.
2 properties
OR28_Response_200_Refunds_Taxes_AmountBreakdown
object
1 property
1 required
OR28_Request_Refunds_Taxes
object
The taxes to be refunded on the shipping price This field is required if the order has shipping taxes.
2 properties
OR26_Request
object
1 property
1 required
OR28_Response_200_Refunds_ShippingAmountBreakdown_Parts
object
4 properties
1 required
OR28_Request_Refunds
object
List of representations of refunds to be created
11 properties
4 required
OR32_Response_200_OrderLinesAdjusted_Measurement
object
4 properties
OR04_Request_Orders_OrderLines_EcoContributions
object
Eco-contributions to add or update on the order line - only available if the operator setting Activate data collection related to circular economy regulations…
3 properties
2 required
OR32_Response_200_OrderLinesAdjusted_Cancelations_ShippingTaxes
object
2 properties
OR32_Request
object
1 property
1 required
OR32_Response_200_OrderLinesAdjusted_Refunds
object
8 properties
OR28_Response_200_Refunds_ShippingTaxes_AmountBreakdown_Parts
object
4 properties
1 required
OR28_Request
object
2 properties
1 required
OR32_Response_200
object
1 property
OR28_Response_200_Refunds_PurchaseInformation_PurchaseFeeAmount
object
1 property
1 required
OR28_Response_200_Refunds_ShippingTaxes_AmountBreakdown
object
1 property
1 required
OR28_Response_200_Refunds_EcoContributions
object
5 properties
3 required
OR28_Response_200_Refunds_AmountBreakdown
object
1 property
1 required
OR28_Response_200_Refunds_ShippingAmountBreakdown
object
1 property
1 required
OR32_Response_200_OrderLinesAdjusted_Cancelations_Taxes
object
2 properties
OR04_Request_Orders_OrderLines
object
Order lines to be updated
2 properties
1 required
OR28_Response_200
object
2 properties
2 required
OR28_Response_200_Refunds
object
17 properties
7 required
OR28_Response_200_Refunds_PurchaseInformation_PurchaseCommissionOnFees
object
1 property
1 required
OR28_Response_200_Refunds_ShippingTaxes
object
5 properties
2 required
OR28_Response_200_Refunds_Taxes_AmountBreakdown_Parts
object
4 properties
1 required
OR04_Request_Orders_2
object
Orders to be updated, maximum number of orders per call: 100
9 properties
1 required
OR28_Response_200_Refunds_Fees
object
2 properties
OR32_Response_200_OrderLinesAdjusted_Errors
object
3 properties
3 required
OR32_Response_200_OrderLinesAdjusted_Cancelations
object
8 properties
OR32_Response_200_OrderLinesAdjusted_Refunds_EcoContributions
object
5 properties
3 required
OR32_Response_200_OrderLinesAdjusted_Refunds_Taxes
object
2 properties
OR28_Request_Refunds_Fees
object
The fee part amount to be refunded
2 properties
OR32_Request_OrderLines
object
Order lines to be updated, maximum number of order lines per call: 100
2 properties
2 required
OR32_Response_200_OrderLinesAdjusted_Cancelations_EcoContributions
object
5 properties
3 required
OR28_Response_200_Refunds_Taxes_PurchaseTax
object
2 properties
1 required
OR32_Response_200_OrderLinesAdjusted_Refunds_ShippingTaxes
object
2 properties
OR28_Response_200_Refunds_PurchaseInformation
object
6 properties
4 required
OR15_Response_200_Ext_FileStructure_Orders_Customer_DeliveryContact_2
object
5 properties
3 required
OR13_Request_2
object
11 properties
OR15_Response_200_Ext_FileStructure_Orders_Customer_2
object
10 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_EcoContributions_2
object
5 properties
3 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_2
object
50 properties
27 required
OR11_Response_200_Orders_Customer_DeliveryContact_2
object
5 properties
3 required
OR11_Response_200_Orders_OrderLines_2
object
50 properties
27 required
OR15_Response_200_Ext_FileStructure_Orders_2
object
55 properties
26 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines_EcoContributions_2
object
5 properties
OR28_Request_Refunds_2
object
List of representations of refunds to be created
10 properties
4 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_2
object
16 properties
5 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines_Refunds_EcoContributions_2
object
5 properties
OR11_Response_200_Orders_Customer_ShippingAddress_2
object
15 properties
5 required
OR11_Response_200_Orders_OrderLines_Cancelations_EcoContributions_2
object
5 properties
3 required
OR11_Response_200_Orders_OrderLines_EcoContributions_2
object
5 properties
3 required
OR75_Response_200_Taxes_2
object
3 properties
3 required
OR28_Response_200_Refunds_EcoContributions_2
object
5 properties
3 required
OR12_Response_200_OrderLines_2
object
32 properties
31 required
OR11_Response_200_Orders_Customer_Organization_2
object
5 properties
1 required
OR15_Response_200_Ext_FileStructure_Orders_Customer_ShippingAddress_2
object
15 properties
5 required
OR11_Response_200_Orders_2
object
55 properties
26 required
OR30_Response_200_Cancelations_EcoContributions_2
object
5 properties
3 required
OR12_Response_200_2
object
26 properties
22 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_EcoContributions_2
object
5 properties
3 required
OR11_Response_200_Orders_OrderLines_Refunds_EcoContributions_2
object
5 properties
3 required
OR12_Response_200_Customer_ShippingAddress_2
object
14 properties
5 required
OR28_Response_200_Refunds_2
object
16 properties
7 required
OR04_Request_Orders_3
object
Orders to be updated, maximum number of orders per call: 100
3 properties
1 required
OR11_Response_200_Orders_Customer_2
object
10 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_Customer_Organization_2
object
5 properties
1 required
OR12_Response_200_Customer_2
object
6 properties
5 required
OR11_Response_200_Orders_OrderLines_Refunds_2
object
23 properties
11 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_2
object
23 properties
11 required
OR32_Response_200_OrderLinesAdjusted_Refunds_EcoContributions_2
object
5 properties
3 required
OR04_Response_200_UpdatedOrders_Updated_2
object
2 properties
OR04_Request_Orders_References_2
object
Order references
1 property
OR15_Response_200_Ext_FileStructure_Orders_Customer_AccountingContact_2
object
5 properties
3 required
OR04_Response_200_UpdatedOrders_Updated_OrderLines_Cancelations_EcoContributions_2
object
5 properties
OR32_Response_200_OrderLinesAdjusted_Cancelations_EcoContributions_2
object
5 properties
3 required
OR11_Response_200_Orders_OrderLines_Cancelations_2
object
16 properties
5 required
OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_EcoContributions_2
object
5 properties
3 required
OR11_Response_200_Orders_Customer_AccountingContact_2
object
5 properties
3 required
OR04_Response_200_UpdatedOrders_Updated_References_2
object
1 property
SOR51_Response_200_Assessments
object
3 properties
3 required
SOR04_Response_200_Commission_CommissionTaxes
object
2 properties
2 required
SOR04_Response_200_Price
object
2 properties
1 required
SOR04_Request_CustomAttributeValues
object
Order custom attribute values to update. Only specified custom attribute values will be updated. In order to delete a custom attribute value, set it to null .
3 properties
3 required
SOR04_Response_200_Service_Category
object
2 properties
2 required
SOR04_Response_200_Consumption
object
1 property
1 required
SOR04_Request_Price
object
New price for this order.
1 property
SOR51_Response_200
object
10 properties
8 required
SOR04_Response_200_Service_Model
object
2 properties
2 required
SOR04_Response_200_CustomAttributeValues
object
4 properties
3 required
SOR04_Response_200_Refunds_Options
object
3 properties
2 required
SOR04_Request_Price_Options
object
Order pricing options to update. Only specified pricing options will be updated (non specified pricing option will be ignored). Please note that pricing option…
2 properties
1 required
SOR04_Response_200_Workflow
object
1 property
1 required
SOR04_Response_200_Customer
object
8 properties
2 required
SOR04_Response_200_Location
object
1 property
1 required
SOR51_Response_200_Reply
object
3 properties
3 required
SOR04_Response_200_Shop
object
2 properties
2 required
SOR04_Response_200_Service
object
7 properties
5 required
SOR04_Response_200_Refunds
object
10 properties
7 required
SOR04_Response_200_Booking
object
1 property
1 required
SOR04_Request
object
3 properties
SOR04_Response_200_Refunds_Commission
object
3 properties
SOR04_Request_Booking
object
Booking information to update for this order.
1 property
SOR04_Response_200_Service_CustomAttributeValues
object
4 properties
3 required
SOR04_Response_200
object
23 properties
15 required
SOR04_Response_200_Service_Medias
object
2 properties
2 required
SOR04_Response_200_Customer_BillingAddress
object
12 properties
5 required
SOR04_Response_200_Refunds_Commission_CommissionTaxes
object
2 properties
2 required
SOR25_Request
object
2 properties
SOR04_Response_200_Price_Options
object
3 properties
2 required
SOR04_Response_200_Refunds_Taxes
object
2 properties
2 required
SOR04_Response_200_Commission
object
3 properties
SOR28_Request_Taxes
object
2 properties
2 required
SOR04_Request_Price_2
object
New price for this order.
1 property
SOR04_Request_Price_Options_2
object
Order pricing options to update. Only specified pricing options will be updated (non specified pricing option will be ignored). Please note that pricing option…
2 properties
1 required
SOR28_Request_Options
object
The options to be refunded. This field is required if the order has options.
2 properties
1 required
SOR04_Request_2
object
3 properties
SOR28_Request
object
5 properties
3 required
SOR11_Response_200_Data
object
21 properties
13 required
SOR11_Response_200_Data_Refunds
object
10 properties
7 required
SOR11_Response_200_Data_CustomAttributeValues
object
4 properties
3 required
SOR11_Response_200_Data_Customer
object
7 properties
2 required
SOR11_Response_200_Data_Refunds_Commission_CommissionTaxes
object
2 properties
2 required
SOR11_Response_200_Data_Service_Model
object
2 properties
2 required
SOR04_Request_Price_3
object
New price for this order.
1 property
SOR11_Response_200_Data_Consumption
object
1 property
1 required
SOR11_Response_200_Data_Location
object
1 property
1 required
SOR11_Response_200_Data_Service_Category
object
2 properties
2 required
SOR11_Response_200_Data_Commission_CommissionTaxes
object
2 properties
2 required
SOR04_Request_Price_Options_3
object
Order pricing options to update. Only specified pricing options will be updated (non specified pricing option will be ignored). Please note that the seller can…
2 properties
1 required
SOR04_Response_200_Customer_2
object
7 properties
2 required
SOR11_Response_200
object
3 properties
1 required
SOR11_Response_200_Data_Commission
object
3 properties
SOR11_Response_200_Data_Refunds_Commission
object
3 properties
SOR11_Response_200_Data_Booking
object
1 property
1 required
SOR11_Response_200_Data_Service_CustomAttributeValues
object
4 properties
3 required
SOR11_Response_200_Data_Customer_BillingAddress
object
12 properties
5 required
SOR11_Response_200_Data_Price
object
2 properties
1 required
SOR11_Response_200_Data_Price_Options
object
3 properties
2 required
SOR11_Response_200_Data_Service_Medias
object
2 properties
2 required
SOR04_Request_3
object
3 properties
SOR11_Response_200_Data_Service
object
7 properties
5 required
SOR11_Response_200_Data_Refunds_Taxes
object
2 properties
2 required
SOR11_Response_200_Data_Workflow
object
1 property
1 required
SOR04_Response_200_2
object
21 properties
13 required
SOR11_Response_200_Data_Refunds_Options
object
3 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Mirakl 12
Other APIs Mirakl publishes across the network.
Mirakl Carriers API
Mirakl Catalog Configuration API
Mirakl Incidents API
Mirakl Invoicing and Accounting API
Mirakl Messages API
Mirakl Multiple shipments API
Mirakl Offers API
Mirakl Picklists API
Mirakl Platform Settings API
Mirakl Product Feedback API
Mirakl Products API
Mirakl Promotions API
#Order
Where this information came from
This is an independent, third-party profile of Mirakl Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.