Listar Order Bumps

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

{
  "data": [
    {
      "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": []
    }
  ],
  "meta": {
    "pagination": {
      "total": "10",
      "count": "30",
      "per_page": "10",
      "current_page": "1",
      "total_pages": "3",
      "links": {
        "previous": "",
        "next": ""
      }
    }
  }
}

GET

{alias}

pricing

order-bumps

Listar Order Bumps

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

{
  "data": [
    {
      "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": []
    }
  ],
  "meta": {
    "pagination": {
      "total": "10",
      "count": "30",
      "per_page": "10",
      "current_page": "1",
      "total_pages": "3",
      "links": {
        "previous": "",
        "next": ""
      }
    }
  }
}

Authorizations

User-Token

string

header

required

User-Secret-Key

string

header

required

Path Parameters

alias

string

required

Alias da loja

Query Parameters

filters

Filtros de Order Bumps · object

Filtros de OrderBump Objeto que mapeia os filtros disponíveis para pesquisa de Order Bumps.

Show child attributes

filters.accepted_payment

enum<string>[]

Filtra Order Bumps pelo(s) meio(s) de pagamento aceito(s).

Available options:

all,

deposit,

billet,

credit_card,

pix,

pix_in_installments

Example:

"?accepted_payment[]=pix"

filters.active

boolean

Define se o Order Bump está ativo ou inativo.

Example:

"?active=true"

Response

Lista de Order Bumps

Representa uma paginação com meta

data

object[]

Show child attributes

data.id

integer

Example:

255787

data.active

boolean

Example:

true

data.is_ia

boolean

Example:

false

data.pre_select_variation

boolean

Example:

true

data.name

string

Example:

"Oferta Especial"

data.displayed_quantity

integer

Example:

1

data.resource_id

integer

Example:

42533439

data.resource_type

string

Example:

"product"

data.price_sale

string

Example:

"50.00"

data.price_discount

string

Example:

"0.00"

data.params

object

Show child attributes

data.params.button_text

string

Example:

"+ Adicionar oferta"

data.params.title

string | null

Example:

null

data.params.message

string | null

Example:

null

data.accepted_payment

string

Example:

"all"

data.display_rule

string

Example:

"always"

data.amount_rule

string

Example:

"greater_than"

data.amount_value

string

Example:

"0.00"

data.updated_at

object

Show child attributes

data.updated_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.updated_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.updated_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.created_at

object

Show child attributes

data.created_at.date

string

Data e hora no formato YYYY-MM-DD H:MM:SS.

Example:

"2000-08-17 10:24:24"

data.created_at.timezone_type

integer

Número de representação do timezone.

Example:

3

data.created_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

data.display_product_ids

integer[]

Example:

[]

Referência da API

Authorizations

Path Parameters

Query Parameters

Response