Mirakl Returns API
The Returns API from Mirakl — 8 operation(s) for returns.
Operations 17
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I push returns from my sales channel into Mirakl Connect?”
“Does sending a return that already exists update it or create a duplicate?”
Tell an agent
Upsert returns {returns} from origin {origin}.
Synchronize these channel returns {returns} with Connect.
PUT
/v2/orders/returns/{return_id}/accept
Accept or refuse a Connect return · v2-acceptReturn - Accept or refuse return
#
Ask an LLM
“Can I approve a return request that's still waiting in REQUEST_INITIATED from Connect?”
“What do I send to reject a customer's return with a reason in Mirakl Connect?”
Tell an agent
Set accepted to {accepted} for Connect return {return_id}.
Refuse Connect return {return_id} because {rejection_reason}.
PUT
/v2/orders/returns/{return_id}/receive
Mark a Connect return as received · v2-acknowledgeReturnReception - Mark return as received
#
Ask an LLM
“How do I confirm I physically got the item back for a Connect return?”
“Does marking a Connect return received also update the sales channel?”
Tell an agent
Mark Connect return {return_id} as received.
Confirm the returned item for Connect return {return_id} arrived at the warehouse.
PUT
/v2/orders/returns/{return_id}/close
Close a Connect return · v2-closeReturn - Mark return as closed
#
Ask an LLM
“When the refund and checks are done, how do I close a return in Connect?”
“Can I finalize a single Connect return once all steps are complete?”
Tell an agent destructive · confirm first
Close Connect return {return_id}.
Mark Connect return {return_id} as closed now that the refund is done.
Ask an LLM
“Which Connect returns changed since my last sync?”
“Can I list Connect returns for specific orders or statuses?”
Tell an agent
List Connect returns updated since {updated_from}.
Show Connect returns for orders {order_ids} updated since {updated_from}.
PUT
/v2/orders/returns/{return_id}/trackings
Update a Connect return's tracking · v2-updateReturnTrackingInformation - Update return tracking information
#
Ask an LLM
“How do I add a return shipping tracking number to a Connect return?”
“Can I attach a return label URL or RMA to a Connect return?”
Tell an agent
Set tracking {tracking} on Connect return {return_id}.
Add label {label_url} and RMA {rma_id} to Connect return {return_id}.
Ask an LLM
“How do I open new returns for order lines on the marketplace?”
“What's the maximum number of returns I can create in one request?”
Tell an agent
Create these returns {returns}.
Open a batch of new return requests {returns}.
Ask an LLM
“Which returns are open on the marketplace right now?”
“Can I find returns by order, RMA number or customer?”
Tell an agent
List marketplace returns in state {return_state}.
Find the returns for order {order_commercial_id}.
Ask an LLM
“How do I change details on returns that already exist on the marketplace?”
“Can I edit several returns in one partial update?”
Tell an agent
Patch these returns {returns}.
Update returns {returns} for shop {shop_id}.
Ask an LLM
“Which items on an order can still be returned?”
“Is a specific order line eligible to be returned?”
Tell an agent
List the returnable items of order {order_commercial_id}.
Check whether order line {order_line_id} can be returned.
Ask an LLM
“How do I confirm reception for many marketplace returns at once?”
“How many returns can I mark as received in one call?”
Tell an agent
Mark returns {returns} as received.
Validate reception of this batch of returns {returns}.
Ask an LLM
“How do I cancel a return that should no longer go ahead?”
“Can I cancel up to 100 returns in one request?”
Tell an agent destructive · confirm first
Cancel returns {returns}.
Mark this batch of returns {returns} as canceled.
Ask an LLM
“How do I generate prepaid return labels for returns?”
“Can I request return labels for several returns at once?”
Tell an agent
Create return labels {return_labels}.
Generate shipping labels for these returns {return_labels}.
Ask an LLM
“What's the state of the return labels I requested?”
“Can I find return labels created within a date range?”
Tell an agent
List return labels for return {return_id}.
Show return labels in state {label_state}.
PUT
/api/returns/accept
Accept or refuse marketplace return requests · RT21 - Accept or refuse a return request
#
Ask an LLM
“As a seller, how do I approve or decline several return requests in bulk?”
“Is there a limit on how many return requests I can accept in one call?”
Tell an agent
Accept or refuse return requests {returns}.
Decide on return requests {returns} for shop {shop_id}.
PUT
/api/returns/compliance
Mark returns compliant or non-compliant · RT26 - Mark a return as compliant or non compliant
#
Ask an LLM
“How do I record that a returned item failed inspection?”
“Can I flag returned items as compliant after checking them?”
Tell an agent
Set compliance on returns {returns}.
Mark returns {returns} as compliant or non compliant for shop {shop_id}.
Ask an LLM
“How do I close a batch of finished returns on the marketplace?”
“Can I close up to 100 returns at once as a seller?”
Tell an agent destructive · confirm first
Close returns {returns}.
Mark returns {returns} as closed for shop {shop_id}.