/rma_search (version 1) | Swap Knowledge Base

Name

/rma_search

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.
rma	yes	number	RMA number
version	no	number	1

Response

Name	Type	Description
products	list of products	List of products that match the RMA in the request.
version	number	1

Products

Parameter	Type	Description
product_id	string	SWAP's internal product id
shopify_product_id	string	Shopify's Product ID
shopify_variant_id	string	Shopify's Variant ID
order_number	string	The return's order number
original_order_name	string	Return order’s original order name
rma	number	RMA number
date	date	Date the product was created
product_name	string	Name of the product
variant_name	string	Name of the variant
sku	string	SKU
main_reason_id	string	Id of the main reason for the return
main_reason_text	string	Text of the main reason for the return
sub_reason_id	string	Id of the sub reason for the return
sub_reason_text	string	Text of the sub reason for the return
comments	string	Customer's comments
item_count	number	Number of items
cost	number	Total cost
return_type	string	Return type. Can be one of the following: - Refund - Shop Now Credit - Shop Later Credit - Additional Payment - Recycle - Warranty
currency	string	Currency used by the customer
vendor	string	Name of the vendor
collection	list of string	List of names of the collections this product is part of
return_status	string	The status of the orders these products are assigned to. Possible values are: - Open - Needs Review - Closed - Expired - On Hold - Cancelled
product_alt_type	string	Used to designate a different use case/type for a product outside of a normal return RMA (Recycle, refurbishment, etc.)
recycle_material	string	Used with the recycle feature. Collects the material type for the product being returned for recycling
grams	number	Product's weight, in grams
intake_reason	string	Dropdown options for each item on the returns dashboard. Used to keep a record of the condition of the item returned. Current values: - Sellable - Damaged - Missing - Wrong Item
tags	string	Product tags

Response sample

{
   "products": [
{
   "product_id": "1708021108629x291289696099893250",
   "shopify_product_id": "8071912554670",
   "shopify_variant_id": "44207363981486",
   "order_number": "2557748",
   "original_order_name": "2557748",
	 "rma": 6885,
   "date": "2024-02-15T18:18:29.382Z",
   "product_name": "Mimi Glass Heart Necklace by Gemini Jewels",
   "variant_name": "OS",
   "sku": "MIMI GLASS HEART NECKLACE RED OS",
   "main_reason_id": "1689628639247x942523305687193000",
   "main_reason_text": "Do not like style",
   "sub_reason_id": "",
   "sub_reason_text": "",
   "comments": "",
   "item_count": 1,
   "cost": 19.20,
   "return_type": "Refund",
   "currency": "GBP",
   "vendor": "Z026600",
   "collection": [
   
],
   "return_status":"Closed"
	 "product_alt_type": "",
   "recycle_material": "",
   "grams": 11,
   "intake_reason": ""
},{
   "product_id": "1708021135998x676562343615791100",
   "shopify_product_id": "8080048652462",
   "shopify_variant_id": "44225308098734",
   "order_number": "2557748",
   "original_order_name": "2557748",
	 "rma": 6885,
   "date": "2024-02-15T18:18:56.531Z",
   "product_name": "Lucca Ripple Top Jacquard White",
   "variant_name": "XS",
   "sku": "LUCCA TOP RIPPLE JACQUARD WHITE XS",
   "main_reason_id": "1689628639070x268187782145970180",
   "main_reason_text": "Changed my mind",
   "sub_reason_id": "",
   "sub_reason_text": "",
   "comments": "",
   "item_count": 1,
   "cost": 28.80,
   "return_type": "Refund",
   "currency": "GBP",
   "vendor": "Z026644",
   "collection": [
   
],
	 "return_status":"Closed"
   "product_alt_type": "",
   "recycle_material": "",
   "grams": 250,
   "intake_reason": ""
}   
   ],
"version": 1
}