GET /api/v1/appointments

Returns all the appointments present for a provided date.

Supported Formats

json

Errors

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

Examples

curl --location --request GET 'https://app.octopi.co/api/v1/appointments'     --header 'Authorization: Token token==ADD TOKEN HERE'     --header 'Content-Type: application/json'     --data-raw '{
  "appointment_date": "2023-08-18"
}'

{
  "appointments": [
    {
      "appointment_number": "OCTOAPPT1104501",
      "appointment_slot_id": 1045,
      "appointment_date": "2023-08-18",
      "appointment_timings": "01:00 PM - 02:00 PM",
      "status": "Pending",
      "truck": "TN01AN1982",
      "truck_driver": {
        "id": 1234,
        "fullname": "John Doe",
        "license_number": "LIDEW9784FY",
        "twic": "",
        "number": "633353",
        "active": true,
        "date_of_birth": null,
        "telephone_number": null,
        "email": null,
        "remarks": null,
        "trucking_company": "TruckingCo1",
        "allowed_until": null,
        "created_at": "2017-09-15T15:47:12Z",
        "updated_at": "2023-09-15T15:47:12Z"
      },
      "truck_visit": null,
      "comment": "",
      "reschedule_reason": null,
      "purposes": [
        {
          "purpose_type": "drop_off",
          "cargo_type": "container",
          "cargo_status": "full",
          "cargo": "CMAU2100410",
          "container_usage": null,
          "booking": "RUNNINGBOOKING",
          "bill_of_lading": "BOL1092719",
          "delivery_order": null
        }
      ]
    }
  ]
}

Params

Param name Description
appointment_date
required

Filter appointments for the provided date. Must be formatted as YYYY-MM-DD.

Validations:

  • Must be a String
appointment_number
optional

Filter appointments for a given appointment. You can pass the appointment Octopi ID or the appointment number.

Validations:

  • Must be a String
terminal
optional

Filter appointments for the provided Terminal Name. You can pass the terminal Octopi ID or the terminal name.

Validations:

  • Must be a String
container
optional

Filter appointments associated with a container. You can pass the container Octopi ID or the container number.

Validations:

  • Must be a String
truck
optional

Filter appointments associated with a truck. You can pass the truck Octopi ID or the truck’s license plate.

Validations:

  • Must be a String
bill_of_lading
optional

Filter appointments associated with a bill of lading. You can pass the bill of lading Octopi ID or the bill_of_lading number

Validations:

  • Must be a String
shipping_line
optional

Filter appointments associated with a shipping line. You can pass the shipping line Octopi ID or the shiping line’s name

Validations:

  • Must be a String
status
optional

Filter appointments for the given status

Validations:

  • Must be one of: pending, completed, cancelled.
booking
optional

Filter appointments associated with a booking. You can pass the booking Octopi ID or the booking number

Validations:

  • Must be a String
purpose
optional

Filter appointments for the provided purpose type

Validations:

  • Must be one of: drop_off, pick_up.
delivery_order
optional

Filter appointments associated with a delivery order. You can pass the delivery orde Octopi ID or the delivery orde number

Validations:

  • Must be a String
truck_driver
optional

Filter appointments associated with a truck driver. You can pass the truck driver Octopi ID or the truck driver’s license number

Validations:

  • Must be a String
page
optional

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

Validations:

  • Must be a Integer
per
optional

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

Validations:

  • Must be a Integer