> ## Documentation Index
> Fetch the complete documentation index at: https://docs.machine.global/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar cupom

> Cria um novo cupom de desconto.



## OpenAPI

````yaml pages/v1/openapi-corridas.json POST /criarCupom
openapi: 3.1.0
info:
  title: API de Integração
  description: API de Integração v1
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api-vendas.taximachine.com.br/api/integracao
  - url: https://api.taximachine.com.br/api/integracao
security:
  - basicAuth: []
    ApiKeyAuth: []
paths:
  /criarCupom:
    post:
      summary: Criar cupom
      description: Cria um novo cupom de desconto.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - gerador_cupom_id
                - codigo
                - data_hora_inicio
                - data_hora_final
                - limite_de_uso
                - limite_de_uso_individual
                - tipo_desconto
                - desconto
                - tipos_pagamentos
              properties:
                gerador_cupom_id:
                  type: integer
                  description: ID do gerador de cupons de que deve seguir o padrão.
                codigo:
                  type: string
                  description: Código do cupom.
                data_hora_inicio:
                  type: string
                  format: date-time
                  description: Data hora do início da validade do cupom.
                data_hora_final:
                  type: string
                  format: date-time
                  description: Data hora do fim da validade do cupom.
                limite_de_uso:
                  type: string
                  description: >-
                    Quantidade de vezes que o cupom poderá ser utilizado,
                    podendo ser: sem_limite, apenas_uma_vez,
                    apenas_primeira_corrida, ate_n_vezes_por_passageiro.
                  enum:
                    - sem_limite
                    - apenas_uma_vez
                    - apenas_primeira_corrida
                    - ate_n_vezes_por_passageiro
                limite_de_uso_individual:
                  type: integer
                  description: >-
                    Quantidade de vezes que o cupom pode ser utilizado, caso
                    limite_de_uso seja ate_n_vezes_por_passageiro.
                tipo_desconto:
                  type: string
                  description: >-
                    Tipo de desconto como percentual (percentual) ou valor fixo
                    (valor_fixo).
                  enum:
                    - percentual
                    - valor_fixo
                desconto:
                  type: string
                  description: Valor do desconto que será aplicado no cupom.
                tipos_pagamentos:
                  type: array
                  description: >-
                    Tipos de pagamento em que o cupom irá se aplicar, valores
                    aceitos: Dinheiro (D), Débito (máquina) (B), Crédito máquina
                    (C), eTicket (T), Voucher (V), Pix (X), Picpay (P), Whatsapp
                    (H), Cartão via app (A), Faturado (F), Picpay (P), Pix via
                    app (I) e Carteira de Créditos (R).
                  items:
                    type: string
                    enum:
                      - D
                      - B
                      - C
                      - T
                      - V
                      - X
                      - P
                      - H
                      - A
                      - F
                      - I
                      - R
                cliente_ids:
                  type: array
                  description: >-
                    Opcional. Lista de ids dos clientes que poderão usar o cupom
                    criado.
                  items:
                    type: integer
                  example:
                    - 83983
                    - 83992
                    - 83959
                area_id:
                  type: integer
                  description: Opcional. Indica a área a qual o cupom será restrito.
                  example: 239
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
              example:
                success: true
                response:
                  codigo: BLACK FRIDAY
                  mensagem: Cupom criado com sucesso
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Obrigatório. Sua chave API.

````