API docs · v1
Create shipments, get labels, track parcels
The Global Cross-Border Intelligence (GXBiQ) API lets you create shipments with their parcel and item details, receive a label for each parcel and read the tracking history of a shipment. All requests and responses are JSON.
curl -X POST 'https://api.gxbiq.com/api/v1/Authenticate/ClientLogin' \
-H 'Content-Type: application/json' \
--data '{
"username": "testusername",
"password": "******"
}'Quickstart
- 01
Get your credentials
Your account manager gives you a username and password, and the service codes your account can use.
- 02
Sign in for a token
Call Client login with your username and password. You get a bearer access token that is valid for 4 hours.
- 03
Process shipments
Call Process shipments with up to 100 shipments and an
Idempotency-Keyheader, so you can retry safely.
Endpoints
Guides
- GuideOverviewWhat the API does, how requests work and how to send your first shipment.
- GuideAuthenticationSign in with your credentials and send the access token on each request.
- GuideIdempotency and retriesRetry shipment requests safely without creating shipments twice.
- GuideLimitsBatch sizes, token lifetime, key format and timing.
- GuideResponse codesWhat each HTTP status from the shipment endpoint means, with examples.
- GuideError messagesMessages returned in customResponse.errorMessage, what causes them and what to do.
Versions
| Version | Status | Base path | Docs | Spec |
|---|---|---|---|---|
| v1 | Latest | /api/v1 | Read the v1 docs | Download openapi.yaml |