Show Source

• Array of: object OrderStatus
  Order status details object.

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

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

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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"
        }
    }
}

Show Source

• details: string
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

  Example: User role is missing required permission REPORTING_VIEW. Field: userId
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}