Skip to content

UserAttributeValue ​

Type: schema

Description ​

A customer attribute with the customer's value for it.

TypeScript Definition ​

typescript
UserAttributeValue: {components["schemas"]["StorefrontAttribute"] & {
            /** @description The value, of the attribute's `attribute_type`
}

Component References ​

ReferenceResolves To
components["schemas"]["StorefrontAttribute"]StorefrontAttribute

OpenAPI Schema ​

json
{
  "title": "UserAttributeValue",
  "description": "A customer attribute with the customer's value for it.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/UserAttributeValue",
    "description": "API reference for the UserAttributeValue schema"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/StorefrontAttribute"
    },
    {
      "type": "object",
      "properties": {
        "value": {
          "description": "The value, of the attribute's `attribute_type`; `null` when none is set. A `linked` attribute's value is the document number once the document is approved, otherwise `not_submitted`, `submitted` or `rejected`.",
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            },
            {
              "type": "array"
            },
            {
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "updated_at": {
          "description": "When the value was last set; `null` when none is set.",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "required": [
        "value",
        "updated_at"
      ]
    }
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: