Terminal service can be applied to general cargo. It also can have a custom value and record of start and end times.

Supported Formats

json

GET /api/v1/general_cargoes/:general_cargo_id/terminal_services.json

Returns a list of terminal services applied to the cargo.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Not found.
500 Server crashed for some reason.

Examples

curl "https://app.octopi.co/api/v1/general_cargoes/:general_cargo_id/terminal_services.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=TOKEN"
{
  "actions": {
      "index": {
          "method": "GET",
          "url": "https://app.octopi.co/api/v1/general_cargoes/:id/terminal_services"
      }
  },
  "terminal_services": [
      {
          "name": "AQI 20' Full Strip MAX",
          "description": "AQI 20' Full Strip MAX",
          "custom_value": {
            "type_name": "number",
            "name": "Count",
            "short_name": "ANBPLS",
            "value": "28.0"
          },
          "started_at": "2021-12-28T13:59:00-05:00",
          "ended_at": "2022-01-25T14:00:00-05:00"
      }
  ]
}

Params

Param name Description
container_number
required

Validations:

  • Must be a String