Logixs
API docs by Redocly

Logixs Fleet API (UAT) (1.0.0)

Download OpenAPI specification:

Logixs Developer Support: developers@logixs.cloud URL: https://logixs.cloud License: Proprietary

The Logixs Fleet API lets corporate logistics partners book shipments, quote rates, track deliveries, and reconcile invoices programmatically.

Authentication

All requests require an X-API-Key header. Keys are provisioned from the Logixs B2B dashboard and are scoped to either sandbox or live via the key prefix:

Prefix Environment
pwm_test_sk_* Sandbox (no real dispatch, no billing)
pwm_live_sk_* Live (real parcels, charged at pickup/acceptance)

You can also pass the key via Authorization: Bearer <key>.

Bulk-first design

Every write endpoint accepts a batch of up to 200 items per call. There is no single-item write endpoint — to create one shipment you send an array of one. Bulk responses use partial success: each item gets its own status, and HTTP 200 is returned even if some items fail. Inspect results[i].status to detect per-item failures.

Idempotency

Write endpoints accept an Idempotency-Key header (max 255 chars). Replays within 24 hours with the same key and body return the stored response. Same key with a different body returns 409 Conflict.

Rate limits

Request-rate limits are applied per API key:

  • Write endpoints: 60 req/min
  • Read endpoints: 300 req/min

When exceeded the response is 429 Too Many Requests with a Retry-After header.

Billing model

Shipments created via this API enter the created state and are not charged at creation. Billing applies when a parcel is physically accepted (scanned by a courier on pickup, or dropped at a postal counter).

Environments

Sandbox and live are fully isolated — objects created in one environment are invisible in the other. Sandbox is safe for development and automated tests.

System

Health checks and diagnostics

Health check

Verifies API key validity and returns the resolved environment. Use this as the first call when onboarding a new API key.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Account

B2B account profile

Get account

Returns the authenticated B2B account and its credit profile.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Rates

Rate overrides and quotes

List rate overrides

Returns currently-active rate overrides negotiated for your B2B account. Only overrides whose validFrom/validUntil window includes now() and are marked active are returned.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
serviceType
string
Enum: "postal" "courier" "ems"

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
Array of objects

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Bulk rate quote

Calculates rates for up to 200 shipment geometries in one request. B2B overrides are automatically applied. Quotes are advisory only — they are not stored and do not guarantee a price. The authoritative price is calculated at parcel acceptance (scan / pickup) time.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
required
Array of objects [ 1 .. 200 ] items

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object
required
Array of objects or objects

Request samples

Content type
application/json
{
  • "quotes": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "summary": {
    },
  • "results": [
    ]
}

Shipments

Bulk create, list, cancel

Create shipments (bulk)

Creates up to 200 shipments in one request. Each shipment enters the created state with no billing impact — the account is only charged when the parcel is physically accepted (scanned at pickup or dropped at a counter).

Idempotency: Pass an Idempotency-Key header to make retries safe. Replays within 24h with the same key + body return the same response; same key with a different body returns 409.

Partial success: Each item in the batch is processed independently. HTTP 200 is returned even if some items fail — inspect results[i].status.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required

Batch of shipments to create (1–200)

required
Array of objects [ 1 .. 200 ] items

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object
required
Array of objects or objects

Request samples

Content type
application/json
{
  • "shipments": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "summary": {
    },
  • "results": [
    ]
}

List shipments

Returns parcels owned by this B2B account in the current environment. Supports filtering by status, serviceType, and creation date range.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
status
string
serviceType
string
Enum: "postal" "courier" "ems"
from
string <date-time> ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...

ISO datetime, created after

to
string <date-time> ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...

ISO datetime, created before

page
integer ( 0 .. 9007199254740991 ]
Default: 1
limit
integer ( 0 .. 200 ]
Default: 20

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
Array of objects
required
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Get shipment

Returns details for a single shipment owned by this account.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Cancel shipments (bulk)

Cancels up to 200 shipments. Only shipments in created state can be cancelled via the API — once a parcel has been accepted by a courier or counter, cancellation requires support.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
required
Array of objects [ 1 .. 200 ] items

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object
required
Array of objects or objects

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "summary": {
    },
  • "results": [
    ]
}

Tracking

Shipment tracking lookups

Track shipment

Returns the status and event history for a single parcel by S10 or tracking number. Only parcels owned by your account are visible.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
s10
required
string

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Track shipments (bulk)

Look up status and latest event for up to 200 tracking numbers in one request. Per-item results: success with full tracking data, or error for numbers not owned by your account.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json
required
trackingNumbers
required
Array of strings [ 1 .. 200 ] items [ items [ 1 .. 50 ] characters ]

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object
required
Array of objects or objects

Request samples

Content type
application/json
{
  • "trackingNumbers": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "summary": {
    },
  • "results": [
    ]
}

Billing

Invoices

List invoices

Returns invoices for this B2B account, scoped to the current environment.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
status
string
page
integer ( 0 .. 9007199254740991 ]
Default: 1
limit
integer ( 0 .. 200 ]
Default: 20

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
Array of objects
required
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Get invoice

Returns a single invoice by id (scoped to this account).

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
success
required
boolean
Value: true
required
object

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}