Jump to

• Request
• Response

[Deprecated]: v1.0

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits

Deprecated: Use latest version instead. Updates the status of a received kit in the system. Rights: OrsSupplyManagerPost and OrsBlinded.

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:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Shipment Update Kits Request

Type: object

Title: Shipment Update Kits Request

Request object containing shipment kits to be updated.

Show Source

• kits(required): array kits
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Contains kit IDs.
• toInventoryStatus(required): integer (int32)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]

  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 5

{
    "title":"Shipment Update Kits Request",
    "required":[
        "kits",
        "toInventoryStatus"
    ],
    "type":"object",
    "properties":{
        "kits":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "description":"Contains kit IDs.",
            "example":[
                "E39FF55A445543A38D513325664F0B2D",
                "8ECE2C9D389645B09740DC7926DEFB69"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "toInventoryStatus":{
            "type":"integer",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"int32",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        }
    },
    "description":"Request object containing shipment kits to be updated."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Contains kit IDs.

Show Source

• Array of: string(uuid)

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "description":"Contains kit IDs.",
    "example":[
        "E39FF55A445543A38D513325664F0B2D",
        "8ECE2C9D389645B09740DC7926DEFB69"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "E39FF55A445543A38D513325664F0B2D",
    "8ECE2C9D389645B09740DC7926DEFB69"
]

Examples

Select an example Update Received Kits Status Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ShipmentReceivedResponse

Type: object

Title: ShipmentReceivedResponse

Received shipment details response object.

Show Source

• availableCount: integer (int64)
  Available kits count.

  Example: 5
• damagedCount: integer (int64)
  Damaged kits count.

  Example: 5
• missingCount: integer (int64)
  Missing kits count.

  Example: 5
• preQuarantinedCount: integer (int64)
  Pre quarantined kits count.

  Example: 5
• receivedDate: string (date-time)
  Shipment received date.

  Example: 2026-02-21T06:30:00Z
• shipmentId: string (uuid)
  ID of the shipment.

{
    "title":"ShipmentReceivedResponse",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "receivedDate":{
            "type":"string",
            "description":"Shipment received date.",
            "format":"date-time",
            "example":"2026-02-21T06:30:00Z"
        },
        "damagedCount":{
            "type":"integer",
            "description":"Damaged kits count.",
            "format":"int64",
            "example":5
        },
        "missingCount":{
            "type":"integer",
            "description":"Missing kits count.",
            "format":"int64",
            "example":5
        },
        "preQuarantinedCount":{
            "type":"integer",
            "description":"Pre quarantined kits count.",
            "format":"int64",
            "example":5
        },
        "availableCount":{
            "type":"integer",
            "description":"Available kits count.",
            "format":"int64",
            "example":5
        }
    },
    "description":"Received shipment details response object."
}

Examples

Select an example Update Received Kits Status Response

400 Response

'Invalid order status', 'Invalid kit', 'Invalid inventory status value'

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Bad Request Response

404 Response

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid shipment ID'

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Server Error Response

Back to Top