YAyampi
Promoções - Cupons de desconto

Listar clientes que usaram o cupom

Retorna uma lista de clientes que usaram um cupom específico

get/{alias}/pricing/promocodes/{id}/customers

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}/customers
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do cupom

Response

Lista de clientes que usaram o cupom

idinteger

Identificador único do cliente.

merchant_idinteger

ID da loja à qual o cliente pertence.

marketplace_idinteger

ID do marketplace de origem do cliente, quando o cadastro vem de um marketplace.

activeboolean

Indica se o cliente está ativo.

typestring

Tipo de pessoa do cliente: f para pessoa física, j para pessoa jurídica.

cluster_idinteger

ID do cluster (grupo de clientes) ao qual o cliente está vinculado, quando houver.

namestring

Nome do cliente.

first_namestring

Primeiro nome do cliente, derivado de name.

last_namestring

Sobrenome do cliente, derivado de name.

generic_namestring

Nome de exibição do cliente: o name para pessoa física e a razao_social para pessoa jurídica.

cpfstring

CPF do cliente, para pessoa física.

razao_socialstring

Razão social do cliente, para pessoa jurídica.

cnpjstring

CNPJ do cliente, para pessoa jurídica.

state_registrationstring

Inscrição estadual do cliente, para pessoa jurídica.

emailstring email

E-mail do cliente.

passwordstring

Senha de acesso do cliente. Enviada apenas na criação ou atualização, nunca retornada.

birthdaystring date

Data de nascimento do cliente.

newsletterboolean

Indica se o cliente aceitou receber a newsletter da loja.

whatsappboolean

Indica se o cliente aceitou receber mensagens no WhatsApp.

social_driverstring

Provedor de login social usado no cadastro do cliente (ex.: Google, Facebook), quando aplicável.

social_idinteger

Identificador do cliente no provedor de login social, quando o cadastro veio de login social.

ipstring

Endereço IP do cliente no momento do cadastro.

tokenstring

Token único do cliente, usado para autenticá-lo em ações como login automático.

utm_sourcestring

Origem da campanha de marketing (parâmetro UTM utm_source) que originou o cadastro do cliente.

utm_campaignstring

Nome da campanha de marketing (parâmetro UTM utm_campaign) que originou o cadastro do cliente.

notesstring

Observações internas sobre o cliente.

login_urlstring uri

URL de login automático do cliente na loja, gerada a partir do seu token.

anonymizedboolean

Indica se os dados do cliente foram anonimizados por solicitação de exclusão (LGPD).

Example response

{
  "spreadsheet": {
    "data": {
      "phone": "(16) 98187-5668",
      "phone_number": "981875668",
      "phone_code": "16"
    }
  },
  "addresses": {
    "data": [
      {
        "created_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "updated_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        }
      }
    ]
  },
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.