Return Webhooks

Return webhook urls can be configured in our portal under the Business > Webhooks > Returns section.
Webhooks are triggered whenever Return Request Status changes.

Property	Type	Provided	Description
rmaId	String	true	The unique identifier for the Return Request created in our system
status	String	true	The status of the Return Request
returnReason	Return Reasons	true	The information related to the return reason chosen for the Return Request
returnMethod	Return Methods	true	The information related to the return method chosen for the Return Request
refundMode	Refund Methods	true	The information related to the refund mode chosen for the Return Request
itemList	Item - Order	true	The array of items to be returned
orderBeingReturned	String	true	The orderExternalId at the business level
createdAt	Date	true	The date on which the Return was created
tenantId	String	true	The unique identifier for the business
brandExternalId	String	true	The unique identifier for the brand
storeExternalId	String	true	The unique identifier for the store, from where the original order was placed
deliveryAddress	Address	true	The address at which the return order is being delivered to
customer	Contact (Order)	true	The details of the customer
returnOrder	Return Order	false	The information related to the Return Order
fee	decimal	false	The information related to the fee charged from the customer for the return

{
  "_id": "662fa26dec0244f8b699d11f",
  "rmaId": "1714397805407",
  "status": "COMPLETED",
  "returnReason": {
    "code": "uniqlo003",
    "name": "Item damanged",
    "additionalComments": "The item is completely broken"
  },
  "returnMethod": {
    "code": "HP001",
    "name": "Home Pickup - Print Label",
    "type": "home-pickup",
    "displayName": "UPS-Home Pickup - Print Label",
    "_id": "662fa26dec0244f8b699d120"
  },
  "refundMode": {
    "code": "uniqlo003",
    "name": "Cash"
  },
  "tenantId": "uniqlo",
  "brandExternalId": "uniqlo",
  "customerAddress": {
    "street": "11111 Research Boulevard",
    "city": "Austin",
    "zipcode": "78759",
    "state": "TX",
    "country": "US",
    "latitude": 30.4054131,
    "longitude": -97.7438087
  },
  "itemList": [
    {
      "sku": "sku2000",
      "quantity": 1,
      "size": {
        "length": 10,
        "width": 10,
        "height": 10,
        "_id": "660e6e58e19bfcc8a391ab67"
      },
      "weight": 10,
      "price": 10,
      "title": "Pens",
      "description": "Cross Pen",
       "image": "https://qa.files.deliverysolutions.co/zebra/items/%5Bdeliverysolutions123456%5D/zebra/sku89_1665035377206.png",
      "category":"Stationary",
      "tags":["Pens", "Ballpen","Cross"],
      "returnReason": {
        "code": "uniqlo003",
        "name": "Item damanged",
        "additionalComments": "The item is completely broken"
      },
      "refundMode": {
        "code": "uniqlo003",
        "name": "Cash"
      }
    },
    {
      "sku": "sku4000",
      "quantity": 1,
      "size": {
        "length": 10,
        "width": 10,
        "height": 10,
        "_id": "660e6e58e19bfcc8a391ab69"
      },
      "weight": 10,
      "price": 10,
      "title": "Watches",
      "description": "Rolex Watch",
       "image": "https://qa.files.deliverysolutions.co/zebra/items/%5Bdeliverysolutions123456%5D/zebra/sku89_1665035377206.png",
      "category":"Accessories",
       "tags":["Watches", "Smart Watch","Rolex"],
      "returnReason": {
        "code": "uniqlo003",
        "name": "Item damanged",
        "additionalComments": "The item is completely broken"
      },
      "refundMode": {
        "code": "uniqlo003",
        "name": "Cash"
      },
    }
  ],
  "customer": {
    "phone": "+14343424224",
    "name": "John Doe"
  },
  "orderIdBeingReturned": "660e6de71670b67c2f502feb",
  "createdAt": "2024-04-29T13:36:45.000Z",
  "lastUpdatedAt": "2024-04-30T02:46:00.131Z",
  "fee": 1200,
  "locationExternalId": "UPS_Return_Store",
  "returnOrder": {
    "order": "662fa26e2f33f4fd659c00f3",
    "trackingNumber": "30apr0815",
    "trackingUrl": "https://d.dl-s.co/qw4DSEROZpE",
    "providerInfo": {
      "name": "UPS",
      "dspId": "",
      "displayName": ""
    },
    "labelLink": "https://development.api.deliverysolutions.co/api/v3/label?tenantId=uniqlo&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvcmRlcklkIjoiNjYyZmEyNmUyZjMzZjRmZDY1OWMwMGYzIiwiaWF0IjoxNzE0Mzk3ODA2fQ.bKxF2Sw1fWa3uz8-U5sTVovdLDYChZErIUH_rbieI3g",
    "orderExternalId": "return_order_rishabh_4-1714397805407",
    "createdAt": "2024-04-29T13:36:46.075Z",
    "requestedTime": 1714484205000
  },
  "subStatus": null,
  "notifyStatus": {
    "tenantId": "uniqlo",
    "brandExternalId": "uniqlo",
    "returnRequestId": "662fa26dec0244f8b699d11f",
    "updatedAt": "2024-04-30T02:46:00.000Z",
    "status": "COMPLETED",
    "subStatus": null
  },
  "sentAt": "2024-04-30T02:46:00.322Z"
}