Skip to main content

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

successful operation

Schema
  • shipments object[]
  • Array [
  • orderId string
  • shipmentId string
  • orderItems object[]
  • Array [
  • id string
  • fragile boolean
  • large boolean
  • dangerous boolean
  • add_ons object[]
  • Array [
  • category_label string
  • message_priority integer
  • is_rto boolean
  • message string
  • items object[]
  • Array [
  • label string
  • amount number
  • currency string
  • ]
  • ]
  • deliveryAddress object
  • firstName string
  • lastName string
  • pinCode string
  • city string
  • state string
  • stateCode string
  • addressLine1 string
  • addressLine2 string
  • landmark string
  • contactNumber string
  • billingAddress object
  • firstName string
  • lastName string
  • pinCode string
  • city string
  • state string
  • stateCode string
  • addressLine1 string
  • addressLine2 string
  • landmark string
  • contactNumber string
  • buyerDetails object
  • firstName string
  • lastName string
  • sellerAddress object
  • sellerName string
  • pinCode string
  • city string
  • state string
  • stateCode string nullable
  • addressLine1 string
  • addressLine2 string
  • landmark string nullable
  • returnAddress object
  • firstName string nullable
  • lastName string nullable
  • pinCode string nullable
  • city string nullable
  • state string nullable
  • stateCode string nullable
  • addressLine1 string nullable
  • addressLine2 string nullable
  • landmark string nullable
  • contactNumber string nullable
  • subShipments object[]
  • Array [
  • subShipmentId string
  • courierDetails object
  • pickupDetails object
  • trackingId string nullable
  • vendorName string nullable
  • deliveryDetails object
  • trackingId string nullable
  • vendorName string nullable
  • shipmentDimensions object
  • length float nullable
  • breadth float nullable
  • height float nullable
  • weight float nullable
  • ]
  • locationId string
  • ]
Loading...