Post Delivered to UC

This REST API is used to notify the Uniware when the order has been delivered to the Customer via MarketPlace.

Tip

  • This is an optional API used only when the marketplaces wish to post delivered update in Uniware.
  • This API request is initiated by the marketplace to post information(delivered) in Uniware. For such APIs a unique static securitykey is provided by the Unicommerce to the marketplaces for authentication. This securitykey should be passed in header as mentioned below.
  • 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.

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NAME DETAILS
Usage: Optional
URL: https://genericproxy.unicommerce.com/
Endpoint: /uc/v1/awbStatusTracking
Request Type: POST
Scheme: HTTPS
Header (Content-Type): application/json
Header (clientid): ID (provided by Unicommerce)
Header (merchantid): username
Header (securitykey): key (provided by Unicommerce), Eg.: F212b212-232323-232323

Request Payload

{

"trackingNumber": "String",
"providerCode": "Shipper_Name",
"trackingStatus": "DELIVERED_SHIPMENT_DELIVERED",
"statusDate": "2023-09-18 00:14:39",
"facilityCode": null,
"shippingPackageCode": "VARAAA121719"

}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 trackingNumber string Shipment tracking number Yes -
2 providerCode string Shipping provider code Yes -
3 trackingStatus string Tracking Status Yes DELIVERED_SHIPMENT_DELIVERED
4 statusDate string Status date for marking delivered in UC Yes e.g. 2023-09-18 00:14:39
5 facilityCode string Seller facility (warehouse) code driven by json map at connector applicability.  Yes -
6 shippingPackageCode string Shipping Package Code Opt -

Response Payload

{
    "status": "success",
    "message": "Tracking Status updated successfully",
    "data": null
}

Response Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 Status string Success after Delievred is acknowledged Yes Success/Failed
2 message string Response message - -
3 data string Null - -

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What would be that frequency of Delivered push to UC?
Ans. On MarketPlace action for Delivered, at same time MP needs to post the Delivered information to UC.

Q2. Can UC handle partial Delivered of order (item wise order Delivered)?
Ans. No, UC handle package-wise Delivered status. Check the API schema.

Unicommerce Website

Copyright © 2024 Unicommerce eSolutions Pvt. Ltd.