Amberai · Schema

Shipments

CompanyArtificial IntelligenceOperating SystemAutomationSupply Chain

Properties

Name Type Description
id string
shipmentCode string
status string
trackingNumber stringnull
carrier stringnull
carrierSlug stringnull
freightForwarder stringnull
shipmentMode stringnull
containerNumbers array
totalPacks numbernull
grossWeightValue stringnull
grossWeightUom stringnull
volumeValue stringnull
volumeUom stringnull
incoterm stringnull
incotermLocation stringnull
targetShipDate stringnull
agreedShipDate stringnull
revisedShipDate stringnull
actualShipDate stringnull
agreedPickupDate stringnull
revisedPickupDate stringnull
actualPickupDate stringnull
estimatedPortArrivalDate stringnull
actualPortArrivalDate stringnull
targetArrivalDate stringnull
estimatedArrivalDate stringnull
customsClearedDate stringnull
customsClearedDateSource stringnull
actualArrivalDate stringnull
actualArrivalDateSource stringnull
cargoReadyDate stringnull
bookingReceivedDate stringnull
houseBillNumber stringnull
masterBillNumber stringnull
estimatedCost stringnull
finalCost stringnull
customsCost stringnull
costCurrency stringnull
conveyanceReference stringnull
loadType stringnull
loadUtilization stringnull
originId object
dischargeLocationId object
destinationId object
pickupLocationId object
source stringnull
externalShipmentId stringnull
externalStatus stringnull
externalBookingReference stringnull
lastEventOccurredAt stringnull
brandOwnerId object
customFields object
createdAt string
updatedAt string
View JSON Schema on GitHub

JSON Schema

amberai-shipments-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amberai/main/json-schema/amberai-shipments-schema.json",
  "title": "Shipments",
  "x-generated": "2026-10-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amberai-openapi.json#/components/schemas/Shipments",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    },
    "shipmentCode": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "trackingNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "carrier": {
      "type": [
        "string",
        "null"
      ]
    },
    "carrierSlug": {
      "type": [
        "string",
        "null"
      ]
    },
    "freightForwarder": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipmentMode": {
      "type": [
        "string",
        "null"
      ]
    },
    "containerNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "totalPacks": {
      "type": [
        "number",
        "null"
      ]
    },
    "grossWeightValue": {
      "type": [
        "string",
        "null"
      ]
    },
    "grossWeightUom": {
      "type": [
        "string",
        "null"
      ]
    },
    "volumeValue": {
      "type": [
        "string",
        "null"
      ]
    },
    "volumeUom": {
      "type": [
        "string",
        "null"
      ]
    },
    "incoterm": {
      "type": [
        "string",
        "null"
      ]
    },
    "incotermLocation": {
      "type": [
        "string",
        "null"
      ]
    },
    "targetShipDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "agreedShipDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "revisedShipDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "actualShipDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "agreedPickupDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "revisedPickupDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "actualPickupDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "estimatedPortArrivalDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "actualPortArrivalDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "targetArrivalDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "estimatedArrivalDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "customsClearedDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "customsClearedDateSource": {
      "type": [
        "string",
        "null"
      ]
    },
    "actualArrivalDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "actualArrivalDateSource": {
      "type": [
        "string",
        "null"
      ]
    },
    "cargoReadyDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "bookingReceivedDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "houseBillNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "masterBillNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "estimatedCost": {
      "type": [
        "string",
        "null"
      ]
    },
    "finalCost": {
      "type": [
        "string",
        "null"
      ]
    },
    "customsCost": {
      "type": [
        "string",
        "null"
      ]
    },
    "costCurrency": {
      "type": [
        "string",
        "null"
      ]
    },
    "conveyanceReference": {
      "type": [
        "string",
        "null"
      ]
    },
    "loadType": {
      "type": [
        "string",
        "null"
      ]
    },
    "loadUtilization": {
      "type": [
        "string",
        "null"
      ]
    },
    "originId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "dischargeLocationId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "destinationId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "pickupLocationId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "source": {
      "type": [
        "string",
        "null"
      ]
    },
    "externalShipmentId": {
      "type": [
        "string",
        "null"
      ]
    },
    "externalStatus": {
      "type": [
        "string",
        "null"
      ]
    },
    "externalBookingReference": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastEventOccurredAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "brandOwnerId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "customFields": {
      "anyOf": [
        {
          "$ref": "#/$defs/__schema0"
        },
        {
          "type": "null"
        }
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "shipmentCode",
    "status",
    "trackingNumber",
    "carrier",
    "carrierSlug",
    "freightForwarder",
    "shipmentMode",
    "containerNumbers",
    "totalPacks",
    "grossWeightValue",
    "grossWeightUom",
    "volumeValue",
    "volumeUom",
    "incoterm",
    "incotermLocation",
    "targetShipDate",
    "agreedShipDate",
    "revisedShipDate",
    "actualShipDate",
    "agreedPickupDate",
    "revisedPickupDate",
    "actualPickupDate",
    "estimatedPortArrivalDate",
    "actualPortArrivalDate",
    "targetArrivalDate",
    "estimatedArrivalDate",
    "customsClearedDate",
    "customsClearedDateSource",
    "actualArrivalDate",
    "actualArrivalDateSource",
    "cargoReadyDate",
    "bookingReceivedDate",
    "houseBillNumber",
    "masterBillNumber",
    "estimatedCost",
    "finalCost",
    "customsCost",
    "costCurrency",
    "conveyanceReference",
    "loadType",
    "loadUtilization",
    "originId",
    "dischargeLocationId",
    "destinationId",
    "pickupLocationId",
    "source",
    "externalShipmentId",
    "externalStatus",
    "externalBookingReference",
    "lastEventOccurredAt",
    "brandOwnerId",
    "customFields",
    "createdAt",
    "updatedAt"
  ],
  "additionalProperties": false,
  "$defs": {
    "__schema0": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/__schema0"
          }
        },
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "$ref": "#/$defs/__schema0"
          }
        }
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amberai-shipments"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.