Return Completed

This REST API is used to notify the Partner when the return has been completed in Uniware.

Tip

  • The access token received in response is required in Header (apikey) in all subsequent API requests.
  • It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.

Basic Information

NAME DETAILS
BaseUrl: https://{PartnerBaseUrl}
Endpoint: /completeReturn
Request Type: POST
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): token value(got from Authentication

Request Payload

{
  "orderId": "1100053069",
  "invoiceNumber": "ISR0002",
  "returnId": "2361635",
  "facilityCode": "string",
  "shippingPackageCode": "tes5122",
  "courierName": "DELHIVERYOMNI",
  "status": "COMPLETED",
  "returnReason": "Different from the Photograph",
  "type": "CUSTOMER_RETURN",
  "createdOn": "Feb 13, 2023 4:01:45 PM",
  "trackingNumber": "17266310218105",
  "orderItems": [
    {
      "inventoryType": "GOOD_INVENTORY",
      "orderItemId": "FN1100053069_9351746447330_0",
      "bundleIdentifier": null,
      "skuCode": "9351746447330",
      "customFieldValues": [
        
      ]
    }
  ],
  "customFieldValues": [
    
  ]
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 orderId string Sale order code Yes -
2 invoiceNumber string Sale order code Yes -
3 returnId string Return id Yes -
3 facilityCode string Uniwre warehouse code Yes -
4 shippingPackageCode string Shipment code Yes -
5 courierName string Courier name Yes -
6 status string Return status Yes “COMPLETED”
7 returnReason string Return reason Yes -
8 type string Return type Yes “CUSTOMER_RETURN” for CIR or “COURIER_RETURN” for RTO
9 createdOn Date date-time Eg: Feb 13, 2023 4:01:45 PM Yes -
10 trackingNumber string trackingNumber(AWB) Yes -
11 orderItems object orderItems details Yes -
11.1 inventoryType string Inventory Type Yes GOOD_INVENTORY or BAD_INVENTORY
11.2 orderItemId string OrderItems Ids Yes -
11.3 bundleIdentifier string Bundle Identifier Yes -
11.4 skuCode string SKU Yes -
11.5 customFields object Custom fields details Opt -
12 customFields object Custom fields details Opt -

Response Payload

{
    "status": "Success",
    "message": "Detail is updated successfully"    
}

Response Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 status string Success after notification is acknowledged Yes Success/Failed
2 message string Readable response message Yes -

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What would be that frequency of Notification push to partner?
Ans. Real-time or nearly real-time.

Unicommerce Website

Copyright © 2024 Unicommerce eSolutions Pvt. Ltd.