API Integration Suite - Build Custom Logistics Workflows

Frequently Asked Questions

What can I build with the ProShip Shipping API suite?

The API suite covers the full shipping lifecycle: create forward and reverse shipments, generate AWBs and labels, fetch real-time tracking updates via polling or webhooks, retrieve COD remittance and invoice data, pull large datasets for custom dashboards, and receive event-driven webhook notifications. Brands use these APIs to power custom webstores, mobile apps, internal tools, and third-party integrations.

Does Prozo provide webhook notifications for shipment events?

Yes. ProShip supports event-driven webhook notifications for all major shipment lifecycle events - shipment created, picked up, in-transit, out-for-delivery, delivered, NDR flagged, RTO initiated, and returned. Webhooks push real-time data to your endpoint, eliminating the need for constant polling and enabling instant updates in your systems.

Is there a sandbox environment for testing the ProShip API?

Yes, ProShip provides a full sandbox environment with test API credentials for development and testing. The sandbox mirrors production APIs with simulated courier responses, allowing engineering teams to build, test, and validate integrations without affecting live shipments. Sandbox access is provided during onboarding along with comprehensive API documentation.

What authentication method does the ProShip API use?

The ProShip API uses token-based authentication with API keys issued per client account. Each API request requires an authorization header with the client's unique API key. Keys can be generated and revoked from the ProShip dashboard, and separate keys can be created for production and sandbox environments to maintain security boundaries between testing and live operations.

Can I create bulk shipments through the API?

Yes, the ProShip API supports bulk shipment creation through a dedicated batch endpoint that accepts multiple shipment records in a single API call. This is ideal for high-volume dispatch operations that need to process hundreds or thousands of orders programmatically. PACE automatically assigns the optimal courier for each shipment in the batch, and bulk AWB and label generation is handled in parallel.

What rate limits apply to the ProShip API?

ProShip's API rate limits are configured based on the client's plan and expected volume. Standard plans support sufficient throughput for most D2C operations, while enterprise plans offer higher rate limits for brands processing thousands of shipments per hour. Rate limit details are documented in the API reference, and the integration team can adjust limits based on specific operational requirements.

How do I retrieve COD remittance data through the API?

ProShip provides dedicated financial APIs that return COD remittance details including collection amount, delivery date, remittance cycle (D+1, D+2, or standard), settlement date, and UTR number. These APIs support date-range queries and partner-level filtering, enabling automated reconciliation with your accounting system without manual report downloads.

Can the API be used to build a custom branded tracking page?

Yes, the tracking API returns real-time shipment status with normalized milestone data that can power a fully custom branded tracking page on your website or app. The API provides current status, transit history, estimated delivery date, and courier details in a structured JSON format. Many D2C brands use this API to replace generic courier tracking pages with their own branded tracking experience.

Does the API support reverse shipment creation for returns?

Yes, the reverse shipment API allows programmatic initiation of return pickups with return reason, QC instructions, and preferred pickup date. The API integrates with ProShip's RMS for OTP verification and doorstep QC workflows. Dynamic reverse courier allocation is handled automatically, and tracking updates for reverse shipments follow the same webhook and polling patterns as forward shipments.

What error handling and response codes does the ProShip API provide?

The ProShip API returns standard HTTP status codes with detailed error objects containing error code, human-readable message, and field-level validation details. Common scenarios like invalid pincode, unsupported weight, or serviceability failure return specific error codes that enable programmatic error handling. The API documentation includes a complete error code reference with recommended resolution actions for each error type.