REST API for Clinical One Cloud Service

v3.0

get

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments

Searches for shipments associated with a site by site ID. This version includes a new field in the response: formInstanceId.
Rights: OrsSupplyManagerGet and OrsBlinded.

Request

Path Parameters

mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.
Example:
```
test
```
siteId(required): string(uuid)
Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
9B83BFB48C5A41C59775E4D8D22D8B26
```
studyId(required): string(uuid)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
1BC29B36F5D64B1B95F4BDBBCEA481BE
```

Query Parameters

limit: string
Maximum number of records to display per page.

Default Value: 100
Example:
```
100
```
offset: string
An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

Default Value: 0
Example:
```
0
```
recon(required): boolean
Boolean value for recon.
Example:
```
false
```
searchString(required): string
Search string.
Example:
```
SHIP
```
statusId(required): number
ID of the status.
Example:
```
1
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : ViewShipmentResponse

Type: object

Title: ViewShipmentResponse

Contains shipments search result.

Show Source

count: integer (int64)

Total count of result
hasMore: boolean

Attribute describes if result set has more records

Example: true
limit: integer (int64)

Maximum number of records to display per page.
links: array links
offset: integer (int64)

An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

Example: 400
shipments: array Shipments

Title: Shipments

Shipments list.
totalResults: integer (int64)

Total number of entities in response

{
    "title":"ViewShipmentResponse",
    "type":"object",
    "properties":{
        "shipments":{
            "title":"Shipments",
            "type":"array",
            "description":"Shipments list.",
            "example":[
                {
                    "shipmentId":"B1B8327AFAA6412287106192AB5984EF",
                    "siteId":"C36A3197FDEE433FB5547EE83DE99E4B",
                    "siteName":"Site Houston",
                    "shipmentNumber":"123",
                    "statusId":5
                }
            ],
            "items":{
                "$ref":"#/components/schemas/ShipmentTOV3"
            }
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Attribute describes if result set has more records",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.",
            "format":"int64",
            "example":400
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelLink"
            }
        }
    },
    "description":"Contains shipments search result."
}

Nested Schema : links

Type: array

Show Source

Array of: object RelLink

Object contains link detail.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelLink"
    }
}

Nested Schema : Shipments

Type: array

Title: Shipments

Shipments list.

Show Source

Array of: object ShipmentTO

Title: ShipmentTO

Shipment details including site, depot, status, dates, and tracking info.

{
    "title":"Shipments",
    "type":"array",
    "description":"Shipments list.",
    "example":[
        {
            "shipmentId":"B1B8327AFAA6412287106192AB5984EF",
            "siteId":"C36A3197FDEE433FB5547EE83DE99E4B",
            "siteName":"Site Houston",
            "shipmentNumber":"123",
            "statusId":5
        }
    ],
    "items":{
        "$ref":"#/components/schemas/ShipmentTOV3"
    }
}

Example:

[
    {
        "shipmentId":"B1B8327AFAA6412287106192AB5984EF",
        "siteId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "siteName":"Site Houston",
        "shipmentNumber":"123",
        "statusId":5
    }
]

Nested Schema : RelLink

Type: object

Object contains link detail.

Show Source

href: string

Realtive URL
rel: string

link

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link"
        },
        "href":{
            "type":"string",
            "description":"Realtive URL"
        }
    },
    "description":"Object contains link detail."
}

Nested Schema : ShipmentTO

Type: object

Title: ShipmentTO

Shipment details including site, depot, status, dates, and tracking info.

Show Source

createdDate: string (date-time)

Shipment creation date.

Example: 2026-02-21T06:30:00Z
depotId: string (uuid)

Depot ID.
depotName: string

Name of the depot.

Example: Depot Houston
depotShortName: string

Depot short name.

Example: dpt_hstn
formInstanceId: string (uuid)

Title: Form ID

Identifier of the form associated with the resupply.

Example: 00d48a2a-7280-1a4e-e063-0100007f3af8
reconciliation: boolean

Indicates whether the shipment is for kit reconciliation.

Example: true
reportId: string (uuid)

Report Id
shipDate: string (date-time)

Ship date.

Example: 2026-02-21T06:45:00Z
shipmentId: string

ID of the shipment.

Example: B1B8327AFAA6412287106192AB5984EF
shipmentNumber: string

Shipment number.

Example: 123
siteId: string (uuid)

Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
siteName: string

Name of the site.

Example: Site Houston
siteShortName: string

Site short name.

Example: st_hstn
statusId: integer (int32)

Shipment status ID.

Example: 5
trackingNumber: string

Shipment tracking number.

Example: 12345
trackingNumberURL: string

URL for tracking the shipment.

Example: http://www.site.com

{
    "title":"ShipmentTO",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"uuid"
        },
        "siteName":{
            "type":"string",
            "description":"Name of the site.",
            "example":"Site Houston"
        },
        "siteShortName":{
            "type":"string",
            "description":"Site short name.",
            "example":"st_hstn"
        },
        "depotId":{
            "type":"string",
            "description":"Depot ID.",
            "format":"uuid"
        },
        "depotName":{
            "type":"string",
            "description":"Name of the depot.",
            "example":"Depot Houston"
        },
        "depotShortName":{
            "type":"string",
            "description":"Depot short name.",
            "example":"dpt_hstn"
        },
        "statusId":{
            "type":"integer",
            "description":"Shipment status ID.",
            "format":"int32",
            "example":5
        },
        "shipmentNumber":{
            "type":"string",
            "description":"Shipment number.",
            "example":"123"
        },
        "createdDate":{
            "type":"string",
            "description":"Shipment creation date.",
            "format":"date-time",
            "example":"2026-02-21T06:30:00Z"
        },
        "shipDate":{
            "type":"string",
            "description":"Ship date.",
            "format":"date-time",
            "example":"2026-02-21T06:45:00Z"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "reportId":{
            "type":"string",
            "description":"Report Id",
            "format":"uuid"
        },
        "reconciliation":{
            "type":"boolean",
            "description":"Indicates whether the shipment is for kit reconciliation.",
            "example":true
        },
        "trackingNumberURL":{
            "type":"string",
            "description":"URL for tracking the shipment.",
            "example":"http://www.site.com"
        },
        "formInstanceId":{
            "title":"Form ID",
            "type":"string",
            "description":"Identifier of the form associated with the resupply.",
            "format":"uuid",
            "example":"00d48a2a-7280-1a4e-e063-0100007f3af8"
        }
    },
    "description":"Shipment details including site, depot, status, dates, and tracking info.",
    "example":{
        "shipmentId":"B1B8327AFAA6412287106192AB5984EF",
        "siteId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "siteName":"Site Houston",
        "shipmentNumber":"123",
        "statusId":5
    }
}

Example:

{
    "shipmentId":"B1B8327AFAA6412287106192AB5984EF",
    "siteId":"C36A3197FDEE433FB5547EE83DE99E4B",
    "siteName":"Site Houston",
    "shipmentNumber":"123",
    "statusId":5
}

Examples

404 Response

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid site ID'

Root Schema : DesignerResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Examples

500 Response

Internal server error

Root Schema : DesignerResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Examples