Get Shipping Manifest
This REST API is used to fetch shipping manifest details from Uniware using shipping manifest code.
Tip
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 |
|---|---|
| Endpoint: | /services/rest/v1/oms/shippingManifest/get |
| Request Type: | POST |
| Level: | Facility |
| Scheme: | HTTPS |
| Header (Content-Type): | application/json |
| Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
| Header (Facility): | facility code as in Uniware (refer FAQs) |
Request Payload
{
"shippingManifestCode": "string"
}Request Payload Details
| PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|
| shippingManifestCode | string | Shipping manifest code | Yes | - |
Response Payload
{
"successful": true,
"message": "string",
"errors": [
{
"code": 0,
"fieldName": "string",
"description": "string",
"message": "string",
"errorParams": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
],
"warnings": [
{
"code": 0,
"message": "string",
"description": "string"
}
],
"shippingManifest": {
"id": 0,
"code": "string",
"username": "string",
"shippingProvider": "string",
"shippingProviderCode": "string",
"shippingManfestLink": "string",
"shippingMethod": "string",
"signatureLink": "string",
"channel": "string",
"cashOnDelivery": true,
"created": "2023-07-08T06:19:01.460Z",
"updated": "2023-07-08T09:19:01.460Z",
"status": "string",
"manifestItems": [
{
"shippingPackageCode": "string",
"shippingPackageStatusCode": "string",
"invoiceCode": "string",
"invoiceDisplayCode": "string",
"trackingNumber": "string",
"quantity": 0,
"noOfBoxes": 0,
"weight": 0,
"totalAmount": 0,
"shippingCharges": 0,
"collectableAmount": 0,
"shippingMethod": "string",
"shippingAddress": {
"id": 0,
"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"pincode": "string",
"phone": "string"
},
"shippingPackageType": {
"code": "string",
"boxLength": 0,
"boxWidth": 0,
"boxHeight": 0,
"boxWeight": 0,
"packingCost": 0,
"enabled": true,
"editable": true
},
"displayOrderCode": "string",
"cashOnDelivery": true,
"shippingProviderCode": "string",
"shippingProviderName": "string",
"manifestLineItems": [
{
"lineItemIdentifier": "string",
"itemName": "string",
"sellerSkuCode": "string",
"quantity": 0
}
]
}
],
"customFieldValues": [
{
"fieldName": "string",
"fieldValue": {},
"valueType": "string",
"displayName": "string",
"required": true,
"possibleValues": [
"string"
]
}
],
"shippingManifestStatus": {
"mileStoneCount": 0,
"currentMileStone": 0,
"currentStatus": "string",
"completed": true,
"successful": true,
"percentageComplete": 0,
"id": "string",
"shippingManifestCode": "string",
"shippingManifestLink": "string",
"failedShippingPackages": [
{
"code": "string",
"saleOrderCode": "string",
"failureReason": "string",
"cancelled": true
}
],
"failedShipmentsBatchCode": "string",
"created": "2020-07-08T06:19:01.460Z",
"updated": "2020-07-08T06:19:01.460Z"
},
"fetchCurrentChannelManifestEnabled": true,
"shippingCourier": "DELHIVERY"
}
}Response Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | NOTES |
|---|---|---|---|---|
| 1 | successful | true | Request success status | - |
| 2 | message | string | Response message | - |
| 3 | errors | list | List of errors (if any) | - |
| 3.1 | code | number | Error code | - |
| 3.2 | fieldName | string | Field with error | - |
| 3.3 | description | string | Error description | - |
| 3.4 | message | string | Error message | - |
| 3.5 | errorParams | object | Parameters with error | - |
| 3.5.1 | additionalProp1 | object | Parameter 1 with error | - |
| 3.5.2 | additionalProp2 | object | Parameter 2 with error | - |
| 3.5.3 | additionalProp3 | object | Parameter 3 with error | - |
| 4 | warnings | list | List of warnings (if any) | - |
| 4.1 | code | number | Warning code | - |
| 4.2 | message | string | Warning message | - |
| 4.3 | description | string | Warning description | - |
| 5 | shippingManifest | object | Shipping manifest details | - |
| 5.1 | id | integer | Manifest ID | - |
| 5.2 | code | string | Manifest code | - |
| 5.3 | username | string | Username | - |
| 5.4 | shippingProvider | string | Shipping provider | - |
| 5.5 | shippingProviderCode | string | Shipping provider code | - |
| 5.6 | shippingManfestLink | string | Shipping manifest link | - |
| 5.7 | shippingMethod | string | Shipping method | - |
| 5.8 | signatureLink | string | Signature link | - |
| 5.9 | channel | string | - | - |
| 5.10 | cashOnDelivery | boolean | true if COD | - |
| 5.11 | created | date | Creation Date | - |
| 5.11 | updated | date | updated Date | - |
| 5.12 | status | string | - | - |
| 5.13 | manifestItems | list | - | - |
| 5.13.1 | shippingPackageCode | string | Shipping package code | - |
| 5.13.2 | shippingPackageStatusCode | string | Shipping package status code | - |
| 5.13.3 | invoiceCode | string | Invoice code | - |
| 5.13.4 | invoiceDisplayCode | string | Invoice display code | - |
| 5.13.5 | trackingNumber | string | Tracking number | - |
| 5.13.6 | quantity | integer | Quantity of items | - |
| 5.13.7 | noOfBoxes | integer | No. of boxes | - |
| 5.13.8 | weight | integer | Weight in gm | - |
| 5.13.9 | totalAmount | number | Total amount | - |
| 5.13.10 | shippingCharges | number | Shipping charges | - |
| 5.13.11 | collectableAmount | number | Amount to be collected at time of delivery | 0.00 for Prepaid mode |
| 5.13.12 | shippingMethod | string | Shipping method | - |
| 5.13.13 | shippingAddress | object | Shipping address details | - |
| 5.13.13.1 | id | integer | ID | - |
| 5.13.13.2 | name | string | Name | - |
| 5.13.13.3 | addressLine1 | string | Precise address | - |
| 5.13.13.4 | addressLine2 | string | Additional address information | Max chars: 500 |
| 5.13.13.5 | city | string | City name | Eg: Surat, Max. chars: 100 |
| 5.13.13.6 | state | string | State name | Eg: Gujrat, Max. chars: 45 |
| 5.13.13.7 | pincode | string | Area pincode (min. 6 digits) | Max chars: 45 |
| 5.13.13.8 | phone | string | Contact no. | - |
| 5.13.14 | shippingPackageType | object | Shipping package type | - |
| 5.13.14.1 | code | string | Code | - |
| 5.13.14.2 | boxLength | integer | Packing box length (in mm) | - |
| 5.13.14.3 | boxWidth | integer | Packing box width (in mm) | - |
| 5.13.14.4 | boxHeight | integer | Packing box height (in mm) | - |
| 5.13.14.5 | boxWeight | integer | Packing box weight (in kg) | - |
| 5.13.14.6 | packingCost | number | Cost of packaging | - |
| 5.13.14.7 | enabled | boolean | true if enabled | - |
| 5.13.14.8 | editable | boolean | - | Default: true |
| 5.13.15 | displayOrderCode | string | Order code to be displayed | - |
| 5.13.16 | cashOnDelivery | boolean | true if COD | - |
| 5.13.17 | shippingProviderCode | string | Shipping provider code | - |
| 5.13.18 | shippingProviderName | string | Shipping provider name | - |
| 5.13.19 | manifestLineItems | list | - | - |
| 5.13.19.1 | lineItemIdentifier | string | - | - |
| 5.13.19.2 | itemName | string | Item name | - |
| 5.13.19.3 | sellerSkuCode | string | Seller SKU code | - |
| 5.13.19.4 | quantity | integer | Quantity of items | - |
| 5.14 | customFieldValues | list | Custom field details | - |
| 5.14.1 | fieldName | string | Custom field name | - |
| 5.14.2 | fieldValue | object | Custom field value | - |
| 5.14.3 | valueType | string | - | - |
| 5.14.4 | displayName | string | Name to be displayed | - |
| 5.14.5 | required | boolean | true if required | - |
| 5.14.6 | possibleValues | list | - | - |
| 5.15 | shippingManifestStatus | object | - | - |
| 5.15.1 | mileStoneCount | integer | - | - |
| 5.15.2 | currentMileStone | integer | - | - |
| 5.15.3 | currentStatus | string | Current status | - |
| 5.15.4 | completed | boolean | true if completed | - |
| 5.15.5 | successful | boolean | true if successful | - |
| 5.15.6 | percentageComplete | number | - | - |
| 5.15.7 | id | string | - | - |
| 5.15.8 | shippingManifestCode | string | Shipping manifest code | - |
| 5.15.9 | shippingManifestLink | string | Shipping manifest link | - |
| 5.15.10 | failedShippingPackages | list | List of failed shipping packages | - |
| 5.15.10.1 | code | string | Shipping package code | - |
| 5.15.10.2 | saleOrderCode | string | Sale order code | - |
| 5.15.10.3 | failureReason | string | Reason for failure | - |
| 5.15.10.4 | cancelled | boolean | true if cancelled | - |
| 5.15.11 | failedShipmentsBatchCode | string | Batch code of failed shipment | - |
| 5.15.12 | created | date | Creation Date | - |
| 5.15.13 | updated | date | Updation Date, to know when the package was dispatched in UC | - |
| 5.16 | fetchCurrentChannelManifestEnabled | boolean | true if fetch current channel manifest enabled | - |
| 5.17 | shippingCourier | string | ShippingCourier name as lastmile | - |
Error Codes
Refer Response Codes section to know about specific errors codes.