{ "item": [ { "name": "Index", "description": "Trade-level weekly rate index across the tracked regional lanes.", "item": [ { "id": "271650c9-1ad6-4303-83f0-a2eb5fab5b53", "name": "Latest rate index", "request": { "name": "Latest rate index", "description": { "content": "The latest weekly rate index for every tracked trade bucket (one row per `line_category_id`), with average 20GP/40GP/40HC, the 40HC median/min/max, sample size and average transit days. This is the trade-level benchmark each lane's `line_premium` is measured against.", "type": "text/plain" }, "url": { "path": [ "indices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e265e35b-7d55-4e0c-8980-38e845ff08ea", "name": "Latest rate index rows (one per trade bucket).", "originalRequest": { "url": { "path": [ "indices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"data\": [\n {\n \"line_category_id\": \"\",\n \"line_category\": \"\",\n \"week\": \"\",\n \"lane_count\": \"\",\n \"sample_size\": \"\",\n \"avg_20gp\": \"\",\n \"avg_40gp\": \"\",\n \"avg_40hc\": \"\",\n \"median_40hc\": \"\",\n \"min_40hc\": \"\",\n \"max_40hc\": \"\",\n \"avg_transit_days\": \"\",\n \"currency\": \"\",\n \"key_0\": 472.6494659304981,\n \"key_1\": 9206\n },\n {\n \"line_category_id\": \"\",\n \"line_category\": \"\",\n \"week\": \"\",\n \"lane_count\": \"\",\n \"sample_size\": \"\",\n \"avg_20gp\": \"\",\n \"avg_40gp\": \"\",\n \"avg_40hc\": \"\",\n \"median_40hc\": \"\",\n \"min_40hc\": \"\",\n \"max_40hc\": \"\",\n \"avg_transit_days\": \"\",\n \"currency\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90f86245-55ee-4f1a-8063-1f9e802d8d27", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "indices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f5cf8ff-b158-45de-a102-4469f3e29fef", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "indices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f30078c-b964-42b9-87ce-0c534fe9cda4", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "indices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d167d05-0bb1-43d7-b8f4-02d4b081795b", "name": "The rate data could not be read (`server_error`). Safe to retry.", "originalRequest": { "url": { "path": [ "indices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27f23429-f2ce-4004-9477-1d6e49952381", "name": "Key verification or the entitlement check is temporarily unavailable (`auth_unavailable`). Safe to retry.", "originalRequest": { "url": { "path": [ "indices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Lanes", "description": "Per-lane indicative rate, the sailing cards behind it, and daily rate history — keyed by origin/destination UN/LOCODE.", "item": [ { "id": "2986ad60-78d0-4e61-a702-3a9d2202111f", "name": "Indicative rate for one lane", "request": { "name": "Indicative rate for one lane", "description": { "content": "The single latest indicative rate card for a port-pair: 20GP/40GP/40HC prices, the representative carrier/vessel/voyage, service mode, transit days and next ETD/ETA. Requires both `pol` and `pod`.", "type": "text/plain" }, "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "587f1dc6-8c0b-4644-8da4-876d4e034a61", "name": "The latest indicative rate for the lane.", "originalRequest": { "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"data\": {\n \"pol_code\": \"\",\n \"pol_name\": \"\",\n \"pol_country\": \"\",\n \"pol_terminal\": \"\",\n \"pod_code\": \"\",\n \"pod_name\": \"\",\n \"pod_country\": \"\",\n \"pod_terminal\": \"\",\n \"carrier\": \"\",\n \"vessel\": \"\",\n \"voyage\": \"\",\n \"route_code\": \"\",\n \"service_mode\": \"\",\n \"is_via\": \"\",\n \"transit_days\": \"\",\n \"etd\": \"\",\n \"eta\": \"\",\n \"price_20gp\": \"\",\n \"price_40gp\": \"\",\n \"price_40hc\": \"\",\n \"currency\": \"\",\n \"line_category\": \"\",\n \"line_category_id\": \"\",\n \"source_updated_at\": \"\",\n \"last_seen_at\": \"\",\n \"carrier_logo\": \"\",\n \"source\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "585a1d9d-224b-4d37-b23c-463e7de7cc61", "name": "Both `pol` and `pod` query params are required (`invalid_request`).", "originalRequest": { "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bd6b09d-d150-4ec7-b7bb-b4f3896e9f7f", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87a4b96e-bc3b-4442-8159-aca2eb1764c6", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d11282b-a6ab-4abd-914a-2f9babd7d4a4", "name": "No indicative rate exists for the requested port-pair (`not_found`).", "originalRequest": { "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a524e355-aa9f-4959-a631-74572588526f", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8477a35f-2019-4614-b141-0892c5a7aeea", "name": "The rate data could not be read (`server_error`). Safe to retry.", "originalRequest": { "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6ec31bd-f07f-4637-b1ea-f7f7249c96e6", "name": "Key verification or the entitlement check is temporarily unavailable (`auth_unavailable`). Safe to retry.", "originalRequest": { "url": { "path": [ "lane" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2a6418d-d448-4492-b6d9-aff1d245f3bb", "name": "Sailing cards behind a lane", "request": { "name": "Sailing cards behind a lane", "description": { "content": "Every individual sailing card harvested for the port-pair (the rows the single `/lane` rate is distilled from), ordered by ETD ascending. Each card carries its own carrier, vessel, voyage and prices. `raw` is always `null`. Requires both `pol` and `pod`. Paginated: pass `limit`/`offset` and read `total`/`has_more` to walk every sailing (a dense lane can hold more than one page). Optional `carrier` and `etd_from`/`etd_to` filters narrow the result.", "type": "text/plain" }, "url": { "path": [ "lane", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1-1000 (the database row ceiling). Defaults to 1000.", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "Row cursor; use with limit to page through total. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Case-insensitive exact carrier filter, e.g. MAERSK.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or after this date-time (inclusive).", "type": "text/plain" }, "key": "etd_from", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or before this date-time (inclusive).", "type": "text/plain" }, "key": "etd_to", "value": "" }, { "disabled": false, "description": { "content": "Short spelling of etd_from (etd_from wins when both are sent). The word today means the current UTC date, e.g. from=today for upcoming sailings only.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Order of the cards, always ascending: etd (default, soonest first) or a price, cheapest first. Alias: order. An unknown value falls back to etd. (This can only be one of etd,price_40hc,price_40gp,price_20gp)", "type": "text/plain" }, "key": "sort", "value": "etd" }, { "disabled": false, "description": { "content": "true returns the cheapest current card per carrier: from defaults to today, expired prices are left out, and total counts carriers.", "type": "text/plain" }, "key": "compact", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "985537e4-f868-4d64-862f-67defc3d6b88", "name": "A page of sailing cards for the lane (possibly empty), with pagination totals.", "originalRequest": { "url": { "path": [ "lane", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1-1000 (the database row ceiling). Defaults to 1000.", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "Row cursor; use with limit to page through total. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Case-insensitive exact carrier filter, e.g. MAERSK.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or after this date-time (inclusive).", "type": "text/plain" }, "key": "etd_from", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or before this date-time (inclusive).", "type": "text/plain" }, "key": "etd_to", "value": "" }, { "disabled": false, "description": { "content": "Short spelling of etd_from (etd_from wins when both are sent). The word today means the current UTC date, e.g. from=today for upcoming sailings only.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Order of the cards, always ascending: etd (default, soonest first) or a price, cheapest first. Alias: order. An unknown value falls back to etd. (This can only be one of etd,price_40hc,price_40gp,price_20gp)", "type": "text/plain" }, "key": "sort", "value": "etd" }, { "disabled": false, "description": { "content": "true returns the cheapest current card per carrier: from defaults to today, expired prices are left out, and total counts carriers.", "type": "text/plain" }, "key": "compact", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"data\": [\n {\n \"por_code\": null,\n \"pdl_code\": \"string\",\n \"valid_to\": \"1984-01-19\",\n \"raw\": null,\n \"pol_code\": \"\",\n \"pol_name\": \"\",\n \"pol_country\": \"\",\n \"pol_terminal\": \"\",\n \"pod_code\": \"\",\n \"pod_name\": \"\",\n \"pod_country\": \"\",\n \"pod_terminal\": \"\",\n \"carrier\": \"\",\n \"vessel\": \"\",\n \"voyage\": \"\",\n \"route_code\": \"\",\n \"service_mode\": \"\",\n \"is_via\": \"\",\n \"transit_days\": \"\",\n \"etd\": \"\",\n \"eta\": \"\",\n \"price_20gp\": \"\",\n \"price_40gp\": \"\",\n \"price_40hc\": \"\",\n \"currency\": \"\",\n \"line_category\": \"\",\n \"line_category_id\": \"\",\n \"source_updated_at\": \"\",\n \"last_seen_at\": \"\",\n \"carrier_logo\": \"\",\n \"source\": \"\"\n },\n {\n \"por_code\": \"string\",\n \"pdl_code\": \"string\",\n \"valid_to\": null,\n \"raw\": null,\n \"pol_code\": \"\",\n \"pol_name\": \"\",\n \"pol_country\": \"\",\n \"pol_terminal\": \"\",\n \"pod_code\": \"\",\n \"pod_name\": \"\",\n \"pod_country\": \"\",\n \"pod_terminal\": \"\",\n \"carrier\": \"\",\n \"vessel\": \"\",\n \"voyage\": \"\",\n \"route_code\": \"\",\n \"service_mode\": \"\",\n \"is_via\": \"\",\n \"transit_days\": \"\",\n \"etd\": \"\",\n \"eta\": \"\",\n \"price_20gp\": \"\",\n \"price_40gp\": \"\",\n \"price_40hc\": \"\",\n \"currency\": \"\",\n \"line_category\": \"\",\n \"line_category_id\": \"\",\n \"source_updated_at\": \"\",\n \"last_seen_at\": \"\",\n \"carrier_logo\": \"\",\n \"source\": \"\"\n }\n ],\n \"total\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"has_more\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24f59491-7e19-4823-a3b1-2a2f7d2b0abd", "name": "Both `pol` and `pod` query params are required (`invalid_request`).", "originalRequest": { "url": { "path": [ "lane", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1-1000 (the database row ceiling). Defaults to 1000.", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "Row cursor; use with limit to page through total. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Case-insensitive exact carrier filter, e.g. MAERSK.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or after this date-time (inclusive).", "type": "text/plain" }, "key": "etd_from", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or before this date-time (inclusive).", "type": "text/plain" }, "key": "etd_to", "value": "" }, { "disabled": false, "description": { "content": "Short spelling of etd_from (etd_from wins when both are sent). The word today means the current UTC date, e.g. from=today for upcoming sailings only.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Order of the cards, always ascending: etd (default, soonest first) or a price, cheapest first. Alias: order. An unknown value falls back to etd. (This can only be one of etd,price_40hc,price_40gp,price_20gp)", "type": "text/plain" }, "key": "sort", "value": "etd" }, { "disabled": false, "description": { "content": "true returns the cheapest current card per carrier: from defaults to today, expired prices are left out, and total counts carriers.", "type": "text/plain" }, "key": "compact", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "876be894-6f01-4f01-93c3-f5bf67e77dae", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "lane", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1-1000 (the database row ceiling). Defaults to 1000.", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "Row cursor; use with limit to page through total. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Case-insensitive exact carrier filter, e.g. MAERSK.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or after this date-time (inclusive).", "type": "text/plain" }, "key": "etd_from", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or before this date-time (inclusive).", "type": "text/plain" }, "key": "etd_to", "value": "" }, { "disabled": false, "description": { "content": "Short spelling of etd_from (etd_from wins when both are sent). The word today means the current UTC date, e.g. from=today for upcoming sailings only.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Order of the cards, always ascending: etd (default, soonest first) or a price, cheapest first. Alias: order. An unknown value falls back to etd. (This can only be one of etd,price_40hc,price_40gp,price_20gp)", "type": "text/plain" }, "key": "sort", "value": "etd" }, { "disabled": false, "description": { "content": "true returns the cheapest current card per carrier: from defaults to today, expired prices are left out, and total counts carriers.", "type": "text/plain" }, "key": "compact", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1c68091-e1d1-420f-a2bb-9c28b4b05f7a", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "lane", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1-1000 (the database row ceiling). Defaults to 1000.", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "Row cursor; use with limit to page through total. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Case-insensitive exact carrier filter, e.g. MAERSK.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or after this date-time (inclusive).", "type": "text/plain" }, "key": "etd_from", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or before this date-time (inclusive).", "type": "text/plain" }, "key": "etd_to", "value": "" }, { "disabled": false, "description": { "content": "Short spelling of etd_from (etd_from wins when both are sent). The word today means the current UTC date, e.g. from=today for upcoming sailings only.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Order of the cards, always ascending: etd (default, soonest first) or a price, cheapest first. Alias: order. An unknown value falls back to etd. (This can only be one of etd,price_40hc,price_40gp,price_20gp)", "type": "text/plain" }, "key": "sort", "value": "etd" }, { "disabled": false, "description": { "content": "true returns the cheapest current card per carrier: from defaults to today, expired prices are left out, and total counts carriers.", "type": "text/plain" }, "key": "compact", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8afa5bb5-e188-4e8f-abe9-52fd0d075d2d", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "lane", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1-1000 (the database row ceiling). Defaults to 1000.", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "Row cursor; use with limit to page through total. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Case-insensitive exact carrier filter, e.g. MAERSK.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or after this date-time (inclusive).", "type": "text/plain" }, "key": "etd_from", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or before this date-time (inclusive).", "type": "text/plain" }, "key": "etd_to", "value": "" }, { "disabled": false, "description": { "content": "Short spelling of etd_from (etd_from wins when both are sent). The word today means the current UTC date, e.g. from=today for upcoming sailings only.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Order of the cards, always ascending: etd (default, soonest first) or a price, cheapest first. Alias: order. An unknown value falls back to etd. (This can only be one of etd,price_40hc,price_40gp,price_20gp)", "type": "text/plain" }, "key": "sort", "value": "etd" }, { "disabled": false, "description": { "content": "true returns the cheapest current card per carrier: from defaults to today, expired prices are left out, and total counts carriers.", "type": "text/plain" }, "key": "compact", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd608008-3e93-4048-a14c-6c9c026def1e", "name": "The rate data could not be read (`server_error`). Safe to retry.", "originalRequest": { "url": { "path": [ "lane", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1-1000 (the database row ceiling). Defaults to 1000.", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "Row cursor; use with limit to page through total. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Case-insensitive exact carrier filter, e.g. MAERSK.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or after this date-time (inclusive).", "type": "text/plain" }, "key": "etd_from", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or before this date-time (inclusive).", "type": "text/plain" }, "key": "etd_to", "value": "" }, { "disabled": false, "description": { "content": "Short spelling of etd_from (etd_from wins when both are sent). The word today means the current UTC date, e.g. from=today for upcoming sailings only.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Order of the cards, always ascending: etd (default, soonest first) or a price, cheapest first. Alias: order. An unknown value falls back to etd. (This can only be one of etd,price_40hc,price_40gp,price_20gp)", "type": "text/plain" }, "key": "sort", "value": "etd" }, { "disabled": false, "description": { "content": "true returns the cheapest current card per carrier: from defaults to today, expired prices are left out, and total counts carriers.", "type": "text/plain" }, "key": "compact", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62cdb71c-784a-4d3e-a208-8be774415588", "name": "Key verification or the entitlement check is temporarily unavailable (`auth_unavailable`). Safe to retry.", "originalRequest": { "url": { "path": [ "lane", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Page size, 1-1000 (the database row ceiling). Defaults to 1000.", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "Row cursor; use with limit to page through total. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Case-insensitive exact carrier filter, e.g. MAERSK.", "type": "text/plain" }, "key": "carrier", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or after this date-time (inclusive).", "type": "text/plain" }, "key": "etd_from", "value": "" }, { "disabled": false, "description": { "content": "Only sailings departing on or before this date-time (inclusive).", "type": "text/plain" }, "key": "etd_to", "value": "" }, { "disabled": false, "description": { "content": "Short spelling of etd_from (etd_from wins when both are sent). The word today means the current UTC date, e.g. from=today for upcoming sailings only.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Order of the cards, always ascending: etd (default, soonest first) or a price, cheapest first. Alias: order. An unknown value falls back to etd. (This can only be one of etd,price_40hc,price_40gp,price_20gp)", "type": "text/plain" }, "key": "sort", "value": "etd" }, { "disabled": false, "description": { "content": "true returns the cheapest current card per carrier: from defaults to today, expired prices are left out, and total counts carriers.", "type": "text/plain" }, "key": "compact", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62d3be25-5ec7-4a94-ac10-87973971fc7c", "name": "Spot rates for a lane: FCL and LCL from marketplaces", "request": { "name": "Spot rates for a lane: FCL and LCL from marketplaces", "description": { "content": "Marketplace spot rates for a port-pair, stored in our database and refreshed daily, so the answer is instant. `fcl` holds one entry per offer with the 20ST, 40ST and 40HC prices side by side. `lcl` holds a ladder by shipment size (up to 1, 3 and 10 W/M, where 1 W/M is 1 m3 or 1 tonne, whichever is greater); give `cbm` and `kg` together to get the band that covers a cargo. Each offer carries `covers`: whether origin and destination charges are in the price. Sources do not all quote the same basis, so compare only offers with the same `covers`. Asking for a lane registers it for the daily refresh: a lane never asked before answers `state: queued` with empty lists and is filled within the hour. Prices are USD and indicative, not firm quotes. Requires both `pol` and `pod`.", "type": "text/plain" }, "url": { "path": [ "lane", "spot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Cargo volume in cubic metres, for an LCL estimate. Give with `kg`.", "type": "text/plain" }, "key": "cbm", "value": "" }, { "disabled": false, "description": { "content": "Cargo weight in kilograms, for an LCL estimate. Give with `cbm`.", "type": "text/plain" }, "key": "kg", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "892ccd55-f05c-4265-9b8b-83721adc0218", "name": "The stored spot rates for the lane (possibly empty while the first fetch is pending).", "originalRequest": { "url": { "path": [ "lane", "spot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Cargo volume in cubic metres, for an LCL estimate. Give with `kg`.", "type": "text/plain" }, "key": "cbm", "value": "" }, { "disabled": false, "description": { "content": "Cargo weight in kilograms, for an LCL estimate. Give with `cbm`.", "type": "text/plain" }, "key": "kg", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"data\": {\n \"pol\": \"\",\n \"pod\": \"\",\n \"state\": \"watching\",\n \"fetched_at\": \"\",\n \"fcl\": [\n {\n \"source\": \"\",\n \"carrier\": \"\",\n \"prices_usd\": {\n \"20ST\": \"\",\n \"40ST\": \"\",\n \"40HC\": \"\"\n },\n \"transit_days\": \"\",\n \"departure\": \"\",\n \"valid_until\": \"\",\n \"covers\": \"not_stated\",\n \"details\": \"\",\n \"badge\": \"\",\n \"source_url\": \"\"\n },\n {\n \"source\": \"\",\n \"carrier\": \"\",\n \"prices_usd\": {\n \"20ST\": \"\",\n \"40ST\": \"\",\n \"40HC\": \"\"\n },\n \"transit_days\": \"\",\n \"departure\": \"\",\n \"valid_until\": \"\",\n \"covers\": \"origin_destination_included\",\n \"details\": \"\",\n \"badge\": \"\",\n \"source_url\": \"\"\n }\n ],\n \"lcl\": {\n \"reference_kg_per_m3\": \"\",\n \"bands\": [\n {\n \"up_to_wm\": \"\",\n \"from_usd\": \"\",\n \"per_wm_usd\": \"\",\n \"offers\": \"\",\n \"transit_days\": [\n \"\",\n \"\"\n ],\n \"valid_until\": \"\",\n \"source\": \"\",\n \"covers\": \"origin_destination_included\"\n },\n {\n \"up_to_wm\": \"\",\n \"from_usd\": \"\",\n \"per_wm_usd\": \"\",\n \"offers\": \"\",\n \"transit_days\": null,\n \"valid_until\": \"\",\n \"source\": \"\",\n \"covers\": \"ocean_freight_only\"\n }\n ],\n \"estimate\": {\n \"kind\": \"band\",\n \"chargeable_wm\": \"\",\n \"up_to_wm\": \"\",\n \"from_usd\": \"\",\n \"heavier_than_reference\": \"\"\n }\n },\n \"notes\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7691a439-7116-487e-b6d3-3ba59c120604", "name": "Both `pol` and `pod` query params are required (`invalid_request`).", "originalRequest": { "url": { "path": [ "lane", "spot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Cargo volume in cubic metres, for an LCL estimate. Give with `kg`.", "type": "text/plain" }, "key": "cbm", "value": "" }, { "disabled": false, "description": { "content": "Cargo weight in kilograms, for an LCL estimate. Give with `cbm`.", "type": "text/plain" }, "key": "kg", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed4fbf19-ace0-4180-805f-fcf57148395a", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "lane", "spot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Cargo volume in cubic metres, for an LCL estimate. Give with `kg`.", "type": "text/plain" }, "key": "cbm", "value": "" }, { "disabled": false, "description": { "content": "Cargo weight in kilograms, for an LCL estimate. Give with `cbm`.", "type": "text/plain" }, "key": "kg", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7986a290-c3d4-4b07-8f67-5d6ddb1d8928", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "lane", "spot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Cargo volume in cubic metres, for an LCL estimate. Give with `kg`.", "type": "text/plain" }, "key": "cbm", "value": "" }, { "disabled": false, "description": { "content": "Cargo weight in kilograms, for an LCL estimate. Give with `cbm`.", "type": "text/plain" }, "key": "kg", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "defcc795-af62-4644-a7eb-7a2aa96f1c12", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "lane", "spot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Cargo volume in cubic metres, for an LCL estimate. Give with `kg`.", "type": "text/plain" }, "key": "cbm", "value": "" }, { "disabled": false, "description": { "content": "Cargo weight in kilograms, for an LCL estimate. Give with `cbm`.", "type": "text/plain" }, "key": "kg", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2a1c09a-e334-4704-84a7-cfe1cb8c84bb", "name": "The rate data could not be read (`server_error`). Safe to retry.", "originalRequest": { "url": { "path": [ "lane", "spot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" }, { "disabled": false, "description": { "content": "Cargo volume in cubic metres, for an LCL estimate. Give with `kg`.", "type": "text/plain" }, "key": "cbm", "value": "" }, { "disabled": false, "description": { "content": "Cargo weight in kilograms, for an LCL estimate. Give with `cbm`.", "type": "text/plain" }, "key": "kg", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e4f05fa-bb8e-4622-99de-34bcc5e5a677", "name": "Daily rate history for a lane", "request": { "name": "Daily rate history for a lane", "description": { "content": "The daily median rate curve for a port-pair — one point per day the lane was observed, with the 40HC and 20GP medians and the sample size that day. Ordered by day ascending, so it charts directly. Requires both `pol` and `pod`; an empty array when there is no history.", "type": "text/plain" }, "url": { "path": [ "lane", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ea4520c6-7632-4c1d-822f-347894ffb12b", "name": "Daily median history for the lane (possibly empty).", "originalRequest": { "url": { "path": [ "lane", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"data\": [\n {\n \"day\": \"\",\n \"pol_code\": \"\",\n \"pod_code\": \"\",\n \"median_40hc\": \"\",\n \"median_20gp\": \"\",\n \"sample\": \"\"\n },\n {\n \"day\": \"\",\n \"pol_code\": \"\",\n \"pod_code\": \"\",\n \"median_40hc\": \"\",\n \"median_20gp\": \"\",\n \"sample\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9262762e-6272-467e-beea-48cf695efe95", "name": "Both `pol` and `pod` query params are required (`invalid_request`).", "originalRequest": { "url": { "path": [ "lane", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e9ce003-5f3c-4b8a-8a42-287f122bb5c1", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "lane", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6093f508-5ffa-4288-a9ae-69cde5b96e50", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "lane", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3991c918-71f2-4a66-a551-a585d3a700ff", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "lane", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97cb02f9-a3d4-4c47-b293-1179a087e74f", "name": "The rate data could not be read (`server_error`). Safe to retry.", "originalRequest": { "url": { "path": [ "lane", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70e53ca9-b58e-458c-9bba-a74a47d3ebd0", "name": "Key verification or the entitlement check is temporarily unavailable (`auth_unavailable`). Safe to retry.", "originalRequest": { "url": { "path": [ "lane", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Port of loading (origin) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pol", "value": "" }, { "disabled": false, "description": { "content": "(Required) Port of discharge (destination) UN/LOCODE, case-insensitive.", "type": "text/plain" }, "key": "pod", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Spot rates", "description": "Multi-modal spot quotes from 55 connected ocean, air, road and rail sources and freight indices.", "item": [ { "id": "2f7703f0-5fa6-47e2-927c-a421d644ad20", "name": "Multi-modal spot quotes", "request": { "name": "Multi-modal spot quotes", "description": { "content": "Ranked live and indicative quotes from the connected sources (ocean FCL/LCL, air, road, rail, RoRo, freight indices). Slow marketplaces come back as `pending`: repeat the identical body after `retry_after_s` (never with `no_cache`) until `complete` is true. Indicative quotes are never bookable.", "type": "text/plain" }, "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"origin\": \"\",\n \"destination\": \"\",\n \"shipping_type\": \"AIR\",\n \"container_type\": \"20ST\",\n \"weight_kg\": \"\",\n \"volume_cbm\": \"\",\n \"pieces\": \"\",\n \"shipment_date\": \"\",\n \"road_type\": \"LTL\",\n \"rail_type\": \"FTL\",\n \"rate_mode\": \"live\",\n \"no_cache\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "06ff06c5-2b9c-4879-9b69-9dcfd93376fc", "name": "Quotes, per-source status, `complete` and `pending_providers`. Sources are not named: `provider`, `provider_id` and each `pending_providers` entry read `navo24`, `source_url` is `null`, and `booking_ref` is opaque.", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"origin\": \"\",\n \"destination\": \"\",\n \"shipping_type\": \"AIR\",\n \"container_type\": \"20ST\",\n \"weight_kg\": \"\",\n \"volume_cbm\": \"\",\n \"pieces\": \"\",\n \"shipment_date\": \"\",\n \"road_type\": \"LTL\",\n \"rail_type\": \"FTL\",\n \"rate_mode\": \"live\",\n \"no_cache\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 7344.585828660876\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87d6bd68-43e3-465c-9def-cf64584290dd", "name": "Both `pol` and `pod` query params are required (`invalid_request`).", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"origin\": \"\",\n \"destination\": \"\",\n \"shipping_type\": \"AIR\",\n \"container_type\": \"20ST\",\n \"weight_kg\": \"\",\n \"volume_cbm\": \"\",\n \"pieces\": \"\",\n \"shipment_date\": \"\",\n \"road_type\": \"LTL\",\n \"rail_type\": \"FTL\",\n \"rate_mode\": \"live\",\n \"no_cache\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5294c3b-fc79-4b98-a90c-09925d086fa9", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"origin\": \"\",\n \"destination\": \"\",\n \"shipping_type\": \"AIR\",\n \"container_type\": \"20ST\",\n \"weight_kg\": \"\",\n \"volume_cbm\": \"\",\n \"pieces\": \"\",\n \"shipment_date\": \"\",\n \"road_type\": \"LTL\",\n \"rail_type\": \"FTL\",\n \"rate_mode\": \"live\",\n \"no_cache\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec29344c-2c7b-4968-93d1-22cd712b5ee7", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"origin\": \"\",\n \"destination\": \"\",\n \"shipping_type\": \"AIR\",\n \"container_type\": \"20ST\",\n \"weight_kg\": \"\",\n \"volume_cbm\": \"\",\n \"pieces\": \"\",\n \"shipment_date\": \"\",\n \"road_type\": \"LTL\",\n \"rail_type\": \"FTL\",\n \"rate_mode\": \"live\",\n \"no_cache\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3add7f3-6b9e-4395-986a-6389af71e8a5", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"origin\": \"\",\n \"destination\": \"\",\n \"shipping_type\": \"AIR\",\n \"container_type\": \"20ST\",\n \"weight_kg\": \"\",\n \"volume_cbm\": \"\",\n \"pieces\": \"\",\n \"shipment_date\": \"\",\n \"road_type\": \"LTL\",\n \"rail_type\": \"FTL\",\n \"rate_mode\": \"live\",\n \"no_cache\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01eb3bd9-15f2-48d7-9cd7-477c78d17b6f", "name": "The spot-rate engine did not answer (`upstream_error`) or is misconfigured (`upstream_auth_failed`).", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"origin\": \"\",\n \"destination\": \"\",\n \"shipping_type\": \"AIR\",\n \"container_type\": \"20ST\",\n \"weight_kg\": \"\",\n \"volume_cbm\": \"\",\n \"pieces\": \"\",\n \"shipment_date\": \"\",\n \"road_type\": \"LTL\",\n \"rail_type\": \"FTL\",\n \"rate_mode\": \"live\",\n \"no_cache\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Gateway", "code": 502, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08173c2f-6e35-4689-9d66-36d86bea17c4", "name": "Key verification or the entitlement check is temporarily unavailable (`auth_unavailable`). Safe to retry.", "originalRequest": { "url": { "path": [ "quote" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"origin\": \"\",\n \"destination\": \"\",\n \"shipping_type\": \"AIR\",\n \"container_type\": \"20ST\",\n \"weight_kg\": \"\",\n \"volume_cbm\": \"\",\n \"pieces\": \"\",\n \"shipment_date\": \"\",\n \"road_type\": \"LTL\",\n \"rail_type\": \"FTL\",\n \"rate_mode\": \"live\",\n \"no_cache\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f35ce71a-fcea-4c4f-9eba-d3926d98d713", "name": "Booking contacts for a quote", "request": { "name": "Booking contacts for a quote", "description": { "content": "Releases the booking contacts for a `booking_ref` taken from a quote: the publicly published contacts of the company selling the rate, or the Navo24 contact. Does not place a booking.", "type": "text/plain" }, "url": { "path": [ "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "66e4aaa5-1de4-47b3-8460-e9cde09f1c25", "name": "Contacts with `contact_type` (`vendor` or `navo24`) and `verified_at`. `provider`/`provider_id` read `navo24` and `source_url` is `null`.", "originalRequest": { "url": { "path": [ "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 7344.585828660876\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0794e1a5-4ec4-43ac-9864-b1dc36c21c15", "name": "Both `pol` and `pod` query params are required (`invalid_request`).", "originalRequest": { "url": { "path": [ "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3ed09a3-1f82-426f-bf79-eaed8f4613e9", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec19a0f6-fd43-4cfb-90b5-e59a798bb640", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79902583-9338-46ec-9915-42eba5a8ffb6", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccfb58bb-a6e1-4fe0-8d16-1b91ebcaffb7", "name": "The spot-rate engine did not answer (`upstream_error`) or is misconfigured (`upstream_auth_failed`).", "originalRequest": { "url": { "path": [ "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Gateway", "code": 502, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed78613b-73a9-4e43-a66f-5a74f2d693fc", "name": "Key verification or the entitlement check is temporarily unavailable (`auth_unavailable`). Safe to retry.", "originalRequest": { "url": { "path": [ "book" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"booking_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c62f8ec2-5807-4b21-8172-06bb947563a4", "name": "Rate source registry", "request": { "name": "Rate source registry", "description": { "content": "Every rate source with mode, access type and integration status. Sources are not named: `id` and `name` read `navo24`, links read `null`.", "type": "text/plain" }, "url": { "path": [ "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "mode", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "integration", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1689e464-9ecc-4e5d-8c07-812e547e94de", "name": "The provider registry.", "originalRequest": { "url": { "path": [ "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "mode", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "integration", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 7344.585828660876\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51749798-a812-4291-b4ff-2e1436a32539", "name": "Both `pol` and `pod` query params are required (`invalid_request`).", "originalRequest": { "url": { "path": [ "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "mode", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "integration", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca260587-a5d3-472f-904b-dbda0b6d4d49", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "mode", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "integration", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "688ecb92-9158-4f09-a2c5-5cd49f7d546f", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "mode", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "integration", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7027914-5869-49b5-a802-668a36f930ae", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "mode", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "integration", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38e52afa-422a-49f8-834b-cd0e9fbf62f7", "name": "The spot-rate engine did not answer (`upstream_error`) or is misconfigured (`upstream_auth_failed`).", "originalRequest": { "url": { "path": [ "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "mode", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "integration", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36814f2c-309f-4c96-add1-c06eeb0feb60", "name": "Key verification or the entitlement check is temporarily unavailable (`auth_unavailable`). Safe to retry.", "originalRequest": { "url": { "path": [ "providers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "category", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "mode", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "integration", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7eb710b-3298-4edf-a904-33d22cef4bc2", "name": "One rate source", "request": { "name": "One rate source", "description": { "content": "Add `check=1` for a live reachability probe.", "type": "text/plain" }, "url": { "path": [ "providers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 1)", "type": "text/plain" }, "key": "check", "value": "1" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "00bf382f-e7de-48eb-a060-c72b67b671b2", "name": "One provider.", "originalRequest": { "url": { "path": [ "providers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 1)", "type": "text/plain" }, "key": "check", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 7344.585828660876\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85e9a4ae-2215-4e19-adc0-347604cc9c88", "name": "Both `pol` and `pod` query params are required (`invalid_request`).", "originalRequest": { "url": { "path": [ "providers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 1)", "type": "text/plain" }, "key": "check", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41acd177-cf8b-4038-93e6-29d482d65b8d", "name": "Missing (`missing_key`), unrecognised (`invalid_key`), revoked (`revoked_key`) or expired (`expired_key`) API key.", "originalRequest": { "url": { "path": [ "providers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 1)", "type": "text/plain" }, "key": "check", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9741e88-64cd-40d7-b550-0d3c9457c041", "name": "The key's org does not hold an active `freightrates` entitlement (`not_entitled`). On the MCP surface an org with a spendable Navo Tokens wallet needs no product row; when the wallet cannot pay for the call the code is `insufficient_credits`, `no_wallet`, `trial_expired` or `wallet_inactive`, and `error` also carries `credits_required`, `credits_balance`, `top_up_url` and `packages`.", "originalRequest": { "url": { "path": [ "providers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 1)", "type": "text/plain" }, "key": "check", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5998c0f2-fb4c-463f-b17c-ba5ea1061836", "name": "A usage window (daily / weekly / monthly / lifetime) is exhausted (`quota_exceeded`). The `X-Usage-*` response headers show which window and when it resets.", "originalRequest": { "url": { "path": [ "providers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 1)", "type": "text/plain" }, "key": "check", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The metered product for this key (`freightrates`).", "type": "text/plain" }, "key": "X-Usage-Product", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed in the current calendar month. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Used", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the monthly counter resets. Always present on a successful call.", "type": "text/plain" }, "key": "X-Usage-Monthly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Daily call cap, present only when a daily cap is set on the key.", "type": "text/plain" }, "key": "X-Usage-Daily-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed today, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Used", "value": "" }, { "disabled": false, "description": { "content": "Daily calls remaining, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the daily counter resets, present only when a daily cap is set.", "type": "text/plain" }, "key": "X-Usage-Daily-Reset", "value": "" }, { "disabled": false, "description": { "content": "Weekly (ISO week) call cap, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed this ISO week, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Used", "value": "" }, { "disabled": false, "description": { "content": "Weekly calls remaining, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "ISO 8601 timestamp when the weekly counter resets, present only when a weekly cap is set.", "type": "text/plain" }, "key": "X-Usage-Weekly-Reset", "value": "" }, { "disabled": false, "description": { "content": "Monthly call cap, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Limit", "value": "" }, { "disabled": false, "description": { "content": "Monthly calls remaining, present only when a monthly cap is set.", "type": "text/plain" }, "key": "X-Usage-Monthly-Remaining", "value": "" }, { "disabled": false, "description": { "content": "Lifetime call cap, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Limit", "value": "" }, { "disabled": false, "description": { "content": "Calls consumed over the key's lifetime, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Used", "value": "" }, { "disabled": false, "description": { "content": "Lifetime calls remaining, present only when a lifetime cap is set.", "type": "text/plain" }, "key": "X-Usage-Lifetime-Remaining", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8222df79-b568-4864-a477-c200d29f994b", "name": "The spot-rate engine did not answer (`upstream_error`) or is misconfigured (`upstream_auth_failed`).", "originalRequest": { "url": { "path": [ "providers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 1)", "type": "text/plain" }, "key": "check", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b103d95d-7b9b-4e3d-b8f2-7c4c06a0313c", "name": "Key verification or the entitlement check is temporarily unavailable (`auth_unavailable`). Safe to retry.", "originalRequest": { "url": { "path": [ "providers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of 1)", "type": "text/plain" }, "key": "check", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"no_wallet\",\n \"message\": \"\",\n \"credits_required\": \"\",\n \"credits_balance\": \"\",\n \"top_up_url\": \"\",\n \"packages\": [\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n },\n {\n \"plan\": \"\",\n \"credits\": \"\",\n \"usd\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "System", "description": "Unauthenticated service health.", "item": [] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.navo24.com/v1/rates", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "info": { "_postman_id": "7b702cc6-8284-4298-b3af-c9846eb3d12b", "name": "Navo Freight Rates API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Ocean-freight spot-rate intelligence your code can read. One backend serves freightratesmcp.com: a weekly trade-level rate index, per-lane indicative rates keyed by port-pair (UN/LOCODE), the individual sailing cards behind a lane, and a daily median rate history. Every lane is derived from daily ex-Asia liner rate cards fused with SchedulesMCP reliability. No answer names where a rate came from: every `source` and `provider` value is `navo24` and every source link is `null`, with the same keys always present. Every endpoint takes `Authorization: Bearer ` (or `X-API-Key: `) — one `tmcp_` family key whose org holds an active `freightrates` product entitlement. Successful calls answer back with `X-Usage-*` headers for every cap set on the key. `GET /health` is free and unauthenticated. Browse the same rates free (no key) on the website; the programmatic API and hosted MCP server are on Pro.\n\nContact Support:\n Name: FreightRatesMCP\n Email: hello@freightratesmcp.com", "type": "text/plain" } } }