Overview

What the API does, how requests work and how to send your first shipment.

The Global Cross-Border Intelligence (GXBiQ) API lets you create shipments, receive a shipping label for each parcel and read tracking history. It uses JSON for every request and response.

What you can do

  • Sign in. Send your username and password to Client login and get a bearer access token.
  • Create shipments. Send between 1 and 100 shipments, with their parcel and item details, to Process shipments. You get a label for each parcel.
  • Track shipments. Read the events recorded for a parcel with Get tracking log.

Base URL

Every path in this version starts with this base URL:

https://api.gxbiq.com/api/v1

The version is part of the path. See Versions and changelog for every version and its support status.

Quickstart

  1. Get your credentials. Your account manager gives you a username and password, and the service codes your account can use.
  2. Sign in for a token. Call Client login. The access token is valid for 4 hours. Send it as a bearer token on every other request. See Authentication.
  3. Process shipments. Call Process shipments with your shipments and an Idempotency-Key header. If you don't get a response, send the same request again with the same key. See Idempotency and retries.

Label generation time

We produce labels through several carriers, using our own integrations, carrier APIs and third-party services. Speed depends on the carrier. Allow up to 1 second per item for label generation.