Inbound | POST | /usp/order/pack
...
This API will pack the order in the OMS and required marketplace and return the invoice and shipping label documents in response
Description
It means the shipment is going to be packed with SKUs mentioned in the & the respective Integrated Marketplace to Increff system and then return the Invoice & Shipping Label documents in the response.
Description
This API will be used to pack the shipment for an Order having the SKUs passed in the request payload.
Request
| Code Block | ||
|---|---|---|
| ||
{
"orderCode": "H19304030001",
"locationCode": "l123",
"channelName": "Myntra",
"weight": 40,
"packageSku": "P1",
"fulfillmentType": "BLOCK_COMPLETE",
"packageDetails": {
"length": 12,
"breadth": 6,
"height": 1
},
"shipmentItems": [
{
"channelSkuCode": "100000789702",
"quantityToPack": 5,
"externalSerialCodes": []
}
]
} |
Parameter Name | Data Type | Description | Mandatory |
| String | Unique code used by the channel to identify the order. |
Yes | |||
| String | Code used by channels to identify a warehouse | Yes |
| String | Code used to identify a channel | Yes |
| String | SKU of the package material used for packing |
No | ||
| Double | Weight of the package in grams |
No | ||
| String | Enum with possible values: |
|
|
|
No | ||
| Object | Dimensions of the packed shipment |
No |
| Double |
length of |
shipment box |
No |
| Double |
breadth of |
shipment box |
No |
| Double |
height of |
shipment box |
No | ||
| Object[] | List of items corresponding to shipment |
Yes | ||
| String | SKU code of order item |
Yes | ||
| Integer | Quantity of SKU in shipment |
Yes | ||
| String[] | These are the external serial ids for the item |
No |
Response
| Code Block | ||
|---|---|---|
| ||
{
"orderCode": "H19304030001",
"locationCode": "l123",
"channelId": "l123",
"shipmentCode": "l123",
"shipmentId": "l123",
"shippingLabel": {
"transporter": "INV123",
"awbawbNumber": "INV123",
"shippingLabelUrl": "https://mybrand.com/shipping-Label123.pdf",
"shippingLabel": "invoiceBase64String",
},
"invoice": [
"invoiceUrl": "https://mybrand.com/shipping-Label123.pdf",
"invoice": "invoiceBase64String",
"invoiceCode": "INV-1",
"invoiceDate": "2020-10-16T20:22:28.000+05:30",
"invoiceDetails": [
{
"channelSkuCode": "100000789702",
"clientSkuId": "100000789702",
"netTaxAmountPerUnit": 60,
"netTaxAmountTotal": 120,
"baseSellingPricePerUnit": 500,
"baseSellingPriceTotal": 1000,
"actualSellingPricePerUnit": 560,
"actualSellingPriceTotal": 1120,
"quantity": 2,
"taxItems": [
{
"type": "SGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
},
{
"type": "CGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
}
]
}
]
]
}
} |
HttpStatus : 200
Parameter Name | Data Type | Description | Mandatory |
| String | Unique code used by the channel to identify the order. |
Yes | |||
| String | Code used by channels to identify a warehouse | Yes |
channelId
| String | Code used to identify a channel | Yes |
| Long | Shipment id of Increff Omni system |
Yes | ||
| String | Unique code used by the channel to identify the shipment |
Yes | ||
| Object | Shipping Label Details |
No | ||
| String | Downloadable pdf url of the shipping label document(either of shippingLabel and shippingLabelUrl is mandatory) |
No | ||
| String | Tracking number provided by the courier partner |
Yes | ||
| String | Base64 encoded string of the shipping label(either of shippingLabel and shippingLabelUrl is mandatory) |
No | ||
| String | Courier partner name |
Yes | |||
| String | Invoice Number that is printed on the invoice PDF | Yes |
| String | Downloadable pdf url of the invoice document(either of invoice and invoice Url is mandatory) |
No | |||
| Object[] | Tax Details of the invoice.
| No |
| String | Date of invoice generated by Increff Omni | Yes |
| String | Base64 encoded string of invoice PDF(either of invoice and invoice Url is mandatory) |
No | |||
| String | SKU code of order item | Yes |
| Double | Per unit tax applicable for the SKU | Yes |
| Double | Total tax applicable for the SKU | Yes |
| Double | Per unit base selling price of the SKU | Yes |
| Double | Total base selling price of the SKU | Yes |
| Double | Per unit actual selling price of the SKU | Yes |
| Double | Total actual selling price of the SKU | Yes |
| Integer | Total quantity of a sku for a line item | Yes |
| Object[] | Distribution of tax with tax type
| Yes |
| String | Type of tax applicable | Yes |
| Double | Tax rate for this tax type | Yes |
| Double | Per unit tax applicable for this type of tax | Yes |
| Double | Total tax applicable for this type of tax | Yes |