Get shipping related details for shipments
GET /sellers/v3/shipments/:shipmentIds
This operation returns shipping and tracking related details of the shipments e.g delivery / billing address, tracking id, buyer address, etc. Buyer contact number and email address would be provided only for self-ship shipments.
Path Parameters
- shipmentIds string required
Comma separated shipment ids. Maximum 100 shipment ids allowed per request.
Responses
- 200
successful operation
- application/json
- Schema
- Example (from schema)
Schema
shipments object[]
Array [shipmentId stringdispatchByDate date-timedispatchAfterDate date-timeupdatedAt date-timelocationId stringhold booleanmps booleanpackagingPolicy stringsubShipments object[]
Array [subShipmentId stringpackages object[]
Array [id stringname string requireddimensions object
length number requiredbreadth number requiredheight number requiredweight numbernotional_value object
amount number requiredunit string requiredPossible values: [
PERCENTAGE
,INR
]description stringhandling object
fragile boolean required]]orderItems object[]
Array [orderItemId stringorderId stringcancellationGroupId stringorderDate date-timecancellationDate date-timepaymentType stringPossible values: [
COD
,PREPAID
]status stringPossible values: [
APPROVED
,PACKING_IN_PROGRESS
,FORM_FAILED
,PACKED
,READY_TO_DISPATCH
,PICKUP_COMPLETE
,CANCELLED
,RETURN_REQUESTED
,RETURNED
,SHIPPED
,DELIVERED
,COMPLETED
]cancellationReason stringcancellationSubReason stringcourierReturn booleanquantity int32fsn stringsku stringlistingId stringhsn stringtitle stringpackageIds string[]priceComponents object
sellingPrice numbertotalPrice numbershippingCharge numbercustomerPrice numberflipkartDiscount numberserviceProfile stringPossible values: [
Flipkart_Fulfilment
,Seller_Fulfilment
,Smart_Fulfilment
,FBF
,NON_FBF
,FBF_LITE
]is_replacement boolean]forms object[]
Array [name stringlink stringautomated boolean]shipmentType string]
{
"shipments": [
{
"shipmentId": "string",
"dispatchByDate": "2025-01-29T05:32:53.641Z",
"dispatchAfterDate": "2025-01-29T05:32:53.641Z",
"updatedAt": "2025-01-29T05:32:53.641Z",
"locationId": "string",
"hold": true,
"mps": true,
"packagingPolicy": "string",
"subShipments": [
{
"subShipmentId": "string",
"packages": [
{
"notional_value": {
"amount": 0.7386281948385884,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 4.145608029883936,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 3.616076749251911,
"length": 9.301444243932576,
"height": 2.027123023002322
}
}
]
}
],
"orderItems": [
{
"orderItemId": "string",
"orderId": "string",
"cancellationGroupId": "string",
"orderDate": "2025-01-29T05:32:53.642Z",
"cancellationDate": "2025-01-29T05:32:53.642Z",
"paymentType": "COD",
"status": "APPROVED",
"cancellationReason": "string",
"cancellationSubReason": "string",
"courierReturn": true,
"quantity": 0,
"fsn": "string",
"sku": "string",
"listingId": "string",
"hsn": "string",
"title": "string",
"packageIds": [
"string"
],
"priceComponents": {
"sellingPrice": 0,
"totalPrice": 0,
"shippingCharge": 0,
"customerPrice": 0,
"flipkartDiscount": 0
},
"serviceProfile": "Flipkart_Fulfilment",
"is_replacement": true
}
],
"forms": [
{
"name": "string",
"link": "string",
"automated": true
}
],
"shipmentType": "string"
}
]
}
Loading...