{
  "info": {
    "name": "Navlo API",
    "description": "Track ocean and air shipments, read Navlo's shipment intelligence, manage customers, webhooks and Navlo AI. Authenticate with the X-API-Key header.\n\nSet the apiKey variable to your nvl_ key. Generated from public/developers/navlo-openapi.json.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.navlo.io"
    },
    {
      "key": "apiKey",
      "value": "nvl_your_key_here"
    },
    {
      "key": "embedKey",
      "value": "nvle_your_key_here"
    }
  ],
  "item": [
    {
      "name": "Embed",
      "item": [
        {
          "name": "Resolve a tracked shipment for the embed widget",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/api/embed/resolve",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api",
                "embed",
                "resolve"
              ],
              "query": [
                {
                  "key": "key",
                  "value": "",
                  "description": "The embed key (nvle_…) as a query parameter, for the iframe. Prefer the X-Embed-Key header.",
                  "disabled": true
                },
                {
                  "key": "number",
                  "value": "MEDU1234562",
                  "description": "The exact number your customer typed: container, Master B/L, booking or Master AWB.",
                  "disabled": false
                },
                {
                  "key": "parentOrigin",
                  "value": "",
                  "description": "The origin of the page embedding the widget. Required, and checked, when the key pins allowed origins.",
                  "disabled": true
                }
              ]
            },
            "description": "Resolve a tracked shipment for the embed widget\n\nExact-match lookup of a container, Master B/L, booking or Master AWB number among the shipments your organization already tracks. Never starts a tracking or spends credits. Answers the read-only public shipment view the share links use. 401 invalid or revoked embed key, 403 origin not allowed, 404 not tracked, 429 more than 60 lookups in a minute for this key (see `Retry-After`).",
            "auth": {
              "type": "apikey",
              "apikey": [
                {
                  "key": "key",
                  "value": "X-Embed-Key",
                  "type": "string"
                },
                {
                  "key": "value",
                  "value": "{{embedKey}}",
                  "type": "string"
                },
                {
                  "key": "in",
                  "value": "header",
                  "type": "string"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Navlo AI",
      "item": [
        {
          "name": "Ask a question",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/ai/ask",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "ai",
                "ask"
              ]
            },
            "description": "Ask a question\n\nStarts a new conversation and answers its first question. Pass `shipmentId` to ask about one shipment, `customer` to bill the AI credits to one of your customers in the usage report.\n\n**Streaming (default).** The response is `text/event-stream`; every `data:` line is one JSON object. Send `\"stream\": false` to get the `result` object as one JSON body instead.\n\n- `started` `{conversationId, messageId}` — your question is stored (`messageId` is its id). Always first.\n- `step` `{label}` — Navlo AI started a lookup; `label` is the text the app shows. Text streamed before a `step` was Navlo AI thinking aloud and is not part of the answer — clear it.\n- `text` `{delta}` — answer text as it is written (raw markdown, ```chart fences included).\n- `result` `{conversationId, messageId, answer, shipments, charts, files, creditsUsed}` — the finished answer; render this one. `answer` is markdown without ```chart blocks (those are parsed into `charts`), `files` are the documents it generated (download links valid for 7 days), `shipments` are your shipments it is about.\n- `error` `{message, code}` — no answer: `insufficient_credits`, `rejected` (not a logistics question), `busy` (retry in a minute), `timeout` (5 minutes), `internal`.\n\nThe stream ends after `result` or `error`. Problems found before it starts (invalid body, unknown shipment or conversation, or `429` while your organization already has 2 answers running) are ordinary HTTP errors. With `stream: false` the codes answer as 402, 422, 503, 504 and 500 with the body `{error, message, code}`. Each answer uses AI credits; `creditsUsed` says how many.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"customer\": {\n    \"id\": \"0c7d2f6e-3a41-4b0e-9a55-1f2b3c4d5e6f\",\n    \"name\": \"Acme Trading Ltd.\",\n    \"ref\": \"C-1042\"\n  },\n  \"question\": \"Which of my shipments to Rotterdam are running late?\",\n  \"shipmentId\": null,\n  \"stream\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "List conversations",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/ai/conversations",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "ai",
                "conversations"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "0-based page.",
                  "disabled": true
                },
                {
                  "key": "size",
                  "value": "20",
                  "description": "Page size, 1–100.",
                  "disabled": true
                }
              ]
            },
            "description": "List conversations\n\nThe key creator's Navlo AI conversations, most recently active first — the ones started in the app included."
          }
        },
        {
          "name": "Start a conversation",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/ai/conversations",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "ai",
                "conversations"
              ]
            },
            "description": "Start a conversation\n\nAn empty conversation to ask follow-up questions in. Without a `title`, Navlo AI titles it from its first exchange.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"customer\": {\n    \"id\": \"0c7d2f6e-3a41-4b0e-9a55-1f2b3c4d5e6f\",\n    \"name\": \"Acme Trading Ltd.\",\n    \"ref\": \"C-1042\"\n  },\n  \"title\": \"Rotterdam delays\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Get a conversation",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/ai/conversations/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "ai",
                "conversations",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Conversation id."
                }
              ]
            },
            "description": "Get a conversation\n\nThe conversation with every message, oldest first."
          }
        },
        {
          "name": "Delete a conversation",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/ai/conversations/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "ai",
                "conversations",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Conversation id."
                }
              ]
            },
            "description": "Delete a conversation\n\nRemoves it here and from the app. The credits it used stay in your usage report."
          }
        },
        {
          "name": "Ask a follow-up",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/ai/conversations/:id/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "ai",
                "conversations",
                ":id",
                "messages"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Conversation id."
                }
              ]
            },
            "description": "Ask a follow-up\n\nAsks the next question in a conversation; Navlo AI reads the earlier turns.\n\n**Streaming (default).** The response is `text/event-stream`; every `data:` line is one JSON object. Send `\"stream\": false` to get the `result` object as one JSON body instead.\n\n- `started` `{conversationId, messageId}` — your question is stored (`messageId` is its id). Always first.\n- `step` `{label}` — Navlo AI started a lookup; `label` is the text the app shows. Text streamed before a `step` was Navlo AI thinking aloud and is not part of the answer — clear it.\n- `text` `{delta}` — answer text as it is written (raw markdown, ```chart fences included).\n- `result` `{conversationId, messageId, answer, shipments, charts, files, creditsUsed}` — the finished answer; render this one. `answer` is markdown without ```chart blocks (those are parsed into `charts`), `files` are the documents it generated (download links valid for 7 days), `shipments` are your shipments it is about.\n- `error` `{message, code}` — no answer: `insufficient_credits`, `rejected` (not a logistics question), `busy` (retry in a minute), `timeout` (5 minutes), `internal`.\n\nThe stream ends after `result` or `error`. Problems found before it starts (invalid body, unknown shipment or conversation, or `429` while your organization already has 2 answers running) are ordinary HTTP errors. With `stream: false` the codes answer as 402, 422, 503, 504 and 500 with the body `{error, message, code}`. Each answer uses AI credits; `creditsUsed` says how many.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"content\": \"And which of those are with MSC?\",\n  \"stream\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    },
    {
      "name": "Ports & airports",
      "item": [
        {
          "name": "List airport delays",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/airports/delays",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "airports",
                "delays"
              ]
            },
            "description": "List airport delays\n\nThe latest delay sample of each airport Navlo watches: average delay and ground stops."
          }
        },
        {
          "name": "List port congestion",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/ports/congestion",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "ports",
                "congestion"
              ],
              "query": [
                {
                  "key": "scope",
                  "value": "shipments",
                  "description": "shipments (default) or all.",
                  "disabled": true
                },
                {
                  "key": "country",
                  "value": "TR",
                  "description": "Only ports in this country, ISO 3166-1 alpha-2.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "100",
                  "description": "At most this many ports (1 to 500).",
                  "disabled": true
                }
              ]
            },
            "description": "List port congestion\n\nThe latest daily congestion sample per port, most congested first. By default the ports on your active ocean shipments (origin, destination, current port); scope=all lists every port Navlo samples."
          }
        },
        {
          "name": "Get a port's congestion history",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/ports/:locode/congestion",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "ports",
                ":locode",
                "congestion"
              ],
              "query": [
                {
                  "key": "days",
                  "value": "30",
                  "description": "Days back from now (1 to 90).",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "locode",
                  "value": "TRAMR",
                  "description": "The port's UN/LOCODE."
                }
              ]
            },
            "description": "Get a port's congestion history\n\nThe port's daily congestion samples, oldest first. Navlo keeps 90 days. 404 for an unknown UN/LOCODE."
          }
        }
      ]
    },
    {
      "name": "Usage & credits",
      "item": [
        {
          "name": "Credit balances",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/credits",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "credits"
              ]
            },
            "description": "Credit balances\n\nWhat the API key can spend now: tracking credits (shipments, vessel tracking) and Navlo AI credits. For a key created by an organization admin these are the organization's pools."
          }
        },
        {
          "name": "Usage report",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/usage",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "usage"
              ],
              "query": [
                {
                  "key": "from",
                  "value": "2026-10-01",
                  "description": "First day, inclusive (YYYY-MM-DD, UTC). Default: the first day of the current month.",
                  "disabled": true
                },
                {
                  "key": "to",
                  "value": "2026-11-01",
                  "description": "Day after the last day, exclusive (YYYY-MM-DD, UTC). Default: one month after `from`.",
                  "disabled": true
                },
                {
                  "key": "groupBy",
                  "value": "customer",
                  "description": "customer (default), shipment, day or none.",
                  "disabled": true
                },
                {
                  "key": "customerId",
                  "value": "",
                  "description": "Only this customer's usage (Navlo id).",
                  "disabled": true
                },
                {
                  "key": "customerRef",
                  "value": "C-1042",
                  "description": "Only this customer's usage (your reference).",
                  "disabled": true
                },
                {
                  "key": "format",
                  "value": "json",
                  "description": "json (default) or csv.",
                  "disabled": true
                }
              ]
            },
            "description": "Usage report\n\nCredits charged and refunded in a period, attributed to the CURRENT customer of each shipment, vessel follow or Navlo AI conversation. Days are UTC; `from` is inclusive, `to` exclusive; the default is the current calendar month and a report covers at most 366 days. format=csv returns one line per ledger row instead (charges positive, refunds negative)."
          }
        }
      ]
    },
    {
      "name": "Customers",
      "item": [
        {
          "name": "List customers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/customers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "customers"
              ],
              "query": [
                {
                  "key": "search",
                  "value": "acme",
                  "description": "Text contained in the name, ref or tax id.",
                  "disabled": true
                },
                {
                  "key": "ref",
                  "value": "C-1042",
                  "description": "Your own reference, exact match (case-insensitive).",
                  "disabled": true
                },
                {
                  "key": "includeArchived",
                  "value": "false",
                  "description": "Include archived customers.",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "0",
                  "description": "0-based page number.",
                  "disabled": true
                },
                {
                  "key": "size",
                  "value": "20",
                  "description": "Page size, 1 to 100.",
                  "disabled": true
                }
              ]
            },
            "description": "List customers\n\nYour customers in name order, archived ones only with includeArchived=true. `search` matches name, ref or tax id (contains, case-insensitive); `ref` is an exact, case-insensitive match."
          }
        },
        {
          "name": "Create a customer",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/customers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "customers"
              ]
            },
            "description": "Create a customer\n\nOnly `name` is required. A name or ref another customer already has is refused (400 for a name, 409 for a ref) — archived customers count too.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"address\": null,\n  \"city\": null,\n  \"contacts\": [\n    {\n      \"email\": null,\n      \"name\": \"\",\n      \"phone\": null,\n      \"primary\": false,\n      \"role\": \"Operations\"\n    }\n  ],\n  \"countryCode\": \"TR\",\n  \"name\": \"Acme Trading Ltd.\",\n  \"ref\": \"C-1042\",\n  \"taxId\": null\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Get a customer",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/customers/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "customers",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Navlo's customer id."
                }
              ]
            },
            "description": "Get a customer\n\nArchived customers are returned too (`archived: true`)."
          }
        },
        {
          "name": "Update a customer",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/customers/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "customers",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Navlo's customer id."
                }
              ]
            },
            "description": "Update a customer\n\nPartial update: only the keys you send change; `null` or \"\" clears an optional field; `contacts` replaces the whole list.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"address\": null,\n  \"city\": null,\n  \"contacts\": null,\n  \"countryCode\": \"TR\",\n  \"name\": null,\n  \"ref\": null,\n  \"taxId\": null\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Archive a customer",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/customers/:id/archive",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "customers",
                ":id",
                "archive"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Navlo's customer id."
                }
              ]
            },
            "description": "Archive a customer\n\nHides the customer from the app's directory and pickers; its shipments keep it and its reports pause. Archived customers still resolve by id or ref. Idempotent."
          }
        },
        {
          "name": "Restore an archived customer",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/customers/:id/restore",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "customers",
                ":id",
                "restore"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Navlo's customer id."
                }
              ]
            },
            "description": "Restore an archived customer\n\nIdempotent."
          }
        }
      ]
    },
    {
      "name": "Reports",
      "item": [
        {
          "name": "Generate a report",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/reports",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "reports"
              ]
            },
            "description": "Generate a report\n\nBuilds the same Excel workbook Navlo AI produces when you ask it for a status report (up to 500 shipments), a cost analysis or a D&D risk report (up to 200 shipments) — straight from your data, with no AI credits used. Answers with a download link valid for 7 days. A filter the report type cannot apply is a 400; nothing is silently ignored.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"filters\": {\n    \"carrier\": \"MSC\",\n    \"customerId\": \"0c7d2f6e-3a41-4b0e-9a55-1f2b3c4d5e6f\",\n    \"customerRef\": \"C-1042\",\n    \"destinationCountry\": \"NL\",\n    \"destinationPort\": \"NLRTM\",\n    \"etaFrom\": \"2026-10-01\",\n    \"etaTo\": \"2026-10-31\",\n    \"from\": \"2026-09-01\",\n    \"mode\": \"OCEAN\",\n    \"originCountry\": \"TR\",\n    \"originPort\": \"TRMER\",\n    \"shipments\": [\n      \"MSCU1234567\"\n    ],\n    \"status\": [\n      \"active\"\n    ],\n    \"tag\": [\n      \"Priority\"\n    ],\n    \"to\": \"2026-09-30\"\n  },\n  \"type\": \"STATUS\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Export shipments as CSV or Excel",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/export",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                "export"
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "description": "csv (default) or xlsx.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "description": "Comma-separated: discovering, resolving, active, completed, stopped.",
                  "disabled": true
                },
                {
                  "key": "mode",
                  "value": "",
                  "description": "OCEAN or AIR.",
                  "disabled": true
                },
                {
                  "key": "carrier",
                  "value": "",
                  "description": "Carrier code or name (partial match).",
                  "disabled": true
                },
                {
                  "key": "customerId",
                  "value": "",
                  "description": "One of your customer ids, or `none` for shipments without a customer.",
                  "disabled": true
                },
                {
                  "key": "tag",
                  "value": "",
                  "description": "Comma-separated tag names (any case); a shipment matches when it carries any of them.",
                  "disabled": true
                },
                {
                  "key": "etaFrom",
                  "value": "",
                  "description": "ETA on or after (ISO date or timestamp).",
                  "disabled": true
                },
                {
                  "key": "etaTo",
                  "value": "",
                  "description": "ETA on or before (a date covers the whole day).",
                  "disabled": true
                },
                {
                  "key": "createdFrom",
                  "value": "",
                  "description": "Created on or after (ISO date or timestamp).",
                  "disabled": true
                },
                {
                  "key": "createdTo",
                  "value": "",
                  "description": "Created on or before (a date covers the whole day).",
                  "disabled": true
                },
                {
                  "key": "columns",
                  "value": "",
                  "description": "Comma-separated column keys, as in the app's column picker. Omitted = every column.",
                  "disabled": true
                }
              ]
            },
            "description": "Export shipments as CSV or Excel\n\nThe same file as the Export button on the Shipments page — same columns, same order, same formatting — for every shipment the filters select (no paging). Without filters: all of your organization's shipments. A status, mode, format, column or customerId the API does not know is a 400 that lists the allowed values; a tag name none of your tags carry matches no shipment, as on GET /v1/shipments."
          }
        }
      ]
    },
    {
      "name": "Shipments",
      "item": [
        {
          "name": "List shipments",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "0-based page number.",
                  "disabled": true
                },
                {
                  "key": "size",
                  "value": "20",
                  "description": "Page size, 1 to 100.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "active",
                  "description": "Statuses, comma-separated: discovering, resolving, active, tracking, completed, stopped. `active` also matches `tracking`, the status of a live air shipment.",
                  "disabled": true
                },
                {
                  "key": "mode",
                  "value": "OCEAN",
                  "description": "OCEAN or AIR.",
                  "disabled": true
                },
                {
                  "key": "carrier",
                  "value": "MSC",
                  "description": "Carrier code, as on the shipment (case-insensitive).",
                  "disabled": true
                },
                {
                  "key": "customerId",
                  "value": "",
                  "description": "Only shipments of this customer (Navlo's customer id).",
                  "disabled": true
                },
                {
                  "key": "customerRef",
                  "value": "C-1042",
                  "description": "Only shipments of the customer with this reference of yours.",
                  "disabled": true
                },
                {
                  "key": "tag",
                  "value": "Urgent,Q4",
                  "description": "Tag names, comma-separated: shipments carrying any of them.",
                  "disabled": true
                },
                {
                  "key": "risk",
                  "value": "HIGH",
                  "description": "Risk levels, comma-separated: LOW, MEDIUM, HIGH. Only current assessments count.",
                  "disabled": true
                },
                {
                  "key": "etaFrom",
                  "value": "2026-11-01",
                  "description": "ETA on or after this time (any container or waybill). Carrier times are port-local with a Z suffix and are compared as written. ISO-8601 timestamp or date.",
                  "disabled": true
                },
                {
                  "key": "etaTo",
                  "value": "2026-11-30",
                  "description": "ETA on or before this time; a date means the end of that day.",
                  "disabled": true
                },
                {
                  "key": "createdFrom",
                  "value": "2026-10-01T00:00:00Z",
                  "description": "Created in Navlo on or after this time (UTC).",
                  "disabled": true
                },
                {
                  "key": "createdTo",
                  "value": "",
                  "description": "Created in Navlo on or before this time (UTC); a date means the end of that day.",
                  "disabled": true
                },
                {
                  "key": "updatedSince",
                  "value": "2026-10-22T08:00:00Z",
                  "description": "Only shipments that changed (status, ETA, discovery outcome) at or after this time, UTC. Pass the newest lastChangedAt you have seen to sync incrementally.",
                  "disabled": true
                },
                {
                  "key": "sort",
                  "value": "-updatedAt",
                  "description": "createdAt, -createdAt (newest first), updatedAt, -updatedAt, eta, -eta (shipments without an ETA last). Without sort and filters the list keeps its original order.",
                  "disabled": true
                },
                {
                  "key": "include",
                  "value": "customer,risk",
                  "description": "Extra keys on each item, comma-separated: customer, tags, risk, lastChangedAt.",
                  "disabled": true
                }
              ]
            },
            "description": "List shipments\n\nYour organization's shipments, a page at a time. Filter by status, mode, carrier, customer, tag, risk and date ranges, sort, and add per-item keys with `include`. Without any of these the list keeps its original order; for a stable order across pages pass `sort`. Sync changes incrementally with `updatedSince` and `include=lastChangedAt`."
          }
        },
        {
          "name": "Start tracking a shipment",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments"
              ]
            },
            "description": "Start tracking a shipment\n\nStarts tracking a container, B/L, booking or air waybill number. A number your organization already tracks is returned as it is and costs nothing; a new one costs 1 tracking credit. With `customer`, the shipment is filed under that customer — also when it already existed.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"carrier\": \"MSC\",\n  \"customer\": {\n    \"id\": \"0c7d2f6e-3a41-4b0e-9a55-1f2b3c4d5e6f\",\n    \"name\": \"Acme Trading Ltd.\",\n    \"ref\": \"C-1042\"\n  },\n  \"identifier\": \"MEDU1234562\",\n  \"mode\": \"OCEAN\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Start tracking up to 50 shipments",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                "batch"
              ]
            },
            "description": "Start tracking up to 50 shipments\n\nOne call, one rate-limit hit. Items succeed or fail on their own: a failing item reports its error and the others still start. Each item takes the same fields as a single start, `customer` included.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"shipments\": [\n    {\n      \"carrier\": \"MSC\",\n      \"customer\": {\n        \"id\": \"0c7d2f6e-3a41-4b0e-9a55-1f2b3c4d5e6f\",\n        \"name\": \"Acme Trading Ltd.\",\n        \"ref\": \"C-1042\"\n      },\n      \"identifier\": \"MEDU1234562\",\n      \"mode\": \"OCEAN\"\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Update a shipment",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Update a shipment\n\nChanges only the keys you send. Today that is `customer`: an object files the shipment under that customer (a new `ref` creates the customer), `null` clears it.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"customer\": {\n    \"id\": \"0c7d2f6e-3a41-4b0e-9a55-1f2b3c4d5e6f\",\n    \"name\": \"Acme Trading Ltd.\",\n    \"ref\": \"C-1042\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a shipment",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Delete a shipment\n\nRemoves the shipment and its history. Credits already spent are not refunded — use /stop to just end updates."
          }
        },
        {
          "name": "Resume tracking",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/resume",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "resume"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Resume tracking\n\nRestarts refreshing a stopped shipment. Idempotent."
          }
        },
        {
          "name": "Get a shipment's route",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/route",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "route"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Get a shipment's route\n\nThe map geometry Navlo draws for the shipment, as GeoJSON: sea legs follow shipping lanes, inland and air legs are straight. Coordinates are [longitude, latitude]."
          }
        },
        {
          "name": "Stop tracking",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/stop",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "stop"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Stop tracking\n\nStops refreshing the shipment. Its history and last status stay, and /resume restarts it. Idempotent."
          }
        }
      ]
    },
    {
      "name": "Shipment intelligence",
      "item": [
        {
          "name": "Get a shipment",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id"
              ],
              "query": [
                {
                  "key": "include",
                  "value": "risk,navloEta,dnd",
                  "description": "Comma-separated: risk, recommendations, navloEta, dnd, carbon, alerts, customer, tags, details — or all.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Get a shipment\n\nThe shipment with its containers or air waybills, merged timeline, ETA history and vessel position. Add Shipment intelligence with `include`; each requested key is always present, null when there is nothing."
          }
        }
      ]
    },
    {
      "name": "Shipment actions",
      "item": [
        {
          "name": "Change the carrier",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/carrier",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "carrier"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Change the carrier\n\nWhen Navlo picked the wrong carrier: the carrier data is discarded and the shipment is discovered again with the carrier you name. Notes, tags, documents and the customer stay. Allowed once per shipment — a second change is a 409. An unknown carrier is a 400 and does not use up the change.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"carrier\": \"MSC\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Mark as completed",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/complete",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "complete"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Mark as completed\n\nDeclares the shipment done: polling stops and it leaves the active views. No completion email is sent for your own action. Idempotent."
          }
        },
        {
          "name": "List a shipment's documents",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/documents",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "documents"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "List a shipment's documents\n\nFiles attached on the shipment's Documents tab, newest first."
          }
        },
        {
          "name": "Upload a document",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/documents",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "documents"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Upload a document\n\nmultipart/form-data with the file in `file`. Same limits as the app: up to 10 MB; PDF, PNG, JPG, TIFF, BMP, CSV, XLS, XLSX, DOC or DOCX.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "documentType",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "file",
                  "type": "file",
                  "src": ""
                }
              ]
            }
          }
        },
        {
          "name": "Delete a document",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/documents/:documentId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "documents",
                ":documentId"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                },
                {
                  "key": "documentId",
                  "value": "",
                  "description": "Document id."
                }
              ]
            },
            "description": "Delete a document"
          }
        },
        {
          "name": "Get a download link",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/documents/:documentId/download",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "documents",
                ":documentId",
                "download"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                },
                {
                  "key": "documentId",
                  "value": "",
                  "description": "Document id."
                }
              ]
            },
            "description": "Get a download link\n\nA signed link to the file, valid for 15 minutes."
          }
        },
        {
          "name": "Mute notifications",
          "request": {
            "method": "PUT",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/mute",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "mute"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Mute notifications\n\nNo Navlo email, push, in-app or digest notification about this shipment reaches anyone — your team, subscribers or share recipients. Webhooks keep firing. Allowed for organization admins and whoever added the shipment. Idempotent."
          }
        },
        {
          "name": "Unmute notifications",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/mute",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "mute"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Unmute notifications\n\nSame permission as muting. Idempotent."
          }
        },
        {
          "name": "List a shipment's notes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/notes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "notes"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "0-based page number.",
                  "disabled": true
                },
                {
                  "key": "size",
                  "value": "20",
                  "description": "Page size, 1–100.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "List a shipment's notes\n\nThe notes your team wrote on the shipment, newest first."
          }
        },
        {
          "name": "Add a note",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/notes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "notes"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Add a note\n\nWritten as the API key's creator; teammates mentioned with the app's markup are notified as in the app.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"content\": \"Customer asked for delivery before Friday.\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Edit a note",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/notes/:noteId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "notes",
                ":noteId"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                },
                {
                  "key": "noteId",
                  "value": "",
                  "description": "Note id."
                }
              ]
            },
            "description": "Edit a note\n\nOnly the note's author can edit it (403 otherwise), as in the app.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"content\": \"Customer asked for delivery before Friday.\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a note",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/notes/:noteId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "notes",
                ":noteId"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                },
                {
                  "key": "noteId",
                  "value": "",
                  "description": "Note id."
                }
              ]
            },
            "description": "Delete a note\n\nOnly the note's author can delete it (403 otherwise), as in the app."
          }
        },
        {
          "name": "Create the public share link",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/share-link",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "share-link"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Create the public share link\n\nA read-only page anyone with the link can open — carrier facts only, no notes, documents or customer. Idempotent: an existing link is returned unchanged."
          }
        },
        {
          "name": "Revoke the public share link",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/share-link",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "share-link"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Revoke the public share link\n\nThe old link stops working. Idempotent."
          }
        },
        {
          "name": "List email subscribers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/subscribers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "subscribers"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "List email subscribers\n\nPeople outside Navlo who get an email when this shipment's status changes."
          }
        },
        {
          "name": "Share by email and subscribe",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/subscribers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "subscribers"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Share by email and subscribe\n\nEmails the shipment's share link to each address (creating the link if there is none) and subscribes them to status-change emails until they unsubscribe — the app's Share by email with status updates on. Adding an address again updates its event selection. Your organization can email at most 500 recipients per 24 hours, app and API together; a request that would go over answers `429` and emails nobody.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"emails\": [\n    \"ops@acme-trading.example\"\n  ],\n  \"events\": [\n    \"TRANSIT\",\n    \"DESTINATION\"\n  ],\n  \"note\": \"Here is the live status of your order.\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Unsubscribe an address",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/subscribers/:subscriberId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "subscribers",
                ":subscriberId"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                },
                {
                  "key": "subscriberId",
                  "value": "",
                  "description": "Subscriber id."
                }
              ]
            },
            "description": "Unsubscribe an address\n\nSame effect as the recipient's own unsubscribe link. Idempotent."
          }
        }
      ]
    },
    {
      "name": "Tags",
      "item": [
        {
          "name": "Tag a shipment",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/tags",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "tags"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                }
              ]
            },
            "description": "Tag a shipment\n\nSend `tagId`, or `name` — a name is matched regardless of case and the tag is created when it does not exist. Adding a tag the shipment already has changes nothing. Answers with the shipment's tags.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Urgent\",\n  \"tagId\": null\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Remove a tag from a shipment",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/shipments/:id/tags/:tagId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "shipments",
                ":id",
                "tags",
                ":tagId"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Shipment id."
                },
                {
                  "key": "tagId",
                  "value": "",
                  "description": "Tag id."
                }
              ]
            },
            "description": "Remove a tag from a shipment\n\nIdempotent. The tag itself stays in your organization. Answers with the shipment's remaining tags."
          }
        },
        {
          "name": "List tags",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/tags",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "tags"
              ]
            },
            "description": "List tags\n\nEvery tag in your organization, by name."
          }
        },
        {
          "name": "Create a tag",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/tags",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "tags"
              ]
            },
            "description": "Create a tag\n\nA name already used in your organization (any case) is a 409.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"color\": \"#ef4444\",\n  \"name\": \"Urgent\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a tag",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/tags/:tagId",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "tags",
                ":tagId"
              ],
              "variable": [
                {
                  "key": "tagId",
                  "value": "",
                  "description": "Tag id."
                }
              ]
            },
            "description": "Delete a tag\n\nRemoves the tag from every shipment. Organization admins only (403 otherwise), as in the app."
          }
        }
      ]
    },
    {
      "name": "Vessels",
      "item": [
        {
          "name": "List followed vessels",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/vessels/follows",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "vessels",
                "follows"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "Page number, 0-based.",
                  "disabled": true
                },
                {
                  "key": "size",
                  "value": "20",
                  "description": "Page size, at most 100.",
                  "disabled": true
                }
              ]
            },
            "description": "List followed vessels\n\nActive follows first, then completed ones; newest first within each."
          }
        },
        {
          "name": "Follow a vessel",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/vessels/follows",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "vessels",
                "follows"
              ]
            },
            "description": "Follow a vessel\n\nStarts tracking the vessel's voyage and charges it (see the quote). Following a vessel you already track returns that follow and charges nothing; following one whose voyage is completed starts its next voyage. 402 when your credits do not cover the voyage, 409 when your organization already follows 50 vessels.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"customer\": {\n    \"id\": \"0c7d2f6e-3a41-4b0e-9a55-1f2b3c4d5e6f\",\n    \"name\": \"Acme Trading Ltd.\",\n    \"ref\": \"C-1042\"\n  },\n  \"flag\": \"LR\",\n  \"imo\": \"9811000\",\n  \"mmsi\": \"636019825\",\n  \"name\": \"MSC ANNA\",\n  \"vesselType\": \"Container Ship\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Quote a follow",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/vessels/follows/quote",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "vessels",
                "follows",
                "quote"
              ]
            },
            "description": "Quote a follow\n\nWhat following this vessel will cost, before you follow it. Nothing is written or charged.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"customer\": {\n    \"id\": \"0c7d2f6e-3a41-4b0e-9a55-1f2b3c4d5e6f\",\n    \"name\": \"Acme Trading Ltd.\",\n    \"ref\": \"C-1042\"\n  },\n  \"flag\": \"LR\",\n  \"imo\": \"9811000\",\n  \"mmsi\": \"636019825\",\n  \"name\": \"MSC ANNA\",\n  \"vesselType\": \"Container Ship\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Get a followed vessel",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/vessels/follows/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "vessels",
                "follows",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Follow id."
                }
              ]
            },
            "description": "Get a followed vessel\n\nThe follow with its position, voyage, ETA history, port calls and events."
          }
        },
        {
          "name": "Stop following a vessel",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/vessels/follows/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "vessels",
                "follows",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Follow id."
                }
              ]
            },
            "description": "Stop following a vessel\n\nRemoves the vessel from your list. Credits already spent are not refunded."
          }
        },
        {
          "name": "Complete a voyage",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/vessels/follows/:id/complete",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "vessels",
                "follows",
                ":id",
                "complete"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Follow id."
                }
              ]
            },
            "description": "Complete a voyage\n\nMarks the voyage completed: it stays in the list as completed. Idempotent."
          }
        },
        {
          "name": "Search vessels",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/vessels/search",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "vessels",
                "search"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "MSC ANNA",
                  "description": "Vessel name, IMO or MMSI.",
                  "disabled": false
                }
              ]
            },
            "description": "Search vessels\n\nSearches Navlo's vessel catalogue by name (3+ characters), IMO (7 digits) or MMSI (9 digits). Free. A vessel the catalogue does not know can still be followed by its IMO or MMSI."
          }
        }
      ]
    },
    {
      "name": "Webhooks",
      "item": [
        {
          "name": "List webhooks",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks"
              ]
            },
            "description": "List webhooks\n\nEvery endpoint of your organization, including ones Navlo switched off."
          }
        },
        {
          "name": "Create a webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks"
              ]
            },
            "description": "Create a webhook\n\nOrganization admins only. The URL must be https; at most 10 endpoints per organization. The response carries the signing secret — the only time it is shown.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"ERP production\",\n  \"topics\": null,\n  \"url\": \"https://erp.example.com/hooks/navlo\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "List topics",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/topics",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                "topics"
              ]
            },
            "description": "List topics\n\nThe events an endpoint can subscribe to."
          }
        },
        {
          "name": "Get a webhook",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Webhook id."
                }
              ]
            },
            "description": "Get a webhook"
          }
        },
        {
          "name": "Update a webhook",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Webhook id."
                }
              ]
            },
            "description": "Update a webhook\n\nOrganization admins only. Only the keys you send change. Re-activating an endpoint clears its failure count.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"active\": null,\n  \"name\": null,\n  \"topics\": null,\n  \"url\": null\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a webhook",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Webhook id."
                }
              ]
            },
            "description": "Delete a webhook\n\nOrganization admins only. Deliveries stop at once."
          }
        },
        {
          "name": "List deliveries",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id/deliveries",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id",
                "deliveries"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "0-based page.",
                  "disabled": true
                },
                {
                  "key": "size",
                  "value": "20",
                  "description": "Page size, 1 to 100.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Webhook id."
                }
              ]
            },
            "description": "List deliveries\n\nWhat Navlo sent this endpoint and how it answered, newest first. Kept 30 days."
          }
        },
        {
          "name": "Rotate the signing secret",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id/rotate-secret",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id",
                "rotate-secret"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Webhook id."
                }
              ]
            },
            "description": "Rotate the signing secret\n\nOrganization admins only. Returns the new secret once; every delivery from now on, retries included, is signed with it."
          }
        },
        {
          "name": "Send a test event",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/:id/test",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                ":id",
                "test"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "Webhook id."
                }
              ]
            },
            "description": "Send a test event\n\nOrganization admins only. Queues a sample event of the topic (default shipment.status_changed) to this endpoint, signed and retried like a real one, with \"test\": true and a sample shipment. Arrives within a minute.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"topic\": \"shipment.eta_changed\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    }
  ]
}
