diff --git a/.cursor/rules/agent-trust.mdc b/.cursor/rules/agent-trust.mdc new file mode 100644 index 00000000..d9697fb8 --- /dev/null +++ b/.cursor/rules/agent-trust.mdc @@ -0,0 +1,14 @@ +--- +description: Terminal49/API paved path and verification gate +alwaysApply: true +--- + +# Agent trust gate + +- Extend OpenAPI endpoints, npm packages, and MCP tools through + `skills/agent-trust/references/paved-path.md`. +- Keep `skills/agent-trust/feature-map.json` synchronized with MCP tool + registrations, SDK package exports, and non-generated SDK/MCP docs routes. +- Run `npm run agent-verify` before handing off code changes. Do not claim a + passing result from `agent-verify:quick`. +- Keep generated files generated and credentials out of this public repository. diff --git a/.cursor/rules/pstack-onboarding.mdc b/.cursor/rules/pstack-onboarding.mdc new file mode 100644 index 00000000..c2185b3a --- /dev/null +++ b/.cursor/rules/pstack-onboarding.mdc @@ -0,0 +1,14 @@ +--- +description: Repository-local P-Stack routing +alwaysApply: true +--- + +# P-Stack + +For non-trivial Terminal49/API work, use the installed P-Stack plugin's +`/poteto-mode` workflow when available. Use `/how` for unfamiliar subsystems +and `/reflect` to turn durable lessons into executable guards. The agent-trust +rule owns the repository verification gate. + +Model and reasoning-budget choices belong in the user-local file created by +`/setup-pstack`; never commit personal model slugs. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 567e0e2c..8504a37b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,7 +4,6 @@ on: push: branches: [main, master, feature/**] pull_request: - branches: [main, master, feature/**, cursor/vite-plus-toolchain-cdbd] permissions: contents: read @@ -24,12 +23,8 @@ jobs: cache-dependency-path: package-lock.json - name: Install workspace dependencies run: npm ci - - name: Check root and every workspace - run: npx vp run check - - name: Test every workspace - run: npx vp run test - - name: Build every workspace - run: npx vp run build + - name: Verify agent paved path + run: npm run agent-verify # Consumer compatibility: the standalone SDK lockfile on every supported # Node version, with no workspace tooling involved. diff --git a/AGENTS.md b/AGENTS.md index 125a16bb..2dff98b1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -73,6 +73,14 @@ For substantive documentation writing, use the repo-local skill at `skills/termi - CI (`.github/workflows/ci.yml`) runs build + test + lint for both packages. - Running the MCP server locally + testing tool calls with Claude Desktop (stdio and gateway paths): [packages/mcp/LOCAL_DEV.md](packages/mcp/LOCAL_DEV.md). Gateway env template: `.env.local.example`. +### Agent paved path + +- Read [`skills/agent-trust/SKILL.md`](skills/agent-trust/SKILL.md) before adding or changing an OpenAPI endpoint, npm package, MCP tool, SDK entrypoint, or SDK/MCP docs route. +- Extend the repository through [`skills/agent-trust/references/paved-path.md`](skills/agent-trust/references/paved-path.md); do not create alternate registration, generation, or verification flows. +- Keep [`skills/agent-trust/feature-map.json`](skills/agent-trust/feature-map.json) synchronized in the same commit. CI rejects MCP tool, SDK export, and docs-route drift. +- Run `npm run agent-verify` before handoff. `npm run agent-verify:quick` is for iteration and is not the completion gate. +- P-Stack is optional user tooling, not a repository dependency. Install it with `/add-plugin pstack`, then run `/setup-pstack` to choose a user-local model budget. Repository wiring is in [`skills/agent-trust/references/pstack.md`](skills/agent-trust/references/pstack.md). + --- ## MCP Auth Gateway notes diff --git a/Terminal49-API.postman_collection.json b/Terminal49-API.postman_collection.json index 1000252d..ece7bdba 100644 --- a/Terminal49-API.postman_collection.json +++ b/Terminal49-API.postman_collection.json @@ -5,7 +5,7 @@ "description": "", "item": [ { - "id": "05d2af2b-f34f-421e-8884-a8d2a871fdae", + "id": "981bef4f-c132-4e35-938d-f1ba016a0222", "name": "List containers", "request": { "name": "List containers", @@ -63,7 +63,7 @@ }, "response": [ { - "id": "96238af0-589a-41f7-ab05-f43fd0b1aae6", + "id": "fae27fa5-2f3b-4261-a400-c81204d8a0ed", "name": "OK", "originalRequest": { "url": { @@ -129,7 +129,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"open top\",\n \"equipment_length\": 40,\n \"equipment_height\": null,\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"extended_dwell_time\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"exam\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"dropped\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"open top\",\n \"equipment_length\": 45,\n \"equipment_height\": \"standard\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"exam\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"delivered\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"booking_cancelled\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"cancelled_by_user\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": null,\n \"equipment_length\": 45,\n \"equipment_height\": \"standard\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"total\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"extended_dwell_time\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"grounded\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"open top\",\n \"equipment_length\": 10,\n \"equipment_height\": null,\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"exam\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"extended_dwell_time\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"picked_up\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"cancelled_by_user\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -140,7 +140,7 @@ } }, { - "id": "39edb41f-c70e-4a36-b5d4-5fed3875f09d", + "id": "5e801780-7336-43ab-9f98-290a427d4ea7", "name": "Edit a container", "request": { "name": "Edit a container", @@ -171,7 +171,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_numbers\": [\n \"\",\n \"\"\n ]\n },\n \"type\": true\n }\n}", + "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_numbers\": [\n \"\",\n \"\"\n ]\n },\n \"type\": 4162\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -183,7 +183,7 @@ }, "response": [ { - "id": "d71433ac-b8dc-44e7-8663-f13601aafd26", + "id": "782ac324-fe04-4d27-a67d-81d9d6ee72e6", "name": "OK", "originalRequest": { "url": { @@ -217,7 +217,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_numbers\": [\n \"\",\n \"\"\n ]\n },\n \"type\": true\n }\n}", + "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_numbers\": [\n \"\",\n \"\"\n ]\n },\n \"type\": 4162\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -234,7 +234,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"dry\",\n \"equipment_length\": null,\n \"equipment_height\": \"standard\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"total\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"total\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"available\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"dry\",\n \"equipment_length\": null,\n \"equipment_height\": \"standard\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"total\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"loaded\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -245,7 +245,7 @@ } }, { - "id": "ad3d42f2-7116-4261-8c7b-6dbe6197f425", + "id": "f41e10d9-2b82-4286-9cb3-15b459b3380f", "name": "Get a container", "request": { "name": "Get a container", @@ -297,7 +297,7 @@ }, "response": [ { - "id": "77b26e2c-85c8-4625-a560-cc988f8a244a", + "id": "625f31e3-6ce2-497e-9778-a5c377d2e922", "name": "OK", "originalRequest": { "url": { @@ -357,7 +357,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"open top\",\n \"equipment_length\": 10,\n \"equipment_height\": \"standard\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"exam\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"new\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"booking_cancelled\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ]\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"dry\",\n \"equipment_length\": null,\n \"equipment_height\": \"high_cube\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"total\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"other\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"available\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_full_out_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"cancelled_by_user\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -368,7 +368,7 @@ } }, { - "id": "1ab16716-006f-4c0e-89c9-061e34e045b0", + "id": "232f92a4-c7ca-4811-b121-41a5fc81114b", "name": "Get a container's raw events", "request": { "name": "Get a container's raw events", @@ -411,7 +411,7 @@ }, "response": [ { - "id": "b3dcc0d4-2478-4466-8b21-97d9d0ee6726", + "id": "6a0b6b7e-7e5b-474e-86b0-06df677f2dec", "name": "OK", "originalRequest": { "url": { @@ -462,7 +462,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\",\n \"attributes\": {\n \"event\": \"vessel_loaded\",\n \"original_event\": \"\",\n \"timestamp\": \"\",\n \"estimated\": \"\",\n \"actual_on\": \"\",\n \"estimated_on\": \"\",\n \"actual_at\": \"\",\n \"estimated_at\": \"\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"location_name\": \"\",\n \"location_locode\": \"\",\n \"vessel_name\": \"\",\n \"vessel_imo\": \"\",\n \"index\": \"\",\n \"voyage_number\": \"\"\n },\n \"relationships\": {\n \"location\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"metro_area\"\n }\n },\n \"vessel\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"vessel\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\",\n \"attributes\": {\n \"event\": \"feeder_arrived\",\n \"original_event\": \"\",\n \"timestamp\": \"\",\n \"estimated\": \"\",\n \"actual_on\": \"\",\n \"estimated_on\": \"\",\n \"actual_at\": \"\",\n \"estimated_at\": \"\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"location_name\": \"\",\n \"location_locode\": \"\",\n \"vessel_name\": \"\",\n \"vessel_imo\": \"\",\n \"index\": \"\",\n \"voyage_number\": \"\"\n },\n \"relationships\": {\n \"location\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"metro_area\"\n }\n },\n \"vessel\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"vessel\"\n }\n }\n }\n }\n ]\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\",\n \"attributes\": {\n \"event\": \"transshipment_departed\",\n \"original_event\": \"\",\n \"timestamp\": \"\",\n \"estimated\": \"\",\n \"actual_on\": \"\",\n \"estimated_on\": \"\",\n \"actual_at\": \"\",\n \"estimated_at\": \"\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"location_name\": \"\",\n \"location_locode\": \"\",\n \"vessel_name\": \"\",\n \"vessel_imo\": \"\",\n \"index\": \"\",\n \"voyage_number\": \"\"\n },\n \"relationships\": {\n \"location\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"metro_area\"\n }\n },\n \"vessel\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"vessel\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\",\n \"attributes\": {\n \"event\": \"transshipment_arrived\",\n \"original_event\": \"\",\n \"timestamp\": \"\",\n \"estimated\": \"\",\n \"actual_on\": \"\",\n \"estimated_on\": \"\",\n \"actual_at\": \"\",\n \"estimated_at\": \"\",\n \"timezone\": \"\",\n \"created_at\": \"\",\n \"location_name\": \"\",\n \"location_locode\": \"\",\n \"vessel_name\": \"\",\n \"vessel_imo\": \"\",\n \"index\": \"\",\n \"voyage_number\": \"\"\n },\n \"relationships\": {\n \"location\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"port\"\n }\n },\n \"vessel\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"vessel\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -473,7 +473,7 @@ } }, { - "id": "72b4b591-7781-46ed-9844-c416f0ffdc34", + "id": "e3a5c210-fbcb-46e8-8d62-03fec2598381", "name": "Get a container's transport events", "request": { "name": "Get a container's transport events", @@ -526,7 +526,7 @@ }, "response": [ { - "id": "0ae81ca4-b178-4b31-b8bb-8c827b499f20", + "id": "b1e06109-5b7a-4d4f-9e71-4e2963288475", "name": "OK", "originalRequest": { "url": { @@ -587,7 +587,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\",\n \"attributes\": {\n \"event\": \"container.transport.vessel_departed\",\n \"voyage_number\": \"\",\n \"timestamp\": \"\",\n \"timezone\": \"\",\n \"location_locode\": \"\",\n \"created_at\": \"\",\n \"data_source\": \"shipping_line\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"location\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"port\"\n }\n },\n \"vessel\": {\n \"data\": {\n \"id\": \"\",\n \"name\": \"vessel\"\n }\n },\n \"terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"rail_terminal\"\n }\n },\n \"container\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"container\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\",\n \"attributes\": {\n \"event\": \"container.transport.rail_loaded\",\n \"voyage_number\": \"\",\n \"timestamp\": \"\",\n \"timezone\": \"\",\n \"location_locode\": \"\",\n \"created_at\": \"\",\n \"data_source\": \"terminal\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"location\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"metro_area\"\n }\n },\n \"vessel\": {\n \"data\": {\n \"id\": \"\",\n \"name\": \"vessel\"\n }\n },\n \"terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"container\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"container\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_full_out_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"no_updates_at_line\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\",\n \"attributes\": {\n \"event\": \"container.transport.feeder_discharged\",\n \"voyage_number\": \"\",\n \"timestamp\": \"\",\n \"timezone\": \"\",\n \"location_locode\": \"\",\n \"created_at\": \"\",\n \"data_source\": \"ais\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"location\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"metro_area\"\n }\n },\n \"vessel\": {\n \"data\": {\n \"id\": \"\",\n \"name\": \"vessel\"\n }\n },\n \"terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"rail_terminal\"\n }\n },\n \"container\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"container\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\",\n \"attributes\": {\n \"event\": \"container.transport.delivered\",\n \"voyage_number\": \"\",\n \"timestamp\": \"\",\n \"timezone\": \"\",\n \"location_locode\": \"\",\n \"created_at\": \"\",\n \"data_source\": \"ais\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"location\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"port\"\n }\n },\n \"vessel\": {\n \"data\": {\n \"id\": \"\",\n \"name\": \"vessel\"\n }\n },\n \"terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"rail_terminal\"\n }\n },\n \"container\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"container\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"cancelled_by_user\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": null\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -598,7 +598,198 @@ } }, { - "id": "7946c21f-55e3-4745-acce-74772c98ece5", + "id": "8b33006d-9867-4579-b911-8db1b41bbb4d", + "name": "Get a container's route", + "request": { + "name": "Get a container's route", + "description": { + "content": "Get the route and route locations for a container. This feature may not be enabled for every account.", + "type": "text/plain" + }, + "url": { + "path": [ + "containers", + ":id", + "route" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Comma-delimited relations to include", + "type": "text/plain" + }, + "key": "include", + "value": "" + } + ], + "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": "b9f875ea-933f-4312-ac2f-cd5d5e2ceea4", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "containers", + ":id", + "route" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Comma-delimited relations to include", + "type": "text/plain" + }, + "key": "include", + "value": "" + } + ], + "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: apikey", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"route\",\n \"attributes\": {\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"route_locations\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"route_location\"\n },\n {\n \"id\": \"\",\n \"type\": \"route_location\"\n }\n ]\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"route_location\",\n \"attributes\": {\n \"inbound_scac\": \"\",\n \"inbound_mode\": \"\",\n \"inbound_eta_at\": \"\",\n \"inbound_ata_at\": \"\",\n \"inbound_voyage_number\": \"\",\n \"outbound_scac\": \"\",\n \"outbound_mode\": \"\",\n \"outbound_etd_at\": \"\",\n \"outbound_atd_at\": \"\",\n \"outbound_voyage_number\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"key_1\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"route_location\",\n \"attributes\": {\n \"inbound_scac\": \"\",\n \"inbound_mode\": \"\",\n \"inbound_eta_at\": \"\",\n \"inbound_ata_at\": \"\",\n \"inbound_voyage_number\": \"\",\n \"outbound_scac\": \"\",\n \"outbound_mode\": \"\",\n \"outbound_etd_at\": \"\",\n \"outbound_atd_at\": \"\",\n \"outbound_voyage_number\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"key_0\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n }\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "862ac0bb-73cd-4b22-8d30-df750f15a21c", + "name": "Routing data is not enabled for this account", + "originalRequest": { + "url": { + "path": [ + "containers", + ":id", + "route" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Comma-delimited relations to include", + "type": "text/plain" + }, + "key": "include", + "value": "" + } + ], + "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: apikey", + "type": "text/plain" + }, + "key": "Authorization", + "value": "" + } + ], + "method": "GET", + "body": {} + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "97abe634-50bb-49cb-865b-d608b07be5b5", "name": "Get container map GeoJSON", "request": { "name": "Get container map GeoJSON", @@ -641,7 +832,7 @@ }, "response": [ { - "id": "f9a99aee-d7ee-41db-921e-cff1710d4ea2", + "id": "519d509d-4e53-4069-a638-f1546f835cd9", "name": "OK", "originalRequest": { "url": { @@ -697,7 +888,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9af05f29-c841-4838-ac84-5774e938edea", + "id": "ea20eb40-a777-4859-863d-16f6d55f7660", "name": "Forbidden - Routing data feature is not enabled for this account", "originalRequest": { "url": { @@ -759,7 +950,7 @@ } }, { - "id": "8363c387-918d-4b9a-9d53-4ec3e5190db9", + "id": "87b6b506-3999-42bc-bb51-274e4a4415ce", "name": "Refresh container", "request": { "name": "Refresh container", @@ -802,7 +993,7 @@ }, "response": [ { - "id": "252adc34-6c68-4656-877a-2cae9e4b9ab4", + "id": "41f690ca-2f07-4e9f-8ba1-b90204b6ed4b", "name": "OK", "originalRequest": { "url": { @@ -858,7 +1049,7 @@ "_postman_previewlanguage": "json" }, { - "id": "53539555-4d0a-403e-b466-7ada2945918c", + "id": "4dac2cef-55b2-4421-b9a5-57088ae7160c", "name": "Forbidden - This API endpoint is not enabled for your account. Please contact support@terminal49.com", "originalRequest": { "url": { @@ -914,7 +1105,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7ab77a3d-1eb9-45a7-b466-943c495d797e", + "id": "46bc6066-89ac-4d18-aaaf-2f93a2b11f4d", "name": "Too Many Requests - You've hit the refresh limit. Please try again in a minute.", "originalRequest": { "url": { @@ -985,7 +1176,7 @@ } }, { - "id": "e4e62a78-1483-4035-831d-365e12ac78a9", + "id": "d4d4420e-f723-4097-a012-01907e810242", "name": "List container custom fields", "request": { "name": "List container custom fields", @@ -1025,7 +1216,7 @@ }, "response": [ { - "id": "4109103c-3105-4bae-8298-50ef020ca8e7", + "id": "68d8a23e-a97e-4d5d-9ddf-b055fd43ecee", "name": "OK", "originalRequest": { "url": { @@ -1076,7 +1267,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"container\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1087,7 +1278,7 @@ } }, { - "id": "dd1ebdcc-4b80-448f-b54e-ed81f7f0dc14", + "id": "fea8e403-bf33-4a43-b6bf-77d5b99db9db", "name": "Create a container custom field", "request": { "name": "Create a container custom field", @@ -1140,7 +1331,7 @@ }, "response": [ { - "id": "9a42453a-4844-4bfa-8f55-d94fe435dd7d", + "id": "e67ab860-efb5-4cdc-9607-9d258d8e9fae", "name": "Created", "originalRequest": { "url": { @@ -1204,7 +1395,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1215,7 +1406,7 @@ } }, { - "id": "b3172cbd-dfec-4e8d-885d-e10408c080ac", + "id": "63e8d5a9-efdb-4e27-9d3a-4acac5778f05", "name": "Update a container custom field", "request": { "name": "Update a container custom field", @@ -1279,7 +1470,7 @@ }, "response": [ { - "id": "43594106-d297-4209-ace1-fc14464797b8", + "id": "865313c2-0823-49ce-bb8b-cebb9f9288f7", "name": "OK", "originalRequest": { "url": { @@ -1354,7 +1545,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1365,7 +1556,7 @@ } }, { - "id": "8568a53d-09ef-4e5f-b90c-576ed80f9fd7", + "id": "43f7b84d-9519-4ee5-bb22-3f9377c08f24", "name": "Delete a container custom field", "request": { "name": "Delete a container custom field", @@ -1410,7 +1601,7 @@ }, "response": [ { - "id": "02e249b6-afce-40d2-83af-575ddca24d5a", + "id": "c53452f4-608e-44e6-8040-e41dca935341", "name": "No Content", "originalRequest": { "url": { @@ -1479,7 +1670,7 @@ "description": "", "item": [ { - "id": "c3804357-5982-4a20-9899-7ce66c959882", + "id": "c0e1410c-831a-42ed-a311-6af22be039d5", "name": "List custom field definitions", "request": { "name": "List custom field definitions", @@ -1552,7 +1743,7 @@ }, "response": [ { - "id": "8f7b9caa-7e61-4fa0-b288-3023d7261128", + "id": "3b2a20b0-e6b5-40b0-bee8-bc84f6cc5b6c", "name": "OK", "originalRequest": { "url": { @@ -1636,7 +1827,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Shipment\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"enum\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": 2857.7642909881274\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"TrackingRequest\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"enum\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": \"string\"\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Shipment\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"boolean\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": 7420.789303126753,\n \"key_1\": 7964\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Shipment\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"datetime\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": 1549,\n \"key_1\": false\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1647,7 +1838,7 @@ } }, { - "id": "4ad98315-b5b5-4d7d-a1db-ba7c1dc5f076", + "id": "bdd6addb-fc02-42e7-a54f-e1ef7c3a3cfd", "name": "Create a custom field definition", "request": { "name": "Create a custom field definition", @@ -1675,7 +1866,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Shipment\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"enum\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": 9170,\n \"key_1\": 9570.981240950046\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Container\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"date\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": 1965.4174105538536,\n \"key_1\": 604,\n \"key_2\": 3431\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1687,7 +1878,7 @@ }, "response": [ { - "id": "010015e8-8dbe-4a48-9793-0d7cd5839b6d", + "id": "e38071b9-ea50-4053-b3f5-b0de11cf1b39", "name": "Created", "originalRequest": { "url": { @@ -1721,7 +1912,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Shipment\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"enum\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": 9170,\n \"key_1\": 9570.981240950046\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Container\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"date\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": 1965.4174105538536,\n \"key_1\": 604,\n \"key_2\": 3431\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1738,7 +1929,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Shipment\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"enum_multi\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Container\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"date\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": \"string\",\n \"key_1\": 1248.4575048411739\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1749,7 +1940,7 @@ } }, { - "id": "c4f654fa-bddd-4169-80b0-6bdb3a052e01", + "id": "695d12ad-29ba-45de-b19b-798d2694ca69", "name": "Get a custom field definition", "request": { "name": "Get a custom field definition", @@ -1788,7 +1979,7 @@ }, "response": [ { - "id": "15decfee-4600-4dd3-9760-19515380b757", + "id": "0c8fbfc6-3d3d-4ae3-b053-42ab78ca2674", "name": "OK", "originalRequest": { "url": { @@ -1838,7 +2029,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Shipment\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"enum_multi\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Container\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"date\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": \"string\",\n \"key_1\": 1248.4575048411739\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1849,7 +2040,7 @@ } }, { - "id": "6967501f-afc8-45c2-8136-e4e02676b4ec", + "id": "4dd26940-1688-406e-a6bc-2fb225cffe48", "name": "Update a custom field definition", "request": { "name": "Update a custom field definition", @@ -1889,7 +2080,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"display_name\": \"\",\n \"description\": \"\",\n \"validation\": {\n \"key_0\": false\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"display_name\": \"\",\n \"description\": \"\",\n \"validation\": {\n \"key_0\": 8704,\n \"key_1\": \"string\",\n \"key_2\": 4540\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1901,7 +2092,7 @@ }, "response": [ { - "id": "7406fcfd-1ef1-44b5-bce7-f07999bebc96", + "id": "e1b6c24c-706b-4a34-ab7d-169993661fe7", "name": "OK", "originalRequest": { "url": { @@ -1947,7 +2138,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"display_name\": \"\",\n \"description\": \"\",\n \"validation\": {\n \"key_0\": false\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"display_name\": \"\",\n \"description\": \"\",\n \"validation\": {\n \"key_0\": 8704,\n \"key_1\": \"string\",\n \"key_2\": 4540\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -1964,7 +2155,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Shipment\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"enum_multi\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field_definition\",\n \"attributes\": {\n \"entity_type\": \"Container\",\n \"api_slug\": \"\",\n \"display_name\": \"\",\n \"data_type\": \"date\",\n \"description\": \"\",\n \"reference_type\": \"\",\n \"validation\": {\n \"key_0\": \"string\",\n \"key_1\": 1248.4575048411739\n },\n \"default_format\": \"\",\n \"default_value\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -1975,7 +2166,7 @@ } }, { - "id": "b730a060-a811-47d4-b74d-b46ccdb1dc91", + "id": "fe5398d5-580b-4dc8-bda2-561f053c8ea1", "name": "Delete a custom field definition", "request": { "name": "Delete a custom field definition", @@ -2008,7 +2199,7 @@ }, "response": [ { - "id": "38a220c0-0da1-4da7-89fb-2703c1eb0266", + "id": "4e82ec19-70b6-448b-83ee-5d41d8c9d863", "name": "OK", "originalRequest": { "url": { @@ -2065,7 +2256,7 @@ "description": "", "item": [ { - "id": "cb558d13-6663-4b98-88a0-0ce4689141f7", + "id": "8cc1f532-8c71-426f-9cd7-48e0e5fa07b3", "name": "List custom field options", "request": { "name": "List custom field options", @@ -2105,7 +2296,7 @@ }, "response": [ { - "id": "cdff9a65-9dfe-4179-ae9e-bafe89b98180", + "id": "59023196-2485-466b-9aaf-84bb7a818d98", "name": "OK", "originalRequest": { "url": { @@ -2167,7 +2358,7 @@ } }, { - "id": "82eac4d3-3950-4db5-b400-0a5e669210ea", + "id": "c7c4d6ca-2e51-4de0-bc1b-c2e899dbc650", "name": "Create a custom field option", "request": { "name": "Create a custom field option", @@ -2220,7 +2411,7 @@ }, "response": [ { - "id": "26314d7b-995c-4b3f-b045-e2f8fc43d14e", + "id": "f236384e-5584-44ea-9f73-89e3ff4cf71a", "name": "Created", "originalRequest": { "url": { @@ -2295,7 +2486,7 @@ } }, { - "id": "29297d94-a0da-4c6c-9402-59a13638142a", + "id": "6144ab62-81ad-4fcb-9442-df26510c3a40", "name": "Get a custom field option", "request": { "name": "Get a custom field option", @@ -2346,7 +2537,7 @@ }, "response": [ { - "id": "1f01b2a5-e9ac-4596-8ffe-d4f59dd1676e", + "id": "a80ecbbb-c5be-4c26-93ac-f4aa68ebae6c", "name": "OK", "originalRequest": { "url": { @@ -2419,7 +2610,7 @@ } }, { - "id": "b35625ba-6127-4144-82b4-5421be8e3338", + "id": "a2ba7fb8-756d-401b-ac1f-14496967052a", "name": "Update a custom field option", "request": { "name": "Update a custom field option", @@ -2483,7 +2674,7 @@ }, "response": [ { - "id": "0a23aa15-8bde-4fb7-a171-1f5101b4512c", + "id": "29abb12b-0ff5-487c-b0b1-f35a8b779e0f", "name": "OK", "originalRequest": { "url": { @@ -2569,7 +2760,7 @@ } }, { - "id": "9c49f27f-033b-4a97-b3d9-b91d65564d68", + "id": "c55060d0-3404-4384-ad9f-8397540bbff2", "name": "Delete a custom field option", "request": { "name": "Delete a custom field option", @@ -2614,7 +2805,7 @@ }, "response": [ { - "id": "235c5fd6-c7fd-43b5-9e5d-af8de224b46d", + "id": "23d09241-369c-4a08-9bb2-580f1727ea68", "name": "OK", "originalRequest": { "url": { @@ -2683,7 +2874,7 @@ "description": "", "item": [ { - "id": "a35ee265-f99a-47c9-b36f-ca5cfcd09350", + "id": "561baf27-2fef-4769-a730-56fd3e542010", "name": "List custom fields", "request": { "name": "List custom fields", @@ -2756,7 +2947,7 @@ }, "response": [ { - "id": "f864104b-3aaf-4443-ad2b-e6476af9958e", + "id": "61bc8641-c829-4d32-a939-e5e640858de6", "name": "OK", "originalRequest": { "url": { @@ -2840,7 +3031,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"container\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -2851,7 +3042,7 @@ } }, { - "id": "0e04126c-af96-4251-9da4-0916d5183dc6", + "id": "982405d3-3f72-4ff6-936c-9932cbde4ffe", "name": "Create a custom field", "request": { "name": "Create a custom field", @@ -2891,7 +3082,7 @@ }, "response": [ { - "id": "e61fae3e-f57e-4790-8536-e1ef81d15fbf", + "id": "8ca5be19-cef4-409f-8c60-c399b41fe4ef", "name": "Created", "originalRequest": { "url": { @@ -2942,7 +3133,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -2953,7 +3144,7 @@ } }, { - "id": "355cd77d-0a26-44d0-9c72-ff83bd09050b", + "id": "c689d6c0-74d2-47aa-b0e6-baa8e07a5656", "name": "Get a custom field", "request": { "name": "Get a custom field", @@ -2992,7 +3183,7 @@ }, "response": [ { - "id": "3271adec-9e76-447d-b5b3-5f18e34d6609", + "id": "39aabe93-1af3-4700-bec4-69fad28c9c4e", "name": "OK", "originalRequest": { "url": { @@ -3042,7 +3233,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -3053,7 +3244,7 @@ } }, { - "id": "bdec162c-e967-4b3e-81b3-10c5a79c36d1", + "id": "c6a30928-5f71-4cba-a7eb-7040ead3190d", "name": "Update a custom field", "request": { "name": "Update a custom field", @@ -3105,7 +3296,7 @@ }, "response": [ { - "id": "3a2a376b-2b7d-4347-a40a-734986fdf61c", + "id": "9b716b1e-6707-495f-9b87-7a921ec26567", "name": "OK", "originalRequest": { "url": { @@ -3168,7 +3359,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -3179,7 +3370,7 @@ } }, { - "id": "2667eb2d-c340-4135-a834-9a18d01dc4a6", + "id": "245d50fa-c7de-42aa-9e25-76149f4f8670", "name": "Delete a custom field", "request": { "name": "Delete a custom field", @@ -3212,7 +3403,7 @@ }, "response": [ { - "id": "1e4f5135-2890-4fff-9dc3-02340f91c525", + "id": "8e521fb1-c875-47a3-a4bc-f37ff19343b0", "name": "OK", "originalRequest": { "url": { @@ -3269,7 +3460,7 @@ "description": "", "item": [ { - "id": "037f4c05-c0d3-4ec1-82c9-949aa5709010", + "id": "b7a33f1f-e643-40ac-ac2e-dfab3e525ac5", "name": "List shipments", "request": { "name": "List shipments", @@ -3363,7 +3554,7 @@ }, "response": [ { - "id": "7eb4d3f9-bad7-4d9c-9a82-6c9a829d8e02", + "id": "c6cefa22-5149-4f84-bd40-c8c459dbbe2c", "name": "OK", "originalRequest": { "url": { @@ -3465,12 +3656,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": null\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"bulk\",\n \"equipment_length\": 40,\n \"equipment_height\": null,\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"other\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"total\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"not_available\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"reefer\",\n \"equipment_length\": null,\n \"equipment_height\": null,\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"other\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"delivered\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"cancelled_by_user\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"reefer\",\n \"equipment_length\": 40,\n \"equipment_height\": \"standard\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"total\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"exam\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"awaiting_inland_transfer\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"bulk\",\n \"equipment_length\": 10,\n \"equipment_height\": \"standard\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"awaiting_inland_transfer\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "20a50661-3cf1-4f9f-b3c9-c6777eeed917", + "id": "dd6fbb84-f59b-4c5a-bc17-ebd2ec8d5dba", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -3572,7 +3763,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -3583,7 +3774,7 @@ } }, { - "id": "b56e253f-fb52-4520-821c-416fa6b69693", + "id": "b116536a-2d0e-4ec0-8b89-d51670f1520d", "name": "Get a shipment", "request": { "name": "Get a shipment", @@ -3644,7 +3835,7 @@ }, "response": [ { - "id": "156c3e61-db0f-4ec9-8994-7cc710b96672", + "id": "0efd23a7-0758-42f6-a898-bf10f4c2bad5", "name": "OK", "originalRequest": { "url": { @@ -3713,12 +3904,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"open top\",\n \"equipment_length\": 40,\n \"equipment_height\": \"high_cube\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"other\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"grounded\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"flat rack\",\n \"equipment_length\": 45,\n \"equipment_height\": \"high_cube\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"exam\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"total\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"new\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n }\n ]\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"no_updates_at_line\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"flat rack\",\n \"equipment_length\": 10,\n \"equipment_height\": \"high_cube\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"other\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"awaiting_inland_transfer\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"equipment_type\": \"reefer\",\n \"equipment_length\": 45,\n \"equipment_height\": \"standard\",\n \"weight_in_lbs\": \"\",\n \"created_at\": \"\",\n \"seal_number\": \"\",\n \"pickup_lfd\": \"\",\n \"pickup_appointment_at\": \"\",\n \"availability_known\": \"\",\n \"available_for_pickup\": \"\",\n \"pod_arrived_at\": \"\",\n \"pod_discharged_at\": \"\",\n \"pod_full_out_at\": \"\",\n \"terminal_checked_at\": \"\",\n \"pod_full_out_chassis_number\": \"\",\n \"location_at_pod_terminal\": \"\",\n \"final_destination_full_out_at\": \"\",\n \"empty_terminated_at\": \"\",\n \"holds_at_pod_terminal\": [\n {\n \"name\": \"\",\n \"status\": \"pending\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"status\": \"hold\",\n \"description\": \"\"\n }\n ],\n \"fees_at_pod_terminal\": [\n {\n \"type\": \"exam\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n },\n {\n \"type\": \"demurrage\",\n \"amount\": \"\",\n \"currency_code\": \"\"\n }\n ],\n \"pod_timezone\": \"\",\n \"final_destination_timezone\": \"\",\n \"empty_terminated_timezone\": \"\",\n \"pod_rail_carrier_scac\": \"\",\n \"ind_rail_carrier_scac\": \"\",\n \"pod_last_tracking_request_at\": \"\",\n \"shipment_last_tracking_request_at\": \"\",\n \"pod_rail_loaded_at\": \"\",\n \"pod_rail_departed_at\": \"\",\n \"ind_eta_at\": \"\",\n \"ind_ata_at\": \"\",\n \"ind_rail_unloaded_at\": \"\",\n \"ind_facility_lfd_on\": \"\",\n \"import_deadlines\": {\n \"pickup_lfd_terminal\": \"\",\n \"pickup_lfd_rail\": \"\",\n \"pickup_lfd_line\": \"\"\n },\n \"current_status\": \"off_dock\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"pickup_facility\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"terminal\"\n }\n },\n \"transport_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n ]\n },\n \"raw_events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n },\n {\n \"id\": \"\",\n \"type\": \"raw_event\"\n }\n ]\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "74cd9127-44b4-4767-a0c1-d562ffd2ed95", + "id": "f894fb21-13f2-4c3e-aa96-3748ffa59eae", "name": "Not Found", "originalRequest": { "url": { @@ -3787,12 +3978,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d301fa69-c8e3-4e0a-bc56-b1c380d21960", + "id": "2d0e3ac6-edac-4238-bcdc-3dafc222e1b1", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -3861,7 +4052,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -3872,7 +4063,7 @@ } }, { - "id": "05e38e27-6a79-4fa3-b5cc-2eadfc0d93d0", + "id": "0b1ab632-8485-451a-a158-0ceb5c65dec8", "name": "Edit a shipment", "request": { "name": "Edit a shipment", @@ -3927,7 +4118,7 @@ }, "response": [ { - "id": "cb07e26a-04f3-43bf-ab0a-f5d1cb986015", + "id": "afdcee8f-a738-4ef5-81a3-067a912305fc", "name": "OK", "originalRequest": { "url": { @@ -3990,7 +4181,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -4001,7 +4192,7 @@ } }, { - "id": "d698a879-ecd6-4f40-917a-2dcc99170c85", + "id": "f0960958-9a4f-483f-9121-7c18776fbfc6", "name": "Stop tracking a shipment", "request": { "name": "Stop tracking a shipment", @@ -4044,7 +4235,7 @@ }, "response": [ { - "id": "9bca05e2-67c8-4860-9193-84ffb5632c0c", + "id": "fa3bb0a5-0348-4982-bc14-b0a56245494c", "name": "OK", "originalRequest": { "url": { @@ -4095,7 +4286,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -4106,7 +4297,7 @@ } }, { - "id": "267ddb24-fcb0-4edd-913d-fcce5e980e2b", + "id": "15f6705c-6636-4a55-9a8b-b578b2db8bd6", "name": "Resume tracking a shipment", "request": { "name": "Resume tracking a shipment", @@ -4149,7 +4340,7 @@ }, "response": [ { - "id": "47ae277e-8eba-4950-bfd4-1041aeaf1678", + "id": "39a55bbe-d184-4e64-93ad-53dbba0a195f", "name": "OK", "originalRequest": { "url": { @@ -4200,7 +4391,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"rail_terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"bill_of_lading_number\": \"\",\n \"normalized_number\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"port_of_lading_locode\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_locode\": \"\",\n \"port_of_discharge_name\": \"\",\n \"destination_locode\": \"\",\n \"destination_name\": \"\",\n \"shipping_line_scac\": \"\",\n \"shipping_line_name\": \"\",\n \"shipping_line_short_name\": \"\",\n \"customer_name\": \"\",\n \"pod_vessel_name\": \"\",\n \"pod_vessel_imo\": \"\",\n \"pod_voyage_number\": \"\",\n \"pol_etd_at\": \"\",\n \"pol_atd_at\": \"\",\n \"pod_eta_at\": \"\",\n \"pod_original_eta_at\": \"\",\n \"pod_ata_at\": \"\",\n \"destination_eta_at\": \"\",\n \"destination_ata_at\": \"\",\n \"pol_timezone\": \"\",\n \"pod_timezone\": \"\",\n \"destination_timezone\": \"\",\n \"line_tracking_last_attempted_at\": \"\",\n \"line_tracking_last_succeeded_at\": \"\",\n \"line_tracking_stopped_at\": \"\",\n \"line_tracking_stopped_reason\": \"past_arrival_window\"\n },\n \"relationships\": {\n \"destination\": {\n \"data\": {\n \"type\": \"metro_area\",\n \"id\": \"\"\n }\n },\n \"port_of_lading\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"containers\": {\n \"data\": [\n {\n \"type\": \"container\",\n \"id\": \"\"\n },\n {\n \"type\": \"container\",\n \"id\": \"\"\n }\n ]\n },\n \"port_of_discharge\": {\n \"data\": {\n \"type\": \"port\",\n \"id\": \"\"\n }\n },\n \"pod_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"destination_terminal\": {\n \"data\": {\n \"type\": \"terminal\",\n \"id\": \"\"\n }\n },\n \"line_tracking_stopped_by_user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -4211,7 +4402,7 @@ } }, { - "id": "e3dc834a-e4b7-41a9-9c8e-42aa70773266", + "id": "36f3219f-2078-4f6d-924f-99ca92a2967c", "name": "List shipment custom fields", "request": { "name": "List shipment custom fields", @@ -4251,7 +4442,7 @@ }, "response": [ { - "id": "8eb24305-22ed-4def-b369-e63a56045fd3", + "id": "5297e3ed-f8cd-4cbd-9439-202278cee487", "name": "OK", "originalRequest": { "url": { @@ -4302,7 +4493,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"container\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -4313,7 +4504,7 @@ } }, { - "id": "74e86d18-511a-416d-adeb-d83493880ea9", + "id": "7eb34923-0e32-4a21-93da-99efb54c4d65", "name": "Create a shipment custom field", "request": { "name": "Create a shipment custom field", @@ -4366,7 +4557,7 @@ }, "response": [ { - "id": "3a375386-388a-4ded-a343-9daa28c0d738", + "id": "1d55d2f2-e0d6-4e54-b7b4-93494aaa0680", "name": "Created", "originalRequest": { "url": { @@ -4430,7 +4621,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -4441,7 +4632,7 @@ } }, { - "id": "484c7280-4c05-434c-87b2-8d87263efc52", + "id": "9e85a4f0-8c0a-46fa-8cb1-f13fe1abb2a8", "name": "Update a shipment custom field", "request": { "name": "Update a shipment custom field", @@ -4505,7 +4696,7 @@ }, "response": [ { - "id": "e3e7581a-0bb0-4e13-8b7e-95cfd0c6262d", + "id": "5f487e18-ddd0-4e41-9600-41e92cc66b85", "name": "OK", "originalRequest": { "url": { @@ -4580,7 +4771,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -4591,7 +4782,7 @@ } }, { - "id": "2add99cf-0ffa-4044-9387-1589717f9e61", + "id": "94191990-f849-4399-98fd-f239c6cbaad1", "name": "Delete a shipment custom field", "request": { "name": "Delete a shipment custom field", @@ -4636,7 +4827,7 @@ }, "response": [ { - "id": "cae1b6a4-6941-41c2-880d-a0e0ce23ee48", + "id": "ef9426f4-f2cc-4f4b-8895-ad98f3aee5b9", "name": "No Content", "originalRequest": { "url": { @@ -4715,7 +4906,7 @@ "description": "", "item": [ { - "id": "313e7107-313b-434f-b838-328484ce6ad7", + "id": "351c0b13-4a2b-4ad6-a30d-3faad988f897", "name": "Create a tracking request", "request": { "name": "Create a tracking request", @@ -4746,7 +4937,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_type\": \"booking_number\",\n \"request_number\": \"\",\n \"scac\": \"\",\n \"auto_detect_vocc_scac\": false,\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"shipment_tags\": [\n \"\",\n \"\"\n ],\n \"initial_custom_fields\": {\n \"shipment\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n }\n ],\n \"containers\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n }\n ]\n }\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"shipper\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"consignee\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"notify_party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"customs_broker\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"freight_forwarder\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"pickup_dray_carrier\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_type\": \"bill_of_lading\",\n \"request_number\": \"\",\n \"scac\": \"\",\n \"auto_detect_vocc_scac\": false,\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"shipment_tags\": [\n \"\",\n \"\"\n ],\n \"initial_custom_fields\": {\n \"shipment\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n }\n ],\n \"containers\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n }\n ]\n }\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"shipper\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"consignee\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"notify_party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"customs_broker\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"freight_forwarder\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"pickup_dray_carrier\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -4774,7 +4965,7 @@ }, "response": [ { - "id": "22df6464-14e5-498e-853d-2516f6287eca", + "id": "1f63cff3-5d69-4c4e-8876-a19cb1ee7b89", "name": "Tracking Request Created", "originalRequest": { "url": { @@ -4808,7 +4999,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_type\": \"booking_number\",\n \"request_number\": \"\",\n \"scac\": \"\",\n \"auto_detect_vocc_scac\": false,\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"shipment_tags\": [\n \"\",\n \"\"\n ],\n \"initial_custom_fields\": {\n \"shipment\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n }\n ],\n \"containers\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n }\n ]\n }\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"shipper\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"consignee\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"notify_party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"customs_broker\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"freight_forwarder\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"pickup_dray_carrier\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_type\": \"bill_of_lading\",\n \"request_number\": \"\",\n \"scac\": \"\",\n \"auto_detect_vocc_scac\": false,\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"shipment_tags\": [\n \"\",\n \"\"\n ],\n \"initial_custom_fields\": {\n \"shipment\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n }\n ],\n \"containers\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n }\n ]\n }\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"shipper\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"consignee\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"notify_party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"customs_broker\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"freight_forwarder\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"pickup_dray_carrier\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -4825,12 +5016,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"awaiting_manifest\",\n \"request_type\": \"booking_number\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": null,\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n }\n ]\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"awaiting_manifest\",\n \"request_type\": \"bill_of_lading\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": \"retries_exhausted\",\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6160d581-5836-4bd8-9635-ebc30daa67a5", + "id": "230e164d-de85-455f-8072-617a098b145e", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -4864,7 +5055,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_type\": \"booking_number\",\n \"request_number\": \"\",\n \"scac\": \"\",\n \"auto_detect_vocc_scac\": false,\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"shipment_tags\": [\n \"\",\n \"\"\n ],\n \"initial_custom_fields\": {\n \"shipment\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n }\n ],\n \"containers\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n }\n ]\n }\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"shipper\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"consignee\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"notify_party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"customs_broker\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"freight_forwarder\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"pickup_dray_carrier\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_type\": \"bill_of_lading\",\n \"request_number\": \"\",\n \"scac\": \"\",\n \"auto_detect_vocc_scac\": false,\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"shipment_tags\": [\n \"\",\n \"\"\n ],\n \"initial_custom_fields\": {\n \"shipment\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n }\n ],\n \"containers\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n }\n ]\n }\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"shipper\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"consignee\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"notify_party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"customs_broker\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"freight_forwarder\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"pickup_dray_carrier\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -4881,12 +5072,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "899a1e77-25fa-4066-9665-1b6be424cdc9", + "id": "db6d9b74-338a-4503-a071-4cd34a37bf09", "name": "Too Many Requests - You've hit the create tracking requests limit. Please try again in a minute.", "originalRequest": { "url": { @@ -4920,7 +5111,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_type\": \"booking_number\",\n \"request_number\": \"\",\n \"scac\": \"\",\n \"auto_detect_vocc_scac\": false,\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"shipment_tags\": [\n \"\",\n \"\"\n ],\n \"initial_custom_fields\": {\n \"shipment\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n }\n ],\n \"containers\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n }\n ]\n }\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"shipper\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"consignee\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"notify_party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"customs_broker\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"freight_forwarder\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"pickup_dray_carrier\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_type\": \"bill_of_lading\",\n \"request_number\": \"\",\n \"scac\": \"\",\n \"auto_detect_vocc_scac\": false,\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"shipment_tags\": [\n \"\",\n \"\"\n ],\n \"initial_custom_fields\": {\n \"shipment\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\"\n }\n ],\n \"containers\": [\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n },\n {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"number\": \"\"\n }\n ]\n }\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"shipper\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"consignee\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"notify_party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"customs_broker\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"freight_forwarder\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n },\n \"pickup_dray_carrier\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -4957,7 +5148,7 @@ } }, { - "id": "54d34a19-44af-48b1-b2b2-aa95e2199493", + "id": "1cb48a9b-29b0-4459-843b-c683a36fb48c", "name": "List tracking requests", "request": { "name": "List tracking requests", @@ -4998,7 +5189,7 @@ "type": "text/plain" }, "key": "filter[status]", - "value": "created" + "value": "failed" }, { "disabled": false, @@ -5087,7 +5278,7 @@ }, "response": [ { - "id": "3c57febd-4a15-4288-812f-fd36d9ddcc12", + "id": "12c17c77-db24-49e9-b47c-a195abe3ac21", "name": "OK", "originalRequest": { "url": { @@ -5123,7 +5314,7 @@ "type": "text/plain" }, "key": "filter[status]", - "value": "created" + "value": "failed" }, { "disabled": false, @@ -5225,12 +5416,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"tracking_stopped\",\n \"request_type\": \"container\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": \"expired\",\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"awaiting_manifest\",\n \"request_type\": \"bill_of_lading\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": null,\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n }\n ]\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"created\",\n \"request_type\": \"booking_number\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": \"invalid_number\",\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"failed\",\n \"request_type\": \"container\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": \"retries_exhausted\",\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "68de02ca-0b45-410d-ace2-685a0ebba643", + "id": "479585ce-d8f2-4847-8125-b3e43d2bad41", "name": "Not Found", "originalRequest": { "url": { @@ -5266,7 +5457,7 @@ "type": "text/plain" }, "key": "filter[status]", - "value": "created" + "value": "failed" }, { "disabled": false, @@ -5368,7 +5559,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -5379,7 +5570,7 @@ } }, { - "id": "2b23e6d0-6cc5-483a-8469-6508f3863017", + "id": "33396548-6ffb-4538-a311-f9751bb9b973", "name": "Infer Tracking Number", "request": { "name": "Infer Tracking Number", @@ -5439,7 +5630,7 @@ }, "response": [ { - "id": "717a0b69-0d85-494e-9e90-e8497d29fae9", + "id": "b4c815c2-fc82-48a7-8a31-6daeccf3d265", "name": "Successfully inferred number type and shipping line", "originalRequest": { "url": { @@ -5491,12 +5682,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {\n \"number_type\": \"booking\",\n \"validation\": {\n \"is_valid\": \"\",\n \"type\": \"container\",\n \"check_digit_passed\": \"\",\n \"parsed_number\": \"\",\n \"reason\": \"\"\n },\n \"shipping_line\": {\n \"decision\": \"auto_select\",\n \"selected\": {\n \"scac\": \"\",\n \"name\": \"\",\n \"confidence\": \"\"\n },\n \"candidates\": [\n {\n \"scac\": \"\",\n \"name\": \"\",\n \"confidence\": \"\"\n },\n {\n \"scac\": \"\",\n \"name\": \"\",\n \"confidence\": \"\"\n }\n ]\n }\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"\",\n \"attributes\": {\n \"number_type\": \"bill_of_lading\",\n \"validation\": {\n \"is_valid\": \"\",\n \"type\": \"container\",\n \"check_digit_passed\": \"\",\n \"parsed_number\": \"\",\n \"reason\": \"\"\n },\n \"shipping_line\": {\n \"decision\": \"needs_confirmation\",\n \"selected\": {\n \"scac\": \"\",\n \"name\": \"\",\n \"confidence\": \"\"\n },\n \"candidates\": [\n {\n \"scac\": \"\",\n \"name\": \"\",\n \"confidence\": \"\"\n },\n {\n \"scac\": \"\",\n \"name\": \"\",\n \"confidence\": \"\"\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8f680e06-3f8e-40bb-8fe3-d014f0eb2b1d", + "id": "b5278bcb-a47c-4494-ac6f-7cb6a0423a1f", "name": "Unprocessable Entity - Invalid tracking number format", "originalRequest": { "url": { @@ -5553,7 +5744,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c1e84563-06f8-490e-97f7-9db52b7c2597", + "id": "31cab4e5-3ad8-406f-af33-02d31ebc2b0f", "name": "Too Many Requests - Rate limit exceeded", "originalRequest": { "url": { @@ -5625,7 +5816,7 @@ } }, { - "id": "a8e500ac-e949-4084-ae43-01ae5fada5a0", + "id": "842aaee7-63de-4847-8e2a-e9bb3d7a3fb9", "name": "Get a single tracking request", "request": { "name": "Get a single tracking request", @@ -5677,7 +5868,7 @@ }, "response": [ { - "id": "71331d4f-71af-4149-a333-934491e42527", + "id": "0a662267-bf82-49dc-94d3-b2b871c9a0fa", "name": "OK", "originalRequest": { "url": { @@ -5737,12 +5928,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"awaiting_manifest\",\n \"request_type\": \"booking_number\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": null,\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n }\n ]\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"awaiting_manifest\",\n \"request_type\": \"bill_of_lading\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": \"retries_exhausted\",\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "0e75c45d-d13e-4fbb-aebc-2ebf8a2a22eb", + "id": "23024f74-612f-4f85-9ef8-c39c754f8b91", "name": "Not Found", "originalRequest": { "url": { @@ -5802,7 +5993,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -5813,7 +6004,7 @@ } }, { - "id": "01f7ecc2-e33a-4d13-a5f0-e65cf660cb63", + "id": "75ae97ed-6b99-4769-bb97-792a1c9df897", "name": "Edit a tracking request", "request": { "name": "Edit a tracking request", @@ -5856,7 +6047,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_number\": \"\"\n },\n \"type\": 5822.2543244029175\n }\n}", + "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_number\": \"\"\n },\n \"type\": 7527.508768162965\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -5868,7 +6059,7 @@ }, "response": [ { - "id": "9dd2aa41-f872-4a35-87e7-f386a784a351", + "id": "f12f16c2-70b1-41b4-9227-ec4af5c7e5dd", "name": "OK", "originalRequest": { "url": { @@ -5914,7 +6105,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_number\": \"\"\n },\n \"type\": 5822.2543244029175\n }\n}", + "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_number\": \"\"\n },\n \"type\": 7527.508768162965\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -5931,7 +6122,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"tracking_stopped\",\n \"request_type\": \"booking_number\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": \"invalid_number\",\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"request_number\": \"\",\n \"status\": \"failed\",\n \"request_type\": \"container\",\n \"scac\": \"\",\n \"created_at\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"failed_reason\": \"data_unavailable\",\n \"updated_at\": \"\",\n \"is_retrying\": \"\",\n \"retry_count\": \"\"\n },\n \"relationships\": {\n \"tracked_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n },\n \"customer\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -5942,7 +6133,7 @@ } }, { - "id": "f2fc14d6-9323-48fe-b6b7-5633661b0f12", + "id": "5a3b5739-1233-4871-ae89-4e11baf8482b", "name": "List tracking request custom fields", "request": { "name": "List tracking request custom fields", @@ -5982,7 +6173,7 @@ }, "response": [ { - "id": "9774bc03-0e14-4110-b433-09bea840312a", + "id": "b8bbd2c9-3dc1-495a-8db1-e4803063735f", "name": "OK", "originalRequest": { "url": { @@ -6033,7 +6224,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"container\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6044,7 +6235,7 @@ } }, { - "id": "5f893b07-e1d3-4f15-a660-fc4c9cd1412a", + "id": "bae05f25-d274-4a0b-b00d-f40ab34186b0", "name": "Create a tracking request custom field", "request": { "name": "Create a tracking request custom field", @@ -6097,7 +6288,7 @@ }, "response": [ { - "id": "34bb4a12-b19b-407d-8483-d07eb16cd93f", + "id": "45772acc-8419-4b2a-b1ce-e6d861712f0a", "name": "Created", "originalRequest": { "url": { @@ -6161,7 +6352,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6172,7 +6363,7 @@ } }, { - "id": "98b52efe-fed0-4c4c-837a-e260c1d142ce", + "id": "ec7c544e-b96c-4225-a278-397edd237913", "name": "Update a tracking request custom field", "request": { "name": "Update a tracking request custom field", @@ -6236,7 +6427,7 @@ }, "response": [ { - "id": "fad74576-d604-4c3f-a0c8-69db6378308e", + "id": "f0f1e341-80c1-4d45-8a96-749415839478", "name": "OK", "originalRequest": { "url": { @@ -6311,7 +6502,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_field\",\n \"attributes\": {\n \"api_slug\": \"\",\n \"value\": \"\",\n \"display_value\": \"\"\n },\n \"relationships\": {\n \"entity\": {\n \"data\": {\n \"type\": \"tracking_request\",\n \"id\": \"\"\n }\n },\n \"definition\": {\n \"data\": {\n \"type\": \"custom_field_definition\",\n \"id\": \"\"\n }\n }\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6322,7 +6513,7 @@ } }, { - "id": "4ef1d857-e8eb-4247-891e-a48c6ff9ff46", + "id": "27674bc5-1270-4117-9ab3-d8c3707ae354", "name": "Delete a tracking request custom field", "request": { "name": "Delete a tracking request custom field", @@ -6367,7 +6558,7 @@ }, "response": [ { - "id": "43010ecd-f01f-40de-9d65-2df205121c78", + "id": "a68fb894-63ca-442b-a579-124e8b370873", "name": "No Content", "originalRequest": { "url": { @@ -6436,7 +6627,7 @@ "description": "", "item": [ { - "id": "db2671bb-924c-4812-8188-4c0b83cb348a", + "id": "3081d623-28b9-4a21-bacf-59ed56deae72", "name": "Get single webhook", "request": { "name": "Get single webhook", @@ -6478,7 +6669,7 @@ }, "response": [ { - "id": "23c27406-7b4f-4a27-a861-3a904be804a9", + "id": "de3c6365-723a-45d9-9a90-c109bb60d6a7", "name": "OK", "originalRequest": { "url": { @@ -6528,7 +6719,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.created\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.feeder_discharged\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6539,7 +6730,7 @@ } }, { - "id": "646eb275-026a-4a66-84ef-607696a2055f", + "id": "31d708f9-5a42-4e36-b244-d05bc1d6ef1c", "name": "Edit a webhook", "request": { "name": "Edit a webhook", @@ -6582,7 +6773,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"attributes\": {\n \"url\": \"\",\n \"events\": [\n \"container.transport.feeder_arrived\"\n ],\n \"active\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"type\": \"webhook\"\n }\n}", + "raw": "{\n \"data\": {\n \"attributes\": {\n \"url\": \"\",\n \"events\": [\n \"container.pickup_lfd_line.changed\"\n ],\n \"active\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"type\": \"webhook\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6594,7 +6785,7 @@ }, "response": [ { - "id": "860e16c7-2e4a-43c7-88c4-3f1801f06681", + "id": "49bbde3f-b41b-4620-84d9-6230e600d5ff", "name": "OK", "originalRequest": { "url": { @@ -6640,7 +6831,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"attributes\": {\n \"url\": \"\",\n \"events\": [\n \"container.transport.feeder_arrived\"\n ],\n \"active\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"type\": \"webhook\"\n }\n}", + "raw": "{\n \"data\": {\n \"attributes\": {\n \"url\": \"\",\n \"events\": [\n \"container.pickup_lfd_line.changed\"\n ],\n \"active\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"type\": \"webhook\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6657,7 +6848,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.created\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.feeder_discharged\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6668,7 +6859,7 @@ } }, { - "id": "1f68ac84-8b93-4aa0-b255-d6a665238b9e", + "id": "0503e662-aad9-4fe2-b234-374ea548c7ae", "name": "Delete a webhook", "request": { "name": "Delete a webhook", @@ -6704,7 +6895,7 @@ }, "response": [ { - "id": "d1ebd2fe-f5a5-4858-8164-f10c9acd2df5", + "id": "ba6e547d-52fe-4d04-a3df-b10742e7fb05", "name": "OK", "originalRequest": { "url": { @@ -6755,7 +6946,7 @@ } }, { - "id": "4ab092d4-c1f0-427d-9d52-f757924fe989", + "id": "cba1f6eb-4724-4a04-9ddb-ec8f125522f8", "name": "List webhooks", "request": { "name": "List webhooks", @@ -6804,7 +6995,7 @@ }, "response": [ { - "id": "dbca41eb-ee52-4466-b29e-634560ed334e", + "id": "4c8432bb-8d7e-46ff-916c-7955a38f81ec", "name": "OK", "originalRequest": { "url": { @@ -6861,7 +7052,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.empty_in\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.available\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.pickup_lfd_terminal.changed\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.transshipment_departed\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6872,7 +7063,7 @@ } }, { - "id": "2068d06a-4f1c-4a12-b2a0-7c624d9f08f0", + "id": "9148a856-4421-4da9-98cf-e38c0538d7a0", "name": "Create a webhook", "request": { "name": "Create a webhook", @@ -6903,7 +7094,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"attributes\": {\n \"url\": \"\",\n \"active\": \"\",\n \"events\": [\n \"container.pickup_lfd_rail.changed\"\n ],\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"type\": \"webhook\"\n }\n}", + "raw": "{\n \"data\": {\n \"attributes\": {\n \"url\": \"\",\n \"active\": \"\",\n \"events\": [\n \"container.transport.estimated.vessel_departed\"\n ],\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"type\": \"webhook\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6915,7 +7106,7 @@ }, "response": [ { - "id": "280714f4-852f-4dd8-8623-67a9426a772b", + "id": "84eddbd4-73ec-463b-a76f-7f3e51c9a772", "name": "Create a test webhook endpoint", "originalRequest": { "url": { @@ -6949,7 +7140,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"attributes\": {\n \"url\": \"\",\n \"active\": \"\",\n \"events\": [\n \"container.pickup_lfd_rail.changed\"\n ],\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"type\": \"webhook\"\n }\n}", + "raw": "{\n \"data\": {\n \"attributes\": {\n \"url\": \"\",\n \"active\": \"\",\n \"events\": [\n \"container.transport.estimated.vessel_departed\"\n ],\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"type\": \"webhook\"\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -6966,7 +7157,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.created\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.feeder_discharged\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -6977,7 +7168,7 @@ } }, { - "id": "edcbb944-1d95-4b40-ab32-e416794a1532", + "id": "9265af70-ede1-4e24-b633-757740140306", "name": "List webhook events", "request": { "name": "List webhook events", @@ -7008,7 +7199,7 @@ }, "response": [ { - "id": "3d280abf-5294-4151-a5a8-2a166ac1f3e6", + "id": "7e5c21f2-9d9a-4ec2-9281-b6f4380fdfb8", "name": "OK", "originalRequest": { "url": { @@ -7058,7 +7249,7 @@ } }, { - "id": "eeafe751-f504-4983-85fb-9f0bc60f9980", + "id": "5116845e-0d30-4f75-85bc-1835987d1e2d", "name": "List webhook IPs", "request": { "name": "List webhook IPs", @@ -7089,7 +7280,7 @@ }, "response": [ { - "id": "ad170a48-2020-4290-b86d-09a221c33d7a", + "id": "55536cc5-ab1b-47cf-a87a-793dd984d562", "name": "OK", "originalRequest": { "url": { @@ -7139,7 +7330,7 @@ } }, { - "id": "54324c5a-c126-4209-a68f-5e1ad655bce5", + "id": "bb5973a5-f75c-4b94-9a33-428d4f00e6a0", "name": "Trigger a webhook test delivery", "request": { "name": "Trigger a webhook test delivery", @@ -7183,7 +7374,7 @@ }, "response": [ { - "id": "3f857415-1d2b-406c-b3c9-389d20dbb5a9", + "id": "0ecf8f4e-ab19-41e3-b2c5-abf3544c530c", "name": "Webhook test delivery attempt result", "originalRequest": { "url": { @@ -7235,12 +7426,12 @@ "value": "application/json" } ], - "body": "{\n \"url\": \"\",\n \"succeeded\": \"\",\n \"error\": \"\",\n \"status_code\": \"\",\n \"request_headers\": {\n \"key_0\": false\n },\n \"request_body\": \"\",\n \"response_headers\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n },\n \"response_body\": \"\"\n}", + "body": "{\n \"url\": \"\",\n \"succeeded\": \"\",\n \"error\": \"\",\n \"status_code\": \"\",\n \"request_headers\": {\n \"key_0\": \"string\",\n \"key_1\": 2552.067191575702,\n \"key_2\": false,\n \"key_3\": true\n },\n \"request_body\": \"\",\n \"response_headers\": {\n \"key_0\": true\n },\n \"response_body\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7404bb5a-243a-420f-82a3-68ec9d43f28c", + "id": "f308e680-ca0d-4d6c-b0eb-11944c0ea6ee", "name": "Validation error", "originalRequest": { "url": { @@ -7309,7 +7500,7 @@ "description": "", "item": [ { - "id": "f7c29504-043a-4dd0-b4d0-0a247f0b726a", + "id": "08b59fbc-03c4-4609-8522-0e3017461c9d", "name": "Get a single webhook notification", "request": { "name": "Get a single webhook notification", @@ -7361,7 +7552,7 @@ }, "response": [ { - "id": "f4251357-83d1-46d5-9e03-bf90c1df09a1", + "id": "1926b10d-ae31-4ec0-b0fb-6780ff17ccdb", "name": "200", "originalRequest": { "url": { @@ -7421,7 +7612,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"container.transport.delivered\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"estimated_event\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.arrived_at_inland_destination\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.transshipment_loaded\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"document_representation.created\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"estimated_event\"\n }\n }\n }\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.estimated.arrived_at_inland_destination\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.transshipment_departed\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -7432,7 +7623,7 @@ } }, { - "id": "9f664c17-591c-4524-9373-5eced40dc9a6", + "id": "06e3ca84-d04b-4f30-aaf1-500f9dcd7877", "name": "List webhook notifications", "request": { "name": "List webhook notifications", @@ -7490,7 +7681,7 @@ }, "response": [ { - "id": "a053c78a-4e59-4bad-b472-3c65f3ff4def", + "id": "597de2d2-e590-4768-bcad-ad65c58dbf78", "name": "OK", "originalRequest": { "url": { @@ -7556,7 +7747,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"container.transport.rail_unloaded\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"container_updated_event\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"container.updated\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"document_representation.failed\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.transshipment_arrived\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"tracking_request.succeeded\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"container.transport.feeder_departed\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"container_updated_event\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.transshipment_arrived\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.rail_arrived\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -7567,7 +7758,7 @@ } }, { - "id": "81941306-5aee-4c32-8ce4-71c050ee2948", + "id": "a4aa78c7-e3d5-48d4-9b85-3e2f66d54abf", "name": "Get webhook notification payload examples", "request": { "name": "Get webhook notification payload examples", @@ -7591,7 +7782,7 @@ "type": "text/plain" }, "key": "event", - "value": "container.transport.vessel_discharged" + "value": "container.created" } ], "variable": [] @@ -7608,7 +7799,7 @@ }, "response": [ { - "id": "ba72e9ac-b43e-4fd8-92f5-58dfd70f3998", + "id": "e0b255c7-ac7c-450c-89bc-d962e462c982", "name": "OK", "originalRequest": { "url": { @@ -7627,7 +7818,7 @@ "type": "text/plain" }, "key": "event", - "value": "container.transport.vessel_discharged" + "value": "container.created" } ], "variable": [] @@ -7657,7 +7848,7 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"container.transport.rail_unloaded\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"container_updated_event\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"container.updated\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"document_representation.failed\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.transshipment_arrived\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"tracking_request.succeeded\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"transport_event\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook_notification\",\n \"attributes\": {\n \"event\": \"container.transport.feeder_departed\",\n \"delivery_status\": \"pending\",\n \"created_at\": \"\"\n },\n \"relationships\": {\n \"webhook\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhook\"\n }\n },\n \"reference_object\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"container_updated_event\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n },\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.transshipment_arrived\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhook\",\n \"attributes\": {\n \"url\": \"\",\n \"active\": true,\n \"events\": [\n \"container.transport.rail_arrived\"\n ],\n \"secret\": \"\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -7674,7 +7865,7 @@ "description": "", "item": [ { - "id": "f1c2c68d-3482-42c2-9d63-a4e52f8279bc", + "id": "dcd7bfcf-3b41-4e53-8c13-9782c1b1c811", "name": "Get a port using the locode or the id", "request": { "name": "Get a port using the locode or the id", @@ -7716,7 +7907,7 @@ }, "response": [ { - "id": "a1778065-c8e5-4b90-8dd8-40389ec9652b", + "id": "9d1fec46-54fa-487e-bf5c-2df1e3bb16b3", "name": "OK", "originalRequest": { "url": { @@ -7783,7 +7974,7 @@ "description": "", "item": [ { - "id": "44ce5ae6-76e1-4799-91c5-19c9dfa6280f", + "id": "ddabd098-8fef-4ee6-b74d-e8f893509626", "name": "Get a metro area using the un/locode or the id", "request": { "name": "Get a metro area using the un/locode or the id", @@ -7825,7 +8016,7 @@ }, "response": [ { - "id": "0ee8a771-9e3c-402c-ba0d-9affedc9a0ae", + "id": "e629a6be-5426-42d2-b8d2-2f14e91888b9", "name": "OK", "originalRequest": { "url": { @@ -7892,7 +8083,7 @@ "description": "", "item": [ { - "id": "21ba24bb-47da-4e8d-b7bd-4677bc46554d", + "id": "d339f606-ab92-4d66-b88b-e47337ece765", "name": "Get a terminal using the id", "request": { "name": "Get a terminal using the id", @@ -7934,7 +8125,7 @@ }, "response": [ { - "id": "de8e4016-1158-48f2-954e-7d0a28f001ef", + "id": "3332702b-add2-4f0a-aa8b-62092d214f8f", "name": "OK", "originalRequest": { "url": { @@ -8001,7 +8192,7 @@ "description": "", "item": [ { - "id": "92977667-2743-4743-97cf-079f6742ea33", + "id": "74674f4f-5ecd-4a4c-be2a-43f675baa76b", "name": "Get container map GeoJSON", "request": { "name": "Get container map GeoJSON", @@ -8044,7 +8235,7 @@ }, "response": [ { - "id": "b0c4cec8-670f-4601-baea-8840e02c58e3", + "id": "7334a864-b5a6-4922-96eb-c2fba5a27e1d", "name": "OK", "originalRequest": { "url": { @@ -8100,7 +8291,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1431de4c-db2a-4aa1-aecc-14045a881cbc", + "id": "e245c38d-6100-4b69-9b72-bbbab9e157c0", "name": "Forbidden - Routing data feature is not enabled for this account", "originalRequest": { "url": { @@ -8162,7 +8353,7 @@ } }, { - "id": "faef3075-1f4d-4d1f-99d2-b5a03c4c798f", + "id": "6aaa0e64-da51-4a35-9815-cfb4d9b58335", "name": "Get vessel future positions", "request": { "name": "Get vessel future positions", @@ -8224,7 +8415,7 @@ }, "response": [ { - "id": "3e0a2214-55ea-4bf8-87dc-2ed2afa0f15e", + "id": "b71d61ca-72a3-4990-b27f-9a75d96f5f04", "name": "OK", "originalRequest": { "url": { @@ -8299,7 +8490,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1c460953-3ecc-4957-a9dc-f9ff40850222", + "id": "c6e3f653-a1a9-4332-94b6-58f480922476", "name": "Forbidden - Routing data feature is not enabled for this account", "originalRequest": { "url": { @@ -8380,7 +8571,7 @@ } }, { - "id": "4ddbfdfc-15ce-4e02-b378-cbd8191bb659", + "id": "f9bae975-83b3-4642-96f9-c15502ee35aa", "name": "Get vessel future positions from coordinates", "request": { "name": "Get vessel future positions from coordinates", @@ -8460,7 +8651,7 @@ }, "response": [ { - "id": "a5619b8b-e831-4cec-afc1-2fa202de3101", + "id": "00e8b84c-02d1-4725-9b9d-5e5449395f9c", "name": "OK", "originalRequest": { "url": { @@ -8553,7 +8744,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d6df3d64-1349-4b85-ae3f-a12c280732f8", + "id": "0e5d792d-d311-4de5-9c88-097e008a35ac", "name": "Forbidden - Routing data feature is not enabled for this account", "originalRequest": { "url": { @@ -8658,7 +8849,7 @@ "description": "", "item": [ { - "id": "9b2668aa-aa3d-49c0-ada7-844c8e3d57c9", + "id": "35db9660-eb4d-40d8-9f6e-c6a347ac1684", "name": "List documents", "request": { "name": "List documents", @@ -8752,7 +8943,7 @@ }, "response": [ { - "id": "4da7abb8-43d7-45ed-ac65-186db71adb1d", + "id": "16e9e479-693e-40f5-b4d5-38835b594779", "name": "OK", "originalRequest": { "url": { @@ -8854,12 +9045,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"document\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"document_type\": \"\",\n \"document_type_manual\": \"\",\n \"classification_notes\": \"\",\n \"source\": \"split_document\",\n \"file_name\": \"\",\n \"file_content_type\": \"\",\n \"file_size_bytes\": \"\",\n \"parsed\": {\n \"packetSegment\": {\n \"startPage\": \"\",\n \"endPage\": \"\"\n }\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n },\n \"email_submission\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"email_submission\"\n }\n },\n \"last_document_representation\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document_representation\"\n }\n },\n \"parent_document\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document\"\n }\n },\n \"shipments\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\"\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n ]\n },\n \"cargos\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"container\"\n },\n {\n \"id\": \"\",\n \"type\": \"container\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\",\n \"download\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"document\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"document_type\": \"\",\n \"document_type_manual\": \"\",\n \"classification_notes\": \"\",\n \"source\": \"email\",\n \"file_name\": \"\",\n \"file_content_type\": \"\",\n \"file_size_bytes\": \"\",\n \"parsed\": {\n \"packetSegment\": {\n \"startPage\": \"\",\n \"endPage\": \"\"\n }\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n },\n \"email_submission\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"email_submission\"\n }\n },\n \"last_document_representation\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document_representation\"\n }\n },\n \"parent_document\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document\"\n }\n },\n \"shipments\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\"\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n ]\n },\n \"cargos\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"container\"\n },\n {\n \"id\": \"\",\n \"type\": \"container\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\",\n \"download\": \"\"\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"document\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"document_type\": \"\",\n \"document_type_manual\": \"\",\n \"classification_notes\": \"\",\n \"source\": \"upload\",\n \"file_name\": \"\",\n \"file_content_type\": \"\",\n \"file_size_bytes\": \"\",\n \"parsed\": {\n \"packetSegment\": {\n \"startPage\": \"\",\n \"endPage\": \"\"\n }\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n },\n \"email_submission\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"email_submission\"\n }\n },\n \"last_document_representation\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document_representation\"\n }\n },\n \"parent_document\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document\"\n }\n },\n \"shipments\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\"\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n ]\n },\n \"cargos\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"container\"\n },\n {\n \"id\": \"\",\n \"type\": \"container\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\",\n \"download\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"document\",\n \"attributes\": {\n \"id\": \"\",\n \"name\": \"\",\n \"document_type\": \"\",\n \"document_type_manual\": \"\",\n \"classification_notes\": \"\",\n \"source\": \"upload\",\n \"file_name\": \"\",\n \"file_content_type\": \"\",\n \"file_size_bytes\": \"\",\n \"parsed\": {\n \"packetSegment\": {\n \"startPage\": \"\",\n \"endPage\": \"\"\n }\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n },\n \"email_submission\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"email_submission\"\n }\n },\n \"last_document_representation\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document_representation\"\n }\n },\n \"parent_document\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"document\"\n }\n },\n \"shipments\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\"\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\"\n }\n ]\n },\n \"cargos\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"container\"\n },\n {\n \"id\": \"\",\n \"type\": \"container\"\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"\",\n \"download\": \"\"\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"account\",\n \"attributes\": {\n \"company_name\": \"\"\n }\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "59fbbbd5-278a-4cb3-a8fe-048f86206ca6", + "id": "a87c4242-4927-4aab-8a4a-9b5168d47786", "name": "Bad Request", "originalRequest": { "url": { @@ -8961,12 +9152,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "224f9995-a5d0-4a97-be84-df28b1415391", + "id": "7f8708d4-69b9-4807-91b4-9139e4ec39a9", "name": "Unauthorized", "originalRequest": { "url": { @@ -9068,7 +9259,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9079,7 +9270,7 @@ } }, { - "id": "965a85f1-1b5a-48d9-9f20-3b4529b23e29", + "id": "ab5c9a13-2af9-4bef-ac9c-67b7fbb2f80b", "name": "Upload a document", "request": { "name": "Upload a document", @@ -9122,7 +9313,7 @@ }, "response": [ { - "id": "d61a41d9-0dc6-4607-8b6b-0227c93534d4", + "id": "e6cfcba2-e18d-4e8b-96fc-f3f048da9e31", "name": "Created", "originalRequest": { "url": { @@ -9178,7 +9369,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f2cfeb3f-63ff-41a0-a082-81b4983ec1d9", + "id": "cea446f9-45fa-411e-b9fd-807f3bda69df", "name": "Duplicate document", "originalRequest": { "url": { @@ -9234,7 +9425,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8a600079-99ef-4423-a34b-e2d46ded4531", + "id": "46e9dec7-708a-4dcd-b6ed-a6863be642c7", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -9285,7 +9476,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9296,7 +9487,7 @@ } }, { - "id": "711c9ba1-416b-49b1-9815-ed76dfaf23a9", + "id": "aad09f73-dda4-469f-9f4d-5cbf7c592e6a", "name": "List document types", "request": { "name": "List document types", @@ -9327,7 +9518,7 @@ }, "response": [ { - "id": "9dc64532-9b8e-4c05-83cb-2c6a44ffcabe", + "id": "20cd1c94-19b8-4e78-b857-ae8b40b81cd5", "name": "OK", "originalRequest": { "url": { @@ -9371,7 +9562,7 @@ "_postman_previewlanguage": "json" }, { - "id": "84cf936e-8b59-4ebd-83fb-652fcda30594", + "id": "f91b8fac-0300-4c03-b84a-64e272db9588", "name": "Unauthorized", "originalRequest": { "url": { @@ -9410,7 +9601,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9421,7 +9612,7 @@ } }, { - "id": "8edadab4-5d10-4b57-b23b-5a62e1bd88f6", + "id": "6056eb7b-cf48-4be3-9fdf-9afe16ca5806", "name": "Get a document", "request": { "name": "Get a document", @@ -9470,7 +9661,7 @@ }, "response": [ { - "id": "6b80fc18-dc34-4d13-a33f-a8b519cf98fa", + "id": "2218e512-8bc1-4a56-a430-6c4da6dbe196", "name": "OK", "originalRequest": { "url": { @@ -9535,7 +9726,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2dc4e376-02d9-4736-93f0-6311c2061117", + "id": "4294bac1-08b1-404e-b381-7195a05e0c8e", "name": "Bad Request", "originalRequest": { "url": { @@ -9595,12 +9786,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "82742ac0-aae3-43d2-a8e0-b2372bdfe342", + "id": "0126ea49-2c02-4df0-b3b8-076b7e08b10e", "name": "Not Found", "originalRequest": { "url": { @@ -9660,7 +9851,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9671,7 +9862,7 @@ } }, { - "id": "3618f403-355b-4f17-a6ff-ff7103468c34", + "id": "0c9e1786-c5a9-4765-a21f-263b763a678c", "name": "Edit a document", "request": { "name": "Edit a document", @@ -9714,7 +9905,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"document\",\n \"attributes\": {\n \"document_type_manual\": \"\",\n \"extracted_data_manual\": {\n \"key_0\": false,\n \"key_1\": false\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"document\",\n \"attributes\": {\n \"document_type_manual\": \"\",\n \"extracted_data_manual\": {\n \"key_0\": 7912,\n \"key_1\": 468.92601933033353,\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9726,7 +9917,7 @@ }, "response": [ { - "id": "9ccc8406-55d0-47e0-a14b-d48e774cc14f", + "id": "6a4a48cb-cffe-427f-a617-6771301c5dde", "name": "OK", "originalRequest": { "url": { @@ -9772,7 +9963,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"document\",\n \"attributes\": {\n \"document_type_manual\": \"\",\n \"extracted_data_manual\": {\n \"key_0\": false,\n \"key_1\": false\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"document\",\n \"attributes\": {\n \"document_type_manual\": \"\",\n \"extracted_data_manual\": {\n \"key_0\": 7912,\n \"key_1\": 468.92601933033353,\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9794,7 +9985,7 @@ "_postman_previewlanguage": "json" }, { - "id": "649af74a-0bd8-42b9-b4db-6f51b9c0cf5e", + "id": "07832c3a-7213-441f-b021-bb2218664a2d", "name": "Not Found", "originalRequest": { "url": { @@ -9840,7 +10031,7 @@ "method": "PATCH", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"document\",\n \"attributes\": {\n \"document_type_manual\": \"\",\n \"extracted_data_manual\": {\n \"key_0\": false,\n \"key_1\": false\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"document\",\n \"attributes\": {\n \"document_type_manual\": \"\",\n \"extracted_data_manual\": {\n \"key_0\": 7912,\n \"key_1\": 468.92601933033353,\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -9857,7 +10048,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -9868,7 +10059,7 @@ } }, { - "id": "f950f9f2-2066-403c-b4a7-cce0b900d9b6", + "id": "13bdc15e-6b22-46b1-8c36-17f86a7d1cba", "name": "Delete a document", "request": { "name": "Delete a document", @@ -9910,7 +10101,7 @@ }, "response": [ { - "id": "d947a42a-69bc-4fce-b789-d323a40bacc9", + "id": "6f8a61d9-ae03-4f46-a5c0-b3e9d6f2836e", "name": "No Content", "originalRequest": { "url": { @@ -9955,7 +10146,7 @@ "_postman_previewlanguage": "text" }, { - "id": "fb6db05d-ee13-4e55-a755-ca5021542571", + "id": "aae6492c-f3f6-4c85-803c-81d9579b1f81", "name": "Not Found", "originalRequest": { "url": { @@ -10005,7 +10196,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -10016,7 +10207,7 @@ } }, { - "id": "62ce3f2a-cb72-432a-b82e-a95d2082f7fa", + "id": "fe52d6d4-aab8-4314-8b5b-d437b371fa96", "name": "Get a document download URL", "request": { "name": "Get a document download URL", @@ -10059,7 +10250,7 @@ }, "response": [ { - "id": "51df9729-9b12-4339-90d4-ab5dc3154773", + "id": "96490c8a-777b-4413-9760-163c81df51c7", "name": "OK", "originalRequest": { "url": { @@ -10115,7 +10306,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8ff15a33-75ab-4c77-95c8-e8c9d68ded5e", + "id": "a5fc2b8f-f583-4aad-a5bc-20af42c8ee3c", "name": "Not Found", "originalRequest": { "url": { @@ -10166,12 +10357,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "cee16e28-30e9-427e-810c-edc031b4aa26", + "id": "6e34bf4a-fbce-449f-957c-59b58573f238", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -10222,7 +10413,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -10233,7 +10424,7 @@ } }, { - "id": "934367cb-1d7e-415d-b990-1bffbf59dbe6", + "id": "3b832659-a568-4ad2-808e-f59590a044d8", "name": "Re-extract a document", "request": { "name": "Re-extract a document", @@ -10276,7 +10467,7 @@ }, "response": [ { - "id": "aca809d3-ac52-4bdd-b296-cbd37721c3de", + "id": "8118bba2-b68e-4da8-afbd-c2cecd2ade72", "name": "Accepted", "originalRequest": { "url": { @@ -10332,7 +10523,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ea0317f2-1d33-4ba8-ac26-29da93caf325", + "id": "e7fd0353-a17a-4e0e-b5ba-222c031ec5ce", "name": "Not Found", "originalRequest": { "url": { @@ -10383,7 +10574,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -10394,7 +10585,7 @@ } }, { - "id": "52640f9d-f832-44dd-9955-4881eb1521b1", + "id": "85c45325-5154-435a-bd11-c2a9da5db8b7", "name": "Re-classify a document", "request": { "name": "Re-classify a document", @@ -10437,7 +10628,7 @@ }, "response": [ { - "id": "951cf61f-a848-4ca2-a092-f266a329895f", + "id": "f46fac60-a60e-421f-a85a-dc1f1f3d44e9", "name": "Accepted", "originalRequest": { "url": { @@ -10493,7 +10684,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1ffe985b-e95a-406a-8faa-c269790a7c6d", + "id": "6dcdf7bb-87a5-4da7-827a-7e239509afaf", "name": "Not Found", "originalRequest": { "url": { @@ -10544,7 +10735,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -10555,7 +10746,7 @@ } }, { - "id": "2e9e7451-e4cb-42fb-a5f8-506f327fd26b", + "id": "d7d4f00f-cd69-4ff9-b7c9-a0c4075e0f9f", "name": "Re-link a document", "request": { "name": "Re-link a document", @@ -10598,7 +10789,7 @@ }, "response": [ { - "id": "1d9d6cff-b774-4005-83a7-eb6d8a5f6ec9", + "id": "84bdfde9-f209-40df-be16-5b464dc61282", "name": "Accepted", "originalRequest": { "url": { @@ -10654,7 +10845,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5217f7f7-8c7f-4748-bf02-01ddbf35320a", + "id": "89d7bcba-acb0-4c70-b8f8-9ef56a4901ec", "name": "Not Found", "originalRequest": { "url": { @@ -10705,7 +10896,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -10716,7 +10907,7 @@ } }, { - "id": "a57a10bc-c807-44e9-809a-fe6f2f1b2c44", + "id": "498a5edf-7c16-461a-8b8a-dd6a143befcb", "name": "Rotate a document", "request": { "name": "Rotate a document", @@ -10760,7 +10951,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"degrees\": 180\n}", + "raw": "{\n \"degrees\": 90\n}", "options": { "raw": { "headerFamily": "json", @@ -10772,7 +10963,7 @@ }, "response": [ { - "id": "f03c210f-3133-494c-b635-2fc208750ccf", + "id": "ebe3dba4-12c9-42da-b93c-00c204cddfbe", "name": "Accepted", "originalRequest": { "url": { @@ -10819,7 +11010,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"degrees\": 180\n}", + "raw": "{\n \"degrees\": 90\n}", "options": { "raw": { "headerFamily": "json", @@ -10841,7 +11032,7 @@ "_postman_previewlanguage": "json" }, { - "id": "52aa570f-8c26-49c4-a45b-8e8c741e87ab", + "id": "2ef4b39a-77ca-4bfc-9312-6bbdc12ba327", "name": "Not Found", "originalRequest": { "url": { @@ -10888,7 +11079,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"degrees\": 180\n}", + "raw": "{\n \"degrees\": 90\n}", "options": { "raw": { "headerFamily": "json", @@ -10905,12 +11096,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "abaf6de8-423b-4392-9387-36254df54b33", + "id": "91eb385d-394d-4145-8036-896cdb2b4866", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -10957,7 +11148,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"degrees\": 180\n}", + "raw": "{\n \"degrees\": 90\n}", "options": { "raw": { "headerFamily": "json", @@ -10974,7 +11165,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -10991,7 +11182,7 @@ "description": "", "item": [ { - "id": "78e8b40e-b3c6-4a98-8e29-19a60a2a5653", + "id": "0a3032fe-e547-44a1-ba55-0984f43ebefd", "name": "List email submissions", "request": { "name": "List email submissions", @@ -11049,7 +11240,7 @@ }, "response": [ { - "id": "cc5cc019-67f9-4921-b211-6a0857713339", + "id": "053fcd8a-cba8-498b-a317-bfe464237c57", "name": "OK", "originalRequest": { "url": { @@ -11120,7 +11311,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d413832f-37be-4640-87bd-7a17ff2b9b38", + "id": "4bf98c59-d317-466f-92ef-2a31c4d4049e", "name": "Bad Request", "originalRequest": { "url": { @@ -11186,12 +11377,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "eb2c1da1-900b-431e-9986-471901bb3e29", + "id": "8f1f87ff-18e6-4e33-94ed-1e6fe38b301d", "name": "Unauthorized", "originalRequest": { "url": { @@ -11257,7 +11448,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -11268,7 +11459,7 @@ } }, { - "id": "6fe7731f-9ceb-4d85-8852-25a553524cf4", + "id": "40869f20-dc27-4a04-98be-97996d12068d", "name": "Get an email submission", "request": { "name": "Get an email submission", @@ -11317,7 +11508,7 @@ }, "response": [ { - "id": "84886335-b82c-487b-9610-0e613048b043", + "id": "09c91c95-9a35-4407-bf06-5271fe1b3206", "name": "OK", "originalRequest": { "url": { @@ -11382,7 +11573,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5340527e-ec5b-467a-93c3-a0462e15c422", + "id": "bf494076-37d9-4198-bc60-7b344c6a1260", "name": "Bad Request", "originalRequest": { "url": { @@ -11442,12 +11633,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "76594ab1-ba5f-4a5a-82bc-58c03611a5d6", + "id": "65d893e8-30a2-4aaa-9d85-05914ae64920", "name": "Not Found", "originalRequest": { "url": { @@ -11507,7 +11698,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -11524,7 +11715,7 @@ "description": "", "item": [ { - "id": "df18663c-70aa-4161-8691-69a8fe7e7eba", + "id": "d92725a9-699c-40e9-bfd0-798d4f12d58e", "name": "Get a document schema", "request": { "name": "Get a document schema", @@ -11563,7 +11754,7 @@ }, "response": [ { - "id": "e61b2a26-d77f-47c9-8453-647094b2e9de", + "id": "891ebbc4-5840-4a49-9636-c2cde067e32c", "name": "OK", "originalRequest": { "url": { @@ -11613,12 +11804,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"document_schema\",\n \"attributes\": {\n \"document_type\": \"\",\n \"label\": \"\",\n \"schema_version\": \"\",\n \"full_version\": \"\",\n \"current\": \"\",\n \"draft\": \"\",\n \"active_at\": \"\",\n \"schema_format\": \"json_schema\",\n \"description\": \"\",\n \"schema_payload\": {\n \"key_0\": \"string\",\n \"key_1\": 1899.9427026582816\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"document_schema\",\n \"attributes\": {\n \"document_type\": \"\",\n \"label\": \"\",\n \"schema_version\": \"\",\n \"full_version\": \"\",\n \"current\": \"\",\n \"draft\": \"\",\n \"active_at\": \"\",\n \"schema_format\": \"json_schema\",\n \"description\": \"\",\n \"schema_payload\": {\n \"key_0\": 7157,\n \"key_1\": false,\n \"key_2\": false\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "392ebdc3-9bf1-468f-aef0-2371a759a7c3", + "id": "b505a713-9103-4404-adf7-a033795cc264", "name": "Unauthorized", "originalRequest": { "url": { @@ -11668,12 +11859,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e81b349b-8c47-4ec4-87a5-21dcf629c5e2", + "id": "a971d457-620e-4849-8c2d-e07c6816fc71", "name": "Not Found", "originalRequest": { "url": { @@ -11723,7 +11914,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -11740,7 +11931,7 @@ "description": "", "item": [ { - "id": "b2377437-535b-4e6e-996f-302ee9ac0b69", + "id": "71ed03c2-ac53-43de-8e34-a4126b06712d", "name": "Search shipments, containers, and tracking requests", "request": { "name": "Search shipments, containers, and tracking requests", @@ -11780,7 +11971,7 @@ }, "response": [ { - "id": "993d6ef6-f254-40e5-9e07-341d66d8790b", + "id": "eddbd30b-2c52-4785-a7d8-5469f228e3f8", "name": "Successful search results", "originalRequest": { "url": { @@ -11828,12 +12019,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"entity_type\": \"\",\n \"number\": \"\",\n \"shipment_id\": \"\",\n \"scac\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_name\": \"\",\n \"containers_count\": \"\",\n \"tracking_stopped\": \"\",\n \"tracking_stopped_reason\": \"\",\n \"status\": \"\",\n \"failed_reason\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"entity_type\": \"\",\n \"number\": \"\",\n \"shipment_id\": \"\",\n \"scac\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_name\": \"\",\n \"containers_count\": \"\",\n \"tracking_stopped\": \"\",\n \"tracking_stopped_reason\": \"\",\n \"status\": \"\",\n \"failed_reason\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n ]\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"tracking_request\",\n \"attributes\": {\n \"entity_type\": \"\",\n \"number\": \"\",\n \"shipment_id\": \"\",\n \"scac\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_name\": \"\",\n \"containers_count\": \"\",\n \"tracking_stopped\": \"\",\n \"tracking_stopped_reason\": \"\",\n \"status\": \"\",\n \"failed_reason\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipment\",\n \"attributes\": {\n \"entity_type\": \"\",\n \"number\": \"\",\n \"shipment_id\": \"\",\n \"scac\": \"\",\n \"port_of_lading_name\": \"\",\n \"port_of_discharge_name\": \"\",\n \"containers_count\": \"\",\n \"tracking_stopped\": \"\",\n \"tracking_stopped_reason\": \"\",\n \"status\": \"\",\n \"failed_reason\": \"\",\n \"ref_numbers\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "864b68a4-6109-407c-8381-ef30343b144c", + "id": "c933bf43-0761-425b-b565-2cbca0a591f2", "name": "Bad request — missing required `query` parameter", "originalRequest": { "url": { @@ -11886,7 +12077,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f99a6024-3269-4f5d-b930-5700848e28e5", + "id": "4a0dd2bd-d953-4059-8365-478f982fd213", "name": "Unauthorized — missing or invalid API token", "originalRequest": { "url": { @@ -11934,7 +12125,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -11951,7 +12142,7 @@ "description": "", "item": [ { - "id": "debc98d5-ee25-4bb4-a03a-374928c35fcc", + "id": "f5957ba2-f9b7-47ac-a67c-cb39c9a7c6a0", "name": "list-parties", "request": { "name": "list-parties", @@ -12000,7 +12191,7 @@ }, "response": [ { - "id": "99fe24dc-46ff-41e7-9f5f-3a6df421393b", + "id": "806e7dc8-cfc8-44b8-ab54-1cbdb896eb2c", "name": "OK", "originalRequest": { "url": { @@ -12068,7 +12259,7 @@ } }, { - "id": "5a332a17-6007-460f-94b2-04bb482ccd5f", + "id": "05600371-8aee-4f7c-8fb1-70b6f5782695", "name": "post-party", "request": { "name": "post-party", @@ -12111,7 +12302,7 @@ }, "response": [ { - "id": "b0c3b92f-f0ee-45df-86d8-12159cb79c48", + "id": "18454ff4-cfaf-4a9e-acf7-25e71a27b65f", "name": "Party Created", "originalRequest": { "url": { @@ -12167,7 +12358,7 @@ "_postman_previewlanguage": "json" }, { - "id": "166bd55d-dc0d-4efe-a4dd-60b40d4b99f2", + "id": "cdc1b923-9916-4280-ab6a-3861aec70104", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -12218,7 +12409,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -12229,7 +12420,7 @@ } }, { - "id": "83737bad-6836-4411-a396-a16b018c0e33", + "id": "2fc7146c-f538-47e9-9236-6a8e9ae00cf9", "name": "List shipment party roles", "request": { "name": "List shipment party roles", @@ -12272,7 +12463,7 @@ }, "response": [ { - "id": "dfc3e431-038f-4a29-8846-5bb3f1f30d94", + "id": "538fe5d1-3e55-4f8a-a623-4cb01e7d5756", "name": "OK", "originalRequest": { "url": { @@ -12323,12 +12514,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"customer\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"shipper\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n },\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"shipper\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"notify_party\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n },\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "debf7a34-8636-47f7-bb60-055f4947f9ca", + "id": "cc7ce17b-fe13-4511-8054-a1aba5699c1d", "name": "Unauthorized. Also returned when the record belongs to another account.", "originalRequest": { "url": { @@ -12379,12 +12570,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "23865c35-c5dd-4177-b001-82334bb2018c", + "id": "94292181-9f5c-45a5-b13c-b04f97cb2c6a", "name": "Not Found", "originalRequest": { "url": { @@ -12436,7 +12627,7 @@ } }, { - "id": "bab6b800-9ae2-4f7b-b3cf-460e1ee31732", + "id": "c3332dba-3d99-4c73-94ed-86b5aecf9589", "name": "Assign a shipment party role", "request": { "name": "Assign a shipment party role", @@ -12480,7 +12671,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"customer\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"notify_party\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -12492,7 +12683,7 @@ }, "response": [ { - "id": "93485110-cde1-4fd4-b911-02672519a1b4", + "id": "c05a708e-61f4-4b9e-a0ce-cc2ceb4ba302", "name": "Created", "originalRequest": { "url": { @@ -12539,7 +12730,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"customer\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"notify_party\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -12556,12 +12747,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"pickup_dray_carrier\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n },\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n }\n ],\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"freight_forwarder\",\n \"roleable_type\": \"Shipment\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n },\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n }\n ],\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "9bd1faa8-8f90-4d6b-82d2-0df97b97befa", + "id": "adc97aa3-b6a4-4fb3-b30c-dac4f18b3791", "name": "Unauthorized. Also returned when the party or the record belongs to another account.", "originalRequest": { "url": { @@ -12608,7 +12799,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"customer\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"notify_party\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -12625,12 +12816,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "a7b0c43a-965b-4cee-9d01-7ebb83de1391", + "id": "aa3f1880-eed6-47b1-92b2-1fa9ee12d5aa", "name": "Not Found", "originalRequest": { "url": { @@ -12673,7 +12864,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"customer\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"notify_party\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -12689,7 +12880,7 @@ "_postman_previewlanguage": "text" }, { - "id": "08f00a10-61a0-4b25-ba11-3517a47656f8", + "id": "4b901635-0d58-4985-adb7-47c18bc0b15d", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -12736,7 +12927,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"customer\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", + "raw": "{\n \"data\": {\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"notify_party\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", @@ -12753,7 +12944,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -12764,7 +12955,7 @@ } }, { - "id": "dba45775-789a-40e2-9fe8-de637240b03e", + "id": "a2c3de51-ad45-4054-b95c-dbb77acb8cc9", "name": "Remove a shipment party role", "request": { "name": "Remove a shipment party role", @@ -12818,7 +13009,7 @@ }, "response": [ { - "id": "f51accb3-bf27-43fd-8540-578a557bf5e2", + "id": "6cfa042e-b207-4e19-89bd-6c50a8a2dbe5", "name": "No Content", "originalRequest": { "url": { @@ -12875,7 +13066,7 @@ "_postman_previewlanguage": "text" }, { - "id": "f20ae10e-3a99-4c7a-a557-a48e75a0b4a9", + "id": "373a5852-c3c7-49d9-8661-8784fa47c0a2", "name": "Unauthorized. Also returned when the record belongs to another account.", "originalRequest": { "url": { @@ -12937,12 +13128,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d01f1a50-0f43-4ea9-b65f-c9d44490a8e1", + "id": "26a9066f-a0c4-446e-9c28-c85d0832b658", "name": "Not Found", "originalRequest": { "url": { @@ -13005,7 +13196,7 @@ } }, { - "id": "dbb98780-bf94-4c7a-85b4-2d2645645d72", + "id": "5412110d-e5d4-4a22-ad66-e6e07c855f8e", "name": "List container party roles", "request": { "name": "List container party roles", @@ -13048,7 +13239,7 @@ }, "response": [ { - "id": "283729fd-7af3-4a5c-99a8-a83b49ebf810", + "id": "185e1cc1-2f25-47ca-aafe-2522708d78f6", "name": "OK", "originalRequest": { "url": { @@ -13099,12 +13290,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"customer\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"shipper\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n },\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", + "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"shipper\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"notify_party\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n },\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n }\n ],\n \"links\": {\n \"last\": \"\",\n \"next\": \"\",\n \"prev\": \"\",\n \"first\": \"\",\n \"self\": \"\"\n },\n \"meta\": {\n \"size\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e6a8d108-e766-4c6e-8631-879e7bb3cabc", + "id": "04c5c5bc-6a9a-430f-86b1-b4fb6aa995d4", "name": "Unauthorized. Also returned when the record belongs to another account.", "originalRequest": { "url": { @@ -13155,12 +13346,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c2f940ad-6114-4960-91fa-b30fddc53e66", + "id": "56ec1abd-dc49-41ba-a0b8-1830f90fd8f8", "name": "Not Found", "originalRequest": { "url": { @@ -13212,7 +13403,7 @@ } }, { - "id": "e0173f05-154f-49b3-999e-dd7484703b44", + "id": "b1ab5b76-2eff-4381-a803-3333657eb4b3", "name": "Assign a container party role", "request": { "name": "Assign a container party role", @@ -13268,7 +13459,7 @@ }, "response": [ { - "id": "44519016-bd11-444a-83da-49ead801e4d8", + "id": "c27e1859-b2d2-4a1a-97f0-fbb9524dda49", "name": "Created", "originalRequest": { "url": { @@ -13332,12 +13523,12 @@ "value": "application/json" } ], - "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"pickup_dray_carrier\",\n \"roleable_type\": \"Cargo\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n },\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n }\n ],\n \"links\": {\n \"self\": \"\"\n }\n}", + "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"party_role\",\n \"attributes\": {\n \"role\": \"freight_forwarder\",\n \"roleable_type\": \"Shipment\",\n \"roleable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"relationships\": {\n \"party\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"party\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n },\n {\n \"attributes\": {\n \"company_name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"party\"\n }\n ],\n \"links\": {\n \"self\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "81d0d7e5-2345-4272-b1b0-280de378aa3e", + "id": "c5e72b1b-658a-42ea-8caa-113bc472e1d7", "name": "Unauthorized. Also returned when the party or the record belongs to another account.", "originalRequest": { "url": { @@ -13401,12 +13592,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c4ac76a8-7c99-41ac-85ef-e59cb34c05cf", + "id": "316f179a-3686-4910-a076-bade4a22f263", "name": "Not Found", "originalRequest": { "url": { @@ -13465,7 +13656,7 @@ "_postman_previewlanguage": "text" }, { - "id": "79c83c6a-441b-4501-9962-16d59df4f018", + "id": "1e29f5c2-c0ec-4f1e-90dc-bac612634b8e", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -13529,7 +13720,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13540,7 +13731,7 @@ } }, { - "id": "6c569235-ae2e-4a38-b8ac-d9ff93c6f1be", + "id": "4842bebd-1b78-49ee-97ca-762fda15911a", "name": "Remove a container party role", "request": { "name": "Remove a container party role", @@ -13594,7 +13785,7 @@ }, "response": [ { - "id": "9154ebd4-6fac-443b-af18-72f25368dec9", + "id": "4ac43680-e33a-4691-b88e-dd10615f8895", "name": "No Content", "originalRequest": { "url": { @@ -13651,7 +13842,7 @@ "_postman_previewlanguage": "text" }, { - "id": "176b96a8-32e9-4274-8246-f64dcf7326ad", + "id": "3767c409-666c-4d08-ad13-87c1ecfbaa5a", "name": "Unauthorized. Also returned when the record belongs to another account.", "originalRequest": { "url": { @@ -13713,12 +13904,12 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "39579326-4bac-441a-9fbd-46dd607a86f3", + "id": "1d565b33-6d1e-470c-a72a-2e7b841d0793", "name": "Not Found", "originalRequest": { "url": { @@ -13781,7 +13972,7 @@ } }, { - "id": "06d34a65-b5d2-4dac-a596-a34892a0a525", + "id": "d67c8ab1-b9b3-4af6-bf28-5baec692d747", "name": "get-parties-id", "request": { "name": "get-parties-id", @@ -13823,7 +14014,7 @@ }, "response": [ { - "id": "8fd12415-12ed-4bed-8948-7b8b755495da", + "id": "4acc80b6-2a0f-446e-a750-3ca30acef045", "name": "OK", "originalRequest": { "url": { @@ -13884,7 +14075,7 @@ } }, { - "id": "fadde5ed-999b-47f7-b2bb-7f9d89b2e1e5", + "id": "6f2f05b7-ccb0-4a27-ac76-6e3921c6c6f2", "name": "edit-party", "request": { "name": "edit-party", @@ -13939,7 +14130,7 @@ }, "response": [ { - "id": "bd714eb5-c187-4695-8065-a4b9a7a78eef", + "id": "1f9b24b9-8dfa-4477-b08a-9fa96628d3a9", "name": "OK", "originalRequest": { "url": { @@ -14007,7 +14198,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d6c7f593-412a-4bd1-8cab-d3d6f398dde3", + "id": "45cac9c8-2b79-4c01-986a-f082871c66de", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -14070,7 +14261,7 @@ "value": "application/json" } ], - "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": 5307.47503756303\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": 9339,\n \"key_1\": true\n }\n }\n ]\n}", + "body": "{\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"source\": {\n \"pointer\": \"\",\n \"parameter\": \"\"\n },\n \"code\": \"\",\n \"status\": \"\",\n \"meta\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": false\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -14087,7 +14278,7 @@ "description": "", "item": [ { - "id": "dfe91f6e-9744-46f6-8400-c6a632c92a53", + "id": "2bc2cdce-81f4-48b1-8d02-dfa65176a4f8", "name": "Shipping Lines", "request": { "name": "Shipping Lines", @@ -14117,7 +14308,7 @@ }, "response": [ { - "id": "ca4c1b8d-65ef-4a02-8a34-20054a3a5b09", + "id": "6d2aa987-d300-4b42-99ed-bc53b2d309ca", "name": "OK", "originalRequest": { "url": { @@ -14166,7 +14357,7 @@ } }, { - "id": "a33cfe66-70b8-472c-b62f-0a7295ac01e9", + "id": "cff3e9e8-c244-45be-97ef-13d447769474", "name": "Get a single shipping line", "request": { "name": "Get a single shipping line", @@ -14208,7 +14399,7 @@ }, "response": [ { - "id": "83206a00-c5ae-4ecf-840e-0067a66e88d6", + "id": "2cd9b072-c382-45cd-b411-0bc7ee681a60", "name": "OK", "originalRequest": { "url": { @@ -14275,7 +14466,7 @@ "description": "", "item": [ { - "id": "ee035fcc-7a2f-4c27-b520-7fec950e56d0", + "id": "27d49e7a-2920-4289-9c30-d4d3d86eba3f", "name": "Get a vessel using the id", "request": { "name": "Get a vessel using the id", @@ -14336,7 +14527,7 @@ }, "response": [ { - "id": "4cca209c-f754-4f24-973c-1475dc6cf103", + "id": "c8e94809-af77-462a-9d24-743e2f4f0c90", "name": "OK", "originalRequest": { "url": { @@ -14410,7 +14601,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e09d3412-1ec1-4db9-9137-c85af21d3b74", + "id": "7d9efedd-2eee-44fc-8c92-d3994a2b9294", "name": "Forbidden - Feature not enabled", "originalRequest": { "url": { @@ -14490,7 +14681,7 @@ } }, { - "id": "e1556630-ab6d-4e0a-876f-e32b843e5cf6", + "id": "78644da7-d6e2-4564-a639-a07820ebab36", "name": "Get a vessel using the imo", "request": { "name": "Get a vessel using the imo", @@ -14551,7 +14742,7 @@ }, "response": [ { - "id": "a38d2212-96f3-4ac0-8d6a-3b930ee7fcd5", + "id": "61b1684b-9b84-4ae2-a629-acd894629ec4", "name": "OK", "originalRequest": { "url": { @@ -14625,7 +14816,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2da54a0e-7863-4c68-abac-f8a4ea336970", + "id": "0d4e5987-bd2f-4bcb-9cd9-3a21fc1c7a1f", "name": "Forbidden - Feature not enabled", "originalRequest": { "url": { @@ -14705,7 +14896,7 @@ } }, { - "id": "c4071858-86f3-4e4a-bd83-096037bd131b", + "id": "269cc179-713b-4b0e-a08c-709e63dc5646", "name": "Get vessel future positions", "request": { "name": "Get vessel future positions", @@ -14767,7 +14958,7 @@ }, "response": [ { - "id": "7de3ac45-2819-4642-97f8-996719351060", + "id": "a628880e-168b-4842-a434-ade0049b615d", "name": "OK", "originalRequest": { "url": { @@ -14842,7 +15033,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7dbca698-4920-4396-9c5c-1bc2796a752a", + "id": "5a8304d3-8843-43e3-b928-db1d7377baff", "name": "Forbidden - Routing data feature is not enabled for this account", "originalRequest": { "url": { @@ -14923,7 +15114,7 @@ } }, { - "id": "b379fcaa-26a2-4a22-bb31-765ad417575a", + "id": "5ced2264-497a-4745-98ff-18eb94ba22ef", "name": "Get vessel future positions from coordinates", "request": { "name": "Get vessel future positions from coordinates", @@ -15003,7 +15194,7 @@ }, "response": [ { - "id": "16ed1c21-2b3c-48a0-abbf-5befb6f565e2", + "id": "8846c711-c3ab-4be1-a5dd-a71018d2f9b4", "name": "OK", "originalRequest": { "url": { @@ -15096,7 +15287,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9b9dbc89-6fc8-44b7-9b28-d6d12d895ea8", + "id": "b84d91e8-c477-435c-a075-35f35fff1577", "name": "Forbidden - Routing data feature is not enabled for this account", "originalRequest": { "url": { @@ -15225,7 +15416,7 @@ } ], "info": { - "_postman_id": "e46d0805-eb78-4b1a-a498-11191e27970b", + "_postman_id": "07e1c337-f7e9-4ff2-9aec-1470cd55e78f", "name": "Terminal49 API Reference", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/bin/agent-verify.mjs b/bin/agent-verify.mjs new file mode 100644 index 00000000..2f480729 --- /dev/null +++ b/bin/agent-verify.mjs @@ -0,0 +1,93 @@ +#!/usr/bin/env node + +import { spawnSync } from 'node:child_process'; +import { resolve } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const root = resolve(fileURLToPath(new URL('..', import.meta.url))); +const mode = process.argv[2]; +if (mode && mode !== '--quick') { + console.error('Usage: bin/agent-verify.mjs [--quick]'); + process.exit(2); +} + +const steps = [ + { + name: 'Node runtime', + run: () => { + const [major, minor] = process.versions.node.split('.').map(Number); + if (major !== 24 || minor < 11) { + throw new Error( + `Node 24.11+ is required; received ${process.versions.node}`, + ); + } + }, + }, + { + name: 'Agent trust guards', + command: ['node', 'bin/check-agent-trust.mjs'], + }, + { + name: 'Vite+ and TypeScript checks', + command: ['npx', '--no-install', 'vp', 'run', 'check'], + }, + { + name: 'Workspace builds', + command: ['npx', '--no-install', 'vp', 'run', 'build'], + }, + ...(mode === '--quick' + ? [] + : [ + { + name: 'Workspace tests', + command: ['npx', '--no-install', 'vp', 'run', 'test'], + }, + ]), + { + name: 'OpenAPI SDK type generation', + command: ['node', 'bin/check-openapi-types.mjs'], + }, + { + name: 'MCP initialize and tools/list smoke', + command: ['npm', 'run', 'test:protocol', '--workspace', '@terminal49/mcp'], + env: { MCP_PROTOCOL_VERSION: '2025-06-18' }, + }, +]; + +function runStep(step) { + const startedAt = performance.now(); + process.stdout.write(`\n[RUN ] ${step.name}\n`); + if (step.run) { + step.run(); + } else { + const [command, ...args] = step.command; + const result = spawnSync(command, args, { + cwd: root, + env: { ...process.env, ...step.env }, + stdio: 'inherit', + }); + if (result.error) { + throw result.error; + } + if (result.status !== 0) { + throw new Error(`command exited ${result.status ?? 'without a status'}`); + } + } + const duration = Math.round(performance.now() - startedAt); + process.stdout.write(`[PASS] ${step.name} (${duration} ms)\n`); +} + +for (const step of steps) { + try { + runStep(step); + } catch (error) { + console.error( + `[FAIL] ${step.name}: ${error instanceof Error ? error.message : String(error)}`, + ); + process.exit(1); + } +} + +console.log( + `\nPASS agent-verify${mode === '--quick' ? ' --quick' : ''}: ${steps.length} steps`, +); diff --git a/bin/check-agent-trust.mjs b/bin/check-agent-trust.mjs new file mode 100644 index 00000000..e8363719 --- /dev/null +++ b/bin/check-agent-trust.mjs @@ -0,0 +1,171 @@ +#!/usr/bin/env node + +import { existsSync, readFileSync, readdirSync } from 'node:fs'; +import { join, relative, resolve } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const root = resolve(fileURLToPath(new URL('..', import.meta.url))); + +function readJson(path) { + return JSON.parse(readFileSync(resolve(root, path), 'utf8')); +} + +function sorted(values) { + return [...values].sort((left, right) => left.localeCompare(right)); +} + +function normalizedVersion(version) { + return version.replace(/^=/, ''); +} + +function assertEqual(label, actual, expected) { + const actualJson = JSON.stringify(sorted(actual)); + const expectedJson = JSON.stringify(sorted(expected)); + if (actualJson !== expectedJson) { + throw new Error( + `${label} drifted.\nExpected: ${expectedJson}\nActual: ${actualJson}`, + ); + } +} + +function collectFiles(directory) { + const files = []; + for (const entry of readdirSync(directory, { withFileTypes: true })) { + const path = join(directory, entry.name); + if (entry.isDirectory()) { + files.push(...collectFiles(path)); + } else { + files.push(path); + } + } + return files; +} + +function collectStrings(value) { + if (typeof value === 'string') { + return [value]; + } + if (Array.isArray(value)) { + return value.flatMap(collectStrings); + } + if (value && typeof value === 'object') { + return Object.values(value).flatMap(collectStrings); + } + return []; +} + +function checkFeatureMap() { + const featureMap = readJson('skills/agent-trust/feature-map.json'); + const serverSource = readFileSync( + resolve(root, 'packages/mcp/src/server.ts'), + 'utf8', + ); + const registeredTools = [ + ...serverSource.matchAll(/server\.registerTool\(\s*'([^']+)'/g), + ].map((match) => match[1]); + assertEqual( + 'MCP feature map', + featureMap.mcpTools.map((tool) => tool.name), + registeredTools, + ); + + for (const tool of featureMap.mcpTools) { + if (!existsSync(resolve(root, tool.implementation))) { + throw new Error(`Missing MCP implementation: ${tool.implementation}`); + } + } + + const sdkPackage = readJson('sdks/typescript-sdk/package.json'); + assertEqual( + 'SDK entrypoint map', + featureMap.sdkEntrypoints.map((entry) => entry.export), + Object.keys(sdkPackage.exports), + ); + for (const entry of featureMap.sdkEntrypoints) { + if (!existsSync(resolve(root, entry.source))) { + throw new Error(`Missing SDK entrypoint source: ${entry.source}`); + } + } + + const docsConfig = readJson('docs/docs.json'); + const docsRoutes = collectStrings(docsConfig.navigation).filter( + (route) => + route === 'api-docs/in-depth-guides/mcp' || + route.startsWith('mcp/') || + (route.startsWith('sdk/') && !route.startsWith('sdk/reference/')), + ); + assertEqual('Docs route map', featureMap.docsRoutes, docsRoutes); + for (const route of featureMap.docsRoutes) { + if (!existsSync(resolve(root, `docs/${route}.mdx`))) { + throw new Error(`Missing docs route source: docs/${route}.mdx`); + } + } +} + +function checkToolchain() { + const rootPackage = readJson('package.json'); + const vitePlusPackage = readJson('node_modules/vite-plus/package.json'); + const expected = vitePlusPackage.dependencies; + const workspaces = [ + 'packages/mcp/package.json', + 'sdks/typescript-sdk/package.json', + 'sdks/typescript-sdk-cli/package.json', + ]; + + if (rootPackage.devDependencies['vite-plus'] !== vitePlusPackage.version) { + throw new Error( + 'Root vite-plus version does not match the installed tool.', + ); + } + if ( + rootPackage.devDependencies['@oxlint/plugins'] !== + normalizedVersion(expected['@oxlint/plugins']) + ) { + throw new Error('@oxlint/plugins is not coupled to vite-plus.'); + } + if (rootPackage.overrides.vitest !== expected.vitest) { + throw new Error('Vitest override is not coupled to vite-plus.'); + } + if ( + rootPackage.overrides.vite !== + `npm:@voidzero-dev/vite-plus-core@${vitePlusPackage.version}` + ) { + throw new Error('Vite core override is not coupled to vite-plus.'); + } + + for (const workspacePath of workspaces) { + const workspace = readJson(workspacePath); + if (workspace.devDependencies['vite-plus'] !== vitePlusPackage.version) { + throw new Error(`${workspacePath} has a mismatched vite-plus version.`); + } + if (workspace.devDependencies['@vitest/coverage-v8'] !== expected.vitest) { + throw new Error( + `${workspacePath} has a mismatched Vitest coverage version.`, + ); + } + } +} + +function checkConfigOwnership() { + const nestedConfigs = ['packages', 'sdks'] + .flatMap((directory) => collectFiles(resolve(root, directory))) + .filter((path) => /(?:^|\/)vite\.config\.[cm]?[jt]s$/.test(path)) + .map((path) => relative(root, path)); + if (nestedConfigs.length > 0) { + throw new Error( + `Workspace Vite configs are not allowed: ${nestedConfigs.join(', ')}`, + ); + } +} + +try { + checkFeatureMap(); + checkToolchain(); + checkConfigOwnership(); + console.log('PASS agent trust guards'); +} catch (error) { + console.error( + `FAIL agent trust guards: ${error instanceof Error ? error.message : String(error)}`, + ); + process.exitCode = 1; +} diff --git a/bin/check-openapi-types.mjs b/bin/check-openapi-types.mjs new file mode 100644 index 00000000..289d311d --- /dev/null +++ b/bin/check-openapi-types.mjs @@ -0,0 +1,52 @@ +#!/usr/bin/env node + +import { mkdtempSync, readFileSync, rmSync } from 'node:fs'; +import { tmpdir } from 'node:os'; +import { join, resolve } from 'node:path'; +import { spawnSync } from 'node:child_process'; +import { fileURLToPath } from 'node:url'; + +const root = resolve(fileURLToPath(new URL('..', import.meta.url))); +const temporaryDirectory = mkdtempSync(join(tmpdir(), 't49-openapi-')); +const generatedPath = join(temporaryDirectory, 'terminal49.ts'); + +try { + const result = spawnSync( + 'npx', + [ + '--no-install', + 'openapi-typescript', + 'docs/openapi.json', + '-o', + generatedPath, + ], + { + cwd: root, + encoding: 'utf8', + stdio: ['ignore', 'pipe', 'pipe'], + }, + ); + if (result.status !== 0) { + throw new Error(result.stderr.trim() || 'openapi-typescript failed'); + } + + const expected = readFileSync( + resolve(root, 'sdks/typescript-sdk/src/generated/terminal49.ts'), + 'utf8', + ); + const actual = readFileSync(generatedPath, 'utf8'); + if (actual !== expected) { + throw new Error( + 'OpenAPI-generated SDK types are stale. Run `npm run generate:types --workspace @terminal49/sdk`.', + ); + } + + console.log('PASS OpenAPI SDK type generation'); +} catch (error) { + console.error( + `FAIL OpenAPI SDK type generation: ${error instanceof Error ? error.message : String(error)}`, + ); + process.exitCode = 1; +} finally { + rmSync(temporaryDirectory, { recursive: true, force: true }); +} diff --git a/docs/openapi.json b/docs/openapi.json index 048b54cd..2431d3cf 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -6488,6 +6488,91 @@ ] } }, + "/containers/{id}/route": { + "parameters": [ + { + "schema": { + "type": "string", + "format": "uuid" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Get a container's route", + "description": "Get the route and route locations for a container. This feature may not be enabled for every account.", + "tags": [ + "Containers" + ], + "operationId": "get-containers-id-route", + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "include", + "description": "Comma-delimited relations to include" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/route" + }, + "included": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/route_location" + }, + { + "$ref": "#/components/schemas/port" + }, + { + "$ref": "#/components/schemas/vessel" + }, + { + "$ref": "#/components/schemas/shipment" + } + ] + } + } + } + } + } + } + }, + "403": { + "description": "Routing data is not enabled for this account", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + } + } + } + } + } + } + } + } + } + }, "/containers/{id}/map_geojson": { "parameters": [ { @@ -13019,6 +13104,230 @@ ], "x-examples": {} }, + "user": { + "title": "User model", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "type": "string", + "enum": [ + "user" + ] + }, + "attributes": { + "type": "object", + "additionalProperties": true + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "x-examples": {} + }, + "route": { + "title": "Route model", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "type": "string", + "enum": [ + "route" + ] + }, + "attributes": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + } + }, + "relationships": { + "type": "object", + "properties": { + "route_locations": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "type": "string", + "enum": [ + "route_location" + ] + } + }, + "required": [ + "id", + "type" + ] + } + } + } + } + } + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "x-examples": {} + }, + "route_location": { + "title": "Route location model", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "type": "string", + "enum": [ + "route_location" + ] + }, + "attributes": { + "type": "object", + "properties": { + "inbound_scac": { + "type": "string", + "nullable": true + }, + "inbound_mode": { + "type": "string", + "nullable": true + }, + "inbound_eta_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "inbound_ata_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "inbound_voyage_number": { + "type": "string", + "nullable": true + }, + "outbound_scac": { + "type": "string", + "nullable": true + }, + "outbound_mode": { + "type": "string", + "nullable": true + }, + "outbound_etd_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "outbound_atd_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "outbound_voyage_number": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + } + }, + "relationships": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "data": { + "nullable": true, + "oneOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + } + } + ] + } + } + } + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "x-examples": {} + }, "error": { "title": "Error model", "type": "object", diff --git a/package.json b/package.json index 5865cdf2..b82785b5 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,10 @@ ], "type": "module", "scripts": { + "agent-verify": "node bin/agent-verify.mjs", + "agent-verify:quick": "node bin/agent-verify.mjs --quick", "build": "npm run build --workspace @terminal49/sdk && npm run build --workspace @terminal49/mcp && npm run build --workspace @terminal49/cli", + "check:agent-trust": "node bin/check-agent-trust.mjs && node bin/check-openapi-types.mjs", "check": "vp check && npm run build --workspace @terminal49/sdk && npm run type-check:api && vp run -r type-check", "format": "vp fmt --write api packages sdks", "lint:api": "vp lint api && vp fmt --check api", diff --git a/sdks/typescript-sdk/src/generated/terminal49.ts b/sdks/typescript-sdk/src/generated/terminal49.ts index 52ce65ef..027087b8 100644 --- a/sdks/typescript-sdk/src/generated/terminal49.ts +++ b/sdks/typescript-sdk/src/generated/terminal49.ts @@ -114,14 +114,13 @@ export interface paths { put?: never; /** * Create a tracking request - * @description To track an ocean shipment, you create a new tracking request. - * Two attributes are required to track a shipment. A `bill of lading/booking number` and a shipping line `SCAC`. + * @description To track an ocean shipment, create a new tracking request. `request_type` and `request_number` are always required. Supply either a shipping line `scac` or set `auto_detect_vocc_scac` to `true` to have Terminal49 infer the SCAC from the request number before creating the tracking request. * - * Once a tracking request is created we will attempt to fetch the shipment details and it's related containers from the shipping line. If the attempt is successful we will create in new shipment object including any related container objects. We will send a `tracking_request.succeeded` webhook notification to your webhooks. + * Auto-detection uses the same carrier prediction capability as the Infer Tracking Number endpoint and runs asynchronously. The tracking request is created immediately (HTTP `201`) with `status: "pending"`; if no supported carrier can be inferred it transitions to `status: "failed"` with `failed_reason: "scac_auto_detect_failed"` and no shipment is created. Once a tracking request is created we will attempt to fetch the shipment details and its related containers from the shipping line. If the attempt is successful we will create a new shipment object including any related container objects. We will send a `tracking_request.succeeded` webhook notification to your webhooks. * * If the attempt to fetch fails then we will send a `tracking_request.failed` webhook notification to your `webhooks`. * - * A `tracking_request.succeeded` or `tracking_request.failed` webhook notificaiton will only be sent if you have atleast one active webhook.

