GET /v3/shipments/{shipmentIds}

Description - The Shipments API gives the shipping details for multiple shipment ids based on the specified shipmentIds. The recommended limit is 25 shipmentIds.

Note that 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.

Request and Response Parameters

☰ SHOW | HIDE

URL: https://api.flipkart.net/sellers/v3/shipments/{shipmentIds}

Request Header Parameters

Path Parameter	Requirement	Description
shipmentIds	Mandatory	Gives shipping details for shipmentIds

Response Body Parameters

Parameter/Attribute	Type	Description
orderId	String	Identifies the order
deliveryAddress. firstName	String	First name of the recipient
deliveryAddress. lastName	String	Last name of the recipient
deliveryAddress. pincode	String	Pincode of the recipient address
deliveryAddress. city	String	City in the recipient address
deliveryAddress. stateName	String	State in which the deliveryAddress.city is located.
deliveryAddress. addressLine1	String	Address Line 1 of the recipient address
deliveryAddress. addressLine2	String	Address Line 2 of the recipient address
deliveryAddress. stateCode	.String	State Code corresponding to the State Name
deliveryAddress. state	String	State name of recipient
deliveryAddress. landmark	String	Landmark in the recipient address
deliveryAddress. contactNumber	String	Contact number of the recipient
shipmentId	String	Unique identifier to the Shipment
locationId	String	Id which refers to seller’s dispatch location
subShipments. subShipmentId	String	Identifies the sub shipments within a single shipment.
subShipments. courierDetails. pickupDetails. vendorName	String	Vendor name picking up the shipment from seller location
subShipments. courierDetails. pickupDetails. trackingId	String	Pick up courier tracking id
subShipments. courierDetails. deliveryDetails. vendorName	String	Vendor name delivering shipment to customer from mother hub
subShipments. courierDetails. deliveryDetails. trackingId	String	Delivery tracking id
subShipments. shipmentDimensions. length	Float	Length of the sub-shipment
subShipments. shipmentDimensions. breadth	Float	Breadth of the sub-shipment
subShipments. shipmentDimensions. height	Float	Height of the sub-shipment
subShipments. shipmentDimensions. weight	Float	Weight of the sub-shipment
sellerAddress. sellerName	String	Seller name as in the Seller’s Address
sellerAddress. pincode	String	Pincode in the Seller’s address
sellerAddress. city	String	City in the Seller’s address
sellerAddress. stateName	String	Name of the state in the Seller’s address
sellerAddress. addressLine1	String	Address Line 1 in the Seller’s address
sellerAddress. addressLine2	String	Address Line 2 in the Seller’s address
sellerAddress. stateCode	String	State Code in the Seller’s address
sellerAddress. state	String	State in which seller address located.
sellerAddress. landmark	String	Landmark in the Seller’s address
billingAddress. firstName	String	First Name of the recipient of the Bill.
billingAddress. lastName	String	Last Name of the recipient of the Bill.
billingAddress. pincode	String	Pincode in the Billing Address.
billingAddress. city	String	City in the Billing Address.
billingAddress. stateName	String	StateName in the Billing Address
billingAddress. addressLine1	String	Address Line 1 in the Billing Address.
billingAddress. addressLine2	String	Address Line 2 in the Billing Address.
billingAddress. stateCode	String	State Code in the Billing Address
billingAddress. state	String	State name of billing address
billingAddress. landmark	String	Landmark in the Billing Address
billingAddress. contactNumber	String	Contact Number in the Billing Address
buyerDetails. firstName	String	First Name of the Buyer
buyerDetails. lastName	String	Last Name of the Buyer
orderItems. large	Boolean	True or False indicating shipment is large
orderItems. dangerous	Boolean	True or False indicating shipment is dangerous
orderItems. id	Boolean	Order item id inside the shipment
orderItems. fragile	Boolean	True or False indicating shipment is fragile
returnAddress. firstName	String	First Name of the person to whom the items have to be returned to, if not delivered, as mentioned in the Return Address.
returnAddress. lastName	String	Last Name of the person to whom the items have to be returned to, if not delivered, as mentioned in the Return Address.
returnAddress. pincode	String	Pincode in the Return Address
returnAddress. city	String	City in the Return Address
returnAddress. addressLine1	String	Address Line 1 in the Return Address
returnAddress. addressLine2	String	Address Line 2 in the Return Address
returnAddress. stateCode	String	State Code in the Return Address
returnAddress. state	String	State name where shipment has to be returned
returnAddress. landmark	String	Landmark in the Return Address

Validations

shipmentIds: should be valid shipment ids for this seller
Maximum 100 shipments per request.

Possible Error Response Codes

Error Codes	Reason for Error
DEPENDENT_SYSTEM_CALL_FAILED	Error in getting shipment details for the shipment
UNPROCESSABLE_ENTITY	When more than processable shipments are received.

Try it out!