API Reference
Log In
API Reference

Create a new return

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

Return case parameters

customer
object
required
external_references
array of objects
required

The external references associated with the return case. Following items are supported: - RMA_NUMBER (required): RMA will always be provided and is an external unique number associated to the store's RMA system. - Order ID (required): The ID of the order this return case is associated with. - Order Number (required): The number of the order this return case is associated with. - SHOPIFY_RETURN_GID (optional): The Shopify return GID of the return case. This should be the same format as Shopify's GID format.

ExternalReferences*
return_items
array of objects
required
length ≥ 1
return_items*
string

The comment for the return

string
required

The date and time the return case item was fulfilled

string

The name of the return case item

order_line_details
object
required
string

The reason for the return

string
enum
required

The type of return for the return case item.

Allowed:
string

The ID of the return case item. UUID generated by ReturnBear.

integer
required

The ID of the store this return case 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 cases for to use this endpoint. Reach out to ReturnBear for more information.

Responses

Callback

Updated 7 months ago

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

Updated 7 months ago