/csl_ordername | Swap Knowledge Base

Name

/csl_ordername

Method

GET

Request

Name	Type	Mandatory	Description
api_token	string	yes	API key provided by SWAP.
store	string	yes	SWAP’s internal store ID
order_number	string	yes	Shopify order number

Response

Name	Type	Description
email	string	Customer's email
return_id	string	SWAP's internal return ID
order_name	string	Shopify's order name
rma	number	Swap's RMA number
type	List of strings	An array listing the types of returns. Can be one of the following: - Refund - Shop Now Credit - Shop Later Credit - Additional Payment - Recycle - Warranty
carrier	string	The carrier in charge of the shipment
royalmail_label	string	Royal Mail Label's URL
tracking_number	string	Tracking Number
shipping_status	string	The shipping status
tracking_link	string	Carrier's Tracking Website URL
rma_status	string	The status of the return. Possible values are: - Open - Needs Review - Closed - Expired - On Hold - Cancelled
created_at	string	Date the return was created
customer_currency	string	Currency used by the customer
gift_return	boolean	Gift return?
shipping_deduction	string	Description of the shipping deduction for the order
return_value	string	Return value
exchange_value	string	Exchange value
exchange_credit	string	Exchange Credit
return_credit	string	Return Credit
total_refund	string	Total refund
returned_items	List of strings	List of returned items
exchange_items	List of strings	List of exchange items
returned_qty	number	Quantity of returned items
exchange_qty	number	Quantity of exchange items
shipping_name	string	Customer's name
shipping_address1	string	Customer's address line 1
shipping_address2	string	Customer's address line 2
shipping_city	string	Customer's city
shipping_province	string	Customer's state/province
shipping_postcode	string	Customer's postcode
shipping_country	string	Customer's country code

Response sample

{
    "response": [
        {
            "email": "[email protected]",
            "return_id": "1710459833772x264494554942013440",
            "order_name": "17618",
            "rma": 7261,
            "type": [
                "Exchange", "Additional Payment"
            ],
            "carrier": "Royal Mail QR",
            "royalmail_label": "<https://f84b6cef02afc70067889de47ac8b2b8.cdn.bubble.io/d185/f1710459983883x417656457165263000/Label_JJD149990200010423878.pdf>",
            "tracking_number": "XF822102564GB",
            "shipping_status": "Pre-Transit",
            "tracking_link": "<https://www.royalmail.com/track-your-item#/tracking-results/XF822102564GB>",
            "rma_status": "Needs Review",
            "created_at": "March 14, 2024",
            "customer_currency": "GBP",
            "gift_return": false,
            "shipping_deduction": "",
            "return_value": "£300.00",
            "exchange_value": "£300.00",
            "exchange_credit": "£300.00",
            "return_credit": "£0.00",
            "total_refund": "£0.00",
            "returned_items": [
                "Silk Tuxedo", "Men's Modena Shirt"
            ],
            "exchange_items": [
                "Silk Tuxedo", "Men's Modena Shirt"
            ],
            "returned_qty": 4,
            "exchange_qty": 4,
            "shipping_name": "a bc",
            "shipping_address1": "null",
            "shipping_address2": "aa",
            "shipping_city": "London",
            "shipping_province": "ENG",
            "shipping_postcode": "EC2A 4NE",
            "shipping_country": "GB"
        },
        {
            "email": "[email protected]",
            "return_id": "1710518798879x623610907142389800",
            "order_name": "17653",
            "rma": 7279,
            "type": [
                "Exchange"
            ],
            "carrier": "Royal Mail",
            "royalmail_label": "<https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240315/e84e4612a33c3c46929c3a228d0ad28b04.png>",
            "tracking_number": "HZ851053313GB",
            "shipping_status": "Pre-Transit",
            "tracking_link": "<https://www.royalmail.com/track-your-item#/tracking-results/HZ851053313GB>",
            "rma_status": "Needs Review",
            "created_at": "March 15, 2024",
            "customer_currency": "GBP",
            "gift_return": false,
            "shipping_deduction": "",
            "return_value": "£150.00",
            "exchange_value": "£150.00",
            "exchange_credit": "£150.00",
            "return_credit": "£0.00",
            "total_refund": "£0.00",
            "returned_items": [
                "Silk Tuxedo", "Men's Modena Shirt"
            ],
            "exchange_items": [
                "Silk Tuxedo", "Men's Modena Shirt"
            ],
            "returned_qty": 2,
            "exchange_qty": 2,
            "shipping_name": "a bc",
            "shipping_address1": "null",
            "shipping_address2": "aa",
            "shipping_city": "London",
            "shipping_province": "ENG",
            "shipping_postcode": "EC2A 4NE",
            "shipping_country": "GB"
        }
    ]
}