| Name | Description | Type | Additional information |
|---|---|---|---|
| RMAId |
Unique identifier from the WMS system that is assigned at RMA creation, and it can be used as the id parameter. |
integer |
None. |
| RMANumber |
RMA identifier from your system. |
string |
Required |
| WarehouseCode |
Use "SLC" to send the order to the Salt Lake City warehouse. |
string |
Required |
| 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 |
Required |
| CompanyOrName |
Required if no orders are linked to the RMA. If at least one order is linked, then the CompanyOrName field of the first linked order will be used. |
string |
String length: inclusive between 2 and 35 |
| Attention |
Optional. However, if at least one order is linked, then the Attention field of the first linked order will be used. |
string |
String length: inclusive between 2 and 35 |
| AddressLine1 |
Required if no orders are linked to the RMA. If at least one order is linked, then the address fields of the first linked order will be used. |
string |
String length: inclusive between 2 and 35 |
| AddressLine2 |
Optional. However, if at least one order is linked, then the address fields of the first linked order will be used. |
string |
String length: inclusive between 2 and 35 |
| AddressLine3 |
Optional. However, if at least one order is linked, then the address fields of the first linked order will be used. |
string |
String length: inclusive between 2 and 35 |
| City |
Required if no orders are linked to the RMA. If at least one order is linked, then the address fields of the first linked order will be used. |
string |
String length: inclusive between 2 and 35 |
| State |
Can accept the 2 digit state code or the state's full name. Required if no orders are linked to the RMA. If at least one order is linked, then the address fields of the first linked order will be used. |
string |
String length: inclusive between 2 and 35 |
| PostalCode |
Required if no orders are linked to the RMA. If at least one order is linked, then the address fields of the first linked order will be used. |
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. Required if no orders are linked to the RMA. If at least one order is linked, then the address fields of the first linked order will be used. |
string |
String length: inclusive between 2 and 35 |
| Phone |
Optional. However, if at least one order is linked, then the address fields of the first linked order will be used. |
string |
String length: inclusive between 0 and 35 |
|
Optional. However, if at least one order is linked, then the address fields of the first linked order will be used. |
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 |
| RMADetailData |
Includes the returning product line items for the RMA. |
Collection of RMADetailData |
None. |
| RMALinkedOrderData |
Optional. If any orders are linked, then the address of the first linked order will be used for the RMA if the regular RMA address details are not supplied. |
Collection of RMALinkedOrderData |
None. |
| MetaData |
Includes any additional meta data for the RMA. |
Collection of RMAMetaData |
None. |