Name

/rma

Method

GET

Request

Name Mandatory Type Description
api_token yes string API key provided by SWAP.
store yes string The store id that the RMAs belong to.
last_rma no string The last_rma returned (used for pagination). An empty value means the first page will be returned.
return_type no string The endpoint will return RMAs which contain this type of return. Can be one of the following:

Response

Name Type Description
last_rma number The RMA of the last RMA returned. This will be the value for the request parameter last_rma to get the next “page”.
remaining_rmas number The number of RMAs left. A value greater than 0 indicates there are more “pages”.
version number 1
products list of products List of products that match the filters in the request.

products

Name Type Description
rma number The RMA number
creation_date date The date the product was created
order_number string The order number the product is assigned to
customer_name string The name of the customer who created the return
sku_id string The SKU of the product
sku_description string The description of the product
sku_ean string The barcode of the product
duty_amount number The duty amount
quantity number Number of items
shopify_order_id string The Shopify order id
image string The url to an image of the product
return_type string Return type of the product
carrier string The carrier shipping this product
tracking_number string The tracking number provided by the carrier
destination_countrycode string Two letter country code (e.g., GB, NL, US), referring to the destination where the return was sent to
destination_postcode string Post / Zip code, referring to the post/ zip code of the destination where the return was sent to
amount number The price of this product
totalTax number Total tax
main_reason_text string The main reason why the product was returned.
sub_reason_text string The sub reason why the product was returned.