GET /api/v1/voyages/:number/movements.json

Supported Formats

json

Errors

Code	Description
400	Bad Request.
404	Not Found.
500	Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/voyages/VOYAGE123/movements.json?container_number=CONTAINER123" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token token=YOURTOKEN"

{
  "movements" : [
     {
       "id": 186,
       "movement_type": "loading",
       "moved_at": "2023-02-16T09:52:42Z",
       "user": {
           "name": "Test",
           "email": "test@test.com"
       },
       "status": "full",
       "source_type": "ShippingLine",
       "source": {
           "name": "MAERSK"
       },
       "destination_type": "Voyage",
       "destination": {
           "name": "Voyage: VOYAGE123"
       },
       "container": {
           "number": "CONTAINER123",
           "size": "45",
           "is_high_cube": false,
           "is_reefer": true,
           "container_type": {
               "code": "45RF",
               "description": "REEFER 45",
               "iso_type_code": "45U6"
           },
           "arrival_voyage": {
               "number": "GC45667",
               "estimated_time_of_anchorage": "2023-02-17T06:21:00Z",
               "vessel": {
                   "name": "Vega Luna"
               }
           }
       },
       "original_container_seals": [],
       "stuffed_container_seals": [],
       "new_container_seals": [],
       "truck": {
           "license_plate": "TV123",
           "number": "123",
           "trucking_company": {
               "name": "Some Company"
           }
       },
       "arrival_voyage": {
           "id": 2,
           "number": "GC45667",
           "status": "active",
           "last_port_of_call": {
               "name": null,
               "locode": null
           },
           "next_port_of_call": {
               "name": null,
               "locode": null
           },
           "captain": {
               "name": null
           },
           "agent": {
               "name": null
           },
           "number_of_tug_boats": 0,
           "arrival_number_of_tug_boats": null,
           "departure_number_of_tug_boats": 0,
           "estimated_time_of_anchorage": "2023-02-17T06:21:00Z",
           "actual_time_of_anchorage": null,
           "actual_time_of_pilot_boarded": null,
           "actual_time_of_berth": null,
           "actual_time_of_customs_clearance": null,
           "actual_time_of_departure": null,
           "closing_comments": null,
           "display_name": "",
           "actual_time_of_departure_pilot_boarded": null,
           "estimated_time_of_departure": "2023-02-21T06:21:00Z",
           "created_at": "2023-02-16T09:51:22Z",
           "updated_at": "2023-02-22T13:20:04Z",
           "ship": {
               "name": "",
               "imo": "9773210",
               "call_sign": "",
               "vessel_type": "Container",
               "loa": "",
               "flag": "PA",
               "gross_tonnage": 210691,
               "net_tonnage": 0
           },
           "vessel": {
               "name": "",
               "imo": "9773210",
               "call_sign": "",
               "vessel_type": "Container",
               "loa": "",
               "flag": "PA",
               "gross_tonnage": 210691,
               "net_tonnage": 0
           },
           "assigned_berth_area": {
               "name": "Berth Area BA1"
           },
           "assigned_yard_area": {
               "name": null
           },
           "discharge_terminal": {
               "name": "South Terminal"
           },
           "arrival_pilot": {
               "name": null
           },
           "departure_pilot": {
               "name": null
           },
           "tax_date": null
       }
   }
  ],
  "actions" : {
   "next_page" : {
       "method" : "GET",
       "url" : "https://app.octopi.co/api/v1/voyages/VOYAGE123/movements.json?container_number=CONTAINER123&page=2&per=10"
   }
 }
}

Params

Param name	Description
number required	Validations: Must be a String
container_number optional	Validations: Must be a String
page optional	Specify which page of results to fetch. This value defaults to 1. Validations: Must be a number.
per optional	The number of items to be displayed. This value defaults to 10 and accepts a maximum of 100. Validations: Must be a number.