Criar cupom
curl --request POST \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Cupom Exemplo",
"type": "flat_discount",
"value": 10,
"code": "CW10",
"active": true,
"minimum_order_value": 80,
"use_limit": 10,
"new_customers_only": false,
"customer_multi_use": false,
"availability_start_time": "10:00",
"availability_end_time": "17:00",
"available_days": [
"monday",
"tuesday",
"wednesday"
],
"available_from": "2024-07-01",
"expires_at": "2024-07-31",
"item_ids": [
1234
]
}
'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons"
payload = {
"name": "Cupom Exemplo",
"type": "flat_discount",
"value": 10,
"code": "CW10",
"active": True,
"minimum_order_value": 80,
"use_limit": 10,
"new_customers_only": False,
"customer_multi_use": False,
"availability_start_time": "10:00",
"availability_end_time": "17:00",
"available_days": ["monday", "tuesday", "wednesday"],
"available_from": "2024-07-01",
"expires_at": "2024-07-31",
"item_ids": [1234]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Cupom Exemplo',
type: 'flat_discount',
value: 10,
code: 'CW10',
active: true,
minimum_order_value: 80,
use_limit: 10,
new_customers_only: false,
customer_multi_use: false,
availability_start_time: '10:00',
availability_end_time: '17:00',
available_days: ['monday', 'tuesday', 'wednesday'],
available_from: '2024-07-01',
expires_at: '2024-07-31',
item_ids: [1234]
})
};
fetch('https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Cupom Exemplo',
'type' => 'flat_discount',
'value' => 10,
'code' => 'CW10',
'active' => true,
'minimum_order_value' => 80,
'use_limit' => 10,
'new_customers_only' => false,
'customer_multi_use' => false,
'availability_start_time' => '10:00',
'availability_end_time' => '17:00',
'available_days' => [
'monday',
'tuesday',
'wednesday'
],
'available_from' => '2024-07-01',
'expires_at' => '2024-07-31',
'item_ids' => [
1234
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons"
payload := strings.NewReader("{\n \"name\": \"Cupom Exemplo\",\n \"type\": \"flat_discount\",\n \"value\": 10,\n \"code\": \"CW10\",\n \"active\": true,\n \"minimum_order_value\": 80,\n \"use_limit\": 10,\n \"new_customers_only\": false,\n \"customer_multi_use\": false,\n \"availability_start_time\": \"10:00\",\n \"availability_end_time\": \"17:00\",\n \"available_days\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"available_from\": \"2024-07-01\",\n \"expires_at\": \"2024-07-31\",\n \"item_ids\": [\n 1234\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Cupom Exemplo\",\n \"type\": \"flat_discount\",\n \"value\": 10,\n \"code\": \"CW10\",\n \"active\": true,\n \"minimum_order_value\": 80,\n \"use_limit\": 10,\n \"new_customers_only\": false,\n \"customer_multi_use\": false,\n \"availability_start_time\": \"10:00\",\n \"availability_end_time\": \"17:00\",\n \"available_days\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"available_from\": \"2024-07-01\",\n \"expires_at\": \"2024-07-31\",\n \"item_ids\": [\n 1234\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Cupom Exemplo\",\n \"type\": \"flat_discount\",\n \"value\": 10,\n \"code\": \"CW10\",\n \"active\": true,\n \"minimum_order_value\": 80,\n \"use_limit\": 10,\n \"new_customers_only\": false,\n \"customer_multi_use\": false,\n \"availability_start_time\": \"10:00\",\n \"availability_end_time\": \"17:00\",\n \"available_days\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"available_from\": \"2024-07-01\",\n \"expires_at\": \"2024-07-31\",\n \"item_ids\": [\n 1234\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 12345,
"uid": "9ix",
"code": "CW10",
"name": "Cupom Exemplo",
"type": "flat_discount",
"value": 10,
"active": true,
"status": "valid",
"minimum_order_value": 80,
"use_limit": 10,
"new_customers_only": false,
"customer_multi_use": false,
"availability_start_time": "10:00",
"availability_end_time": "17:00",
"available_days": [
"monday",
"tuesday",
"wednesday"
],
"available_from": "2024-07-01",
"expires_at": "2024-07-31",
"item_ids": []
}{
"code": 4000,
"message": "Parâmetros inválidos",
"details": "updated_since não é uma data válida"
}{
"code": 4010,
"message": "Token inválido"
}This response has no body data.Cupons
Criar cupom
Criar um novo cupom para o estabelecimento.
POST
/
api
/
partner
/
v1
/
merchant
/
coupons
Criar cupom
curl --request POST \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Cupom Exemplo",
"type": "flat_discount",
"value": 10,
"code": "CW10",
"active": true,
"minimum_order_value": 80,
"use_limit": 10,
"new_customers_only": false,
"customer_multi_use": false,
"availability_start_time": "10:00",
"availability_end_time": "17:00",
"available_days": [
"monday",
"tuesday",
"wednesday"
],
"available_from": "2024-07-01",
"expires_at": "2024-07-31",
"item_ids": [
1234
]
}
'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons"
payload = {
"name": "Cupom Exemplo",
"type": "flat_discount",
"value": 10,
"code": "CW10",
"active": True,
"minimum_order_value": 80,
"use_limit": 10,
"new_customers_only": False,
"customer_multi_use": False,
"availability_start_time": "10:00",
"availability_end_time": "17:00",
"available_days": ["monday", "tuesday", "wednesday"],
"available_from": "2024-07-01",
"expires_at": "2024-07-31",
"item_ids": [1234]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Cupom Exemplo',
type: 'flat_discount',
value: 10,
code: 'CW10',
active: true,
minimum_order_value: 80,
use_limit: 10,
new_customers_only: false,
customer_multi_use: false,
availability_start_time: '10:00',
availability_end_time: '17:00',
available_days: ['monday', 'tuesday', 'wednesday'],
available_from: '2024-07-01',
expires_at: '2024-07-31',
item_ids: [1234]
})
};
fetch('https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Cupom Exemplo',
'type' => 'flat_discount',
'value' => 10,
'code' => 'CW10',
'active' => true,
'minimum_order_value' => 80,
'use_limit' => 10,
'new_customers_only' => false,
'customer_multi_use' => false,
'availability_start_time' => '10:00',
'availability_end_time' => '17:00',
'available_days' => [
'monday',
'tuesday',
'wednesday'
],
'available_from' => '2024-07-01',
'expires_at' => '2024-07-31',
'item_ids' => [
1234
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons"
payload := strings.NewReader("{\n \"name\": \"Cupom Exemplo\",\n \"type\": \"flat_discount\",\n \"value\": 10,\n \"code\": \"CW10\",\n \"active\": true,\n \"minimum_order_value\": 80,\n \"use_limit\": 10,\n \"new_customers_only\": false,\n \"customer_multi_use\": false,\n \"availability_start_time\": \"10:00\",\n \"availability_end_time\": \"17:00\",\n \"available_days\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"available_from\": \"2024-07-01\",\n \"expires_at\": \"2024-07-31\",\n \"item_ids\": [\n 1234\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Cupom Exemplo\",\n \"type\": \"flat_discount\",\n \"value\": 10,\n \"code\": \"CW10\",\n \"active\": true,\n \"minimum_order_value\": 80,\n \"use_limit\": 10,\n \"new_customers_only\": false,\n \"customer_multi_use\": false,\n \"availability_start_time\": \"10:00\",\n \"availability_end_time\": \"17:00\",\n \"available_days\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"available_from\": \"2024-07-01\",\n \"expires_at\": \"2024-07-31\",\n \"item_ids\": [\n 1234\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/merchant/coupons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Cupom Exemplo\",\n \"type\": \"flat_discount\",\n \"value\": 10,\n \"code\": \"CW10\",\n \"active\": true,\n \"minimum_order_value\": 80,\n \"use_limit\": 10,\n \"new_customers_only\": false,\n \"customer_multi_use\": false,\n \"availability_start_time\": \"10:00\",\n \"availability_end_time\": \"17:00\",\n \"available_days\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\"\n ],\n \"available_from\": \"2024-07-01\",\n \"expires_at\": \"2024-07-31\",\n \"item_ids\": [\n 1234\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 12345,
"uid": "9ix",
"code": "CW10",
"name": "Cupom Exemplo",
"type": "flat_discount",
"value": 10,
"active": true,
"status": "valid",
"minimum_order_value": 80,
"use_limit": 10,
"new_customers_only": false,
"customer_multi_use": false,
"availability_start_time": "10:00",
"availability_end_time": "17:00",
"available_days": [
"monday",
"tuesday",
"wednesday"
],
"available_from": "2024-07-01",
"expires_at": "2024-07-31",
"item_ids": []
}{
"code": 4000,
"message": "Parâmetros inválidos",
"details": "updated_since não é uma data válida"
}{
"code": 4010,
"message": "Token inválido"
}This response has no body data.Autorizações
bearerAuthapiKey
Access token OAuth 2.0 de app instalado na CW App Store. Escopos: store, customers, coupons, reviews.
Corpo
application/json
Estrutura do cupom
Nome do cupom. Essa informação fica visível para o cliente.
Tipo de cupom:
free_shipping: Entrega grátis.percent_discount: Desconto percentual no carrinho.flat_discount: Desconto fixo no carrinho.
Opções disponíveis:
free_shipping, percent_discount, flat_discount Exemplo:
"percent_discount"
Valor do desconto:
- Para
typeigual afree_shipping, esse campo será null. - Para
percent_discount, deve ser maior que 0 e menor ou igual a 100. - Para
flat_discount, deve ser maior que 0.
Código do Cupom. Nos cupons com código, o cliente deve informar o código durante a compra. Cupons sem código são visíveis e disponíveis para todos os clientes.
Indica se o cupom está ativo.
Valor mínimo do pedido que o cliente precisa alcançar para poder usar o cupom.
Indica o número máximo de vezes que o cupom pode ser usado.
Indica se o cupom é válido apenas para novos clientes.
Indica se um cliente pode usar o cupom mais de uma vez.
Define o horário a partir do qual o cupom estará disponível para uso. Segue o formato de 24 horas, indo de 00:00 a 23:59. Não inclui os segundos.
Define o horário até o qual o cupom estará disponível para uso. Segue o formato de 24 horas, indo de 00:00 a 23:59. Não inclui os segundos.
Especifique os dias da semana em que o cupom pode ser usado. Por padrão, o cupom é válido todos os dias da semana. Se o array estiver vazio, isso significa que o cupom está disponível todos os dias.
Required array length:
1 - 7 elementsOpções disponíveis:
sunday, monday, tuesday, wednesday, thursday, friday, saturday Disponibilidade do cupom por tipo de pedido:
delivery: disponível em pedidos de delivery.takeout: disponível em pedidos de retirada.onsite: disponível em pedidos de consumo no local. Por padrão, o cupom fica disponível para todos os tipos de pedido. Se o array estiver vazio, isso significa que o cupom está disponível para todos os tipos de pedidos.
Required array length:
1 - 3 elementsOpções disponíveis:
delivery, takeout, onsite Data a partir da qual o cupom está disponível para uso, iniciando à meia-noite (00:00) do dia indicado, no formato YYYY-MM-DD.
Data em que o cupom expira e não pode mais ser usado. O cupom é válido até 23:59 do dia especificado. Formato YYYY-MM-DD.
ID dos produtos aos quais o desconto será aplicado. Essa opção está disponível apenas quando type for igual a percent_discount.
Maximum array length:
30Resposta
Cupom criado com sucesso!
Estrutura do cupom
Nome do cupom. Essa informação fica visível para o cliente.
Tipo de cupom:
free_shipping: Entrega grátis.percent_discount: Desconto percentual no carrinho.flat_discount: Desconto fixo no carrinho.
Opções disponíveis:
free_shipping, percent_discount, flat_discount Exemplo:
"percent_discount"
Valor do desconto:
- Para
typeigual afree_shipping, esse campo será null. - Para
percent_discount, deve ser maior que 0 e menor ou igual a 100. - Para
flat_discount, deve ser maior que 0.
ID único do cupom
Identificador alfanumérico único do cupom, utilizado para a aplicação automática no site. Deve ser usado da seguinte forma: https://app.sandbox.cardapioweb.com/teste_integracao?cid={uid}
Código do Cupom. Nos cupons com código, o cliente deve informar o código durante a compra. Cupons sem código são visíveis e disponíveis para todos os clientes.
Indica se o cupom está ativo.
Status do cupom:
not_active: O cupom está inativo e não pode ser usado no momento.not_yet_available: O cupom ainda não está disponível para uso. Ver campoavailable_from.expired: O cupom expirou e não pode mais ser utilizado. Ver campoexpires_at.usage_limit_reached: O cupom atingiu o limite de uso permitido e não está mais disponível. Ver campouse_limit.not_available: O cupom não está disponível no momento. Ver camposavailability_start_time,availability_end_timeeavailable_days.valid: O cupom está ativo e pode ser utilizado.
Opções disponíveis:
not_active, not_yet_available, expired, usage_limit_reached, not_available, valid Valor mínimo do pedido que o cliente precisa alcançar para poder usar o cupom.
Indica o número máximo de vezes que o cupom pode ser usado.
Indica se o cupom é válido apenas para novos clientes.
Indica se um cliente pode usar o cupom mais de uma vez.
Define o horário a partir do qual o cupom estará disponível para uso. Segue o formato de 24 horas, indo de 00:00 a 23:59. Não inclui os segundos.
Define o horário até o qual o cupom estará disponível para uso. Segue o formato de 24 horas, indo de 00:00 a 23:59. Não inclui os segundos.
Especifique os dias da semana em que o cupom pode ser usado. Por padrão, o cupom é válido todos os dias da semana. Se o array estiver vazio, isso significa que o cupom está disponível todos os dias.
Required array length:
1 - 7 elementsOpções disponíveis:
sunday, monday, tuesday, wednesday, thursday, friday, saturday Disponibilidade do cupom por tipo de pedido:
delivery: disponível em pedidos de delivery.takeout: disponível em pedidos de retirada.onsite: disponível em pedidos de consumo no local. Por padrão, o cupom fica disponível para todos os tipos de pedido. Se o array estiver vazio, isso significa que o cupom está disponível para todos os tipos de pedidos.
Required array length:
1 - 3 elementsOpções disponíveis:
delivery, takeout, onsite Data a partir da qual o cupom está disponível para uso, iniciando à meia-noite (00:00) do dia indicado, no formato YYYY-MM-DD.
Data em que o cupom expira e não pode mais ser usado. O cupom é válido até 23:59 do dia especificado. Formato YYYY-MM-DD.
Produtos aos quais o desconto será aplicado. Essa opção está disponível apenas quando type for igual a percent_discount.
Maximum array length:
30Show child attributes
Show child attributes
Última modificação em 23 de setembro de 2026
Esta página foi útil?