POST /api/v1/truck_visits/:truck_visit_id/interchanges.json
Create an interchange for a truck visit.

Create an interchange for a truck visit.

Supported Formats

json

Errors

Code Description
404 Not found.
422 Unprocessable Entity.
500 Internal Server Error.
409 Entity conflict.

Examples

curl --location --request POST 'https://app.octopi.co/api/v1/truck_visits/1876441/interchanges.json'     --header 'Content-Type: application/json'     --data-raw '{
  "purpose": "drop_off_container",
  "container_number": "NYKU438409",
  "container_status": "full",
  "booking_number": "BOOK234234",
  "chassis_number": "CH1234"
  "export_release_number": "EXP123"
}'

    {
    "truck_visit_id": 1876441,
    "action_type": "interchange_in",
    "container_number": "CONZ1234674",
    "container_status": "full",
    "container_usage": 0,
    "container_has_damage": null,
    "container_vgm": null,
    "container_seal": null,
    "booking": "BOOKING12APR",
    "export_release": "EXP1",
    "bill_of_lading": null,
    "delivery_order": null,
    "chassis_number": "TESTCH-201",
    "chassis_weight": null,
    "genset": null,
    "genset_seal": null,
    "genset_fuel_level": null,
    "genset_has_reefer_compartment_seal": null,
    "genset_weight": null,
    "reefer_temperature": null,
    "reefer_temperature_unit": null,
    "reefer_set_point_temperature": null,
    "operating_reefer": false,
    "reefer_supply_temperature": null,
    "reefer_humidity": null,
    "reefer_ventilation": null,
    "scale_weight": null,
    "truck_weight": null,
    "completed_at": "2023-02-20T21:12:29.128+09:00",
    "work_queue_item": {
      "work_queue_item_id": 77,
      "work_queue_id": 1,
      "work_queue_name": "Terminal: South Terminal",
      "terminal_id": 1,
      "terminal_name": "South Terminal",
      "suggested_yard_slot": {
          "suggested_destination": "Heap 8828",
          "suggested_destination_yard_slot_id": 1,
          "suggested_destination_yard_slot_name": "Heap 8828",
          "suggested_yard_area_id": 1,
          "suggested_yard_area_name": "Heap 8828"
      },
      "completed_at": "2023-02-20T21:12:29.128+09:00"
  }
}

Params

Param name Description
truck_visit_id
required

Truck visit ID.

Validations:

  • Must be a Integer
purpose
required

Purpose of the interchange.

Validations:

  • Must be one of: drop_off_container, pick_up_container, drop_off_chassis, pick_up_chassis, drop_off_genset, pick_up_genset.
container_number
optional

Container number to create interchange.

Validations:

  • Must be a String
container_status
optional

Container status.

Validations:

  • Must be one of: full, empty.
booking_number
optional

Booking number for the interchange.

Validations:

  • Must be a String
chassis_number
optional

Chassis number.

Validations:

  • Must be a String
genset_number
optional

Genset number.

Validations:

  • Must be a String
export_release_number
optional

Export release number for the interchange.

Validations:

  • Must be a String
bill_of_lading_number
optional

Bill of lading number for the interchange.

Validations:

  • Must be a String
delivery_order_number
optional

Delivery order number for the interchange.

Validations:

  • Must be a String
completed_at
optional

The date and time at which interchange was completed, in ISO 8601 format (Eg 2023-04-13T14:30:00Z). Providing this value will create the interchange with a completed status.

Validations:

  • Must be a String