API Reference

Create an RMA

post
https://openapi.staging.tryware2go.com/v1/merchants//rmas

Create an RMA.

Path Params
string
required

The merchant ID assigned by Ware2Go.

Body Params
string
required

A unique identifer for the RMA.

string
required

The referenceId of the existing outbound order that you would like to associate with the RMA.

string | null
enum
Defaults to ECONOMY

The shipping speed to use when sending the return.

Allowed:
date

This field should be ignored. It will be removed in an upcoming release.

date

The date that the return will be received by the warehouse.

number
required
0 to 30

The number of packages being returned.

boolean
Defaults to false

Should only be false if you want to use your own method of shipping the return, other than your Ware2Go UPS account.

string
enum
required

A string describing why the items are being returned.

Allowed:
string

A note to associate with the RMA.

destinationFacility
object
required

The Warehouse the Return will be sent to.

lines
array of objects
required
length ≥ 1

The SKU ID(s) and quantity that the RMA will contain.

lines*
string
required

The unique identifier for the item.

number
required

The number of units of the item begin returned.

rmaTags
array of strings

An array of tags to associate with the RMA.

rmaTags
routing
object

Routing use to determinate shipping for Unbundled merchants, may be null

Responses

Updated 7 months ago

Language
Credentials
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago