Container_weights
This resource allows you to fetch container weights in Octopi.

Supported Formats

json
>>>

GET /api/v1/container_weights.json
Returns all the container weights present in Octopi.

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/container_weights' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

{
  "total_count": 3,
  "container_weights": [
    {
      "id": 123,
      "user": "John Doe",
      "container_id": 5281925,
      "container_number": "TEST7607347",
      "movement_id": 24491960,
      "declared_weight_kg": 40000,
      "verified_weight_kg": 40000,
      "reported_during": "Container Weight",
      "created_at": "2024-02-21T14:54:06.000-05:00",
      "event_created_at": "2024-02-21T14:55:06.000-05:00",
      "arrival_voyage_id": 123552,
      "arrival_voyage_number": "101S",
      "container_weight_receipt_url": "https://app.octopi.co/container_weights/123/print"
    },
    {
      "id": 189,
      "user": "John Doe",
      "container_id": 5281925,
      "container_number": "TEST7607347",
      "movement_id": 24491960,
      "declared_weight_kg": 40000,
      "verified_weight_kg": 40000,
      "reported_during": "Gate In",
      "created_at": "2024-02-21T14:54:06.000-05:00",
      "event_created_at": "2024-02-21T14:55:06.000-05:00",
      "arrival_voyage_id": 123552,
      "arrival_voyage_number": "101S",
      "container_weight_receipt_url": "https://app.octopi.co/container_weights/189/print"
    },
    {
      "id": 108,
      "user": "John Doe",
      "container_id": 5281925,
      "container_number": "TEST7607347",
      "movement_id": 24491960,
      "declared_weight_kg": 40000,
      "verified_weight_kg": 40000,
      "reported_during": "Container Weight",
      "created_at": "2024-02-21T14:54:06.000-05:00",
      "event_created_at": "2024-02-21T14:55:06.000-05:00",
      "arrival_voyage_id": 123552,
      "arrival_voyage_number": "101S",
      "container_weight_receipt_url": "https://app.octopi.co/container_weights/108/print"
    }
  ]
}

Params

Param name Description
reported_during
optional

The movement type during which the container weight is created.

Validations:

  • Must be one of: stripping_only, partial_stripping_only, full_stripping_and_stuffing, partial_stripping_and_stuffing, customs_verification, gate_in, gate_out, loading, unloading, inventory, other, manual_insert, manifest, overshipped, stuffing_only, vessel_convenience, ship_to_ship_shifting, ship_to_port_shifting, port_to_ship_shifting, overlanded, container_weight, container_damage, container_repair, moved_by_octopi, breakbulk_delivery, vehicle_delivery, boat_delivery, container_cleaning, reefer_pre_trip, dock_receipt, yard, transfer_out, transfer_in, container_scanning, reefer_plug_in, reefer_plug_out, container_stripping, stock_transfer, breakbulk_split, breakbulk_merge, container_inspection, container_reseal, send_to_berth, receive_from_berth, container_repair_start, partial_stuffing, booking_updated, storage_invoice, container_edit, rail_manifest, rail_in, rail_out, terminal_service, mount, dismount.
created_at
optional

The date and time when the container weight is created, in ISO 8601 format (Eg. 2023-08-18T14:00:00Z) in UTC.

Validations:

  • Must be a String
arrival_voyage_id
optional

container or breakbulk

Validations:

  • Must be a Integer
container_id
optional

Octopi ID of any container.

Validations:

  • Must be a Integer
page
optional

Specify which page of results to fetch. This value defaults to 1.

Validations:

  • Must be a Integer
per
optional

The number of container weights to be displayed. This value defaults to 10 and accepts a maximum of 100.

Validations:

  • Must be a Integer
>>>

GET /api/v1/container_weights/:id.json
Returns information about the container weight.

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/container_weights/ID.json' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

{
  "id": 123,
  "user": "John Doe",
  "container_id": 5281925,
  "container_number": "TEST7607347",
  "movement_id": 24491960,
  "declared_weight_kg": 40000,
  "verified_weight_kg": 40000,
  "reported_during": "Container Weight",
  "created_at": "2024-02-21T14:54:06.000-05:00",
  "event_created_at": "2024-02-21T14:55:06.000-05:00",
  "arrival_voyage_id": 123552,
  "arrival_voyage_number": "101S",
  "container_weight_receipt_url": "https://app.octopi.co/container_weights/123/print"
}

Params

Param name Description
id
required

Octopi ID of container weight.

Validations:

  • Must be a Integer