Z
Zoppy Partners API

Clientes

/customers

Gerencie os clientes da sua loja. Clientes podem ter endereço, cupons e campos personalizados.

Modelo

Propriedade Tipo Descrição
idstring Obrigatório ID único do cliente (UUID)
externalIdstring Opcional ID do cliente no seu sistema/provedor
emailstring Opcional Email do cliente
phonestring | null Opcional Telefone do cliente: DDD + número, sem o 55 (10 dígitos para fixo, 11 para celular)
firstNamestring Obrigatório Primeiro nome
lastNamestring Obrigatório Sobrenome
birthDateDate | null Opcional Data de nascimento
genderstring | null Opcional Gênero, em maiúsculas (M, F)
positionstring | null Opcional Segmentação RFM (somente leitura). Valores: promising, loyal, sleeping, possible-loyal, at-risk
addressAddressResponse | null Opcional Endereço do cliente (id, address1, address2, city, state, postcode, country, latitude, longitude)
couponCouponResponse Opcional Cupom vinculado ao cliente
customFieldsCustomerCustomFieldResponse[] Opcional Campos personalizados do cliente
createdAtDate Obrigatório Data de criação
updatedAtDate Obrigatório Data de atualização

Endpoints