PATCH /api/v1/truck_visits/:truck_visit_id/interchanges/:id.json
Update an interchange's attributes.

This API endpoint allows you to update a pending interchange.

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/truck_visits/123/interchanges/12345.json" -X PATCH -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE
-d '{
  "container_number": "CON123456",
  "booking_number": "BOOK1234",
  "chassis_number": "CH1234",
  "genset_number": "GEN123",
  "export_release_number": "EXP123",
  "bill_of_lading_number":  null,
  "delivery_order_number":  null,
  "completed_at": "2023-06-28T21:12:29.128+09:00",
}'

{
  "id": 12345,
  "container_status": "full",
  "truck_visit_id": 123456,
  "complete": true,
  "completed_at": "2023-07-03T09:24:09-05:00",
  "for_container": true,
  "for_chassis": false,
  "for_genset": false,
  "type": "interchange_in",
  "container": {
    "id": 12345,
    "number": "CON123456",
    "status": "full",
    "has_damages": false,
    "is_reefer": false,
    "is_flatrack": false,
    "unlifted_holds_exist": false
  },
  "booking": {
    "id": 123456,
    "trucking_company_id": null,
    "is_runner": true,
    "booking_number": "111111",
    "voyage_number": null,
    "ship_name": null,
    "port_of_discharge": null,
    "port_of_loading": null,
    "port_of_delivery": null,
    "items": [],
    "all_items": []
  },
  "export_release": null,
  "interchange": null
}

Params

Param name	Description
id required	Interchange ID. Validations: Must be a String
truck_visit_id required	Truck visit ID. Validations: Must be a String
container_number optional	The container number used for the interchange. Validations: Must be a String
booking_number optional	The booking number used for the interchange. Validations: Must be a String
chassis_number optional	The chassis number used for the interchange. Validations: Must be a String
genset_number optional	The genset number used for the interchange. Validations: Must be a String
export_release_number optional	Export release number used for the interchange. Validations: Must be a String
bill_of_lading_number optional	Bill of lading number used for the interchange. Validations: Must be a String
delivery_order_number optional	Delivery order number used 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 update the interchange with a completed status. Validations: Must be a String