This endpoint is limited to 100 tracking requests per minute. + * A `tracking_request.succeeded` or `tracking_request.failed` webhook notification will only be sent if you have at least one active webhook.

This endpoint is limited to 100 tracking requests per minute. */ post: operations["post-track"]; delete?: never; @@ -177,6 +176,50 @@ export interface paths { patch: operations["patch-track-request-by-id"]; trace?: never; }; + "/tracking_requests/{tracking_request_id}/custom_fields": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Tracking request ID */ + tracking_request_id: string; + }; + cookie?: never; + }; + /** List tracking request custom fields */ + get: operations["get-tracking-requests-custom-fields"]; + put?: never; + /** Create a tracking request custom field */ + post: operations["post-tracking-requests-custom-fields"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tracking_requests/{tracking_request_id}/custom_fields/{api_slug}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Tracking request ID */ + tracking_request_id: string; + /** @description Custom field api_slug */ + api_slug: string; + }; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** Delete a tracking request custom field */ + delete: operations["delete-tracking-requests-custom-fields-api-slug"]; + options?: never; + head?: never; + /** Update a tracking request custom field */ + patch: operations["patch-tracking-requests-custom-fields-api-slug"]; + trace?: never; + }; "/webhooks/{id}": { parameters: { query?: never; @@ -233,6 +276,26 @@ export interface paths { patch?: never; trace?: never; }; + "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/webhooks/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List webhook events + * @description Returns webhook event categories and event names available to the authenticated account. Events may be filtered by account features. + */ + get: operations["get-webhooks-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/webhook_notifications/{id}": { parameters: { query?: never; @@ -315,6 +378,26 @@ export interface paths { patch?: never; trace?: never; }; + "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/webhooks/trigger": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Trigger a webhook test delivery + * @description Send a one-time test webhook notification payload to a target HTTPS URL without creating a webhook endpoint. For document webhook events (`document_representation.created` and `document_representation.failed`), you can pass `sample.document_type` to test a specific document type payload. + */ + post: operations["post-webhooks-trigger"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/containers": { parameters: { query?: never; @@ -430,8 +513,8 @@ export interface paths { cookie?: never; }; /** - * Get container route - * @description Retrieves the route details from the port of lading to the port of discharge, including transshipments. This is a paid feature. Please contact sales@terminal49.com. + * Get a container's route + * @description Get the route and route locations for a container. This feature may not be enabled for every account. */ get: operations["get-containers-id-route"]; put?: never; @@ -700,10 +783,10 @@ export interface paths { path?: never; cookie?: never; }; - /** @description Get a list of parties */ + /** @description Returns the parties in your account. A party is a company you assign to shipments, tracking requests, and containers through party roles (customer, shipper, consignee, notify party, customs broker, freight forwarder, dray carrier). */ get: operations["list-parties"]; put?: never; - /** @description Creates a new party */ + /** @description Creates a party. Use the returned `id` to set the `customer` relationship on a tracking request or to assign party roles. */ post: operations["post-party"]; delete?: never; options?: never; @@ -711,1416 +794,4574 @@ export interface paths { patch?: never; trace?: never; }; - "/parties/{id}": { + "/custom_field_definitions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** List custom field definitions */ + get: operations["get-custom-field-definitions"]; + put?: never; + /** Create a custom field definition */ + post: operations["post-custom-field-definitions"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/custom_field_definitions/{id}": { parameters: { query?: never; header?: never; path: { + /** @description Custom field definition ID */ id: string; }; cookie?: never; }; - /** @description Returns a party by it's given identifier */ - get: operations["get-parties-id"]; + /** Get a custom field definition */ + get: operations["get-custom-field-definitions-id"]; put?: never; post?: never; - delete?: never; + /** Delete a custom field definition */ + delete: operations["delete-custom-field-definitions-id"]; options?: never; head?: never; - /** @description Updates a party */ - patch: operations["edit-party"]; + /** Update a custom field definition */ + patch: operations["patch-custom-field-definitions-id"]; trace?: never; }; -} -export type webhooks = Record; -export interface components { - schemas: { - /** Shipment model */ - shipment: { - /** Format: uuid */ - id: string; - relationships: { - destination?: { - data?: { - /** @enum {string} */ - type: "port" | "metro_area"; - /** Format: uuid */ - id: string; - } | null; - }; - port_of_lading?: { - data?: { - /** @enum {string} */ - type: "port"; - /** Format: uuid */ - id: string; - } | null; - }; - containers?: { - data?: { - /** @enum {string} */ - type: "container"; - /** Format: uuid */ - id: string; - }[]; - }; - port_of_discharge?: { - data?: { - /** @enum {string} */ - type: "port"; - /** Format: uuid */ - id: string; - } | null; - }; - pod_terminal?: { - data?: { - /** @enum {string} */ - type: "terminal"; - /** Format: uuid */ - id: string; - }; - }; - destination_terminal?: { - data?: { - /** @enum {string} */ - type: "terminal" | "rail_terminal"; - /** Format: uuid */ - id: string; - }; - }; - line_tracking_stopped_by_user?: { - data?: { - /** @enum {string} */ - type: "user"; - /** Format: uuid */ - id: string; - }; - }; - }; - attributes: { - bill_of_lading_number: string; - /** @description The normalized version of the shipment number used for querying the carrier */ - normalized_number?: string; - ref_numbers?: string[] | null; - /** Format: date-time */ - created_at?: string; - tags?: string[]; - /** @description UN/LOCODE */ - port_of_lading_locode?: string | null; - port_of_lading_name?: string | null; - /** @description UN/LOCODE */ - port_of_discharge_locode?: string | null; - port_of_discharge_name?: string | null; - /** @description UN/LOCODE */ - destination_locode?: string | null; - destination_name?: string | null; - shipping_line_scac?: string; - shipping_line_name?: string; - shipping_line_short_name?: string; - customer_name?: string | null; - pod_vessel_name?: string | null; - pod_vessel_imo?: string | null; - pod_voyage_number?: string | null; - /** Format: date-time */ - pol_etd_at?: string | null; - /** Format: date-time */ - pol_atd_at?: string | null; - /** Format: date-time */ - pod_eta_at?: string | null; - /** Format: date-time */ - pod_original_eta_at?: string | null; - /** Format: date-time */ - pod_ata_at?: string | null; - /** Format: date-time */ - destination_eta_at?: string | null; - /** Format: date-time */ - destination_ata_at?: string | null; - /** @description IANA tz */ - pol_timezone?: string | null; - /** @description IANA tz */ - pod_timezone?: string | null; - /** @description IANA tz */ - destination_timezone?: string | null; - /** - * Format: date-time - * @description When Terminal49 last tried to update the shipment status from the shipping line - */ - line_tracking_last_attempted_at?: string | null; - /** - * Format: date-time - * @description When Terminal49 last successfully updated the shipment status from the shipping line - */ - line_tracking_last_succeeded_at?: string | null; - /** - * Format: date-time - * @description When Terminal49 stopped checking at the shipping line - */ - line_tracking_stopped_at?: string | null; - /** - * @description The reason Terminal49 stopped checking - * @enum {string|null} - */ - line_tracking_stopped_reason?: "all_containers_terminated" | "past_arrival_window" | "past_full_out_window" | "no_updates_at_line" | "cancelled_by_user" | "booking_cancelled" | null; - }; - /** @enum {string} */ - type: "shipment"; - links: { - /** Format: uri */ - self: string; + "/custom_field_definitions/{definition_id}/options": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ + definition_id: string; }; + cookie?: never; }; - /** meta */ - meta: { - size?: number; - total?: number; + /** List custom field options */ + get: operations["get-custom-field-options"]; + put?: never; + /** Create a custom field option */ + post: operations["post-custom-field-options"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/custom_field_definitions/{definition_id}/options/{option_id}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ + definition_id: string; + /** @description Custom field option ID */ + option_id: string; + }; + cookie?: never; }; - /** link */ - "link-self": { - /** Format: uri */ - self?: string; + /** Get a custom field option */ + get: operations["get-custom-field-options-id"]; + put?: never; + post?: never; + /** Delete a custom field option */ + delete: operations["delete-custom-field-options-id"]; + options?: never; + head?: never; + /** Update a custom field option */ + patch: operations["patch-custom-field-options-id"]; + trace?: never; + }; + "/custom_fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** links */ - links: { - /** Format: uri */ - last?: string; - /** Format: uri */ - next?: string; - /** Format: uri */ - prev?: string; - /** Format: uri */ - first?: string; - /** Format: uri */ - self?: string; + /** List custom fields */ + get: operations["get-custom-fields"]; + put?: never; + /** Create a custom field */ + post: operations["post-custom-fields"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/custom_fields/{id}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field ID */ + id: string; + }; + cookie?: never; + }; + /** Get a custom field */ + get: operations["get-custom-fields-id"]; + put?: never; + post?: never; + /** Delete a custom field */ + delete: operations["delete-custom-fields-id"]; + options?: never; + head?: never; + /** Update a custom field */ + patch: operations["patch-custom-fields-id"]; + trace?: never; + }; + "/shipments/{shipment_id}/custom_fields": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Shipment ID */ + shipment_id: string; + }; + cookie?: never; + }; + /** List shipment custom fields */ + get: operations["get-shipments-custom-fields"]; + put?: never; + /** Create a shipment custom field */ + post: operations["post-shipments-custom-fields"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/shipments/{shipment_id}/custom_fields/{api_slug}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Shipment ID */ + shipment_id: string; + /** @description Custom field api_slug */ + api_slug: string; + }; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** Delete a shipment custom field */ + delete: operations["delete-shipments-custom-fields-api-slug"]; + options?: never; + head?: never; + /** Update a shipment custom field */ + patch: operations["patch-shipments-custom-fields-api-slug"]; + trace?: never; + }; + "/shipments/{shipment_id}/party_roles": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Shipment ID */ + shipment_id: string; + }; + cookie?: never; }; /** - * Container model - * @description Represents the equipment during a specific journey. + * List shipment party roles + * @description Returns the party roles attached to the shipment. Each role links one party to the record. The linked parties are returned in `included`. */ - container: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "container"; - attributes: { - number?: string; - ref_numbers?: string[]; - /** @enum {string|null} */ - equipment_type?: "dry" | "reefer" | "open top" | "flat rack" | "bulk" | "tank" | null; - /** @enum {integer|null} */ - equipment_length?: null | 10 | 20 | 40 | 45; - /** @enum {string|null} */ - equipment_height?: "standard" | "high_cube" | null; - weight_in_lbs?: number | null; - /** Format: date-time */ - created_at?: string; - seal_number?: string | null; - /** - * Format: date-time - * @description Coalesces `import_deadlines` values giving preference to `pickup_lfd_line` - */ - pickup_lfd?: string | null; - /** - * Format: date-time - * @description When available the pickup appointment time at the terminal is returned. - */ - pickup_appointment_at?: string | null; - /** @description Whether Terminal 49 is receiving availability status from the terminal. */ - availability_known?: boolean; - /** @description If availability_known is true, then whether container is available to be picked up at terminal. */ - available_for_pickup?: boolean | null; - /** - * Format: date-time - * @description Time the vessel arrived at the POD - */ - pod_arrived_at?: string | null; - /** - * Format: date-time - * @description Discharge time at the port of discharge - */ - pod_discharged_at?: string | null; - /** - * Format: date-time - * @description Full Out time at port of discharge. Null for inland moves. - */ - pod_full_out_at?: string | null; - /** - * Format: date-time - * @description When the terminal was last checked. - */ - terminal_checked_at?: string | null; - /** @description The chassis number used when container was picked up at POD (if available) */ - pod_full_out_chassis_number?: string | null; - /** @description Location at port of discharge terminal */ - location_at_pod_terminal?: string | null; - /** - * Format: date-time - * @description Pickup time at final destination for inland moves. - */ - final_destination_full_out_at?: string | null; - /** - * Format: date-time - * @description Time empty container was returned. - */ - empty_terminated_at?: string | null; - holds_at_pod_terminal?: components["schemas"]["terminal_hold"][]; - fees_at_pod_terminal?: components["schemas"]["terminal_fee"][]; - /** @description IANA tz. Applies to attributes pod_arrived_at, pod_discharged_at, pickup_appointment_at, pod_full_out_at. */ - pod_timezone?: string | null; - /** @description IANA tz. Applies to attribute final_destination_full_out_at. */ - final_destination_timezone?: string | null; - /** @description IANA tz. Applies to attribute empty_terminated_at. */ - empty_terminated_timezone?: string | null; - /** @description The SCAC of the rail carrier for the pickup leg of the container's journey.(BETA) */ - pod_rail_carrier_scac?: string | null; - /** @description The SCAC of the rail carrier for the delivery leg of the container's journey.(BETA) */ - ind_rail_carrier_scac?: string | null; - /** Format: date-time */ - pod_last_tracking_request_at?: string | null; - /** Format: date-time */ - shipment_last_tracking_request_at?: string | null; - /** Format: date-time */ - pod_rail_loaded_at?: string | null; - /** Format: date-time */ - pod_rail_departed_at?: string | null; - /** Format: date-time */ - ind_eta_at?: string | null; - /** Format: date-time */ - ind_ata_at?: string | null; - /** Format: date-time */ - ind_rail_unloaded_at?: string | null; - /** - * Format: date-time - * @deprecated - * @description Please use `import_deadlines.pickup_lfd_rail` - */ - ind_facility_lfd_on?: string | null; - /** @description Import pickup deadlines for the container */ - import_deadlines?: { + get: operations["get-shipments-party-roles"]; + put?: never; + /** + * Assign a shipment party role + * @description Attaches a party to the shipment in the given role. Roles are additive: posting a second party with the same role keeps both. To replace a party, delete its role and create a new one. Posting the same party and role twice returns `422`. + */ + post: operations["post-shipments-party-roles"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/shipments/{shipment_id}/party_roles/{id}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Shipment ID */ + shipment_id: string; + /** @description Party role ID */ + id: string; + }; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove a shipment party role + * @description Detaches the party from the shipment. The party itself is not deleted. + */ + delete: operations["delete-shipments-party-roles-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/containers/{container_id}/custom_fields": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Container ID */ + container_id: string; + }; + cookie?: never; + }; + /** List container custom fields */ + get: operations["get-containers-custom-fields"]; + put?: never; + /** Create a container custom field */ + post: operations["post-containers-custom-fields"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/containers/{container_id}/custom_fields/{api_slug}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Container ID */ + container_id: string; + /** @description Custom field api_slug */ + api_slug: string; + }; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** Delete a container custom field */ + delete: operations["delete-containers-custom-fields-api-slug"]; + options?: never; + head?: never; + /** Update a container custom field */ + patch: operations["patch-containers-custom-fields-api-slug"]; + trace?: never; + }; + "/containers/{container_id}/party_roles": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Container ID */ + container_id: string; + }; + cookie?: never; + }; + /** + * List container party roles + * @description Returns the party roles attached to the container. Each role links one party to the record. The linked parties are returned in `included`. + */ + get: operations["get-containers-party-roles"]; + put?: never; + /** + * Assign a container party role + * @description Attaches a party to the container in the given role. Roles are additive: posting a second party with the same role keeps both. To replace a party, delete its role and create a new one. Posting the same party and role twice returns `422`. + */ + post: operations["post-containers-party-roles"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/containers/{container_id}/party_roles/{id}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Container ID */ + container_id: string; + /** @description Party role ID */ + id: string; + }; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove a container party role + * @description Detaches the party from the container. The party itself is not deleted. + */ + delete: operations["delete-containers-party-roles-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{id}": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + /** @description Returns a party by it's given identifier */ + get: operations["get-parties-id"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** @description Updates a party */ + patch: operations["edit-party"]; + trace?: never; + }; + "/documents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List documents + * @description Returns documents for the authenticated account. Supports filters, sorting, includes, and pagination. + */ + get: operations["get-documents"]; + put?: never; + /** + * Upload a document + * @description Creates a document record. Provide an ActiveStorage signed blob id in `attached_document`. + */ + post: operations["post-documents"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "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/documents/types": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List document types + * @description Returns account-scoped allowed document types and labels. + */ + get: operations["get-documents-types"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/documents/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a document */ + get: operations["get-documents-id"]; + put?: never; + post?: never; + /** + * Delete a document + * @description Soft-deletes (discards) the document. + */ + delete: operations["delete-documents-id"]; + options?: never; + head?: never; + /** + * Edit a document + * @description Updates manual extraction and classification fields. + */ + patch: operations["patch-documents-id"]; + trace?: never; + }; + "/documents/{id}/download_url": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a document download URL + * @description Returns a presigned URL for downloading/viewing the current document file. + */ + get: operations["get-documents-id-download_url"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/documents/{id}/reextract": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Re-extract a document + * @description Triggers asynchronous extraction for the document. + */ + post: operations["post-documents-id-reextract"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/documents/{id}/reclassify": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Re-classify a document + * @description Triggers asynchronous classification for the document. + */ + post: operations["post-documents-id-reclassify"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/documents/{id}/relink": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Re-link a document + * @description Re-runs reference linking for the document. + */ + post: operations["post-documents-id-relink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/documents/{id}/rotate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Rotate a document + * @description Queues a rotation update for image document types only. Non-image documents are not rotatable. + */ + post: operations["post-documents-id-rotate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/email_submissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List email submissions + * @description Returns email submissions for the authenticated account. + */ + get: operations["get-email_submissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/email_submissions/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get an email submission */ + get: operations["get-email_submissions-id"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/document_schemas/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a document schema */ + get: operations["get-document_schemas-id"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/search": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Search shipments, containers, and tracking requests + * @description Full-text search across shipments, containers (cargos), and tracking requests within your account. Results are ranked by type (shipments first, then containers, then tracking requests) and recency. Returns up to 25 results. Duplicate tracking requests (where a shipment exists with the same BL number) are automatically filtered out. + */ + get: operations["searchAll"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + /** Shipment model */ + shipment: { + /** Format: uuid */ + id: string; + relationships: { + destination?: { + data?: { + /** @enum {string} */ + type: "port" | "metro_area"; + /** Format: uuid */ + id: string; + } | null; + }; + port_of_lading?: { + data?: { + /** @enum {string} */ + type: "port"; + /** Format: uuid */ + id: string; + } | null; + }; + containers?: { + data?: { + /** @enum {string} */ + type: "container"; + /** Format: uuid */ + id: string; + }[]; + }; + port_of_discharge?: { + data?: { + /** @enum {string} */ + type: "port"; + /** Format: uuid */ + id: string; + } | null; + }; + pod_terminal?: { + data?: { + /** @enum {string} */ + type: "terminal"; + /** Format: uuid */ + id: string; + }; + }; + destination_terminal?: { + data?: { + /** @enum {string} */ + type: "terminal" | "rail_terminal"; + /** Format: uuid */ + id: string; + }; + }; + line_tracking_stopped_by_user?: { + data?: { + /** @enum {string} */ + type: "user"; + /** Format: uuid */ + id: string; + }; + }; + }; + attributes: { + bill_of_lading_number: string; + /** @description The normalized version of the shipment number used for querying the carrier */ + normalized_number?: string; + ref_numbers?: string[] | null; + /** Format: date-time */ + created_at?: string; + tags?: string[]; + /** @description UN/LOCODE */ + port_of_lading_locode?: string | null; + port_of_lading_name?: string | null; + /** @description UN/LOCODE */ + port_of_discharge_locode?: string | null; + port_of_discharge_name?: string | null; + /** @description UN/LOCODE */ + destination_locode?: string | null; + destination_name?: string | null; + shipping_line_scac?: string; + shipping_line_name?: string; + shipping_line_short_name?: string; + customer_name?: string | null; + pod_vessel_name?: string | null; + pod_vessel_imo?: string | null; + pod_voyage_number?: string | null; + /** + * Format: date-time + * @description Estimated Time of Departure from the Port of Lading, as reported by the shipping line. Carrier dependent; may be null. + */ + pol_etd_at?: string | null; + /** + * Format: date-time + * @description Actual Time of Departure from the Port of Lading. Populated after the vessel has departed the origin port. + */ + pol_atd_at?: string | null; + /** + * Format: date-time + * @description Estimated Time of Arrival at the Port of Discharge. + */ + pod_eta_at?: string | null; + /** + * Format: date-time + * @description Initial Estimated Time of Arrival at the Port of Discharge, as first reported by the shipping line. + */ + pod_original_eta_at?: string | null; + /** + * Format: date-time + * @description Actual Time of Arrival at the Port of Discharge. + */ + pod_ata_at?: string | null; + /** + * Format: date-time + * @description Estimated Time of Arrival at the shipment's destination, as reported by the shipping line. For inland (rail) moves, see also the container-level `ind_eta_at`, which is reported by the rail carrier. Corresponding timezone is `destination_timezone`. + */ + destination_eta_at?: string | null; + /** + * Format: date-time + * @description Actual Time of Arrival at the shipment's destination, as reported by the shipping line. For inland (rail) moves, see also the container-level `ind_ata_at`, which is reported by the rail carrier. Corresponding timezone is `destination_timezone`. + */ + destination_ata_at?: string | null; + /** @description IANA tz */ + pol_timezone?: string | null; + /** @description IANA tz */ + pod_timezone?: string | null; + /** @description IANA tz */ + destination_timezone?: string | null; + /** + * Format: date-time + * @description When Terminal49 last tried to update the shipment status from the shipping line + */ + line_tracking_last_attempted_at?: string | null; + /** + * Format: date-time + * @description When Terminal49 last successfully updated the shipment status from the shipping line + */ + line_tracking_last_succeeded_at?: string | null; + /** + * Format: date-time + * @description When Terminal49 stopped checking at the shipping line + */ + line_tracking_stopped_at?: string | null; + /** + * @description The reason Terminal49 stopped checking + * @enum {string|null} + */ + line_tracking_stopped_reason?: "all_containers_terminated" | "past_arrival_window" | "past_full_out_window" | "no_updates_at_line" | "cancelled_by_user" | "booking_cancelled" | null; + }; + /** @enum {string} */ + type: "shipment"; + links: { + /** Format: uri */ + self: string; + }; + }; + /** meta */ + meta: { + size?: number; + total?: number; + }; + /** link */ + "link-self": { + /** Format: uri */ + self?: string; + }; + /** links */ + links: { + /** Format: uri */ + last?: string; + /** Format: uri */ + next?: string; + /** Format: uri */ + prev?: string; + /** Format: uri */ + first?: string; + /** Format: uri */ + self?: string; + }; + /** + * Container model + * @description Represents the equipment during a specific journey. + */ + container: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "account"; + attributes: { + number?: string; + ref_numbers?: string[]; + /** @enum {string|null} */ + equipment_type?: "dry" | "reefer" | "open top" | "flat rack" | "bulk" | "tank" | null; + /** @enum {integer|null} */ + equipment_length?: null | 10 | 20 | 40 | 45; + /** @enum {string|null} */ + equipment_height?: "standard" | "high_cube" | null; + weight_in_lbs?: number | null; + /** Format: date-time */ + created_at?: string; + seal_number?: string | null; + /** + * Format: date-time + * @description Coalesces `import_deadlines` values giving preference to `pickup_lfd_line` + */ + pickup_lfd?: string | null; + /** + * Format: date-time + * @description When available the pickup appointment time at the terminal is returned. + */ + pickup_appointment_at?: string | null; + /** @description Whether Terminal 49 is receiving availability status from the terminal. */ + availability_known?: boolean; + /** @description If availability_known is true, then whether container is available to be picked up at terminal. */ + available_for_pickup?: boolean | null; + /** + * Format: date-time + * @description Time the vessel arrived at the POD + */ + pod_arrived_at?: string | null; + /** + * Format: date-time + * @description Discharge time at the port of discharge + */ + pod_discharged_at?: string | null; + /** + * Format: date-time + * @description Full Out time at port of discharge. Null for inland moves. + */ + pod_full_out_at?: string | null; + /** + * Format: date-time + * @description When the terminal was last checked. + */ + terminal_checked_at?: string | null; + /** @description The chassis number used when container was picked up at POD (if available) */ + pod_full_out_chassis_number?: string | null; + /** @description Location at port of discharge terminal */ + location_at_pod_terminal?: string | null; + /** + * Format: date-time + * @description Pickup time at final destination for inland moves. + */ + final_destination_full_out_at?: string | null; + /** + * Format: date-time + * @description Time empty container was returned. + */ + empty_terminated_at?: string | null; + holds_at_pod_terminal?: components["schemas"]["terminal_hold"][]; + fees_at_pod_terminal?: components["schemas"]["terminal_fee"][]; + /** @description IANA tz. Applies to attributes pod_arrived_at, pod_discharged_at, pickup_appointment_at, pod_full_out_at. */ + pod_timezone?: string | null; + /** @description IANA tz. Applies to attribute final_destination_full_out_at. */ + final_destination_timezone?: string | null; + /** @description IANA tz. Applies to attribute empty_terminated_at. */ + empty_terminated_timezone?: string | null; + /** @description The SCAC of the rail carrier for the pickup leg of the container's journey.(BETA) */ + pod_rail_carrier_scac?: string | null; + /** @description The SCAC of the rail carrier for the delivery leg of the container's journey.(BETA) */ + ind_rail_carrier_scac?: string | null; + /** + * Format: date-time + * @description Timestamp of the last time Terminal49 requested container tracking updates directly from the port-of-discharge terminal. Compare with `shipment_last_tracking_request_at`, which tracks shipment-level requests to the shipping line. + */ + pod_last_tracking_request_at?: string | null; + /** + * Format: date-time + * @description Timestamp of the last time Terminal49 requested shipment-level tracking updates from the shipping line for this container's shipment. Compare with `pod_last_tracking_request_at`, which tracks container-level requests made directly to the terminal. + */ + shipment_last_tracking_request_at?: string | null; + /** Format: date-time */ + pod_rail_loaded_at?: string | null; + /** Format: date-time */ + pod_rail_departed_at?: string | null; + /** + * Format: date-time + * @description Estimated Time of Arrival at the inland destination, as reported by the rail carrier. For the shipping-line view at the shipment's destination, see `destination_eta_at` on the shipment. Corresponding timezone is `final_destination_timezone`. + */ + ind_eta_at?: string | null; + /** + * Format: date-time + * @description Actual Time of Arrival at the inland destination, as reported by the rail carrier. For the shipping-line view at the shipment's destination, see `destination_ata_at` on the shipment. Corresponding timezone is `final_destination_timezone`. + */ + ind_ata_at?: string | null; + /** + * Format: date-time + * @description Time when the container is unloaded from rail at the inland destination. + */ + ind_rail_unloaded_at?: string | null; + /** + * Format: date-time + * @deprecated + * @description Please use `import_deadlines.pickup_lfd_rail` + */ + ind_facility_lfd_on?: string | null; + /** @description Import pickup deadlines for the container */ + import_deadlines?: { + /** + * Format: date-time + * @description The last free day for pickup before demmurage accrues. Corresponding timezone is pod_timezone. + */ + pickup_lfd_terminal?: string | null; + /** + * Format: date-time + * @description The last free day for pickup at the inland destination, as reported by the rail carrier. Corresponding timezone is final_destination_timezone. Subscribe to `container.pickup_lfd_rail.changed` to be notified of updates. + */ + pickup_lfd_rail?: string | null; + /** + * Format: date-time + * @description The last free day as reported by the shipping line (carrier dependent). Corresponding timezone is final_destination_timezone or pod_timezone. Preferred source for the coalesced top-level `pickup_lfd` field. + */ + pickup_lfd_line?: string | null; + } | null; + /** + * @description The current status of the container in its journey. [Read guide to learn more.](/api-docs/in-depth-guides/container-statuses) + * @enum {string} + */ + current_status?: "new" | "on_ship" | "available" | "not_available" | "grounded" | "on_rail" | "picked_up" | "off_dock" | "delivered" | "dropped" | "loaded" | "empty_returned" | "awaiting_inland_transfer"; + }; + relationships?: { + shipment?: { + data?: { + id?: string; + /** @enum {string} */ + type?: "shipment"; + }; + }; + pickup_facility?: { + data?: { + id?: string; + /** @enum {string} */ + type?: "terminal"; + }; + }; + pod_terminal?: { + data?: { + id?: string; + /** @enum {string} */ + type?: "terminal"; + }; + }; + transport_events?: { + data?: { + id?: string; + /** @enum {string} */ + type?: "transport_event"; + }[]; + }; + raw_events?: { + data?: { + id?: string; + /** @enum {string} */ + type?: "raw_event"; + }[]; + }; + }; + }; + /** Port model */ + port: { + /** Format: uuid */ + id: string; + attributes?: { + name?: string; + /** @description UN/LOCODE */ + code?: string; + state_abbr?: string | null; + city?: string | null; + /** @description 2 digit country code */ + country_code?: string; + /** @description IANA tz */ + time_zone?: string; + latitude?: number | null; + longitude?: number | null; + }; + /** @enum {string} */ + type: "port"; + }; + /** Shipping line model */ + shipping_line: { + /** Format: uuid */ + id: string; + attributes: { + scac: string; + name: string; + /** @description Additional SCACs which will be accepted in tracking requests */ + alternative_scacs: string[]; + short_name: string; + bill_of_lading_tracking_support: boolean; + booking_number_tracking_support: boolean; + container_number_tracking_support: boolean; + }; + /** @enum {string} */ + type: "shipping_line"; + }; + /** Account model */ + account: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "account"; + attributes: { + company_name: string; + }; + }; + /** User model */ + user: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "user"; + attributes: { + [key: string]: unknown; + }; + }; + /** Route model */ + route: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "route"; + attributes: { + /** Format: date-time */ + created_at?: string | null; + /** Format: date-time */ + updated_at?: string | null; + }; + relationships?: { + route_locations?: { + data?: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "route_location"; + }[]; + }; + }; + }; + /** Route location model */ + route_location: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "route_location"; + attributes: { + inbound_scac?: string | null; + inbound_mode?: string | null; + /** Format: date-time */ + inbound_eta_at?: string | null; + /** Format: date-time */ + inbound_ata_at?: string | null; + inbound_voyage_number?: string | null; + outbound_scac?: string | null; + outbound_mode?: string | null; + /** Format: date-time */ + outbound_etd_at?: string | null; + /** Format: date-time */ + outbound_atd_at?: string | null; + outbound_voyage_number?: string | null; + /** Format: date-time */ + created_at?: string | null; + /** Format: date-time */ + updated_at?: string | null; + }; + relationships?: { + [key: string]: { + data?: ({ + /** Format: uuid */ + id: string; + type: string; + } | { + /** Format: uuid */ + id: string; + type: string; + }[]) | null; + }; + }; + }; + /** Error model */ + error: { + detail?: string | null; + title: string | null; + source?: { + pointer?: string | null; + parameter?: string | null; + } | null; + code?: string | null; + status?: string | null; + meta?: { + [key: string]: unknown; + } | null; + }; + /** Metro area model */ + metro_area: { + /** Format: uuid */ + id: string; + attributes?: { + name?: string; + /** @description UN/LOCODE */ + code?: string; + state_abbr?: string | null; + country_code?: string; + /** @description IANA tz */ + time_zone?: string; + latitude?: number | null; + longitude?: number | null; + }; + /** @enum {string} */ + type: "metro_area"; + ""?: string; + }; + /** Terminal model */ + terminal: { + /** Format: uuid */ + id?: string; + relationships: { + port: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "port"; + }; + }; + }; + attributes: { + name: string; + nickname?: string; + /** @description CBP FIRMS Code or CBS Sublocation Code */ + firms_code?: string; + /** @description SMDG Code */ + smdg_code?: string; + /** @description BIC Facility Code */ + bic_facility_code?: string; + /** @description Street part of the address */ + street?: string; + /** @description City part of the address */ + city?: string; + /** @description State part of the address */ + state?: string; + /** @description State abbreviation for the state */ + state_abbr?: string; + /** @description ZIP code part of the address */ + zip?: string; + /** @description Country part of the address */ + country?: string; + }; + /** @enum {string} */ + type?: "terminal"; + }; + /** Rail Terminal model */ + rail_terminal: { + /** Format: uuid */ + id?: string; + relationships?: { + port?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "port"; + } | null; + }; + metro_area?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "metro_area"; + }; + }; + }; + attributes: { + name: string; + nickname?: string; + /** @description CBP FIRMS Code or CBS Sublocation Code */ + firms_code?: string; + }; + /** @enum {string} */ + type?: "rail_terminal"; + }; + /** Tracking Request */ + tracking_request: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "tracking_request"; + attributes?: { + /** @example ONEYSH9AME650500 */ + request_number: string; + ref_numbers?: string[] | null; + tags?: string[]; + /** @enum {string} */ + status: "pending" | "awaiting_manifest" | "created" | "failed" | "tracking_stopped"; + /** + * @description If the tracking request has failed, or is currently failing, the last reason we were unable to complete the request. `scac_auto_detect_failed` means `auto_detect_vocc_scac` was set but no supported carrier SCAC could be inferred from the request number. + * @enum {string|null} + */ + failed_reason?: "booking_cancelled" | "duplicate" | "expired" | "internal_processing_error" | "invalid_number" | "not_found" | "retries_exhausted" | "shipping_line_unreachable" | "unrecognized_response" | "data_unavailable" | "scac_auto_detect_failed" | null; + /** + * @example bill_of_lading + * @enum {string} + */ + request_type: "bill_of_lading" | "booking_number" | "container"; + /** @example ONEY */ + scac: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at?: string; + is_retrying?: boolean; + /** @description How many times T49 has attempted to get the shipment from the shipping line */ + retry_count?: number | null; + }; + relationships?: { + tracked_object?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "shipment"; + } | null; + }; + /** @description Account linked to the customer party, or `null` when the customer party has no linked account. Once the shipment exists, read the party through `GET /shipments/{shipment_id}/party_roles`. */ + customer?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "account"; + } | null; + }; + }; + }; + /** webhook */ + webhook: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "webhook"; + attributes?: { + /** + * Format: uri + * @description https end point + */ + url: string; + /** + * @description Whether the webhook will be delivered when events are triggered + * @default true + */ + active: boolean; + /** @description The list of events to enabled for this endpoint */ + events: ("container.transport.vessel_arrived" | "container.transport.estimated.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.estimated.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.pickup_lfd_terminal.changed" | "container.pickup_lfd_rail.changed" | "container.pickup_appointment.changed" | "container.transport.available" | "container.transport.not_available" | "container.transport.delivered" | "document_representation.created" | "document_representation.failed")[]; + /** @description A random token that will sign all delivered webhooks */ + secret: string; + headers?: { + name?: string; + value?: string; + }[] | null; + }; + }; + /** vessel */ + vessel: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "vessel"; + attributes?: { + /** + * @description The name of the ship or vessel + * @example Ever Given + */ + name?: string; + /** + * @description International Maritime Organization (IMO) number + * @example 9811000 + */ + imo?: string | null; + /** + * @description Maritime Mobile Service Identity (MMSI) + * @example 353136000 + */ + mmsi?: string | null; + /** + * @description The current latitude position of the vessel + * @example 25.29845 + */ + latitude?: number | null; + /** + * @description The current longitude position of the vessel + * @example 121.217 + */ + longitude?: number | null; + /** + * @description The current speed of the ship in knots (nautical miles per hour) + * @example 90 + */ + nautical_speed_knots?: number | null; + /** + * @description The current heading of the ship in degrees, where 0 is North, 90 is East, 180 is South, and 270 is West + * @example 194 + */ + navigational_heading_degrees?: number | null; + /** + * @description The timestamp of when the ship's position was last recorded, in ISO 8601 date and time format + * @example 2023-07-28T14:01:37Z + */ + position_timestamp?: string | null; + /** @description An array of historical position data for the vessel. Only included if `show_positions` is true. */ + positions?: { + /** @example 1.477285 */ + latitude?: number; + /** @example 104.535533333 */ + longitude?: number; + /** @example 51 */ + heading?: number | null; + /** + * Format: date-time + * @example 2025-05-23T19:14:22Z + */ + timestamp?: string; + /** @example false */ + estimated?: boolean; + }[] | null; + }; + }; + /** Transport Event Model */ + transport_event: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "transport_event"; + attributes?: { + /** @enum {string} */ + event?: "container.transport.vessel_arrived" | "container.transport.estimated.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.estimated.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.pickup_lfd_terminal.changed" | "container.pickup_lfd_rail.changed" | "container.pickup_appointment.changed" | "container.transport.available" | "container.transport.not_available" | "container.transport.delivered" | "document_representation.created" | "document_representation.failed"; + voyage_number?: string | null; + /** Format: date-time */ + timestamp?: string | null; + /** @description IANA tz */ + timezone?: string | null; + /** @description UNLOCODE of the event location */ + location_locode?: string | null; + /** Format: date-time */ + created_at?: string; + /** + * @description The original source of the event data + * @example shipping_line + * @enum {string} + */ + data_source?: "shipping_line" | "terminal" | "ais"; + }; + relationships?: { + shipment?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "shipment"; + }; + }; + location?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "port" | "metro_area"; + } | null; + }; + vessel?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + name?: "vessel"; + } | null; + }; + terminal?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "terminal" | "rail_terminal"; + } | null; + }; + container?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "container"; + }; + }; + }; + }; + /** Estimated Event Model */ + estimated_event: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "estimated_event"; + attributes: { + /** + * Format: date-time + * @description When the estimated event was created + */ + created_at: string; + /** Format: date-time */ + estimated_timestamp: string; + /** @enum {string} */ + event: "shipment.estimated.arrival" | "document_representation.created" | "document_representation.failed"; + /** @description UNLOCODE of the event location */ + location_locode?: string | null; + /** @description IANA tz */ + timezone?: string | null; + voyage_number?: string | null; + /** + * @description The original source of the event data + * @enum {string} + */ + data_source?: "shipping_line" | "terminal"; + }; + relationships: { + shipment: { + data: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "shipment"; + }; + }; + port?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "port"; + } | null; + }; + /** @description */ + vessel?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "vessel"; + } | null; + }; + }; + }; + /** webhook_notification */ + webhook_notification: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "webhook_notification"; + attributes?: { + /** @enum {string} */ + event: "container.transport.vessel_arrived" | "container.transport.estimated.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.estimated.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.pickup_lfd_terminal.changed" | "container.pickup_lfd_rail.changed" | "container.pickup_appointment.changed" | "container.transport.available" | "container.transport.not_available" | "container.transport.delivered" | "document_representation.created" | "document_representation.failed"; + /** + * @description Whether the notification has been delivered to the webhook endpoint + * @default pending + * @enum {string} + */ + delivery_status: "pending" | "succeeded" | "failed"; + created_at: string; + }; + relationships?: { + webhook: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "webhook"; + }; + }; + reference_object?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "tracking_request" | "estimated_event" | "transport_event" | "container_updated_event" | "document"; + }; + }; + }; + }; + /** terminal_hold */ + terminal_hold: { + name: string; + /** @enum {string} */ + status: "pending" | "hold"; + /** @description Text description from the terminal (if any) */ + description?: string | null; + }; + /** terminal_fee */ + terminal_fee: { + /** @enum {string} */ + type: "demurrage" | "exam" | "extended_dwell_time" | "other" | "total"; + /** @description The fee amount in local currency */ + amount: number; + /** + * @description The ISO 4217 currency code of the fee is charged in. E.g. USD + * @example USD + */ + currency_code?: string; + }; + /** container_updated_event */ + container_updated_event: { + id?: string; + type?: string; + attributes?: { + /** + * @description A hash of all the changed attributes with the values being an array of the before and after. E.g. + * `{"pickup_lfd": [null, "2020-05-20"]}` + * + * The current attributes that can be alerted on are: + * - `available_for_pickup` + * - `pickup_lfd` + * - `fees_at_pod_terminal` + * - `holds_at_pod_terminal` + * - `pickup_appointment_at` + * - `pod_terminal` + */ + changeset: Record; + /** Format: date-time */ + timestamp: string; + /** @description IANA tz */ + timezone?: string; + /** + * @example terminal + * @enum {string} + */ + data_source?: "terminal"; + }; + relationships: { + container: { + data: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "container"; + }; + }; + terminal: { + data: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "terminal"; + }; + }; + }; + }; + /** + * Raw Event Model + * @description Raw Events represent the milestones from the shipping line for a given container. + * + * ### About raw_event datetimes + * + * The events may include estimated future events. The event is a future event if an `estimated_` timestamp is not null. + * + * The datetime properties `timestamp` and `estimated`. + * + * When the `time_zone` property is present the datetimes are UTC timestamps, which can be converted to the local time by parsing the provided `time_zone`. + * + * When the `time_zone` property is absent, the datetimes represent local times which serialized as UTC timestamps for consistency. + */ + raw_event: { + id?: string; + /** @enum {string} */ + type?: "raw_event"; + attributes?: { + /** + * @description Normalized string representing the event + * @enum {string|null} + */ + event?: "empty_out" | "full_in" | "positioned_in" | "positioned_out" | "vessel_loaded" | "vessel_departed" | "transshipment_arrived" | "transshipment_discharged" | "transshipment_loaded" | "transshipment_departed" | "feeder_arrived" | "feeder_discharged" | "feeder_loaded" | "feeder_departed" | "rail_loaded" | "rail_departed" | "rail_arrived" | "rail_unloaded" | "vessel_arrived" | "vessel_discharged" | "arrived_at_destination" | "delivered" | "full_out" | "empty_in" | "vgm_received" | "carrier_release" | "customs_release" | "available" | null; + /** @description The event name as returned by the carrier */ + original_event?: string; + /** + * Format: date-time + * @description The datetime the event either transpired or will occur in UTC + */ + timestamp?: string; + /** @description True if the timestamp is estimated, false otherwise */ + estimated?: boolean; + /** + * Format: date + * @description Deprecated: The date of the event at the event location when no time information is available. + */ + actual_on?: string | null; + /** + * Format: date + * @description Deprecated: The estimated date of the event at the event location when no time information is available. + */ + estimated_on?: string | null; + /** + * Format: date-time + * @description Deprecated: The datetime the event transpired in UTC + */ + actual_at?: string | null; + /** + * Format: date-time + * @description Deprecated: The estimated datetime the event will occur in UTC + */ + estimated_at?: string | null; + /** @description IANA tz where the event occured */ + timezone?: string | null; + /** + * Format: date-time + * @description When the raw_event was created in UTC + */ + created_at?: string; + /** @description The city or facility name of the event location */ + location_name?: string; + /** @description UNLOCODE of the event location */ + location_locode?: string | null; + /** @description The name of the vessel where applicable */ + vessel_name?: string | null; + /** @description The IMO of the vessel where applicable */ + vessel_imo?: string | null; + /** @description The order of the event. This may be helpful when only dates (i.e. actual_on) are available. */ + index?: number; + voyage_number?: string | null; + }; + relationships?: { + location?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "port" | "metro_area"; + }; + }; + vessel?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "vessel"; + }; + }; + }; + }; + /** Container Pod Terminal Changed Event */ + container_pod_terminal_changed_event: { + id?: string; + type?: string; + attributes?: { + /** + * @description Where the information about the terminal change came from + * @example shipping_line + * @enum {string} + */ + data_source?: "shipping_line" | "terminal" | "pierpass"; + /** + * Format: date-time + * @description When the terminal change was recorded + */ + timestamp?: string; + }; + relationships?: { + container?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "container"; + }; + shipment?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "shipment"; + }; + /** @description The terminal the container has changed to. If this container is still on the vessel this represents an advisory. If it was previously at the terminal this represents an off-dock move. */ + terminal?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "terminal"; + }; + }; + }; + /** Party model */ + party: { + /** Format: uuid */ + id?: string; + attributes: { + /** @description Company name */ + company_name: string; + }; + /** @enum {string} */ + type?: "party"; + }; + /** Vessel with positions model */ + vessel_with_positions: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "vessel"; + attributes: { + /** @description The name of the ship or vessel */ + name?: string; + /** @description International Maritime Organization (IMO) number */ + imo?: string | null; + /** @description Maritime Mobile Service Identity (MMSI) */ + mmsi?: string | null; + /** @description The current latitude position of the vessel */ + latitude?: number | null; + /** @description The current longitude position of the vessel */ + longitude?: number | null; + /** @description The current speed of the ship in knots (nautical miles per hour) */ + nautical_speed_knots?: number | null; + /** @description The current heading of the ship in degrees, where 0 is North, 90 is East, 180 is South, and 270 is West */ + navigational_heading_degrees?: number | null; + /** + * Format: date-time + * @description The timestamp of when the ship's position was last recorded, in ISO 8601 date and time format + */ + position_timestamp?: string | null; + /** @description Array of estimated future positions */ + positions?: { + latitude: number; + longitude: number; + heading?: number | null; + /** Format: date-time */ + timestamp: string; + estimated: boolean; + }[]; + }; + }; + /** Port */ + portFeatureProperties: { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + feature_type: "port"; + /** @description The sequence number of this port in the route (1 = POL, last = POD) */ + ports_sequence?: number; + /** @description Total number of ports in the route */ + ports_total?: number; + /** @description Unique identifier for the port location */ + location_id?: string; + /** @enum {string} */ + location_type?: "Port"; + /** @description Name of the port */ + name?: string; + /** @description State abbreviation (if applicable) */ + state_abbr?: string | null; + /** @description State name (if applicable) */ + state?: string | null; + /** @description ISO country code */ + country_code?: string; + /** @description Country name */ + country?: string; + /** @description IANA timezone identifier */ + time_zone?: string; + /** @description Port label: POL, POD, or TS1, TS2, etc. */ + label?: string; + /** + * Format: date-time + * @description Estimated time of arrival (ISO 8601) + */ + inbound_eta_at?: string | null; + /** + * Format: date-time + * @description Actual time of arrival (ISO 8601) + */ + inbound_ata_at?: string | null; + /** + * Format: date-time + * @description Estimated time of departure (ISO 8601) + */ + outbound_etd_at?: string | null; + /** + * Format: date-time + * @description Actual time of departure (ISO 8601) + */ + outbound_atd_at?: string | null; + /** + * Format: date-time + * @description Last update timestamp from the shipment (ISO 8601) + */ + updated_at?: string | null; + }; + /** Current Vessel */ + currentVesselFeatureProperties: { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + feature_type: "current_vessel"; + /** @description Sequence number of the departure port for this leg */ + ports_sequence?: number; + /** @description Unique identifier for the vessel */ + vessel_id?: string; + /** @description Name of the vessel */ + vessel_name?: string; + /** @description IMO number of the vessel */ + vessel_imo?: string; + /** @description Voyage number for this leg */ + voyage_number?: string | null; + /** + * Format: date-time + * @description Timestamp of the vessel position (ISO 8601) + */ + vessel_location_timestamp?: string; + /** @description Vessel heading in degrees (0-360) */ + vessel_location_heading?: number | null; + /** @description Vessel speed in knots */ + vessel_location_speed?: number | null; + /** @description ID of the port the vessel departed from */ + departure_port_id?: string; + /** @description Name of the departure port */ + departure_port_name?: string; + /** @description State abbreviation of departure port */ + departure_port_state_abbr?: string | null; + /** @description State name of departure port */ + departure_port_state?: string | null; + /** @description Country code of departure port */ + departure_port_country_code?: string; + /** @description Country name of departure port */ + departure_port_country?: string; + /** @description Label of departure port (POL, POD, TS1, etc.) */ + departure_port_label?: string; + /** + * Format: date-time + * @description Actual time of departure from the port (ISO 8601) + */ + departure_port_atd?: string | null; + /** @description Timezone of departure port */ + departure_port_time_zone?: string; + /** @description ID of the next port the vessel is heading to */ + arrival_port_id?: string | null; + /** @description Name of the arrival port */ + arrival_port_name?: string | null; + /** @description State abbreviation of arrival port */ + arrival_port_state_abbr?: string | null; + /** @description State name of arrival port */ + arrival_port_state?: string | null; + /** @description Country code of arrival port */ + arrival_port_country_code?: string | null; + /** @description Country name of arrival port */ + arrival_port_country?: string | null; + /** @description Label of arrival port (POL, POD, TS1, etc.) */ + arrival_port_label?: string | null; + /** + * Format: date-time + * @description Estimated time of arrival at the next port (ISO 8601) + */ + arrival_port_eta?: string | null; + /** @description Timezone of arrival port */ + arrival_port_time_zone?: string | null; + }; + /** Past Vessel Locations */ + pastVesselLocationsFeatureProperties: { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + feature_type: "past_vessel_locations"; + /** @description Sequence number of the departure port for this leg */ + ports_sequence?: number; + /** @description Unique identifier for the vessel that traveled this path */ + vessel_id?: string; + /** + * Format: date-time + * @description Start timestamp of the path (ISO 8601) + */ + start_time?: string; + /** + * Format: date-time + * @description End timestamp of the path (ISO 8601) + */ + end_time?: string; + /** @description Number of coordinate points in the LineString */ + point_count?: number; + /** + * Format: date-time + * @description Actual time of departure from the origin port (ISO 8601) + */ + outbound_atd_at?: string | null; + /** + * Format: date-time + * @description Actual time of arrival at the destination port (ISO 8601) + */ + inbound_ata_at?: string | null; + /** + * Format: date-time + * @description Estimated time of arrival at the destination port (ISO 8601) + */ + inbound_eta_at?: string | null; + }; + /** Estimated Full Leg */ + estimatedFullLegFeatureProperties: { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + feature_type: "estimated_full_legs"; + /** @description Sequence number of the departure port for this leg */ + ports_sequence?: number; + /** @description ID of the origin port */ + previous_port_id?: string; + /** @description ID of the destination port */ + next_port_id?: string; + /** @description Number of coordinate points in the LineString */ + point_count?: number; + }; + /** Estimated Partial Leg */ + estimatedPartialLegFeatureProperties: { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + feature_type: "estimated_partial_leg"; + /** @description Sequence number of the departure port for this leg */ + ports_sequence?: number; + /** @description ID of the port the vessel departed from */ + current_port_id?: string; + /** @description ID of the next port the vessel is heading to */ + next_port_id?: string; + /** @description Number of coordinate points in the LineString */ + point_count?: number; + }; + /** Point */ + pointGeometry: { + /** @enum {string} */ + type: "Point"; + /** + * @example [ + * 100.896831042, + * 13.065302386 + * ] + */ + coordinates: number[]; + }; + /** @description Raw custom field value (type depends on definition) */ + custom_field_value: (string | number | boolean | string[] | Record) | null; + /** Custom field */ + custom_field: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "custom_field"; + attributes?: { + api_slug: string; + value?: components["schemas"]["custom_field_value"]; + /** @description Formatted value for display */ + display_value?: string | null; + }; + relationships?: { + entity?: { + data?: { + /** @enum {string} */ + type: "shipment" | "container" | "tracking_request"; + /** Format: uuid */ + id: string; + }; + }; + definition?: { + data?: { + /** @enum {string} */ + type: "custom_field_definition"; + /** Format: uuid */ + id: string; + }; + }; + }; + }; + /** Custom field definition */ + custom_field_definition: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "custom_field_definition"; + attributes?: { + /** @enum {string} */ + entity_type: "Shipment" | "Container" | "TrackingRequest"; + api_slug: string; + display_name: string; + description?: string | null; + /** @enum {string} */ + data_type: "short_text" | "number" | "date" | "datetime" | "boolean" | "enum" | "enum_multi" | "reference"; + reference_type?: string | null; + validation?: { + [key: string]: unknown; + } | null; + default_format?: string | null; + default_value?: components["schemas"]["custom_field_value"]; + }; + }; + /** Custom field option */ + custom_field_option: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "custom_field_option"; + attributes?: { + label: string; + value: string; + position?: number | null; + }; + }; + /** LineString */ + lineStringGeometry: { + /** @enum {string} */ + type: "LineString"; + /** + * @example [ + * [ + * 100.868768333, + * 13.07306 + * ], + * [ + * 100.839155, + * 13.079318333 + * ] + * ] + */ + coordinates: number[][]; + }; + /** Document Representation */ + document_representation: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "document_representation"; + attributes?: { + schema_version?: string; + payload?: { + [key: string]: unknown; + }; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + }; + /** Email Submission */ + email_submission: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "email_submission"; + attributes?: { + /** @description Email subject line. */ + subject?: string; + /** @description Email body content captured from the inbound message. */ + body?: string | null; + /** @description Sender email addresses. */ + from?: string[]; + /** @description Primary recipient email addresses. */ + to?: string[]; + /** @description CC recipient email addresses. */ + cc?: string[]; + /** + * Format: date-time + * @description Timestamp from the inbound email header. + */ + sent_at?: string | null; + /** @description Message-ID header value. */ + message_id?: string | null; + /** @description In-Reply-To header value. */ + in_reply_to?: string | null; + /** @description References header values. */ + references?: string[]; + /** @description Top-level MIME content type of the inbound email. */ + content_type?: string | null; + /** @description Number of non-discarded documents created from this email. */ + documents_count?: number; + /** + * Format: date-time + * @description When the email submission record was created. + */ + created_at?: string; + /** + * Format: date-time + * @description When the email submission record was last updated. + */ + updated_at?: string; + }; + relationships?: { + account?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "account"; + }; + }; + user?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "user"; + } | null; + }; + documents?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "document"; + }[]; + }; + }; + links?: { + self?: string; + }; + }; + /** Document Schema */ + document_schema: { + id: string; + /** @enum {string} */ + type: "document_schema"; + attributes?: { + /** @description Document type this schema applies to (for example, commercial_invoice). */ + document_type?: string; + /** @description Human-readable label for the document type. */ + label?: string; + /** @description Public schema version identifier. */ + schema_version?: string; + /** @description Fully-qualified schema version id (for example, commercial_invoice@2026-03-23). */ + full_version?: string; + /** @description Whether this schema version is currently active. */ + current?: boolean; + /** @description Whether this schema version is marked as draft. */ + draft?: boolean; + /** + * Format: date-time + * @description Timestamp when this schema version became active. + */ + active_at?: string | null; + /** + * @description Schema payload format. + * @enum {string} + */ + schema_format?: "json_schema"; + /** @description Optional notes describing this schema. */ + description?: string | null; + /** @description JSON Schema payload used to validate and describe extracted fields. */ + schema_payload?: { + [key: string]: unknown; + }; + /** + * Format: date-time + * @description When this schema record was created. + */ + created_at?: string; + /** + * Format: date-time + * @description When this schema record was last updated. + */ + updated_at?: string; + }; + links?: { + self?: string; + }; + }; + /** Document */ + document: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "document"; + attributes?: { + /** + * Format: uuid + * @description Unique identifier for the document. + */ + id?: string; + /** @description Display name of the document. */ + name?: string; + /** @description System-classified document type. */ + document_type?: string; + /** @description Document type set manually by a user, when available. */ + document_type_manual?: string | null; + /** @description Additional notes captured during document classification. */ + classification_notes?: string | null; + /** + * @description How the document was created in Terminal49. + * @enum {string} + */ + source?: "upload" | "api" | "email" | "split_document"; + /** @description Original file name of the uploaded or generated document. */ + file_name?: string; + /** @description MIME type of the document file. */ + file_content_type?: string | null; + /** @description File size in bytes. */ + file_size_bytes?: number | null; + /** @description Additional parsing metadata. Present for child documents created from a split packet. */ + parsed?: { + /** @description Page range of the child document within the original packet. */ + packetSegment?: { + /** @description Start page number (inclusive) in the parent packet. */ + startPage?: number; + /** @description End page number (inclusive) in the parent packet. */ + endPage?: number; + }; + } | null; + /** + * Format: date-time + * @description Timestamp when the document was created. + */ + created_at?: string; + /** + * Format: date-time + * @description Timestamp when the document was last updated. + */ + updated_at?: string; + }; + relationships?: { + account?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "account"; + }; + }; + user?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "user"; + } | null; + }; + email_submission?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "email_submission"; + } | null; + }; + last_document_representation?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "document_representation"; + } | null; + }; + /** @description Present for child documents created from a split packet. */ + parent_document?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "document"; + } | null; + }; + shipments?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "shipment"; + }[]; + }; + cargos?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "container"; + }[]; + }; + }; + links?: { + self?: string; + download?: string; + }; + }; + /** Document Email Submission */ + document_email_submission: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "email_submission"; + attributes?: { + subject?: string | null; + body_preview?: string | null; + from?: string[]; + to?: string[]; + cc?: string[]; + message_id?: string | null; + /** Format: date-time */ + sent_at?: string | null; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + }; + /** Email Submission Document */ + email_submission_document: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "document"; + attributes?: { + name?: string; + /** @enum {string} */ + source?: "upload" | "api" | "email" | "split_document"; + document_type?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + relationships?: { + last_document_representation?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "document_representation"; + } | null; + }; + }; + }; + /** Party role model */ + party_role: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "party_role"; + attributes?: { + /** + * @description Role the party plays on the record. Shipments accept every value. Containers accept only `pickup_dray_carrier`. + * @enum {string} + */ + role?: "shipper" | "consignee" | "notify_party" | "customs_broker" | "customer" | "freight_forwarder" | "pickup_dray_carrier"; + /** + * @description Type of the record the role is attached to. `Cargo` is returned for containers. + * @enum {string} + */ + roleable_type?: "Shipment" | "Cargo"; + /** + * Format: uuid + * @description ID of the shipment, container, or tracking request. + */ + roleable_id?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + relationships?: { + party?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "party"; + }; + }; + }; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + "get-shipments": { + parameters: { + query?: { + /** @description */ + "page[number]"?: number; + /** @description */ + "page[size]"?: number; + /** + * @deprecated + * @description Search shipments by master bill of lading, reference number, or container number. + */ + q?: string; + /** @description Comma delimited list of relations to include */ + include?: string; + /** @description Search shipments by the original tracking `request_number` — typically a master bill of lading or booking number. This filter does **not** match container numbers; to look up a shipment by container number, use `GET /containers?filter[number]={container_number}` and include the related shipment via `include=shipment`. */ + number?: string; + /** @description Filter shipments by whether they are still tracking or not */ + "filter[tracking_stopped]"?: boolean; + /** @description Set to `true` to add the `party_roles` relationship to each shipment. Add `include=party_roles.party` to embed the roles and their parties. */ + "flag[parties]"?: boolean; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["shipment"][]; + included?: (components["schemas"]["container"] | components["schemas"]["port"] | components["schemas"]["terminal"])[]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + }; + }; + }; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + }; + }; + "get-shipment-id": { + parameters: { + query?: { + /** @description Comma delimited list of relations to include */ + include?: string; + /** @description Set to `true` to add the `party_roles` relationship to each shipment. Add `include=party_roles.party` to embed the roles and their parties. */ + "flag[parties]"?: boolean; + }; + header?: never; + path: { + /** @description Shipment Id */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["shipment"]; + included?: (components["schemas"]["container"] | components["schemas"]["port"] | components["schemas"]["terminal"])[]; + }; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + }; + }; + "patch-shipments-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Shipment Id */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data?: { + attributes: { + /** + * @description Shipment ref numbers. + * @example [ + * "REFNUMBER10" + * ] + */ + ref_numbers?: string[]; + /** @description Tags related to a shipment */ + tags?: string[]; + }; + }; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["shipment"]; + }; + }; + }; + }; + }; + "patch-shipments-id-stop-tracking": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["shipment"]; + }; + }; + }; + }; + }; + "patch-shipments-id-resume-tracking": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["shipment"]; + }; + }; + }; + }; + }; + "get-tracking-requests": { + parameters: { + query?: { + /** + * @deprecated + * @description A search term to be applied against request_number and reference_numbers. + */ + q?: string; + /** @description filter by `request_number` */ + "filter[request_number]"?: string; + /** @description filter by `status` */ + "filter[status]"?: "created" | "pending" | "failed"; + /** @description filter by shipping line `scac` */ + "filter[scac]"?: string; + /** @description filter by tracking_requests `created_at` after a certain ISO8601 timestamp */ + "filter[created_at][start]"?: string; + /** @description filter by tracking_requests `created_at` before a certain ISO8601 timestamp */ + "filter[created_at][end]"?: string; + /** @description filter by tracking_requests `updated_at` after a certain ISO8601 timestamp */ + "filter[updated_at][start]"?: string; + /** @description filter by tracking_requests `updated_at` before a certain ISO8601 timestamp */ + "filter[updated_at][end]"?: string; + /** @description Comma delimited list of relations to include. 'tracked_object' is included by default. */ + include?: string; + "page[number]"?: number; + "page[size]"?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["tracking_request"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + included?: (components["schemas"]["account"] | components["schemas"]["shipping_line"] | { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "shipment"; + links?: { + /** Format: uri */ + self?: string; + }; + })[]; + }; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + }; + }; + "post-track": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Create a shipment tracking request */ + requestBody?: { + content: { + "application/json": { + data?: { + attributes?: { + /** + * @description The type of document number to be supplied. Container number support is currently in BETA. + * @example bill_of_lading + * @enum {string} + */ + request_type: "bill_of_lading" | "booking_number" | "container"; + /** @example MEDUFR030802 */ + request_number: string; + /** + * @description The carrier SCAC to use for this tracking request. Required unless `auto_detect_vocc_scac` is `true`. + * @example MSCU + */ + scac?: string; + /** + * @description Set to `true` to have Terminal49 infer the carrier SCAC from `request_number` when `scac` is not supplied. Detection is asynchronous: the tracking request is created immediately (HTTP `201`) with `status: "pending"` and `scac: null`. If a carrier is inferred, the request transitions to `status: "created"` with the detected `scac` populated. If no supported carrier can be inferred, it transitions to `status: "failed"` with `failed_reason: "scac_auto_detect_failed"` and no shipment is created. Poll the tracking request or use webhooks to observe the outcome — the create response does not include the detected `scac`. + * @default false + * @example true + */ + auto_detect_vocc_scac?: boolean; + /** @description Optional list of reference numbers to be added to the shipment when tracking request completes */ + ref_numbers?: string[]; + /** @description Optional list of tags to be added to the shipment when tracking request completes */ + shipment_tags?: string[]; + /** @description Optional custom field values to stage before the shipment and containers exist. Terminal49 applies `shipment` entries to the shipment and `containers` entries to matching containers once the tracking request resolves. Each `api_slug` must reference an existing custom field definition on your account. */ + initial_custom_fields?: { + /** @description Custom field values to apply to the shipment created by this tracking request. */ + shipment?: { + /** @description The `api_slug` of a custom field definition scoped to the `Shipment` entity type. */ + api_slug: string; + value: components["schemas"]["custom_field_value"]; + }[]; + /** @description Custom field values to apply to the containers created by this tracking request. Include `number` to target one specific container; omit it (or pass an empty string) to apply the value to every container on the shipment. */ + containers?: { + /** @description The `api_slug` of a custom field definition scoped to the `Container` entity type. */ + api_slug: string; + value: components["schemas"]["custom_field_value"]; + /** + * @description Container number to target. Omit this field, or pass an empty string, to broadcast this value to every container on the shipment. + * @example MSCU1234567 + */ + number?: string; + }[]; + }; + }; + relationships?: { + /** @description Party to assign as the customer. The response's `customer` relationship carries the party's linked account, or `null` when there is none. */ + customer?: { + data?: { + /** Format: uuid */ + id?: string; + /** @enum {string} */ + type?: "party"; + }; + }; + /** @description Party to assign as the shipper. One party per role at creation. The role is copied to the shipment when it is created and can be read with `GET /shipments/{shipment_id}/party_roles`. The party must belong to your account. */ + shipper?: { + data?: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "party"; + }; + }; + /** @description Party to assign as the consignee. One party per role at creation. The role is copied to the shipment when it is created and can be read with `GET /shipments/{shipment_id}/party_roles`. The party must belong to your account. */ + consignee?: { + data?: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "party"; + }; + }; + /** @description Party to assign as the notify party. One party per role at creation. The role is copied to the shipment when it is created and can be read with `GET /shipments/{shipment_id}/party_roles`. The party must belong to your account. */ + notify_party?: { + data?: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "party"; + }; + }; + /** @description Party to assign as the customs broker. One party per role at creation. The role is copied to the shipment when it is created and can be read with `GET /shipments/{shipment_id}/party_roles`. The party must belong to your account. */ + customs_broker?: { + data?: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "party"; + }; + }; + /** @description Party to assign as the freight forwarder. One party per role at creation. The role is copied to the shipment when it is created and can be read with `GET /shipments/{shipment_id}/party_roles`. The party must belong to your account. */ + freight_forwarder?: { + data?: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "party"; + }; + }; + /** @description Party to assign as the dray carrier. One party per role at creation. The role is copied to the shipment when it is created and can be read with `GET /shipments/{shipment_id}/party_roles`. The party must belong to your account. */ + pickup_dray_carrier?: { + data?: { + /** Format: uuid */ + id: string; + /** @enum {string} */ + type: "party"; + }; + }; + }; + /** @enum {string} */ + type: "tracking_request"; + }; + }; + }; + }; + responses: { + /** @description Tracking Request Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["tracking_request"]; + included?: (components["schemas"]["account"] | components["schemas"]["shipping_line"])[]; + }; + }; + }; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + /** @description Too Many Requests - You've hit the create tracking requests limit. Please try again in a minute. */ + 429: { + headers: { + /** @description Number of seconds to wait before making another request */ + "Retry-After"?: number; + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + /** @example 429 */ + status?: string; + /** @example Too Many Requests */ + title?: string; + /** @example You've hit the create tracking requests limit. Please try again in a minute. */ + detail?: string; + }[]; + }; + }; + }; + }; + }; + "post-infer-number": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The tracking number to analyze (container number, bill of lading, or booking number) + * @example WHLU1234560 + */ + number: string; + }; + }; + }; + responses: { + /** @description Successfully inferred number type and shipping line */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: { + /** @example req_123e4567-e89b-12d3-a456-426614174000 */ + id?: string; + /** @example infer_number_results */ + type?: string; + attributes?: { + /** @enum {string} */ + number_type?: "container" | "bill_of_lading" | "booking"; + validation?: { + is_valid?: boolean | null; + /** @enum {string} */ + type?: "container" | "shipment"; + check_digit_passed?: boolean | null; + parsed_number?: string | null; + reason?: string | null; + }; + shipping_line?: { + /** @enum {string} */ + decision?: "auto_select" | "needs_confirmation" | "no_prediction"; + selected?: { + scac?: string; + name?: string; + confidence?: number; + } | null; + candidates?: { + scac?: string; + name?: string; + confidence?: number; + }[]; + }; + }; + }; + }; + }; + }; + /** @description Unprocessable Entity - Invalid tracking number format */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + status?: string; + detail?: string; + }[]; + }; + }; + }; + /** @description Too Many Requests - Rate limit exceeded */ + 429: { + headers: { + /** @description Number of seconds to wait before making another request */ + "Retry-After"?: number; + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + status?: string; + detail?: string; + }[]; + }; + }; + }; + }; + }; + "get-track-request-by-id": { + parameters: { + query?: { + /** @description Comma delimited list of relations to include. 'tracked_object' is included by default. */ + include?: string; + }; + header?: never; + path: { + /** @description Tracking Request ID */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["tracking_request"]; + included?: (components["schemas"]["account"] | components["schemas"]["shipment"] | components["schemas"]["shipping_line"])[]; + }; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + }; + }; + "patch-track-request-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Tracking Request ID */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data?: { + attributes: { + /** + * @description Tracking request ref number. + * @example REFNUMBER11 + */ + ref_number?: string; + }; + }; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["tracking_request"]; + }; + }; + }; + }; + }; + "get-tracking-requests-custom-fields": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Tracking request ID */ + tracking_request_id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + }; + }; + }; + }; + }; + "post-tracking-requests-custom-fields": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Tracking request ID */ + tracking_request_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "data": { + * "type": "custom_field", + * "attributes": { + * "api_slug": "customer_reference_number", + * "value": "ABC124" + * } + * } + * } + */ + "application/json": { + data?: { + /** @enum {string} */ + type: "custom_field"; + attributes: { + api_slug: string; + value: components["schemas"]["custom_field_value"]; + }; + }; + }; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; + }; + }; + }; + }; + }; + "delete-tracking-requests-custom-fields-api-slug": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Tracking request ID */ + tracking_request_id: string; + /** @description Custom field api_slug */ + api_slug: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No Content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "patch-tracking-requests-custom-fields-api-slug": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Tracking request ID */ + tracking_request_id: string; + /** @description Custom field api_slug */ + api_slug: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data?: { + /** @enum {string} */ + type: "custom_field"; + attributes: { + value: components["schemas"]["custom_field_value"]; + }; + }; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; + }; + }; + }; + }; + }; + "get-webhooks-id": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["webhook"]; + }; + }; + }; + }; + }; + "delete-webhooks-id": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "patch-webhooks-id": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + attributes: { + /** + * Format: uri + * @description The URL of the webhook endpoint. + * @example https://webhook.site/#!/39084fbb-d887-42e8-be08-b9183ad02362 + */ + url?: string; + /** @description The list of events to enable for this endpoint. */ + events?: ("container.transport.vessel_arrived" | "container.transport.estimated.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.estimated.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.pickup_lfd_terminal.changed" | "container.pickup_lfd_rail.changed" | "container.pickup_appointment.changed" | "container.transport.available" | "container.transport.not_available" | "container.transport.delivered" | "document_representation.created" | "document_representation.failed")[]; + active?: boolean; + /** @description Optional custom headers to pass with each webhook invocation */ + headers?: { + /** @description The name of the header. (Please not this will be auto-capitalized) */ + name?: string; + /** @description The value to pass for the header */ + value?: string; + }[]; + }; + /** @enum {string} */ + type: "webhook"; + }; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["webhook"]; + }; + }; + }; + }; + }; + "get-webhooks": { + parameters: { + query?: { + "page[number]"?: number; + "page[size]"?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["webhook"][]; + meta?: components["schemas"]["meta"]; + links?: components["schemas"]["links"]; + }; + }; + }; + }; + }; + "post-webhooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data: { + attributes: { + /** + * Format: uri + * @description The URL of the webhook endpoint. + * @example https://webhook.site/#!/39084fbb-d887-42e8-be08-b9183ad02362 + */ + url: string; + /** @description The list of events to enable for this endpoint. */ + events?: ("container.transport.vessel_arrived" | "container.transport.estimated.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.estimated.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.pickup_lfd_terminal.changed" | "container.pickup_lfd_rail.changed" | "container.pickup_appointment.changed" | "container.transport.available" | "container.transport.not_available" | "container.transport.delivered" | "document_representation.created" | "document_representation.failed")[]; + active: boolean; + /** @description Optional custom headers to pass with each webhook invocation */ + headers?: { + /** @description The name of the header. (Please note this will be auto-capitalized) */ + name?: string; + /** @description The value to pass for the header */ + value?: string; + }[]; + }; + /** @enum {string} */ + type: "webhook"; + }; + }; + }; + }; + responses: { + /** @description Create a test webhook endpoint */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["webhook"]; + }; + "application/xml": components["schemas"]["webhook"]; + }; + }; + }; + }; + "get-webhooks-events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: { + id: string; + /** @enum {string} */ + type: "webhook_event_category"; + attributes: { + name: string; + events: { + /** @example tracking_request.succeeded */ + name: string; + description: string; + }[]; + }; + }[]; + }; + }; + }; + }; + }; + "get-webhook-notification-id": { + parameters: { + query?: { + /** @description Comma delimited list of relations to include. */ + include?: string; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["webhook_notification"]; + included?: (components["schemas"]["webhook"] | components["schemas"]["tracking_request"] | components["schemas"]["transport_event"] | components["schemas"]["estimated_event"] | components["schemas"]["container_updated_event"] | components["schemas"]["document"] | components["schemas"]["document_representation"] | components["schemas"]["document_email_submission"])[]; + }; + }; + }; + }; + }; + "get-webhook-notifications": { + parameters: { + query?: { + "page[number]"?: number; + "page[size]"?: number; + /** @description Comma delimited list of relations to include. */ + include?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["webhook_notification"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + included?: (components["schemas"]["webhook"] | components["schemas"]["tracking_request"] | components["schemas"]["transport_event"] | components["schemas"]["estimated_event"] | components["schemas"]["container_updated_event"] | components["schemas"]["document"] | components["schemas"]["document_representation"] | components["schemas"]["document_email_submission"])[]; + }; + }; + }; + }; + }; + "get-webhook-notifications-example": { + parameters: { + query?: { + /** @description The webhook notification event name you wish to see an example of */ + event?: "container.transport.vessel_arrived" | "container.transport.estimated.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.estimated.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.pickup_lfd_terminal.changed" | "container.pickup_lfd_rail.changed" | "container.pickup_appointment.changed" | "container.transport.available" | "container.transport.not_available" | "container.transport.delivered" | "document_representation.created" | "document_representation.failed"; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["webhook_notification"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + included?: (components["schemas"]["webhook"] | components["schemas"]["tracking_request"] | components["schemas"]["transport_event"] | components["schemas"]["estimated_event"] | components["schemas"]["container_updated_event"] | components["schemas"]["document"] | components["schemas"]["document_representation"] | components["schemas"]["document_email_submission"])[]; + }; + }; + }; + }; + }; + "get-webhooks-ips": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + webhook_notification_ips?: string[]; + /** Format: date-time */ + last_updated?: string; + }; + }; + }; + }; + }; + "post-webhooks-trigger": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { /** - * Format: date-time - * @description The last free day for pickup before demmurage accrues. Corresponding timezone is pod_timezone. + * Format: uri + * @description Destination URL for the test webhook delivery. Must be HTTPS. + * @example https://webhook.site/your-endpoint */ - pickup_lfd_terminal?: string | null; + url: string; /** - * Format: date-time - * @description The last free day for pickup before demmurage accrues. Corresponding timezone is final_destination_timezone. + * @description Webhook event name to use for generating an example payload. + * @example tracking_request.succeeded */ - pickup_lfd_rail?: string | null; + event: string; /** - * Format: date-time - * @description The last free day as reported by the line. Corresponding timezone is final_destination_timezone or pod_timezone. + * @description Optional secret used to sign the request in `X-T49-Webhook-Signature`. + * @example optional-test-secret */ - pickup_lfd_line?: string | null; - } | null; - /** - * @description The current status of the container in its journey. [Read guide to learn more.](/api-docs/in-depth-guides/container-statuses) - * @enum {string} - */ - current_status?: "new" | "on_ship" | "available" | "not_available" | "grounded" | "on_rail" | "picked_up" | "off_dock" | "delivered" | "dropped" | "loaded" | "empty_returned" | "awaiting_inland_transfer"; + secret?: string; + /** @description Optional test payload controls. Currently only supports `document_type` for document webhook events. */ + sample?: { + /** + * @description Specific document type to use when generating example payloads for `document_representation.created` or `document_representation.failed`. If omitted for these events, Terminal49 selects a default document type. + * @example dray_delivery_order + */ + document_type?: string; + }; + }; }; - relationships?: { - shipment?: { + }; + responses: { + /** @description Webhook test delivery attempt result */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uri + * @description Destination URL that the test webhook delivery attempted to call. + */ + url?: string; + /** @description Whether the webhook delivery attempt was considered successful (HTTP 200, 201, 202, or 204). */ + succeeded?: boolean; + /** @description Error message captured when delivery failed, or `null` when no error occurred. */ + error?: string | null; + /** @description HTTP status code returned by the destination endpoint, or `null` if no response was received. */ + status_code?: number | null; + /** @description Headers sent by Terminal49 with the test webhook request. */ + request_headers?: { + [key: string]: unknown; + }; + /** @description Serialized JSON payload delivered to the target URL. */ + request_body?: string; + /** @description Headers returned by the destination endpoint, or `null` when unavailable. */ + response_headers?: { + [key: string]: unknown; + } | null; + /** @description Raw response body returned by the destination endpoint, or `null` when unavailable. */ + response_body?: string | null; + }; + }; + }; + /** @description Validation error */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + /** @example url is required */ + detail?: string; + }[]; + }; + }; + }; + }; + }; + "get-containers": { + parameters: { + query?: { + "page[number]"?: number; + "page[size]"?: number; + /** @description Comma delimited list of relations to include */ + include?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["container"][]; + included?: components["schemas"]["shipment"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + }; + }; + }; + }; + }; + "patch-containers-id": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { data?: { - id?: string; - /** @enum {string} */ - type?: "shipment"; + attributes: { + ref_numbers?: string[]; + }; + }; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["container"]; + }; + }; + }; + }; + }; + "get-containers-id": { + parameters: { + query?: { + /** @description Comma delimited list of relations to include */ + include?: string; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["container"]; + included?: (components["schemas"]["shipment"] | components["schemas"]["terminal"] | components["schemas"]["transport_event"])[]; + }; + }; + }; + }; + }; + "get-containers-id-raw_events": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["raw_event"][]; + }; + }; + }; + }; + }; + "get-containers-id-transport_events": { + parameters: { + query?: { + /** @description Comma delimited list of relations to include */ + include?: string; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["transport_event"][]; + included?: (components["schemas"]["shipment"] | components["schemas"]["container"] | components["schemas"]["port"] | components["schemas"]["metro_area"] | components["schemas"]["terminal"] | components["schemas"]["rail_terminal"] | components["schemas"]["vessel"])[]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + }; + }; + }; + }; + }; + "get-containers-id-route": { + parameters: { + query?: { + /** @description Comma-delimited relations to include */ + include?: string; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["route"]; + included?: (components["schemas"]["route_location"] | components["schemas"]["port"] | components["schemas"]["vessel"] | components["schemas"]["shipment"])[]; }; }; - pickup_facility?: { - data?: { - id?: string; - /** @enum {string} */ - type?: "terminal"; + }; + /** @description Routing data is not enabled for this account */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; }; }; - pod_terminal?: { - data?: { - id?: string; + }; + }; + }; + "get-containers-id-map-geojson": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { /** @enum {string} */ - type?: "terminal"; + type: "FeatureCollection"; + features: { + /** @enum {string} */ + type: "Feature"; + geometry: { + /** @enum {string} */ + type: "Point"; + /** + * @example [ + * 100.896831042, + * 13.065302386 + * ] + */ + coordinates: number[]; + } | { + /** @enum {string} */ + type: "LineString"; + /** + * @example [ + * [ + * 100.868768333, + * 13.07306 + * ], + * [ + * 100.839155, + * 13.079318333 + * ] + * ] + */ + coordinates: number[][]; + }; + properties: components["schemas"]["portFeatureProperties"] | components["schemas"]["currentVesselFeatureProperties"] | components["schemas"]["pastVesselLocationsFeatureProperties"] | components["schemas"]["estimatedFullLegFeatureProperties"] | components["schemas"]["estimatedPartialLegFeatureProperties"]; + }[]; }; }; - transport_events?: { - data?: { - id?: string; - /** @enum {string} */ - type?: "transport_event"; - }[]; + }; + /** @description Forbidden - Routing data feature is not enabled for this account */ + 403: { + headers: { + [name: string]: unknown; }; - raw_events?: { - data?: { - id?: string; - /** @enum {string} */ - type?: "raw_event"; - }[]; + content: { + "application/json": { + errors?: { + /** @example 403 */ + status?: string; + /** @example Forbidden */ + title?: string; + /** @example Routing data feature is not enabled for this account */ + detail?: string; + }[]; + }; }; }; }; - /** Port model */ - port: { - /** Format: uuid */ - id: string; - attributes?: { - name?: string; - /** @description UN/LOCODE */ - code?: string; - state_abbr?: string | null; - city?: string | null; - /** @description 2 digit country code */ - country_code?: string; - /** @description IANA tz */ - time_zone?: string; - latitude?: number | null; - longitude?: number | null; + }; + "patch-containers-id-refresh": { + parameters: { + query?: never; + header?: never; + path: { + id: string; }; - /** @enum {string} */ - type: "port"; + cookie?: never; }; - /** Shipping line model */ - shipping_line: { - /** Format: uuid */ - id: string; - attributes: { - scac: string; - name: string; - /** @description Additional SCACs which will be accepted in tracking requests */ - alternative_scacs: string[]; - short_name: string; - bill_of_lading_tracking_support: boolean; - booking_number_tracking_support: boolean; - container_number_tracking_support: boolean; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example Started refresh for Shipping line, Terminal, Rail */ + message?: string; + }; + }; }; - /** @enum {string} */ - type: "shipping_line"; - }; - /** Account model */ - account: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "container"; - attributes: { - company_name: string; + /** @description Forbidden - This API endpoint is not enabled for your account. Please contact support@terminal49.com */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + /** @example 403 */ + status?: string; + /** @example API access not enabled */ + title?: string; + /** @example This API endpoint is not enabled for your account. Please contact support@terminal49.com */ + detail?: string; + }[]; + }; + }; + }; + /** @description Too Many Requests - You've hit the refresh limit. Please try again in a minute. */ + 429: { + headers: { + /** @description Number of seconds to wait before making another request */ + "Retry-After"?: number; + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + /** @example 429 */ + status?: string; + /** @example Too Many Requests */ + title?: string; + /** @example You've hit the refresh limit. Please try again in a minute. */ + detail?: string; + }[]; + }; + }; }; }; - /** Error model */ - error: { - detail?: string | null; - title: string | null; - source?: { - pointer?: string | null; - parameter?: string | null; - } | null; - code?: string | null; - status?: string | null; - meta?: { - /** Format: uuid */ - tracking_request_id?: string | null; - } | null; + }; + "get-shipping_lines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** Metro area model */ - metro_area: { - /** Format: uuid */ - id: string; - attributes?: { - name?: string; - /** @description UN/LOCODE */ - code?: string; - state_abbr?: string | null; - country_code?: string; - /** @description IANA tz */ - time_zone?: string; - latitude?: number | null; - longitude?: number | null; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["shipping_line"][]; + links?: components["schemas"]["links"]; + }; + }; }; - /** @enum {string} */ - type: "metro_area"; - ""?: string; }; - /** Terminal model */ - terminal: { - /** Format: uuid */ - id?: string; - relationships: { - port: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "port"; + }; + "get-shipping_lines-id": { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["shipping_line"]; }; }; }; - attributes: { - name: string; - nickname?: string; - /** @description CBP FIRMS Code or CBS Sublocation Code */ - firms_code?: string; - /** @description SMDG Code */ - smdg_code?: string; - /** @description BIC Facility Code */ - bic_facility_code?: string; - /** @description Street part of the address */ - street?: string; - /** @description City part of the address */ - city?: string; - /** @description State part of the address */ - state?: string; - /** @description State abbreviation for the state */ - state_abbr?: string; - /** @description ZIP code part of the address */ - zip?: string; - /** @description Country part of the address */ - country?: string; + }; + }; + "get-metro-area-id": { + parameters: { + query?: never; + header?: never; + path: { + id: string; }; - /** @enum {string} */ - type?: "terminal"; + cookie?: never; }; - /** Rail Terminal model */ - rail_terminal: { - /** Format: uuid */ - id?: string; - relationships?: { - port?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "port"; - } | null; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; }; - metro_area?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "metro_area"; + content: { + "application/json": { + data?: components["schemas"]["metro_area"]; }; }; }; - attributes: { - name: string; - nickname?: string; - /** @description CBP FIRMS Code or CBS Sublocation Code */ - firms_code?: string; - }; - /** @enum {string} */ - type?: "rail_terminal"; }; - /** Tracking Request */ - tracking_request: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "tracking_request"; - attributes?: { - /** @example ONEYSH9AME650500 */ - request_number: string; - ref_numbers?: string[] | null; - tags?: string[]; - /** @enum {string} */ - status: "pending" | "awaiting_manifest" | "created" | "failed" | "tracking_stopped"; - /** - * @description If the tracking request has failed, or is currently failing, the last reason we were unable to complete the request - * @enum {string|null} - */ - failed_reason?: "booking_cancelled" | "duplicate" | "expired" | "internal_processing_error" | "invalid_number" | "not_found" | "retries_exhausted" | "shipping_line_unreachable" | "unrecognized_response" | "data_unavailable" | null; - /** - * @example bill_of_lading - * @enum {string} - */ - request_type: "bill_of_lading" | "booking_number" | "container"; - /** @example ONEY */ - scac: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at?: string; - is_retrying?: boolean; - /** @description How many times T49 has attempted to get the shipment from the shipping line */ - retry_count?: number | null; + }; + "get-port-id": { + parameters: { + query?: never; + header?: never; + path: { + id: string; }; - relationships?: { - tracked_object?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "shipment"; - } | null; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; }; - customer?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "party"; + content: { + "application/json": { + data?: components["schemas"]["port"]; }; }; }; }; - /** webhook */ - webhook: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "webhook"; - attributes?: { - /** - * Format: uri - * @description https end point - */ - url: string; - /** - * @description Whether the webhook will be delivered when events are triggered - * @default true - */ - active: boolean; - /** @description The list of events to enabled for this endpoint */ - events: ("container.transport.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.transport.available")[]; - /** @description A random token that will sign all delivered webhooks */ - secret: string; - headers?: { - name?: string; - value?: string; - }[] | null; + }; + "get-vessels-id": { + parameters: { + query?: { + /** @description ISO 8601 timestamp to filter positions from. 7 days by default. */ + "show_positions[from_timestamp]"?: string; + /** @description ISO 8601 timestamp to filter positions up to. Current time by default. */ + "show_positions[to_timestamp]"?: string; + }; + header?: never; + path: { + id: string; }; + cookie?: never; }; - /** vessel */ - vessel: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "vessel"; - attributes?: { - /** - * @description The name of the ship or vessel - * @example Ever Given - */ - name?: string; - /** - * @description International Maritime Organization (IMO) number - * @example 9811000 - */ - imo?: string | null; - /** - * @description Maritime Mobile Service Identity (MMSI) - * @example 353136000 - */ - mmsi?: string | null; - /** - * @description The current latitude position of the vessel - * @example 25.29845 - */ - latitude?: number | null; - /** - * @description The current longitude position of the vessel - * @example 121.217 - */ - longitude?: number | null; - /** - * @description The current speed of the ship in knots (nautical miles per hour) - * @example 90 - */ - nautical_speed_knots?: number | null; - /** - * @description The current heading of the ship in degrees, where 0 is North, 90 is East, 180 is South, and 270 is West - * @example 194 - */ - navigational_heading_degrees?: number | null; - /** - * @description The timestamp of when the ship's position was last recorded, in ISO 8601 date and time format - * @example 2023-07-28T14:01:37Z - */ - position_timestamp?: string | null; - /** @description An array of historical position data for the vessel. Only included if `show_positions` is true. */ - positions?: { - /** @example 1.477285 */ - latitude?: number; - /** @example 104.535533333 */ - longitude?: number; - /** @example 51 */ - heading?: number | null; - /** - * Format: date-time - * @example 2025-05-23T19:14:22Z - */ - timestamp?: string; - /** @example false */ - estimated?: boolean; - }[] | null; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["vessel"]; + }; + }; + }; + /** @description Forbidden - Feature not enabled */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + /** @example 403 */ + status?: string; + source?: Record | null; + /** @example Forbidden */ + title?: string; + /** @example Routing data feature is not enabled for this account */ + detail?: string; + }[]; + }; + }; }; }; - /** Transport Event Model */ - transport_event: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "transport_event"; - attributes?: { - /** @enum {string} */ - event?: "container.transport.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.transport.available"; - voyage_number?: string | null; - /** Format: date-time */ - timestamp?: string | null; - /** @description IANA tz */ - timezone?: string | null; - /** @description UNLOCODE of the event location */ - location_locode?: string | null; - /** Format: date-time */ - created_at?: string; - /** - * @description The original source of the event data - * @example shipping_line - * @enum {string} - */ - data_source?: "shipping_line" | "terminal" | "ais"; + }; + "get-vessels-imo": { + parameters: { + query?: { + /** @description ISO 8601 timestamp to filter positions from. 7 days by default. */ + "show_positions[from_timestamp]"?: string; + /** @description ISO 8601 timestamp to filter positions up to. Current time by default. */ + "show_positions[to_timestamp]"?: string; }; - relationships?: { - shipment?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "shipment"; + header?: never; + path: { + imo: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["vessel"]; }; }; - location?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "port" | "metro_area"; - } | null; + }; + /** @description Forbidden - Feature not enabled */ + 403: { + headers: { + [name: string]: unknown; }; - vessel?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - name?: "vessel"; - } | null; + content: { + "application/json": { + errors?: { + /** @example 403 */ + status?: string; + source?: Record | null; + /** @example Forbidden */ + title?: string; + /** @example Routing data feature is not enabled for this account */ + detail?: string; + }[]; + }; }; - terminal?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "terminal" | "rail_terminal"; - } | null; + }; + }; + }; + "get-vessels-id-future-positions": { + parameters: { + query: { + /** @description The destination port id */ + port_id: string; + /** @description The previous port id */ + previous_port_id: string; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; }; - container?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "container"; + content: { + "application/json": { + data?: components["schemas"]["vessel_with_positions"]; + links?: { + /** Format: uri */ + self?: string; + }; + }; + }; + }; + /** @description Forbidden - Routing data feature is not enabled for this account */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + /** @example 403 */ + status?: string; + /** @example Forbidden */ + title?: string; + /** @example Routing data feature is not enabled for this account */ + detail?: string; + }[]; }; }; }; }; - /** Estimated Event Model */ - estimated_event: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "estimated_event"; - attributes: { - /** - * Format: date-time - * @description When the estimated event was created - */ - created_at: string; - /** Format: date-time */ - estimated_timestamp: string; - /** @enum {string} */ - event: "shipment.estimated.arrival"; - /** @description UNLOCODE of the event location */ - location_locode?: string | null; - /** @description IANA tz */ - timezone?: string | null; - voyage_number?: string | null; - /** - * @description The original source of the event data - * @enum {string} - */ - data_source?: "shipping_line" | "terminal"; + }; + "get-vessels-id-future-positions-with-coordinates": { + parameters: { + query: { + /** @description The destination port id */ + port_id: string; + /** @description The previous port id */ + previous_port_id: string; + /** @description Starting latitude coordinate */ + latitude: number; + /** @description Starting longitude coordinate */ + longitude: number; }; - relationships: { - shipment: { - data: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "shipment"; - }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; }; - port?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "port"; - } | null; + content: { + "application/json": { + data?: components["schemas"]["vessel_with_positions"]; + links?: { + /** Format: uri */ + self?: string; + }; + }; }; - /** @description */ - vessel?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "vessel"; - } | null; + }; + /** @description Forbidden - Routing data feature is not enabled for this account */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: { + /** @example 403 */ + status?: string; + /** @example Forbidden */ + title?: string; + /** @example Routing data feature is not enabled for this account */ + detail?: string; + }[]; + }; }; }; }; - /** webhook_notification */ - webhook_notification: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "webhook_notification"; - attributes?: { - /** @enum {string} */ - event: "container.transport.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.transport.available"; - /** - * @description Whether the notification has been delivered to the webhook endpoint - * @default pending - * @enum {string} - */ - delivery_status: "pending" | "succeeded" | "failed"; - created_at: string; + }; + "get-terminal-id": { + parameters: { + query?: never; + header?: never; + path: { + id: string; }; - relationships?: { - webhook: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "webhook"; - }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; }; - reference_object?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "tracking_request" | "estimated_event" | "transport_event" | "container_updated_event"; + content: { + "application/json": { + data?: components["schemas"]["terminal"]; }; }; }; }; - /** terminal_hold */ - terminal_hold: { - name: string; - /** @enum {string} */ - status: "pending" | "hold"; - /** @description Text description from the terminal (if any) */ - description?: string | null; + }; + "list-parties": { + parameters: { + query?: { + "page[number]"?: number; + "page[size]"?: number; + }; + header?: never; + path?: never; + cookie?: never; }; - /** terminal_fee */ - terminal_fee: { - /** @enum {string} */ - type: "demurrage" | "exam" | "extended_dwell_time" | "other" | "total"; - /** @description The fee amount in local currency */ - amount: number; - /** - * @description The ISO 4217 currency code of the fee is charged in. E.g. USD - * @example USD - */ - currency_code?: string; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["party"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + }; + }; + }; }; - /** container_updated_event */ - container_updated_event: { - id?: string; - type?: string; - attributes?: { - /** - * @description A hash of all the changed attributes with the values being an array of the before and after. E.g. - * `{"pickup_lfd": [null, "2020-05-20"]}` - * - * The current attributes that can be alerted on are: - * - `available_for_pickup` - * - `pickup_lfd` - * - `fees_at_pod_terminal` - * - `holds_at_pod_terminal` - * - `pickup_appointment_at` - * - `pod_terminal` - */ - changeset: Record; - /** Format: date-time */ - timestamp: string; - /** @description IANA tz */ - timezone?: string; - /** - * @example terminal - * @enum {string} - */ - data_source?: "terminal"; + }; + "post-party": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data?: { + attributes: { + /** + * @description The name of the company + * @example COMPANY NAME + */ + company_name?: string; + }; + }; + }; }; - relationships: { - container: { - data: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "container"; + }; + responses: { + /** @description Party Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["party"]; + links?: components["schemas"]["link-self"]; }; }; - terminal: { - data: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "terminal"; + }; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; }; }; }; }; - /** - * Raw Event Model - * @description Raw Events represent the milestones from the shipping line for a given container. - * - * ### About raw_event datetimes - * - * The events may include estimated future events. The event is a future event if an `estimated_` timestamp is not null. - * - * The datetime properties `timestamp` and `estimated`. - * - * When the `time_zone` property is present the datetimes are UTC timestamps, which can be converted to the local time by parsing the provided `time_zone`. - * - * When the `time_zone` property is absent, the datetimes represent local times which serialized as UTC timestamps for consistency. - */ - raw_event: { - id?: string; - /** @enum {string} */ - type?: "raw_event"; - attributes?: { - /** - * @description Normalized string representing the event - * @enum {string|null} - */ - event?: "empty_out" | "full_in" | "positioned_in" | "positioned_out" | "vessel_loaded" | "vessel_departed" | "transshipment_arrived" | "transshipment_discharged" | "transshipment_loaded" | "transshipment_departed" | "feeder_arrived" | "feeder_discharged" | "feeder_loaded" | "feeder_departed" | "rail_loaded" | "rail_departed" | "rail_arrived" | "rail_unloaded" | "vessel_arrived" | "vessel_discharged" | "arrived_at_destination" | "delivered" | "full_out" | "empty_in" | "vgm_received" | "carrier_release" | "customs_release" | "available" | null; - /** @description The event name as returned by the carrier */ - original_event?: string; - /** - * Format: date-time - * @description The datetime the event either transpired or will occur in UTC - */ - timestamp?: string; - /** @description True if the timestamp is estimated, false otherwise */ - estimated?: boolean; - /** - * Format: date - * @description Deprecated: The date of the event at the event location when no time information is available. - */ - actual_on?: string | null; - /** - * Format: date - * @description Deprecated: The estimated date of the event at the event location when no time information is available. - */ - estimated_on?: string | null; - /** - * Format: date-time - * @description Deprecated: The datetime the event transpired in UTC - */ - actual_at?: string | null; - /** - * Format: date-time - * @description Deprecated: The estimated datetime the event will occur in UTC - */ - estimated_at?: string | null; - /** @description IANA tz where the event occured */ - timezone?: string | null; - /** - * Format: date-time - * @description When the raw_event was created in UTC - */ - created_at?: string; - /** @description The city or facility name of the event location */ - location_name?: string; - /** @description UNLOCODE of the event location */ - location_locode?: string | null; - /** @description The name of the vessel where applicable */ - vessel_name?: string | null; - /** @description The IMO of the vessel where applicable */ - vessel_imo?: string | null; - /** @description The order of the event. This may be helpful when only dates (i.e. actual_on) are available. */ - index?: number; - voyage_number?: string | null; + }; + "get-custom-field-definitions": { + parameters: { + query?: { + "page[number]"?: number; + "page[size]"?: number; + /** @description Filter by entity type (Shipment or Container) */ + "filter[entity_type]"?: string; + /** @description Filter by data type */ + "filter[data_type]"?: string; + /** @description Filter by display name (prefix match) */ + "filter[display_name]"?: string; }; - relationships?: { - location?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "port" | "metro_area"; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field_definition"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; }; }; - vessel?: { + }; + }; + }; + "post-custom-field-definitions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { data?: { - /** Format: uuid */ - id?: string; /** @enum {string} */ - type?: "vessel"; + type: "custom_field_definition"; + attributes: { + /** @enum {string} */ + entity_type: "Shipment" | "Container"; + api_slug: string; + display_name: string; + description?: string | null; + /** @enum {string} */ + data_type: "short_text" | "number" | "date" | "datetime" | "boolean" | "enum" | "enum_multi" | "reference"; + reference_type?: string | null; + validation?: { + [key: string]: unknown; + } | null; + default_format?: string | null; + default_value?: components["schemas"]["custom_field_value"]; + }; }; }; }; }; - /** Container Pod Terminal Changed Event */ - container_pod_terminal_changed_event: { - id?: string; - type?: string; - attributes?: { - /** - * @description Where the information about the terminal change came from - * @example shipping_line - * @enum {string} - */ - data_source?: "shipping_line" | "terminal" | "pierpass"; - /** - * Format: date-time - * @description When the terminal change was recorded - */ - timestamp?: string; - }; - relationships?: { - container?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "container"; - }; - shipment?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "shipment"; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; }; - /** @description The terminal the container has changed to. If this container is still on the vessel this represents an advisory. If it was previously at the terminal this represents an off-dock move. */ - terminal?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "terminal"; + content: { + "application/json": { + data?: components["schemas"]["custom_field_definition"]; + links?: components["schemas"]["link-self"]; + }; }; }; }; - /** Party model */ - party: { - /** Format: uuid */ - id?: string; - attributes: { - /** @description Company name */ - company_name: string; - }; - /** @enum {string} */ - type?: "party"; - }; - /** Route model */ - route: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "route"; - attributes: { - /** Format: uuid */ + }; + "get-custom-field-definitions-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ id: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; }; - relationships: { - cargo?: { - data?: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "container"; - }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; }; - shipment?: { - data?: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "shipment"; + content: { + "application/json": { + data?: components["schemas"]["custom_field_definition"]; + links?: components["schemas"]["link-self"]; }; }; - route_locations?: { - data?: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "route_location"; - }[]; + }; + }; + }; + "delete-custom-field-definitions-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; - /** Route Location model */ - route_location: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "route_location"; - attributes: { - /** Format: uuid */ + }; + "patch-custom-field-definitions-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ id: string; - inbound_scac?: string | null; - /** @enum {string|null} */ - inbound_mode?: "vessel" | "rail" | null; - /** Format: date-time */ - inbound_eta_at?: string | null; - /** Format: date-time */ - inbound_ata_at?: string | null; - inbound_voyage_number?: string | null; - outbound_scac?: string | null; - /** @enum {string|null} */ - outbound_mode?: "vessel" | "rail" | null; - /** Format: date-time */ - outbound_etd_at?: string | null; - /** Format: date-time */ - outbound_atd_at?: string | null; - outbound_voyage_number?: string | null; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; }; - relationships: { - route?: { + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { data?: { - /** Format: uuid */ - id: string; /** @enum {string} */ - type: "route"; + type: "custom_field_definition"; + attributes: { + display_name?: string; + description?: string | null; + validation?: { + [key: string]: unknown; + } | null; + default_format?: string | null; + default_value?: components["schemas"]["custom_field_value"]; + }; }; }; - inbound_vessel?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "vessel"; - } | null; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; }; - outbound_vessel?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "vessel"; - } | null; + content: { + "application/json": { + data?: components["schemas"]["custom_field_definition"]; + links?: components["schemas"]["link-self"]; + }; }; - location?: { + }; + }; + }; + "get-custom-field-options": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ + definition_id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field_option"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + }; + }; + }; + }; + }; + "post-custom-field-options": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ + definition_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { data?: { - /** Format: uuid */ - id?: string; /** @enum {string} */ - type?: "port" | "terminal"; + type: "custom_field_option"; + attributes: { + label: string; + value: string; + position?: number | null; + }; }; }; - facility?: { - data?: { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "terminal" | "port"; - } | null; - }; }; }; - /** Vessel with positions model */ - vessel_with_positions: { - /** Format: uuid */ - id: string; - /** @enum {string} */ - type: "vessel"; - attributes: { - /** @description The name of the ship or vessel */ - name?: string; - /** @description International Maritime Organization (IMO) number */ - imo?: string | null; - /** @description Maritime Mobile Service Identity (MMSI) */ - mmsi?: string | null; - /** @description The current latitude position of the vessel */ - latitude?: number | null; - /** @description The current longitude position of the vessel */ - longitude?: number | null; - /** @description The current speed of the ship in knots (nautical miles per hour) */ - nautical_speed_knots?: number | null; - /** @description The current heading of the ship in degrees, where 0 is North, 90 is East, 180 is South, and 270 is West */ - navigational_heading_degrees?: number | null; - /** - * Format: date-time - * @description The timestamp of when the ship's position was last recorded, in ISO 8601 date and time format - */ - position_timestamp?: string | null; - /** @description Array of estimated future positions */ - positions?: { - latitude: number; - longitude: number; - heading?: number | null; - /** Format: date-time */ - timestamp: string; - estimated: boolean; - }[]; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field_option"]; + links?: components["schemas"]["link-self"]; + }; + }; }; }; - /** Port */ - portFeatureProperties: { - /** - * @description discriminator enum property added by openapi-typescript - * @enum {string} - */ - feature_type: "port"; - /** @description The sequence number of this port in the route (1 = POL, last = POD) */ - ports_sequence?: number; - /** @description Total number of ports in the route */ - ports_total?: number; - /** @description Unique identifier for the port location */ - location_id?: string; - /** @enum {string} */ - location_type?: "Port"; - /** @description Name of the port */ - name?: string; - /** @description State abbreviation (if applicable) */ - state_abbr?: string | null; - /** @description State name (if applicable) */ - state?: string | null; - /** @description ISO country code */ - country_code?: string; - /** @description Country name */ - country?: string; - /** @description IANA timezone identifier */ - time_zone?: string; - /** @description Port label: POL, POD, or TS1, TS2, etc. */ - label?: string; - /** - * Format: date-time - * @description Estimated time of arrival (ISO 8601) - */ - inbound_eta_at?: string | null; - /** - * Format: date-time - * @description Actual time of arrival (ISO 8601) - */ - inbound_ata_at?: string | null; - /** - * Format: date-time - * @description Estimated time of departure (ISO 8601) - */ - outbound_etd_at?: string | null; - /** - * Format: date-time - * @description Actual time of departure (ISO 8601) - */ - outbound_atd_at?: string | null; - /** - * Format: date-time - * @description Last update timestamp from the shipment (ISO 8601) - */ - updated_at?: string | null; - }; - /** Current Vessel */ - currentVesselFeatureProperties: { - /** - * @description discriminator enum property added by openapi-typescript - * @enum {string} - */ - feature_type: "current_vessel"; - /** @description Sequence number of the departure port for this leg */ - ports_sequence?: number; - /** @description Unique identifier for the vessel */ - vessel_id?: string; - /** @description Name of the vessel */ - vessel_name?: string; - /** @description IMO number of the vessel */ - vessel_imo?: string; - /** @description Voyage number for this leg */ - voyage_number?: string | null; - /** - * Format: date-time - * @description Timestamp of the vessel position (ISO 8601) - */ - vessel_location_timestamp?: string; - /** @description Vessel heading in degrees (0-360) */ - vessel_location_heading?: number | null; - /** @description Vessel speed in knots */ - vessel_location_speed?: number | null; - /** @description ID of the port the vessel departed from */ - departure_port_id?: string; - /** @description Name of the departure port */ - departure_port_name?: string; - /** @description State abbreviation of departure port */ - departure_port_state_abbr?: string | null; - /** @description State name of departure port */ - departure_port_state?: string | null; - /** @description Country code of departure port */ - departure_port_country_code?: string; - /** @description Country name of departure port */ - departure_port_country?: string; - /** @description Label of departure port (POL, POD, TS1, etc.) */ - departure_port_label?: string; - /** - * Format: date-time - * @description Actual time of departure from the port (ISO 8601) - */ - departure_port_atd?: string | null; - /** @description Timezone of departure port */ - departure_port_time_zone?: string; - /** @description ID of the next port the vessel is heading to */ - arrival_port_id?: string | null; - /** @description Name of the arrival port */ - arrival_port_name?: string | null; - /** @description State abbreviation of arrival port */ - arrival_port_state_abbr?: string | null; - /** @description State name of arrival port */ - arrival_port_state?: string | null; - /** @description Country code of arrival port */ - arrival_port_country_code?: string | null; - /** @description Country name of arrival port */ - arrival_port_country?: string | null; - /** @description Label of arrival port (POL, POD, TS1, etc.) */ - arrival_port_label?: string | null; - /** - * Format: date-time - * @description Estimated time of arrival at the next port (ISO 8601) - */ - arrival_port_eta?: string | null; - /** @description Timezone of arrival port */ - arrival_port_time_zone?: string | null; - }; - /** Past Vessel Locations */ - pastVesselLocationsFeatureProperties: { - /** - * @description discriminator enum property added by openapi-typescript - * @enum {string} - */ - feature_type: "past_vessel_locations"; - /** @description Sequence number of the departure port for this leg */ - ports_sequence?: number; - /** @description Unique identifier for the vessel that traveled this path */ - vessel_id?: string; - /** - * Format: date-time - * @description Start timestamp of the path (ISO 8601) - */ - start_time?: string; - /** - * Format: date-time - * @description End timestamp of the path (ISO 8601) - */ - end_time?: string; - /** @description Number of coordinate points in the LineString */ - point_count?: number; - /** - * Format: date-time - * @description Actual time of departure from the origin port (ISO 8601) - */ - outbound_atd_at?: string | null; - /** - * Format: date-time - * @description Actual time of arrival at the destination port (ISO 8601) - */ - inbound_ata_at?: string | null; - /** - * Format: date-time - * @description Estimated time of arrival at the destination port (ISO 8601) - */ - inbound_eta_at?: string | null; + }; + "get-custom-field-options-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ + definition_id: string; + /** @description Custom field option ID */ + option_id: string; + }; + cookie?: never; }; - /** Estimated Full Leg */ - estimatedFullLegFeatureProperties: { - /** - * @description discriminator enum property added by openapi-typescript - * @enum {string} - */ - feature_type: "estimated_full_legs"; - /** @description Sequence number of the departure port for this leg */ - ports_sequence?: number; - /** @description ID of the origin port */ - previous_port_id?: string; - /** @description ID of the destination port */ - next_port_id?: string; - /** @description Number of coordinate points in the LineString */ - point_count?: number; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field_option"]; + links?: components["schemas"]["link-self"]; + }; + }; + }; }; - /** Estimated Partial Leg */ - estimatedPartialLegFeatureProperties: { - /** - * @description discriminator enum property added by openapi-typescript - * @enum {string} - */ - feature_type: "estimated_partial_leg"; - /** @description Sequence number of the departure port for this leg */ - ports_sequence?: number; - /** @description ID of the port the vessel departed from */ - current_port_id?: string; - /** @description ID of the next port the vessel is heading to */ - next_port_id?: string; - /** @description Number of coordinate points in the LineString */ - point_count?: number; + }; + "delete-custom-field-options-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ + definition_id: string; + /** @description Custom field option ID */ + option_id: string; + }; + cookie?: never; }; - /** Point */ - pointGeometry: { - /** @enum {string} */ - type: "Point"; - /** - * @example [ - * 100.896831042, - * 13.065302386 - * ] - */ - coordinates: number[]; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; - /** LineString */ - lineStringGeometry: { - /** @enum {string} */ - type: "LineString"; - /** - * @example [ - * [ - * 100.868768333, - * 13.07306 - * ], - * [ - * 100.839155, - * 13.079318333 - * ] - * ] - */ - coordinates: number[][]; + }; + "patch-custom-field-options-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field definition ID */ + definition_id: string; + /** @description Custom field option ID */ + option_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data?: { + /** @enum {string} */ + type: "custom_field_option"; + attributes: { + label?: string; + position?: number | null; + }; + }; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field_option"]; + links?: components["schemas"]["link-self"]; + }; + }; + }; }; }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -} -export type $defs = Record; -export interface operations { - "get-shipments": { + "get-custom-fields": { parameters: { query?: { - /** @description */ "page[number]"?: number; - /** @description */ "page[size]"?: number; - /** - * @deprecated - * @description Search shipments by master bill of lading, reference number, or container number. - */ - q?: string; - /** @description Comma delimited list of relations to include */ - include?: string; - /** @description Search shipments by the original request tracking `request_number` */ - number?: string; - /** @description Filter shipments by whether they are still tracking or not */ - "filter[tracking_stopped]"?: boolean; + /** @description Filter by entity type (Shipment or Container) */ + "filter[entity_type]"?: string; + /** @description Filter by entity ID */ + "filter[entity_id]"?: string; + /** @description Filter by custom field definition ID */ + "filter[definition_id]"?: string; }; header?: never; path?: never; @@ -2135,35 +5376,85 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["shipment"][]; - included?: (components["schemas"]["container"] | components["schemas"]["port"] | components["schemas"]["terminal"])[]; + data?: components["schemas"]["custom_field"][]; links?: components["schemas"]["links"]; meta?: components["schemas"]["meta"]; }; }; }; - /** @description Unprocessable Entity */ - 422: { + }; + }; + "post-custom-fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "data": { + * "type": "custom_field", + * "attributes": { + * "api_slug": "customer_reference_number", + * "value": "ABC124" + * }, + * "relationships": { + * "entity": { + * "data": { + * "type": "shipment", + * "id": "YOUR_SHIPMENT_ID" + * } + * } + * } + * } + * } + */ + "application/json": { + data?: { + /** @enum {string} */ + type: "custom_field"; + attributes: { + api_slug: string; + value: components["schemas"]["custom_field_value"]; + }; + relationships: { + entity?: { + data?: { + /** @enum {string} */ + type: "shipment" | "container"; + /** Format: uuid */ + id: string; + }; + }; + }; + }; + }; + }; + }; + responses: { + /** @description Created */ + 201: { headers: { [name: string]: unknown; }; content: { "application/json": { - errors?: components["schemas"]["error"][]; + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; }; }; }; }; }; - "get-shipment-id": { + "get-custom-fields-id": { parameters: { - query?: { - /** @description Comma delimited list of relations to include */ - include?: string; - }; + query?: never; header?: never; path: { - /** @description Shipment Id */ + /** @description Custom field ID */ id: string; }; cookie?: never; @@ -2177,30 +5468,40 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["shipment"]; - included?: (components["schemas"]["container"] | components["schemas"]["port"] | components["schemas"]["terminal"])[]; + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; }; }; }; - /** @description Not Found */ - 404: { + }; + }; + "delete-custom-fields-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Custom field ID */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - errors?: components["schemas"]["error"][]; - }; - }; + content?: never; }; }; }; - "patch-shipments-id": { + "patch-custom-fields-id": { parameters: { query?: never; header?: never; path: { - /** @description Shipment Id */ + /** @description Custom field ID */ id: string; }; cookie?: never; @@ -2209,16 +5510,10 @@ export interface operations { content: { "application/json": { data?: { + /** @enum {string} */ + type: "custom_field"; attributes: { - /** - * @description Shipment ref numbers. - * @example [ - * "REFNUMBER10" - * ] - */ - ref_numbers?: string[]; - /** @description Tags related to a shipment */ - shipment_tags?: string[]; + value: components["schemas"]["custom_field_value"]; }; }; }; @@ -2232,18 +5527,20 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["shipment"]; + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; }; }; }; }; }; - "patch-shipments-id-stop-tracking": { + "get-shipments-custom-fields": { parameters: { query?: never; header?: never; path: { - id: string; + /** @description Shipment ID */ + shipment_id: string; }; cookie?: never; }; @@ -2256,22 +5553,112 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["shipment"]; + data?: components["schemas"]["custom_field"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; }; }; }; }; }; - "patch-shipments-id-resume-tracking": { + "post-shipments-custom-fields": { parameters: { query?: never; header?: never; path: { - id: string; + /** @description Shipment ID */ + shipment_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "data": { + * "type": "custom_field", + * "attributes": { + * "api_slug": "customer_reference_number", + * "value": "ABC124" + * } + * } + * } + */ + "application/json": { + data?: { + /** @enum {string} */ + type: "custom_field"; + attributes: { + api_slug: string; + value: components["schemas"]["custom_field_value"]; + }; + }; + }; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; + }; + }; + }; + }; + }; + "delete-shipments-custom-fields-api-slug": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Shipment ID */ + shipment_id: string; + /** @description Custom field api_slug */ + api_slug: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No Content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "patch-shipments-custom-fields-api-slug": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Shipment ID */ + shipment_id: string; + /** @description Custom field api_slug */ + api_slug: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + data?: { + /** @enum {string} */ + type: "custom_field"; + attributes: { + value: components["schemas"]["custom_field_value"]; + }; + }; + }; }; - cookie?: never; }; - requestBody?: never; responses: { /** @description OK */ 200: { @@ -2280,41 +5667,21 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["shipment"]; + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; }; }; }; }; }; - "get-tracking-requests": { + "get-shipments-party-roles": { parameters: { - query?: { - /** - * @deprecated - * @description A search term to be applied against request_number and reference_numbers. - */ - q?: string; - /** @description filter by `request_number` */ - "filter[request_number]"?: string; - /** @description filter by `status` */ - "filter[status]"?: "created" | "pending" | "failed"; - /** @description filter by shipping line `scac` */ - "filter[scac]"?: string; - /** @description filter by tracking_requests `created_at` after a certain ISO8601 timestamp */ - "filter[created_at][start]"?: string; - /** @description filter by tracking_requests `created_at` before a certain ISO8601 timestamp */ - "filter[created_at][end]"?: string; - /** @description filter by tracking_requests `updated_at` after a certain ISO8601 timestamp */ - "filter[updated_at][start]"?: string; - /** @description filter by tracking_requests `updated_at` before a certain ISO8601 timestamp */ - "filter[updated_at][end]"?: string; - /** @description Comma delimited list of relations to include. 'tracked_object' is included by default. */ - include?: string; - "page[number]"?: number; - "page[size]"?: number; - }; + query?: never; header?: never; - path?: never; + path: { + /** @description Shipment ID */ + shipment_id: string; + }; cookie?: never; }; requestBody?: never; @@ -2326,24 +5693,15 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["tracking_request"][]; + data?: components["schemas"]["party_role"][]; + included?: components["schemas"]["party"][]; links?: components["schemas"]["links"]; meta?: components["schemas"]["meta"]; - included?: (components["schemas"]["account"] | components["schemas"]["shipping_line"] | { - /** Format: uuid */ - id?: string; - /** @enum {string} */ - type?: "shipment"; - links?: { - /** Format: uri */ - self?: string; - }; - })[]; }; }; }; - /** @description Not Found */ - 404: { + /** @description Unauthorized. Also returned when the record belongs to another account. */ + 401: { headers: { [name: string]: unknown; }; @@ -2353,67 +5711,89 @@ export interface operations { }; }; }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "post-track": { + "post-shipments-party-roles": { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description Shipment ID */ + shipment_id: string; + }; cookie?: never; }; - /** @description Create a shipment tracking request */ requestBody?: { content: { + /** + * @example { + * "data": { + * "type": "party_role", + * "attributes": { + * "role": "shipper" + * }, + * "relationships": { + * "party": { + * "data": { + * "id": "ba4cb904-827f-4038-8e31-1e92b3356218", + * "type": "party" + * } + * } + * } + * } + * } + */ "application/json": { - data?: { - attributes?: { + data: { + /** @enum {string} */ + type: "party_role"; + attributes: { /** - * @description The type of document number to be supplied. Container number support is currently in BETA. - * @example bill_of_lading + * @description Accepted values: `shipper`, `consignee`, `notify_party`, `customs_broker`, `customer`, `freight_forwarder`, `pickup_dray_carrier`. * @enum {string} */ - request_type: "bill_of_lading" | "booking_number" | "container"; - /** @example MEDUFR030802 */ - request_number: string; - /** @example MSCU */ - scac: string; - /** @description Optional list of reference numbers to be added to the shipment when tracking request completes */ - ref_numbers?: string[]; - /** @description Optional list of tags to be added to the shipment when tracking request completes */ - shipment_tags?: string[]; + role: "shipper" | "consignee" | "notify_party" | "customs_broker" | "customer" | "freight_forwarder" | "pickup_dray_carrier"; }; - relationships?: { - customer?: { - data?: { - /** Format: uuid */ - id?: string; + relationships: { + party: { + data: { + /** + * Format: uuid + * @description ID of a party in your account. See `GET /parties`. + */ + id: string; /** @enum {string} */ - type?: "party"; + type: "party"; }; }; }; - /** @enum {string} */ - type: "tracking_request"; }; }; }; }; responses: { - /** @description Tracking Request Created */ + /** @description Created */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["tracking_request"]; - included?: (components["schemas"]["account"] | components["schemas"]["shipping_line"])[]; + data?: components["schemas"]["party_role"]; + included?: components["schemas"]["party"][]; + links?: components["schemas"]["link-self"]; }; }; }; - /** @description Unprocessable Entity */ - 422: { + /** @description Unauthorized. Also returned when the party or the record belongs to another account. */ + 401: { headers: { [name: string]: unknown; }; @@ -2423,131 +5803,74 @@ export interface operations { }; }; }; - /** @description Too Many Requests - You've hit the create tracking requests limit. Please try again in a minute. */ - 429: { + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unprocessable Entity */ + 422: { headers: { - /** @description Number of seconds to wait before making another request */ - "Retry-After"?: number; [name: string]: unknown; }; content: { "application/json": { - errors?: { - /** @example 429 */ - status?: string; - /** @example Too Many Requests */ - title?: string; - /** @example You've hit the create tracking requests limit. Please try again in a minute. */ - detail?: string; - }[]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "post-infer-number": { + "delete-shipments-party-roles-id": { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The tracking number to analyze (container number, bill of lading, or booking number) - * @example WHLU1234560 - */ - number: string; - }; + path: { + /** @description Shipment ID */ + shipment_id: string; + /** @description Party role ID */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successfully inferred number type and shipping line */ - 200: { + /** @description No Content */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - data?: { - /** @example req_123e4567-e89b-12d3-a456-426614174000 */ - id?: string; - /** @example infer_number_results */ - type?: string; - attributes?: { - /** @enum {string} */ - number_type?: "container" | "bill_of_lading" | "booking"; - validation?: { - is_valid?: boolean | null; - /** @enum {string} */ - type?: "container" | "shipment"; - check_digit_passed?: boolean | null; - parsed_number?: string | null; - reason?: string | null; - }; - shipping_line?: { - /** @enum {string} */ - decision?: "auto_select" | "needs_confirmation" | "no_prediction"; - selected?: { - scac?: string; - name?: string; - confidence?: number; - } | null; - candidates?: { - scac?: string; - name?: string; - confidence?: number; - }[]; - }; - }; - }; - }; - }; + content?: never; }; - /** @description Unprocessable Entity - Invalid tracking number format */ - 422: { + /** @description Unauthorized. Also returned when the record belongs to another account. */ + 401: { headers: { [name: string]: unknown; }; content: { "application/json": { - errors?: { - status?: string; - detail?: string; - }[]; + errors?: components["schemas"]["error"][]; }; }; }; - /** @description Too Many Requests - Rate limit exceeded */ - 429: { + /** @description Not Found */ + 404: { headers: { - /** @description Number of seconds to wait before making another request */ - "Retry-After"?: number; [name: string]: unknown; }; - content: { - "application/json": { - errors?: { - status?: string; - detail?: string; - }[]; - }; - }; + content?: never; }; }; }; - "get-track-request-by-id": { + "get-containers-custom-fields": { parameters: { - query?: { - /** @description Comma delimited list of relations to include. 'tracked_object' is included by default. */ - include?: string; - }; + query?: never; header?: never; path: { - /** @description Tracking Request ID */ - id: string; + /** @description Container ID */ + container_id: string; }; cookie?: never; }; @@ -2560,100 +5883,80 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["tracking_request"]; - included?: (components["schemas"]["account"] | components["schemas"]["shipment"] | components["schemas"]["shipping_line"])[]; - }; - }; - }; - /** @description Not Found */ - 404: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - errors?: components["schemas"]["error"][]; + data?: components["schemas"]["custom_field"][]; + links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; }; }; }; }; }; - "patch-track-request-by-id": { + "post-containers-custom-fields": { parameters: { query?: never; header?: never; path: { - /** @description Tracking Request ID */ - id: string; + /** @description Container ID */ + container_id: string; }; cookie?: never; }; requestBody?: { content: { + /** + * @example { + * "data": { + * "type": "custom_field", + * "attributes": { + * "api_slug": "customer_reference_number", + * "value": "ABC124" + * } + * } + * } + */ "application/json": { data?: { + /** @enum {string} */ + type: "custom_field"; attributes: { - /** - * @description Tracking request ref number. - * @example REFNUMBER11 - */ - ref_number?: string; + api_slug: string; + value: components["schemas"]["custom_field_value"]; }; }; }; }; }; responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - data?: components["schemas"]["tracking_request"]; - }; - }; - }; - }; - }; - "get-webhooks-id": { - parameters: { - query?: never; - header?: never; - path: { - id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { + /** @description Created */ + 201: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["webhook"]; + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; }; }; }; }; }; - "delete-webhooks-id": { + "delete-containers-custom-fields-api-slug": { parameters: { query?: never; header?: never; path: { - id: string; + /** @description Container ID */ + container_id: string; + /** @description Custom field api_slug */ + api_slug: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description OK */ - 200: { + /** @description No Content */ + 204: { headers: { [name: string]: unknown; }; @@ -2661,39 +5964,27 @@ export interface operations { }; }; }; - "patch-webhooks-id": { + "patch-containers-custom-fields-api-slug": { parameters: { query?: never; header?: never; path: { - id: string; + /** @description Container ID */ + container_id: string; + /** @description Custom field api_slug */ + api_slug: string; }; cookie?: never; }; requestBody?: { content: { "application/json": { - data: { + data?: { + /** @enum {string} */ + type: "custom_field"; attributes: { - /** - * Format: uri - * @description The URL of the webhook endpoint. - * @example https://webhook.site/#!/39084fbb-d887-42e8-be08-b9183ad02362 - */ - url?: string; - /** @description The list of events to enable for this endpoint. */ - events?: ("container.transport.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.transport.available")[]; - active?: boolean; - /** @description Optional custom headers to pass with each webhook invocation */ - headers?: { - /** @description The name of the header. (Please not this will be auto-capitalized) */ - name?: string; - /** @description The value to pass for the header */ - value?: string; - }[]; + value: components["schemas"]["custom_field_value"]; }; - /** @enum {string} */ - type: "webhook"; }; }; }; @@ -2706,20 +5997,21 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["webhook"]; + data?: components["schemas"]["custom_field"]; + links?: components["schemas"]["link-self"]; }; }; }; }; }; - "get-webhooks": { + "get-containers-party-roles": { parameters: { - query?: { - "page[number]"?: number; - "page[size]"?: number; - }; + query?: never; header?: never; - path?: never; + path: { + /** @description Container ID */ + container_id: string; + }; cookie?: never; }; requestBody?: never; @@ -2731,185 +6023,184 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["webhook"][]; - meta?: components["schemas"]["meta"]; + data?: components["schemas"]["party_role"][]; + included?: components["schemas"]["party"][]; links?: components["schemas"]["links"]; + meta?: components["schemas"]["meta"]; + }; + }; + }; + /** @description Unauthorized. Also returned when the record belongs to another account. */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; }; }; }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "post-webhooks": { + "post-containers-party-roles": { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description Container ID */ + container_id: string; + }; cookie?: never; }; requestBody?: { content: { + /** + * @example { + * "data": { + * "type": "party_role", + * "attributes": { + * "role": "pickup_dray_carrier" + * }, + * "relationships": { + * "party": { + * "data": { + * "id": "ba4cb904-827f-4038-8e31-1e92b3356218", + * "type": "party" + * } + * } + * } + * } + * } + */ "application/json": { data: { + /** @enum {string} */ + type: "party_role"; attributes: { /** - * Format: uri - * @description The URL of the webhook endpoint. - * @example https://webhook.site/#!/39084fbb-d887-42e8-be08-b9183ad02362 + * @description Only `pickup_dray_carrier` is accepted. Other values return `422`. + * @enum {string} */ - url: string; - /** @description The list of events to enable for this endpoint. */ - events?: ("container.transport.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.transport.available")[]; - active: boolean; - /** @description Optional custom headers to pass with each webhook invocation */ - headers?: { - /** @description The name of the header. (Please note this will be auto-capitalized) */ - name?: string; - /** @description The value to pass for the header */ - value?: string; - }[]; + role: "pickup_dray_carrier"; + }; + relationships: { + party: { + data: { + /** + * Format: uuid + * @description ID of a party in your account. See `GET /parties`. + */ + id: string; + /** @enum {string} */ + type: "party"; + }; + }; }; - /** @enum {string} */ - type: "webhook"; }; }; }; }; responses: { - /** @description Create a test webhook endpoint */ + /** @description Created */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["webhook"]; + data?: components["schemas"]["party_role"]; + included?: components["schemas"]["party"][]; + links?: components["schemas"]["link-self"]; }; - "application/xml": components["schemas"]["webhook"]; }; }; - }; - }; - "get-webhook-notification-id": { - parameters: { - query?: { - /** @description Comma delimited list of relations to include. */ - include?: string; - }; - header?: never; - path: { - id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: { + /** @description Unauthorized. Also returned when the party or the record belongs to another account. */ + 401: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["webhook_notification"]; - included?: (components["schemas"]["webhook"] | components["schemas"]["tracking_request"] | components["schemas"]["transport_event"] | components["schemas"]["estimated_event"] | components["schemas"]["container_updated_event"])[]; + errors?: components["schemas"]["error"][]; }; }; }; - }; - }; - "get-webhook-notifications": { - parameters: { - query?: { - "page[number]"?: number; - "page[size]"?: number; - /** @description Comma delimited list of relations to include. */ - include?: string; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { + /** @description Not Found */ + 404: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - data?: components["schemas"]["webhook_notification"][]; - links?: components["schemas"]["links"]; - meta?: components["schemas"]["meta"]; - included?: (components["schemas"]["webhook"] | components["schemas"]["tracking_request"] | components["schemas"]["transport_event"] | components["schemas"]["estimated_event"])[]; - }; - }; - }; - }; - }; - "get-webhook-notifications-example": { - parameters: { - query?: { - /** @description The webhook notification event name you wish to see an example of */ - event?: "container.transport.vessel_arrived" | "container.transport.vessel_discharged" | "container.transport.vessel_loaded" | "container.transport.vessel_departed" | "container.transport.rail_departed" | "container.transport.rail_arrived" | "container.transport.rail_loaded" | "container.transport.rail_unloaded" | "container.transport.transshipment_arrived" | "container.transport.transshipment_discharged" | "container.transport.transshipment_loaded" | "container.transport.transshipment_departed" | "container.transport.feeder_arrived" | "container.transport.feeder_discharged" | "container.transport.feeder_loaded" | "container.transport.feeder_departed" | "container.transport.empty_out" | "container.transport.full_in" | "container.transport.full_out" | "container.transport.empty_in" | "container.transport.vessel_berthed" | "shipment.estimated.arrival" | "tracking_request.succeeded" | "tracking_request.failed" | "tracking_request.awaiting_manifest" | "tracking_request.tracking_stopped" | "container.created" | "container.updated" | "container.pod_terminal_changed" | "container.transport.arrived_at_inland_destination" | "container.transport.estimated.arrived_at_inland_destination" | "container.pickup_lfd.changed" | "container.pickup_lfd_line.changed" | "container.transport.available"; + content?: never; }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { + /** @description Unprocessable Entity */ + 422: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["webhook_notification"][]; - links?: components["schemas"]["links"]; - meta?: components["schemas"]["meta"]; - included?: (components["schemas"]["webhook"] | components["schemas"]["tracking_request"] | components["schemas"]["transport_event"] | components["schemas"]["estimated_event"])[]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "get-webhooks-ips": { + "delete-containers-party-roles-id": { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description Container ID */ + container_id: string; + /** @description Party role ID */ + id: string; + }; cookie?: never; }; requestBody?: never; responses: { - /** @description OK */ - 200: { + /** @description No Content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unauthorized. Also returned when the record belongs to another account. */ + 401: { headers: { [name: string]: unknown; }; content: { "application/json": { - webhook_notification_ips?: string[]; - /** Format: date-time */ - last_updated?: string; + errors?: components["schemas"]["error"][]; }; }; }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "get-containers": { + "get-parties-id": { parameters: { - query?: { - "page[number]"?: number; - "page[size]"?: number; - /** @description Comma delimited list of relations to include */ - include?: string; - /** @description Number of seconds in which containers were refreshed */ - terminal_checked_before?: number; - }; + query?: never; header?: never; - path?: never; + path: { + id: string; + }; cookie?: never; }; requestBody?: never; @@ -2921,20 +6212,20 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["container"][]; - included?: components["schemas"]["shipment"][]; - links?: components["schemas"]["links"]; - meta?: components["schemas"]["meta"]; + data?: components["schemas"]["party"]; + links?: components["schemas"]["link-self"]; }; }; }; }; }; - "patch-containers-id": { + "edit-party": { parameters: { query?: never; header?: never; - path?: never; + path: { + id: string; + }; cookie?: never; }; requestBody?: { @@ -2942,7 +6233,11 @@ export interface operations { "application/json": { data?: { attributes: { - ref_numbers?: string[]; + /** + * @description The name of the company + * @example COMPANY NAME + */ + company_name?: string; }; }; }; @@ -2956,74 +6251,42 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["container"]; - }; - }; - }; - }; - }; - "get-containers-id": { - parameters: { - query?: { - /** @description Comma delimited list of relations to include */ - include?: string; - }; - header?: never; - path: { - id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - data?: components["schemas"]["container"]; - included?: (components["schemas"]["shipment"] | components["schemas"]["terminal"] | components["schemas"]["transport_event"])[]; + data?: components["schemas"]["party"]; + links?: components["schemas"]["link-self"]; }; }; }; - }; - }; - "get-containers-id-raw_events": { - parameters: { - query?: never; - header?: never; - path: { - id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { + /** @description Unprocessable Entity */ + 422: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["raw_event"][]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "get-containers-id-transport_events": { + "get-documents": { parameters: { query?: { - /** @description Comma delimited list of relations to include */ + /** @description Comma-separated includes. Allowed: shipments, cargos, account, user, last_document_representation, email_submission, current_extraction (alias for last_document_representation). */ include?: string; + /** @description Sortable fields: document_type, added_by, created_at. Prefix with - for descending. */ + sort?: string; + /** @description Filter by filename (full-text match). */ + "filter[filename]"?: string; + /** @description Filter by reference token. */ + "filter[reference]"?: string; + /** @description Comma-separated document types. */ + "filter[document_types]"?: string; + "page[number]"?: number; + "page[size]"?: number; }; header?: never; - path: { - id: string; - }; + path?: never; cookie?: never; }; requestBody?: never; @@ -3035,65 +6298,115 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["transport_event"][]; - included?: (components["schemas"]["shipment"] | components["schemas"]["container"] | components["schemas"]["port"] | components["schemas"]["metro_area"] | components["schemas"]["terminal"] | components["schemas"]["rail_terminal"] | components["schemas"]["vessel"])[]; + data?: components["schemas"]["document"][]; + included?: (components["schemas"]["account"] | components["schemas"]["user"] | components["schemas"]["shipment"] | components["schemas"]["container"] | components["schemas"]["document"] | components["schemas"]["document_email_submission"] | components["schemas"]["document_representation"])[]; links?: components["schemas"]["links"]; meta?: components["schemas"]["meta"]; }; }; }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; }; }; - "get-containers-id-route": { + "post-documents": { parameters: { query?: never; header?: never; - path: { - id: string; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + data?: { + /** @enum {string} */ + type: "document"; + attributes: { + name: string; + /** @description ActiveStorage signed blob id from direct upload. */ + attached_document: string; + }; + }; + }; + }; + }; responses: { - /** @description OK */ - 200: { + /** @description Created */ + 201: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["route"]; - included?: (components["schemas"]["port"] | components["schemas"]["vessel"] | components["schemas"]["route_location"] | components["schemas"]["shipment"])[]; + data?: components["schemas"]["document"]; + included?: (components["schemas"]["account"] | components["schemas"]["user"] | components["schemas"]["shipment"] | components["schemas"]["container"] | components["schemas"]["document"] | components["schemas"]["document_email_submission"] | components["schemas"]["document_representation"])[]; + links?: components["schemas"]["link-self"]; }; }; }; - /** @description Forbidden - Routing data feature is not enabled for this account */ - 403: { + /** @description Duplicate document */ + 409: { headers: { [name: string]: unknown; }; content: { "application/json": { errors?: { - /** @example 403 */ + /** @example 409 */ status?: string; - /** @example Forbidden */ + /** @example duplicate_document */ + code?: string; + /** @example Duplicate document */ title?: string; - /** @example Routing data feature is not enabled for this account */ detail?: string; + meta?: { + /** Format: uuid */ + existing_document_id?: string; + existing_document_name?: string; + }; }[]; }; }; }; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; }; }; - "get-containers-id-map-geojson": { + "get-documents-types": { parameters: { query?: never; header?: never; - path: { - id: string; - }; + path?: never; cookie?: never; }; requestBody?: never; @@ -3105,66 +6418,32 @@ export interface operations { }; content: { "application/json": { - /** @enum {string} */ - type: "FeatureCollection"; - features: { - /** @enum {string} */ - type: "Feature"; - geometry: { - /** @enum {string} */ - type: "Point"; - /** - * @example [ - * 100.896831042, - * 13.065302386 - * ] - */ - coordinates: number[]; - } | { - /** @enum {string} */ - type: "LineString"; - /** - * @example [ - * [ - * 100.868768333, - * 13.07306 - * ], - * [ - * 100.839155, - * 13.079318333 - * ] - * ] - */ - coordinates: number[][]; - }; - properties: components["schemas"]["portFeatureProperties"] | components["schemas"]["currentVesselFeatureProperties"] | components["schemas"]["pastVesselLocationsFeatureProperties"] | components["schemas"]["estimatedFullLegFeatureProperties"] | components["schemas"]["estimatedPartialLegFeatureProperties"]; + document_types?: { + code: string; + label: string; }[]; }; }; }; - /** @description Forbidden - Routing data feature is not enabled for this account */ - 403: { + /** @description Unauthorized */ + 401: { headers: { [name: string]: unknown; }; content: { "application/json": { - errors?: { - /** @example 403 */ - status?: string; - /** @example Forbidden */ - title?: string; - /** @example Routing data feature is not enabled for this account */ - detail?: string; - }[]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "patch-containers-id-refresh": { + "get-documents-id": { parameters: { - query?: never; + query?: { + /** @description Comma-separated includes. Allowed: shipments, cargos, account, user, last_document_representation, email_submission, current_extraction (alias for last_document_representation). */ + include?: string; + }; header?: never; path: { id: string; @@ -3180,75 +6459,68 @@ export interface operations { }; content: { "application/json": { - /** @example Started refresh for Shipping line, Terminal, Rail */ - message?: string; + data?: components["schemas"]["document"]; + included?: (components["schemas"]["account"] | components["schemas"]["user"] | components["schemas"]["shipment"] | components["schemas"]["container"] | components["schemas"]["document"] | components["schemas"]["document_email_submission"] | components["schemas"]["document_representation"])[]; + links?: components["schemas"]["link-self"]; }; }; }; - /** @description Forbidden - This API endpoint is not enabled for your account. Please contact support@terminal49.com */ - 403: { + /** @description Bad Request */ + 400: { headers: { [name: string]: unknown; }; content: { "application/json": { - errors?: { - /** @example 403 */ - status?: string; - /** @example API access not enabled */ - title?: string; - /** @example This API endpoint is not enabled for your account. Please contact support@terminal49.com */ - detail?: string; - }[]; + errors?: components["schemas"]["error"][]; }; }; }; - /** @description Too Many Requests - You've hit the refresh limit. Please try again in a minute. */ - 429: { + /** @description Not Found */ + 404: { headers: { - /** @description Number of seconds to wait before making another request */ - "Retry-After"?: number; [name: string]: unknown; }; content: { "application/json": { - errors?: { - /** @example 429 */ - status?: string; - /** @example Too Many Requests */ - title?: string; - /** @example You've hit the refresh limit. Please try again in a minute. */ - detail?: string; - }[]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "get-shipping_lines": { + "delete-documents-id": { parameters: { query?: never; header?: never; - path?: never; + path: { + id: string; + }; cookie?: never; }; requestBody?: never; responses: { - /** @description OK */ - 200: { + /** @description No Content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Not Found */ + 404: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["shipping_line"][]; - links?: components["schemas"]["links"]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "get-shipping_lines-id": { + "patch-documents-id": { parameters: { query?: never; header?: never; @@ -3257,7 +6529,24 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + data?: { + /** @enum {string} */ + type: "document"; + attributes: { + /** @description Manually override the document type. */ + document_type_manual?: string; + /** @description Manually provide extracted key/value data. Set to null to clear manual values. */ + extracted_data_manual?: { + [key: string]: unknown; + } | null; + }; + }; + }; + }; + }; responses: { /** @description OK */ 200: { @@ -3266,37 +6555,26 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["shipping_line"]; + data?: components["schemas"]["document"]; + included?: (components["schemas"]["account"] | components["schemas"]["user"] | components["schemas"]["shipment"] | components["schemas"]["container"] | components["schemas"]["document"] | components["schemas"]["document_email_submission"] | components["schemas"]["document_representation"])[]; + links?: components["schemas"]["link-self"]; }; }; }; - }; - }; - "get-metro-area-id": { - parameters: { - query?: never; - header?: never; - path: { - id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { + /** @description Not Found */ + 404: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["metro_area"]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "get-port-id": { + "get-documents-id-download_url": { parameters: { query?: never; header?: never; @@ -3314,116 +6592,74 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["port"]; + /** Format: uri */ + download_url: string; }; }; }; - }; - }; - "get-vessels-id": { - parameters: { - query?: { - /** @description ISO 8601 timestamp to filter positions from. 7 days by default. */ - "show_positions[from_timestamp]"?: string; - /** @description ISO 8601 timestamp to filter positions up to. Current time by default. */ - "show_positions[to_timestamp]"?: string; - }; - header?: never; - path: { - id: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { + /** @description Not Found */ + 404: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["vessel"]; + errors?: components["schemas"]["error"][]; }; }; }; - /** @description Forbidden - Feature not enabled */ - 403: { + /** @description Unprocessable Entity */ + 422: { headers: { [name: string]: unknown; }; content: { "application/json": { - errors?: { - /** @example 403 */ - status?: string; - source?: Record | null; - /** @example Forbidden */ - title?: string; - /** @example Routing data feature is not enabled for this account */ - detail?: string; - }[]; - }; - }; - }; - }; - }; - "get-vessels-imo": { - parameters: { - query?: { - /** @description ISO 8601 timestamp to filter positions from. 7 days by default. */ - "show_positions[from_timestamp]"?: string; - /** @description ISO 8601 timestamp to filter positions up to. Current time by default. */ - "show_positions[to_timestamp]"?: string; + errors?: components["schemas"]["error"][]; + }; + }; }; + }; + }; + "post-documents-id-reextract": { + parameters: { + query?: never; header?: never; path: { - imo: string; + id: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description OK */ - 200: { + /** @description Accepted */ + 202: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["vessel"]; + /** @enum {string} */ + status: "accepted"; }; }; }; - /** @description Forbidden - Feature not enabled */ - 403: { + /** @description Not Found */ + 404: { headers: { [name: string]: unknown; }; content: { "application/json": { - errors?: { - /** @example 403 */ - status?: string; - source?: Record | null; - /** @example Forbidden */ - title?: string; - /** @example Routing data feature is not enabled for this account */ - detail?: string; - }[]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "get-vessels-id-future-positions": { + "post-documents-id-reclassify": { parameters: { - query: { - /** @description The destination port id */ - port_id: string; - /** @description The previous port id */ - previous_port_id: string; - }; + query?: never; header?: never; path: { id: string; @@ -3432,53 +6668,34 @@ export interface operations { }; requestBody?: never; responses: { - /** @description OK */ - 200: { + /** @description Accepted */ + 202: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["vessel_with_positions"]; - links?: { - /** Format: uri */ - self?: string; - }; + /** @enum {string} */ + status: "accepted"; }; }; }; - /** @description Forbidden - Routing data feature is not enabled for this account */ - 403: { + /** @description Not Found */ + 404: { headers: { [name: string]: unknown; }; content: { "application/json": { - errors?: { - /** @example 403 */ - status?: string; - /** @example Forbidden */ - title?: string; - /** @example Routing data feature is not enabled for this account */ - detail?: string; - }[]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "get-vessels-id-future-positions-with-coordinates": { + "post-documents-id-relink": { parameters: { - query: { - /** @description The destination port id */ - port_id: string; - /** @description The previous port id */ - previous_port_id: string; - /** @description Starting latitude coordinate */ - latitude: number; - /** @description Starting longitude coordinate */ - longitude: number; - }; + query?: never; header?: never; path: { id: string; @@ -3487,42 +6704,32 @@ export interface operations { }; requestBody?: never; responses: { - /** @description OK */ - 200: { + /** @description Accepted */ + 202: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["vessel_with_positions"]; - links?: { - /** Format: uri */ - self?: string; - }; + /** @enum {string} */ + status: "accepted"; }; }; }; - /** @description Forbidden - Routing data feature is not enabled for this account */ - 403: { + /** @description Not Found */ + 404: { headers: { [name: string]: unknown; }; content: { "application/json": { - errors?: { - /** @example 403 */ - status?: string; - /** @example Forbidden */ - title?: string; - /** @example Routing data feature is not enabled for this account */ - detail?: string; - }[]; + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "get-terminal-id": { + "post-documents-id-rotate": { parameters: { query?: never; header?: never; @@ -3531,24 +6738,56 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @enum {integer} */ + degrees: 90 | 180 | 270; + }; + }; + }; responses: { - /** @description OK */ - 200: { + /** @description Accepted */ + 202: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["terminal"]; + /** @enum {string} */ + status: "accepted"; + }; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; }; }; }; }; }; - "list-parties": { + "get-email_submissions": { parameters: { query?: { + /** @description Allowed: account, user, documents, documents.last_document_representation. Defaults to documents + documents.last_document_representation. */ + include?: string; "page[number]"?: number; "page[size]"?: number; }; @@ -3565,51 +6804,77 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["party"][]; + data?: components["schemas"]["email_submission"][]; + included?: (components["schemas"]["account"] | components["schemas"]["user"] | components["schemas"]["email_submission_document"] | components["schemas"]["document_representation"])[]; links?: components["schemas"]["links"]; meta?: components["schemas"]["meta"]; }; }; }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; }; }; - "post-party": { + "get-email_submissions-id": { parameters: { - query?: never; + query?: { + /** @description Allowed: account, user, documents, documents.last_document_representation. Defaults to documents + documents.last_document_representation. */ + include?: string; + }; header?: never; - path?: never; + path: { + id: string; + }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - data?: { - attributes: { - /** - * @description The name of the company - * @example COMPANY NAME - */ - company_name?: string; - }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data?: components["schemas"]["email_submission"]; + included?: (components["schemas"]["account"] | components["schemas"]["user"] | components["schemas"]["email_submission_document"] | components["schemas"]["document_representation"])[]; + links?: components["schemas"]["link-self"]; }; }; }; - }; - responses: { - /** @description Party Created */ - 201: { + /** @description Bad Request */ + 400: { headers: { [name: string]: unknown; }; content: { "application/json": { - data?: components["schemas"]["party"]; - links?: components["schemas"]["link-self"]; + errors?: components["schemas"]["error"][]; }; }; }; - /** @description Unprocessable Entity */ - 422: { + /** @description Not Found */ + 404: { headers: { [name: string]: unknown; }; @@ -3621,11 +6886,12 @@ export interface operations { }; }; }; - "get-parties-id": { + "get-document_schemas-id": { parameters: { query?: never; header?: never; path: { + /** @description Schema id in full-version format, e.g. commercial_invoice@2026-03-23. */ id: string; }; cookie?: never; @@ -3639,52 +6905,174 @@ export interface operations { }; content: { "application/json": { - data?: components["schemas"]["party"]; + data?: components["schemas"]["document_schema"]; links?: components["schemas"]["link-self"]; }; }; }; + /** @description Unauthorized */ + 401: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errors?: components["schemas"]["error"][]; + }; + }; + }; }; }; - "edit-party": { + searchAll: { parameters: { - query?: never; - header?: never; - path: { - id: string; + query: { + /** @description Search term to match against BL numbers, container numbers, reference numbers, and other indexed fields. Supports full-text search and partial (ILIKE) matching. */ + query: string; }; + header?: never; + path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - data?: { - attributes: { + requestBody?: never; + responses: { + /** @description Successful search results */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + /** + * @example { + * "data": [ + * { + * "id": "abc12345-6789-40ef-9012-3456789abcde", + * "type": "shipment", + * "attributes": { + * "entity_type": "shipment", + * "number": "MEDUA1234567", + * "shipment_id": null, + * "scac": "MSCU", + * "port_of_lading_name": "Shanghai", + * "port_of_discharge_name": "Los Angeles", + * "containers_count": 3, + * "tracking_stopped": false, + * "tracking_stopped_reason": null, + * "status": null, + * "failed_reason": null, + * "ref_numbers": [ + * "PO-2026-001" + * ], + * "created_at": "2026-01-15T10:30:00.000Z", + * "updated_at": "2026-03-01T14:22:00.000Z" + * } + * }, + * { + * "id": "def45678-9012-43ab-9cde-f0123456789a", + * "type": "cargo", + * "attributes": { + * "entity_type": "cargo", + * "number": "MSCU1234567", + * "shipment_id": "abc12345-6789-40ef-9012-3456789abcde", + * "scac": "MSCU", + * "port_of_lading_name": null, + * "port_of_discharge_name": null, + * "containers_count": null, + * "tracking_stopped": null, + * "tracking_stopped_reason": null, + * "status": null, + * "failed_reason": null, + * "ref_numbers": [], + * "created_at": "2026-01-15T10:30:00.000Z", + * "updated_at": "2026-03-01T14:22:00.000Z" + * } + * } + * ] + * } + */ + "application/json": { + data?: { + /** @description Unique identifier of the matched resource */ + id?: string; /** - * @description The name of the company - * @example COMPANY NAME + * @description Resource type + * @enum {string} */ - company_name?: string; - }; + type?: "shipment" | "cargo" | "tracking_request"; + attributes?: { + /** @description Type of the matched entity: `shipment`, `cargo`, or `tracking_request` */ + entity_type?: string; + /** @description BL number (shipments), container number (cargos), or request number (tracking requests) */ + number?: string; + /** @description Associated shipment ID (for cargos and tracking requests only) */ + shipment_id?: string | null; + /** @description Standard Carrier Alpha Code of the shipping line */ + scac?: string | null; + /** @description Port of lading name (shipments only) */ + port_of_lading_name?: string | null; + /** @description Port of discharge name (shipments only) */ + port_of_discharge_name?: string | null; + /** @description Number of containers on the shipment (shipments only) */ + containers_count?: number | null; + /** @description Whether tracking has been stopped (shipments only) */ + tracking_stopped?: boolean | null; + /** @description Reason tracking was stopped (shipments only) */ + tracking_stopped_reason?: string | null; + /** @description Tracking request status (tracking requests only) */ + status?: string | null; + /** @description Reason the tracking request failed (tracking requests only) */ + failed_reason?: string | null; + /** @description Customer reference numbers */ + ref_numbers?: string[]; + /** + * Format: date-time + * @description When the resource was created + */ + created_at?: string; + /** + * Format: date-time + * @description When the resource was last updated + */ + updated_at?: string; + }; + }[]; }; }; }; - }; - responses: { - /** @description OK */ - 200: { + /** @description Bad request — missing required `query` parameter */ + 400: { headers: { [name: string]: unknown; }; content: { + /** + * @example { + * "errors": [ + * { + * "detail": "Query parameter is required" + * } + * ] + * } + */ "application/json": { - data?: components["schemas"]["party"]; - links?: components["schemas"]["link-self"]; + errors?: { + detail?: string; + }[]; }; }; }; - /** @description Unprocessable Entity */ - 422: { + /** @description Unauthorized — missing or invalid API token */ + 401: { headers: { [name: string]: unknown; }; diff --git a/skills/agent-trust/SKILL.md b/skills/agent-trust/SKILL.md new file mode 100644 index 00000000..96d4e5a6 --- /dev/null +++ b/skills/agent-trust/SKILL.md @@ -0,0 +1,43 @@ +--- +name: terminal49-agent-trust +description: Use when adding or changing API/OpenAPI endpoints, npm packages, MCP tools, SDK entrypoints, or their docs in the Terminal49/API repository. +--- + +# Terminal49 agent trust + +Extend this repository through one paved path and prove the change with the +same command CI runs. + +## Before editing + +1. Read [the paved path](references/paved-path.md) for the surface you are + changing. +2. Read [the feature map](feature-map.json) to confirm the registered MCP + tools, SDK exports, and docs routes, and to find an existing tool's source. +3. Keep generated files generated. Change `docs/openapi.json` before SDK types, + Postman, or SDK reference output. + +## Verification + +Run: + +```bash +npm run agent-verify +``` + +Use `npm run agent-verify:quick` only while iterating. The full command is the +completion gate and must pass before a code change is handed off. + +The verifier checks: + +- feature-map, toolchain-pin, and root-config ownership rules +- Vite+ format/lint and authoritative TypeScript checks +- SDK, MCP, and CLI builds and tests +- OpenAPI-to-SDK type generation drift +- an offline MCP initialize plus `tools/list` protocol smoke + +## P-Stack + +Follow [the repository P-Stack wiring](references/pstack.md) for non-trivial +investigation, implementation, verification, and lesson encoding. Model choices +and reasoning budget are user-local; never commit a teammate's model slugs. diff --git a/skills/agent-trust/feature-map.json b/skills/agent-trust/feature-map.json new file mode 100644 index 00000000..24145da3 --- /dev/null +++ b/skills/agent-trust/feature-map.json @@ -0,0 +1,72 @@ +{ + "updateNote": "Update this file in the same commit that adds, removes, or renames an MCP tool, SDK package export, or non-generated SDK/MCP docs route.", + "mcpTools": [ + { + "name": "search_container", + "implementation": "packages/mcp/src/tools/search-container.ts" + }, + { + "name": "track_container", + "implementation": "packages/mcp/src/tools/track-container.ts" + }, + { + "name": "get_container", + "implementation": "packages/mcp/src/tools/get-container.ts" + }, + { + "name": "get_shipment_details", + "implementation": "packages/mcp/src/tools/get-shipment-details.ts" + }, + { + "name": "get_container_transport_events", + "implementation": "packages/mcp/src/tools/get-container-transport-events.ts" + }, + { + "name": "get_supported_shipping_lines", + "implementation": "packages/mcp/src/tools/get-supported-shipping-lines.ts" + }, + { + "name": "get_container_route", + "implementation": "packages/mcp/src/tools/get-container-route.ts" + }, + { + "name": "list_shipments", + "implementation": "packages/mcp/src/tools/list-shipments.ts" + }, + { + "name": "list_containers", + "implementation": "packages/mcp/src/tools/list-containers.ts" + }, + { + "name": "list_tracking_requests", + "implementation": "packages/mcp/src/tools/list-tracking-requests.ts" + } + ], + "sdkEntrypoints": [ + { + "export": ".", + "source": "sdks/typescript-sdk/src/index.ts" + }, + { + "export": "./client", + "source": "sdks/typescript-sdk/src/client.ts" + } + ], + "docsRoutes": [ + "api-docs/in-depth-guides/mcp", + "mcp/home", + "mcp/setup/agent-plugins", + "mcp/setup/chatgpt", + "mcp/setup/claude", + "mcp/setup/claude-code", + "mcp/setup/cursor", + "mcp/setup/microsoft-copilot", + "mcp/setup/other-clients", + "mcp/setup/vs-code", + "sdk/error-handling", + "sdk/filtering-pagination", + "sdk/introduction", + "sdk/methods", + "sdk/quickstart" + ] +} diff --git a/skills/agent-trust/references/paved-path.md b/skills/agent-trust/references/paved-path.md new file mode 100644 index 00000000..34dafa27 --- /dev/null +++ b/skills/agent-trust/references/paved-path.md @@ -0,0 +1,49 @@ +# Paved extension path + +Use these sequences. Do not create a second registration, build, test, or +generation path. + +## Add or change an OpenAPI endpoint + +1. Edit `docs/openapi.json`, the API contract source of truth. +2. Run `npm run generate:types --workspace @terminal49/sdk`. + Commit the updated `src/generated/terminal49.ts`. +3. Add or update the SDK manager method and fixture-backed tests. +4. Update the relevant non-generated docs page. Regenerate SDK reference docs + only through `npm run sdk:docs`. +5. Update `feature-map.json` only when a public SDK package export or docs route + changes. +6. Run `npm run agent-verify`. + +## Add a package + +1. Place it under `packages/*` or `sdks/*`. +2. Provide `build`, `type-check`, `test`, `lint`, and `format` scripts using the + shared Vite+ stack. Keep lint and format configuration at the repository + root; package-level Vitest configuration is allowed. +3. Add workspace dependencies normally so npm and Vite+ can see the dependency + graph. If generated declarations are required, preserve explicit build + ordering in the root task. +4. Update the root lockfile only. A standalone lockfile is allowed solely for a + package whose consumer-compatibility CI installs it outside the workspace. +5. Add the package to CI and run `npm run agent-verify`. + +## Add an MCP tool + +1. Add one executor in `packages/mcp/src/tools/.ts`. +2. Register its name, schemas, annotations, and handler once in + `packages/mcp/src/server.ts`. +3. Add behavior and contract coverage in + `packages/mcp/src/tools/contracts.test.ts`; these tests call executors + directly. Use `npm run test:protocol --workspace @terminal49/mcp` for + transport-level behavior. +4. Add the tool to `skills/agent-trust/feature-map.json`. +5. Update MCP docs when the public capability or recommended chaining changes. +6. Run `npm run agent-verify`; the final protocol step must report the updated + tool count. + +## Update the map + +Change `skills/agent-trust/feature-map.json` in the same commit as an MCP tool, +SDK package export, or non-generated SDK/MCP navigation route. The verifier +rejects drift in either direction. diff --git a/skills/agent-trust/references/pstack.md b/skills/agent-trust/references/pstack.md new file mode 100644 index 00000000..94af0356 --- /dev/null +++ b/skills/agent-trust/references/pstack.md @@ -0,0 +1,22 @@ +# P-Stack wiring + +P-Stack is a Cursor plugin, not a repository dependency. Install it in Cursor: + +```text +/add-plugin pstack +``` + +Then run `/setup-pstack`. Choose the reasoning budget and models available to +your account. That command writes `~/.cursor/rules/pstack-models.mdc`; the file +is user-local and must not be committed. + +Use the stack this way: + +- `/poteto-mode` for a non-trivial feature, refactor, bug, or multi-phase task +- `/how` before changing an unfamiliar subsystem +- the repository's `npm run agent-verify` as the executable proof step +- `/reflect` after a costly task; encode accepted lessons in a guard, test, + feature-map check, or verifier step instead of adding advisory prose + +The repository does not pin model slugs. Re-run `/setup-pstack` to change the +budget or per-role model selection without changing the codebase.