Create and Complete Manifest
This REST API is used to create and complete manifest in Uniware.
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.
Flow
Tip
Complete integration flow is available on Basic Overview page.
Basic Information
| NAME | DETAILS |
|---|---|
| Endpoint: | /services/rest/v1/oms/shippingManifest/createclose |
| 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
{
"channel": "string",
"shippingProviderCode": "string",
"shippingProviderName": "string",
"shippingMethodCode": "string",
"comments": "string",
"thirdPartyShipping": true,
"customFieldValues": [
{
"name": "string",
"value": "string"
}
],
"shippingPackageCodes": [
"string"
],
"shippingProviderIsAggregator": "boolean",
"shippingCourier": "string"
}Request Payload Details
| LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
|---|---|---|---|---|---|
| 1 | channel | string | - | - | - |
| 2 | shippingProviderCode | string | Shipping provider code | Yes | - |
| 3 | shippingProviderName | string | Shipping provider name | Yes | - |
| 4 | shippingMethodCode | string | The shipping method of the order | Yes | - |
| 5 | comments | string | Comments | Opt | - |
| 6 | thirdPartyShipping | boolean | true if the shipping to end customer is taken care by the Marketplace. false for self shipping | - | Default: true |
| 7 | customFieldValues | list | - | - | - |
| 7.1 | name | string | Custom field name | Yes | - |
| 7.2 | value | string | Custom field value | Opt | - |
| 8 | shippingPackageCodes | string | Shipping package code | Yes | - |
| 9 | shippingProviderIsAggregator | boolean | true if shipping provider is aggregator | No | - |
| 10 | shippingCourier | string | Shipping provider name as lastmile | No | if shipping Provider Is Aggregator |
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"
}
],
"shippingManifestId": 0,
"shippingManifestCode": "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
}
]
}
],
"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-06-02T04:51:12.835Z",
"updated": "2020-06-02T04:51:12.835Z"
}
}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 | shippingManifestId | number | Shipping manifest ID | Default: 0 |
| 6 | shippingManifestCode | string | Shipping manifest code | - |
| 7 | manifestItems | list | - | - |
| 7.1 | shippingPackageCode | string | Shipping package code | - |
| 7.2 | shippingPackageStatusCode | string | Shipping package status code | - |
| 7.3 | invoiceCode | string | Invoice code | - |
| 7.4 | invoiceDisplayCode | string | Invoice display code | - |
| 7.5 | trackingNumber | string | Tracking number | - |
| 7.6 | quantity | integer | Qty of the item | Default: 0 |
| 7.7 | noOfBoxes | integer | No. of boxes | Default: 0 |
| 7.8 | weight | integer | Weight of the shipment | Default: 0 |
| 7.9 | totalAmount | number | Total amount | - |
| 7.10 | shippingCharges | number | Shipping charges | Default: 0 |
| 7.11 | collectableAmount | number | Amount to be collected | Default: 0 |
| 7.12 | shippingMethod | string | Shipping method | - |
| 7.13 | shippingAddress | - | Shipping address of receiver | - |
| 7.13.1 | id | number | - | Default: 0 |
| 7.13.2 | name | string | Buyer name | - |
| 7.13.3 | addressLine1 | string | Precise address of receiver | - |
| 7.13.4 | addressLine2 | string | Additional address information | - |
| 7.13.5 | city | string | City name | Eg: Surat |
| 7.13.6 | state | string | State name | Eg: Gujrat |
| 7.13.7 | pincode | string | Area pincode (min. 6 digits) | Eg: 395006 |
| 7.13.8 | phone | string | Contact no. | - |
| 7.14 | shippingPackageType | string | Shipping package type | - |
| 7.14.1 | code | string | - | - |
| 7.14.2 | boxLength | integer | Packing box length (in mm) | - |
| 7.14.3 | boxWidth | integer | Packing box width (in mm) | - |
| 7.14.4 | boxHeight | integer | Packing box height (in mm) | - |
| 7.14.5 | boxWeight | integer | Packing box weight (in kg) | - |
| 7.14.6 | packingCost | number | Cost of packaging | - |
| 7.14.7 | enabled | boolean | - | Default: true |
| 7.14.8 | editable | boolean | - | Default: true |
| 7.15 | displayOrderCode | string | Order code to be displayed | - |
| 7.16 | cashOnDelivery | boolean | true if COD | Default: true |
| 7.17 | shippingProviderCode | string | Shipping provider code | - |
| 7.18 | shippingProviderName | string | Shipping provider name | - |
| 7.19 | manifestLineItems | list | - | - |
| 7.19.1 | lineItemIdentifier | string | - | - |
| 7.19.2 | itemName | string | Item name | - |
| 7.19.3 | sellerSkuCode | string | Seller SKU code | - |
| 7.19.4 | quantity | integer | Qty of the item | Default: 0 |
| 8 | shippingManifestStatus | object | - | - |
| 8.1 | mileStoneCount | integer | - | Default: 0 |
| 8.2 | currentMileStone | integer | - | Default: 0 |
| 8.3 | currentStatus | string | - | - |
| 8.4 | completed | boolean | true if completed | Default: true |
| 8.5 | successful | boolean | true if successful | Default: true |
| 8.6 | percentageComplete | number | - | Default: 0 |
| 8.7 | id | string | - | - |
| 8.8 | shippingManifestCode | string | Shipping manifest code | - |
| 8.9 | shippingManifestLink | string | Shipping manifest link | - |
| 8.10 | failedShippingPackages | list | List of failed shipping packages | - |
| 8.10.1 | code | string | Code of shipping package failed | - |
| 8.10.2 | saleOrderCode | string | Sale order code of shipping package failed | - |
| 8.10.3 | failureReason | string | Reason for failure of shipping package | - |
| 8.10.4 | cancelled | boolean | true if cancelled | Default: true |
| 8.11 | failedShipmentsBatchCode | string | Batch code of failed shipment | - |
| 8.12 | created | date | Shipment creation date | - |
| 8.13 | updated | date | Shipment last updated date | - |
Error Codes
Refer Response Codes section to know about specific errors codes.