Copy page

Core

AWB Generation

You can let Shadowfax assign an AWB automatically at order creation, or pre-generate AWB numbers and pass one in order_details.awb_number when you place the order. Two endpoints cover this, and they behave differently — pick based on what you need.

Pool Replenishment (Conditional)

Requests a batch of AWBs, topped up from your existing unused pool. If you already have enough unused AWBs sitting idle, this can return those instead of minting new ones — it only generates fresh numbers when your unused pool is below the requested count.

Code
curl -X POST https://dale.staging.shadowfax.in/api/v3/clients/generate_marketplace_awb/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{"count": 10}'

Code
{
  "message": "Success",
  "awb_numbers": ["SF10000001", "SF10000002"]
}

count defaults to 10, max 100,000 per call. Use this when you just need a working pool of AWBs on hand and don't care whether they're brand new.

See Generate AWBs (Pool Replenishment) in the API Reference.

Fresh Generation (Always New)

Requests AWBs that are guaranteed newly minted, regardless of how many unused ones you already have. This is asynchronous — you submit a request, then poll for the result.

1. Submit the request:

Code
curl -X POST https://dale.staging.shadowfax.in/api/v1/clients/awb/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{"awb_count": 100, "request_type": "fwd"}'

Code
{
  "status": "SUCCESS",
  "request_id": 1,
  "message": "Request created successfully",
  "delay_time": 120
}

request_type is fwd or rev. awb_count defaults to 1000, max 100,000. delay_time (seconds) is how long to wait before polling — it scales with request size and how many of your requests are already queued.

2. Poll for the result:

Code
curl https://dale.staging.shadowfax.in/api/v1/clients/awb/1/ \
  -H "Authorization: Token your_api_token"

Code
{
  "awb_numbers": ["SF10000001", "SF10000002"],
  "status": "SUCCESS",
  "retry_flag": false
}

While the batch is still generating, this returns "status": "PENDING" with "retry_flag": true — wait and poll again. Use this when you specifically need guaranteed-fresh AWBs (for example, reconciling with an external system that can't tolerate reused numbers) rather than just topping up a working pool.

See Request Fresh AWBs and Poll for Result in the API Reference.