{ "opencollection": "1.0.0", "info": { "name": "Mirakl Connect Channel Platform APIs Carriers Returns API", "version": "1.0" }, "items": [ { "info": { "name": "Returns", "type": "folder" }, "items": [ { "info": { "name": "upsertReturns - Upsert returns", "type": "http" }, "http": { "method": "POST", "url": "https://miraklconnect.com/api/channel-platform/v1/orders/returns", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "
Description
\n\nUse this API to synchronize returns with Mirakl Connect.\n\n ## Overview\n - Returns are always associated to an order already known by Mirakl Connect\n - Each return line must reference an order line already known by Mirakl Connect\n - The API performs an upsert: existing returns are updated, new ones are created\n - The operation is **partially successful**: some returns in the payload can succeed while others fail\n\n ## Usage Notes\n - The" }, { "info": { "name": "RT11 - List returns", "type": "http" }, "http": { "method": "GET", "url": "https://miraklconnect.com/api/channel-platform/api/returns", "params": [ { "name": "return_id", "value": "", "type": "query", "description": "Return id for filtering. This parameter can be supplied multiple times (return_id=58fd00d1-4ea4-453e-9a56-ec28c5c156ea&return_id=3071c162-dcd9-414b-a39d-ac3165f29453...)." }, { "name": "return_state", "value": "", "type": "query", "description": "Return state for filtering. This parameter can be supplied multiple times (return_state=WAITING_ACCEPTANCE&return_state=IN_PROGRESS...)." }, { "name": "return_creation_date_from", "value": "", "type": "query", "description": "Filter returns with a creation date after the given date." }, { "name": "return_creation_date_to", "value": "", "type": "query", "description": "Filter returns with a creation date before the given date." }, { "name": "return_last_updated_from", "value": "", "type": "query", "description": "Filter returns updated after the given date." }, { "name": "return_last_updated_to", "value": "", "type": "query", "description": "Filter returns updated before the given date." }, { "name": "order_commercial_id", "value": "", "type": "query", "description": "Order commercial id for filtering. This parameter can be supplied multiple times (order_commercial_id=OR01-A&order_commercial_id=OR02-A...)." }, { "name": "order_line_id", "value": "", "type": "query", "description": "Order line id for filtering. This parameter can be supplied multiple times (order_line_id=OR01-A-1&order_line_id=OR02-A-1...)." }, { "name": "return_rma", "value": "", "type": "query", "description": "Return RMA for filtering. This parameter can be supplied multiple times (return_rma=RMA-1&return_rma=RMA-2...)." }, { "name": "customer_id", "value": "", "type": "query", "description": "Customer id for filtering. This parameter can be supplied multiple times (customer_id=id1&customer_id=id2...)." } ] }, "docs": "
\n
Call Frequency
\n\n
Recommended usage: Every 15 minutes
\n
Maximum usage: Every 5 minutes
\n
Read More
\n\n
Pagination
\n\n

This resource supports s" }, { "info": { "name": "RT01 - Create returns", "type": "http" }, "http": { "method": "POST", "url": "https://miraklconnect.com/api/channel-platform/api/returns", "body": { "type": "json", "data": "{}" } }, "docs": "

Description
\n\nLimited to 200 returns at a time\n\n
\n
Call Frequency
\n\n
Recommended usage: At each customer return request
\n
Maximum usage: At each customer return request
\n
Read More
\n\n
" }, { "info": { "name": "RT12 - List items to return", "type": "http" }, "http": { "method": "GET", "url": "https://miraklconnect.com/api/channel-platform/api/returns/items_to_return", "params": [ { "name": "order_commercial_id", "value": "", "type": "query", "description": "Order commercial id for filtering. This parameter can be supplied multiple times (order_commercial_id=OR01-A&order_commercial_id=OR02-A...)." }, { "name": "order_line_id", "value": "", "type": "query", "description": "Order line id for filtering. This parameter can be supplied multiple times (order_line_id=OR01-A-1&order_line_id=OR02-A-1...)." } ] }, "docs": "
\n
Call Frequency
\n\n
Recommended usage: At each customer return request
\n
Maximum usage: At each customer return request
\n
Read More
\n\n
PaginationDescription
\n\nLimited to 100 returns at a time\n\n
\n
Read More
\n\n
" }, { "info": { "name": "RT25 - Validate returns as received", "type": "http" }, "http": { "method": "PUT", "url": "https://miraklconnect.com/api/channel-platform/api/returns/receive", "body": { "type": "json", "data": "{}" } }, "docs": "
Description
\n\nLimited to 100 returns at a time\n\n
\n
Read More
\n\n
" }, { "info": { "name": "RT26 - Mark a return as compliant or non compliant", "type": "http" }, "http": { "method": "PUT", "url": "https://miraklconnect.com/api/channel-platform/api/returns/compliance", "body": { "type": "json", "data": "{}" } }, "docs": "
Description
\n\nLimited to 100 returns at a time\n\n
\n
" }, { "info": { "name": "RT27 - Mark a return as closed", "type": "http" }, "http": { "method": "PUT", "url": "https://miraklconnect.com/api/channel-platform/api/returns/close", "body": { "type": "json", "data": "{}" } }, "docs": "
Description
\n\nLimited to 100 returns at a time\n\n
\n
" }, { "info": { "name": "RT29 - Mark a return as canceled", "type": "http" }, "http": { "method": "PUT", "url": "https://miraklconnect.com/api/channel-platform/api/returns/cancel", "body": { "type": "json", "data": "{}" } }, "docs": "
Description
\n\nLimited to 100 returns at a time\n\n
\n
" } ] } ], "bundled": true }