Jump to

• Request
• Response

v8.0

get

/ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/shipments

Searches for shipments associated with a study by study ID. Rights: OrsInventoryGet, OrsUnblinded, BlindedDepot.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  B1B8327AFAA6412287106192AB5984EF

Query Parameters

• depotShipment(required): boolean
  Boolean value for looking for depot shipments.

  Example:

  true

• destinationId(required): string(uuid)
  String value for destination of shipment.

  Example:

  B1B8327AFAA6412287106192AB5984EF

• 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

• originId(required): string(uuid)
  String value for origin of shipment.

  Example:

  9B83BFB48C5A41C59775E4D8D22D8B26

• 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

• transactionId: string(uuid)
  String value for transaction ID of shipment.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ViewShipmentResponse v8.0

Type: object

Title: ViewShipmentResponse v8.0

Response containing shipment details.

Show Source

• count: integer (int32)
  Minimum Value: 0

  Number of results in the current page.

  Example: 25
• hasMore: boolean
  Indicates if there are more results beyond the current page.

  Example: true
• limit: integer (int32)
  Minimum Value: 1

  Maximum Value: 500

  Maximum number of records returned per page.

  Example: 50
• offset: integer (int32)
  Minimum Value: 0

  Index of the first record returned in the current page.

  Example: 0
• resultData: object Shipments v8.0
  Title: Shipments v8.0

  Shipment details object including compounding kits.
• shipments: array Shipments
  Title: Shipments

  List of shipments.
• totalResults: integer (int32)
  Minimum Value: 0

  Total number of results across all pages.

  Example: 125

