Skip to content

CustomerAttributeKind ​

Type: schema

Description ​

Who sets the attribute's values. custom: the store's own attribute, set by admins and, unless it is is_readonly, by shoppers in the storefront. linked: set from the customer's KYC document of the same type: the document number once it is approved, otherwise not_submitted, submitted or rejected. system: set by Commerce Engine, such as the campaign source of a shopper's first and latest visits (initial-utm-source, utm-source).

TypeScript Definition ​

typescript
CustomerAttributeKind: "custom" | "linked" | "system"

OpenAPI Schema ​

json
{
  "description": "Who sets the attribute's values. `custom`: the store's own attribute, set by admins and, unless it is `is_readonly`, by shoppers in the storefront. `linked`: set from the customer's KYC document of the same type: the document number once it is approved, otherwise `not_submitted`, `submitted` or `rejected`. `system`: set by Commerce Engine, such as the campaign source of a shopper's first and latest visits (`initial-utm-source`, `utm-source`).",
  "type": "string",
  "enum": [
    "custom",
    "linked",
    "system"
  ],
  "title": "CustomerAttributeKind"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: