GET /api/v1/bookings/:number.json

The booking API endpoint allows querying for one booking.

Supported Formats

json

Errors

Code	Description
400	Bad Request.
404	Booking Not Found
500	Internal Server Error.

Examples

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

{
  "booking_number": "MYBOOKING123",
  "number_of_units": 2,
  "goods": "Soccer Balls and A piano",
  "ship_name": "CMA CGM BRAZIL",
  "status": "full",
  "shipping_line": {
      "id": 12345,
      "code": "UNKN",
      "name": "Unknown",
      "synonyms": [],
      "carrier_type": "ocean",
      "address": "",
      "empty_container_storage_teu_quota": null,
      "email": "",
      "contact_person": "",
      "phone": "",
      "receive_email_alerts_on_container_damages": false,
      "vat_number": "",
      "general_ledger_id": "",
      "dock_receipt_email": ""
  },
  "voyage_number": "0RT0SN1MA",
  "shipper": "Microsoft",
  "consignee": "APPLE",
  "port_of_loading": "USMIA",
  "port_of_discharge": "USPEF",
  "line_items": [
    {
      "container_number": "SUDU3253351",
      "container_type": "20DV",
      "line_item_number": 1,
      "description": "Soccer Balls",
      "weight": 10000.0,
      "weight_unit_code": "kg",
      "temperature": 0.0,
      "temperature_unit": "F",
      "reefer_ventilation": null,
      "reefer_humidity": null,
      "hazmat_classes": [

      ]
    },
    {
      "container_number": "AMFU8527917",
      "container_type": "45CT",
      "line_item_number": 2,
      "description": "A piano",
      "weight": 15000.0,
      "weight_unit_code": "kg",
      "temperature": null,
      "temperature_unit": null,
      "reefer_ventilation": null,
      "reefer_humidity": null,
      "hazmat_classes": [

      ]
    }
  ]
}