Voyages::Load_lists
This resource allows you to interact with voyage dynamic load list in Octopi.

Supported Formats

json
>>>

GET /api/v1/voyages/:voyage_number/load_list.json
Returns information about the Voyage load list

Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/voyages/VOYAGE_NUMBER/load_list' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

{
  "id": 7,
  "voyage": {
    "id": 42,
    "name": "OCTORJ 20251022"
  },
  "tally": {
    "id": 29,
    "name": "OCTORJ 20251022 Loading"
  },
  "created_by": {
    "name": "Demo User"
  },
  "shipping_line_voyage_numbers": {
    "REMAKE": "20251022",
    "OCTO": "20251022"
  },
  "created_at": "2025-10-22T08:16:11-04:00",
  "updated_at": "2025-10-31T06:39:24-04:00"
}

Params

Param name Description
voyage_number
required

This must be a voyage number that exists in Octopi.

Validations:

  • Must be a String
>>>

POST /api/v1/voyages/:voyage_number/load_list.json
Creates a new Dynamic Load List for the voyage

Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/voyages/VOYAGE_NUMBER/load_list' \
  -X 'POST' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

{
  "id": 7,
  "voyage": {
    "id": 42,
    "name": "OCTORJ 20251022"
  },
  "tally": {
    "id": 29,
    "name": "OCTORJ 20251022 Loading"
  },
  "created_by": {
    "name": "Demo User"
  },
  "shipping_line_voyage_numbers": {
    "REMAKE": "20251022",
    "OCTO": "20251022"
  },
  "created_at": "2025-10-22T08:16:11-04:00",
  "updated_at": "2025-10-31T06:39:24-04:00"
}

Params

Param name Description
voyage_number
required

This must be a voyage number that exists in Octopi.

Validations:

  • Must be a String
>>>

PUT /api/v1/voyages/:voyage_number/load_list.json
Assigns voyages numbers to the shipping lines

Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/voyages/VOYAGE_NUMBER/load_list' \
  -X 'PUT' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN' \
  -d '{
    "shipping_line_voyage_numbers": {
      "OCTO": "20251022",
      "REMAKE": "20251022"
    }
  }'

{
  "id": 7,
  "voyage": {
    "id": 42,
    "name": "OCTORJ 20251022"
  },
  "tally": {
    "id": 29,
    "name": "OCTORJ 20251022 Loading"
  },
  "created_by": {
    "name": "Demo User"
  },
  "shipping_line_voyage_numbers": {
    "REMAKE": "20251022",
    "OCTO": "20251022"
  },
  "created_at": "2025-10-22T08:16:11-04:00",
  "updated_at": "2025-10-31T06:39:24-04:00"
}

Params

Param name Description
voyage_number
required

This must be a voyage number that exists in Octopi.

Validations:

  • Must be a String
shipping_line_voyage_numbers
required

Hash of fixed keys. Keys(shipping line codes) cannot be changed; only values can be updated.

Validations:

  • Must be a Hash