# Lista de Promoções

Retorna uma lista das promoções.

Endpoint: GET /api/v3/promotions
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `name` (string)
    Filtra pelo nome da promoção.
    Example: "Promoção de Natal"

  - `type` (string)
    Filtra pelo tipo da promoção.
    Enum: "TAKE_MORE_PAY_LESS", "DISCOUNT_COUPON", "ABOVE_VALUE_GET_DISCOUNT", "ABOVE_AMOUNT_GET_DISCOUNT", "ABOVE_VALUE_GET_PRODUCT", "ABOVE_AMOUNT_GET_PRODUCT"

  - `status` (string)
    Filtra pelo status da promoção.
    Enum: "updating_vouchers", "awaiting_voucher_processing", "creating_vouchers", "processed"

  - `startDate` (string)
    Filtra por promoções com inicio de vigência a partir desta data.
    Example: "2025-02-01"

  - `end_date` (string)
    Filtra por promoções com fim de vigência até esta data.
    Example: "2025-03-01"

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

## Response 200 fields (application/json):

  - `data` (object)

  - `data.promotions` (array)
    Representa a lista de promoções

  - `data.promotions.id` (integer)
    Identificador único da promoção.
    Example: 76

  - `data.promotions.name` (string)
    Nome da promoção.
    Example: "Promoção de Natal"

  - `data.promotions.description` (string,null)
    Descrição da promoção.
    Example: "Leve 3 e pague 2"

  - `data.promotions.type` (string)
    Tipo da promoção.
    Enum: "TAKE_MORE_PAY_LESS", "DISCOUNT_COUPON", "ABOVE_VALUE_GET_DISCOUNT", "ABOVE_AMOUNT_GET_DISCOUNT", "ABOVE_VALUE_GET_PRODUCT", "ABOVE_AMOUNT_GET_PRODUCT"

  - `data.promotions.status` (string)
    Status da promoção.
    Enum: "updating_vouchers", "awaiting_voucher_processing", "creating_vouchers", "processed"

  - `data.promotions.start_date` (string)
    Data de início da promoção.
    Example: "2024-10-12"

  - `data.promotions.end_date` (string)
    Data de fim da promoção.
    Example: "2025-11-12"

  - `data.promotions.created_at` (string)
    Data da criação.
    Example: "2025-06-25T12:31:46.000000Z"

  - `data.promotions.updated_at` (string)
    Data da última atualização.
    Example: "2025-06-25T12:31:46.000000Z"

  - `data.promotions.deleted_at` (string)
    Data da exclusão.
    Example: "2025-06-25T12:31:46.000000Z"

  - `data.promotions.companies` (array)
    Lista de empresas participantes da promoção.

  - `data.promotions.companies.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `data.promotions.companies.name` (string)
    Nome fantasia da empresa.
    Example: "ConnectPlug"

  - `data.promotions.companies.company_name` (string,null)
    Razão social da empresa.
    Example: "ConnectPlug Desenvolvimento de Software LTDA"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.


## Response 401 fields

## Response 404 fields