The Octopi API is a RESTful API using JSON and the HATEOAS paradigm. In every JSON response from the API, you will find a list of actions returned as a JSON array. These actions are all the methods available on the API resource. We encourage you to build your clients to use these actions dynamically. That way, if the API changes URLs, your client will keep functioning without changing the source code of your client application.
The Octopi API uses HTTP Token Access Authentication.
To authenticate, you need to pass in your API Key (obtained from the Octopi Team) in the HTTP request header using an ‘Authorization’ header with the API key as a token. For example, the header should have “Token token=yourapikey”.
The Octopi API returns all dates and times in ISO 8601 format and UTC.
Resource | Description |
---|---|
GET /api/v1/average_truck_visit_durations.json | Gets a list of average truck visit durations |
Resource | Description |
---|---|
GET /api/v1/bill_of_ladings.json | Returns a list of bill of ladings. |
Resource | Description |
---|---|
GET /api/v1/bill_of_ladings/:id/line_items.json | Returns a list of line items on a Bill of Lading. |
POST /api/v1/bill_of_ladings/:id/line_items.json | Creates a Line Item for a Bill of Lading with given ID |
PATCH /api/v1/bill_of_ladings/:bill_of_lading_id/line_items/:id | Updates one Line Item with given ID for a Bill of Lading with bill_of_lading_id |
DELETE /api/v1/bill_of_ladings/:bill_of_lading_id/line_items/:id | Deletes the given bill of lading line item |
Resource | Description |
---|---|
GET /api/v1/billing/payment_providers/paycargo/fees | |
POST /api/v1/billing/payment_providers/paycargo/payment |
Resource | Description |
---|---|
GET /api/v1/bookings/:number.json |
Resource | Description |
---|---|
GET /api/v1/cargoes/:id/holds.json | |
PUT /api/v1/cargoes/:cargo_id/holds/:id/lift.json | |
PUT /api/v1/cargoes/:id/holds/:hold_id/apply.json |
Resource | Description |
---|---|
GET /api/v1/chassis.json | |
GET /api/v1/chassis/:number.json | |
POST /api/v1/chassis.json | Create a new chassis |
PATCH /api/v1/chassis/:number.json | Update an existing chassis |
Resource | Description |
---|---|
GET /api/v1/consignees | Returns the list of consignees |
GET /api/v1/consignees/:id | Returns information about a consignee |
POST /api/v1/consignees | Create a new consignee |
PUT /api/v1/consignees/:id | Updates a consignee record |
DELETE /api/v1/consignees/:id | Delete a consignee record |
Resource | Description |
---|---|
GET /api/v1/consignees/:consignee_id/bill_of_ladings.json |
Resource | Description |
---|---|
GET /api/v1/consignees/:consignee_id/packing_list_items.json |
Resource | Description |
---|---|
GET /api/v1/container_types.json | Returns a list of container types. |
Resource | Description |
---|---|
GET /api/v1/containers/:number.json | Returns information about the container. |
POST /api/v1/containers | Creates a container not currently at the terminal |
PATCH /api/v1/containers/:number.json | Updates the container's attributes. |
Resource | Description |
---|---|
GET /api/v1/containers/:container_number/damages.json | Returns a list of Container Damages. |
GET /api/v1/containers/:container_number/damages/:id.json | Returns a Container Damage. |
POST /api/v1/containers/:container_number/damages.json | Creates a Container Damage. |
PATCH /api/v1/containers/:container_number/damages/:id | Starts and completes the repair for a Container Damage. |
Resource | Description |
---|---|
PUT /api/v1/containers/:number/extra_attributes/:label | Updates a Container |
Resource | Description |
---|---|
PUT /api/v1/containers/:number/flex_fields/:label | Updates a Container |
Resource | Description |
---|---|
GET /api/v1/containers/:container_number/movements.json |
Resource | Description |
---|---|
PUT /api/v1/containers/:container_number/strip | Creates a full stripping movement on the container |
Resource | Description |
---|---|
PUT /api/v1/containers/:container_number/stuff | Creates a full stuffing movement on the container |
Resource | Description |
---|---|
POST /api/v1/containers/:container_number/tags.json | Apply tags to containers in Octopi. |
Resource | Description |
---|---|
GET /api/v1/containers/:container_number/terminal_services.json |
Resource | Description |
---|---|
POST /api/v1/containers/:container_number/weights.json | Updates a container gross weight. |
Resource | Description |
---|---|
GET /api/v1/freight_forwarders.json | Returns the list of freight forwarders |
GET /api/v1/freight_forwarders/:id | Returns information about a freight forwarder |
POST /api/v1/freight_forwarders | Create a new freight forwarder |
PUT /api/v1/freight_forwarders/:id | Updates a freight forwarder record |
DELETE /api/v1/freight_forwarders/:id | Soft deletes a freight forwarder record |
Resource | Description |
---|---|
GET /api/v1/general_cargoes.json | Gets a list of general cargo |
GET /api/v1/general_cargoes/:id.json | Returns information about a specific general cargo |
PUT /api/v1/general_cargoes/:id.json | Update general cargo data |
Resource | Description |
---|---|
PUT /api/v1/general_cargoes/:id/flex_fields/:label | Updates a specific general cargo |
Resource | Description |
---|---|
GET /api/v1/general_cargoes/:general_cargo_id/terminal_services.json |
Resource | Description |
---|---|
POST /api/v1/general_cargoes/:general_cargo_id/weights.json | Updates a general cargo gross weight. |
Resource | Description |
---|---|
GET /api/v1/gensets.json | |
GET /api/v1/gensets/:number.json |
Resource | Description |
---|---|
GET /api/v1/invoices.json | Gets a list of invoices |
PUT /api/v1/invoices/:id.json | Updates an invoice |
Resource | Description |
---|---|
POST /api/v1/manifests.json | |
DELETE /api/v1/manifests/:client_identifier | |
GET /api/v1/manifests |
Resource | Description |
---|---|
POST /api/v1/manifests/:manifest_client_identifier/bill_of_ladings/:number/cargoes.json |
Resource | Description |
---|---|
PUT /api/v1manifests/:manifest_client_identifier/bill_of_ladings/:bill_of_lading_number/flex_fields/:label | Updates the flex field |
Resource | Description |
---|---|
GET /api/v1/movements.json | Gets a list of movements |
Resource | Description |
---|---|
GET /api/v1/packing_list_items/:reference_number/cargoes.json |
Resource | Description |
---|---|
GET /api/v1/pre_advices/:advice_number | |
POST /api/v1/pre_advices.json | |
DELETE /api/v1/pre_advices/:advice_number |
Resource | Description |
---|---|
GET /api/v1/shipping_lines.json | Returns a list of shipping lines. |
GET /api/v1/shipping_lines/:id | Returns information about a shipping line. |
POST /api/v1/shipping_lines.json | Creates a new shipping line. |
PUT /api/v1/shipping_lines/:id | Updates a shipping line record. |
Resource | Description |
---|---|
PUT /api/v1/shipping_lines/CODE/bookings/NUMBER/flex_fields/:label | Updates a Container |
Resource | Description |
---|---|
PUT /api/v1/shipping_lines/:code/bookings/:number/line_items/:line_item_number/flex_fields/:label | Updates the flex fields for the line item |
Resource | Description |
---|---|
GET /api/v1/vessels/:name |
Resource | Description |
---|---|
GET /api/v1/truck_drivers.json | Gets a list of truck drivers. |
POST /api/v1/truck_drivers.json | Create a truck driver. |
PATCH /api/v1/truck_drivers/:number.json | |
GET /api/v1/truck_driver.json | Find a truck driver. |
Resource | Description |
---|---|
GET /api/v1/truck_visits.json | Gets a list of truck visits. |
GET /api/v1/truck_visits/:id | Get details of a truck visit. |
POST /api/v1/truck_visits.json | Create a truck visit. |
Resource | Description |
---|---|
GET /api/v1/truck_visits/:truck_visit_id/dock_receipts.json | Get list of dock receipts for a truck visit. |
GET /api/v1/truck_visits/:truck_visit_id/dock_receipts/:id.json | Get details of a dock receipt. |
DELETE /api/v1/truck_visit/:truck_visit_id/dock_receipts/:id.json | Delete a dock receipt when ID given. |
POST /api/v1/truck_visits/:truck_visit_id/dock_receipts.json | Create a dock receipt for a truck visit. |
Resource | Description |
---|---|
GET /api/v1/truck_visits/:truck_visit_id/general_cargo_deliveries.json | Get list of general cargo deliveries for truck visits. |
GET /api/v1/truck_visits/:truck_visit_id/general_cargo_deliveries/:id.json | Get details of a general cargo delivery. |
DELETE /api/v1/truck_visit/:truck_visit_id/general_cargo_deliveries/:id.json | Delete a general cargo delivery when ID given |
POST /api/v1/truck_visits/:truck_visit_id/general_cargo_deliveries.json | Create a general cargo delivery for a truck visit. |
Resource | Description |
---|---|
GET /api/v1/truck_visits/:truck_visit_id/interchanges.json | Get list of interchanges for a truck visit. |
GET /api/v1/truck_visits/:truck_visit_id/interchanges/:id.json | Get details of an interchange for a truck visit. |
DELETE /api/v1/truck_visits/:truck_visit_id/interchanges/:id.json | Delete an interchange when ID given. |
POST /api/v1/truck_visits/:truck_visit_id/interchanges.json | Create an interchange for a truck visit. |
Resource | Description |
---|---|
GET /api/v1/trucking_companies | Returns the list of trucking companies |
GET /api/v1/trucking_companies/:id | Returns information about a trucking company |
POST /api/v1/trucking_companies | Create a new trucking company |
PUT /api/v1/trucking_companies/:id | Updates a trucking company record |
DELETE /api/v1/trucking_companies/:id | Soft deletes a trucking company record |
Resource | Description |
---|---|
GET /api/v1/trucks | Returns a list of trucks |
POST /api/v1/trucks | Allows creating a new truck |
PATCH /api/v1/trucks/:truck_license_number | Allows editing an existing truck |
POST /api/v1/trucks/:truck_license_number/gate_out.json | Performs gate out operation for a truck with truck license number provided |
Resource | Description |
---|---|
GET /api/v1/vessel_tallies.json | Get a list of vessel tallies. |
PATCH /api/v1/vessel_tallies/:id.json | Updates a vessel tally. Perform actions for the containers in the tally. |
Resource | Description |
---|---|
GET /api/v1/voyages.json | |
GET /api/v1/voyages/:number.json | |
PATCH /api/v1/voyages/:number.json |
Resource | Description |
---|---|
GET /api/v1/voyages/:voyage_number/bill_of_ladings.json | |
GET /api/v1/voyages/VOYAGE_NUMBER/bill_of_ladings/BILL_OF_LADING_NUMBER.json |
Resource | Description |
---|---|
GET /api/v1/api/v1/voyages/:voyage_number/bill_of_ladings/:bill_of_lading_number/holds.json |
Resource | Description |
---|---|
DELETE /api/v1/voyages/:voyage_number/bill_of_ladings/:bill_of_lading_number/packing_list_items.json |
Resource | Description |
---|---|
GET /api/v1/voyages/:number/consignees.json |
Resource | Description |
---|---|
PUT /api/v1/voyages/:number/flex_fields/:label | Updates a Voyage |
Resource | Description |
---|---|
GET /api/v1/voyages/:number/movements.json |
Resource | Description |
---|---|
GET /api/v1/voyages/:voyage_number/tallies.json |
Resource | Description |
---|---|
GET /api/v1/work_queues.json |
Resource | Description |
---|---|
POST /api/v1/work_queues/:work_queue_id/work_queue_items.json |
Resource | Description |
---|---|
GET /api/v1/yard_areas.json | Gets a list of yard areas |