NameDescriptionTypeAdditional information
rma_number

Only letters, digits or '-' sign are allowed. It could be auto-generated, depends on the account settings.

string

Max length: 25

rma_date

RMA date. Date in ISO-8601 format. Only date part (no time).

date

None.

original_order_number

Only letters, digits or '-' sign are allowed.

string

Max length: 25

shipping_carrier

Shipping carrier name (example: 'UPS').

string

Max length: 30

shipping_service

Shipping service name (example: 'GROUND').

string

Max length: 30

customer_number

You can store your customer id for reference. Also, highly recommended for B2B account.

string

Max length: 25

comments

It will appear on the packing list.

string

Max length: 255

shipping_instructions

RMA comments.

string

Max length: 255

shipping_address

Shipping address.

address

Required

order_amount

decimal number

None.

shipping_handling

decimal number

None.

sales_tax

decimal number

None.

restocking_fee

decimal number

None.

total_amount

decimal number

None.

rma_type

Type of ReturnTrak RMA to submit.

rma_type

Required

disposition

RMA disposition.

disposition

Required

custom_option1

Must match with the input data defined in ReturnTrak. Required only if is required in ReturnTrak.

string

None.

custom_option2

Must match with the input data defined in ReturnTrak. Required only if is required in ReturnTrak.

string

None.

custom_option3

Must match with the input data defined in ReturnTrak. Required only if is required in ReturnTrak.

string

None.

custom_option4

Must match with the input data defined in ReturnTrak. Required only if is required in ReturnTrak.

string

None.

custom_option5

Must match with the input data defined in ReturnTrak. Required only if is required in ReturnTrak.

string

None.

custom_option6

Must match with the input data defined in ReturnTrak. Required only if is required in ReturnTrak.

string

None.

custom_option7

Must match with the input data defined in ReturnTrak. Required only if is required in ReturnTrak.

string

None.

generate_return_service_label

Generate a return service label.

boolean

Default value is false

return_weight_lb

Weight, in pounds, of the returned items (required if a return service label is needed).

decimal number

None.

rma_location

RMA location.

string

Required

rma_account_number

RMA account number.

string

Required

shipping_location

Shipping location.

string

None.

shipping_account_number

Shipping account number.

string

None.

auth_lines

Collection of auth_line

Required

ship_lines

Collection of ship_line

None.