---
updatedAt: 2026-05-28T09:57:58.000Z
agentTools:
  projectIndex: https://docs.vizionapi.com/llms.txt
---

# List active references

List all `active` references, sorted by creation date (newest first).

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Endpoints",
    "description": "Real-Time Container Tracking API",
    "version": "1.12.20",
    "contact": {
      "name": "API Support",
      "email": "support@vizionapi.com"
    }
  },
  "servers": [
    {
      "url": "https://demo.vizionapi.com",
      "description": "Vizion API Demo API"
    },
    {
      "url": "https://prod.vizionapi.com",
      "description": "Vizion API Production API"
    }
  ],
  "components": {
    "securitySchemes": {
      "apikeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Account API Key"
      }
    }
  },
  "security": [
    {
      "apikeyAuth": []
    }
  ],
  "paths": {
    "/references": {
      "post": {
        "tags": [
          "References"
        ],
        "summary": "Create a new reference",
        "description": "Create a reference to begin tracking per the [configured cadence](doc:configurable-tracking-frequency).\n\nRelated docs:\n- [Quick start](doc:quick-start)",
        "operationId": "reference_create",
        "parameters": [
          {
            "in": "query",
            "name": "bypass_duplicate_check",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false,
              "description": "Create the reference even when your organization is already tracking a matching one. Requires the duplicate-override capability: without it the request is rejected with `403`, whether or not a duplicate exists. Contact support@vizionapi.com to have it enabled. Has no effect for organizations that do not have duplicate reference prevention enabled in the first place."
            }
          }
        ],
        "requestBody": {
          "description": "Reference creation parameters",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "title": "Create reference via carrier code",
                    "type": "object",
                    "description": "Add container reference for update tracking using a carrier code.",
                    "properties": {
                      "container_id": {
                        "type": "string",
                        "format": "ISO 6346",
                        "description": "Container tracking identifier.",
                        "example": "OOLU6467392"
                      },
                      "carrier_code": {
                        "type": "string",
                        "example": "CMDU",
                        "description": "A stable method of specifying carrier.\n- `ALPJ`: Allcargo Logistics\n- `ANNU`: ANL\n- `APLU`: APL\n- `CMDU`: CMA\n- `COSU`: COSCO\n- `EGLV`: Evergreen\n- `HASL`: Heung-A\n- `HDMU`: Hyundai Merchant Marine\n- `HLCU`: Hapag-Lloyd\n- `KMTU`: Korean Marine Transport Co\n- `MAEU`: Maersk\n- `MATS`: Matson\n- `MSCU`: Mediterranean Shipping Company\n- `NSRU`: Namsung\n- `ONEY`: ONEY\n- `OOCL`: OOCL\n- `PCIU`: PIL\n- `RCLU`: RCL Group\n- `SAFM`: Safmarine\n- `SEAU`: Sealand\n- `SMLM`: SM Lines\n- `SNKO`: Sinokor\n- `SUDU`: Hamburg Sud\n- `TMGB`: Teamglobal Logistics\n- `WECU`: WEC Lines\n- `WHLC`: Wan Hai\n- `WWSU`: Westwood\n- `YMLU`: Yang Ming\n- `ZIMU`: ZIM",
                        "enum": [
                          "ALPJ",
                          "ANNU",
                          "APLU",
                          "CMDU",
                          "COSU",
                          "EGLV",
                          "HASL",
                          "HDMU",
                          "HLCU",
                          "KMTU",
                          "MAEU",
                          "MATS",
                          "MSCU",
                          "NSRU",
                          "ONEY",
                          "OOCL",
                          "PCIU",
                          "RCLU",
                          "SAFM",
                          "SEAU",
                          "SMLM",
                          "SNKO",
                          "SUDU",
                          "TMGB",
                          "WECU",
                          "WHLC",
                          "WWSU",
                          "YMLU",
                          "ZIMU"
                        ]
                      },
                      "callback_url": {
                        "$ref": "#/paths/~1references/get/parameters/7/schema/items"
                      },
                      "webhooks": {
                        "type": "array",
                        "items": {
                          "title": "Webhook Subscription Input",
                          "description": "Specifies subscription details for webhook event notifications",
                          "type": "object",
                          "properties": {
                            "events": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "description": "Specifies a type of event that can be subscribed to via webhook callbacks.\n- `*`: Subscribe to all event types. When subscribed to `*`, the endpoint\n  may receive any of the lifecycle `payload_type` values listed in the\n  [Webhook Events](doc:webhook-events) docs (e.g., `reference_created`,\n  `reference_deactivated`, `extraction_succeeded`, etc.).\n- `reference_update`: Reference updates delivered when new tracking data is available. - `estimated_event_alerts`: Estimated event change alerts delivered when eta or etd values change.",
                                "enum": [
                                  "*",
                                  "reference_update",
                                  "estimated_event_alerts"
                                ]
                              }
                            },
                            "callback_url": {
                              "$ref": "#/paths/~1references/get/parameters/7/schema/items"
                            },
                            "sources": {
                              "type": "array",
                              "items": {
                                "type": "string",
                                "example": "carrier",
                                "description": "Specifies the source of the provided data. - '*': All Data Sources - 'carrier': Carrier Reported Data - 'rail': Rail Data - 'ais': AIS Data - 'terminal': Terminal Data - 'vizion': Vizion Data",
                                "enum": [
                                  "*",
                                  "carrier",
                                  "rail",
                                  "ais",
                                  "terminal",
                                  "vizion"
                                ]
                              },
                              "default": [
                                "*"
                              ]
                            }
                          },
                          "required": [
                            "events",
                            "callback_url"
                          ]
                        }
                      },
                      "tags": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references~1{referenceId}~1tags/post/requestBody/content/application~1json/schema/properties/tags/items"
                        },
                        "maxItems": 10,
                        "description": "Optional tags to associate with the reference at creation time. For Bill of Lading and Booking Number references, tags are automatically applied to each child container reference when created."
                      },
                      "criteria": {
                        "type": "object",
                        "additionalProperties": false,
                        "description": "Optional description of what you need from this reference. We use it to judge whether the reference delivered what you asked for. It does not change what we track: every reference is tracked in full either way. Only the properties listed here are accepted; a request with any other property is rejected with a 422. More kinds of criteria may be added later.",
                        "properties": {
                          "milestone_codes": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "enum": [
                                "GTOT_EMPTY",
                                "PRE_GTIN",
                                "PRE_GTOT",
                                "POL_GTIN",
                                "POL_LOAD",
                                "POL_DEPA",
                                "RTP_LOAD",
                                "RTP_DEPA",
                                "RTP_DISC",
                                "RTP_ARRI",
                                "POD_ARRI",
                                "POD_DISC",
                                "POD_GTOT",
                                "PDE_GTIN",
                                "PDE_GTOT",
                                "GTIN_EMPTY",
                                "POD_FTE",
                                "PDE_FTE",
                                "POD_AVPU",
                                "PDE_AVPU",
                                "POL_ERD",
                                "PDE_ERD"
                              ]
                            },
                            "example": [
                              "POD_DISC"
                            ],
                            "description": "The milestones you need from this reference, for example `POD_DISC` when discharge at the port of discharge is the data you are missing. Codes must come from this list, in upper case; any other value is rejected with a 422. Most are `<location>_<event>` (location `PRE`, `POL`, `RTP`, `POD`, `PDE`), and the empty-container and date codes are named as listed:\n- `GTOT_EMPTY`: empty container picked up\n- `PRE_GTIN`, `PRE_GTOT`: gate in / gate out at the place of receipt\n- `POL_GTIN`, `POL_LOAD`, `POL_DEPA`: gate in, loaded, departed at the port of loading\n- `RTP_LOAD`, `RTP_DEPA`, `RTP_DISC`, `RTP_ARRI`: loaded, departed, discharged, arrived at a transshipment port\n- `POD_ARRI`, `POD_DISC`, `POD_GTOT`: arrived, discharged, gate out at the port of discharge\n- `PDE_GTIN`, `PDE_GTOT`: gate in / gate out at the place of delivery\n- `GTIN_EMPTY`: empty container returned\n- `POD_FTE`, `PDE_FTE`: free time expires\n- `POD_AVPU`, `PDE_AVPU`: available for pickup\n- `POL_ERD`, `PDE_ERD`: earliest receiving date"
                          }
                        },
                        "example": {
                          "milestone_codes": [
                            "POD_DISC"
                          ]
                        }
                      }
                    },
                    "required": [
                      "container_id",
                      "carrier_code"
                    ]
                  },
                  {
                    "title": "Create Reference via Bill of Lading",
                    "type": "object",
                    "description": "Track a bill of lading number as the primary identifier. Providing both a `bill_of_lading` and a `booking_number` is invalid.\n\nNote that if no carrier_code is provided, the system will attempt to identify the carrier using the bill of lading number.\n\nUpon creation, the system will identify all containers belonging to the provided `bill_of_lading` and create a child container reference for each. Each child container reference will have parent reference id set as the `parent_reference_id` attribute.\n\n\nRelated docs:\n\n- [Create reference via Bill of Lading](doc:track-by-bl)\n\n- [Parent and child references](doc:parent-and-child)\n\n- [Create reference via ACI](doc:track-by-aci)\n",
                    "properties": {
                      "container_id": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/container_id"
                      },
                      "bill_of_lading": {
                        "type": "string",
                        "description": "Bill of lading issued by a carrier.",
                        "example": "CMDUSHZ5537156"
                      },
                      "carrier_code": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/carrier_code"
                      },
                      "callback_url": {
                        "$ref": "#/paths/~1references/get/parameters/7/schema/items"
                      },
                      "webhooks": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/webhooks/items"
                        }
                      },
                      "tags": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references~1{referenceId}~1tags/post/requestBody/content/application~1json/schema/properties/tags/items"
                        },
                        "maxItems": 10,
                        "description": "Optional tags to associate with the reference at creation time. For Bill of Lading and Booking Number references, tags are automatically applied to each child container reference when created."
                      },
                      "criteria": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/criteria"
                      }
                    },
                    "required": [
                      "bill_of_lading"
                    ]
                  },
                  {
                    "title": "Create Reference via Booking Number",
                    "type": "object",
                    "description": "Track a number as the primary identifier. Providing both a `bill_of_lading` and a `booking_number` is invalid.\n\nNote that if no carrier_code is provided, the system will attempt to identify the carrier using the booking number.\n\nUpon creation, the system will identify all containers belonging to the provided `booking_number` and create a container reference for each. Each child container reference will have parent reference id set as the `parent_reference_id` attribute.\n\nIf a `container_id` is provided, the system will return results for the container as it pertains to the provided `booking_number`.\n\nRelated docs:\n\n- [Create reference via Booking Number](doc:track-by-booking)\n\n- [Create reference via ACI](doc:track-by-aci)\n",
                    "properties": {
                      "container_id": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/container_id"
                      },
                      "booking_number": {
                        "type": "string",
                        "description": "The corresponding booking number issued by a carrier.",
                        "example": "CHN0443732"
                      },
                      "carrier_code": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/carrier_code"
                      },
                      "callback_url": {
                        "$ref": "#/paths/~1references/get/parameters/7/schema/items"
                      },
                      "webhooks": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/webhooks/items"
                        }
                      },
                      "tags": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references~1{referenceId}~1tags/post/requestBody/content/application~1json/schema/properties/tags/items"
                        },
                        "maxItems": 10,
                        "description": "Optional tags to associate with the reference at creation time. For Bill of Lading and Booking Number references, tags are automatically applied to each child container reference when created."
                      },
                      "criteria": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/criteria"
                      }
                    },
                    "required": [
                      "booking_number"
                    ]
                  },
                  {
                    "title": "Create Reference via ACI",
                    "type": "object",
                    "description": "\"Automatic Carrier Identification\" (ACI) attempts to find the correct steamship line and begin tracking updates.\n\n- **If a Carrier is found:** The Reference will be treated as a Reference via Carrier Code and the `carrier_code` attribute will be updated to reflect the found carrier code.\n- **If a Carrier is not found:** The Reference's `last_update_status` attribute will be set to `\"auto_carrier_not_found\"`.\n\n\nRelated docs: \n\n- [Create reference via ACI](doc:track-by-aci)\n\n---\n\n- Need fast and accurate results? Provide a `carrier_code` as seen in Create Reference via Carrier Code\n- Unsupported carriers: RCLU\n",
                    "properties": {
                      "container_id": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/container_id"
                      },
                      "bill_of_lading": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/1/properties/bill_of_lading"
                      },
                      "booking_number": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/2/properties/booking_number"
                      },
                      "callback_url": {
                        "$ref": "#/paths/~1references/get/parameters/7/schema/items"
                      },
                      "webhooks": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/webhooks/items"
                        }
                      },
                      "tags": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references~1{referenceId}~1tags/post/requestBody/content/application~1json/schema/properties/tags/items"
                        },
                        "maxItems": 10,
                        "description": "Optional tags to associate with the reference at creation time. For Bill of Lading and Booking Number references, tags are automatically applied to each child container reference when created."
                      },
                      "criteria": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/criteria"
                      }
                    },
                    "oneOf": [
                      {
                        "required": [
                          "container_id"
                        ]
                      },
                      {
                        "required": [
                          "bill_of_lading"
                        ]
                      },
                      {
                        "required": [
                          "booking_number"
                        ]
                      }
                    ]
                  },
                  {
                    "title": "Deprecated — Create Reference via SCAC",
                    "type": "object",
                    "deprecated": true,
                    "description": "**Deprecated**. Use Create New Reference via Carrier Code payload instead.\n\n---\n\nAdd container reference for update tracking using a carrier's `scac`.\n",
                    "properties": {
                      "container_id": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/container_id"
                      },
                      "scac": {
                        "type": "string",
                        "description": "A standard carrier alpha code. <<glossary:SCAC>> is a deprecated method of specifying a carrier in the Vizion API. Utilize `carrier_code` instead.",
                        "deprecated": true,
                        "example": "CGMU"
                      },
                      "callback_url": {
                        "$ref": "#/paths/~1references/get/parameters/7/schema/items"
                      },
                      "webhooks": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/webhooks/items"
                        }
                      },
                      "tags": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1references~1{referenceId}~1tags/post/requestBody/content/application~1json/schema/properties/tags/items"
                        },
                        "maxItems": 10,
                        "description": "Optional tags to associate with the reference at creation time. For Bill of Lading and Booking Number references, tags are automatically applied to each child container reference when created."
                      },
                      "criteria": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/criteria"
                      }
                    },
                    "required": [
                      "container_id",
                      "scac"
                    ]
                  }
                ]
              },
              "examples": {
                "CreateReferenceViaACI": {
                  "description": "\"Automatic Carrier Identification\" (ACI) attempts to find the correct steamship line and begin tracking updates. For faster and more accurate results, provide a carrier_code as seen in Create New Reference via Carrier Code.\n- If a Carrier is found: The Reference will be treated as a Reference via Carrier Code and the carrier_code attribute will be updated to reflect the found carrier code.\n- If a Carrier is not found: The Reference's last_update_status attribute will be set to auto_carrier_not_found.\n\nRelated docs: \n- [Auto Carrier Identification](doc:input-options#auto-carrier-identification-aci)",
                  "value": {
                    "container_id": "MEDU8381210",
                    "callback_url": "https://example.com"
                  }
                },
                "CreateBillOfLadingReference": {
                  "description": "Adds container Reference(s) for Update Payload tracking using a given Bill of Lading as the primary identifier. You cannot provide both a booking_number and bill_of_lading in the request body. In this case, the system will reject your request with a validation message indicating that only a booking_number or bill_of_lading can be provided.\n- If no container_id is included in the request body, the system will identify all containers belonging to the provided bill_of_lading and create a Reference for each identified container. In this case, each container Reference will have the reference_id of the original Bill of Lading Reference as the parent_reference_id attribute.\n- If a container_id is included in the request body, the system will will return results for the container as it pertains to the specific bill of lading.\n- If no carrier_code is provided, the system will attempt to identify the carrier using the bill of lading number.",
                  "value": {
                    "container_id": "MSDU7157882",
                    "bill_of_lading": "MEDUZ8547594",
                    "carrier_code": "MSCU",
                    "callback_url": "https://example.com"
                  }
                },
                "CreateBillOfLadingReferenceViaACI": {
                  "description": "\"Automatic Carrier Identification\" (ACI) attempts to find the correct steamship line and begin tracking updates using a bill of lading as the primary identifier.\n- If no container_id is included in the request body, the system will identify all containers belonging to the provided bill_of_lading and create a Reference for each identified container. In this case, each container Reference will have the reference_id of the original Bill of Lading Reference as the parent_reference_id attribute.\n- If a Carrier is found: The Reference will be treated as a Reference via Carrier Code and the carrier_code attribute will be updated to reflect the found carrier code.\n- If a Carrier is not found: The Reference's last_update_status attribute will be set to auto_carrier_not_found.\n- If no container_id is included in the request body, the system will identify all containers belonging to the provided bill_of_lading and create a Reference for each identified container. In this case, each container Reference will have the reference_id of the original Bill of Lading Reference as the parent_reference_id attribute.\n- Upon creation, the system will identify the carrier code for the provided bill_of_lading, then identify all containers belonging to the provided bill_of_lading and create a child container reference for each. Each child container reference will have parent reference id set as the parent_reference_id attribute.",
                  "value": {
                    "bill_of_lading": "MEDUZ8547594",
                    "callback_url": "https://example.com"
                  }
                },
                "CreateBookingNumberReference": {
                  "description": "Adds container Reference(s) for Update Payload tracking using a given booking number as the primary identifier. You cannot provide both a booking_number and bill_of_lading in the request body. In this case, the system will reject your request with a validation message indicating that only a booking_number or bill_of_lading can be provided.\n- If no container_id is included in the request body, the system will identify all containers belonging to the provided booking_number and create a Reference for each identified container. In this case, each container Reference will have the reference_id of the original Booking Number Reference as the parent_reference_id attribute.\n- If a container_id is included in the request body, the system will will return results for the container as it pertains to the specific booking number.\n- If no carrier_code is provided, the system will attempt to identify the carrier using the booking number.",
                  "value": {
                    "booking_number": 2436563,
                    "container_id": "MATU2662275",
                    "carrier_code": "MATS",
                    "callback_url": "https://example.com"
                  }
                },
                "CreateBookingNumberReferenceViaACI": {
                  "description": "\"Automatic Carrier Identification\" (ACI) attempts to find the correct steamship line and begin tracking updates using a booking number as the primary identifier.\n- If no container_id is included in the request body, the system will identify all containers belonging to the provided booking_number and create a Reference for each identified container. In this case, each container Reference will have the reference_id of the original Booking Number Reference as the parent_reference_id attribute.\n- If a Carrier is found: The Reference will be treated as a Reference via Carrier Code and the carrier_code attribute will be updated to reflect the found carrier code.\n- If a Carrier is not found: The Reference's last_update_status attribute will be set to auto_carrier_not_found.\n- Upon creation, the system will identify the carrier code for the provided booking_number, then identify all containers belonging to the provided booking_number and create a child container reference for each. Each child container reference will have parent reference id set as the parent_reference_id attribute.",
                  "value": {
                    "booking_number": 2436563,
                    "callback_url": "https://example.com"
                  }
                },
                "CreateReferenceViaCarrierCode": {
                  "description": "Add container reference for update tracking using a Carrier code.",
                  "value": {
                    "container_id": "OOLU6467392",
                    "carrier_code": "OOCL",
                    "callback_url": "https://example.com"
                  }
                },
                "CreateReferenceViaSCAC": {
                  "description": "[Deprecated] Use Create Reference via Carrier Code instead. Add container reference for update tracking using a Carrier's scac code.",
                  "value": {
                    "container_id": "MEDU8381210",
                    "scac": "MEDU",
                    "callback_url": "https://example.com"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Reference successfully created",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Result of the operation.",
                      "example": "Reference created successfully."
                    },
                    "reference": {
                      "$ref": "#/paths/~1references~1{referenceId}/get/responses/200/content/application~1json/schema"
                    }
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/paths/~1tags/get/responses/4XX"
          }
        },
        "callbacks": {
          "statusUpdate": {
            "{$request.body#/callback_url}": {
              "post": {
                "requestBody": {
                  "description": "Container reference update",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "title": "Reference Update",
                        "type": "object",
                        "properties": {
                          "id": {
                            "description": "Unique identifier of the update.",
                            "type": "string",
                            "format": "uuid",
                            "example": "6f907cf6-3dd5-489f-8bed-f65370ec6778"
                          },
                          "status": {
                            "type": "string",
                            "description": "The status of this update.\n- `data_received`: An Update was generated, saved, and optionally POSTed to a given `callback_url`.\n- `webhook_failed`: Vizion received data and built a payload but received a non 200 status code response from the provided `callback_url`.",
                            "enum": [
                              "data_received",
                              "webhook_failed"
                            ]
                          },
                          "reference_id": {
                            "$ref": "#/paths/~1references~1{referenceId}~1trace/get/responses/200/content/application~1json/schema/allOf/1/properties/reference_id"
                          },
                          "parent_reference_id": {
                            "description": "Unique identifier of the parent reference.",
                            "nullable": true,
                            "example": "6164ef3e-198b-47bb-a698-e77fbc0d9c3b",
                            "type": "string",
                            "format": "uuid"
                          },
                          "reference_tags": {
                            "type": "array",
                            "items": {
                              "title": "Tag summary",
                              "type": "object",
                              "properties": {
                                "id": {
                                  "$ref": "#/paths/~1references/get/parameters/15/schema/items"
                                },
                                "name": {
                                  "$ref": "#/paths/~1references/get/parameters/16/schema/items"
                                }
                              },
                              "required": [
                                "id",
                                "name"
                              ]
                            },
                            "description": "Tags associated with this reference at the time of the update."
                          },
                          "organization_id": {
                            "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/organization_id"
                          },
                          "payload": {
                            "type": "object",
                            "properties": {
                              "reference_id": {
                                "$ref": "#/paths/~1references~1{referenceId}~1trace/get/responses/200/content/application~1json/schema/allOf/1/properties/reference_id"
                              },
                              "bill_of_lading": {
                                "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/1/properties/bill_of_lading",
                                "description": "Associated bill of lading, if available.",
                                "nullable": true
                              },
                              "booking_number": {
                                "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/2/properties/booking_number",
                                "description": "Associated booking number, if available.",
                                "nullable": true
                              },
                              "carrier_scac": {
                                "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/4/properties/scac"
                              },
                              "container_id": {
                                "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/container_id",
                                "description": "Associated container id, if available."
                              },
                              "container_iso": {
                                "type": "string",
                                "description": "Container length, height and type."
                              },
                              "destination_port": {
                                "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/origin_port",
                                "description": "Destination port location object, if available."
                              },
                              "inland_origin": {
                                "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/origin_port",
                                "description": "Inland origin location object, if available."
                              },
                              "inland_destination": {
                                "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/origin_port",
                                "description": "Inland destination location object, if available."
                              },
                              "origin_port": {
                                "description": "Origin port location object, if available.",
                                "type": "object",
                                "properties": {
                                  "city": {
                                    "type": "string",
                                    "description": "City, if available.",
                                    "nullable": true,
                                    "example": "Duluth"
                                  },
                                  "country": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "Country, if available.",
                                    "example": "United States"
                                  },
                                  "facility": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "The facility, if available.",
                                    "example": "CN DULUTH INTERNATIONAL TERMINAL"
                                  },
                                  "geolocation": {
                                    "type": "object",
                                    "nullable": true,
                                    "description": "Coordinates, if available.",
                                    "properties": {
                                      "latitude": {
                                        "$ref": "#/paths/~1references~1{referenceId}~1trace/get/responses/200/content/application~1json/schema/allOf/1/properties/trace/items/properties/latitude",
                                        "nullable": true
                                      },
                                      "longitude": {
                                        "$ref": "#/paths/~1references~1{referenceId}~1trace/get/responses/200/content/application~1json/schema/allOf/1/properties/trace/items/properties/longitude",
                                        "nullable": true
                                      }
                                    },
                                    "required": [
                                      "latitude",
                                      "longitude"
                                    ]
                                  },
                                  "name": {
                                    "type": "string",
                                    "description": "The name of the location.",
                                    "example": "Shanghai"
                                  },
                                  "state": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "Administrative division, if available.",
                                    "example": "Minnesota"
                                  },
                                  "unlocode": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "[UNECE Location Code](https://unece.org/trade/cefact/unlocode-code-list-country-and-territory), if available.",
                                    "example": "USDLH"
                                  },
                                  "smdg_cd": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "[SMDG Terminal Code](https://smdg.org/documents/smdg-code-lists/), if available.",
                                    "example": "CNSGHSECT"
                                  },
                                  "bic_cd": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "[BIC Facility Code](https://www.bic-code.org/facility-codes/), if available.",
                                    "example": "CNSHAGIXN"
                                  },
                                  "splc_cd": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "[NMFTA Standard Point Location Code](https://nmfta.org/splc/), if available.",
                                    "example": 684800000
                                  },
                                  "firms_cd": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "[US Customs FIRMS Code](https://www.cbp.gov/document/report/acs-public-firms-code-report), if available.",
                                    "example": "SAT8"
                                  }
                                },
                                "required": [
                                  "city",
                                  "country",
                                  "facility",
                                  "geolocation",
                                  "name",
                                  "state",
                                  "unlocode"
                                ]
                              },
                              "milestones": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "timestamp": {
                                      "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at"
                                    },
                                    "location": {
                                      "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/origin_port",
                                      "description": "The location of the milestone, if available."
                                    },
                                    "description": {
                                      "type": "string",
                                      "description": "A standardized description of the milestone event; if Vizion cannot match the carrier description to a currently mapped value, the carrier description will be provided instead."
                                    },
                                    "raw_description": {
                                      "type": "string",
                                      "description": "The value reported by the carrier."
                                    },
                                    "vessel": {
                                      "$ref": "#/paths/~1references~1last-known-positions/get/responses/200/content/application~1json/schema/oneOf/1/items/properties/mode_details/properties/vessel",
                                      "format": "nullable"
                                    },
                                    "vessel_imo": {
                                      "$ref": "#/paths/~1references~1last-known-positions/get/responses/200/content/application~1json/schema/oneOf/1/items/properties/mode_details/properties/vessel_imo",
                                      "format": "nullable"
                                    },
                                    "vessel_mmsi": {
                                      "format": "nullable",
                                      "type": "string",
                                      "description": "Maritime Mobile Service Identity (MMSI) is a nine-digit number that uniquely identifies a vessel.",
                                      "example": "636019892",
                                      "nullable": true
                                    },
                                    "voyage": {
                                      "format": "nullable",
                                      "type": "string",
                                      "description": "Voyage identifier for the vessel, if available.",
                                      "nullable": true
                                    },
                                    "planned": {
                                      "type": "boolean",
                                      "description": "When set to `true` the timestamp is a planned or estimated event. When set to `false` the timestamp reflects the actual time the event occurred."
                                    },
                                    "shipment_location": {
                                      "type": "object",
                                      "description": "A DCSA Structure representing the relationship between an event and shipment locations.\n\nThis is an addon feature, for enablement and documentation see [DCSA Milestones](doc:dcsa-milestones).",
                                      "properties": {
                                        "type_code": {
                                          "type": "string",
                                          "nullable": true,
                                          "description": "Links to the Location Type Code defined by DCSA.\n- `PRE`: \"Place of receipt\" is the location where the cargo is handed over by the shipper, or his agent, to the shipping line. This indicates the point at which the shipping line takes on responsibility for carriage of the container.\n- `POL`: \"Port of loading\" is the location where the cargo is loaded onto a first sea-going vessel for water transportation.\n- `POD`: \"Port of discharge\" is the location where the cargo is discharged from the last sea-going vessel.\n- `PDE`: \"Place of delivery\" is the location where the cargo is handed over to the consignee, or his agent, by the shipping line and where responsibility of the shipping line ceases.\n- `RTP`: \"Requested transshipment port\" is the place where goods are to be or have been transferred from one means of transport to another during the course of one transport operation.",
                                          "enum": [
                                            "PRE",
                                            "POL",
                                            "POD",
                                            "PDE",
                                            "RTP"
                                          ]
                                        }
                                      }
                                    },
                                    "mode": {
                                      "type": "string",
                                      "nullable": true,
                                      "description": "Vehicle movement type if available.",
                                      "enum": [
                                        "Vessel",
                                        "Feeder",
                                        "Barge",
                                        "Trunk",
                                        "Truck",
                                        "Rail"
                                      ]
                                    },
                                    "source": {
                                      "type": "string",
                                      "enum": [
                                        "ais",
                                        "terminal",
                                        "carrier",
                                        "rail"
                                      ],
                                      "description": "Data provider for the Milestone."
                                    },
                                    "journey_event": {
                                      "title": "Journey Event",
                                      "description": "Milestone event coding in accordance with DCSA Journey Event Types. Schema is one of `EquipmentJourney`, `ShipmentJourney`, or `TransportJourney`, differentiated via `journey_type` discriminator.\n\nThis is an addon feature, for enablement and documentation see [DCSA Milestones](doc:dcsa-milestones).",
                                      "oneOf": [
                                        {
                                          "title": "Equipment Journey",
                                          "type": "object",
                                          "properties": {
                                            "journey_type": {
                                              "description": "Specifies the schema structure.\n- `EQUIPMENT`: The structure of the Equipment Journey governs the naming and understanding of events, which are driven by physical occurrences related to the equipment in question.",
                                              "enum": [
                                                "EQUIPMENT"
                                              ],
                                              "type": "string"
                                            },
                                            "event_classifier": {
                                              "type": "string",
                                              "nullable": true,
                                              "description": "The notation for describing associated timestamp.\n- `ACT`: \"Actual\" is a timestamp that indicates the point at which an event was actually completed in accordance with the definition of the relevant Event Type.\n- `PLN`: \"Planned\" is the point in time, where completion is planned to be completed in accordance with the original route or transportation plan. The time of the planned event will not change after the confirmation has been sent to the customer regardless of operational execution. The transportation plan is generated when the carrier sends the booking confirmation to the customer and will not change afterwards unless a revised plan is agreed by stakeholders.\n- `EST`: \"Estimated\" is a carrier's forecasted completion time of an Event that is covered by a confirmed booking but has not yet been completed. The estimated event is a dynamic value, which can change based on the running forecast of the completion time.",
                                              "enum": [
                                                "ACT",
                                                "PLN",
                                                "EST"
                                              ]
                                            },
                                            "event_type": {
                                              "type": "string",
                                              "nullable": false,
                                              "description": "The active occurrence for the specified container-vehicle event.\n- `AVDO`: Available for drop-off; identifies that shipment/ container is ready to be dropped off / delivered at a facility.\n- `AVPU`: Available for pick-up; identifies that shipment/ Container is ready to be picked up / collection at a facility.\n- `CUSI`: Customs selected for inspection; identifies that that Customs has selected the equipment for inspection.\n- `CUSR`: Customs released; identifies that Customs has released the equipment for either export from or import into the country.\n- `CUSS`: Customs selected for scan; identifies that Customs has selected the equipment for scanning.\n- `DISC`: Discharge; the action of lifting cargo or containers off a mode of transport. Discharge is the opposite of load.\n- `DROP`: Drop off; the action of delivering the container at customer location.\n- `GTIN`: Gate in; the action when a container is introduced into a controlled area like a port - or inland terminal. Gate in has been completed once the operator of the area is legally in possession of the container.\n- `GTOT`: Gate out; the action when a container is removed from a controlled area like a port – or inland terminal. Gate-out has been completed once the possession of the container has been transferred from the operator of the terminal to the entity who is picking up the container.\n- `INSP`: Inspected; identifies that the seal on equipment has been inspected.\n- `LOAD`: Load; the action of lifting cargo or a container on board of the mode of transportation. Load is complete once the cargo or container has been lifted on board the mode of transport and secured.\n- `PICK`: Pick up; the action of collecting the container at customer location.\n- `RMVD`: Removed; identifies that a Seal has been removed from the equipment for inspection.\n- `RSEA`: Resealed; identifies that the equipment has been resealed after inspection.\n- `STRP`: Stripping; the action of unloading cargo from containers or equipment.\n- `STUF`: Stuffing; the process of loading the cargo in a container or in/onto another piece of equipment.\n- `WAYP`: Waypoint crossed; a waypoint is an intermediate point or place during transit of shipment, waypoint crossed indicates that the equipment has crossed the particular waypoint on its transit.",
                                              "enum": [
                                                "AVDO",
                                                "AVPU",
                                                "CUSI",
                                                "CUSR",
                                                "CUSS",
                                                "DISC",
                                                "DROP",
                                                "GTIN",
                                                "GTOT",
                                                "INSP",
                                                "LOAD",
                                                "PICK",
                                                "RMVD",
                                                "RSEA",
                                                "STRP",
                                                "STUF",
                                                "WAYP"
                                              ]
                                            },
                                            "empty_indicator": {
                                              "type": "string",
                                              "nullable": true,
                                              "description": "Indicates whether the container has cargo inside at any given time.\n- `EMPTY`: Containers are considered empty once all cargo have been removed and cleaning has been performed according to carrier standards, this includes the period before stuffing occurs.\n- `LADEN`: \"Laden\" is an indicator that stuffing of container is complete, and a valid seal has been applied to the container doors. Containers are considered Laden regardless of whether the equipment has room for additional cargo. This means the container is considered Laden even if it is only stuffed with partial load. Synonym with Full (container).",
                                              "enum": [
                                                "EMPTY",
                                                "LADEN"
                                              ]
                                            },
                                            "transport_mode": {
                                              "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/milestones/items/properties/journey_event/oneOf/2/properties/transport_mode",
                                              "nullable": true
                                            },
                                            "facility_type": {
                                              "type": "string",
                                              "nullable": true,
                                              "description": "The locational context of the event being reported on.\n- `BOCR`: \"Border crossing\" is the point at a border between two countries where people, transports or goods can cross. This may or may not include a customs checkpoint.\n- `CLOC`: \"Customer location\" is the premise of the customer, who can be either the shipper or the consignee.\n- `COFS`: \"Container freight station\" is a facility where LCL (Less Than Container Load) shipments are consolidated or dispersed, cargo is stuffed into containers prior to shipment, or cargo is stripped from containers prior to release to the consignee.\n- `OFFD`: \"Off dock storage\" is an interim storage facility where empty or full containers are stored in transit.\n- `DEPO`: \"Depot\" is a designated area where empty equipment is stored between use.\n- `INTE`: \"Inland terminal\" is a facility where containers are loaded, moved, or discharged. The inland terminal can be serviced by trucks, rail, and barges (at river terminals).\n- `POTE`: \"Port terminal\" is a facility located adjacent to a waterway where containers are loaded, moved, or discharged onto/from sea-going vessels and barges.\n- `PBPL`: \"Pilot boarding place\" where a pilot boards the vessel upon arrival at the port boundaries.\n- `BRTH`: \"Berth\" is a designated location in a port or harbour used for mooring vessels when they are not at sea.\n- `RAMP`: \"Ramp\" is an inland container terminal (storing both full and empty containers) connected directly to a rail ramp where containers are loaded/discharged to/from a train.\n- `ANCH`: \"Anchorage\" is the location in which vessels anchor or may anchor",
                                              "enum": [
                                                "BOCR",
                                                "CLOC",
                                                "COFS",
                                                "OFFD",
                                                "DEPO",
                                                "INTE",
                                                "POTE",
                                                "PBPL",
                                                "BRTH",
                                                "RAMP",
                                                "ANCH"
                                              ]
                                            }
                                          },
                                          "required": [
                                            "journey_type",
                                            "event_classifier",
                                            "event_type",
                                            "empty_indicator",
                                            "transport_mode",
                                            "facility_type"
                                          ]
                                        },
                                        {
                                          "title": "Shipment Journey",
                                          "type": "object",
                                          "properties": {
                                            "journey_type": {
                                              "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/milestones/items/properties/journey_event/oneOf/0/properties/journey_type",
                                              "description": "Specifies the schema structure.\n- `SHIPMENT`: The structure of the Shipment Journey governs the naming and understanding of events which are driven by occurrences in the customer-facing information flow tied to a shipment. A shipment can consist of FCL/LCL (plus carrier/merchant haulage).",
                                              "enum": [
                                                "SHIPMENT"
                                              ]
                                            },
                                            "event_classifier": {
                                              "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/milestones/items/properties/journey_event/oneOf/0/properties/event_classifier"
                                            },
                                            "document_type": {
                                              "type": "string",
                                              "nullable": true,
                                              "description": "Identifier for a specific information/document type.\n- `BKG`: \"Booking\" is a reservation of space and/or equipment for a vessel/voyage and possibly inland transport with a specific origin/destination/equipment type and commodity.\n- `SHI`: \"Shipping Instruction\" is an enrichment to the original booking shared by the shipper to the carrier. The shipping instruction includes volume/weight, shipping dates, origin, destination, and other special instructions. The information given by the shipper through the shipping instructions is the information which is required to create the Bill of Lading.\n- `VGM`: \"VGM\" is a notification of reception of the declaration informing the carrier of the weight of the container, verified by an authorized person from the shipper or on behalf of said shipper. This includes cargo weight, bracing, dunnage and container tare weight.\n- `SRM`: \"Shipment Release Message\" is document sent to the consignee informing, that the shipment can now be released from its current location and transferred to the consignee on gate-out.\n- `TRD`: \"Transportation Document\" is a document that governs the terms of carriage between shipper and carrier for maritime transportation. 2 distinct types of transport documents exist: Original Bill of Lading and Sea Waybill\n- `ARN`: \"Arrival Notice\" is a notification to the notifying party (often the consignee and/or notify party) on the estimated arrival time of the shipment.\n- `CAS`: \"Cargo Survey\" is an activity identifier of the act of documenting details on the cargo on behalf of the carrier, customer, or authorities. This could be the measurement of an out of gauge shipment, packing of dangerous goods or any element which requires specific documentation of the physical condition of the cargo. It can have Requested or Completed status.\n- `CUS`: \"Customs Inspection\" is an activity identifier that is used to denote the status of a shipment and/ or container regarding inspection by the respective customs authorities. It can have a status of \"On Hold\" or \"Released\".\n- `DGD`: \"Dangerous Good Desclaration\" is a notification of reception of the Document issued by a shipper (consignor) in accordance with applicable conventions or regulations, describing hazardous goods or materials for transport purposes, and stating that the latter have been packed and labelled in accordance with the provisions of the relevant conventions or regulations.\n- `OOG`: \"Out-of-Gauge\" Is a notification of reception of the declaration for Cargo that has been loaded into special equipment, that exceed the dimensions of a standard 20', 40', or high cube container e.g., Out-of-gauge cargo is over length, over width, over height, or combinations thereof.",
                                              "enum": [
                                                "BKG",
                                                "SHI",
                                                "VGM",
                                                "SRM",
                                                "TRD",
                                                "ARN",
                                                "CAS",
                                                "CUS",
                                                "DGD",
                                                "OOG"
                                              ]
                                            },
                                            "event_type": {
                                              "type": "string",
                                              "nullable": false,
                                              "description": "The active occurrence for the specified container-vehicle event.\n- `APPR`: Approved; indicates that a document has been approved by the counterpart.\n- `CANC`: Cancelled; a status indicator to be used when the booking is cancelled by the Shipper.\n- `CMPL`: Completed; a status indicator that can be used with a number of activity identifiers to denote that a certain activity, service or document has been completed.\n- `CONF`: Confirmed; indicates that the document is confirmed.\n- `DRFT`: Drafted; indicates that a document is in draft mode being updated by either the shipper or the carrier.\n- `HOLD`: On hold; a status indicator that can be used with a number of activity identifiers to denote that a container or shipment has been placed on hold i.e. can’t progress in the process.\n- `ISSU`: Issued; indicates that a document has been issued by the carrier.\n- `PENA`: Pending approval; indicates that a document has been submitted by the shipper or carrier and is now awaiting approval by the counterpart.\n- `PENU`: Pending update; indicates that the carrier requested an update from the shipper which is not received yet.\n- `RECE`: Received; indicates that a document is received by the carrier or shipper.\n- `REJE`: Rejected; indicates that a document has been rejected by the carrier.\n- `RELS`: Released; a status indicator that can be used with a number of activity identifiers to denote that a container or shipment has been released i.e. allowed to move from depot or terminal by authorities or service provider.\n- `REQS`: Requested; a status indicator that can be used with a number of identifiers to denote that a certain activity, service or document has been requested by the carrier, customer or authorities. This status remains constant until the requested activity is “Completed”.\n- `SUBM`: Submitted; indicates that a document has been submitted by the customer to the carrier.\n- `SURR`: Surrendered; indicates that a document has been surrendered by the customer to the carrier.\n- `VOID`: Void; cancellation of an original document.",
                                              "enum": [
                                                "APPR",
                                                "CMPL",
                                                "CONF",
                                                "DRFT",
                                                "HOLD",
                                                "ISSU",
                                                "PENA",
                                                "PENU",
                                                "RECE",
                                                "REJE",
                                                "RELS",
                                                "REQS",
                                                "SUBM",
                                                "SURR",
                                                "VOID"
                                              ]
                                            }
                                          },
                                          "required": [
                                            "journey_type",
                                            "event_classifier",
                                            "document_type",
                                            "event_type"
                                          ]
                                        },
                                        {
                                          "title": "Transport Journey",
                                          "type": "object",
                                          "properties": {
                                            "journey_type": {
                                              "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/milestones/items/properties/journey_event/oneOf/0/properties/journey_type",
                                              "default": "TRANSPORT",
                                              "description": "Specifies the schema structure.\n- `TRANSPORT`: The structure of the Transport Journey governs the naming and understanding of events which are driven by occurrences in the general transport of a shipment. A Transport Journey includes all customer-relevant events carried out by one or more modes of transport.",
                                              "enum": [
                                                "TRANSPORT"
                                              ]
                                            },
                                            "event_classifier": {
                                              "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/milestones/items/properties/journey_event/oneOf/0/properties/event_classifier"
                                            },
                                            "transport_mode": {
                                              "type": "string",
                                              "nullable": false,
                                              "description": "Method of transit.\n- `VESSEL`: \"Vessel\" is a floating, sea going structure (mother vessels and feeder vessels) with either an internal or external mode of propulsion designed for the transport of cargo and/or passengers. Ocean vessels are uniquely identified by an IMO number consisting of 7 digits, or alternatively by their AIS signal with an MMSI number.\n- `RAIL`: \"Rail\" is a transport designed for the movement of goods or people. In the context of the event naming structure, this is limited to rail transport designed for containerized cargo.\n- `TRUCK`: \"Truck\" is a road going vehicle designed for the movement of goods or people. In the context of the event naming structure this is limited to trucks designed for containerized cargo and delimited from trucks and vans carrying parcels or other cargo.\n- `BARGE`: \"Barge\" is a flat-bottomed floating structure built mainly for transport of cargo/equipment at coastal areas, rivers, canals or on open sea. A barge may or may not be self-propelled.",
                                              "enum": [
                                                "VESSEL",
                                                "RAIL",
                                                "TRUCK",
                                                "BARGE"
                                              ]
                                            },
                                            "event_type": {
                                              "type": "string",
                                              "nullable": false,
                                              "description": "The active occurrence for the specified container-vehicle event.\n- `ARRI`: The event which occurs, when a mode of transport reaches its final or intermediate destination, and the mode of transport is ready for load/discharge operations to begin at the specified location. Depending on the mode of transport arrival will have different definitions:\n  - Vessel/Barge: A vessel/barge has arrived once the vessel is berthed at the port terminal.\n  - Rail: A rail transport has arrived once the transport is stationary at the intended platform or rail head.\n  - Truck: A truck has arrived once the truck is stationary in front of the loading dock or other loading facility.\n\n- `DEPA`: The event which occurs when a mode of transport leaves a place of operations. Depending on the mode of transport departure will have different definitions:\n  - Vessel/barge: Departure has been completed once the last mooring has been released.\n  - Rail: Departure has been completed once the rail transport is no longer stationary in front of the platform or rail head.\n  - Truck: Departure has been completed once the truck is no longer stationary in front of the loading dock or loading facility.",
                                              "enum": [
                                                "ARRI",
                                                "DEPA"
                                              ]
                                            },
                                            "facility_type": {
                                              "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/milestones/items/properties/journey_event/oneOf/0/properties/facility_type"
                                            }
                                          },
                                          "required": [
                                            "journey_type",
                                            "event_classifier",
                                            "transport_mode",
                                            "event_type",
                                            "facility_type"
                                          ]
                                        }
                                      ]
                                    }
                                  },
                                  "required": [
                                    "description",
                                    "location",
                                    "mode",
                                    "planned",
                                    "raw_description",
                                    "source",
                                    "timestamp",
                                    "vessel",
                                    "vessel_imo",
                                    "vessel_mmsi",
                                    "voyage"
                                  ]
                                }
                              },
                              "charges": {
                                "type": "array",
                                "description": "Charges on the shipment, one entry per type. Currently surfaces inferred demurrage and detention charges; the `type` field is open to more charge types in future. Field names follow the DCSA `Charge` object where they map.\nDemurrage and detention amounts are estimates inferred from published carrier tariffs — see the `Charge` schema.\nThis is an opt-in feature gated behind the `V1_API_UPDATES` feature flag and is omitted from the payload unless your organization has opted in — please contact Vizion to enable `V1_API_UPDATES`.",
                                "items": {
                                  "title": "Charge",
                                  "type": "object",
                                  "description": "A charge on the shipment. `type` discriminates the charge — `demurrage` and `detention` today; the field is open to additional charge types in future.\n\nField names follow the DCSA `Charge` object where they map (`currencyAmount`, `currencyCode`). Note that, unlike a billed DCSA charge, these demurrage and detention amounts are **estimates** (see `valuation`): Vizion infers them from published carrier tariffs and does not observe the carrier's actual invoice — so contractual fields such as `paymentTermCode`, `unitPrice` and `quantity` are not provided. This is an opt-in feature gated behind the `V1_API_UPDATES` feature flag and is omitted from the payload unless your organization has opted in — please contact Vizion to enable `V1_API_UPDATES`.\n\nThis release reports the **current** charge (the amount accrued as of `as_of`), not a forward accrual schedule.",
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "The kind of charge this entry represents (the DCSA `chargeName` concept, as an enum).",
                                      "enum": [
                                        "demurrage",
                                        "detention"
                                      ]
                                    },
                                    "valuation": {
                                      "type": "string",
                                      "description": "Whether `currencyAmount` is inferred or an actual billed value. Currently always `estimated`; `actual` is reserved for future billing-sourced data.",
                                      "enum": [
                                        "estimated",
                                        "actual"
                                      ]
                                    },
                                    "currencyCode": {
                                      "type": "string",
                                      "maxLength": 3,
                                      "description": "Three-letter ISO 4217 currency code (DCSA `currencyCode`).",
                                      "example": "USD"
                                    },
                                    "currencyAmount": {
                                      "type": "number",
                                      "description": "The charge accrued as of `as_of` (DCSA `currencyAmount`). `0` while the shipment is still within free time.",
                                      "example": 1940
                                    },
                                    "as_of": {
                                      "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at",
                                      "description": "The instant `currencyAmount` is current as of: an actual end event when `accrual_closed` is `true`, otherwise the time the update was generated."
                                    },
                                    "accrual_closed": {
                                      "type": "boolean",
                                      "description": "`true` when `as_of` is an actual end event (gate-out for demurrage, empty return for detention) and the charge window is final. `false` while the charge is still accruing."
                                    },
                                    "source": {
                                      "allOf": [
                                        {
                                          "title": "ChargeSource",
                                          "type": "object",
                                          "description": "Where a `Charge` came from. `type` discriminates the **origin** of the amount — `carrier_tariff` today, meaning the figure is inferred from the carrier's published tariff. This is distinct from `valuation` (which conveys how firm the number is): a carrier-tariff charge is `estimated`, while a future invoice-sourced charge would be `actual`. `url`, `rule_name` and `lines` trace the amount back to the exact tariff document, rule, and lines it was read from.",
                                          "properties": {
                                            "type": {
                                              "type": "string",
                                              "description": "The origin of the amount. Currently always `carrier_tariff`.",
                                              "enum": [
                                                "carrier_tariff"
                                              ]
                                            },
                                            "url": {
                                              "type": "string",
                                              "description": "Link to the carrier's published tariff document the rate was read from."
                                            },
                                            "rule_name": {
                                              "type": "string",
                                              "description": "The named rule within the source document."
                                            },
                                            "lines": {
                                              "type": "string",
                                              "description": "The specific line(s) of the source document the rate was read from."
                                            }
                                          },
                                          "required": [
                                            "type"
                                          ],
                                          "example": {
                                            "type": "carrier_tariff",
                                            "url": "https://www.cma-cgm.com/local/north-america/import-demurrage",
                                            "rule_name": "US Import Demurrage — Reefer",
                                            "lines": "p.3, rows 12-15"
                                          }
                                        }
                                      ],
                                      "description": "Where this charge came from. Always a `carrier_tariff` origin in this release; lets you tell an inferred amount apart from a future billing-sourced charge, with traceability to the source tariff."
                                    }
                                  },
                                  "required": [
                                    "type",
                                    "valuation",
                                    "currencyCode",
                                    "currencyAmount",
                                    "as_of",
                                    "accrual_closed",
                                    "source"
                                  ],
                                  "example": {
                                    "type": "demurrage",
                                    "valuation": "estimated",
                                    "currencyCode": "USD",
                                    "currencyAmount": 1940,
                                    "as_of": "2026-06-15T00:00:00-07:00",
                                    "accrual_closed": false,
                                    "source": {
                                      "type": "carrier_tariff",
                                      "url": "https://www.cma-cgm.com/local/north-america/import-demurrage",
                                      "rule_name": "US Import Demurrage — Reefer",
                                      "lines": "p.3, rows 12-15"
                                    }
                                  }
                                }
                              },
                              "cargo": {
                                "description": "Top-level cargo information (weight, quantity, seal, volume, VGM) for the shipment, when available. This is an opt-in feature gated behind the `V1_API_UPDATES` feature flag and is omitted from the payload unless your organization has opted in — please contact Vizion to enable `V1_API_UPDATES`. New fields may be added under `cargo` over time as non-breaking additions.",
                                "type": "object",
                                "title": "Cargo",
                                "properties": {
                                  "weight": {
                                    "type": "array",
                                    "description": "Cargo weight measurements, if available.",
                                    "items": {
                                      "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/cargo/properties/vgm/items"
                                    }
                                  },
                                  "quantity": {
                                    "type": "array",
                                    "description": "Cargo quantity measurements (e.g. number of packages or pallets), if available.",
                                    "items": {
                                      "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/cargo/properties/vgm/items"
                                    }
                                  },
                                  "seal": {
                                    "type": "array",
                                    "description": "Cargo seal numbers, if available.",
                                    "items": {
                                      "type": "object",
                                      "title": "Cargo Seal",
                                      "properties": {
                                        "value": {
                                          "type": "string",
                                          "nullable": true,
                                          "description": "The seal identifier, if available.",
                                          "example": "ABC123"
                                        },
                                        "source": {
                                          "type": "string",
                                          "description": "Data provider for this seal value.",
                                          "enum": [
                                            "carrier"
                                          ],
                                          "example": "carrier"
                                        }
                                      },
                                      "required": [
                                        "value",
                                        "source"
                                      ]
                                    }
                                  },
                                  "volume": {
                                    "type": "array",
                                    "description": "Cargo volume measurements, if available.",
                                    "items": {
                                      "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/cargo/properties/vgm/items"
                                    }
                                  },
                                  "vgm": {
                                    "type": "array",
                                    "description": "Verified Gross Mass (VGM) measurements, if available.",
                                    "items": {
                                      "type": "object",
                                      "title": "Cargo Measurement",
                                      "description": "A single sourced cargo measurement.",
                                      "properties": {
                                        "value": {
                                          "type": "number",
                                          "nullable": true,
                                          "description": "The measured value, if available.",
                                          "example": 18923
                                        },
                                        "units": {
                                          "type": "string",
                                          "nullable": true,
                                          "description": "Unit of measure for the value, if available.",
                                          "example": "kg"
                                        },
                                        "source": {
                                          "type": "string",
                                          "description": "Data provider for this cargo measurement.",
                                          "enum": [
                                            "carrier"
                                          ],
                                          "example": "carrier"
                                        }
                                      },
                                      "required": [
                                        "value",
                                        "units",
                                        "source"
                                      ]
                                    }
                                  }
                                },
                                "required": [
                                  "weight",
                                  "quantity",
                                  "seal",
                                  "volume",
                                  "vgm"
                                ],
                                "example": {
                                  "weight": [
                                    {
                                      "value": 18923,
                                      "units": "kg",
                                      "source": "carrier"
                                    }
                                  ],
                                  "quantity": [
                                    {
                                      "value": 46,
                                      "units": "pallet",
                                      "source": "carrier"
                                    }
                                  ],
                                  "seal": [
                                    {
                                      "value": "ABC123",
                                      "source": "carrier"
                                    }
                                  ],
                                  "volume": [
                                    {
                                      "value": 49.5,
                                      "units": "CBM",
                                      "source": "carrier"
                                    }
                                  ],
                                  "vgm": [
                                    {
                                      "value": 20100,
                                      "units": "kg",
                                      "source": "carrier"
                                    }
                                  ]
                                }
                              },
                              "container_numbers": {
                                "type": "array",
                                "nullable": true,
                                "items": {
                                  "type": "string"
                                },
                                "description": "Container numbers identified for this shipment. This is an opt-in feature gated behind both the `V1_API_UPDATES` and `SIMPLE_TRACKING_CONTAINERS` feature flags and is omitted from the payload unless your organization has opted in to both — please contact Vizion to enable them."
                              },
                              "container_numbers_status": {
                                "type": "string",
                                "nullable": true,
                                "enum": [
                                  "partial",
                                  "complete"
                                ],
                                "description": "Indicates whether `container_numbers` represents the complete set of containers the carrier reports for this shipment (`complete`) or a partial list gathered so far (`partial`). Null when `container_numbers` is null. This is an opt-in feature gated behind both the `V1_API_UPDATES` and `SIMPLE_TRACKING_CONTAINERS` feature flags and is omitted from the payload unless your organization has opted in to both — please contact Vizion to enable them."
                              }
                            },
                            "required": [
                              "reference_id",
                              "bill_of_lading",
                              "booking_number",
                              "carrier_scac",
                              "container_id",
                              "container_iso",
                              "destination_port",
                              "inland_origin",
                              "inland_destination",
                              "origin_port",
                              "milestones"
                            ]
                          },
                          "created_at": {
                            "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at"
                          }
                        },
                        "required": [
                          "id",
                          "status",
                          "reference_id",
                          "parent_reference_id",
                          "organization_id",
                          "payload",
                          "created_at",
                          "updated_at"
                        ],
                        "example": {
                          "id": "aa8e7201-c1eb-467c-895d-012d6dd40549",
                          "status": "data_received",
                          "reference_id": "11b5a19f-e799-409d-9283-6650a5ef0710",
                          "organization_id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                          "reference_tags": [
                            {
                              "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                              "name": "priority:high"
                            }
                          ],
                          "payload": {
                            "bill_of_lading": "MEDUMJ799185",
                            "carrier_scac": "MSCU",
                            "container_id": "GLDU7685366",
                            "container_iso": "40' HIGH CUBE",
                            "milestones": [
                              {
                                "timestamp": "2022-05-02T08:14:00.000+03:00",
                                "location": {
                                  "city": "Haifa",
                                  "country": "Israel",
                                  "facility": null,
                                  "geolocation": {
                                    "latitude": 32.81349700686647,
                                    "longitude": 35.01270637908898
                                  },
                                  "name": "Haifa",
                                  "state": "Haifa District",
                                  "unlocode": "ILHFA"
                                },
                                "description": "Gate in full",
                                "raw_description": "Gate In Full",
                                "vessel": null,
                                "vessel_imo": null,
                                "vessel_mmsi": null,
                                "voyage": null,
                                "planned": false,
                                "mode": "Truck",
                                "source": "carrier"
                              }
                            ],
                            "reference_id": "11b5a19f-e799-409d-9283-6650a5ef0710",
                            "destination_port": {
                              "city": null,
                              "country": null,
                              "facility": null,
                              "geolocation": {
                                "latitude": null,
                                "longitude": null
                              },
                              "name": null,
                              "state": null,
                              "unlocode": null
                            },
                            "inland_origin": {
                              "city": null,
                              "country": null,
                              "facility": null,
                              "geolocation": {
                                "latitude": null,
                                "longitude": null
                              },
                              "name": null,
                              "state": null,
                              "unlocode": null
                            },
                            "inland_destination": {
                              "city": null,
                              "country": null,
                              "facility": null,
                              "geolocation": {
                                "latitude": null,
                                "longitude": null
                              },
                              "name": null,
                              "state": null,
                              "unlocode": null
                            },
                            "origin_port": {
                              "city": null,
                              "country": null,
                              "facility": null,
                              "geolocation": {
                                "latitude": null,
                                "longitude": null
                              },
                              "name": null,
                              "state": null,
                              "unlocode": null
                            }
                          },
                          "created_at": "2022-05-04T20:31:12.974Z",
                          "updated_at": "2022-05-04T20:31:12.974Z"
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "200": {
                    "description": "Your server returns this code if it accepts the callback"
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "tags": [
          "References"
        ],
        "summary": "List active references",
        "description": "List all `active` references, sorted by creation date (newest first).",
        "operationId": "reference_list",
        "parameters": [
          {
            "name": "include_metadata",
            "description": "Include pagination metadata in response. See [pagination](ref:pagination).",
            "in": "query",
            "schema": {
              "type": "boolean",
              "default": false,
              "example": true
            }
          },
          {
            "$ref": "#/paths/~1tags/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1tags/get/parameters/1"
          },
          {
            "in": "query",
            "name": "active",
            "schema": {
              "type": "boolean",
              "description": "Filter on `active`",
              "default": true,
              "example": false
            }
          },
          {
            "in": "query",
            "name": "container_id",
            "schema": {
              "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/container_id",
              "description": "Filter on `container_id`"
            }
          },
          {
            "in": "query",
            "name": "bill_of_lading",
            "schema": {
              "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/1/properties/bill_of_lading",
              "description": "Filter on `bill_of_lading`"
            }
          },
          {
            "in": "query",
            "name": "booking_number",
            "schema": {
              "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/2/properties/booking_number",
              "description": "Filter on `booking_number`"
            }
          },
          {
            "in": "query",
            "name": "callback_urls",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "description": "URL to receive [webhook](ref:webhooks) based updates from Vizions API.",
                "example": "https://www.yourdomain.com"
              },
              "minItems": 1,
              "maxItems": 5,
              "description": "Filter on `callback_url`. Repeat the parameter to filter on more than one (`?callback_urls=https://www.foobar.com&callback_urls=https://www.bizzbazz.com`).",
              "example": [
                "https://www.foobar.com",
                "https://www.bizzbazz.com"
              ]
            }
          },
          {
            "in": "query",
            "name": "carrier_code",
            "schema": {
              "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/carrier_code",
              "description": "Filter on `carrier_code`"
            }
          },
          {
            "in": "query",
            "name": "last_update_status",
            "schema": {
              "$ref": "#/paths/~1references~1{referenceId}/get/responses/200/content/application~1json/schema/properties/last_update_status",
              "description": "Filter on `last_update_status`"
            }
          },
          {
            "in": "query",
            "name": "deactivate_reason",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "description": "Specifies the reason a reference was deactivated.\n\n - `carrier_not_found`: Used when an ACI reference is deactivated because the carrier could not be identified.\n - `data_not_found`: Used when an ACI reference is deactivated because no carrier returned matching data for the shipment identifier.\n - `newer_data_found_on_another_carrier`: Used when an ACI reference is deactivated because a different carrier reported more recent data for the same shipment identifier.\n - `auto_unsubscribed`: Generic reason for auto-unsubscribe behavior.\n - `container_removed_from_bol`: Used for child references when the container is no longer found on the parent bill of lading.\n - `customer_unsubscribed`: Used when the customer manually unsubscribes from the reference.\n - `exceeded_extraction_attempt_threshold`: Used when the maximum number of extraction attempts has been reached without success.\n - `inferred_shipment_completion`: Used to indicate that based on similar journeys, the reference is not expected to yield any new events.\n - `internal_operations`: Used when the reference is deactivated by vizion for internal operations.\n - `invalid_container`: Used when the carrier reports that the specified identifier is not a valid container.\n - `invalid_bill_of_lading`: Used when the carrier reports that the specified identifier is not a valid bill of lading.\n - `invalid_booking_number`: Used when the carrier reports that the specified identifier is not a valid booking number.\n - `shipment_completed`: Used when we detect that the shipment has been completed and no further updates are expected.\n - `too_long_without_updates`: Used when a reference has gone too long without any new updates and is automatically deactivated.",
                "enum": [
                  "carrier_not_found",
                  "data_not_found",
                  "newer_data_found_on_another_carrier",
                  "auto_unsubscribed",
                  "container_removed_from_bol",
                  "customer_unsubscribed",
                  "exceeded_extraction_attempt_threshold",
                  "inferred_shipment_completion",
                  "internal_operations",
                  "invalid_container",
                  "invalid_bill_of_lading",
                  "invalid_booking_number",
                  "shipment_completed",
                  "too_long_without_updates"
                ]
              },
              "minItems": 1,
              "description": "Filter on `deactivate_reason`. Repeat the parameter to filter on multiple reasons (`?deactivate_reason=shipment_completed&deactivate_reason=customer_unsubscribed`). Combine with `active=false` to return deactivated references — by default only active references (where `deactivate_reason` is null) are returned.",
              "example": [
                "shipment_completed",
                "customer_unsubscribed"
              ]
            }
          },
          {
            "in": "query",
            "name": "created_start",
            "schema": {
              "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at",
              "description": "Filter start range of `created_at`",
              "example": "2024-01-30T06:45:00.000+00:00"
            }
          },
          {
            "in": "query",
            "name": "created_end",
            "schema": {
              "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at",
              "description": "Filter end range of `created_at`",
              "example": "2024-02-01T00:00:00.000+00:00"
            }
          },
          {
            "in": "query",
            "name": "updated_start",
            "schema": {
              "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at",
              "description": "Return only references whose `updated_at` is at or after this time (inclusive). `updated_at` changes whenever a reference is modified, including when it is deactivated, so combine with `active=false` to fetch references deactivated since a point in time.",
              "example": "2024-01-30T06:45:00.000+00:00"
            }
          },
          {
            "in": "query",
            "name": "updated_end",
            "schema": {
              "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at",
              "description": "Return only references whose `updated_at` is at or before this time (inclusive).",
              "example": "2024-02-01T00:00:00.000+00:00"
            }
          },
          {
            "in": "query",
            "name": "tag_ids",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid",
                "example": "6f907cf6-3dd5-489f-8bed-f65370ec6778",
                "description": "Unique identifier."
              },
              "minItems": 1,
              "maxItems": 10,
              "description": "Filter on `tag_ids`. Repeat the parameter to filter on more than one (`?tag_ids=6f907cf6-3dd5-489f-8bed-f65370ec6778&tag_ids=9c8b7a6d-1e2f-4a3b-8c9d-0e1f2a3b4c5d`).",
              "example": [
                "6f907cf6-3dd5-489f-8bed-f65370ec6778",
                "9c8b7a6d-1e2f-4a3b-8c9d-0e1f2a3b4c5d"
              ]
            }
          },
          {
            "in": "query",
            "name": "tag_names",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "description": "Tag name. Must be 1-50 characters. Allowed characters: alphanumeric, spaces, hyphens, underscores, colons, and forward slashes. Tag names must be unique. Original casing is preserved.",
                "minLength": 1,
                "maxLength": 50,
                "pattern": "^[a-zA-Z0-9\\s\\-_:/]+$",
                "example": "priority:high"
              },
              "minItems": 1,
              "maxItems": 10,
              "description": "Filter on `tag_names`. Repeat the parameter to filter on more than one (`?tag_names=priority:high&tag_names=reefer`). Matching is case-insensitive.",
              "example": [
                "priority:high",
                "reefer"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of active references",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "title": "Paginated response",
                      "allOf": [
                        {
                          "$ref": "#/paths/~1references~1{referenceId}~1trace/get/responses/200/content/application~1json/schema/allOf/0"
                        },
                        {
                          "type": "object",
                          "properties": {
                            "data": {
                              "type": "array",
                              "items": {
                                "anyOf": [
                                  {
                                    "$ref": "#/paths/~1tags~1{tagId}~1references/get/responses/200/content/application~1json/schema/oneOf/0/items/anyOf/0"
                                  },
                                  {
                                    "$ref": "#/paths/~1tags~1{tagId}~1references/get/responses/200/content/application~1json/schema/oneOf/0/items/anyOf/1"
                                  },
                                  {
                                    "$ref": "#/paths/~1tags~1{tagId}~1references/get/responses/200/content/application~1json/schema/oneOf/0/items/anyOf/2"
                                  }
                                ]
                              }
                            }
                          }
                        }
                      ]
                    },
                    {
                      "title": "Array of references",
                      "type": "array",
                      "items": {
                        "oneOf": [
                          {
                            "$ref": "#/paths/~1tags~1{tagId}~1references/get/responses/200/content/application~1json/schema/oneOf/0/items/anyOf/0"
                          },
                          {
                            "$ref": "#/paths/~1tags~1{tagId}~1references/get/responses/200/content/application~1json/schema/oneOf/0/items/anyOf/1"
                          },
                          {
                            "$ref": "#/paths/~1tags~1{tagId}~1references/get/responses/200/content/application~1json/schema/oneOf/0/items/anyOf/2"
                          }
                        ]
                      }
                    }
                  ]
                },
                "examples": {
                  "ReferenceExample": {
                    "summary": "Response",
                    "value": [
                      {
                        "id": "421f1c94-001e-4a0a-8c5e-c3593b8d000b",
                        "container_id": "CMAU2118620",
                        "bill_of_lading": null,
                        "carrier_scac": "CMDU",
                        "callback_url": "http://4395918f.ngrok.io/webhook",
                        "organization_id": "d5fe91ab-cffa-46fb-979d-aee03e59d3a3",
                        "parent_reference_id": null,
                        "active": true,
                        "last_update_status": "data_received",
                        "created_at": "2020-01-31T06:51:54.397Z",
                        "updated_at": "2020-01-31T21:25:01.764Z",
                        "last_update_attempted_at": "2020-01-31T21:25:01.739Z",
                        "retry_count": 4,
                        "organization": {
                          "id": "d5fe91ab-cffa-46fb-979d-aee03e59d3a3",
                          "name": "Vizion",
                          "active": true,
                          "created_at": "2020-01-31T05:06:14.548Z",
                          "updated_at": "2020-01-31T05:06:14.548Z"
                        }
                      },
                      {
                        "id": "a8f4e867-3fc4-46c4-b3e4-7f9717f3c3ce",
                        "container_id": "KKFU1752206",
                        "bill_of_lading": null,
                        "carrier_scac": "ONEY",
                        "callback_url": "http://4395918f.ngrok.io/webhook",
                        "organization_id": "d5fe91ab-cffa-46fb-979d-aee03e59d3a3",
                        "parent_reference_id": null,
                        "active": true,
                        "last_update_status": "data_received",
                        "created_at": "2020-01-31T05:24:16.674Z",
                        "updated_at": "2020-01-31T23:40:10.114Z",
                        "last_update_attempted_at": "2020-01-31T23:40:10.051Z",
                        "retry_count": 5,
                        "organization": {
                          "id": "d5fe91ab-cffa-46fb-979d-aee03e59d3a3",
                          "name": "Vizion",
                          "active": true,
                          "created_at": "2020-01-31T05:06:14.548Z",
                          "updated_at": "2020-01-31T05:06:14.548Z"
                        }
                      }
                    ]
                  },
                  "PaginatedExample": {
                    "summary": "Paginated response",
                    "value": {
                      "data": [
                        {
                          "id": "11b5a19f-e799-409d-9283-6650a5ef0710",
                          "container_id": "GLDU7685366",
                          "bill_of_lading": "MEDUMJ799185",
                          "carrier_scac": "MSCU",
                          "callback_url": "https://webhook.site/c1eb08ef-ebe1-42e6-8e10-6e062400d25d",
                          "organization_id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                          "parent_reference_id": "0f3df09b-170b-4f01-be34-67b519b39427",
                          "carrier_id": 6,
                          "active": true,
                          "auto_carrier": false,
                          "last_update_status": "data_received",
                          "created_at": "2022-05-04T20:30:47.890Z",
                          "updated_at": "2022-05-04T20:31:12.966Z",
                          "last_update_attempted_at": "2022-05-04T20:31:11.203Z",
                          "retry_count": 1,
                          "organization": {
                            "id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                            "name": "Vizion",
                            "active": true,
                            "created_at": "2020-01-17T01:35:25.139Z",
                            "updated_at": "2021-07-23T16:55:34.935Z"
                          },
                          "carrier": {
                            "id": 6,
                            "name": "MSC",
                            "code": "MSCU",
                            "enabled": true,
                            "created_at": "2021-03-03T18:30:27.457Z",
                            "updated_at": "2021-03-03T18:30:27.457Z"
                          }
                        },
                        {
                          "id": "33e80a4d-c023-4f9e-a807-fe8f0dd1d18a",
                          "container_id": "MEDU8381210",
                          "bill_of_lading": "MEDUMJ799185",
                          "carrier_scac": "MSCU",
                          "callback_url": "https://webhook.site/c1eb08ef-ebe1-42e6-8e10-6e062400d25d",
                          "organization_id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                          "parent_reference_id": "0f3df09b-170b-4f01-be34-67b519b39427",
                          "carrier_id": 6,
                          "active": true,
                          "auto_carrier": false,
                          "last_update_status": "data_received",
                          "created_at": "2022-05-04T20:30:47.889Z",
                          "updated_at": "2022-05-04T20:31:01.008Z",
                          "last_update_attempted_at": "2022-05-04T20:30:59.246Z",
                          "retry_count": 1,
                          "organization": {
                            "id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                            "name": "Vizion",
                            "active": true,
                            "created_at": "2020-01-17T01:35:25.139Z",
                            "updated_at": "2021-07-23T16:55:34.935Z"
                          },
                          "carrier": {
                            "id": 6,
                            "name": "MSC",
                            "code": "MSCU",
                            "enabled": true,
                            "created_at": "2021-03-03T18:30:27.457Z",
                            "updated_at": "2021-03-03T18:30:27.457Z"
                          }
                        }
                      ],
                      "metadata": {
                        "page": 1,
                        "page_count": 382,
                        "per_page": 2,
                        "item_count": 763
                      }
                    }
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/paths/~1tags/get/responses/4XX"
          }
        }
      }
    },
    "/references/{referenceId}": {
      "get": {
        "tags": [
          "References"
        ],
        "summary": "Get reference",
        "description": "Returns a reference for a given id.",
        "operationId": "reference_get",
        "parameters": [
          {
            "name": "referenceId",
            "in": "path",
            "schema": {
              "type": "string",
              "format": "uuid",
              "example": "6f907cf6-3dd5-489f-8bed-f65370ec6778"
            },
            "required": true,
            "description": "Id of a created reference"
          }
        ],
        "responses": {
          "200": {
            "description": "Reference details",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Reference schema",
                  "type": "object",
                  "properties": {
                    "id": {
                      "$ref": "#/paths/~1references~1{referenceId}~1trace/get/responses/200/content/application~1json/schema/allOf/1/properties/reference_id"
                    },
                    "container_id": {
                      "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/container_id",
                      "nullable": true
                    },
                    "bill_of_lading": {
                      "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/1/properties/bill_of_lading",
                      "nullable": true
                    },
                    "carrier_code": {
                      "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/carrier_code",
                      "nullable": true
                    },
                    "carrier_scac": {
                      "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/4/properties/scac",
                      "nullable": true
                    },
                    "callback_url": {
                      "$ref": "#/paths/~1references/get/parameters/7/schema/items",
                      "nullable": true
                    },
                    "organization_id": {
                      "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/organization_id"
                    },
                    "parent_reference_id": {
                      "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/parent_reference_id"
                    },
                    "latest_update_id": {
                      "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/id"
                    },
                    "carrier_id": {
                      "$ref": "#/paths/~1references~1{referenceId}/get/responses/200/content/application~1json/schema/properties/carrier/properties/id",
                      "nullable": true
                    },
                    "active": {
                      "type": "boolean",
                      "description": "Indicates if the reference is is being tracked."
                    },
                    "auto_carrier": {
                      "type": "boolean",
                      "description": "Indicates if we're using ACI (Automatic Carrier Identification) to attempt to find the correct steamship line and begin tracking updates."
                    },
                    "auto_unsubscribed": {
                      "type": "boolean",
                      "description": "Indicates if the reference was automatically unsubscribed due to inactivity or other reasons."
                    },
                    "deactivate_reason": {
                      "$ref": "#/paths/~1references/get/parameters/10/schema/items",
                      "nullable": true
                    },
                    "last_update_status": {
                      "type": "string",
                      "description": "The status of the last update.\n- `data_received`: An Update Payload was generated, saved, and optionally POSTed to a given `callback_url`.\n- `no_data`: No data is available from the Carrier. Tracking could be too early or too late, or the identifier could be incorrect.\n- `extraction_failed`: An error occurred during processing for this attempt, and Vizion did not receive any data. Errors can be both carrier side or Vizion side if any of our services are down.\n- `webhook_failed`: Vizion received data and built a payload but received a non 200 status code response from the provided `callback_url`.\n- `duplicate_payload`: Vizion received data, but there is no update on the shipment. Vizion did not generate a new payload, as there was no new or updated data for your shipment.\n- `auto_carrier_completed`: A temporary status, a carrier was identified using the auto carrier identification feature. An update will be generated shortly.\n- `auto_carrier_failed`: A temporary status. The last attempt to identify a carrier failed, but we will retry.\n- `auto_carrier_not_found`: No supported carrier returned data for your shipment when using the auto carrier identification feature. Vizion will mark your reference as inactive. We will not continue to try and find the appropriate carrier.\n- `invalid_container`: The carrier indicated the provided container number was invalid.\n- `invalid_bill_of_lading`: The carrier indicated the provided bill of lading number was invalid.\n- `invalid_booking_number`: The carrier indicated the provided booking number was invalid.\n- `new_container_journey`: Events representing the start of a new container journey were detected indicating that the current shipment is completed.\n- `container_not_on_document`: Returned when the provided container number is not listed on the specified document (bill of lading or booking number).",
                      "example": "data_received",
                      "enum": [
                        "data_received",
                        "no_data",
                        "extraction_failed",
                        "webhook_failed",
                        "duplicate_payload",
                        "auto_carrier_completed",
                        "auto_carrier_failed",
                        "auto_carrier_not_found",
                        "invalid_container",
                        "invalid_bill_of_lading",
                        "invalid_booking_number",
                        "new_container_journey",
                        "incomplete_processing",
                        "container_not_on_document"
                      ]
                    },
                    "created_at": {
                      "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at"
                    },
                    "updated_at": {
                      "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at",
                      "nullable": true
                    },
                    "last_update_attempted_at": {
                      "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at",
                      "nullable": true,
                      "description": "The last time Vizion attempted to derive a new update."
                    },
                    "retry_count": {
                      "description": "Monitoring attempts since last posted update.",
                      "type": "number",
                      "example": 1
                    },
                    "organization": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/organization_id"
                        },
                        "name": {
                          "type": "string",
                          "description": "Freeform string identifying your organization"
                        },
                        "active": {
                          "type": "boolean"
                        },
                        "process_frequency_minutes": {
                          "type": "number",
                          "description": "Minute rate in which updates are attempted for a given reference.",
                          "minimum": 120,
                          "example": 720
                        },
                        "created_at": {
                          "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at"
                        },
                        "updated_at": {
                          "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at"
                        }
                      }
                    },
                    "carrier": {
                      "nullable": true,
                      "description": "The steamship line Vizion is tracking the container on.",
                      "type": "object",
                      "properties": {
                        "id": {
                          "description": "Unique identifier of the carrier.",
                          "type": "string",
                          "format": "uuid",
                          "example": "6f907cf6-3dd5-489f-8bed-f65370ec6778"
                        },
                        "name": {
                          "$ref": "#/paths/~1carriers/get/responses/200/content/application~1json/schema/items/properties/name"
                        },
                        "code": {
                          "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/carrier_code"
                        },
                        "enabled": {
                          "type": "boolean"
                        },
                        "created_at": {
                          "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at"
                        },
                        "updated_at": {
                          "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at"
                        }
                      }
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/reference_tags/items"
                      },
                      "description": "Tags associated with this reference"
                    }
                  },
                  "required": [
                    "id",
                    "active",
                    "auto_carrier",
                    "bill_of_lading",
                    "callback_url",
                    "carrier",
                    "carrier_id",
                    "carrier_scac",
                    "container_id",
                    "created_at",
                    "last_update_attempted_at",
                    "last_update_status",
                    "organization_id",
                    "organization",
                    "parent_reference_id",
                    "retry_count",
                    "updated_at"
                  ]
                },
                "examples": {
                  "ContainerExample": {
                    "summary": "Container reference",
                    "value": {
                      "id": "60af720c-4f4a-46ac-ad07-2630f3ce8fb4",
                      "container_id": "MEDU8381210",
                      "booking_number": null,
                      "bill_of_lading": null,
                      "carrier_scac": "MSCU",
                      "callback_url": "{{callbackUrl}}",
                      "organization_id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                      "parent_reference_id": null,
                      "carrier_id": 6,
                      "active": true,
                      "auto_carrier": false,
                      "auto_unsubscribed": false,
                      "deactivate_reason": null,
                      "last_update_status": "data_received",
                      "created_at": "2022-05-04T20:25:20.170Z",
                      "updated_at": "2022-05-04T20:25:24.758Z",
                      "last_update_attempted_at": "2022-05-04T20:25:21.030Z",
                      "retry_count": 1,
                      "organization": {
                        "id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                        "name": "Vizion",
                        "active": true,
                        "created_at": "2020-01-17T01:35:25.139Z",
                        "updated_at": "2021-07-23T16:55:34.935Z"
                      },
                      "carrier": {
                        "id": 6,
                        "name": "MSC",
                        "code": "MSCU",
                        "enabled": true,
                        "created_at": "2021-03-03T18:30:27.457Z",
                        "updated_at": "2021-03-03T18:30:27.457Z"
                      },
                      "child_reference_ids": []
                    }
                  },
                  "BillOfLadingExample": {
                    "summary": "Bill of lading reference",
                    "value": {
                      "id": "0f3df09b-170b-4f01-be34-67b519b39427",
                      "container_id": null,
                      "booking_number": null,
                      "bill_of_lading": "MEDUMJ799185",
                      "carrier_scac": "MSCU",
                      "callback_url": "{{callbackUrl}}",
                      "organization_id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                      "parent_reference_id": null,
                      "carrier_id": 6,
                      "active": true,
                      "auto_carrier": false,
                      "auto_unsubscribed": false,
                      "deactivate_reason": null,
                      "last_update_status": "data_received",
                      "created_at": "2022-05-04T20:30:45.446Z",
                      "updated_at": "2022-05-04T20:30:48.025Z",
                      "last_update_attempted_at": "2022-05-04T20:30:45.969Z",
                      "retry_count": 1,
                      "organization": {
                        "id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                        "name": "Vizion",
                        "active": true,
                        "created_at": "2020-01-17T01:35:25.139Z",
                        "updated_at": "2021-07-23T16:55:34.935Z"
                      },
                      "carrier": {
                        "id": 6,
                        "name": "MSC",
                        "code": "MSCU",
                        "enabled": true,
                        "created_at": "2021-03-03T18:30:27.457Z",
                        "updated_at": "2021-03-03T18:30:27.457Z"
                      },
                      "child_reference_ids": [
                        "11b5a19f-e799-409d-9283-6650a5ef0710",
                        "33e80a4d-c023-4f9e-a807-fe8f0dd1d18a"
                      ]
                    }
                  },
                  "BookingNumberExample": {
                    "summary": "Booking number reference",
                    "value": {
                      "id": "0f3df09b-170b-4f01-be34-67b519b39427",
                      "container_id": null,
                      "booking_number": "195EG2005029",
                      "bill_of_lading": null,
                      "carrier_scac": "MSCU",
                      "callback_url": "{{callbackUrl}}",
                      "organization_id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                      "parent_reference_id": null,
                      "carrier_id": 6,
                      "active": true,
                      "auto_carrier": false,
                      "auto_unsubscribed": false,
                      "deactivate_reason": null,
                      "last_update_status": "data_received",
                      "created_at": "2022-05-04T20:30:45.446Z",
                      "updated_at": "2022-05-04T20:30:48.025Z",
                      "last_update_attempted_at": "2022-05-04T20:30:45.969Z",
                      "retry_count": 1,
                      "organization": {
                        "id": "29c06a5d-efb1-4871-b173-b3022113d1c1",
                        "name": "Vizion",
                        "active": true,
                        "created_at": "2020-01-17T01:35:25.139Z",
                        "updated_at": "2021-07-23T16:55:34.935Z"
                      },
                      "carrier": {
                        "id": 6,
                        "name": "MSC",
                        "code": "MSCU",
                        "enabled": true,
                        "created_at": "2021-03-03T18:30:27.457Z",
                        "updated_at": "2021-03-03T18:30:27.457Z"
                      },
                      "child_reference_ids": [
                        "11b5a19f-e799-409d-9283-6650a5ef0710",
                        "33e80a4d-c023-4f9e-a807-fe8f0dd1d18a"
                      ]
                    }
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/paths/~1tags/get/responses/4XX"
          }
        }
      }
    },
    "/references/{referenceId}/trace": {
      "get": {
        "tags": [
          "References"
        ],
        "summary": "List container trace",
        "description": "> ⚠️ Pro Tier Only\nFor access, please [contact support](https://share.hsforms.com/1B6wNyBBSR6uMotj--8Z_0Q56czk).\n\nReturns an array of vessel movements for a given reference id.\n\nVessel movements are identified using the latest update.",
        "operationId": "reference_trace_list",
        "parameters": [
          {
            "$ref": "#/paths/~1references~1{referenceId}/get/parameters/0"
          },
          {
            "in": "query",
            "name": "include_projected",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false,
              "example": true
            },
            "description": "Include projected (forecast) vessel trace points alongside actual ones. Requires the projected trace capability: without it the response is unchanged — actual points only, with no `kind` field. Contact support@vizionapi.com to have it enabled."
          },
          {
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1,
              "example": 2
            },
            "description": "Requested paginated page (1-indexed). Pagination is opt-in and driven by `limit`, so `page` has no effect unless `limit` is also provided. See [pagination](ref:pagination)."
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 20000,
              "example": 50
            },
            "description": "Requested limit per paginated page. Providing `limit` enables pagination; omit it to receive the full trace in one response."
          },
          {
            "in": "query",
            "name": "include_metadata",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false,
              "example": true
            },
            "description": "Include pagination metadata in response. Applies only when `limit` is also provided. See [pagination](ref:pagination)."
          }
        ],
        "responses": {
          "200": {
            "description": "Container trace for a reference",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Container trace",
                  "description": "Envelope for a reference's vessel trace. The `metadata` pagination block is present only when the request opts into pagination with `limit` (and `include_metadata=true`); by default the full `trace` array is returned with no `metadata`.",
                  "allOf": [
                    {
                      "title": "Pagination metadata",
                      "type": "object",
                      "properties": {
                        "metadata": {
                          "type": "object",
                          "properties": {
                            "page": {
                              "type": "number",
                              "description": "Page requested",
                              "example": 1
                            },
                            "page_count": {
                              "type": "number",
                              "description": "Total pages",
                              "example": 100
                            },
                            "per_page": {
                              "type": "number",
                              "description": "Elements requested per page",
                              "example": 25
                            },
                            "item_count": {
                              "type": "number",
                              "description": "Total elements available",
                              "example": 25
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "reference_id": {
                          "description": "Unique identifier of the reference.",
                          "type": "string",
                          "format": "uuid",
                          "example": "6f907cf6-3dd5-489f-8bed-f65370ec6778"
                        },
                        "trace": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "vessel_imo": {
                                "$ref": "#/paths/~1references~1last-known-positions/get/responses/200/content/application~1json/schema/oneOf/1/items/properties/mode_details/properties/vessel_imo",
                                "nullable": false
                              },
                              "timestamp": {
                                "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at",
                                "description": "ISO8601 DateTime of the reported positional data"
                              },
                              "latitude": {
                                "type": "number",
                                "format": "float",
                                "description": "North-south position.",
                                "example": 23.828665
                              },
                              "longitude": {
                                "type": "number",
                                "format": "float",
                                "description": "West-east position.",
                                "example": 122.0337208421651
                              },
                              "vessel_mmsi": {
                                "$ref": "#/paths/~1references/post/callbacks/statusUpdate/{$request.body#~1callback_url}/post/requestBody/content/application~1json/schema/properties/payload/properties/milestones/items/properties/vessel_mmsi",
                                "nullable": true
                              },
                              "vessel_name": {
                                "$ref": "#/paths/~1references~1last-known-positions/get/responses/200/content/application~1json/schema/oneOf/1/items/properties/mode_details/properties/vessel",
                                "nullable": true
                              },
                              "vessel_heading": {
                                "nullable": true,
                                "type": "number",
                                "description": "Direction of the vessel in degrees where 0 (or 360) indicates true north, 90 true east, 180 true south, and 270 true west.",
                                "example": 8
                              },
                              "vessel_speed": {
                                "nullable": true,
                                "type": "number",
                                "description": "Speed of the vessel in knots",
                                "example": 16
                              },
                              "kind": {
                                "type": "string",
                                "enum": [
                                  "actual",
                                  "projected"
                                ],
                                "description": "Present only when projected points are enabled (opt-in + feature-flagged). `actual` = observed AIS position; `projected` = forecast path point."
                              }
                            },
                            "required": [
                              "vessel_imo",
                              "timestamp",
                              "latitude",
                              "longitude",
                              "vessel_mmsi",
                              "vessel_name",
                              "vessel_heading",
                              "vessel_speed"
                            ],
                            "example": {
                              "vessel_imo": 9864502,
                              "timestamp": "2023-01-05T16:33:34.000Z",
                              "latitude": 23.828665,
                              "longitude": 119.92941333333333,
                              "vessel_mmsi": 636019892,
                              "vessel_name": "YM CELEBRITY",
                              "vessel_heading": 8,
                              "vessel_speed": 16
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "204": {
            "description": "No update found for the given reference",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "No Update found for the given Reference"
                    }
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/paths/~1tags/get/responses/4XX"
          }
        }
      }
    },
    "/carriers": {
      "get": {
        "tags": [
          "Carriers"
        ],
        "summary": "List carriers",
        "description": "Get all carriers.\nReturns all supported carriers, and the corresponding `carrier_code` and `scac` (**deprecated**) values.",
        "operationId": "carrier_list",
        "responses": {
          "200": {
            "description": "List of available carriers",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Freeform string identifying a carrier.",
                        "example": "Hyundai Merchant Marine"
                      },
                      "scac": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/4/properties/scac"
                      },
                      "carrier_code": {
                        "$ref": "#/paths/~1references/post/requestBody/content/application~1json/schema/oneOf/0/properties/carrier_code"
                      }
                    },
                    "required": [
                      "name",
                      "scac",
                      "carrier_code"
                    ]
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/paths/~1tags/get/responses/4XX"
          }
        }
      }
    },
    "/tags": {
      "post": {
        "tags": [
          "Tags"
        ],
        "summary": "Create a tag",
        "description": "Create a new tag.",
        "operationId": "tag_create",
        "requestBody": {
          "description": "Tag creation parameters",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "$ref": "#/paths/~1references/get/parameters/16/schema/items"
                  }
                },
                "required": [
                  "name"
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Tag successfully created",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "tag": {
                      "title": "Tag schema",
                      "type": "object",
                      "properties": {
                        "id": {
                          "$ref": "#/paths/~1references/get/parameters/15/schema/items"
                        },
                        "name": {
                          "$ref": "#/paths/~1references/get/parameters/16/schema/items"
                        },
                        "organization_id": {
                          "description": "Unique identifier of the organization.",
                          "type": "string",
                          "format": "uuid",
                          "example": "6f907cf6-3dd5-489f-8bed-f65370ec6778"
                        },
                        "created_at": {
                          "type": "string",
                          "format": "date-time",
                          "description": "ISO8601 DateTime string.",
                          "example": "2024-01-30T06:45:00.000+00:00"
                        },
                        "updated_at": {
                          "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag/properties/created_at"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "organization_id",
                        "created_at",
                        "updated_at"
                      ]
                    }
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/paths/~1tags/get/responses/4XX"
          }
        }
      },
      "get": {
        "tags": [
          "Tags"
        ],
        "summary": "List tags",
        "description": "List all tags.",
        "operationId": "tag_list",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 2000,
              "default": 25,
              "example": 25
            },
            "description": "Requested limit per paginated page"
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1,
              "example": 1
            },
            "description": "Requested paginated page"
          }
        ],
        "responses": {
          "200": {
            "description": "List of tags",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "type": "array",
                      "items": {
                        "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag"
                      }
                    },
                    {
                      "title": "Paginated tags response",
                      "allOf": [
                        {
                          "$ref": "#/paths/~1references~1{referenceId}~1trace/get/responses/200/content/application~1json/schema/allOf/0"
                        },
                        {
                          "type": "object",
                          "properties": {
                            "data": {
                              "type": "array",
                              "items": {
                                "$ref": "#/paths/~1tags/post/responses/201/content/application~1json/schema/properties/tag"
                              }
                            }
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            }
          },
          "4XX": {
            "description": "Invalid request",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "title": "Array of validation errors",
                      "type": "object",
                      "properties": {
                        "errors": {
                          "type": "array",
                          "items": {
                            "title": "Array of validation errors",
                            "type": "array",
                            "items": {
                              "title": "Validation error",
                              "type": "object",
                              "properties": {
                                "property": {
                                  "type": "string",
                                  "description": "The parameter which failed validation",
                                  "example": "limit"
                                },
                                "value": {
                                  "description": "The value which failed validation",
                                  "example": "-1",
                                  "nullable": true,
                                  "oneOf": [
                                    {
                                      "type": "string"
                                    },
                                    {
                                      "type": "number"
                                    },
                                    {
                                      "type": "integer"
                                    },
                                    {
                                      "type": "boolean"
                                    },
                                    {
                                      "type": "array",
                                      "items": {}
                                    },
                                    {
                                      "type": "object"
                                    }
                                  ]
                                },
                                "name": {
                                  "type": "string",
                                  "description": "The name of the failing validation",
                                  "example": "is_positive"
                                },
                                "message": {
                                  "type": "string",
                                  "description": "A human readable description",
                                  "example": "limit must be a positive number"
                                },
                                "detail": {
                                  "type": "string",
                                  "description": "Used to provide additional information to the developer",
                                  "example": "For pagination documentation, see https://docs.vizionapi.com/reference/pagination"
                                }
                              },
                              "required": [
                                "property",
                                "name",
                                "message",
                                "value"
                              ]
                            }
                          }
                        }
                      }
                    },
                    {
                      "title": "Generic error response",
                      "type": "object",
                      "properties": {
                        "error": {
                          "example": "Limit Exceeded",
                          "type": "string",
                          "description": "A human readable description"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/tags/{tagId}/references": {
      "get": {
        "tags": [
          "Tags"
        ],
        "summary": "List references for a tag",
        "description": "Returns all references associated with a given tag.",
        "operationId": "tag_references_list",
        "parameters": [
          {
            "$ref": "#/paths/~1tags~1{tagId}/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1tags/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1tags/get/parameters/1"
          }
        ],
        "responses": {
          "200": {
            "description": "References associated with a tag",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "title": "Container reference",
                            "allOf": [
                              {
                                "$ref": "#/paths/~1references~1{referenceId}/get/responses/200/content/application~1json/schema"
                              },
                              {
                                "type": "object",
                                "required": [
                                  "container_id"
                                ]
                              }
                            ]
                          },
                          {
                            "title": "Bill of lading reference",
                            "allOf": [
                              {
                                "$ref": "#/paths/~1references~1{referenceId}/get/responses/200/content/application~1json/schema"
                              },
                              {
                                "type": "object",
                                "required": [
                                  "bill_of_lading"
                                ],
                                "properties": {
                                  "child_reference_ids": {
                                    "type": "array",
                                    "items": {
                                      "$ref": "#/paths/~1tags~1{tagId}~1references/get/responses/200/content/application~1json/schema/oneOf/0/items/anyOf/0"
                                    }
                                  }
                                }
                              }
                            ]
                          },
                          {
                            "title": "Booking number reference",
                            "allOf": [
                              {
                                "$ref": "#/paths/~1references~1{referenceId}/get/responses/200/content/application~1json/schema"
                              },
                              {
                                "type": "object",
                                "required": [
                                  "booking_number"
                                ],
                                "properties": {
                                  "child_reference_ids": {
                                    "type": "array",
                                    "items": {
                                      "$ref": "#/paths/~1tags~1{tagId}~1references/get/responses/200/content/application~1json/schema/oneOf/0/items/anyOf/0"
                                    }
                                  }
                                }
                              }
                            ]
                          }
                        ]
                      }
                    },
                    {
                      "$ref": "#/paths/~1references/get/responses/200/content/application~1json/schema/oneOf/0"
                    }
                  ]
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/paths/~1tags/get/responses/4XX"
          }
        }
      }
    }
  }
}
```