Zippyy REST APIs
  1. Shipments
Zippyy REST APIs
  • Introduction
  • Authentication API
    • Generate Token
      POST
  • Couriers
    • Check Courier Serviceability
      GET
    • Quick Quote
      POST
    • Forward Shipment (V2)
      POST
    • Forward Shipment
      POST
  • Shipments
    • Get Details of Specific Shipment
      GET
    • Generate Label
      GET
    • Generate Label Url
      GET
    • Cancel a Shipment
      PUT
    • Generate Invoice
      GET
  • Tracking
    • Get Tracking Details
      GET
    • Webhook
      POST
  • NDR
    • Action NDR
      PUT
  • Warehouse
    • Get Warehouse
      GET
    • List of Warehouse details
      GET
    • Create new Warehouse
      POST
    • Update existing warehouse properties
      PUT
  1. Shipments

Get Details of Specific Shipment

GET
/v1/external/shipments

Get Shipment Details#

This endpoint retrieves shipment details for specific shipment based on the provided orderIds. It allows users to access comprehensive information about shipments, including payment details, parcel dimensions, tracking information, and rates from different carriers. This is particularly useful for tracking shipments and managing logistics effectively.

Request Format#

Method: GET
Endpoint: {{base_url}}/v1/external/shipments?orderIds=ord_64bee9263e8d31b196063c24b190e594

Request Parameters#

orderIds (string, required): A comma-separated list of order IDs for which shipment details are being requested. For example, ord_64bee9263e8d31b196063c24b190e594.

Response Structure#

On a successful request, the API returns a JSON array of shipment objects with the following structure:
id (string): Unique identifier for the shipment.
orderId (string): ID of the associated order.
orderNumber (string): The order number linked to the shipment.
shipmentPaymentDetails (object): Contains payment-related information:
orderType (string): Type of the order.
subTotal (number): Subtotal amount for the shipment.
shippingCharges (number): Charges for shipping.
otherCharges (number): Any additional charges.
discount (number): Discount applied to the order.
ndr_action_requested (boolean): Indicates if a non-delivery report action has been requested.
tenantId (string): Identifier for the tenant.
shipmentSourceCode (string|null): Source code for the shipment.
orderSourceCode (string): Source code for the order.
countryCode (string): Country code for the shipment.
options (object): Additional options for the shipment:
currency (string): Currency used for the shipment.
status (string): Current status of the shipment.
subStatus (string): Sub-status of the shipment.
payments (object): Information about payment status:
status (string): Current payment status.
refId (string): Reference ID for the payment.
amount (string): Amount paid.
currency (string): Currency of the payment.
updatedAt (string|null): Timestamp of the last update.
parcel (object): Details about the parcel:
id (string|null): Identifier for the parcel.
length (number): Length of the parcel.
width (number): Width of the parcel.
height (number): Height of the parcel.
dimensionUnit (string): Unit of measurement for dimensions.
weight (number): Weight of the parcel.
weightUnit (string): Unit of measurement for weight.
predefined_package (string|null): Predefined package type.
package_code (string|null): Code for the package.
trackingCode (string): Tracking code for the shipment.
fromAddress (object): Address from which the shipment is sent.
toAddress (object): Address to which the shipment is sent.
rates (array): List of available rates from different carriers.
selectedRate (object): Rate selected for the shipment.
cheapestRate (object): Cheapest available rate.
fastestDelivery (object): Fastest delivery option available.
refundStatus (string|null): Status of any refund requests.
postageLabel (object): Information about the postage label.
pickupStatus (string): Status of the pickup.
customsInfo (object|null): Information regarding customs.
updatedAt (string): Timestamp of the last update.
metadata (object): Additional metadata related to the shipment.

Notes#

Ensure that the orderIds parameter is correctly formatted as a comma-separated list.
The response may contain null values for optional fields; handle these cases appropriately in your application.

Request

Query Params

Header Params

Responses

