Skip to main content
POST
/
criarCupom
Criar cupom
curl --request POST \
  --url https://api-vendas.taximachine.com.br/api/integracao/criarCupom \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "gerador_cupom_id": 123,
  "codigo": "<string>",
  "data_hora_inicio": "2023-11-07T05:31:56Z",
  "data_hora_final": "2023-11-07T05:31:56Z",
  "limite_de_uso_individual": 123,
  "desconto": "<string>",
  "tipos_pagamentos": []
}
'
{
  "success": true,
  "response": {
    "codigo": "BLACK FRIDAY",
    "mensagem": "Cupom criado com sucesso"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

​
api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
​
gerador_cupom_id
integer
required

ID do gerador de cupons de que deve seguir o padrão.

​
codigo
string
required

Código do cupom.

​
data_hora_inicio
string<date-time>
required

Data hora do início da validade do cupom.

​
data_hora_final
string<date-time>
required

Data hora do fim da validade do cupom.

​
limite_de_uso
enum<string>
required

Quantidade de vezes que o cupom poderá ser utilizado, podendo ser: sem_limite, apenas_uma_vez, apenas_primeira_corrida, ate_n_vezes_por_passageiro.

Available options:
sem_limite,
apenas_uma_vez,
apenas_primeira_corrida,
ate_n_vezes_por_passageiro
​
limite_de_uso_individual
integer
required

Quantidade de vezes que o cupom pode ser utilizado, caso limite_de_uso seja ate_n_vezes_por_passageiro.

​
tipo_desconto
enum<string>
required

Tipo de desconto como percentual (percentual) ou valor fixo (valor_fixo).

Available options:
percentual,
valor_fixo
​
desconto
string
required

Valor do desconto que será aplicado no cupom.

​
tipos_pagamentos
enum<string>[]
required

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).

Available options:
D,
B,
C,
T,
V,
X,
P,
H,
A,
F,
I,
R

Response

200 - application/json

Sucesso

The response is of type object.