Jump to

• Request
• Response

v3.0

get

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

Retrieves shipment by shipment ID. Rights: OrsInventoryGet, OrsUnblinded.

Request

Path Parameters

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

  Example:

  test

• shipmentId(required): string(uuid)
  ID of the shipment.

  Example:

  89EE76326E984B548D594D592E5C7FC2

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

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ShipmentTO v2.0

Type: object

Title: ShipmentTO v2.0

Shipment details object.

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
• 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 v2.0",
    "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"
        }
    },
    "description":"Shipment details object.",
    "example":{
        "shipmentId":"B1B8327AFAA6412287106192AB5984EF",
        "siteId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "siteName":"Site Houston",
        "siteShortName":"st_hstn",
        "depotId":"D313327EF13845169A8ADADDA435431E",
        "depotName":"Depot Houston",
        "depotShortName":"dpt_hstn",
        "statusId":5,
        "shipmentNumber":"123",
        "createdDate":"2026-02-21T06:30:00Z",
        "shipDate":"2026-02-21T06:45:00Z",
        "trackingNumber":"12345",
        "reconciliation":true,
        "reportId":"E39FF55A445543A38D513325664F0B2D",
        "trackingNumberURL":"http://www.site.com"
    }
}

Example:

{
    "shipmentId":"B1B8327AFAA6412287106192AB5984EF",
    "siteId":"C36A3197FDEE433FB5547EE83DE99E4B",
    "siteName":"Site Houston",
    "siteShortName":"st_hstn",
    "depotId":"D313327EF13845169A8ADADDA435431E",
    "depotName":"Depot Houston",
    "depotShortName":"dpt_hstn",
    "statusId":5,
    "shipmentNumber":"123",
    "createdDate":"2026-02-21T06:30:00Z",
    "shipDate":"2026-02-21T06:45:00Z",
    "trackingNumber":"12345",
    "reconciliation":true,
    "reportId":"E39FF55A445543A38D513325664F0B2D",
    "trackingNumberURL":"http://www.site.com"
}

Examples

Select an example Get Shipment Response

404 Response

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

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 Get Shipment Not Found Response

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 Get Shipment Server Error Response

Back to Top