NameDescriptionTypeAdditional information
RMAId

Unique identifier from the WMS system that is assigned at RMA creation, and it can be used as the id parameter.

integer

Required

RMANumber

RMA identifier from your system.

string

None.

WarehouseCode

Use "SLC" to send the order to the Salt Lake City warehouse.

string

None.

ReturnReason

The reason the product(s) are being returned. Please see your WMS admin for a list of allowable return reasons beyond the defaults: No indication, Refused

string

None.

RequestedDate

The date the RMA was requested by the customer.

date

None.

CompanyOrName

string

String length: inclusive between 2 and 35

Attention

string

String length: inclusive between 2 and 35

AddressLine1

string

String length: inclusive between 2 and 35

AddressLine2

string

String length: inclusive between 2 and 35

AddressLine3

string

String length: inclusive between 2 and 35

City

string

String length: inclusive between 2 and 35

State

string

String length: inclusive between 2 and 35

PostalCode

string

String length: inclusive between 2 and 35

Country

Can accept the 2 digit ISO code, the 3 digit ISO code, or the country's full name.

string

String length: inclusive between 2 and 35

Phone

string

String length: inclusive between 0 and 35

Email

string

String length: inclusive between 0 and 100

Notes

Text submitted here will appear on the RMA reports.

string

String length: inclusive between 0 and 500

RMADetailEditData

Includes the returning product line items for the RMA. Submitting new RMADetailData will replace all of the current RMADetailData, including the MetaData.

Collection of RMADetailEditData

None.

RMALinkedOrderData

Includes any orders linked to this RMA (i.e.: Original Order, Shipping Label Order, and Replenishment Order). Submitting new RMALinkedOrderData will replace all of the current RMALinkedOrderData.

Collection of RMALinkedOrderData

None.

MetaData

Includes any additional meta data for the RMA. If the submitted MetaData exists, then it will be modified; otherwise, it will be added.

Collection of RMAMetaData

None.