How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Mirakl

Mirakl Returns API

The Returns API from Mirakl — 8 operation(s) for returns.

Documentation Provider Profile APIs.io OpenAPI GitHub

Mirakl Returns API is one of 34 APIs that Mirakl publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Returns. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 14 paths, and defines 95 schemas. It is described by OpenAPI 3.2.0.

Requests are made against 3 base URLs: https://miraklconnect.com/api/channel-platform, https://miraklconnect.com/api, https://your-instance.mirakl.net.

17 operations 14 paths 95 schemas 4 GET3 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://your-instance.mirakl.net
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 7

Mirakl Returns API declares 7 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). It accepts HTTP bearer tokens (JWT) (Front-Bearer-Token). It supports OAuth 2.0 (OAuth-2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (Operator-Bearer-Token). It accepts HTTP bearer tokens (JWT) (operator_bearer_token). An API key is passed in the header as Authorization (Shop-API-Key). An API key is passed in the header as Authorization (shop_api_key).

  • OAuth-2 — For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partnersintegration/authenticatio…

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 4 GET, 3 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Returns 17
POST
/v1/orders/returns
upsertReturns - Upsert returns
upsertReturns body → 200400404
PUT
/v2/orders/returns/{return_id}/accept
v2-acceptReturn - Accept or refuse return
v2-acceptReturn 1 param body → 202400404
PUT
/v2/orders/returns/{return_id}/receive
v2-acknowledgeReturnReception - Mark return as received
v2-acknowledgeReturnReception 1 param → 202400404
PUT
/v2/orders/returns/{return_id}/close
v2-closeReturn - Mark return as closed
v2-closeReturn 1 param → 202400404
GET
/v2/orders/returns
v2-listReturns - List Mirakl Connect returns
v2-listReturns 5 params → 200
PUT
/v2/orders/returns/{return_id}/trackings
v2-updateReturnTrackingInformation - Update return tracking information
v2-updateReturnTrackingInformation 1 param body → 202400404
POST
/api/returns
RT01 - Create returns
RT01 body → 200
GET
/api/returns
RT11 - List returns
RT11 10 params → 200
PUT
/api/returns
RT04 - Patch update returns
RT04 body → 200
GET
/api/returns/items_to_return
RT12 - List items to return
RT12 2 params → 200
PUT
/api/returns/receive
RT25 - Validate returns as received
RT25 body → 200
PUT
/api/returns/cancel
RT29 - Mark a return as canceled
RT29 body → 200
POST
/api/returns/return-labels
RT51 - Create return labels
RT51 body → 200
GET
/api/returns/return-labels
RT52 - List return labels
RT52 6 params → 200
PUT
/api/returns/accept
RT21 - Accept or refuse a return request
RT21 body → 200
PUT
/api/returns/compliance
RT26 - Mark a return as compliant or non compliant
RT26 body → 200
PUT
/api/returns/close
RT27 - Mark a return as closed
RT27 body → 200

Schemas 95

The contract defines 95 schemas that model the data the API accepts and returns. The most detailed are RT01_Response_200_ReturnSuccess (16 properties), RT04_Response_200_ReturnSuccess (16 properties), RT11_Response_200_Data (16 properties), ReturnResponse (15 properties). Each schema is shown below with its type and property counts.

Error
object
4 properties 2 required
UpsertReturnsRequest
object
2 properties 2 required
ReturnErrorDetail
object
3 properties 2 required
OriginRequest
object
2 properties 2 required
ReturnLineRequest
object
3 properties 3 required
ErrorItem
object
3 properties 1 required
ReturnRequest
object
13 properties 6 required
UpsertReturnsResponse
object
2 properties
UpdateReturnTrackingInformationRequest
object
3 properties
AsynchronousActionResponse
object
2 properties 1 required
AcceptReturnRequest
object
2 properties 1 required
Origin
object
6 properties 1 required
ReturnResponse
object
15 properties 8 required
ResourcesPage
object
2 properties
ReturnLineResponse
object
4 properties 3 required
ReturnsPageResponse
RT25_Request_Returns
object
Return ids
1 property 1 required
RT51_Response_200_ReturnLabelErrors
object
2 properties
RT01_Request_Returns
object
Returns list
8 properties 3 required
RT11_Response_200_Data_ReturnLines_Compliance
object
3 properties 1 required
RT29_Request
object
1 property 1 required
RT11_Response_200
object
3 properties 1 required
RT01_Response_200
object
2 properties 2 required
RT51_Request_ReturnLabels_Package_Weight
object
Weight of the package
2 properties 2 required
RT25_Response_200_ReturnErrors
object
2 properties
RT01_Request
object
1 property 1 required
RT51_Response_200_ReturnLabelSuccesses
object
1 property
RT51_Request_ReturnLabels_ShippingFrom
object
Custom pickup address for the return (e.g. store address for in-store returns). If not provided, the initial shipping address of the related order will be used.
8 properties 5 required
RT29_Response_200_ReturnSuccess
object
1 property 1 required
RT29_Request_Returns
object
Return ids
1 property 1 required
RT51_Request_ReturnLabels_Package_Dimensions
object
Physical dimensions of the package
4 properties 4 required
RT25_Response_200_ReturnSuccess
object
1 property 1 required
RT52_Response_200_Data
object
8 properties 4 required
RT51_Response_200
object
2 properties
RT11_Response_200_Data_Tracking
object
5 properties
RT11_Response_200_Data
object
16 properties 9 required
RT52_Response_200_Data_Tracking
object
6 properties
RT52_Response_200_Data_Files_Label
object
2 properties
RT11_Response_200_Data_ReturnAddress
object
6 properties 4 required
RT11_Response_200_Data_Documents
object
2 properties 2 required
RT29_Response_200_ReturnErrors
object
2 properties
RT51_Request_ReturnLabels_Package
object
Details of the package containing the returned items
2 properties 2 required
RT01_Response_200_ReturnSuccess_ReturnLines_Compliance
object
3 properties 1 required
RT52_Response_200_Data_EstimatedCost
object
2 properties
RT12_Response_200_Data
object
8 properties 3 required
RT01_Request_Returns_ReturnLines
object
Return lines
3 properties 3 required
RT29_Response_200
object
2 properties
RT25_Request
object
1 property 1 required
RT01_Response_200_ReturnSuccess_Documents
object
2 properties 2 required
RT52_Response_200_Data_Files
object
2 properties
RT51_Request_ReturnLabels
object
Returns list
7 properties 2 required
RT01_Response_200_ReturnSuccess
object
16 properties 9 required
RT01_Response_200_ReturnSuccess_ReturnLines
object
4 properties 3 required
RT52_Response_200_Data_Errors
object
2 properties
RT51_Request_ReturnLabels_LabelOptions
object
Specific options applying on label generation
1 property
RT01_Response_200_ReturnSuccess_Tracking
object
5 properties
RT52_Response_200
object
3 properties 1 required
RT25_Response_200
object
2 properties
RT11_Response_200_Data_ReturnLines
object
4 properties 3 required
RT52_Response_200_Data_Files_QrCode
object
2 properties
RT12_Response_200
object
3 properties 1 required
RT01_Response_200_ReturnErrors
object
2 properties
RT51_Request
object
1 property 1 required
RT01_Response_200_ReturnSuccess_ReturnAddress
object
6 properties 4 required
RT04_Request_Returns_ReturnAddress_Address
object
The return address details
6 properties 3 required
RT27_Response_200_ReturnSuccess
object
1 property 1 required
RT04_Request_Returns
object
Returns to be updated, maximum number of returns per call: 100
6 properties 1 required
RT21_Response_200_ReturnSuccess
object
1 property 1 required
RT27_Response_200_ReturnErrors
object
2 properties
RT27_Request
object
1 property 1 required
RT26_Response_200_ReturnErrors
object
2 properties
RT26_Request
object
1 property 1 required
RT26_Request_Returns_ReturnLines
object
Return lines
4 properties 2 required
RT04_Response_200_ReturnSuccess
object
16 properties 9 required
RT04_Response_200_ReturnSuccess_Tracking
object
5 properties
RT04_Response_200_ReturnSuccess_ReturnAddress
object
6 properties 4 required
RT04_Response_200_ReturnSuccess_ReturnLines_Compliance
object
3 properties 1 required
RT26_Response_200_ReturnSuccess
object
1 property 1 required
RT04_Request_Returns_ReturnAddress
object
The address where items must be returned
1 property
RT27_Response_200
object
2 properties
RT12_Response_200_Data_2
object
6 properties 3 required
RT26_Request_Returns
object
Mark returns as compliant or non-compliant, maximum number of returns per call: 100
2 properties 2 required
RT04_Response_200_ReturnErrors
object
2 properties
RT21_Response_200
object
2 properties
RT04_Request
object
1 property 1 required
RT04_Request_Returns_Tracking
object
Tracking information
5 properties
RT21_Request
object
1 property 1 required
RT04_Response_200_ReturnSuccess_ReturnLines
object
4 properties 3 required
RT26_Response_200
object
2 properties
RT21_Request_Returns
object
Returns to be accepted, maximum number of returns per call: 100
3 properties 2 required
RT04_Response_200
object
2 properties
RT21_Response_200_ReturnErrors
object
2 properties
RT27_Request_Returns
object
Return ids
1 property 1 required
RT04_Response_200_ReturnSuccess_Documents
object
2 properties 2 required
RT12_Response_200_Data_3
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-returns-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
AE Profile APIs.io
Mirakl Catalog Configuration API
AE Profile APIs.io
Mirakl Incidents API
AE Profile APIs.io
Mirakl Invoicing and Accounting API
AE Profile APIs.io
Mirakl Messages API
AE Profile APIs.io
Mirakl Multiple shipments API
AE Profile APIs.io
Mirakl Offers API
AE Profile APIs.io
Mirakl Orders API
AE Profile APIs.io
Mirakl Picklists API
AE Profile APIs.io
Mirakl Platform Settings API
AE Profile APIs.io
Mirakl Product Feedback API
AE Profile APIs.io
Mirakl Products API
AE Profile APIs.io
#Returns
← Back to M APIs
API Details
ID
mirakl:mirakl-returns-api
Base URL
https://your-instance.mirakl.net
Docs
https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3
Provider
Mirakl
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mirakl-returns-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mirakl-returns-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Mirakl Returns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.