--- title: OR11 - List Orders slug: or11-list-orders createdAt: 2023-03-02T18:14:43.000Z --- :::ApiMethodV2 ```json { "tab": "examples", "url": "https://saksus2-dev.mirakl.net/api/orders", "name": "OR11 - List Orders", "method": "GET", "request": { "pathParameters": [], "queryParameters": [ { "kind": "optional", "name": "order_ids", "type": "string", "children": [], "description": "A comma-separated list of order's identifiers. max: 100" }, { "kind": "optional", "name": "order_references_for_customer", "type": "string", "children": [], "description": "A comma-separated list of order references for customer. max: 100" }, { "kind": "optional", "name": "order_references_for_seller", "type": "string", "children": [], "description": "A comma-separated list of order references for seller. max: 100" }, { "kind": "optional", "name": "order_state_codes", "type": "string", "children": [], "description": "A comma-separated list of order state's codes" }, { "kind": "optional", "name": "channel_codes", "type": "string", "children": [], "description": "A comma-separated list of channel codes. max: 100" }, { "kind": "optional", "name": "only_null_channel", "type": "Boolean", "children": [], "description": "Return only orders without channel. If true, ignore the channel_codes. Default to false." }, { "kind": "optional", "name": "start_date", "type": "string", "children": [], "description": "Start creation date for filtering" }, { "kind": "optional", "name": "end_date", "type": "string", "children": [], "description": "End creation date for filtering" }, { "kind": "optional", "name": "start_update_date", "type": "string", "children": [], "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." }, { "kind": "optional", "name": "end_update_date", "type": "string", "children": [], "description": "End update date for filtering" }, { "kind": "optional", "name": "paginate", "type": "Boolean", "children": [], "description": "Control the pagination usage. Default to true." }, { "kind": "optional", "name": "customer_debited", "type": "Boolean", "children": [], "description": "Order paid by customer" }, { "kind": "optional", "name": "payment_workflow", "type": "string", "children": [], "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" }, { "kind": "optional", "name": "has_incident", "type": "Boolean", "children": [], "description": "If true returns only orders with incidents in progress, if false returns orders without incidents in progress. Default to all." }, { "kind": "optional", "name": "fulfillment_center_code", "type": "Array", "children": [], "description": "Code of the fulfillment center. max: 100" }, { "kind": "optional", "name": "order_tax_mode", "type": "string", "children": [], "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." }, { "kind": "optional", "name": "shop_id", "type": "Integer", "children": [], "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." } ], "headerParameters": [ { "kind": "required", "name": "Authorization", "type": "string", "children": [], "description": "" } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "v7DTFM7X5fBGJC-QuHW8W", "code": "", "language": "200", "customLabel": "" } ], "selectedLanguageId": "v7DTFM7X5fBGJC-QuHW8W" }, "examples": { "languages": [ { "id": "CuWelsXDf4HXBsHMFxQcv", "code": "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' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: string'", "language": "curl", "customLabel": "" }, { "id": "YOmdbusHOQ79tayt_ZI75", "code": "var request = require('request');\nvar options = {\n 'method': 'GET',\n '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',\n 'headers': {\n 'Accept': 'application/json',\n 'Authorization': 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n", "language": "nodejs", "customLabel": "" }, { "id": "4almD6Jd6pUnTO9vugucB", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Authorization\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"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)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));", "language": "javascript", "customLabel": "" }, { "id": "ME8uE13tpQZ-8cXdckjzH", "code": "import requests\n\nurl = \"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\"\n\npayload={}\nheaders = {\n 'Accept': 'application/json',\n 'Authorization': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n", "language": "python", "customLabel": "" }, { "id": "kkw2N-fN0N9lDksMiZ1Py", "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = 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\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Authorization\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n", "language": "ruby", "customLabel": "" } ], "selectedLanguageId": "CuWelsXDf4HXBsHMFxQcv" }, "description": "When available, refunds will be returned within the refunds object under orders.order_lines.refunds", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "or11-list-orders", "legacyHash": "maZHvWeiBD4W3uQ36Keqk" } ``` ::: ::::VerticalSplit{layout="middle"} :::VerticalSplitItem **CALL FREQUENCIES** ::: :::VerticalSplitItem Recommended: \- Asynchronous: every 5 minutes \- Synchronous: at each order page display Maximum: \- Asynchronous: once per minute \- Synchronous: at each order page display ::: :::: ::::VerticalSplit{layout="middle"} :::VerticalSplitItem **PAGINATION** ::: :::VerticalSplitItem This resource supports offset pagination. ::: :::: ::::VerticalSplit{layout="middle"} :::VerticalSplitItem **SORT FIELDS** ::: :::VerticalSplitItem Sort field can have the following values: dateCreated (Default) - Sort by creation date, and then by order identifier (asc by default) ::: :::: ::::VerticalSplit{layout="middle"} :::VerticalSplitItem **LOCALIZATION** ::: :::VerticalSplitItem This resource supports locale parameter ([see documentation](https://saksus1-dev.mirakl.net/help/help/api-doc/seller/mmp.html#locale)). Localized output fields will be highlighted with a flag icon. ::: ::::