POST /v3/shipments/labels¶
Description - The Label Generation API (also known as the Pack API) generates invoice and shipping labels for the shipment ids and marks shipments as packed. It takes the invoice details in the request as input. If the orderItemId requires a serial number or IMEI number (also known as serialized product), that input is also required when calling this API.
Request and Response Parameters¶
☰ SHOW | HIDE
URL: https://api.flipkart.net/sellers/v3/shipments/labels
Request Body Parameter
| Parameter/Attribute | Type | Requirement | Description |
|---|---|---|---|
shipments |
List of shipments | Mandatory | List of shipment ids for pack |
shipmentId |
String | Mandatory | Unique number that identifies the shipment. |
locationId |
String | Mandatory | Id which refers to seller’s dispatch location. |
taxItems |
List of tax items | Mandatory | List of taxable items |
taxItems. orderItemId |
String | Mandatory | The orderItemId of the primary shipment Item. |
taxItems. purchasePrice |
Numeric | Optional | Purchase price of the item (only to be passed for refurbished products) |
taxItems. taxRate |
Numeric | Mandatory | Tax Rate for the Item |
taxItems. quantity |
Numeric | Mandatory | Quantity of items to be shipped. |
serialNumbers |
List of serial numbers | Mandatory only if item is serialized | Serial number array for serialized products |
serialNumbers. orderItemId |
String | Mandatory | orderItemId for which serial number is being input |
serialNumbers. serialNumbers |
List<List<String>> | Mandatory | serialNumbers for the given order item id |
subShipments |
List of sub shipments | Mandatory | List of subShipments associated with the shipment |
subShipments. subShipment |
String | Mandatory | Primary identifier for a specific sub shipment. |
subShipments. dimensions. length |
Float | Mandatory | Length of the sub-shipment |
subShipments. dimensions. breadth |
Float | Mandatory | Breadth of the sub-shipment |
subShipments. dimensions. height |
Float | Mandatory | Height of the sub-shipment |
subShipments. dimensions. width |
Float | Mandatory | Width of the sub-shipment |
invoices |
List of invoice details | Mandatory | Invoice details for the shipment |
invoices. orderId |
String | Mandatory | Order id to which particular order item is associated. |
invoices. invoiceNumber |
String | Optional | If the seller has not opted for auto invoicing, then this field is mandatory. |
invoices. invoiceDate |
Date | Mandatory | Invoice date |
Validations
ShipmentId and Sub Shipment Id is mandatory.
Order Item id is mandatory.
Dimensions are mandatory and should be a positive value.
For multiline orders, Pass the LBHW attributes of the the order_item which has the maximum value in the order.
GST information must be part of taxItems
Response Body Parameters
| Parameter/Attribute | Type | Description |
|---|---|---|
shipments. shipmentId |
String | Primary identifier for a specific shipment. |
shipments. processingStatus |
String | SUCCESS or FAILURE |
shipments. errorCode |
String | Error code for any error |
shipments. errorMessage |
String | Error message |
| Error Codes | Reason for Error |
|---|---|
ITEM_ON_HOLD |
Error if shipment is on hold |
INVALID_PACK_REQUEST |
If all the order items inside shipment are not in approved state |
INCOMPLETE_SHIPMENT_DIMENSIONS |
Invalid dimensions given for particular sub shipment |
SERVICEABILITY_NOT_ALLOWED |
Serviceability not allowed from seller location to buyer location |
SELLER_TIN_NOT_FOUND |
Seller TIN number not found |
INVALID_DISPATCH_AFTER_DATE |
Dispatch After Date is greater than current time of pack |
PACK_OPERATION_NOT_AUTHORISED |
Seller not authorised for packing the shipment |
INVALID_IMEI_NUMBER |
Invalid IMEI number given for any serialised products |
WEIGHT_ANOMALY_ERROR |
Error in dimension details for given shipments |
WEIGHT_ANOMALY_WARNING |
Warning in dimension details for given shipments |
PACK_GSTIN_NOT_FOUND |
Please check and update your GSTIN |
INVALID_PACK_CHANNEL |
When pack channel is not supported for shipment type and service profile |
DUPLICATE_PACK_REQUEST |
When Earlier Pack Request Still in Processing |
INVALID_LOCATION |
When Shipment does not belong to this location, please cross check from Get shipment details api |
INVALID_PURCHASE_PRICE |
When Purchase Price present for non-refurbished verticals or not valid purchase price for order item id’s |
INVALID_PACKAGE_DIMENSION |
Package dimensions too big to be serviceable. Please re-check your packaging under My Listings tab at the time of order placement |