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 |