Jump to

• Request
• Response

Get shipment by shipment ID

get

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

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

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• shipmentId(required): string(uuid)
  ID of the shipment.
• studyId(required): string(uuid)
  ID of the study

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root 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

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "siteName":{
            "type":"string",
            "description":"Name of the site.",
            "example":"Site Houston"
        },
        "siteShortName":{
            "type":"string",
            "description":"Site Id.",
            "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 Id.",
            "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"
        },
        "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"
        },
        "reconciliation":{
            "type":"boolean",
            "description":"Indicate if kit reconciliation is there.",
            "example":true
        },
        "trackingNumberURL":{
            "type":"string",
            "description":"Tracking url.",
            "example":"http://www.site.com"
        }
    },
    "description":"Shipment details object."
}

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

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

Back to Top