Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/allShipments

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

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Query Parameters

• depotShipment(required): boolean
  Boolean value for looking for depot shipments.
• destinationId(required): string(uuid)
  String value for destination of shipment.
• 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.
• transactionId: string(uuid)
  String value for transaction ID of shipment.

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

Type: object

Title: ViewShipmentResponse

Contains shipments search result.

Show Source

• count: integer (int64)
  Total count of result
• hasMore: boolean
  Attribute describes if result set has more records

  Example: 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.

  Example: 400
• shipments: array Shipments
  Title: Shipments

  Shipments list.
• totalResults: integer (int64)
  Total number of entities in response

{
    "title":"ViewShipmentResponse",
    "type":"object",
    "properties":{
        "shipments":{
            "title":"Shipments",
            "type":"array",
            "description":"Shipments list.",
            "items":{
                "$ref":"#/components/schemas/ShipmentTO"
            }
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Attribute describes if result set has more records",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "example":400
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelLink"
            }
        }
    },
    "description":"Contains shipments search result."
}

Nested Schema : links

Type: array

Show Source

• Array of: object RelLink
  Object contains link detail.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelLink"
    }
}

Nested Schema : Shipments

Type: array

Title: Shipments

Shipments list.

Show Source

• Array of: object ShipmentTO
  Title: ShipmentTO

  Shipment details including site, depot, status, dates, and tracking info.

{
    "title":"Shipments",
    "type":"array",
    "description":"Shipments list.",
    "items":{
        "$ref":"#/components/schemas/ShipmentTO"
    }
}

Nested Schema : RelLink

Type: object

Object contains link detail.

Show Source

• href: string
  Realtive URL
• rel: string
  link

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link"
        },
        "href":{
            "type":"string",
            "description":"Realtive URL"
        }
    },
    "description":"Object contains link detail."
}

Nested Schema : ShipmentTO

Type: object

Title: ShipmentTO

Shipment details including site, depot, status, dates, and tracking info.

Show Source

• createdDate: string (date-time)
  Shipment creation date.

  Example: 2025-01-01T12:00:00Z
• depotId: string (uuid)
  Depot ID.

  Example: 00000000-0000-0000-0000-000000000002
• depotName: string
  Name of the depot.

  Example: Main Depot
• depotShortName: string
  Depot short name.

  Example: DEPOT-1
• shipDate: string (date-time)
  Ship date.

  Example: 2025-01-02T09:30:00Z
• shipmentId: string
  ID of the shipment.

  Example: SHIP-0001
• shipmentNumber: string
  Shipment number.

  Example: 00012345
• siteId: string (uuid)
  Site ID.

  Example: 00000000-0000-0000-0000-000000000001
• siteName: string
  Name of the site.

  Example: Site 001
• siteShortName: string
  Site short name.

  Example: S001
• statusId: integer (int32)
  Shipment status ID.

  Example: 1
• trackingNumber: string
  Shipment tracking number.

  Example: 1Z999AA10123456784
• trackingNumberURL: string (uri)
  URL for tracking the shipment.

  Example: https://carrier.example/track/1Z999AA10123456784

{
    "title":"ShipmentTO",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"SHIP-0001"
        },
        "siteId":{
            "type":"string",
            "description":"Site ID.",
            "format":"uuid",
            "example":"00000000-0000-0000-0000-000000000001"
        },
        "siteName":{
            "type":"string",
            "description":"Name of the site.",
            "example":"Site 001"
        },
        "siteShortName":{
            "type":"string",
            "description":"Site short name.",
            "example":"S001"
        },
        "depotId":{
            "type":"string",
            "description":"Depot ID.",
            "format":"uuid",
            "example":"00000000-0000-0000-0000-000000000002"
        },
        "depotName":{
            "type":"string",
            "description":"Name of the depot.",
            "example":"Main Depot"
        },
        "depotShortName":{
            "type":"string",
            "description":"Depot short name.",
            "example":"DEPOT-1"
        },
        "statusId":{
            "type":"integer",
            "description":"Shipment status ID.",
            "format":"int32",
            "example":1
        },
        "shipmentNumber":{
            "type":"string",
            "description":"Shipment number.",
            "example":"00012345"
        },
        "createdDate":{
            "type":"string",
            "description":"Shipment creation date.",
            "format":"date-time",
            "example":"2025-01-01T12:00:00Z"
        },
        "shipDate":{
            "type":"string",
            "description":"Ship date.",
            "format":"date-time",
            "example":"2025-01-02T09:30:00Z"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"1Z999AA10123456784"
        },
        "trackingNumberURL":{
            "type":"string",
            "description":"URL for tracking the shipment.",
            "format":"uri",
            "example":"https://carrier.example/track/1Z999AA10123456784"
        }
    },
    "description":"Shipment details including site, depot, status, dates, and tracking info."
}

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

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