SbPublicApiOrderHistorySummary

snowbee.SbPublicApiOrderHistorySummary

object · non-null

currencyIsoCodestringnon-nullrequired: ISO 4217 currency code
Example"NOK"
idstringnon-nullrequired: Example"01234567-89ab-cdef-0123-456789abcdef"
orderDatestringnon-nullrequired: Date the order was placed
Format: date
Example"2024-06-15"
orderNumberstringnon-nullrequired: Human-readable order number
Example"SO-2024-00123"
orderStatusstringnon-nullrequired: Current status of the order
Allowed values"PLANNED""CLOSED""RELEASED"
totalAmountstringnon-nullrequired: Total order amount including VAT
Format: BigDecimal
Pattern: ^-?\d+(\.\d{1,2})?$
Example"598.00"

View raw schema

{
  "type": "object",
  "properties": {
    "currencyIsoCode": {
      "type": "string",
      "description": "ISO 4217 currency code",
      "example": "NOK",
      "title": "String"
    },
    "id": {
      "type": "string",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "orderDate": {
      "type": "string",
      "format": "date",
      "description": "Date the order was placed",
      "example": "2024-06-15",
      "title": "LocalDate"
    },
    "orderNumber": {
      "type": "string",
      "description": "Human-readable order number",
      "example": "SO-2024-00123",
      "title": "String"
    },
    "orderStatus": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiOrderStatus",
      "description": "Current status of the order"
    },
    "totalAmount": {
      "type": "string",
      "format": "BigDecimal",
      "description": "Total order amount including VAT",
      "example": "598.00",
      "pattern": "^-?\\d+(\\.\\d{1,2})?$",
      "title": "BigDecimalAsString"
    }
  },
  "required": [
    "currencyIsoCode",
    "id",
    "orderDate",
    "orderNumber",
    "orderStatus",
    "totalAmount"
  ],
  "title": "SbPublicApiOrderHistorySummary"
}