Visualizar Order Bump

curl --request GET \
  --url https://api.dooki.com.br/v2/{alias}/pricing/order-bumps/{id} \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>'

import requests

url = "https://api.dooki.com.br/v2/{alias}/pricing/order-bumps/{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/order-bumps/{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/order-bumps/{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/order-bumps/{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/order-bumps/{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/order-bumps/{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": 255787,
  "active": true,
  "is_ia": false,
  "pre_select_variation": true,
  "name": "Oferta Especial",
  "displayed_quantity": 1,
  "resource_id": 42533439,
  "resource_type": "product",
  "price_sale": "50.00",
  "price_discount": "0.00",
  "params": {
    "button_text": "+ Adicionar oferta",
    "title": null,
    "message": null
  },
  "accepted_payment": "all",
  "display_rule": "always",
  "amount_rule": "greater_than",
  "amount_value": "0.00",
  "updated_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"
  },
  "display_product_ids": []
}

GET

{alias}

pricing

order-bumps

{id}

Visualizar Order Bump

curl --request GET \
  --url https://api.dooki.com.br/v2/{alias}/pricing/order-bumps/{id} \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>'

import requests

url = "https://api.dooki.com.br/v2/{alias}/pricing/order-bumps/{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/order-bumps/{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/order-bumps/{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/order-bumps/{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/order-bumps/{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/order-bumps/{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": 255787,
  "active": true,
  "is_ia": false,
  "pre_select_variation": true,
  "name": "Oferta Especial",
  "displayed_quantity": 1,
  "resource_id": 42533439,
  "resource_type": "product",
  "price_sale": "50.00",
  "price_discount": "0.00",
  "params": {
    "button_text": "+ Adicionar oferta",
    "title": null,
    "message": null
  },
  "accepted_payment": "all",
  "display_rule": "always",
  "amount_rule": "greater_than",
  "amount_value": "0.00",
  "updated_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"
  },
  "display_product_ids": []
}

Authorizations

User-Token

string

header

required

User-Secret-Key

string

header

required

Path Parameters

alias

string

required

Alias da loja

integer

required

ID do Order Bump

Query Parameters

include

enum<string>[]

Incluir relacionamentos adicionais

Available options:

resource

Response

Retorna os detalhes do Order Bump

Informações de um OrderBump individual

integer

ID do Order Bump.

Example:

255787

active

boolean

Indica se o Order Bump está ativo e pode ser exibido no checkout.

Example:

true

is_ia

boolean

Indica se o Order Bump é gerado por IA, com a escolha do produto feita automaticamente. A loja pode ter apenas um Order Bump com IA.

Example:

false

pre_select_variation

boolean

Indica se a variação do produto ofertado já vem selecionada para o cliente.

Example:

true

name

string

Nome do Order Bump, único na loja.

Example:

"Oferta Especial"

displayed_quantity

integer

Quantidade de produtos exibidos na oferta, de 1 a 5. Configurável apenas quando is_ia for verdadeiro; nos demais casos é sempre 1.

Example:

1

resource_id

integer

ID do produto ou do SKU ofertado, conforme resource_type.

Example:

42533439

resource_type

string

Tipo do item ofertado: product ou sku.

Example:

"product"

price_sale

string

Preço de tabela do item na oferta, em reais.

Example:

"50.00"

price_discount

string

Preço promocional do item na oferta, em reais. É um preço final, não um valor de desconto.

Example:

"0.00"

params

object

Textos personalizados exibidos na oferta durante o checkout.

Show child attributes

accepted_payment

string

Meio de pagamento que o cliente precisa escolher para a oferta ser exibida. all exibe em qualquer meio.

Example:

"all"

display_rule

string

Regra de exibição da oferta: always sempre exibe, products_amount compara o valor dos produtos do carrinho e selected_products exige que o carrinho tenha os produtos de display_product_ids.

Example:

"always"

amount_rule

string

Comparação aplicada ao valor dos produtos do carrinho: greater_than ou lower_than. Preenchido quando display_rule for products_amount.

Example:

"greater_than"

amount_value

string

Valor de referência, em reais, comparado ao total dos produtos do carrinho conforme amount_rule.

Example:

"0.00"

updated_at

object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

Show child attributes

created_at

object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

Show child attributes

display_product_ids

integer[]

IDs dos produtos que precisam estar no carrinho para a oferta ser exibida. Preenchido apenas quando display_rule for selected_products.

Example:

[]