Integration Overview
...
API Catalog
Orders
OR11 - List Orders
When available, refunds will be returned within the refunds object under orders.order_lines.refunds
GET
Request
Query Parameters
order_ids
optional
String
A comma-separated list of order's identifiers. max: 100
order_references_for_customer
optional
String
A comma-separated list of order references for customer. max: 100
order_references_for_seller
optional
String
A comma-separated list of order references for seller. max: 100
order_state_codes
optional
String
A comma-separated list of order state's codes
channel_codes
optional
String
A comma-separated list of channel codes. max: 100
only_null_channel
optional
Boolean
Return only orders without channel. If true, ignore the channel_codes. Default to false.
start_date
optional
String
Start creation date for filtering
end_date
optional
String
End creation date for filtering
start_update_date
optional
String
Start update date for filtering. Mirakl will subtract a time delta to ensure no orders are missed due to network and/or software latency.
end_update_date
optional
String
End update date for filtering
paginate
optional
Boolean
Control the pagination usage. Default to true.
customer_debited
optional
Boolean
Order paid by customer
payment_workflow
optional
String
Payment workflow of an order. One of: PAY_ON_ACCEPTANCE, PAY_ON_DELIVERY, PAY_ON_DUE_DATE, PAY_ON_SHIPMENT, NO_CUSTOMER_PAYMENT_CONFIRMATION
has_incident
optional
Boolean
If true returns only orders with incidents in progress, if false returns orders without incidents in progress. Default to all.
fulfillment_center_code
optional
Array
Code of the fulfillment center. max: 100
order_tax_mode
optional
String
One of: TAX_INCLUDED, TAX_EXCLUDED. Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts. Possible values: TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) do not include taxes (taxes come on top of the price amount). TAX_INCLUDED: the price fields include the tax amount. If this query parameter is not specified, the default order tax mode of the platform is used.m is used.
shop_id
optional
Integer
Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
Header Parameters
Authorization
required
String
CALL FREQUENCIES
Recommended: - Asynchronous: every 5 minutes - Synchronous: at each order page display Maximum: - Asynchronous: once per minute - Synchronous: at each order page display
PAGINATION
This resource supports offset pagination.
SORT FIELDS
Sort field can have the following values: dateCreated (Default) - Sort by creation date, and then by order identifier (asc by default)
LOCALIZATION
This resource supports locale parameter (see documentation). Localized output fields will be highlighted with a flag icon.