curl --request GET \
--url https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id} \
--header 'User-Secret-Key: <api-key>' \
--header 'User-Token: <api-key>'import requests
url = "https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}"
headers = {
"User-Token": "<api-key>",
"User-Secret-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'User-Token': '<api-key>', 'User-Secret-Key': '<api-key>'}
};
fetch('https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}', 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://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"User-Secret-Key: <api-key>",
"User-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("User-Token", "<api-key>")
req.Header.Add("User-Secret-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}")
.header("User-Token", "<api-key>")
.header("User-Secret-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["User-Token"] = '<api-key>'
request["User-Secret-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 123,
"code": "TEST",
"description": "",
"customer_id": 123,
"active": true,
"expired": true,
"discount_type": "p",
"for_the_price_of": true,
"cart_default": true,
"type_increment_value": "",
"value": 10,
"price_products": 123,
"percent_products": 123,
"quantity": "100000",
"total_customers_used": "22",
"product_quantity": 123,
"product_max_quantity": 123,
"used": 22,
"items_count": 123,
"min_value": 99.99,
"use_percent": 0.02,
"shipment_percent": 123,
"accumulate": true,
"once_per_customer": true,
"abandoned_cart": true,
"newsletter": true,
"payments_ids": "[1, 2, 3, 4]",
"free_shipment": true,
"ignore_promotion_products": true,
"freebie_id": 123,
"advertise": true,
"start_at": {
"date": "2000-08-17 10:24:24",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"end_at": {
"date": "2000-08-17 10:24:24",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"created_at": {
"date": "2000-08-17 10:24:24",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"updated_at": {
"date": "2000-08-17 10:24:24",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"include": {
"products_ids": "[987, 654, 456, 321, 123]",
"brands_ids": "[]",
"collections_ids": "[]",
"categories_ids": "[]"
},
"exclude": {
"products_ids": "[123, 321]",
"brands_ids": "[]",
"collections_ids": "[]",
"categories_ids": "[]"
},
"include_ids": "[987, 654, 456, 321, 123]",
"exclude_ids": "[123, 321]"
}Visualizar cupom
Obtém detalhes de um cupom de desconto específico
curl --request GET \
--url https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id} \
--header 'User-Secret-Key: <api-key>' \
--header 'User-Token: <api-key>'import requests
url = "https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}"
headers = {
"User-Token": "<api-key>",
"User-Secret-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'User-Token': '<api-key>', 'User-Secret-Key': '<api-key>'}
};
fetch('https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}', 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://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"User-Secret-Key: <api-key>",
"User-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("User-Token", "<api-key>")
req.Header.Add("User-Secret-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}")
.header("User-Token", "<api-key>")
.header("User-Secret-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dooki.com.br/v2/{alias}/pricing/promocodes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["User-Token"] = '<api-key>'
request["User-Secret-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 123,
"code": "TEST",
"description": "",
"customer_id": 123,
"active": true,
"expired": true,
"discount_type": "p",
"for_the_price_of": true,
"cart_default": true,
"type_increment_value": "",
"value": 10,
"price_products": 123,
"percent_products": 123,
"quantity": "100000",
"total_customers_used": "22",
"product_quantity": 123,
"product_max_quantity": 123,
"used": 22,
"items_count": 123,
"min_value": 99.99,
"use_percent": 0.02,
"shipment_percent": 123,
"accumulate": true,
"once_per_customer": true,
"abandoned_cart": true,
"newsletter": true,
"payments_ids": "[1, 2, 3, 4]",
"free_shipment": true,
"ignore_promotion_products": true,
"freebie_id": 123,
"advertise": true,
"start_at": {
"date": "2000-08-17 10:24:24",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"end_at": {
"date": "2000-08-17 10:24:24",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"created_at": {
"date": "2000-08-17 10:24:24",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"updated_at": {
"date": "2000-08-17 10:24:24",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"include": {
"products_ids": "[987, 654, 456, 321, 123]",
"brands_ids": "[]",
"collections_ids": "[]",
"categories_ids": "[]"
},
"exclude": {
"products_ids": "[123, 321]",
"brands_ids": "[]",
"collections_ids": "[]",
"categories_ids": "[]"
},
"include_ids": "[987, 654, 456, 321, 123]",
"exclude_ids": "[123, 321]"
}Query Parameters
Incluir relacionamentos adicionais
customer, categories, collections, brand, products, payments Response
Detalhes do cupom
Representa as restrições de inclusão e exclusão para itens específicos
ID do cupom.
Código digitado pelo cliente no carrinho para aplicar o cupom. Único na loja, com no mínimo 3 e no máximo 40 caracteres.
"TEST"
Descrição interna do cupom, com até 60 caracteres. Emojis são removidos ao salvar.
""
ID do cliente para quem o cupom é exclusivo. Quando nulo, o cupom vale para qualquer cliente.
Indica se o cupom está ativo.
Indica se a data de término do cupom já passou.
Tipo do desconto do cupom: p para percentual e v para valor fixo em reais.
p, v Indica se o cupom é do tipo 'pelo preço de', em que cada produto elegível passa a custar o valor de price_products.
Indica se o cupom é aplicado automaticamente no carrinho. Um cupom percentual de 100% ou mais nunca é tratado como padrão.
Tipo do desconto como está gravado no cupom, com os mesmos valores de discount_type (p ou v).
""
Valor do desconto: percentual quando discount_type for p, ou valor em reais quando for v.
10
Preço aplicado a cada produto elegível quando for_the_price_of for verdadeiro. Obrigatório nesse caso.
Percentual de desconto aplicado ao preço de cada produto elegível, usado em vez de price_products quando for maior que zero.
Quantidade total de usos disponíveis do cupom. O cupom deixa de valer quando used alcança esse número.
"100000"
Quantidade de clientes distintos que já usaram o cupom.
"22"
Quantidade de produtos elegíveis que o cupom 'pelo preço de' considera no cálculo do total.
Quantidade máxima de produtos elegíveis a que o cupom se aplica.
Quantidade de vezes que o cupom já foi usado.
22
Quantidade de itens do carrinho considerada na regra do cupom. Campo legado: é gravado e devolvido, mas nenhuma regra desta API o aplica.
Valor mínimo do subtotal do carrinho, em reais, para o cupom poder ser aplicado.
99.99
Proporção de uso do cupom, entre os usos já feitos e o total disponível.
0.02
Percentual de desconto aplicado ao frete, usado quando o cupom desconta no frete em vez de descontar nos produtos.
Indica se o cupom pode ser acumulado com outras promoções da loja.
Indica se cada cliente pode usar o cupom uma única vez.
Indica se o cupom está vinculado a alguma configuração de recuperação de carrinho abandonado.
Indica se o cupom é entregue ao cliente que se inscreve na newsletter da loja.
IDs dos meios de pagamento em que o cupom é aceito.
"[1, 2, 3, 4]"
Indica se o cupom concede frete grátis em vez de desconto no valor do pedido.
Indica se o cupom deixa de valer para produtos que já estão em promoção.
Brinde concedido pelo cupom
Divulgar o cupom com brinde no checkout
Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
Show child attributes
Show child attributes
Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
Show child attributes
Show child attributes
Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
Show child attributes
Show child attributes
Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
Show child attributes
Show child attributes
Itens a serem incluídos
Show child attributes
Show child attributes
Itens a serem excluídos
Show child attributes
Show child attributes
IDs dos produtos alcançados pelas regras de inclusão, já expandindo marcas, coleções e categorias
"[987, 654, 456, 321, 123]"
IDs dos produtos alcançados pelas regras de exclusão, já expandindo marcas, coleções e categorias
"[123, 321]"
Was this page helpful?