Search shipments for a study
get
/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments
Searches for shipments associated with a study by study ID. Rights: OrsInventoryGet, OrsUnblinded.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
Query Parameters
-
depotShipment(required): boolean
Boolean value for looking for depot shipments
-
destinationId(required): string(uuid)
String value for destination of shipment
-
limit: string
Maximum number of records to display per page.Default Value:
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. Offset is affected by the value of the order parameterDefault Value:
0
-
originId(required): string(uuid)
String value for origin of shipment
-
recon(required): boolean
Boolean value for recon
-
searchString(required): string
Search string
-
statusId(required): number
ID of the status
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ViewShipmentResponseV2
Type:
object
Response object containing shipments.
Show Source
-
count: integer
(int64)
Total count of result
-
hasMore: boolean
Attribute describes if result set has more recordsExample:
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. Offset is affected by the value of the order parameterExample:
400
-
shipments: array
shipments
-
totalResults: integer
(int64)
Total number of entities in response
Nested Schema : shipments
Type:
Show Source
array
-
Array of:
object ShipmentTOV2
Shipment details object.
Nested Schema : RelLink
Type:
object
Object contains link detail.
Show Source
-
href: string
Realtive URL
-
rel: string
link
Nested Schema : ShipmentTOV2
Type:
object
Shipment details object.
Show Source
-
createdDate: string
(date-time)
Shipment creation date
-
depotId: string
(uuid)
Depot Id
-
depotName: string
Name of the depot.Example:
Depot Houston
-
depotShortName: string
Depot Id.Example:
dpt_hstn
-
reconciliation: boolean
Indicate if kit reconciliation is there.Example:
true
-
reportId: string
(uuid)
Report Id
-
shipDate: string
(date-time)
Ship date.
-
shipmentId: string
ID of the shipment.Example:
B1B8327AFAA6412287106192AB5984EF
-
shipmentNumber: string
Shipment number.Example:
123
-
siteId: string
(uuid)
ID of the site
-
siteName: string
Name of the site.Example:
Site Houston
-
siteShortName: string
Site Id.Example:
st_hstn
-
statusId: integer
(int32)
Shipment status Id.Example:
5
-
trackingNumber: string
Shipment tracking number.Example:
12345
-
trackingNumberURL: string
Tracking url.Example:
http://www.site.com
404 Response
'Invalid study ID', 'Study still in design phase'
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object
500 Response
Internal server error
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object