Get order details by a shipment ID
get
/ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/orders/{shipmentId}
Retrieves an order's details by shipment ID. In this version, tempExcursionNumber is added to return temperature excursion number of the kit. Rights: OrsInventoryGet, OrsUnblinded.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
shipmentId(required): string
ID of the shipment.
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : OrdersInventoryDTO v7.0
Type:
object
Title:
OrdersInventoryDTO v7.0
Contains inventory order details.
Show Source
-
inventory: array
inventory
-
kitTypes: array
kitTypes
-
order: object
OrderDTO v5.0
Title:
OrderDTO v5.0
Contains order related details. -
version: integer
(int32)
Version.Example:
1
Nested Schema : inventory
Type:
Show Source
array
-
Array of:
object InventoryDTO v3.0
Title:
InventoryDTO v3.0
Contains kit details.
Nested Schema : kitTypes
Type:
Show Source
array
-
Array of:
object OrdersKitTypes
Orders Kit Types object for Pooling Supplies.
Nested Schema : OrderDTO v5.0
Type:
object
Title:
OrderDTO v5.0
Contains order related details.
Show Source
-
comment: string
commentExample:
Updated with new values
-
deliveryNumber: string
Delivery NumberExample:
Order123
-
depotId: string
(uuid)
Depot Id.
-
depotVersionStart: string
(date-time)
Depot version start.
-
includePooledShipments: boolean
includePooledShipmentsExample:
true
-
isDepotShipment: boolean
isDepotShipmentExample:
true
-
isReconciliation: boolean
isReconciliationExample:
true
-
jobInstanceId: string
(uuid)
Job instance Id.
-
objectVersionNumber: number
(double)
Software version NumberExample:
5
-
operationType: string
Allowed Values:
[ "CREATED", "MODIFIED", "REMOVED" ]
Operation type.Example:CREATED
-
orderDate: string
(date-time)
Date of order
-
orderId: string
(uuid)
Order Id.
-
orderStatusId: number
(double)
Order status Id.Example:
5
-
orderType: string
Allowed Values:
[ "INITIAL", "RESUPPLY", "MANUAL" ]
Order type.Example:MANUAL
-
orderTypeId: integer
(int64)
Order type Id.Example:
5
-
reason: string
reasonExample:
DATA ENTRY ERROR
-
reportId: string
(uuid)
report Id.
-
shipDate: string
(date-time)
Date of shipping.
-
shipmentId: string
ID of the shipment.Example:
123
-
shipmentReceiptDate: string
(date-time)
Shipment Receipt Date
-
shipmentReceivedById: string
(uuid)
Shipment received by ID
-
shippingAddress: string
Shipping AddressExample:
City,Country,Local Address
-
shippingAddressId: string
(uuid)
Shipping address ID
-
siteId: string
(uuid)
ID of the site
-
siteVersionStart: string
(date-time)
Site version start.
-
studyId: string
(uuid)
ID of the study
-
studyVersionStart: string
(date-time)
Study version start.
-
trackingNumber: string
Shipment tracking number.Example:
12345
-
trackingNumberUrl: string
Tracking number url.Example:
http://www.site.com
-
userId: string
(uuid)
User Id.
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
Nested Schema : InventoryDTO v3.0
Type:
object
Title:
InventoryDTO v3.0
Contains kit details.
Show Source
-
Block number: string
Block number.Example:
245
-
blocknumber: string
-
doNotCount: number
(double)
Do Not Count (DNC) Days.Example:
5
-
doNotShip: number
(double)
Do Not Ship (DNS) Days.Example:
5
-
expirationDate: string
(date-time)
Expiration date
-
inventoryId: string
(uuid)
Inventory Id.
-
inventorySourceId: string
(uuid)
Id of the Inventory
-
inventorySourceVersionStart: string
(date-time)
Inventory version start
-
inventoryStatusId: number
(double)
Allowed Values:
[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]
Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).Example:5
-
kitNumber: number
(double)
Kit number.Example:
5
-
kitNumberUTF: string
Kit number UTF8.Example:
24-1
-
kitTypeId: string
(uuid)
ID of the kit type.
-
kitTypeVersionStart: string
(date-time)
Kit type version start
-
labelGroupId: string
(uuid)
Label group Id.
-
labelGroupVersionStart: string
(date-time)
Label group version start
-
lotId: string
(uuid)
Lot Id.
-
lotVersionStart: string
(date-time)
Lot version start
-
sequenceNumber: number
(double)
Sequence nuumber.Example:
5
-
siteId: string
(uuid)
ID of the site
-
siteVersionStart: string
(date-time)
Site version start
-
tempExcursionNumber: string
Temperature excursion numberExample:
001
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
Nested Schema : OrdersKitTypes
Type:
object
Orders Kit Types object for Pooling Supplies.
Show Source
-
Comment: string
CommentExample:
test
-
id: string
(uuid)
Order Kit Type Id for Pooling Supplies
-
kitTypeSrcId: string
(uuid)
KitType source Id
-
lotId: string
(uuid)
Lot Id
-
minExpirationDate: string
(date-time)
Min Expiration date
-
MLot: string
Manufacturing LotExample:
MLOT
-
objectVersionNumber: number
-
Operation Type: string
Operation TypeExample:
modified
-
Pooled KitID: string
Pooled KitIDExample:
Pooled Kit01
-
quantity: number
(number)
Kit quantityExample:
5
-
Reason: string
ReasonExample:
test
-
softwareVersionNumber: number
-
UserId: string
(uuid)
User Id
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
500 Response
Internal server error
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object