OR11 - List Orders

When available, refunds will be returned within the refunds object under orders.order_lines.refunds

GET

https://saksus2-dev.mirakl.net/api/orders

Query Parameters

order_idsstring
Description
A comma-separated list of order's identifiers. max: 100
order_references_for_customerstring
Description
A comma-separated list of order references for customer. max: 100
order_references_for_sellerstring
Description
A comma-separated list of order references for seller. max: 100
order_state_codesstring
Description
A comma-separated list of order state's codes
channel_codesstring
Description
A comma-separated list of channel codes. max: 100
only_null_channelBoolean
Description
Return only orders without channel. If true, ignore the channel_codes. Default to false.
start_datestring
Description
Start creation date for filtering
end_datestring
Description
End creation date for filtering
start_update_datestring
Description
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_datestring
Description
End update date for filtering
paginateBoolean
Description
Control the pagination usage. Default to true.
customer_debitedBoolean
Description
Order paid by customer
payment_workflowstring
Description
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_incidentBoolean
Description
If true returns only orders with incidents in progress, if false returns orders without incidents in progress. Default to all.
fulfillment_center_codeArray
Description
Code of the fulfillment center. max: 100
order_tax_modestring
Description
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_idInteger
Description
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

Authorizationstringrequired

curl

curl --location --request GET 'https://saksus2-dev.mirakl.net/api/orders?order_ids=string&order_references_for_customer=string&order_references_for_seller=string&order_state_codes=string&channel_codes=string&only_null_channel=Boolean&start_date=string&end_date=string&start_update_date=string&end_update_date=string&paginate=Boolean&customer_debited=Boolean&payment_workflow=string&has_incident=Boolean&fulfillment_center_code=Array&order_tax_mode=string&shop_id=Integer' \
--header 'Accept: application/json' \
--header 'Authorization: string'

nodejs

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://saksus2-dev.mirakl.net/api/orders?order_ids=string&order_references_for_customer=string&order_references_for_seller=string&order_state_codes=string&channel_codes=string&only_null_channel=Boolean&start_date=string&end_date=string&start_update_date=string&end_update_date=string&paginate=Boolean&customer_debited=Boolean&payment_workflow=string&has_incident=Boolean&fulfillment_center_code=Array&order_tax_mode=string&shop_id=Integer',
   'headers': {
      'Accept': 'application/json',
      'Authorization': 'string'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://saksus2-dev.mirakl.net/api/orders?order_ids=string&order_references_for_customer=string&order_references_for_seller=string&order_state_codes=string&channel_codes=string&only_null_channel=Boolean&start_date=string&end_date=string&start_update_date=string&end_update_date=string&paginate=Boolean&customer_debited=Boolean&payment_workflow=string&has_incident=Boolean&fulfillment_center_code=Array&order_tax_mode=string&shop_id=Integer", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests

url = "https://saksus2-dev.mirakl.net/api/orders?order_ids=string&order_references_for_customer=string&order_references_for_seller=string&order_state_codes=string&channel_codes=string&only_null_channel=Boolean&start_date=string&end_date=string&start_update_date=string&end_update_date=string&paginate=Boolean&customer_debited=Boolean&payment_workflow=string&has_incident=Boolean&fulfillment_center_code=Array&order_tax_mode=string&shop_id=Integer"

payload={}
headers = {
   'Accept': 'application/json',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://saksus2-dev.mirakl.net/api/orders?order_ids=string&order_references_for_customer=string&order_references_for_seller=string&order_state_codes=string&channel_codes=string&only_null_channel=Boolean&start_date=string&end_date=string&start_update_date=string&end_update_date=string&paginate=Boolean&customer_debited=Boolean&payment_workflow=string&has_incident=Boolean&fulfillment_center_code=Array&order_tax_mode=string&shop_id=Integer")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "string"

response = https.request(request)
puts response.read_body

200

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.