Return Courier Allocated

This REST API is used to notify the Partner when the Courier Allocated to the CIR return 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: /allocateReturnCourier
Request Type: POST
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): token value(got from Authentication

Request Payload

{
  "saleOrderCode": "1100053069",
  "reversePickupCode": "2361635",
  "courierName": "DELHIVERYOMNI",
  "status": "COURIER_ALLOCATED",
  "facilityCode": "string",
  "AWB": "17266310218105",
  "orderItems": [
    {
      "orderItemId": "FN1100053069_9351746447330_0",
      "bundleIdentifier": null,
      "skuCode": "9351746447330"
    }
  ],
  "customFieldValues": [
    
  ]
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 saleOrderCode string Sale order code Yes -
2 reversePickupCode string Reverse pickup code Yes -
3 courierName string Courier name Yes -
4 status string Return status Yes “COURIER_ALLOCATED” for CIR
5 facilityCode string Uniwre warehouse code Yes -
6 AWB string trackingNumber(AWB) Yes -
7 orderItems object Order Items details Yes -
7.1 orderItemId string OrderItems Ids Yes -
7.2 bundleIdentifier string Bundle Identifier Opt -
7.3 skuCode string SKU code Yes -
8 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.