• kitTypes: array kitTypes
• shipmentId: string (uuid)
  Shipment Id.

{
    "title":"ShipmentKitsResponse v5.0",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment Id.",
            "format":"uuid"
        },
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.KitTypeSummaryV4"
            }
        }
    },
    "description":"Response object containing shipment kits details."
}

• Array of: object ShipmentKitsResponse.KitTypeSummary v4.0
  Title: ShipmentKitsResponse.KitTypeSummary v4.0

  Kit type summary details object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ShipmentKitsResponse.KitTypeSummaryV4"
    }
}

• description: string
  Kit type description.

  Example: Non dosing kit
• id: string (uuid)
  ID of the kit type.
• kits: array kits
• kitTypeName: string
  Kit type name.

  Example: Kit A
• kitTypeSrcId: string (uuid)
  ID of the kit.
• nsKits: array nsKits
• packageTypeId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

  Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

  Example: 5
• packageTypeKey: string
  Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

  Package type key.

  Example: INHALER
• unitsPerKit: number (double)
  Number of units perkit.

  Example: 5

{
    "title":"ShipmentKitsResponse.KitTypeSummary v4.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "description":{
            "type":"string",
            "description":"Kit type description.",
            "example":"Non dosing kit"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "packageTypeKey":{
            "type":"string",
            "description":"Package type key.",
            "example":"INHALER",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "unitsPerKit":{
            "type":"number",
            "description":"Number of units perkit.",
            "format":"double",
            "example":5
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"ID of the kit.",
            "format":"uuid"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.KitV5"
            }
        },
        "nsKits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.NonSerializedKitV5"
            }
        }
    },
    "description":"Kit type summary details object."
}

• Array of: object ShipmentKitsResponse.Kit v5.0
  Title: ShipmentKitsResponse.Kit v5.0

  Kit details object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ShipmentKitsResponse.KitV5"
    }
}

• Array of: object ShipmentKitsResponse.NonSerialized v5.0
  Title: ShipmentKitsResponse.NonSerialized v5.0

  Kit details object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ShipmentKitsResponse.NonSerializedKitV5"
    }
}

• barcode: string
  Barcode

  Example: Kit A
• depotReturnedUnits: number (double)
  Number of units returned to depot.

  Example: 5
• id: string (uuid)
  Kit Id.
• inventoryStatusId: number (double)
  Inventory statusId

  Example: 5
• itemNumber: string
  Item Number

  Example: ItemNumber0000001
• kitNumber: number (double)
  Kit number.

  Example: 5
• kitNumberUTF: string
  Kit number in utf-8

  Example: 12345
• materialId: string
  MaterialId Id

  Example: MaterialId0000001
• missingUnits: number (double)
  Missing units.

  Example: 5
• returnedUnits: number (double)
  Returned units.

  Example: 5
• sequenceNumber: number (double)
  Sequence number.

  Example: 5

{
    "title":"ShipmentKitsResponse.Kit v5.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Kit Id.",
            "format":"uuid"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":5
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"double",
            "example":5
        },
        "barcode":{
            "type":"string",
            "description":"Barcode",
            "example":"Kit A"
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned units.",
            "format":"double",
            "example":5
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing units.",
            "format":"double",
            "example":5
        },
        "depotReturnedUnits":{
            "type":"number",
            "description":"Number of units returned to depot.",
            "format":"double",
            "example":5
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Inventory statusId",
            "format":"double",
            "example":5
        },
        "materialId":{
            "type":"string",
            "description":"MaterialId Id",
            "example":"MaterialId0000001"
        },
        "itemNumber":{
            "type":"string",
            "description":"Item Number",
            "example":"ItemNumber0000001"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit number in utf-8",
            "example":"12345"
        }
    },
    "description":"Kit details object."
}

• id: string (uuid)
  NonSerialized lot Id.
• inventoryStatusId: number (double)
  Inventory statusId

  Example: 5
• Lot number: string
  Lot assigned to non serialized kits

  Example: Lot 1
• quantity: number
  Kit quantity

  Example: 1

{
    "title":"ShipmentKitsResponse.NonSerialized v5.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"NonSerialized lot Id.",
            "format":"uuid"
        },
        "Lot number":{
            "type":"string",
            "description":"Lot assigned to non serialized kits",
            "example":"Lot 1"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Inventory statusId",
            "format":"double",
            "example":5
        },
        "quantity":{
            "type":"number",
            "description":"Kit quantity",
            "example":1
        }
    },
    "description":"Kit details object."
}

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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"
        }
    }
}

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  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

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"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"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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"
        }
    }
}

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  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

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"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"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}