SbPublicApiCustomerResponse

snowbee.SbPublicApiCustomerResponse

object · non-null

countryIsoCodestringnullableoptional

ISO 3166-1 alpha-2 country code

Example"NO"

customerNumberstringnullableoptional

Human-readable customer number

Example"CUST-10042"

deliveryAddressobjectnullableoptional

Customer's main delivery address

Show child fields

citystringnon-nullrequired: Example"Oslo"
countryIsoCodestringnon-nullrequired: ISO 3166-1 alpha-2 country code
Example"NO"
postCodestringnon-nullrequired: Example"0123"
streetstringnon-nullrequired: Street address including house number
Example"Storgata 1"

electronicReceiptbooleannon-nullrequired

Whether the customer wants electronic receipts

Exampletrue

emailstringnullableoptional

Example"ola.nordmann@example.com"

firstNamestringnullableoptional

Example"Ola"

idstringnon-nullrequired

Example"01234567-89ab-cdef-0123-456789abcdef"

invoiceAddressobjectnullableoptional

Customer's main invoice/billing address

Show child fields

citystringnon-nullrequired: Example"Oslo"
countryIsoCodestringnon-nullrequired: ISO 3166-1 alpha-2 country code
Example"NO"
postCodestringnon-nullrequired: Example"0123"
streetstringnon-nullrequired: Street address including house number
Example"Storgata 1"

languageIsoCodestringnullableoptional

ISO 639-2 language code

Example"NOR"

lastNamestringnullableoptional

Example"Nordmann"

loyaltyProgramCustomerIdstringnullableread-onlyoptional

Authoritative provider customer ID for this ecom store's configured loyalty program. Null if there is no configured program, no link, or the link is not ID-authoritative. Not proof of active membership. Read-only.

loyaltyProgramsarray of objectnon-nullrequired

List of loyalty programs and the customer's enrollment status

Show item fields

Loyalty program enrollment status for a customer

enrolledbooleannon-nullrequired: Whether the customer is enrolled in this loyalty program
Exampletrue
idstringnon-nullrequired: Unique identifier of the loyalty program
Example"01234567-89ab-cdef-0123-456789abcdef"
namestringnon-nullrequired: Example"Premium Members Club"

phonestringnullableoptional

Customer's phone number in E.164 format

Example"+4790123456"

View raw schema

{
  "type": "object",
  "properties": {
    "countryIsoCode": {
      "type": [
        "null",
        "string"
      ],
      "description": "ISO 3166-1 alpha-2 country code",
      "example": "NO",
      "title": "String"
    },
    "customerNumber": {
      "type": [
        "null",
        "string"
      ],
      "description": "Human-readable customer number",
      "example": "CUST-10042",
      "title": "String"
    },
    "deliveryAddress": {
      "description": "Customer's main delivery address",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.SbPublicApiCustomerAddressData"
        }
      ]
    },
    "electronicReceipt": {
      "type": "boolean",
      "description": "Whether the customer wants electronic receipts",
      "example": "true",
      "title": "Boolean"
    },
    "email": {
      "type": [
        "null",
        "string"
      ],
      "example": "ola.nordmann@example.com",
      "title": "String"
    },
    "firstName": {
      "type": [
        "null",
        "string"
      ],
      "example": "Ola",
      "title": "String"
    },
    "id": {
      "type": "string",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "invoiceAddress": {
      "description": "Customer's main invoice/billing address",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.SbPublicApiCustomerAddressData"
        }
      ]
    },
    "languageIsoCode": {
      "type": [
        "null",
        "string"
      ],
      "description": "ISO 639-2 language code",
      "example": "NOR",
      "title": "String"
    },
    "lastName": {
      "type": [
        "null",
        "string"
      ],
      "example": "Nordmann",
      "title": "String"
    },
    "loyaltyProgramCustomerId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Authoritative provider customer ID for this ecom store's configured loyalty program. Null if there is no configured program, no link, or the link is not ID-authoritative. Not proof of active membership. Read-only.",
      "readOnly": true,
      "title": "String"
    },
    "loyaltyPrograms": {
      "type": "array",
      "description": "List of loyalty programs and the customer's enrollment status",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiCustomerLoyaltyProgramResponse"
      },
      "title": "List<SbPublicApiCustomerLoyaltyProgramResponse>"
    },
    "phone": {
      "type": [
        "null",
        "string"
      ],
      "description": "Customer's phone number in E.164 format",
      "example": "+4790123456",
      "title": "String"
    }
  },
  "required": [
    "electronicReceipt",
    "id",
    "loyaltyPrograms"
  ],
  "title": "SbPublicApiCustomerResponse"
}