Zippyy REST APIs
    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

    Introduction

    Welcome to the Zippyy API Integration Guide, designed for partners who want to add order fulfillment functionality to their e-commerce platforms.
    This guide helps product managers understand the use cases Zippyy's API will handle, and provides engineers with the details needed to build integrations.
    Zippyy’s API is trusted by leading e-commerce platforms to streamline shipping and improve customer experience. With our API, you can:
    Access the best shipping rates
    Print shipping labels
    Track packages

    📌 Guide Overview#

    This document is divided into the following sections:
    1.
    Prerequisites – Tools and knowledge required for integration
    2.
    Foundational Decisions – Handling shipping accounts and UI ownership
    3.
    API Documentation – Endpoints, parameters, methods, and responses
    4.
    Integration Steps – Authentication, error handling, and security
    5.
    Best Practices – Code samples, performance optimization, and edge cases
    6.
    Testing & Debugging – How to test endpoints and troubleshoot issues

    🚀 Getting Started#

    1.
    Register with Zippyy
    Create an account by clicking the sign-up link.
    2.
    API Environments
    Sandbox URL: https://sandbox.sellingpartnerapi-in.zippyy.ai
    Production URL: https://sellingpartnerapi-in.zippyy.ai
    3.
    Postman Support
    You can import and test the full API collection in Postman. Click the Run in Postman button inside the docs.
    ⚠️ Note: Any requests made with valid API credentials affect real-time data in your Zippyy account.

    📄 Document & API Usage Guidelines#

    Our APIs follow REST architecture and use JSON for requests and responses.
    Supported HTTP methods:
    POST
    GET
    PUT
    PATCH
    Authorization:
    Example API responses include:
    Successful Call → The API call was correct.
    Invalid Data → Some input data is invalid.
    Missing Fields → Required fields were not included.
    Wrong Format → Request syntax is incorrect.

    ⚠️ Errors & Response Codes#

    Below are the most common HTTP status codes returned by Zippyy APIs:
    Response CodeDescription
    200 / 202OK / Accepted – Request worked as expected. Some APIs may still return validation errors.
    400Bad Request – The request was invalid or cannot be served.
    401Unauthorized – Token or credentials are invalid.
    404Not Found – The URI or resource requested does not exist.
    405Method Not Allowed – Wrong HTTP method used.
    422Unprocessable Entity – Request contains incorrect syntax.
    429Too Many Requests – API rate limit exceeded.
    500 / 502 / 503 / 504Server Errors – Internal or temporary issues on Zippyy’s side.

    🚚 Carrier & Service Levels#

    Zippyy supports multiple logistics partners with various service levels. Below is the list of carriers and their available services:
    CarrierService Levels
    DTDCB2C SMART EXPRESS, B2C PRIORITY
    DelhiverySurface, Express, Surface 250gm
    EcomExpress
    XpressbeesSurface Xpressbees 0.5 K.G, Xpressbees 1 K.G, Xpressbees 2 K.G, Xpressbees 5 K.G, Xpressbees 10 K.G, Air Xpressbees 0.5 K.G, Xpressbees Same Day Delivery, Xpressbees Next Day Delivery, Express Reverse
    DTDC-B2BSURFACE ECONOMY, SURFACE EXPRESS, AIR CARGO, EXPRESS, STANDARD_AIR, GROUND_EXPRESS, B2B SMART EXPRESS, B2C PRIORITY, B2C SMART EXPRESS, COD, PRIORITY
    BluedartSurface, Air, Surface 1.5kg
    ATSAmazon Shipping Standard, Amazon Shipping Express (Ground) - Forward, Amazon Shipping Express (Ground) - Reverse, Amazon Shipping Air - Forward, Amazon Shipping Air - Reverse
    ZippyyBluedartSurface, Air, Plus Surface
    ZippyyxEkartSurface 0.5kg, Surface 1.0kg
    EkartPremiumSurface 2.0kg
    ShadowfaxSurface
    BlitzSurface 0.5kg, Air 0.5kg, Surface 2.0kg, Air 2.0kg
    Modified at 2025-10-09 10:48:31
    Next
    Authentication API
    Built with