{"item":[{"id":"bcac1c1a-2160-4acb-8278-ffef8598c4a8","name":"air-airlines","description":{"content":"This section provides a comprehensive set of endpoints for airlines.\n","type":"text/plain"},"item":[{"id":"88a740b1-9c33-44e3-a46e-3ddb195fbba5","name":"AIR - List of Airlines","request":{"name":"AIR - List of Airlines","description":{"content":"The shipments list endpoint allows you to retrieve a list of airlines. This includes options to apply various\nfilters and sorting.\n\n**Example #1:** To filter the trackable airlines.\n\n```plain\n/air/airlines?filters[status]=eq:ACTIVE\n```\n\n**Example #2:** To filter airlines that contain `ARABIA` in their name.\n\n```plain\n/air/airlines?filters[name]=contains:ARABIA\n```\n","type":"text/plain"},"url":{"path":["air","airlines"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"order_by","value":"<string>"},{"disabled":false,"key":"skip","value":"<integer>"},{"disabled":false,"key":"take","value":"<integer>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"69523a3f-d94b-44c0-b580-85ce1220e0fe","name":"List of airlines have been successfully retrieved.","originalRequest":{"url":{"path":["air","airlines"],"host":["{{baseUrl}}"],"query":[{"key":"order_by","value":"<string>"},{"key":"skip","value":"<integer>"},{"key":"take","value":"<integer>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"string\",\n  \"airlines\": [\n    {\n      \"iata\": \"string\",\n      \"name\": \"string\",\n      \"status\": \"ACTIVE\",\n      \"prefixes\": [\n        \"string\",\n        \"string\"\n      ]\n    },\n    {\n      \"iata\": \"string\",\n      \"name\": \"string\",\n      \"status\": \"PASSIVE\",\n      \"prefixes\": [\n        \"string\",\n        \"string\"\n      ]\n    }\n  ],\n  \"meta\": {\n    \"more\": false,\n    \"total\": 6835\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"76757df5-bb1e-4bf6-8652-1cb397ee7693","name":"air-shipments","description":{"content":"This section provides a comprehensive set of endpoints to manage your air shipments.\n\n### How It Works\n\nFirst, you need to create the shipment, and after that, we will periodically check the shipment status and other\nrelevant details. Our system will automatically track the shipment's progress and any changes, ensuring everything stays\nupdated. You will be notified with updates and changes as needed, ensuring timely and accurate information about your\nshipment. You can also check your shipment details at any time, or use webhooks to receive real-time updates.\n","type":"text/plain"},"item":[{"id":"8e2597c2-a36e-4c28-9ff0-3cc213c9da5c","name":"AIR - Create a Shipment","request":{"name":"AIR - Create a Shipment","description":{"content":"This endpoint allows you to create a new shipment by providing the necessary shipment details. Once\nthe shipment is successfully created, you need to save the given shipment identifier in your internal system\nto use it across the related endpoints.\n\n### Duplicate Shipments\n\nIf there is an another shipment with the same `reference` and `awb_number`, the shipment will not be created\n(there is no cost), and the system will return a response (`409` - `ALREADY_EXISTS`) indicating details of the\nexisting shipment. If you don't provide a `reference` field on your request, the system will only check with\nthe `awb_number`.\n\n**Note:** If you want to add a follower or tag to the existing shipment, you must make new request(s)\nto related endpoints using the existing shipment's `id`.\n\n### Concurrent Requests\n\nWe process creation requests one by one for your company to prevent race conditions, such as misusing your credits\nor creating unnecessary duplicate shipments. You don't need to take any action, this process is handled entirely by\nShipsgo system. However, sending too many concurrent requests can result in longer wait times and errors\n(`429` - `TOO_MANY_CONCURRENT_REQUESTS`). If you plan to create a large number of shipments at once, ensure that\nrequests are sent synchronously.\n","type":"text/plain"},"url":{"path":["air","shipments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]},"body":{"mode":"raw","raw":"{\n  \"awb_number\": \"<string>\",\n  \"reference\": \"<string>\",\n  \"followers\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"tags\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"1a543010-33b9-432f-9b6d-ab52a234d4df","name":"Shipment successfully created & tracking process has been started.","originalRequest":{"url":{"path":["air","shipments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"awb_number\": \"333-88888888\",\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n  \"followers\": [\n    \"customer-1@example.com\",\n    \"customer-2@example.com\"\n  ],\n  \"tags\": [\n    \"IMPORT\",\n    \"CUSTOMER_ABC\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"disabled":false,"description":"The amount of credit consumption for the operation.","key":"X-Shipsgo-Credits-Cost","value":"1"},{"disabled":false,"description":"The amount of credit remaining after the operation.","key":"X-Shipsgo-Credits-Remaining","value":"999"},{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"shipment\": {\n    \"id\": 123456,\n    \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n    \"awb_number\": \"333-88888888\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"51407e6e-09f8-4899-90c5-7d3f6e601ffb","name":"Company does not have enought credits to create a shipment.","originalRequest":{"url":{"path":["air","shipments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"awb_number\": \"333-88888888\",\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n  \"followers\": [\n    \"customer-1@example.com\",\n    \"customer-2@example.com\"\n  ],\n  \"tags\": [\n    \"IMPORT\",\n    \"CUSTOMER_ABC\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"status":"Payment Required","code":402,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"NOT_ENOUGH_CREDITS\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3383483c-e6c2-4867-a6ff-8da07d94cd2a","name":"Shipment has already been created.","originalRequest":{"url":{"path":["air","shipments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"awb_number\": \"333-88888888\",\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n  \"followers\": [\n    \"customer-1@example.com\",\n    \"customer-2@example.com\"\n  ],\n  \"tags\": [\n    \"IMPORT\",\n    \"CUSTOMER_ABC\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"disabled":false,"description":"The amount of credit consumption for the operation.","key":"X-Shipsgo-Credits-Cost","value":"0"},{"disabled":false,"description":"The amount of credit remaining after the operation.","key":"X-Shipsgo-Credits-Remaining","value":"1000"},{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"ALREADY_EXISTS\",\n  \"shipment\": {\n    \"id\": 123456,\n    \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n    \"awb_number\": \"333-88888888\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"fc3ebf33-ecc5-43bb-acc7-6c2b9f5ce21c","name":"AIR - List of Shipments","request":{"name":"AIR - List of Shipments","description":{"content":"The shipments list endpoint allows you to retrieve a list of your shipments (**basic information**). This includes\noptions to apply various filters and sorting. To access detailed information (`status_extended`, `movements`,\n`followers`, etc.) about a shipment, you should use the **AIR - Details of the Shipment** endpoint.\n\n**Example #1:** **Ongoing** (`EN_ROUTE`) shipments carried by **TURKISH CARGO** (`TK`) or **LUFTHANSA CARGO** (`LH`)\nwith upcoming arrivals in order.\n\n```plain\n/air/shipments\n  ?filters[status]=eq:EN_ROUTE\n  &filters[airline]=in:TK,LH\n  &order_by=date_of_rcf,asc\n```\n\n**Example #2:** Shipments that were shipped to **India** (`IN`), between **September 1, 2024**, and\n**October 1, 2024** in order.\n\n```plain\n/air/shipments\n  ?filters[destination_country]=eq:IN\n  &filters[date_of_dep]=between:2024-09-01...2024-10-01\n  &order_by=date_of_dep,asc\n```\n\n**Example #3:** Shipments tagged with `COMPANY_ABC` and created by **John Doe** (`john-doe@example.com`).\n\n```plain\n/air/shipments\n  ?filters[tags]=with:COMPANY_ABC\n  &filters[creator]=eq:john-doe@example.com\n```\n","type":"text/plain"},"url":{"path":["air","shipments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"order_by","value":"<string>"},{"disabled":false,"key":"skip","value":"<integer>"},{"disabled":false,"key":"take","value":"<integer>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"887d45ac-f663-4a9c-a30a-1890e551cf76","name":"List of shipments have been successfully retrieved.","originalRequest":{"url":{"path":["air","shipments"],"host":["{{baseUrl}}"],"query":[{"key":"order_by","value":"<string>"},{"key":"skip","value":"<integer>"},{"key":"take","value":"<integer>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"shipments\": [\n    {\n      \"id\": 1323,\n      \"reference\": null,\n      \"awb_number\": \"string\",\n      \"airline\": {\n        \"iata\": \"string\",\n        \"name\": \"string\"\n      },\n      \"cargo\": {\n        \"pieces\": 3787,\n        \"weight\": null,\n        \"volume\": null\n      },\n      \"status\": \"NEW\",\n      \"status_split\": true,\n      \"route\": {\n        \"origin\": {\n          \"location\": {\n            \"name\": \"string\",\n            \"iata\": \"string\",\n            \"timezone\": \"string\",\n            \"country\": {\n              \"code\": \"string\",\n              \"name\": \"string\"\n            }\n          },\n          \"date_of_dep\": \"string\",\n          \"date_of_dep_initial\": \"string\"\n        },\n        \"ts_count\": 5797,\n        \"destination\": {\n          \"location\": {\n            \"name\": \"string\",\n            \"iata\": \"string\",\n            \"timezone\": \"string\",\n            \"country\": {\n              \"code\": \"string\",\n              \"name\": \"string\"\n            }\n          },\n          \"date_of_rcf\": \"string\",\n          \"date_of_rcf_initial\": \"string\"\n        },\n        \"transit_time\": 2509,\n        \"transit_percentage\": 5023\n      },\n      \"tags\": [\n        {\n          \"id\": 1001,\n          \"name\": \"IMPORT\"\n        },\n        {\n          \"id\": 1001,\n          \"name\": \"IMPORT\"\n        }\n      ],\n      \"creator\": {\n        \"name\": \"string\",\n        \"email\": \"string\"\n      },\n      \"created_at\": \"string\",\n      \"updated_at\": \"string\",\n      \"checked_at\": null,\n      \"discarded_at\": null\n    },\n    {\n      \"id\": 6643,\n      \"reference\": \"string\",\n      \"awb_number\": \"string\",\n      \"airline\": {\n        \"iata\": \"string\",\n        \"name\": \"string\"\n      },\n      \"cargo\": {\n        \"pieces\": 4516,\n        \"weight\": 5361.0650292702885,\n        \"volume\": 7927.2148631553455\n      },\n      \"status\": \"DELIVERED\",\n      \"status_split\": false,\n      \"route\": {\n        \"origin\": {\n          \"location\": {\n            \"name\": \"string\",\n            \"iata\": \"string\",\n            \"timezone\": \"string\",\n            \"country\": {\n              \"code\": \"string\",\n              \"name\": \"string\"\n            }\n          },\n          \"date_of_dep\": \"string\",\n          \"date_of_dep_initial\": \"string\"\n        },\n        \"ts_count\": 972,\n        \"destination\": {\n          \"location\": {\n            \"name\": \"string\",\n            \"iata\": \"string\",\n            \"timezone\": \"string\",\n            \"country\": {\n              \"code\": \"string\",\n              \"name\": \"string\"\n            }\n          },\n          \"date_of_rcf\": \"string\",\n          \"date_of_rcf_initial\": \"string\"\n        },\n        \"transit_time\": 1978,\n        \"transit_percentage\": 6770\n      },\n      \"tags\": [\n        {\n          \"id\": 1001,\n          \"name\": \"IMPORT\"\n        },\n        {\n          \"id\": 1001,\n          \"name\": \"IMPORT\"\n        }\n      ],\n      \"creator\": {\n        \"name\": \"string\",\n        \"email\": \"string\"\n      },\n      \"created_at\": \"string\",\n      \"updated_at\": \"string\",\n      \"checked_at\": null,\n      \"discarded_at\": null\n    }\n  ],\n  \"meta\": {\n    \"more\": true,\n    \"total\": null\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a22bd5d1-fa99-415c-8882-32adf1522586","name":"AIR - Details of the Shipment","request":{"name":"AIR - Details of the Shipment","description":{"content":"This endpoint retrieves the details of an existing air shipment. It returns comprehensive information\nabout the shipment. This allows users to track and monitor the shipment's progress and status in real-time.\n","type":"text/plain"},"url":{"path":["air","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"0c7fc61a-daef-404b-8192-4006104ed2b3","name":"Details of the shipment have been successfully retrieved.","originalRequest":{"url":{"path":["air","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"shipment\": {\n    \"id\": 123456,\n    \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n    \"awb_number\": \"403-88888888\",\n    \"airline\": {\n      \"iata\": \"PO\",\n      \"name\": \"POLAR AIR CARGO\"\n    },\n    \"cargo\": {\n      \"pieces\": null,\n      \"weight\": null,\n      \"volume\": null\n    },\n    \"status\": \"INPROGRESS\",\n    \"status_split\": false,\n    \"status_extended\": {},\n    \"route\": null,\n    \"movements\": [],\n    \"tokens\": {},\n    \"followers\": [\n      {\n        \"id\": 1001,\n        \"email\": \"customer-1@example.com\"\n      },\n      {\n        \"id\": 1002,\n        \"email\": \"customer-2@example.com\"\n      }\n    ],\n    \"tags\": [\n      {\n        \"id\": 1001,\n        \"name\": \"IMPORT\"\n      },\n      {\n        \"id\": 1002,\n        \"name\": \"CUSTOMER_ABC\"\n      }\n    ],\n    \"creator\": {\n      \"name\": \"John Doe\",\n      \"email\": \"john-doe@example.com\"\n    },\n    \"created_at\": \"2020-01-31 12:00:00\",\n    \"updated_at\": \"2020-01-31 12:00:00\",\n    \"checked_at\": \"2020-01-31 12:00:00\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"99fe0da7-cfce-46d9-ad0c-96bb0c391510","name":"AIR - Update the Shipment","request":{"name":"AIR - Update the Shipment","description":{"content":"This endpoint allows users to update the fields of an existing air shipment.\n","type":"text/plain"},"url":{"path":["air","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]},"body":{"mode":"raw","raw":"{\n  \"reference\": \"<string>\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"755e63de-80d7-4c69-8ea3-e32c5e4e43ef","name":"Shipment successfully updated.","originalRequest":{"url":{"path":["air","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"shipment\": {\n    \"id\": 123456,\n    \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n    \"awb_number\": \"333-88888888\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"3437b7a1-9380-454c-94cc-85e32835764a","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["air","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"a8f9ab16-9621-4c50-915e-37a8093c155f","name":"AIR - Delete the Shipment","request":{"name":"AIR - Delete the Shipment","description":{"content":"This endpoint allows users to delete an existing air shipment.\n","type":"text/plain"},"url":{"path":["air","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"338a241c-b059-4214-9dce-b627357e4978","name":"Shipment successfully deleted.","originalRequest":{"url":{"path":["air","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"9ad97495-675b-4ff2-8549-41d54d9d2765","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["air","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"4d9a0862-6138-4112-987f-78164aaf884e","name":"AIR - Route of the Shipment","request":{"name":"AIR - Route of the Shipment","description":{"content":"This endpoint provides a GeoJSON FeatureCollection with all map-related data for a shipment, including airport\nlocations, the aircraft’s current position, and past/future paths.\n\nGeoJSON ([RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946)) is a format used to describe geographic data and can\nbe directly used with most mapping libraries (Leaflet, Mapbox, Google Maps, etc.).\n\nIn this endpoint, only `Point` and `LineString` geometry types are used. Each geometry is returned within a Feature as\ndefined below:\n\n-   Each Feature has a `geometry` (`Point` or `LineString`).\n-   Each Feature has a set of `properties` according to its `geometry`.\n-   Each Feature has a `status` property, which can be:\n    -   `PAST` – The shipment was at this airport/route in the past.\n    -   `CURRENT` – The shipment is at this airport/route now.\n    -   `FUTURE` – The shipment is expected to be at this airport/route in the future.\n\n#### Point Features\n\nFeatures with `Point` geometry represent airports. Each `Point` Feature includes the airport’s name, IATA code,\ntimezone, and country information.\n\n#### LineString Features\n\nFeatures with `LineString` geometry represent routes between two locations. Each `LineString` Feature includes cargo\ninformation, flight number, related events (`DEP`, `ARR`), and current position (when `status` is `CURRENT`).\n","type":"text/plain"},"url":{"path":["air","shipments",":shipment_id","geojson"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"0477b1e2-abb6-47ec-ada9-3499d3d06f19","name":"Route of the shipment have been successfully retrieved.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","geojson"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"geojson\": {\n    \"type\": \"FeatureCollection\",\n    \"features\": [\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"Point\",\n          \"coordinates\": [\n            136.80541,\n            34.85841\n          ]\n        },\n        \"properties\": {\n          \"status\": \"PAST\",\n          \"location\": {\n            \"iata\": \"NGO\",\n            \"name\": \"Chūbu Centrair International Airport\",\n            \"timezone\": \"Asia/Tokyo\",\n            \"country\": {\n              \"code\": \"JP\",\n              \"name\": \"Japan\"\n            }\n          }\n        }\n      },\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"LineString\",\n          \"coordinates\": [\n            [\n              136.80541,\n              34.85841\n            ],\n            [\n              138.988092,\n              37.692851\n            ],\n            [\n              141.342989,\n              40.483881\n            ],\n            [\n              143.900336,\n              43.222996\n            ],\n            [\n              146.695528,\n              45.899829\n            ],\n            [\n              149.769802,\n              48.501676\n            ],\n            [\n              153.170706,\n              51.012907\n            ],\n            [\n              156.952001,\n              53.414283\n            ],\n            [\n              161.172437,\n              55.682201\n            ],\n            [\n              165.892513,\n              57.787969\n            ],\n            [\n              171.168011,\n              59.697319\n            ],\n            [\n              177.039058,\n              61.370532\n            ],\n            [\n              183.514299,\n              62.763716\n            ],\n            [\n              190.552205,\n              63.831834\n            ],\n            [\n              198.045727,\n              64.533749\n            ],\n            [\n              205.820096,\n              64.838662\n            ],\n            [\n              213.651807,\n              64.732145\n            ],\n            [\n              221.306724,\n              64.219314\n            ],\n            [\n              228.582741,\n              63.32368\n            ],\n            [\n              235.339128,\n              62.082214\n            ],\n            [\n              241.504015,\n              60.53881\n            ],\n            [\n              247.064103,\n              58.73842\n            ],\n            [\n              252.046535,\n              56.723034\n            ],\n            [\n              256.501196,\n              54.529631\n            ],\n            [\n              260.487362,\n              52.189565\n            ],\n            [\n              264.065201,\n              49.72882\n            ],\n            [\n              267.29114,\n              47.168649\n            ],\n            [\n              270.215796,\n              44.526335\n            ],\n            [\n              272.883428,\n              41.81592\n            ],\n            [\n              275.332178,\n              39.048836\n            ]\n          ]\n        },\n        \"properties\": {\n          \"status\": \"CURRENT\",\n          \"cargo\": {\n            \"pieces\": 50,\n            \"weight\": 480,\n            \"volume\": 1.44\n          },\n          \"flight\": \"KJ65\",\n          \"events\": {\n            \"DEP\": {\n              \"location\": {\n                \"iata\": \"NGO\",\n                \"name\": \"Chūbu Centrair International Airport\",\n                \"timezone\": \"Asia/Tokyo\",\n                \"country\": {\n                  \"code\": \"JP\",\n                  \"name\": \"Japan\"\n                }\n              },\n              \"timestamp\": \"2025-12-08T00:23:10+09:00\"\n            },\n            \"ARR\": {\n              \"location\": {\n                \"iata\": \"CVG\",\n                \"name\": \"Cincinnati/Northern Kentucky International Airport\",\n                \"timezone\": \"America/New_York\",\n                \"country\": {\n                  \"code\": \"US\",\n                  \"name\": \"United States (USA)\"\n                }\n              },\n              \"timestamp\": \"2025-12-07T13:44:10-05:00\"\n            }\n          },\n          \"current\": {\n            \"index\": 1,\n            \"coordinates\": [\n              138.988092,\n              37.692851\n            ]\n          }\n        }\n      },\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"Point\",\n          \"coordinates\": [\n            -84.667822,\n            39.048836\n          ]\n        },\n        \"properties\": {\n          \"status\": \"FUTURE\",\n          \"location\": {\n            \"iata\": \"CVG\",\n            \"name\": \"Cincinnati/Northern Kentucky International Airport\",\n            \"timezone\": \"America/New_York\",\n            \"country\": {\n              \"code\": \"US\",\n              \"name\": \"United States (USA)\"\n            }\n          }\n        }\n      }\n    ]\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"efa02df2-1919-49da-b2e4-e191505fe5d8","name":"AIR - Add Follower to the Shipment","request":{"name":"AIR - Add Follower to the Shipment","description":{"content":"This endpoint allows users to add a new follower to an existing air shipment.","type":"text/plain"},"url":{"path":["air","shipments",":shipment_id","followers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]},"body":{"mode":"raw","raw":"{\n  \"follower\": \"<string>\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"20911273-a467-4598-9ac8-aa654fe96839","name":"Follower successfully added to the shipment.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","followers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"follower\": \"customer-1@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"follower\": {\n    \"id\": 1001,\n    \"email\": \"customer-1@example.com\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"7a5dfa65-a409-4979-8763-7f4ee95c618e","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","followers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"follower\": \"customer-1@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"b12e681a-3c36-47e2-9332-7c1cbcd654ec","name":"Follower has already been added.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","followers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"follower\": \"customer-1@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"ALREADY_EXISTS\",\n  \"follower\": {\n    \"id\": 1001,\n    \"email\": \"customer-1@example.com\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"1a4f40cd-8263-4118-a922-d0bf1d3eb885","name":"AIR - Remove Follower from the Shipment","request":{"name":"AIR - Remove Follower from the Shipment","description":{"content":"This endpoint allows users to remove an existing follower from an existing air shipment.","type":"text/plain"},"url":{"path":["air","shipments",":shipment_id","followers",":follower_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"follower_id","description":"(Required) The unique identifier of the follower."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"f99c2e50-b787-4285-9e44-95c9dfc12727","name":"Follower successfully removed from the shipment.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","followers",":follower_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"follower_id","description":"(Required) The unique identifier of the follower."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"4988914e-b715-4818-a75c-6a6bd5e35a3e","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","followers",":follower_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"follower_id","description":"(Required) The unique identifier of the follower."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"747b332c-cc8d-4a4b-b3ea-a8225566172b","name":"AIR - Add Tag to the Shipment","request":{"name":"AIR - Add Tag to the Shipment","description":{"content":"This endpoint allows users to add a tag to an existing air shipment.","type":"text/plain"},"url":{"path":["air","shipments",":shipment_id","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]},"body":{"mode":"raw","raw":"{\n  \"tag\": \"<string>\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"245ee9b9-f911-4efc-b73f-a89e7914e001","name":"Tag successfully added to the shipment.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"tag\": \"IMPORT\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"tag\": {\n    \"id\": 1001,\n    \"name\": \"IMPORT\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"03d05d33-991c-4648-8237-7d7f336caa9e","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"tag\": \"IMPORT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"88a48db0-3c85-4a7f-8565-7f3750e53dfc","name":"Tag has already been added.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"tag\": \"IMPORT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"ALREADY_EXISTS\",\n  \"tag\": {\n    \"id\": 1001,\n    \"name\": \"IMPORT\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c05315cb-5556-4050-9edd-aa3afb051ae0","name":"AIR - Remove Tag from the Shipment","request":{"name":"AIR - Remove Tag from the Shipment","description":{"content":"This endpoint allows users to remove an existing tag from an existing air shipment.","type":"text/plain"},"url":{"path":["air","shipments",":shipment_id","tags",":tag_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"tag_id","description":"(Required) The unique identifier of the tag."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"c72cdb63-2ffb-4244-b4cc-28ce41f16db1","name":"Tag successfully removed from the shipment.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","tags",":tag_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"tag_id","description":"(Required) The unique identifier of the tag."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"813e2629-34ae-4604-8dc7-734446a77286","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["air","shipments",":shipment_id","tags",":tag_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"tag_id","description":"(Required) The unique identifier of the tag."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"8f2c45ad-cc35-410c-8716-e2853d4dbc3a","name":"air-webhook-events","description":{"content":"This section provides a comprehensive set of webhook events to manage your air shipments. You can check the\n**[Webhooks](#description/webhooks)** section for more information about intergration and security.\n","type":"text/plain"},"item":[],"event":[]},{"id":"4dcda575-4562-44df-9290-c29bb4ba0687","name":"ocean-carriers","description":{"content":"This section provides a comprehensive set of endpoints for carriers.\n","type":"text/plain"},"item":[{"id":"9ed4f902-7e3a-4874-a9aa-a2ef91c5d4bc","name":"OCEAN - List of Carriers","request":{"name":"OCEAN - List of Carriers","description":{"content":"The shipments list endpoint allows you to retrieve a list of carriers. This includes options to apply various\nfilters and sorting.\n\n**Example #1:** To filter the trackable carriers.\n\n```plain\n/ocean/carriers?filters[status]=eq:ACTIVE\n```\n\n**Example #2:** To filter carriers that contain `CMA` in their name.\n\n```plain\n/ocean/carriers?filters[name]=contains:CMA\n```\n","type":"text/plain"},"url":{"path":["ocean","carriers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"order_by","value":"<string>"},{"disabled":false,"key":"skip","value":"<integer>"},{"disabled":false,"key":"take","value":"<integer>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"47b0d2d1-c59a-4c33-b7ab-3fb488fc535e","name":"List of carriers have been successfully retrieved.","originalRequest":{"url":{"path":["ocean","carriers"],"host":["{{baseUrl}}"],"query":[{"key":"order_by","value":"<string>"},{"key":"skip","value":"<integer>"},{"key":"take","value":"<integer>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"string\",\n  \"carriers\": [\n    {\n      \"scac\": \"string\",\n      \"name\": \"string\",\n      \"status\": \"PASSIVE\"\n    },\n    {\n      \"scac\": \"string\",\n      \"name\": \"string\",\n      \"status\": \"PASSIVE\"\n    }\n  ],\n  \"meta\": {\n    \"more\": false,\n    \"total\": 4754\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"5f046f02-5ccd-4cc0-8367-4469246c9e3f","name":"ocean-shipments","description":{"content":"This section provides a comprehensive set of endpoints to manage your ocean shipments.\n\n### How It Works\n\nFirst, you need to create the shipment, and after that, we will periodically check the shipment status and other\nrelevant details. Our system will automatically track the shipment's progress and any changes, ensuring everything stays\nupdated. You will be notified with updates and changes as needed, ensuring timely and accurate information about your\nshipment. You can also check your shipment details at any time, or use webhooks to receive real-time updates.\n","type":"text/plain"},"item":[{"id":"5571d54d-857e-44be-83bc-9f211ca8124a","name":"OCEAN - Create a Shipment","request":{"name":"OCEAN - Create a Shipment","description":{"content":"This endpoint allows you to create a new shipment by providing the necessary shipment details. Once\nthe shipment is successfully created, you need to save the given shipment identifier in your internal system\nto use it across the related endpoints.\n\n### Duplicate Shipments\n\nIf a shipment already exists with the same `reference` and `booking_number` or `container_number`, the system will not\ncreate a new shipment (no cost will be incurred) and will return a (`409 - ALREADY_EXISTS`) response containing the\ndetails of the existing shipment.\n\n-   If the `reference` is provided in the request, it will always be considered during the duplicate check.\n-   If both `booking_number` and `container_number` are provided, only the `booking_number` will be considered for the duplicate check.\n-   If the `booking_number` is not provided, the system will perform the duplicate check using the `container_number`.\n\n**Note:** To add a follower or tag to an existing shipment, you must send a new request to the relevant endpoints using\nthe existing shipment’s `id`.\n\n### Concurrent Requests\n\nWe process creation requests one by one for your company to prevent race conditions, such as misusing your credits\nor creating unnecessary duplicate shipments. You don't need to take any action, this process is handled entirely by\nShipsgo system. However, sending too many concurrent requests can result in longer wait times and errors\n(`429` - `TOO_MANY_CONCURRENT_REQUESTS`). If you plan to create a large number of shipments at once, ensure that\nrequests are sent synchronously.\n","type":"text/plain"},"url":{"path":["ocean","shipments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]},"body":{"mode":"raw","raw":"{\n  \"reference\": \"<string,null>\",\n  \"container_number\": \"<string,null>\",\n  \"booking_number\": \"<string,null>\",\n  \"carrier\": \"<string,null>\",\n  \"followers\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"tags\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"249f6bbe-71a1-4c22-bc42-c234b29b5890","name":"Shipment successfully created & tracking process has been started.","originalRequest":{"url":{"path":["ocean","shipments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n  \"container_number\": \"MSCU1234567\",\n  \"booking_number\": \"MEDUQY000000\",\n  \"carrier\": \"MSCU\",\n  \"followers\": [\n    \"customer-1@example.com\",\n    \"customer-2@example.com\"\n  ],\n  \"tags\": [\n    \"IMPORT\",\n    \"CUSTOMER_ABC\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"disabled":false,"description":"The amount of credit consumption for the operation.","key":"X-Shipsgo-Credits-Cost","value":"1"},{"disabled":false,"description":"The amount of credit remaining after the operation.","key":"X-Shipsgo-Credits-Remaining","value":"999"},{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"shipment\": {\n    \"id\": 123456,\n    \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n    \"container_number\": \"MSCU1234567\",\n    \"booking_number\": \"MEDUQY000000\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"c3e42eca-8164-4446-b712-0e4c556f04c9","name":"Company does not have enought credits to create a shipment.","originalRequest":{"url":{"path":["ocean","shipments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n  \"container_number\": \"MSCU1234567\",\n  \"booking_number\": \"MEDUQY000000\",\n  \"carrier\": \"MSCU\",\n  \"followers\": [\n    \"customer-1@example.com\",\n    \"customer-2@example.com\"\n  ],\n  \"tags\": [\n    \"IMPORT\",\n    \"CUSTOMER_ABC\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"status":"Payment Required","code":402,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"NOT_ENOUGH_CREDITS\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"8979f0a3-4302-44d0-b489-5e99a9bd056e","name":"Shipment has already been created.","originalRequest":{"url":{"path":["ocean","shipments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n  \"container_number\": \"MSCU1234567\",\n  \"booking_number\": \"MEDUQY000000\",\n  \"carrier\": \"MSCU\",\n  \"followers\": [\n    \"customer-1@example.com\",\n    \"customer-2@example.com\"\n  ],\n  \"tags\": [\n    \"IMPORT\",\n    \"CUSTOMER_ABC\"\n  ]\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"disabled":false,"description":"The amount of credit consumption for the operation.","key":"X-Shipsgo-Credits-Cost","value":"0"},{"disabled":false,"description":"The amount of credit remaining after the operation.","key":"X-Shipsgo-Credits-Remaining","value":"1000"},{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"ALREADY_EXISTS\",\n  \"shipment\": {\n    \"id\": 123456,\n    \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n    \"container_number\": \"MSCU1234567\",\n    \"booking_number\": \"MEDUQY000000\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c2cc0bc5-e06b-4d43-9582-9201c505f430","name":"OCEAN - List of Shipments","request":{"name":"OCEAN - List of Shipments","description":{"content":"The shipments list endpoint allows you to retrieve a list of your shipments (**basic information**) including options\nfor applying various filters and sorting. To access detailed information (such as `route details`, `container movements`,\n`followers`, etc.) about a shipment, use the **OCEAN - Details of the Shipment** endpoint.\n\n**Example #1:** Ongoing (SAILING) shipments carried by **MSC** (MSCU) or **OOCL** (OOLU) with upcoming\narrivals, listed in order.\n\n```plain\n/ocean/shipments\n  ?filters[status]=eq:SAILING\n  &filters[carrier]=in:MSCU,OOLU\n  &order_by=date_of_discharge,asc\n```\n\n**Example #2:** Shipments loaded from **India** (IN), between **September 1, 2024**, and **October 1, 2024**, listed in\norder of loading date.\n\n```plain\n/ocean/shipments\n  ?filters[port_of_loading_country]=eq:IN\n  &filters[date_of_loading]=between:2024-09-01...2024-10-01\n  &order_by=date_of_loading,asc\n```\n\n**Example #3:** Shipments tagged with `COMPANY_ABC` and created by **John Doe** (`john-doe@example.com`).\n\n```plain\n/ocean/shipments\n  ?filters[tags]=with:COMPANY_ABC\n  &filters[creator]=eq:john-doe@example.com\n```\n","type":"text/plain"},"url":{"path":["ocean","shipments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"order_by","value":"<string>"},{"disabled":false,"key":"skip","value":"<integer>"},{"disabled":false,"key":"take","value":"<integer>"}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"f7d46c9e-8700-43e0-ab20-af450e0d3639","name":"List of shipments have been successfully retrieved.","originalRequest":{"url":{"path":["ocean","shipments"],"host":["{{baseUrl}}"],"query":[{"key":"order_by","value":"<string>"},{"key":"skip","value":"<integer>"},{"key":"take","value":"<integer>"}],"variable":[]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"shipments\": [\n    {\n      \"id\": 9246,\n      \"reference\": \"string\",\n      \"booking_number\": null,\n      \"container_number\": null,\n      \"container_count\": 2831,\n      \"carrier\": {\n        \"scac\": \"string\",\n        \"name\": \"string\"\n      },\n      \"status\": \"DISCHARGED\",\n      \"route\": {\n        \"port_of_loading\": {\n          \"location\": {\n            \"code\": \"string\",\n            \"name\": \"string\",\n            \"timezone\": \"string\",\n            \"country\": {\n              \"code\": \"string\",\n              \"name\": \"string\"\n            }\n          },\n          \"date_of_loading\": \"2018-12-06T16:21:05.878Z\",\n          \"date_of_loading_initial\": \"2000-02-21T12:05:28.281Z\"\n        },\n        \"ts_count\": 9244,\n        \"port_of_discharge\": {\n          \"location\": {\n            \"code\": \"string\",\n            \"name\": \"string\",\n            \"timezone\": \"string\",\n            \"country\": {\n              \"code\": \"string\",\n              \"name\": \"string\"\n            }\n          },\n          \"date_of_discharge\": \"2009-03-07T23:48:04.906Z\",\n          \"date_of_discharge_initial\": \"2023-03-19T20:39:20.200Z\"\n        },\n        \"transit_time\": 6226,\n        \"transit_percentage\": 4554,\n        \"co2_emission\": null\n      },\n      \"tokens\": {\n        \"map\": \"853d7c42-1562-8102-0d6c-0944184f72eb\",\n        \"key_0\": \"string\",\n        \"key_1\": \"string\",\n        \"key_2\": \"string\",\n        \"key_3\": \"string\"\n      },\n      \"creator\": {\n        \"name\": \"string\",\n        \"email\": \"string\"\n      },\n      \"tags\": [\n        {\n          \"id\": 1001,\n          \"name\": \"IMPORT\"\n        },\n        {\n          \"id\": 1001,\n          \"name\": \"IMPORT\"\n        }\n      ],\n      \"created_at\": \"string\",\n      \"updated_at\": \"string\",\n      \"checked_at\": \"string\",\n      \"discarded_at\": \"string\"\n    },\n    {\n      \"id\": 7673,\n      \"reference\": null,\n      \"booking_number\": \"string\",\n      \"container_number\": null,\n      \"container_count\": 2896,\n      \"carrier\": {\n        \"scac\": \"string\",\n        \"name\": \"string\"\n      },\n      \"status\": \"NEW\",\n      \"route\": {\n        \"port_of_loading\": {\n          \"location\": {\n            \"code\": \"string\",\n            \"name\": \"string\",\n            \"timezone\": \"string\",\n            \"country\": {\n              \"code\": \"string\",\n              \"name\": \"string\"\n            }\n          },\n          \"date_of_loading\": \"1961-10-17T11:42:40.210Z\",\n          \"date_of_loading_initial\": \"1949-04-16T00:31:37.254Z\"\n        },\n        \"ts_count\": 5506,\n        \"port_of_discharge\": {\n          \"location\": {\n            \"code\": \"string\",\n            \"name\": \"string\",\n            \"timezone\": \"string\",\n            \"country\": {\n              \"code\": \"string\",\n              \"name\": \"string\"\n            }\n          },\n          \"date_of_discharge\": \"1977-12-19T15:43:26.325Z\",\n          \"date_of_discharge_initial\": \"1949-10-12T03:32:18.168Z\"\n        },\n        \"transit_time\": 7877,\n        \"transit_percentage\": 9639,\n        \"co2_emission\": null\n      },\n      \"tokens\": {\n        \"map\": \"8355dcad-2436-9ab3-712c-152dcfc7e5b3\"\n      },\n      \"creator\": {\n        \"name\": \"string\",\n        \"email\": \"string\"\n      },\n      \"tags\": [\n        {\n          \"id\": 1001,\n          \"name\": \"IMPORT\"\n        },\n        {\n          \"id\": 1001,\n          \"name\": \"IMPORT\"\n        }\n      ],\n      \"created_at\": \"string\",\n      \"updated_at\": \"string\",\n      \"checked_at\": \"string\",\n      \"discarded_at\": null\n    }\n  ],\n  \"meta\": {\n    \"more\": true,\n    \"total\": null\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"f17377c0-82e2-4ca5-835c-1b83f5272371","name":"OCEAN - Details of the Shipment","request":{"name":"OCEAN - Details of the Shipment","description":{"content":"This endpoint retrieves the details of an existing ocean shipment. It returns comprehensive information\nabout the shipment. This allows users to track and monitor the shipment's progress and status in real-time.\n","type":"text/plain"},"url":{"path":["ocean","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"40a87625-bb89-4a3e-88b4-2e4c410fdd53","name":"Details of the shipment have been successfully retrieved.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"shipment\": {\n    \"id\": 1001,\n    \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n    \"booking_number\": null,\n    \"container_number\": \"MSDU7777777\",\n    \"container_count\": 1,\n    \"carrier\": {\n      \"scac\": \"MSCU\",\n      \"name\": \"MSC\"\n    },\n    \"status\": \"INPROGRESS\",\n    \"route\": null,\n    \"containers\": [],\n    \"tokens\": {\n      \"map\": \"00000000-0000-0000-0000-000000000000\"\n    },\n    \"followers\": [],\n    \"tags\": [],\n    \"creator\": {\n      \"name\": \"John Doe\",\n      \"email\": \"zfeil@yahoo.com\"\n    },\n    \"created_at\": \"2025-04-14 10:31:02\",\n    \"updated_at\": \"2025-04-14 10:31:02\",\n    \"checked_at\": \"2025-04-14 10:31:02\",\n    \"discarded_at\": null\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"0f0fb004-870b-46c3-aa0d-b36c3e571130","name":"OCEAN - Update the Shipment","request":{"name":"OCEAN - Update the Shipment","description":{"content":"This endpoint allows users to update the fields of an existing ocean shipment.\n","type":"text/plain"},"url":{"path":["ocean","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]},"body":{"mode":"raw","raw":"{\n  \"reference\": \"<string>\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b746a8d8-d3bc-4ef5-bdb0-a81742b90bc4","name":"Shipment successfully updated.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"shipment\": {\n    \"id\": 123456,\n    \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\",\n    \"container_number\": \"MSCU1234567\",\n    \"booking_number\": \"MEDUQY000000\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"a498d785-723f-4034-bf60-1e7eadbd5c8f","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"{\n  \"reference\": \"INTERNAL_UNIQUE_IDENTIFIER\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"5a39c8ce-cc9b-4ac8-b9a3-f0dfcad3fb97","name":"OCEAN - Delete the Shipment","request":{"name":"OCEAN - Delete the Shipment","description":{"content":"This endpoint allows users to delete an existing ocean shipment.\n","type":"text/plain"},"url":{"path":["ocean","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"8b3e9d52-0ed0-4484-806b-e8de568d7c5e","name":"Shipment successfully deleted.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"663dc662-0dcf-424e-b6cf-fba8f765928f","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"087f91ca-61c9-4aa7-b352-658b766c7b01","name":"OCEAN - Route of the Shipment","request":{"name":"OCEAN - Route of the Shipment","description":{"content":"This endpoint provides a GeoJSON FeatureCollection with all map-related data for a shipment, including port locations,\nthe vessel’s current position, and past/future paths.\n\nGeoJSON ([RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946)) is a format used to describe geographic data and can\nbe directly used with most mapping libraries (Leaflet, Mapbox, Google Maps, etc.).\n\nIn this endpoint, only `Point` and `LineString` geometry types are used. Each geometry is returned within a Feature as\ndefined below:\n\n-   Each Feature has a `geometry` (`Point` or `LineString`).\n-   Each Feature has a set of `properties` according to its `geometry`.\n-   Each Feature has a `status` property, which can be:\n    -   `PAST` – The shipment was at this port/route in the past.\n    -   `CURRENT` – The shipment is at this port/route now.\n    -   `FUTURE` – The shipment is expected to be at this port/route in the future.\n\n#### Point Features\n\nFeatures with `Point` geometry represent ports. Each `Point` Feature includes the port’s name, unlocode, timezone, and\ncountry information.\n\n#### LineString Features\n\nFeatures with `LineString` geometry represent routes between two locations. Each `LineString` Feature includes vessel\ninformation, voyage number, related events (`DEPA`, `ARRV`), and current position (when `status` is `CURRENT`).\n","type":"text/plain"},"url":{"path":["ocean","shipments",":shipment_id","geojson"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"11e605c7-8e80-420c-a7ef-77b279c3579b","name":"Route of the shipment have been successfully retrieved.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","geojson"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"GET","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"geojson\": {\n    \"type\": \"FeatureCollection\",\n    \"features\": [\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"Point\",\n          \"coordinates\": [\n            121.5,\n            31.21667\n          ]\n        },\n        \"properties\": {\n          \"status\": \"CURRENT\",\n          \"location\": {\n            \"code\": \"CNSHA\",\n            \"name\": \"SHANGHAI\",\n            \"timezone\": \"Asia/Shanghai\",\n            \"country\": {\n              \"code\": \"CN\",\n              \"name\": \"China\"\n            }\n          }\n        }\n      },\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"LineString\",\n          \"coordinates\": [\n            [\n              121.5,\n              31.21667\n            ],\n            [\n              121.48375,\n              31.23975\n            ],\n            [\n              121.5645,\n              31.28125\n            ],\n            [\n              121.4995,\n              31.3825\n            ],\n            [\n              121.581,\n              31.39625\n            ],\n            [\n              121.70625,\n              31.3345\n            ],\n            [\n              121.8195,\n              31.2015\n            ],\n            [\n              122.34225,\n              31.039\n            ],\n            [\n              122.7495,\n              30.985\n            ],\n            [\n              122.6775,\n              30.8345\n            ],\n            [\n              122.36625,\n              30.1485\n            ],\n            [\n              122.2245,\n              29.8365\n            ],\n            [\n              121.3,\n              27.8\n            ],\n            [\n              120,\n              25.7\n            ],\n            [\n              118.462,\n              24.31575\n            ],\n            [\n              118.34425,\n              24.21\n            ],\n            [\n              116.9965,\n              22.9985\n            ],\n            [\n              116.97075,\n              22.987\n            ],\n            [\n              114.11362,\n              21.70531\n            ],\n            [\n              113.1995,\n              19.61875\n            ],\n            [\n              112.047,\n              16.9535\n            ],\n            [\n              111.811,\n              16.3785\n            ],\n            [\n              110.1,\n              12.2\n            ],\n            [\n              109.77,\n              11.655\n            ],\n            [\n              107.32075,\n              7.609\n            ],\n            [\n              106.46875,\n              5.7275\n            ],\n            [\n              104.69525,\n              1.81175\n            ],\n            [\n              104.58475,\n              1.56725\n            ],\n            [\n              104.5445,\n              1.479\n            ],\n            [\n              104.47763,\n              1.44175\n            ],\n            [\n              103.89075,\n              1.1815\n            ],\n            [\n              103.853,\n              1.262\n            ],\n            [\n              103.754,\n              1.259\n            ]\n          ]\n        },\n        \"properties\": {\n          \"status\": \"FUTURE\",\n          \"vessel\": {\n            \"name\": \"CMA CGM FIGARO\",\n            \"imo\": 9450600\n          },\n          \"voyage\": \"FST1259\",\n          \"events\": {\n            \"DEPA\": {\n              \"location\": {\n                \"code\": \"CNSHA\",\n                \"name\": \"SHANGHAI\",\n                \"timezone\": \"Asia/Shanghai\",\n                \"country\": {\n                  \"code\": \"CN\",\n                  \"name\": \"China\"\n                }\n              },\n              \"timestamp\": \"2025-12-15T12:00:00+08:00\"\n            },\n            \"ARRV\": {\n              \"location\": {\n                \"code\": \"SGSIN\",\n                \"name\": \"SINGAPORE\",\n                \"timezone\": \"Asia/Singapore\",\n                \"country\": {\n                  \"code\": \"SG\",\n                  \"name\": \"Singapore\"\n                }\n              },\n              \"timestamp\": \"2025-12-26T12:00:00+08:00\"\n            }\n          },\n          \"current\": null\n        }\n      },\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"Point\",\n          \"coordinates\": [\n            103.754,\n            1.259\n          ]\n        },\n        \"properties\": {\n          \"status\": \"FUTURE\",\n          \"location\": {\n            \"code\": \"SGSIN\",\n            \"name\": \"SINGAPORE\",\n            \"timezone\": \"Asia/Singapore\",\n            \"country\": {\n              \"code\": \"SG\",\n              \"name\": \"Singapore\"\n            }\n          }\n        }\n      },\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"LineString\",\n          \"coordinates\": [\n            [\n              103.754,\n              1.259\n            ],\n            [\n              103.6,\n              1.10025\n            ],\n            [\n              101.14925,\n              2.735\n            ],\n            [\n              97,\n              7\n            ],\n            [\n              81.89975,\n              5.8995\n            ],\n            [\n              75.9555,\n              6.97\n            ],\n            [\n              69.67462,\n              8.68163\n            ],\n            [\n              65.062,\n              10.02763\n            ],\n            [\n              52.3005,\n              11.59975\n            ],\n            [\n              44.898,\n              12.04225\n            ],\n            [\n              43.46525,\n              12.633\n            ],\n            [\n              42.4925,\n              14.12825\n            ],\n            [\n              41.3775,\n              16.01175\n            ],\n            [\n              39.335,\n              19.9085\n            ],\n            [\n              37,\n              23.6\n            ],\n            [\n              34.5525,\n              26.90375\n            ],\n            [\n              33.50275,\n              28.1175\n            ],\n            [\n              32.58875,\n              29.557\n            ],\n            [\n              32.58775,\n              29.97425\n            ],\n            [\n              32.303,\n              30.56625\n            ],\n            [\n              32.3795,\n              31.30475\n            ],\n            [\n              31.99925,\n              31.727\n            ],\n            [\n              30.43,\n              32.30275\n            ],\n            [\n              27.9275,\n              33.2195\n            ],\n            [\n              24.92675,\n              34.1875\n            ],\n            [\n              21.069,\n              35.196\n            ],\n            [\n              17.194,\n              35.991\n            ],\n            [\n              15.753,\n              36.2865\n            ],\n            [\n              15.204,\n              36.3995\n            ],\n            [\n              14.8385,\n              36.518\n            ],\n            [\n              14.6855,\n              36.568\n            ],\n            [\n              14.38425,\n              36.66625\n            ],\n            [\n              14.09875,\n              36.7595\n            ],\n            [\n              13.81725,\n              36.85913\n            ],\n            [\n              13.15475,\n              37.0675\n            ],\n            [\n              12.55825,\n              37.26225\n            ],\n            [\n              12.24475,\n              37.3645\n            ],\n            [\n              11.987,\n              37.45238\n            ],\n            [\n              11.451,\n              37.6235\n            ],\n            [\n              11.237,\n              37.6935\n            ],\n            [\n              10.31925,\n              37.993\n            ],\n            [\n              9.12175,\n              38.384\n            ],\n            [\n              8.80075,\n              38.48913\n            ],\n            [\n              8.43,\n              38.6095\n            ],\n            [\n              8.04475,\n              38.7845\n            ],\n            [\n              7.86275,\n              38.867\n            ],\n            [\n              7.53175,\n              39.01725\n            ],\n            [\n              5.87,\n              39.771\n            ],\n            [\n              5.22156,\n              40.04288\n            ],\n            [\n              4.675,\n              40.27775\n            ],\n            [\n              3.94925,\n              40.5685\n            ],\n            [\n              3.62913,\n              40.69438\n            ],\n            [\n              3.34112,\n              40.81762\n            ],\n            [\n              2.88925,\n              40.96375\n            ],\n            [\n              2.641,\n              41.0845\n            ],\n            [\n              2.37988,\n              41.21988\n            ],\n            [\n              2.23431,\n              41.31562\n            ],\n            [\n              2.16667,\n              41.35\n            ]\n          ]\n        },\n        \"properties\": {\n          \"status\": \"FUTURE\",\n          \"vessel\": {\n            \"name\": \"SING\",\n            \"imo\": 9322841\n          },\n          \"voyage\": \"HLN5451\",\n          \"events\": {\n            \"DEPA\": {\n              \"location\": {\n                \"code\": \"SGSIN\",\n                \"name\": \"SINGAPORE\",\n                \"timezone\": \"Asia/Singapore\",\n                \"country\": {\n                  \"code\": \"SG\",\n                  \"name\": \"Singapore\"\n                }\n              },\n              \"timestamp\": \"2025-12-27T12:00:00+08:00\"\n            },\n            \"ARRV\": {\n              \"location\": {\n                \"code\": \"ESBCN\",\n                \"name\": \"BARCELONA\",\n                \"timezone\": \"Europe/Madrid\",\n                \"country\": {\n                  \"code\": \"ES\",\n                  \"name\": \"Spain\"\n                }\n              },\n              \"timestamp\": \"2026-01-13T12:00:00+01:00\"\n            }\n          },\n          \"current\": null\n        }\n      },\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"Point\",\n          \"coordinates\": [\n            2.16667,\n            41.35\n          ]\n        },\n        \"properties\": {\n          \"status\": \"FUTURE\",\n          \"location\": {\n            \"code\": \"ESBCN\",\n            \"name\": \"BARCELONA\",\n            \"timezone\": \"Europe/Madrid\",\n            \"country\": {\n              \"code\": \"ES\",\n              \"name\": \"Spain\"\n            }\n          }\n        }\n      },\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"LineString\",\n          \"coordinates\": [\n            [\n              2.16667,\n              41.35\n            ],\n            [\n              2.14538,\n              41.29613\n            ],\n            [\n              2.07056,\n              41.13594\n            ],\n            [\n              1.9305,\n              40.9205\n            ],\n            [\n              1.897,\n              40.862\n            ],\n            [\n              1.85525,\n              40.79475\n            ],\n            [\n              1.64975,\n              40.50975\n            ],\n            [\n              1.454,\n              40.19175\n            ],\n            [\n              1.4155,\n              40.143\n            ],\n            [\n              1.24,\n              39.89075\n            ],\n            [\n              1.01675,\n              39.635\n            ],\n            [\n              0.8985,\n              39.46075\n            ],\n            [\n              0.8425,\n              39.36225\n            ],\n            [\n              0.60725,\n              39.07337\n            ],\n            [\n              0.45837,\n              38.8295\n            ],\n            [\n              0.38456,\n              38.72794\n            ],\n            [\n              0.31775,\n              38.65225\n            ],\n            [\n              0.1845,\n              38.4825\n            ],\n            [\n              -0.07775,\n              38.166\n            ],\n            [\n              -0.13425,\n              38.086\n            ],\n            [\n              -0.451,\n              37.66975\n            ],\n            [\n              -0.55825,\n              37.5675\n            ],\n            [\n              -0.6435,\n              37.51225\n            ],\n            [\n              -1.10525,\n              37.197\n            ],\n            [\n              -1.8285,\n              36.763\n            ],\n            [\n              -1.965,\n              36.681\n            ],\n            [\n              -2.51713,\n              36.60187\n            ],\n            [\n              -2.9265,\n              36.5565\n            ],\n            [\n              -3.2525,\n              36.43525\n            ],\n            [\n              -3.495,\n              36.42325\n            ],\n            [\n              -3.6565,\n              36.38025\n            ],\n            [\n              -3.86194,\n              36.30572\n            ],\n            [\n              -3.96825,\n              36.27925\n            ],\n            [\n              -4.54625,\n              36.1055\n            ],\n            [\n              -4.994,\n              35.99112\n            ],\n            [\n              -5.27169,\n              35.97781\n            ],\n            [\n              -5.38069,\n              35.97337\n            ],\n            [\n              -5.781,\n              35.9145\n            ],\n            [\n              -7.1,\n              34.4\n            ],\n            [\n              -7.86037,\n              34.03563\n            ],\n            [\n              -7.61667,\n              33.6\n            ]\n          ]\n        },\n        \"properties\": {\n          \"status\": \"FUTURE\",\n          \"vessel\": {\n            \"name\": \"CMA CGM KHAO SOK\",\n            \"imo\": 9925837\n          },\n          \"voyage\": \"ZWF3390\",\n          \"events\": {\n            \"DEPA\": {\n              \"location\": {\n                \"code\": \"ESBCN\",\n                \"name\": \"BARCELONA\",\n                \"timezone\": \"Europe/Madrid\",\n                \"country\": {\n                  \"code\": \"ES\",\n                  \"name\": \"Spain\"\n                }\n              },\n              \"timestamp\": \"2026-01-14T12:00:00+01:00\"\n            },\n            \"ARRV\": {\n              \"location\": {\n                \"code\": \"MACAS\",\n                \"name\": \"CASABLANCA\",\n                \"timezone\": \"Africa/Casablanca\",\n                \"country\": {\n                  \"code\": \"MA\",\n                  \"name\": \"Morocco\"\n                }\n              },\n              \"timestamp\": \"2026-02-12T12:00:00+01:00\"\n            }\n          },\n          \"current\": null\n        }\n      },\n      {\n        \"type\": \"Feature\",\n        \"geometry\": {\n          \"type\": \"Point\",\n          \"coordinates\": [\n            -7.61667,\n            33.6\n          ]\n        },\n        \"properties\": {\n          \"status\": \"FUTURE\",\n          \"location\": {\n            \"code\": \"MACAS\",\n            \"name\": \"CASABLANCA\",\n            \"timezone\": \"Africa/Casablanca\",\n            \"country\": {\n              \"code\": \"MA\",\n              \"name\": \"Morocco\"\n            }\n          }\n        }\n      }\n    ]\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"c58fa36e-d73d-48d1-9b45-d80f46002ff3","name":"OCEAN - Add Follower to the Shipment","request":{"name":"OCEAN - Add Follower to the Shipment","description":{"content":"This endpoint allows users to add a new follower to an existing ocean shipment.","type":"text/plain"},"url":{"path":["ocean","shipments",":shipment_id","followers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]},"body":{"mode":"raw","raw":"{\n  \"follower\": \"<string>\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"b32ca949-a826-4525-a0fb-c47c73e7c377","name":"Follower successfully added to the shipment.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","followers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"follower\": \"customer-1@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"follower\": {\n    \"id\": 1001,\n    \"email\": \"customer-1@example.com\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"1324acff-23fe-4b31-b835-b8e8b110cb93","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","followers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"follower\": \"customer-1@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"24482da2-6b84-434e-97b6-59bf41245738","name":"Follower has already been added.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","followers"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"follower\": \"customer-1@example.com\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"ALREADY_EXISTS\",\n  \"follower\": {\n    \"id\": 1001,\n    \"email\": \"customer-1@example.com\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"dfe0ba24-c4f7-423c-abc0-78feeab5906b","name":"OCEAN - Remove Follower from the Shipment","request":{"name":"OCEAN - Remove Follower from the Shipment","description":{"content":"This endpoint allows users to remove an existing follower from an existing ocean shipment.","type":"text/plain"},"url":{"path":["ocean","shipments",":shipment_id","followers",":follower_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"follower_id","description":"(Required) The unique identifier of the follower."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"44a84bd3-1066-4b64-afc8-fe9835d30f51","name":"Follower successfully removed from the shipment.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","followers",":follower_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"follower_id","description":"(Required) The unique identifier of the follower."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e77e2720-5422-4909-9658-decac0e4ea3a","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","followers",":follower_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"follower_id","description":"(Required) The unique identifier of the follower."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"88255b2a-8422-4907-b81c-ab4240a726b7","name":"OCEAN - Add Tag to the Shipment","request":{"name":"OCEAN - Add Tag to the Shipment","description":{"content":"This endpoint allows users to add a tag to an existing ocean shipment.","type":"text/plain"},"url":{"path":["ocean","shipments",":shipment_id","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]},"body":{"mode":"raw","raw":"{\n  \"tag\": \"<string>\"\n}","options":{"raw":{"language":"json"}}}},"response":[{"id":"fe2644b4-2f3d-4522-8306-2b23ffeb714a","name":"Tag successfully added to the shipment.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"tag\": \"IMPORT\"\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\",\n  \"tag\": {\n    \"id\": 1001,\n    \"name\": \"IMPORT\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"5a336e6c-0417-45c1-8ede-1a91bd1e054c","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"tag\": \"IMPORT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"e6e14c41-9f4f-4f18-b8b4-101f546bc38c","name":"Tag has already been added.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","tags"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\n  \"tag\": \"IMPORT\"\n}","options":{"raw":{"language":"json"}}}},"status":"Conflict","code":409,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"ALREADY_EXISTS\",\n  \"tag\": {\n    \"id\": 1001,\n    \"name\": \"IMPORT\"\n  }\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}},{"id":"ed6b44fd-3169-41fb-bfb0-b9e68fa86041","name":"OCEAN - Remove Tag from the Shipment","request":{"name":"OCEAN - Remove Tag from the Shipment","description":{"content":"This endpoint allows users to remove an existing tag from an existing ocean shipment.","type":"text/plain"},"url":{"path":["ocean","shipments",":shipment_id","tags",":tag_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"tag_id","description":"(Required) The unique identifier of the tag."}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"key":"key","value":"X-Shipsgo-User-Token"},{"key":"value","value":"{{apiKey}}"},{"key":"in","value":"header"}]}},"response":[{"id":"471a63fb-6bd4-4525-b800-91191422ac61","name":"Tag successfully removed from the shipment.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","tags",":tag_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"tag_id","description":"(Required) The unique identifier of the tag."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"OK","code":200,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"SUCCESS\"\n}","cookie":[],"_postman_previewlanguage":"json"},{"id":"274554c9-b80b-458f-bfb6-b5cc50c95f91","name":"User does not permitted for this action.","originalRequest":{"url":{"path":["ocean","shipments",":shipment_id","tags",":tag_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"type":"any","value":"<integer>","key":"shipment_id","description":"(Required) The unique identifier of the shipment."},{"disabled":false,"type":"any","value":"<integer>","key":"tag_id","description":"(Required) The unique identifier of the tag."}]},"header":[{"description":{"content":"Added as a part of security scheme: apikey","type":"text/plain"},"key":"X-Shipsgo-User-Token","value":"<API Key>"},{"key":"Accept","value":"application/json"}],"method":"DELETE","body":{}},"status":"Forbidden","code":403,"header":[{"key":"Content-Type","value":"application/json"}],"body":"{\n  \"message\": \"FORBIDDEN\"\n}","cookie":[],"_postman_previewlanguage":"json"}],"event":[],"protocolProfileBehavior":{"disableBodyPruning":true}}],"event":[]},{"id":"6f4811f8-f828-4059-b664-422abd9dce6d","name":"ocean-webhook-events","description":{"content":"This section provides a comprehensive set of webhook events to manage your ocean shipments. You can check the\n**[Webhooks](#description/webhooks)** section for more information about intergration and security.\n","type":"text/plain"},"item":[],"event":[]}],"event":[],"variable":[{"type":"string","value":"https://api.shipsgo.com/v2","key":"baseUrl"}],"info":{"_postman_id":"8baf126b-a4f1-46bc-b08a-6885db342c10","name":"Shipsgo API","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","description":{"content":"### Overview\n\nThe Shipsgo API is built on REST principles. Authenticated users can interact with any of our\nURIs by using the specified HTTP request method. Our API has predictable resource-oriented URLs,\naccepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes,\nauthentication, and verbs.\n\n### Authentication\n\nAll requests to Shipsgo API require you to authenticate yourself to the service. In order to do\nthis you must send `X-Shipsgo-User-Token` header with the correct API token. If you don't have an\nAPI token, you can create one from \"[Shipsgo API](https://shipsgo.com/dashboard/air/integrations/api-tokens)\"\nsection on your dashboard.\n\nIf you use Shipsgo with multiple users (sub-accounts), API tokens are associated with a single\nuser. Each account has different permission on API endpoints based on their role, similar to dashboard.\n\n| Role           | Description                                                                                 |\n| -------------- | ------------------------------------------------------------------------------------------- |\n| Full Access    | View & manage (delete/update) all shipments of the company.                                 |\n| Co-Worker      | View & manage (delete/update) shipments only created by itself.                             |\n| Co-Worker Plus | View all shipments of the company, manage (delete/update) shipments only created by itself. |\n\nIf you want to check permissions of your users you can view/manage from\n\"[Sub Accounts](https://shipsgo.com/dashboard/sub-accounts)\" section on your dashboard.\n\n### HTTP Response Codes\n\nShipsgo uses conventional HTTP response codes to indicate the success or failure of an API request.\nIn general: Codes in the `2xx` range indicate success. Codes in the `4xx` range indicate an error that\nfailed given the information provided. Codes in the `5xx` range indicate an error with Shipsgo's servers\n(these are rare).\n\n| Code  | Description           | Reason                                                                                          |\n| ----- | --------------------- | ----------------------------------------------------------------------------------------------- |\n| `200` | Success               | Everything went smooth.                                                                         |\n| `401` | Unauthorized          | Missing or invalid authentication token.                                                        |\n| `402` | Payment Required      | Not enough credits.                                                                             |\n| `403` | Forbidden             | User not authorized to perform the operation.                                                   |\n| `404` | Not Found             | Requested resource is not found.                                                                |\n| `409` | Conflict              | The requested resource already exists.                                                          |\n| `422` | Unprocessable Content | Something with the payload isn't quite right, this could be malformed JSON or incorrect fields. |\n| `429` | Too Many Requests     | Client has sent too many requests in a given amount of time.                                    |\n| `500` | Internal Server Error | The server encountered an unexpected condition.                                                 |\n| `503` | Service Unavailable   | The server is down for maintenance. This is a temporary state.                                  |\n\n### Rate Limits\n\nThe Shipsgo API uses a number of safeguards against bursts of incoming traffic to help maximize its stability.\nFor your company, the API rate limit is **100 requests per minute**. This limit applies collectively across all\nusers within the company. You can use the headers that are sent with each response to determine the current status\nof your rate limit. If you send many requests in a short window, you might see error responses with status code `429`.\n\n| Header                | Description                                                                   |\n| --------------------- | ----------------------------------------------------------------------------- |\n| X-RateLimit-Limit     | The maximum number of requests that you can make per minute.                  |\n| X-RateLimit-Remaining | The number of requests remaining in the current rate limit window.            |\n| X-RateLimit-Reset     | The time at which the current rate limit window resets, in UTC epoch seconds. |\n\n### List Endpoints\n\nAll top-level API resources have support for bulk fetches. These list endpoints share a common structure for\nfiltering, sorting and pagination. For example, you can list your air shipments with upcoming arrivals in order:\n\n```plain\n[GET] /air/shipments?filters[status]=eq:EN_ROUTE&order_by=date_of_rcf,asc\n```\n\nThere are a variety of different filters that can be used to each list enpoint. Filters can be used together in\ndifferent combinations. When multiple filters are applied, they will be combined using the **AND** condition. Common\nstructure is `filters[field]=operator:value(s)`. Each `field` has corresponding `operator`s. You can find the\n`field` & `operator` mappings in the **filters** section of the relevant endpoint. The following operators are\nsupported:\n\n| Operator       | Description                                                               |\n| -------------- | ------------------------------------------------------------------------- |\n| `eq`           | Equal to a specific value.                                                |\n| `not_eq`       | Not equal to a specific value.                                            |\n| `contains`     | Checks if the field value contains a specific substring.                  |\n| `not_contains` | Checks if the field value does not contain a specific substring.          |\n| `in`           | Checks if the field value is within a list of values (`,` separated).     |\n| `not_in`       | Checks if the field value is not within a list of values (`,` separated). |\n| `with`         | Checks if the field value is within a list of values (`,` separated).     |\n| `without`      | Checks if the field value is not within a list of values (`,` separated). |\n| `gt`           | Greater than a specific value.                                            |\n| `gte`          | Greater than or equal to a specific value.                                |\n| `lt`           | Less than a specific value.                                               |\n| `lte`          | Less than or equal to a specific value.                                   |\n| `between`      | Checks if the field value is between two values (`...` separated).        |\n\nYou can sort the list with `order_by` parameter. Common structure is `order_by=field,direction`. You can find the\navailable `field` list in the **order_by** section of the relevant endpoint and `direction` can be `asc` (ascending)\nor `desc` (descending). If you omit the `direction`, the default sort direction is `asc` (ascending).\n\nFor the pagination you can use `skip` & `take` parameters with non-negative integer values.\n\n### Webhooks\n\nWhen an event occurs, our system automatically sends a HTTP request (POST) to your specified webhook endpoint with\nrelevant data. This allows you to receive **real-time updates** without manually checking for changes. For example,\nwhen a shipment is created or updated, your system can instantly process the information and take the necessary\nactions. You can manage your webhooks & events you want to listen from\n\"[Webhooks](https://shipsgo.com/dashboard/air/integrations/webhooks)\" section on your dashboard.\n\nThis is the recommended way to track shipments via the API. You should use webhooks instead of polling our API\nperiodically.\n\n##### Retry Mechanism\n\nIf your webhook endpoint responds with a server error (`5xx`) or connection error occurs, we automatically retry\ndelivery up to 3 additional times. This helps to prevent losting webhook events in case of temporary failures. Retries\nare based on the following schedule;\n\n1. **1 minute** after first failure.\n2. **5 minutes** after second failure.\n3. **10 minutes** after third failure (last attempt).\n\n##### Validating Webhook Payloads (Optional)\n\nShipsgo will use your **Secret Key** to create a hash signature that's sent to you with each payload. The hash\nsignature is generated using **HMAC-SHA256** and will appear in each delivery as the value of the\n`X-Shipsgo-Webhook-Signature` header.\n\nIn your code that handles webhook deliveries, you should calculate a hash using your **Secret Key**. Then, compare\nthe hash that Shipsgo sent with the expected hash that you calculated, and ensure that they match.\n\nThere are a few important things to keep in mind when validating webhook payloads:\n\n-   Shipsgo uses an HMAC hex digest to compute the hash.\n-   The hash signature is generated using your Secret Key and the payload contents.\n-   If your language and server implementation specifies a character encoding, ensure that you handle the payload as\n    UTF-8. Webhook payloads can contain unicode characters.\n-   Never use a plain `==` operator. Instead consider using a method performs a \"constant time\" string comparison to\n    help mitigate certain timing attacks.\n\nYou can use the following secret and payload values to verify that your implementation is correct:\n\n**Secret Key:** `SUPER_LONG_AND_SECURE_SECRET_KEY`\n\n**Webhook Payload:** `{\"message\":\"You shall not pass!\"}`\n\nIf your implementation is correct, the signatures that you generate should match the following signature:\n\n**Signature:** `9527e0c9463e6f5b01a0af50aecb4658ff50c6b25d3efa8e5c8dea7e4b763772`\n\n---\n\n-   [Pricing](https://shipsgo.com/pricing)\n-   [Terms & Conditions](https://shipsgo.com/terms)\n-   [Privacy Policy](https://shipsgo.com/privacy-policy)\n","type":"text/plain"}}}