subscription

CompanyContainer ShippingLogisticsMaritimeShippingSupply ChainTrack and TraceTaiwan

Properties

Name Type Description
callbackUrl string The endPoint where a Carrier whould send back events to the Shipper. The callback can contain query parameters uniquely identifying the originator of the events.
carrierBookingReference string A set of unique characters provided by carrier to identify a booking.
carrierServiceCode string The code of the service for which the schedule details are published.
documentTypeCode string
equipmentEventTypeCode string
equipmentReference string The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible.According to ISO 6346, a container identification code consists of a 4-letter pr
eventType array List of eventType to filter by. If multiple values are selected - the OR-operator will be used.



Possible values are



- SHIPMENT (Shipment events)

- TRAN
exportVoyageNumber string The vessel operator-specific identifier of the export Voyage.
secret string A shared secret shared between the Publisher and the Subscriber. It is used to compute the contents of the Notification-Signature header.Only valid in POST calls - anywhere else must be omitted
shipmentEventTypeCode string
transportCallID string The unique identifier for a transport call
transportDocumentReference string A unique number allocated by the shipping line to the transport document and the main number used for the tracking of the status of the shipment.
transportEventTypeCode string
unlocationCode string
vesselIMONumber string The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the
View JSON Schema on GitHub

JSON Schema

evergreen-marine-subscription-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/evergreen-marine/json-schema/evergreen-marine-subscription-schema.json",
  "title": "subscription",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/evergreen-marine-subscriptions-api-openapi.yml#/components/schemas/subscription",
  "type": "object",
  "properties": {
    "callbackUrl": {
      "type": "string",
      "description": "The endPoint where a Carrier whould send back events to the Shipper. The callback can contain query parameters uniquely identifying the originator of the events."
    },
    "carrierBookingReference": {
      "type": "string",
      "description": "A set of unique characters provided by carrier to identify a booking."
    },
    "carrierServiceCode": {
      "type": "string",
      "description": "The code of the service for which the schedule details are published."
    },
    "documentTypeCode": {
      "type": "string"
    },
    "equipmentEventTypeCode": {
      "type": "string"
    },
    "equipmentReference": {
      "type": "string",
      "description": "The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible.According to ISO 6346, a container identification code consists of a 4-letter prefix and a 7-digit number (composed of a 3-letter owner code, a category identifier, a serial number, and a check-digit).If a container does not comply with ISO 6346,it is suggested to follow Recommendation #2 “Container with non-ISO identification” from SMDG."
    },
    "eventType": {
      "type": "array",
      "description": "List of eventType to filter by. If multiple values are selected - the OR-operator will be used.<br/><br/><br/><br/>Possible values are<br/><br/><br/><br/> - SHIPMENT (Shipment events)<br/><br/> - TRANSPORT (Transport events)<br/><br/> - EQUIPMENT (Equipment events)<br/><br/><br/><br/>Default is none as it will not filter on eventType if not specified.",
      "items": {
        "type": "string"
      }
    },
    "exportVoyageNumber": {
      "type": "string",
      "description": "The vessel operator-specific identifier of the export Voyage."
    },
    "secret": {
      "type": "string",
      "description": "A shared secret shared between the Publisher and the Subscriber. It is used to compute the contents of the Notification-Signature header.Only valid in POST calls - anywhere else must be omitted"
    },
    "shipmentEventTypeCode": {
      "type": "string"
    },
    "transportCallID": {
      "type": "string",
      "description": "The unique identifier for a transport call"
    },
    "transportDocumentReference": {
      "type": "string",
      "description": "A unique number allocated by the shipping line to the transport document and the main number used for the tracking of the status of the shipment."
    },
    "transportEventTypeCode": {
      "type": "string"
    },
    "unlocationCode": {
      "type": "string"
    },
    "vesselIMONumber": {
      "type": "string",
      "description": "The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel"
    }
  }
}

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/evergreen-marine-subscription"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.