true, ignore the channel_codes"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Start creation date for filtering"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "End creation date for filtering"
},
{
"name": "start_update_date",
"value": "",
"type": "query",
"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."
},
{
"name": "end_update_date",
"value": "",
"type": "query",
"description": "End update date for filtering"
},
{
"name": "customer_debited",
"value": "",
"type": "query",
"description": "Order paid by customer"
},
{
"name": "payment_workflow",
"value": "",
"type": "query",
"description": "Payment workflow of an order"
},
{
"name": "has_incident",
"value": "",
"type": "query",
"description": "If true returns only orders with incidents in progress, if false returns orders without incidents in progress. If not provided, all orders with or without incident will be returned"
},
{
"name": "fulfillment_center_code",
"value": "",
"type": "query",
"description": "Code of the fulfillment center"
},
{
"name": "order_tax_mode",
"value": "",
"type": "query",
"description": "Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) do not include taxes.TAX_INCLUDED: the price fields include the tax amount. true returns only orders with commission, if false returns orders without commission. Please note that this filter is available only when the platform is in mixed commission model"
},
{
"name": "waiting_tax_confirmation",
"value": "",
"type": "query",
"description": "If true returns only orders awaiting a tax confirmation, When false it does not impact the result."
},
{
"name": "tax_recalculation_required_only",
"value": "",
"type": "query",
"description": "If true returns only orders for which taxes must be recalculated on at least one order line. When false it does not impact the result. Must be used with at least one date range filter: created or last updated date, of a maximum duration of one month."
},
{
"name": "waiting_funding_confirmation",
"value": "",
"type": "query",
"description": "If true returns only orders awaiting a funding update. When false it does not impact the result."
},
{
"name": "refund_state_codes",
"value": "",
"type": "query",
"description": "A comma-separated list of refund state's codes.start_update_date and end_update_date, with a maximum of one month period.\n"
}
]
},
"docs": "Update orders information field by field: unspecified fields will not be updated. To remove the value for a field, send it with the 'null' value (not allowed for the required fields).
You cannot use API OR04 to update customer-related information if the customer has been anonymized via API AN01.
A maximum of 100 orders can be sent at once.
\n\nThis resource supports locale parameter (see documentation)
Localized output fields will be highlighted with an icon:
Update shipping origin (shipping_from) information on order lines.
A maximum of 100 order lines can be sent at once.
\n\nThe API returns a tracking id to be used to query API OR14.
Mirakl recommends to use API OR13 instead of API OR11 as it can handle very large volumes of data.
You must give at least one date range filter: created, last updated date or refunds created date.
API OR13 supports the chunk of the export file into multiple files in order to:
megabytes_per_chunk parameter"
},
{
"info": {
"name": "OR14 - Get the status of an asynchronous order export.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/orders/async-export/status/:tracking_id",
"params": [
{
"name": "tracking_id",
"value": "",
"type": "path",
"description": "Id of the previously created asynchronous order export"
}
]
},
"docs": "Use this API to query the order export status after an API OR13 call.
Until the export via API OR13 is complete, the status returned by API OR14 is PENDING.
You must call API OR14 until you get the COMPLETED status which correspond to a completed and successful export from API OR13.
The URLs in API OR14 response contain all the files from API OR13 export.
Browse those urls and query them using the GE"
},
{
"info": {
"name": "OR15 - Retrieve order export files once asynchronous export is complete (OR13).",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/dynamic-url/The+URL+is+retrieved+from+OR14+output/OR15"
},
"docs": "
WAITING_ACCEPTANCE status\n\nORDER_FULFILLED_UNAUTHORIZED | An unauthorized action has been requested on a fulfilled order |\n| ORDER_INVALID_STATE | Order is not in the expected state for this operation |\n| ORDER_LINE_ACCEPTANCE_DECISION_MISSING | Some order lines are missing"
},
{
"info": {
"name": "OR23 - Update carrier tracking information for a specific order",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://miraklconnect.com/api/channel-platform/api/orders/:order_id/tracking",
"params": [
{
"name": "order_id",
"value": "",
"type": "path",
"description": "Order identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "SHIPPING status\n\nPAY_ON_DELIVERY, PAY_ON_DUE_DATE or PAY_ON_SHIPMENT workflows: shop can only cancel a non-debited order.NO_CUSTOMER_PAYMENT_CONFIRMATION workflow: shop can only cancel an unshipped order.PAY_ON_DELIVERY, PAY_ON_DUE_DATE or PAY_ON_SHIPMENT workflows: shop can only cancel a non-debited order.NO_CUSTOMER_PAYMENT_CONFIRMATION workflow: shop can only cancel an unshipped order.Update order line actual measurement either upwards or downwards, within the limit defined at the platform level.
\n\nORDER_ADJUSTMENT_FEATURE_DISABLED | The order adjustment feature is not enabled |\n| ORDER_LINE_ADJUSTMENT_EQUAL_TO_ORDERED | The actual measurement equals the ordered measurement |\n| ORDER_LINE_ADJUSTMENT_EXC"
},
{
"info": {
"name": "OR41 - List messages of an order",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/orders/:order_id/messages",
"params": [
{
"name": "order_id",
"value": "",
"type": "path",
"description": "Order identifier"
},
{
"name": "read",
"value": "",
"type": "query",
"description": "Ignored, will be removed in a future version"
},
{
"name": "archived",
"value": "",
"type": "query",
"description": "Ignored, will be removed in a future version"
},
{
"name": "received",
"value": "",
"type": "query",
"description": "If \"TRUE\" (\"FALSE\") returns only messages received by (sent to) operator. If \"ALL\", returns all messages, even direct messages between customer and shop."
}
]
},
"docs": "Deprecated endpoint\n\nThis API is going to be removed in a future update, please use M10 and M11 instead\n\nDescription\n\nBy default, all sent, received and unarchived message are listed\n\n\nCall Frequency\n\nRecommended usage: On each message page view\nMaximum usage: On each message p"
},
{
"info": {
"name": "OR51 - Get the evaluation of an order",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/orders/:order_id/evaluation",
"params": [
{
"name": "order_id",
"value": "",
"type": "path"
}
]
},
"docs": "\nCall Frequency\n\nRecommended usage: On each evaluation page view\nMaximum usage: On each evaluation page view\nRead More\n\nLocalization"
},
{
"info": {
"name": "OR72 - Lists order's documents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/orders/documents",
"params": [
{
"name": "order_ids",
"value": "",
"type": "query",
"description": "the orders' identifiers, using comma as separator"
}
]
},
"docs": "Description\n\nReturns a list of all the documents available on the order\n\n\nCall Frequency\n\nRecommended usage: At each document list page display\nMaximum usage: At each document list page display\nRead More\n\n\n\n - If a list of document identifiers is specified only these documents are downloaded.
- If more than one document id is specified, the documents will be wrapped in a ZIP archive
- If only one document id is specified the document will not be zipped
- If a list of order identifiers is specified, all documents from those orders are downloaded.
Use a list of order doc"
},
{
"info": {
"name": "OR74 - Upload documents to attach to an order",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://miraklconnect.com/api/channel-platform/api/orders/:order_id/documents",
"params": [
{
"name": "order_id",
"value": "",
"type": "path",
"description": "The identifier of the order"
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "files",
"type": "text",
"value": ""
},
{
"name": "order_documents",
"type": "text",
"value": ""
}
]
}
},
"docs": "Description\n\n\n Documents filenames must be distinct. Only documents of the following types are supported: csv, doc, xls, xlsx, ppt, pdf, odt, ods, odp, txt, rtf, png, jpg, gif, zpl, mov, mp4.\nAn order can have a maximum of 50 documents.\n In the API output we include only documents with errors. All other documents are successfully uploaded.\n
\nFor system document types, there are specific restrictions :
\n\n \nCall Frequency\n\nRecommended usage: At each order document deletion\nMaximum usage: At each order document deletion\nRead More\n\n- More conte"
},
{
"info": {
"name": "SOR04 - Update an order",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://miraklconnect.com/api/channel-platform/api/mms/orders/:order_id",
"params": [
{
"name": "order_id",
"value": "",
"type": "path",
"description": "The identifier of the order to be updated"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Description\n\nNote: closed or cancelled order cannot be updated.\n\n\nRead More\n\n"
},
{
"info": {
"name": "SOR21 - Accept an order",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://miraklconnect.com/api/channel-platform/api/mms/orders/:order_id/accept",
"params": [
{
"name": "order_id",
"value": "",
"type": "path",
"description": "The identifier of the order to be accepted."
}
]
},
"docs": "Description\n\nAccept an order in
WAITING_ACCEPTANCE state\n\n\nCall Frequency\n\nRecommended usage: For each new service order\nMaximum usage: For each new service order\nRead More\n\n\n\nRefuse an order in WAITING_ACCEPTANCE state\n\n\nCall Frequency\n\nRecommended usage: For each new service order\nMaximum usage: For each new service order\nRead More\n\n\n\nConsumer an order in ORDER_PENDING state\n\n\nCall Frequency\n\nRecommended usage: At each customer service consumption confirmation\nMaximum usage: At each customer service consumption confirmation\nRead More\n\n"
},
{
"info": {
"name": "SOR51 - Get the evaluation of an order",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/mms/orders/:order_id/evaluation",
"params": [
{
"name": "order_id",
"value": "",
"type": "path"
}
]
},
"docs": "\nCall Frequency\n\nRecommended usage: At each order evaluation page display\nMaximum usage: At each order evaluation page display\nRead More\n\n"
},
{
"info": {
"name": "SOR11 - List orders",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://miraklconnect.com/api/channel-platform/api/mms/orders",
"params": [
{
"name": "order_id",
"value": "",
"type": "query",
"description": "Order ids to include in result."
},
{
"name": "commercial_order_id",
"value": "",
"type": "query",
"description": "Order commercial ids to include in result."
},
{
"name": "state",
"value": "",
"type": "query",
"description": "Order states to include in result."
},
{
"name": "customer_id",
"value": "",
"type": "query",
"description": "Order customer ids to include in result."
},
{
"name": "service_code",
"value": "",
"type": "query",
"description": "Order services codes to include in result."
},
{
"name": "date_created_start",
"value": "",
"type": "query",
"description": "Creation date to start from."
},
{
"name": "date_created_end",
"value": "",
"type": "query",
"description": "Creation date to end with."
},
{
"name": "date_updated_start",
"value": "",
"type": "query",
"description": "Last modification date to start from."
},
{
"name": "date_updated_end",
"value": "",
"type": "query",
"description": "Last modification date to end with."
},
{
"name": "refunded",
"value": "",
"type": "query",
"description": "Refund completion."
},
{
"name": "refund_reason_code",
"value": "",
"type": "query",
"description": "Refund reason codes"
},
{
"name": "has_open_incident",
"value": "",
"type": "query",
"description": "If true returns only orders with open incidents, if false returns orders without open incidents. Default to all"
},
{
"name": "shop_id",
"value": "",
"type": "query",
"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."
}
]
},
"docs": "\nCall Frequency\n\nRecommended usage: At each service order page display\nMaximum usage: At each service order page display\nPagination\n\nThis resource supports seek pagination (see documentation)
\n\n"
}
]
}
],
"bundled": true
}