List available order status values

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipment-statuses

Retrieves a list of available order status values. Rights: OrsInventoryGet.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : OrderStatus
Type: object
Order status details object.
Show Source
  • Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
    Unique ID corresponding to each Order status value (1 for PENDING, 2 for IN TRANSIT, 3 for RECEIVED, 4 for CANCELLED, 5 for LOST, 6 for CONFIRMED, 7 for INVALID, 8 for PENDING DESTRUCTION, 9 for RECEIVED FOR DESTRUCTION, 10 for DESTROYED).
    Example: 5
  • Allowed Values: [ "PENDING", "IN TRANSIT", "RECEIVED", "CANCELLED", "LOST", "CONFIRMED", "INVALID", "PENDING DESTRUCTION", "RECEIVED FOR DESTRUCTION", "DESTROYED", "QUARANTINED" ]
    Order status
    Example: PENDING

500 Response

Internal server error
Body ()
Root Schema : DesignerResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Back to Top