Shipment Dispatched

This REST API is used to notify the Partner when the shipment has been dispatched in Uniware.

Tip

  • The access token received in response is required in Header (Authorization) 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: /dispatchedShipment
Request Type: POST
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): token value(got from Authentication

Request Payload

{
  "invoiceNo": "INS9371",
  "shippingPackageCode": "WEARDL-09874",
  "invoiceCreationDate": "Jul 19, 2024 10:09:13 AM",
  "AWB": "77136301701",
  "courierName": "Bluedart Standard",
  "shippingProviderName": "PROSHIP",
  "ChannelName": "SHOPIFY_WEBSITE",
  "facilityCode": "WEARCOMETDELHI",
  "dispatchedOn": "Jul 19, 2024 10:56:22 AM",
  "customFields": [
    
  ],
  "orderItems": [
    {
      "orderItemCode": "15131106574643",
      "hsnCode": "640299",
      "discountAmt": 859.80,
      "shippingCharges": 0.00,
      "CODCharges": 0.00,
      "giftWrapCharges": 0.00,
      "mrp": 4999.00,
      "extraChgAmt": 0,
      "Rate": 3439.20,
      "total": 4299.00,
      "skuCode": "CLSA03077",
      "Imei": "",
      "combinationIdentifier": null,
      "taxableAmt": 2914.58,
      "SGSTPercent": 9.000,
      "CGSTPercent": 9.000,
      "IGSTPercent": 0.000,
      "CESSPercent": 0.000,
      "UGSTPercent": 0.000,
      "SGSTAmt": 262.31,
      "CGSTAmt": 262.31,
      "IGSTAmt": 0.00,
      "CESSAmt": 0.00,
      "UGSTAmt": 0.00,
      "netAmt": 524.62,
      "customFields": [
        
      ]
    }
  ],
  "saleOrder": [
    {
      "code": "5976000299315",
      "paymentMethod": "Prepaid",
      "gstIn": null,
      "customFields": [
        
      ],
      "addresses": [
        {
          "name": "jain",
          "addressLine1": "RWA, sector 39",
          "addressLine2": "road next to wine shop",
          "city": "Gurgaon",
          "state": "Haryana",
          "country": "India",
          "pincode": "122001",
          "phone": "9999999999",
          "email": "",
          "type": "Billing"
        },
        {
          "name": "jain",
          "addressLine1": "RWA, sector 39",
          "addressLine2": "road next to wine shop",
          "city": "Gurgaon",
          "state": "Haryana",
          "country": "India",
          "pincode": "122001",
          "phone": "9999999999",
          "email": "",
          "type": "Shipping"
        }
      ]
    }
  ]
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 invoiceNo string Invoice number Yes -
2 shippingPackageCode string Shipment code Yes -
3 invoiceCreationDate string Invoice creation timestamp Yes -
4 AWB string trackingNumber(AWB) Yes -
5 courierName string Shipping provider name Yes -
6 ChannelName string channel name Yes -
7 facilityCode string Facility code Yes -
8 saleOrder object Sale order code Yes -
8.1 code string Sale order code Yes -
8.2 customFields object Custom fields details Opt -
9 paymentMethod string Payment Method Yes PREPAID or COD
10 gstin string gstin number Yes -
11 customFields object Custom fields details Opt -
11.1 name string Custom field name No -
11.2 value string Custom field value No -
12 orderItems object Order items detials Yes -
12.1 orderItemCode string Shipment Yes -
12.2 CGSTAmt Decimal Central GST value Yes -
12.3 discountAmt Decimal Discount value Yes -
12.4 hsnCode string HSN code Yes -
12.5 shippingCharges Decimal Shipping charges Yes -
12.6 Rate Decimal Rate Yes -
12.7 SGSTPercent Decimal Percentage of state GST Yes -
12.8 mrp Decimal MRP Yes -
12.9 CODCharges Decimal Cash On Delivery Charges Yes -
12.10 CGSTPercent Decimal Percentage of CST Yes -
12.11 IGSTAmt Decimal Integrated GST value Yes -
12.12 IGSTPercent Decimal Percentage of integrated GST Yes -
12.13 netAmt Decimal Net amount Yes -
12.14 giftWrapCharges Decimal Charges for gift wrapping Yes -
12.15 SGSTAmt Decimal State GST value Yes -
12.16 qty Decimal Quantity Yes -
12.17 taxableAmt Decimal Taxable amount Yes -
12.18 CESSPercent Decimal Percentage of compensation cess Yes -
12.19 extraChgAmt Decimal Extra charge value Yes -
12.20 CESSAmt Decimal Compensation cess value Yes -
12.21 skuCode string SKU code Yes -
12.22 Imei string Imei code Yes -
12.23 combinationIdentifier string Combination identifier Yes -
12.24 customFields object Custom Field details Opt -
12.24.1 name string Custom field name No -
12.24.2 value string Custom field value No -
13 addresses object Addresses details Yes -
13.1 addressLine1 string First line of the address Yes -
13.2 addressLine2 string Second line of the address Yes -
13.3 city string City name Yes -
13.4 country string Country name Yes -
13.5 email string Email id Yes -
13.6 name string Customer name Yes -
13.7 phone string Customer mobile number Yes -
13.8 pincode string Pincode Yes -
13.9 state string Address state code Yes -
13.10 type string The type of the address Yes “Billing” or “Shipping”

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.