Loading developer portal
Preparing the API reference and documentation.
Loading developer portal
Preparing the API reference and documentation.
Returns the shipping label as a PDF file for the provided AWB number. The endpoint first validates that the shipment exists in the system. If the AWB is not found, a not-found response is returned.
OAuth2 In: header
application/json
application/json
application/json
Returns master location entries that match the provided search text and locale. The request is forwarded to the master-location backend service with query filters. Use this endpoint to populate location selectors and address lookups.
OAuth2 In: header
application/json
application/json
application/json
Returns location details for the provided coordinates using the selected geocoding provider. This endpoint is useful when latitude and longitude are known but address details are required. Provider-specific reverse-geocoding behavior is supported through the Provider parameter.
OAuth2 In: header
application/json
application/json
application/json
Returns territory information for the provided coordinates with optional paging and sorting. The endpoint can filter and order territory results using skip, take, and sort parameters. Use it to resolve serviceable territories from map coordinates.
OAuth2 In: header
application/json
application/json
application/json
Processes the payment gateway callback for the provided shipment reference number. It updates shipment and payment state, and triggers booking when payment is authorized or captured. After processing, the endpoint redirects the user to the configured client redirect URL.
OAuth2 In: header
application/json
application/json
application/json
Verifies payment status for the provided shipment reference number. On successful payment, it returns AWB details with label and receipt print URLs. If payment is not successful, a bad-request response is returned.
OAuth2 In: header
application/json
application/json
application/json
Returns proof of delivery information for the provided account context and AWB number. The endpoint is intended for retrieving POD details tied to shipment/account identifiers. Use it to display delivery confirmation details in client applications.
OAuth2 In: header
int32int32application/json
application/json
application/json
Validates the request payload and calculates available shipping rates. Pricing options are returned based on origin, destination, service type, and parcel attributes. Validation errors are returned when required fields or values are invalid.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Creates a shipment and applies flow logic based on shipment method. For courier shipments, it creates a payment order and returns a payment gateway URL. For postal shipments, it generates an AWB and initiates the booking process directly.
OAuth2 In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
Returns tracking events for one or more AWB numbers through guest access. A valid X-API-KEY header is required to authorize guest tracking requests. Use comma-separated AWB values to retrieve tracking data in a single call.
OAuth2 In: header
application/json
application/json
application/json
application/json
Returns tracking events for one or more AWB numbers for authenticated users. Supports single or comma-separated AWB values in one request. Use this endpoint to retrieve status timeline updates for shipments.
OAuth2 In: header
application/json
application/json
application/json
application/json
1 <= lengthValue in
Value in