---
title: "Listar clientes que usaram o cupom"
method: GET
path: "/{alias}/pricing/promocodes/{id}/customers"
tags: ["Promoções - Cupons de desconto"]
---

# Listar clientes que usaram o cupom

`GET /{alias}/pricing/promocodes/{id}/customers`

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

## Path parameters

- `alias` string, required
- `id` integer, required

## Response `200`

Lista de clientes que usaram o cupom

- PromocodeCustomer
  - `id` integer
  - `merchant_id` integer
  - `marketplace_id` integer
  - `active` boolean
  - `type` string
  - `cluster_id` integer
  - `name` string
  - `first_name` string
  - `last_name` string
  - `generic_name` string
  - `cpf` string
  - `spreadsheet` object
    - `data` object
      - `brands` string
      - `city` string
      - `purchased_brands` string
      - `last_order_date` object
        - `date` string, date-time
        - `timezone_type` integer
        - `timezone` string
      - `last_order_value` string
      - `purchased_categories` string
      - `number` string
      - `uf` string
      - `phone` string
      - `street` string
      - `phone_number` string
      - `categories` string
      - `neighborhood` string
      - `complement` string
      - `phone_code` string
  - `phone` object
    - `area_code` string — Código de área do telefone
    - `full_number` string — Número do telefone
    - `number` string — Número do telefone
    - `formated_number` string — Número do telefone formatado
    - `whatsapp_link` string, uri
  - `razao_social` string
  - `cnpj` string
  - `state_registration` string
  - `email` string, email
  - `password` string
  - `birthday` string, date
  - `newsletter` boolean
  - `whatsapp` boolean
  - `social_driver` string
  - `social_id` integer
  - `ip` string
  - `token` string
  - `utm_source` string
  - `utm_campaign` string
  - `notes` string
  - `login_url` string, uri
  - `anonymized` boolean
  - `deletion_request` object
    - `data` object
      - `pending_confirmation` boolean
      - `scheduled_date` string, date
  - `addresses` object
    - `data` object[]
      - `receiver` string
      - `city` string
      - `full_address` string
      - `zip_code` string
      - `number` string
      - `uf` string
      - `street` string
      - `id` integer
      - `neighborhood` string
      - `customer_id` integer
      - `complement` string
      - `created_at` BaseTimestamp
        - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
        - `timezone_type` integer — Número de representação do timezone.
        - `timezone` string — Fuso horário associado.
      - `updated_at` BaseTimestamp
        - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
        - `timezone_type` integer — Número de representação do timezone.
        - `timezone` string — Fuso horário associado.
  - `created_at` BaseTimestamp
    - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer — Número de representação do timezone.
    - `timezone` string — Fuso horário associado.
  - `updated_at` BaseTimestamp
    - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer — Número de representação do timezone.
    - `timezone` string — Fuso horário associado.

## Other responses

- `404` — Cupom não encontrado

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/revisions/fa16c50bef09/schema)