• count: integer (int32)
• hasMore: boolean
• limit: integer (int32)
• offset: integer (int32)
• resultData: object Shipments
  Shipment details object includes transactionId.
• shipments: array shipments
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "shipments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Shipments"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "resultData":{
            "$ref":"#/components/schemas/Shipments"
        }
    },
    "description":"Response object containing shipments."
}

• containsPooledkits: boolean
  contains Pooled kits

  Example: false
• createdDate: string (date-time)
  Shipment creation date
• destinationId: string (uuid)
  ID of the destination site or depot
• destinationName: string
  Name of the destination.

  Example: Site Houston
• destinationShortName: string
  destination Id.

  Example: st_hstn
• formInstanceId: string (uuid)
  Form instance id of non subject forms
• isDepotShipment: string
  Is depot shipment or site shipment

  Example: true
• orderType: string
  Type of order Manual or ressuply

  Example: Manual
• originId: string (uuid)
  Origin Id
• originName: string
  Name of the depot/site.

  Example: Depot Houston
• originShortName: string
  Origin Id.

  Example: dpt_hstn
• quarantineKitCount: number (Integer)
  Number of quarantined kits on a shipment

  Example: 10
• reconciliation: boolean
  Indicate if kit reconciliation is there.

  Example: true
• reportId: string (uuid)
  Report Id
• shipDate: string (date-time)
  Ship date.
• shipmentId: string
  ID of the shipment.

  Example: B1B8327AFAA6412287106192AB5984EF
• shipmentNumber: string
  Shipment number.

  Example: 123
• shippingAddress: string
  Primary Address or Shipping Address

  Example: Depot Houston, Houston
• statusId: number (Integer)
  Shipment status Id.

  Example: 5
• trackingNumber: string
  Shipment tracking number.

  Example: 12345
• trackingNumberURL: string
  Tracking url.

  Example: http://www.site.com
• transactionId: string (uuid)
  transactionId of shipments

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "destinationId":{
            "type":"string",
            "description":"ID  of the destination site or depot",
            "format":"uuid"
        },
        "destinationName":{
            "type":"string",
            "description":"Name of the destination.",
            "example":"Site Houston"
        },
        "destinationShortName":{
            "type":"string",
            "description":"destination Id.",
            "example":"st_hstn"
        },
        "originId":{
            "type":"string",
            "description":"Origin Id",
            "format":"uuid"
        },
        "originName":{
            "type":"string",
            "description":"Name of the depot/site.",
            "example":"Depot Houston"
        },
        "originShortName":{
            "type":"string",
            "description":"Origin Id.",
            "example":"dpt_hstn"
        },
        "statusId":{
            "type":"number",
            "description":"Shipment status Id.",
            "format":"Integer",
            "example":"5"
        },
        "shipmentNumber":{
            "type":"string",
            "description":"Shipment number.",
            "example":"123"
        },
        "createdDate":{
            "type":"string",
            "description":"Shipment creation date",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "description":"Ship date.",
            "format":"date-time"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "reportId":{
            "type":"string",
            "description":"Report Id",
            "format":"uuid"
        },
        "isDepotShipment":{
            "type":"string",
            "description":"Is depot shipment or site shipment",
            "example":"true"
        },
        "quarantineKitCount":{
            "type":"number",
            "description":"Number of quarantined kits on a shipment",
            "format":"Integer",
            "example":"10"
        },
        "orderType":{
            "type":"string",
            "description":"Type of order Manual or ressuply",
            "example":"Manual"
        },
        "shippingAddress":{
            "type":"string",
            "description":"Primary Address or Shipping Address",
            "example":"Depot Houston, Houston"
        },
        "containsPooledkits":{
            "type":"boolean",
            "description":"contains Pooled kits",
            "example":false
        },
        "formInstanceId":{
            "type":"string",
            "description":"Form instance id of non subject forms",
            "format":"uuid"
        },
        "transactionId":{
            "type":"string",
            "description":"transactionId of shipments",
            "format":"uuid"
        },
        "reconciliation":{
            "type":"boolean",
            "description":"Indicate if kit reconciliation is there.",
            "example":true
        },
        "trackingNumberURL":{
            "type":"string",
            "description":"Tracking url.",
            "example":"http://www.site.com"
        }
    },
    "description":"Shipment details object includes transactionId."
}

• Array of: object Shipments
  Shipment details object includes transactionId.

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

• 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"
        }
    }
}

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

• 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"
        }
    }
}

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}