Loyalty API

Type

VotingStatus1

The customer's voting state: whether voting is available to them and the next question they can answer.

Kind Type
Used in CustomerBalance3, ListCustomers3, LoggedOutBalance1

Enablement and eligibility follow the same rules as the hosted loyalty page voting block: the voting feature must be enabled for the shop, the customer must have loyalty page access, and the customer must not be excluded from voting.

This is display data. The API has no call that records a vote.

Properties

  • enabled boolean required

    Whether voting is currently enabled and this customer is eligible to vote.

    When false, question is always null. Render a disabled or hidden voting section in this state.

  • daily_limit_reached boolean required

    Whether the customer has reached the shop's daily vote limit.

    Always false when the shop does not configure a daily vote limit. The next question may still be returned for display purposes, but the customer cannot cast another vote today.

  • question VotingQuestion1 required

    The next unanswered voting question for this customer.

    Explicitly null when no question is available: when voting is disabled or the customer is ineligible, or when the customer has already answered every visible question.

Previous
VotingQuestion1