GET /api/v1/appointments/:appointment_number

Returns information about a specific appointment.

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/appointments/OCTOAPPT129903" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"'

{
  "appointment_number": "OCTOAPPT129903",
  "appointment_slot_id": 299,
  "appointment_date": "2023-06-02",
  "appointment_timings": "06:30 PM - 07:30 PM",
  "status": "Completed",
  "truck": "TN01CH0007",
  "truck_driver": {
    "id": 1234,
    "fullname": "John Doe",
    "license_number": "N/A",
    "twic": "",
    "number": "633353",
    "active": true,
    "date_of_birth": null,
    "telephone_number": null,
    "email": null,
    "remarks": null,
    "trucking_company": "FAST DELIVERIES, INC",
    "allowed_until": null,
    "created_at": "2017-09-15T15:47:12Z",
    "updated_at": "2023-09-15T15:47:12Z"
  },
  "truck_visit": 24,
  "comment": "",
  "reschedule_reason": null,
  "purposes": [
    {
      "purpose_type": "pick_up",
      "cargo_type": "container",
      "cargo_status": "full",
      "cargo": "ABCZ120E127",
      "container_usage": "export",
      "booking": null,
      "bill_of_lading": null,
      "delivery_order": null
    },
    {
      "purpose_type": "drop_off",
      "cargo_type": "container",
      "cargo_status": "full",
      "cargo": "ABCZ120E385",
      "container_usage": "export",
      "booking": "RUNNINGBOOKING",
      "bill_of_lading": null,
      "delivery_order": null
    }
  ]
}

Params

Param name	Description
appointment_number required	The Appointment’s number. Validations: Must be a String