Get a Return

Get Return

GET http://wms.eshopbox.com/api/return-shipment/{customerReturnNumber}

This endpoint allows you to get a return.

Path Parameters

Name	Type	Description
customerReturnNumber	string	Return Number of an order

Headers

Name	Type	Description
Authentication	string	Bearer Token to grant access to this API

200 Return successfully retrieved.

{
    "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
    "customerReturnNumber": "R4191129_1",
    "customerOrderNumber": "300975272",
    "order_id": 1564960,
    "pickupType": "reverse",
    "status": "CREATED",
    "refundAmount": 0,
    "cp_id": 24,
    "channel_id": 5,
    "trackingID": "573307721",
    "courierName": "EcomExpress Reverse",
    "customerName": "Sam",
    "customerContactNumber": "9999999999",
    "email": "[e-mail]",
    "remarks": "Soft data uploaded",
    "isCOD": "1",
    "channelSlug": "KAPAS KRAFT",
    "accountSlug": "KAPAS KRAFT",
    "pickupAddress": {
        "pickup_customerName": "Sam",
        "pickup_addressLine1": "Green Soul, reliable space",
        "pickup_addressLine2": "thane",
        "pickup_city": "Thane",
        "pickup_state": "Maharashtra",
        "pickup_postalCode": "421501",
        "pickup_countryCode": "IN",
        "pickup_countryName": "India",
        "pickup_contactPhone": "999999999",
        "pickup_email": "[e-mail]"
    },
    "dropAddress": {
        "drop_name": "Eshopbox Gurgaon (Sohna)",
        "drop_address": "MJ Logistics Private Limited, Seabird Marine Services Pvt Ltd,Village Babra Bakirpur, Pataudi Road Near Adani Logistic Park,  ICD Patli, Gurgaon, Haryana(122503)",
        "drop_pincode": "122503",
        "drop_city": "Gurgaon",
        "drop_country": "India",
        "drop_state": "Haryana"
    },
    "latest_status": "order_placed",
    "status_updated_at": "2020-07-09 17:54:20",
    "status_log": {
        "order_placed": "2020-07-09 17:54:20",
        "created": "2020-07-09 17:10:14"
    },
    "items": [
        {
            "lineItemSequenceNumber": 116833,
            "orderItemID": "300975273736427",
            "itemID": "5050410512025",
            "productName": "Ellison Bay",
            "quantity": 1,
            "lineItemTotal": 5499,
            "discount": 0,
            "returnReason": "Not satisfied with size or fit",
            "item_image": "CA001CL95LVWCLRKS-90678.jpg",
            "additionalInfo": {
                "image": null,
                "comments": null
            },
            "returnType": "refund",
            "productImageUrl": null,
            "productAdditionalInfo": null,
            "shippingCharges": 0,
            "productUrl": null,
            "isExchange": "0",
            "originalOrderItemId": null
        },
        {
            "lineItemSequenceNumber": 116834,
            "orderItemID": "300975273736428",
            "itemID": "5050407050417",
            "productName": "Sift 92",
            "quantity": 1,
            "lineItemTotal": 4199,
            "discount": 0,
            "returnReason": "Not satisfied with size or fit",
            "item_image": "CA001CL95LVWCLRKS-90678.jpg",
            "additionalInfo": {
                "image": null,
                "comments": null
            },
            "returnType": "refund",
            "productImageUrl": null,
            "productAdditionalInfo": null,
            "shippingCharges": 0,
            "productUrl": null,
            "isExchange": "0",
            "originalOrderItemId": null
        },
        {
            "lineItemSequenceNumber": 116835,
            "orderItemID": "300975272-3736429",
            "itemID": "5050407011906",
            "productName": "Sift 92",
            "quantity": 1,
            "lineItemTotal": 4199,
            "discount": 0,
            "returnReason": "Not satisfied with size or fit",
            "item_image": "CA001CL95LVWCLRKS-90678.jpg",
            "additionalInfo": {
                "image": null,
                "comments": null
            },
            "returnType": "refund",
            "productImageUrl": null,
            "productAdditionalInfo": null,
            "shippingCharges": 0,
            "productUrl": null,
            "isExchange": "0",
            "originalOrderItemId": null
        }
    ]
}

curl -X GET http://wms.eshopbox.com/api/return-shipment/{customerReturnNumber}\
-H "Authorization: Bearer XXXX" \
    -H "Content-Type: application/json" \
    -d $'{}