Getting started

1. Create an API key in Velocity

In the Velocity dashboard open Settings → API Keys, press Generate API Key, give it a name such as cartwhizz and an expiry date, and copy the key. Velocity shows it only once.

2. Connect it in CartWhizz

1. Open Logistics → Carrier Accounts and find Velocity.
2. Paste the key into API Key and enter your Pickup Pincode.
3. Fill in the pickup address: warehouse name, street, city, state, contact person, phone and email. GST number is optional.
4. Turn on Enabled and press Save.

CartWhizz checks the key with Velocity before saving. A wrong or expired key is refused with a message, and nothing is saved. The key is stored encrypted and is never shown again.

Your pickup warehouse is registered with Velocity once, the first time you save with dry-run off. Velocity cannot edit or delete a warehouse, so CartWhizz keeps the warehouse ID it gets back and never registers it twice. If your warehouse already exists in Velocity, paste its ID into Velocity warehouse ID instead.

3. Show Velocity rates at checkout

Open Logistics → Shipping, create or edit a shipping method, choose carrier Velocity and rate calculation Realtime (Carrier API). The shopper then sees the cheapest Velocity courier price and delivery time for their pincode. If Velocity cannot quote (an unserviceable pincode, or Velocity is down), your other shipping methods still show.

4. Set up tracking updates (webhook)

1. Open Logistics → Velocity → Settings and copy the Webhook URL.
2. In Velocity open Settings → Webhooks, add the URL, choose HMAC as the authentication method and enter a long random secret (32 characters or more).
3. Back on Carrier Accounts, paste the same secret into Webhook secret and save. Once a secret is saved, CartWhizz ignores any webhook that is not signed with it.
4. Velocity does not publish the name of the header that carries the signature. Ask Velocity support or your account manager, and enter it in Webhook signature header if it is not X-Velocity-Signature.

If you pick API Key or Custom Header in Velocity instead of HMAC, enter that header's name in Webhook signature header and its value as the Webhook secret.

CartWhizz also asks Velocity for the latest status of active shipments about every 15 minutes, so tracking keeps working if a webhook is missed. Velocity switches a webhook off after 5 failed deliveries; switch it back on in Settings → Webhooks if that happens.