lazysticAPI
Sign in

Transport

Not authenticated— sign in to auto-fill your API key in code examples

Grid snapshot

POST/v1/transport/grids/snapshot

Request body

carrierIdstringrequired

The carrier whose pricing grid to retrieve.

filtersobject

Response200
{
  "ok": true,
  "grid": {
    "carrierId": "car_01HQXYZ",
    "carrierName": "Chronopost",
    "updatedAt": "2026-03-28T09:00:00Z",
    "columns": [
      {
        "key": "zone",
        "label": "Zone"
      },
      {
        "key": "weightRange",
        "label": "Weight (kg)"
      },
      {
        "key": "price",
        "label": "Price (EUR)"
      }
    ],
    "rows": [
      {
        "zone": "FR-75",
        "weightRange": "0-5",
        "price": 8.5
      },
      {
        "zone": "FR-75",
        "weightRange": "5-10",
        "price": 12.2
      },
      {
        "zone": "FR-75",
        "weightRange": "10-30",
        "price": 18.75
      }
    ]
  }
}
Response400
{
  "ok": false,
  "error": "Invalid request parameters",
  "code": "VALIDATION_ERROR",
  "details": {
    "field": "email",
    "reason": "must be a valid email address"
  }
}
Response401
{
  "ok": false,
  "error": "Authentication required",
  "code": "UNAUTHORIZED",
  "details": {}
}

Public snapshot

POST/v1/transport/grids/snapshot/public

Request body

tokenstringrequired

A share token granting access to the grid.

carrierIdstringrequired

The carrier whose pricing grid to retrieve.

filtersobject

Response400
{
  "ok": false,
  "error": "Invalid request parameters",
  "code": "VALIDATION_ERROR",
  "details": {
    "field": "email",
    "reason": "must be a valid email address"
  }
}
Response403
{
  "ok": false,
  "error": "You do not have permission to perform this action",
  "code": "FORBIDDEN",
  "details": {}
}

Import grid

POST/v1/transport/grids/import
Response200
{
  "ok": true,
  "importedRows": 1420,
  "carrierId": "car_01HQXYZ"
}
Response400
{
  "ok": false,
  "error": "Invalid request parameters",
  "code": "VALIDATION_ERROR",
  "details": {
    "field": "email",
    "reason": "must be a valid email address"
  }
}
Response401
{
  "ok": false,
  "error": "Authentication required",
  "code": "UNAUTHORIZED",
  "details": {}
}

Reference import

POST/v1/transport/grids/reference-import
Response200
{
  "ok": true,
  "importedRows": 350
}
Response400
{
  "ok": false,
  "error": "Invalid request parameters",
  "code": "VALIDATION_ERROR",
  "details": {
    "field": "email",
    "reason": "must be a valid email address"
  }
}
Response401
{
  "ok": false,
  "error": "Authentication required",
  "code": "UNAUTHORIZED",
  "details": {}
}

Invalidate cache

POST/v1/transport/cache/invalidate

Request body

carrierIdstring

Optional carrier ID to scope the invalidation.

Response200
{
  "ok": true
}
Response401
{
  "ok": false,
  "error": "Authentication required",
  "code": "UNAUTHORIZED",
  "details": {}
}

Filter values

POST/v1/transport/filters/values/public

Request body

tokenstringrequired

carrierIdstringrequired

Response200
{
  "ok": true,
  "filters": {
    "zones": [
      "FR-75",
      "FR-69",
      "FR-13",
      "BE",
      "DE"
    ],
    "serviceTypes": [
      "standard",
      "express",
      "economy"
    ],
    "weightRanges": [
      "0-1",
      "1-5",
      "5-10",
      "10-30",
      "30+"
    ]
  }
}
Response400
{
  "ok": false,
  "error": "Invalid request parameters",
  "code": "VALIDATION_ERROR",
  "details": {
    "field": "email",
    "reason": "must be a valid email address"
  }
}
Response403
{
  "ok": false,
  "error": "You do not have permission to perform this action",
  "code": "FORBIDDEN",
  "details": {}
}

Get share token

GET/v1/transport/share-tokens/:token
ParameterRequiredDescription
tokenstring
required
Response200
{
  "ok": true,
  "shareToken": {
    "id": "stk_01HQXYZ",
    "token": "stk_pub_abc123xyz",
    "name": "Client portal - Acme Corp",
    "carrierIds": [
      "car_01HQXYZ",
      "car_01HQABC"
    ],
    "expiresAt": "2026-06-30T23:59:59Z",
    "createdAt": "2026-01-15T09:00:00Z"
  }
}
Response401
{
  "ok": false,
  "error": "Authentication required",
  "code": "UNAUTHORIZED",
  "details": {}
}
Response404
{
  "ok": false,
  "error": "Resource not found",
  "code": "NOT_FOUND",
  "details": {}
}

Create share token

POST/v1/transport/share-tokens

Request body

namestringrequired

A label for this share token.

carrierIdsarray<string>required

List of carrier IDs this token grants access to.

expiresAtstring

Optional expiration date. Omit for a non-expiring token.

Response201
{
  "ok": true,
  "shareToken": {
    "id": "stk_01HQXYZ",
    "token": "stk_pub_abc123xyz",
    "name": "Client portal - Acme Corp",
    "carrierIds": [
      "car_01HQXYZ",
      "car_01HQABC"
    ],
    "expiresAt": "2026-06-30T23:59:59Z",
    "createdAt": "2026-03-31T12:00:00Z"
  }
}
Response400
{
  "ok": false,
  "error": "Invalid request parameters",
  "code": "VALIDATION_ERROR",
  "details": {
    "field": "email",
    "reason": "must be a valid email address"
  }
}
Response401
{
  "ok": false,
  "error": "Authentication required",
  "code": "UNAUTHORIZED",
  "details": {}
}