API Reference
Log In
API Reference

Create a new return request

post
https://partners.returnbear.com/api/v1/return_requests
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Return request parameters

customer
object
required
external_references
array of objects
required

The external references associated with the return request or return request item.

Supported items:

  • ORDER_NUMBER (required): The order number the return request is associated with.
  • RMA_NUMBER (required): Unique external number from the store's RMA system.
ReturnRequestExternalReferences*
return_items
array of objects
required
length ≥ 1
return_items*
string | null

The comment for the return

external_references
array of objects
required

The external references associated with the return request item.

Supported items:

  • ORDER_LINE_ITEM_ID (required): ID of the order line item for return request item.
  • EXTERNAL_ID (optional): Optional client identifier for tracking return request items.
ReturnRequestItemExternalReferences*
string | null

The reason for the return

integer
required

The ID of the store this return request is associated with. This is a unique identified that is generated by ReturnBear. You will need to have the ReturnBear store ids of all merchants you want to create return requests for to use this endpoint. Reach out to ReturnBear for more information.

Responses

Callback

Updated 6 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago