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 (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: | /dispatchedShipment |
| Request Type: | POST |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | token value(got from Authentication |
Request Payload
{
"invoiceNo": "INS0003",
"shippingPackageCode": "100400003",
"invoiceCreationDate": "Feb 2, 2023 7:30:48 PM",
"AWB": "wq0",
"courierName": "CHANNEL_SHIPPING",
"ChannelName": "TEST_CUSTOM",
"facilityCode": "1004",
"saleOrder":
[
"code": "1100053057",
"customField"[
]
],
"paymentMethod": "PREPAID",
"gstin": "string",
"customFields": [
],
"orderItems": [
{
"orderItemCode": "FN1100053057_2024719601103_0",
"CGSTAmt": 0.000,
"discountAmt": 150.400,
"hsnCode": "62044390",
"shippingCharges": 0.000,
"Rate": 2244.600,
"SGSTPercent": 0.000,
"mrp": 2395.000,
"CODCharges": 0.000,
"CGSTPercent": 0.000,
"IGSTAmt": 240.490,
"IGSTPercent": 12.000,
"netAmt": 2244.600,
"giftWrapCharges": 0.000,
"SGSTAmt": 0.000,
"taxableAmt": 2004.110,
"CESSPercent": 0.000,
"extraChgAmt": 0.0,
"CESSAmt": 0.000,
"skuCode": "2024719601103",
"Imei": "string",
"combinationIdentifier": "string",
"customFields": [
]
},
{
"orderItemId": "FN1100053057_2024719601103_1",
"CGSTAmt": 0.000,
"discountAmt": 150.400,
"hsnCode": "62044390",
"shippingCharges": 0.000,
"Rate": 2244.600,
"SGSTPercent": 0.000,
"mrp": 2395.000,
"CODCharges": 0.000,
"CGSTPercent": 0.000,
"IGSTAmt": 240.490,
"IGSTPercent": 12.000,
"netAmt": 2244.600,
"giftWrapCharges": 0.000,
"SGSTAmt": 0.000,
"qty": 1,
"taxableAmt": 2004.110,
"CESSPercent": 0.000,
"extraChgAmt": 0.0,
"CESSAmt": 0.000,
"skuCode": "2024719601103",
"Imei": "string",
"combinationIdentifier": "string",
"customFields": [
]
}
],
"addresses": [
{
"addressLine1": "ABC",
"addressLine2": "XYZ",
"city": "New Delhi",
"country": "India",
"email": "abc@gmail.com",
"name": "ABC",
"phone": "9999999999",
"pincode": "110020",
"state": "DL",
"type": "Billing"
},
{
"addressLine1": "ABC",
"addressLine2": "XYZ",
"city": "New Delhi",
"country": "India",
"email": "abc@gmail.com",
"name": "ABC",
"phone": "9999999999",
"pincode": "110020",
"state": "DL",
"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 | number | Central GST value | Yes | - |
| 12.3 | discountAmt | number | Discount value | Yes | - |
| 12.4 | hsnCode | string | HSN code | Yes | - |
| 12.5 | shippingCharges | number | Shipping charges | Yes | - |
| 12.6 | Rate | number | Rate | Yes | - |
| 12.7 | SGSTPercent | number | Percentage of state GST | Yes | - |
| 12.8 | mrp | number | MRP | Yes | - |
| 12.9 | CODCharges | number | Cash On Delivery Charges | Yes | - |
| 12.10 | CGSTPercent | number | Percentage of CST | Yes | - |
| 12.11 | IGSTAmt | number | Integrated GST value | Yes | - |
| 12.12 | IGSTPercent | number | Percentage of integrated GST | Yes | - |
| 12.13 | netAmt | number | Net amount | Yes | - |
| 12.14 | giftWrapCharges | number | Charges for gift wrapping | Yes | - |
| 12.15 | SGSTAmt | number | State GST value | Yes | - |
| 12.16 | qty | number | Quantity | Yes | - |
| 12.17 | taxableAmt | number | Taxable amount | Yes | - |
| 12.18 | CESSPercent | number | Percentage of compensation cess | Yes | - |
| 12.19 | extraChgAmt | number | Extra charge value | Yes | - |
| 12.20 | CESSAmt | number | 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 | 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.