Create a shopper
Create a shopper
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Phone number on file for the shopper, and what a loyalty member gives at checkout to be identified.
^\+[1-9]\d{1,14}$Email address on file for the shopper.
254Whether the shopper is enrolled in the loyalty program. Shoppers must explicitly opt into the loyalty program, typically at the POS. Digital gift card recipients are also stored as shoppers, but are only opted into the loyalty program after giving explicit permission.
Given name of the shopper.
Family name of the shopper.
Postal code on file for the shopper.
Response
A person a store can recognize at checkout, whether as a loyalty member or as the holder of a gift card. A shopper belongs to the banner rather than to any one store.
Unique identifier for the record.
When the record was created.
Email address on file for the shopper.
254Whether the shopper has confirmed their email address.
Whether the shopper is enrolled in the loyalty program. Shoppers must explicitly opt into the loyalty program, typically at the POS. Digital gift card recipients are also stored as shoppers, but are only opted into the loyalty program after giving explicit permission.
Given name of the shopper.
ID of the store where the shopper enrolled.
^[0-9]+$Family name of the shopper.
Phone number on file for the shopper, and what a loyalty member gives at checkout to be identified.
^\+[1-9]\d{1,14}$Loyalty points currently available to the shopper.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Postal code on file for the shopper.
Whether the shopper has opted in to marketing emails.
Whether the shopper has opted in to marketing text messages.
When the record was last changed.