Jump to

• Request
• Response

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

• mode(required): string
  Mode of the study, accepts: test, active, or training
• 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 : schema

Type: array

Show Source

• Array of: object OrderStatus
  Order status details object.

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

Nested Schema : OrderStatus

Type: object

Order status details object.

Show Source

• id: integer (int64)
  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
• status: string
  Allowed Values: [ "PENDING", "IN TRANSIT", "RECEIVED", "CANCELLED", "LOST", "CONFIRMED", "INVALID", "PENDING DESTRUCTION", "RECEIVED FOR DESTRUCTION", "DESTROYED", "QUARANTINED" ]

  Order status

  Example: PENDING

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"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).",
            "format":"int64",
            "example":"5",
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10"
            ]
        },
        "status":{
            "type":"string",
            "description":"Order status",
            "example":"PENDING",
            "enum":[
                "PENDING",
                "IN TRANSIT",
                "RECEIVED",
                "CANCELLED",
                "LOST",
                "CONFIRMED",
                "INVALID",
                "PENDING DESTRUCTION",
                "RECEIVED FOR DESTRUCTION",
                "DESTROYED",
                "QUARANTINED"
            ]
        }
    },
    "description":"Order status details 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