{
    "title":"ViewShipmentResponse v8.0",
    "type":"object",
    "properties":{
        "shipments":{
            "title":"Shipments",
            "type":"array",
            "description":"List of shipments.",
            "items":{
                "$ref":"#/components/schemas/Shipments"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more results beyond the current page.",
            "example":true
        },
        "totalResults":{
            "minimum":0,
            "type":"integer",
            "description":"Total number of results across all pages.",
            "format":"int32",
            "example":125
        },
        "count":{
            "minimum":0,
            "type":"integer",
            "description":"Number of results in the current page.",
            "format":"int32",
            "example":25
        },
        "limit":{
            "maximum":500,
            "minimum":1,
            "type":"integer",
            "description":"Maximum number of records returned per page.",
            "format":"int32",
            "example":50
        },
        "offset":{
            "minimum":0,
            "type":"integer",
            "description":"Index of the first record returned in the current page.",
            "format":"int32",
            "example":0
        },
        "resultData":{
            "$ref":"#/components/schemas/Shipments"
        }
    },
    "description":"Response containing shipment details."
}

Nested Schema : Shipments v8.0

Type: object

Title: Shipments v8.0

Shipment details object including compounding kits.

Show Source

• compoundingKits: boolean
  Title: Compounding Kits

  Indicates whether the order contains compounding kits.

  Example: true
• containsPooledkits: boolean
  Title: Contains Pooled Kits

  Indicates whether the shipment contains pooled kits.

  Example: true
• createdDate: string (date-time)
  Shipment creation date.
• destinationId: string (uuid)
  Destination ID.
• destinationName: string
  Destination name.

  Example: Site Houston
• destinationShortName: string
  Destination short name.

  Example: st_hstn
• formInstanceId: string (uuid)
  Title: Form Instance ID

  Form instance identifier of non-subject forms.
• isDepotShipment: boolean
  Depot shipment indicator.

  Example: true
• orderType: string
  Order type (Manual or Resupply).

  Example: Manual
• originId: string (uuid)
  Origin ID.
• originName: string
  Origin name.

  Example: Depot Houston
• originShortName: string
  Origin short name.

  Example: dpt_hstn
• quarantineKitCount: number (Integer)
  Number of kits in quarantine on the shipment.

  Example: 10
• reconciliation: boolean
  Indicates whether kit reconciliation is included.

  Example: true
• reportId: string (uuid)
  Report ID.
• shipDate: string (date-time)
  Ship date.
• shipmentId: string
  Shipment ID.

  Example: B1B8327AFAA6412287106192AB5984EF
• shipmentNumber: string
  Shipment number.

  Example: 123
• shippingAddress: string
  Title: Shipping Address

  Primary or shipping address.

  Example: Depot Houston, Houston
• statusId: number (Integer)
  Shipment status ID.

  Example: 5
• trackingNumber: string
  Shipment tracking number.

  Example: 12345
• trackingNumberURL: string
  Tracking URL.

  Example: http://www.site.com
• transactionId: string (uuid)
  Title: Transaction ID

  Transaction identifier of shipments.

{
    "title":"Shipments v8.0",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "destinationId":{
            "type":"string",
            "description":"Destination ID.",
            "format":"uuid"
        },
        "destinationName":{
            "type":"string",
            "description":"Destination name.",
            "example":"Site Houston"
        },
        "destinationShortName":{
            "type":"string",
            "description":"Destination short name.",
            "example":"st_hstn"
        },
        "originId":{
            "type":"string",
            "description":"Origin ID.",
            "format":"uuid"
        },
        "originName":{
            "type":"string",
            "description":"Origin name.",
            "example":"Depot Houston"
        },
        "originShortName":{
            "type":"string",
            "description":"Origin short name.",
            "example":"dpt_hstn"
        },
        "statusId":{
            "type":"number",
            "description":"Shipment status ID.",
            "format":"Integer",
            "example":5
        },
        "shipmentNumber":{
            "type":"string",
            "description":"Shipment number.",
            "example":"123"
        },
        "createdDate":{
            "type":"string",
            "description":"Shipment creation date.",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "description":"Ship date.",
            "format":"date-time"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "reportId":{
            "type":"string",
            "description":"Report ID.",
            "format":"uuid"
        },
        "isDepotShipment":{
            "type":"boolean",
            "description":"Depot shipment indicator.",
            "example":true
        },
        "quarantineKitCount":{
            "type":"number",
            "description":"Number of kits in quarantine on the shipment.",
            "format":"Integer",
            "example":10
        },
        "orderType":{
            "type":"string",
            "description":"Order type (Manual or Resupply).",
            "example":"Manual"
        },
        "shippingAddress":{
            "title":"Shipping Address",
            "type":"string",
            "description":"Primary or shipping address.",
            "example":"Depot Houston, Houston"
        },
        "containsPooledkits":{
            "title":"Contains Pooled Kits",
            "type":"boolean",
            "description":"Indicates whether the shipment contains pooled kits.",
            "example":true
        },
        "formInstanceId":{
            "title":"Form Instance ID",
            "type":"string",
            "description":"Form instance identifier of non-subject forms.",
            "format":"uuid"
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"string",
            "description":"Transaction identifier of shipments.",
            "format":"uuid"
        },
        "compoundingKits":{
            "title":"Compounding Kits",
            "type":"boolean",
            "description":"Indicates whether the order contains compounding kits.",
            "example":true
        },
        "reconciliation":{
            "type":"boolean",
            "description":"Indicates whether kit reconciliation is included.",
            "example":true
        },
        "trackingNumberURL":{
            "type":"string",
            "description":"Tracking URL.",
            "example":"http://www.site.com"
        }
    },
    "description":"Shipment details object including compounding kits.",
    "example":[
        {
            "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A"
        }
    ]
}

Example:

[
    {
        "ruleId":"8E2253D8E53A4A46BAE3E4952CBE9E5A"
    }
]

Nested Schema : Shipments

Type: array

Title: Shipments

List of shipments.

Show Source

• Array of: object Shipments v8.0
  Title: Shipments v8.0

  Shipment details object including compounding kits.

{
    "title":"Shipments",
    "type":"array",
    "description":"List of shipments.",
    "items":{
        "$ref":"#/components/schemas/Shipments"
    }
}

Examples

Select an example Get Shipments Response

404 Response

'Invalid study ID', 'Study still in design phase'

Body ()

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

Select an example Not Found

500 Response

Internal server error

Body ()

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

Select an example Server Error

Back to Top