Parameters
| Query parameter | Meaning | Example |
|---|---|---|
invoiceNumber | The Airlift invoice number. | INV-12345 |
Send Authorization: Bearer <token> with every request. The token comes from the OAuth 2.0 client credentials flow and must carry the invoice:read scope.
Example request
curl 'https://api.airliftusa.com/api/v1/api-service/external/invoice?invoiceNumber=INV-12345' \
--header 'Authorization: Bearer YOUR_TOKEN'Example response (200)
{
"invoice_number": "INV-12345",
"date": "2024-01-20",
"hbl_number": "HBL12345",
"container_no": "CMAU1234567",
"payment_type": "PREPAID",
"rate_list": [
{ "type": "FREIGHT", "rate_description": "Ocean Freight", "rate": 3000, "exchange_rate": 1, "cgst_in": 270, "sgst_in": 270, "igst_in": 0, "collections": "COLLECTED" }
],
"taxable_amount": 5000,
"non_taxable_amount": 1000.5,
"cgst": 450,
"sgst": 450,
"igst": 0,
"total": 5900.5,
"e_invoice_status": "ISSUED",
"hbl_release_status": "RELEASED",
"bl_release_request": "APPROVED",
"remarks": "Freight charges"
}- total is taxable_amount plus the tax components plus non_taxable_amount.
- e_invoice_status reports whether an e-invoice has been issued for the document.
Other status codes: 400 missing or invalid parameter, 401 token missing or expired, 403 scope not granted, 404 nothing matches the reference, 500 server error. Limits are 60 requests a minute and 4,000 an hour per consumer, reported in the X-RateLimit-* headers.
Frequently asked questions
Where do I get the invoice number?
From the invoices list endpoint, from the invoice PDF, or from the customer portal.
Is the amount in USD?
The record carries the rate and an exchange_rate per charge line; the currency follows the invoice as issued. Check exchange_rate before summing lines across invoices.
Other endpoints
- GET /trackntrace · Track & Trace Events
- GET /booking · Ocean Booking
- POST /bookings · Ocean Booking Service
- GET /documents · Commercial Shipping Documents
- GET /invoices · Invoices Data Service
- All API documentation
- Free tariff API
Need access? Register your application in the developer portal; the API is open to approved Airlift customers.