Supported Formats

json

Errors

Code Description
404 Not found
500 Server crashed for some reason

Examples

curl -v -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token token=YOURTOKEN" \
  "https://app.octopi.co/api/v1/work_queues/WORK_QUEUE_ID/work_queue_items.json" \
  -d '{ "work_queue_item": {"container_number": "ABCD123", "destination_type": "YardArea", "destination_id": 450 }}'
{
  "work_queue_item": {
    "id": 2379116,
    "claimed_by_id": null,
    "claimed_at": null,
    "work_queue_id": 123,
    "completed_by_id": null,
    "completed_at": null,
    "container_id": 2260766,
    "source_id": 94,
    "source_type": "Terminal",
    "destination_id": 450,
    "destination_type": "YardArea",
    "created_at": "2022-01-24T05:12:06.399-05:00",
    "updated_at": "2022-01-24T05:12:06.399-05:00",
    "truck_visit_id": null,
    "destination_yard_slot_id": null,
    "voyage_id": null,
    "tallied_cargo_id": null,
    "yard_slot_custom_name": null,
    "interchange_id": null,
    "work_queue_lift_type_id": null,
    "stripped_tallied_cargo_id": null,
    "destination_second_yard_slot_id": null,
    "second_yard_slot_custom_name": null,
    "equipment_id": null,
    "remarks": null,
    "container_status": "full",
    "claimed_by_name": null,
    "container_number": "ABCD123",
    "container_type": "40CT",
    "container_length": 40,
    "container_shipping_line": "MAERSK",
    "container_notes": null,
    "container_display_name": "ABCD123",
    "container_has_unlifted_holds": false,
    "container_delivery_type": null,
    "container_consignees": "Consignee: ARUBA",
    "container_bol_container_count": null,
    "source_yard_slot_name": "",
    "source_name": "South Terminal",
    "destination_name": "Warehouse Yard Area",
    "truck_visit": "",
    "voyage": "",
    "tallied_cargo": "",
    "container_usage": "export",
    "container_POD": null,
    "has_unfinished_interchange": false,
    "require_interchange_to_claim_work_queues": true,
    "suggested_destination": "",
    "suggested_destination_yard_slot_id": "",
    "suggested_destination_yard_slot_name": "",
    "comment": ""
  }
}

Params

Param name Description
work_queue_id
required

Validations:

  • Must be a String

container_number
required

Validations:

  • Must be a String

destination_type
required

Validations:

  • Must be a String

destination_id
required

Validations:

  • Must be a String