🟢200200 OK - Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/external/shipments?orderIds=ord_64bee9263e8d31b196063c24b190e594' \
--header 'Authorization: {{auth_token}}'
Response Response Example
[
    {
        "id": "shp_9e05a6cbe1954583943e69e4b4a52608",
        "orderId": "ord_64bee9263e8d31b196063c24b190e594",
        "orderNumber": "ORDOPOYeeYrrPEW15426551",
        "shipmentPaymentDetails": {
            "orderType": "PREPAID",
            "subTotal": 0,
            "shippingCharges": 0,
            "otherCharges": 0,
            "discount": 0
        },
        "ndr_action_requested": false,
        "tenantId": "3f6fd6ba-46fc-4b69-b374-2fae758c025b",
        "shipmentSourceCode": null,
        "orderSourceCode": "zippyy",
        "countryCode": "IN",
        "options": {
            "currency": "INR"
        },
        "status": "pre_transit",
        "subStatus": "pre_transit",
        "payments": {
            "status": "completed",
            "refId": "pmnt_82a9b59365474b1eb7e7536c9f795807",
            "amount": "170.04",
            "currency": "INR",
            "updatedAt": null
        },
        "parcel": {
            "id": null,
            "length": 10,
            "width": 10,
            "height": 10,
            "dimensionUnit": "cm",
            "weight": 1,
            "weightUnit": "kg",
            "predefined_package": null,
            "package_code": null
        },
        "trackingCode": "6901910800984",
        "fromAddress": {
            "name": "Koushik",
            "company": "Koushik mondal",
            "emailAddress": "koushik@godash.ai",
            "phoneNumber": "9000755025",
            "addressLine1": "Bonsai ArbourTellapur Rd",
            "addressLine2": null,
            "state": "Telangana",
            "city": "K.V.Rangareddy",
            "postalCode": "500032",
            "country": "India",
            "ref": "8cf79c58121f8b24f8acc904d7e80c5f"
        },
        "toAddress": {
            "name": "Aditya Singh",
            "company": "Aditya Singh ",
            "emailAddress": "aditya.singh@godash.ai",
            "phoneNumber": "9000755025",
            "addressLine1": "Vaishnav Villa CHS, Bunglow No. 1, Thakur Complex, Western Express Hwy",
            "addressLine2": null,
            "state": "Maharashtra",
            "city": "Mumbai",
            "postalCode": "400001",
            "country": "India",
            "ref": null
        },
        "rates": [
            {
                "id": "rate_fc351c0b1efe4b46a5f9e191cf29cc3c",
                "object": "Rate",
                "created_at": 1750080714549,
                "updated_at": 1750080714549,
                "carrierService": "Surface",
                "forwardFreightCharges": "170.04",
                "codCharges": "0.00",
                "rtoCharges": "170.04",
                "zone": "D2",
                "carrier": "Delhivery",
                "pod_name": null,
                "type": "B2C",
                "service": "Surface",
                "rate": "170.04",
                "currency": "INR",
                "delivery_days": 0,
                "delivery_date": null,
                "est_delivery_days": 5,
                "shipmentId": null,
                "carrier_account_id": "ca_4f2f16747aec6830001b70a93a3d2df2",
                "billingType": null,
                "message": null,
                "earliest_pickup_date": "17-06-2025",
                "min_chargeable_weight": null,
                "charged_weight": "1.00"
            },
            {
                "id": "rate_279f350f0c274f0f8ee86932e81308de",
                "object": "Rate",
                "created_at": 1750080714582,
                "updated_at": 1750080714582,
                "carrierService": "Plus Surface",
                "forwardFreightCharges": "92.16",
                "codCharges": "0.00",
                "rtoCharges": "92.16",
                "zone": "z_c",
                "carrier": "ZippyyBluedart",
                "pod_name": null,
                "type": "B2B",
                "service": "Plus Surface",
                "rate": "92.16",
                "currency": "INR",
                "delivery_days": 0,
                "delivery_date": null,
                "est_delivery_days": 3,
                "shipmentId": null,
                "carrier_account_id": "ca_9ff84ee363a8ee5542348c8826cb1780",
                "billingType": null,
                "message": null,
                "earliest_pickup_date": null,
                "min_chargeable_weight": null,
                "charged_weight": "1.00"
            },
            {
                "id": "rate_53b1a67411c94d0283a232263f130d4a",
                "object": "Rate",
                "created_at": 1750080714582,
                "updated_at": 1750080714582,
                "carrierService": "Air",
                "forwardFreightCharges": "92.16",
                "codCharges": "0.00",
                "rtoCharges": "92.16",
                "zone": "z_c",
                "carrier": "ZippyyBluedart",
                "pod_name": null,
                "type": "B2B",
                "service": "Air",
                "rate": "92.16",
                "currency": "INR",
                "delivery_days": 0,
                "delivery_date": null,
                "est_delivery_days": 3,
                "shipmentId": null,
                "carrier_account_id": "ca_9ff84ee363a8ee5542348c8826cb1780",
                "billingType": null,
                "message": null,
                "earliest_pickup_date": null,
                "min_chargeable_weight": null,
                "charged_weight": "1.00"
            }
        ],
        "selectedRate": {
            "id": "rate_fc351c0b1efe4b46a5f9e191cf29cc3c",
            "object": "Rate",
            "created_at": 1750080714549,
            "updated_at": 1750080714549,
            "carrierService": "Surface",
            "forwardFreightCharges": "170.04",
            "codCharges": "0.00",
            "rtoCharges": "170.04",
            "zone": "D2",
            "carrier": "Delhivery",
            "pod_name": null,
            "type": "B2C",
            "service": "Surface",
            "rate": "170.04",
            "currency": "INR",
            "delivery_days": 0,
            "delivery_date": null,
            "est_delivery_days": 5,
            "shipmentId": null,
            "carrier_account_id": "ca_4f2f16747aec6830001b70a93a3d2df2",
            "billingType": null,
            "message": null,
            "earliest_pickup_date": "17-06-2025",
            "min_chargeable_weight": null,
            "charged_weight": "1.00"
        },
        "cheapestRate": {
            "id": "rate_279f350f0c274f0f8ee86932e81308de",
            "object": "Rate",
            "created_at": 1750080714582,
            "updated_at": 1750080714582,
            "carrierService": "Plus Surface",
            "forwardFreightCharges": "92.16",
            "codCharges": "0.00",
            "rtoCharges": "92.16",
            "zone": "z_c",
            "carrier": "ZippyyBluedart",
            "pod_name": null,
            "type": "B2B",
            "service": "Plus Surface",
            "rate": "92.16",
            "currency": "INR",
            "delivery_days": 0,
            "delivery_date": null,
            "est_delivery_days": 3,
            "shipmentId": null,
            "carrier_account_id": "ca_9ff84ee363a8ee5542348c8826cb1780",
            "billingType": null,
            "message": null,
            "earliest_pickup_date": null,
            "min_chargeable_weight": null,
            "charged_weight": "1.00"
        },
        "fastestDelivery": {
            "id": "rate_279f350f0c274f0f8ee86932e81308de",
            "object": "Rate",
            "created_at": 1750080714582,
            "updated_at": 1750080714582,
            "carrierService": "Plus Surface",
            "forwardFreightCharges": "92.16",
            "codCharges": "0.00",
            "rtoCharges": "92.16",
            "zone": "z_c",
            "carrier": "ZippyyBluedart",
            "pod_name": null,
            "type": "B2B",
            "service": "Plus Surface",
            "rate": "92.16",
            "currency": "INR",
            "delivery_days": 0,
            "delivery_date": null,
            "est_delivery_days": 3,
            "shipmentId": null,
            "carrier_account_id": "ca_9ff84ee363a8ee5542348c8826cb1780",
            "billingType": null,
            "message": null,
            "earliest_pickup_date": null,
            "min_chargeable_weight": null,
            "charged_weight": "1.00"
        },
        "refundStatus": null,
        "postageLabel": {
            "id": null,
            "createdAt": "1750080721480",
            "updatedAt": "1750080721480",
            "pdfUrl": null,
            "labelZplUrl": null,
            "labelEpl2Url": null
        },
        "pickupStatus": "pending",
        "customsInfo": null,
        "updatedAt": "1750080721480",
        "ndrLineItemList": null,
        "shipmentPurchaseError": null,
        "tags": "test",
        "deliveryAttempts": null,
        "orderManifestStatus": "MANIFEST_PENDING",
        "orderManifestId": null,
        "sourceCreatedAt": "1749908939",
        "orderStoreId": "zippyy",
        "metadata": {
            "carrierShipmentId": null,
            "waybill": "6901910800984",
            "carrierOrderId": "ORDOPOYeeYrrPEW15426551|1750080719878",
            "productDetails": "[{\"productName\":\"test Product\",\"price\":100.0,\"quantity\":1,\"category\":\"books\",\"currencyCode\":\"INR\",\"sku\":\"testsku\",\"taxRate\":0.0,\"discount\":0.0,\"taxesIncluded\":true}]"
        }
    }
]
Modified at 2025-08-04 19:55:15
Previous
Shipments
Next
Generate Label
Built with