Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/service_orders/ORDER_NUMBER.json' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'
{
  "id": 6,
  "order_number": "SO120230928001",
  "due_at": "2023-09-29T05:32:00-04:00",
  "cargo_type": "breakbulk",
  "status": "partially_completed",
  "comment": "",
  "created_at": "2023-09-28T05:32:05-04:00",
  "ordered_by": "Kamalraj Matheswaran",
  "service_order_items": [
    {
      "id": 1,
      "container_id": 2388117,
      "status": "cancelled",
      "cancelled_at": "2023-10-25T03:23:15-04:00",
      "cancelled_by": "Kamalraj Matheswaran",
      "cancellation_reason": "This page is a service order document for Caribbean Port Services (CPS) with the ID SO120230928001. It provides details of the order including:\r\n\r\nThe key details are the service order ID, required date, and status. It also lists 3 order items and their service statuses.",
      "container_description": "2014 SUBARU FORESTER VIN# JF2SJAGC1EH400056",
      "service_type": "custom",
      "service_id": 723,
      "service_name": "Color Painting"
    },
    {
      "id": 2,
      "container_id": 2388117,
      "status": "completed",
      "completed_at": null,
      "completed_by": "Kamalraj Matheswaran",
      "container_description": "2014 SUBARU FORESTER VIN# JF2SJAGC1EH400056",
      "service_type": "custom",
      "service_id": 722,
      "service_name": "Test Service"
    },
    {
      "id": 32,
      "container_id": 2333777,
      "status": "completed",
      "completed_at": null,
      "completed_by": null,
      "container_description": "SLAC PERSONAL EFFECTCARGO MOVING INBOND UNDER T&E# 679876665POR: NDR#3DTHC COLLECT",
      "service_type": "custom",
      "service_id": 722,
      "service_name": "Test Service"
    }
  ]
}

Params

Param name Description
order_number
required

Octopi ID or the unique service order number given while creating one.

Validations:

  • Must be a String