Criar um desconto da loja

curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/discounts \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "name": "Promoção de Outubro",
  "discount_method": "percent",
  "discount_value": 20,
  "discount_type": "buy_x_get_y",
  "entry_condition_type": "amount",
  "entry_condition_value": 1,
  "accumulate": false,
  "start_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "restrictions": {
    "include": {
      "brands_ids": [
        1,
        2,
        3
      ],
      "products_ids": [
        5,
        6
      ],
      "categories_ids": [
        10,
        11
      ],
      "collections_ids": [
        20,
        21
      ]
    }
  },
  "end_at": "2025-10-15 23:59:59",
  "specifications": {
    "set_cart_usage_limit": true,
    "cart_usage_limit": 1,
    "get_products_quantity": 1,
    "restrictions": {
      "include": {
        "brands_ids": [
          11
        ],
        "products_ids": [
          51
        ],
        "categories_ids": [
          4
        ],
        "collections_ids": [
          9
        ]
      }
    }
  }
}
'

{
  "id": 1520,
  "store_id": 1319250,
  "discount_type_id": 1520,
  "name": "Lucas",
  "entry_condition_type": "amount",
  "entry_condition_value": 10,
  "discount_method": "percent",
  "discount_value": 100,
  "discount_type": "buy_x_get_y",
  "accumulate": false,
  "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"
  }
}

POST

{alias}

discounts

Criar um desconto da loja

curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/discounts \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "name": "Promoção de Outubro",
  "discount_method": "percent",
  "discount_value": 20,
  "discount_type": "buy_x_get_y",
  "entry_condition_type": "amount",
  "entry_condition_value": 1,
  "accumulate": false,
  "start_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "restrictions": {
    "include": {
      "brands_ids": [
        1,
        2,
        3
      ],
      "products_ids": [
        5,
        6
      ],
      "categories_ids": [
        10,
        11
      ],
      "collections_ids": [
        20,
        21
      ]
    }
  },
  "end_at": "2025-10-15 23:59:59",
  "specifications": {
    "set_cart_usage_limit": true,
    "cart_usage_limit": 1,
    "get_products_quantity": 1,
    "restrictions": {
      "include": {
        "brands_ids": [
          11
        ],
        "products_ids": [
          51
        ],
        "categories_ids": [
          4
        ],
        "collections_ids": [
          9
        ]
      }
    }
  }
}
'

{
  "id": 1520,
  "store_id": 1319250,
  "discount_type_id": 1520,
  "name": "Lucas",
  "entry_condition_type": "amount",
  "entry_condition_value": 10,
  "discount_method": "percent",
  "discount_value": 100,
  "discount_type": "buy_x_get_y",
  "accumulate": false,
  "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"
  }
}

Authorizations

User-Token

string

header

required

User-Secret-Key

string

header

required

Path Parameters

alias

string

required

Alias da loja

Body

application/json

Dados para criação do desconto

name

string | null

required

Nome do desconto.

Required string length: 3 - 100

Example:

"Promoção de Outubro"

discount_method

enum<string>

required

Método de desconto.

Available options:

percent,

amount

Maximum string length: 10

Example:

"percent"

discount_value

number<float>

required

Valor do desconto. Se percentual, o máximo é 100.

Required range: x >= 0.01

Example:

20

discount_type

enum<string>

required

Tipo do desconto.

Available options:

buy_x_get_y

Maximum string length: 15

Example:

"buy_x_get_y"

entry_condition_type

enum<string>

required

Tipo de condição para aplicar o desconto.

Available options:

amount,

quantity

Example:

"amount"

entry_condition_value

required

Valor mínimo (quantidade de produto ou valor do carrinho) necessário para ativar o desconto.

Required range: x >= 1

Example:

1

accumulate

boolean

required

Define se o desconto pode acumular com outras promoções.

Example:

false

start_at

object

required

Show child attributes

start_at.date

string

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

Example:

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

start_at.timezone_type

integer

Número de representação do timezone.

Example:

3

start_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

restrictions

object

required

Restrições de aplicação do desconto.

Show child attributes

restrictions.include

object

required

Show child attributes

restrictions.include.brands_ids

integer[]

required

IDs das marcas incluídas.

Example:

[1, 2, 3]

restrictions.include.products_ids

integer[]

required

IDs dos produtos incluídos.

Example:

[5, 6]

restrictions.include.categories_ids

integer[]

required

IDs das categorias incluídas.

Example:

[10, 11]

restrictions.include.collections_ids

integer[]

required

IDs das coleções incluídas.

Example:

[20, 21]

end_at

object

Data/hora de término. Deve ser posterior ao start_at.

Show child attributes

end_at.date

string

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

Example:

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

end_at.timezone_type

integer

Número de representação do timezone.

Example:

3

end_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

Example:

"2025-10-15 23:59:59"

specifications

object

Configurações da promoção escolhida

Show child attributes

specifications.set_cart_usage_limit

boolean

required

Define se há limite de uso por carrinho

Example:

true

specifications.cart_usage_limit

integer

required

Limite de vezes que o desconto pode ser aplicado no carrinho (0 = ilimitado)

Required range: x >= 0

Example:

1

specifications.get_products_quantity

integer

required

Define o número de produtos que o cliente receberá, baseado nos critérios da promoção.

Required range: x >= 1

Example:

1

specifications.restrictions

object

required

Mesmas regras de restrição do campo principal, aplicadas ao tipo de promoção específica

Show child attributes

specifications.restrictions.include

object

Show child attributes

specifications.restrictions.include.brands_ids

integer[]

specifications.restrictions.include.products_ids

integer[]

specifications.restrictions.include.categories_ids

integer[]

specifications.restrictions.include.collections_ids

integer[]

Response

Detalhes do desconto

Representa os atributos de um Desconto

integer

Example:

1520

store_id

integer

Example:

1319250

discount_type_id

integer

Example:

1520

name

string

Example:

"Lucas"

entry_condition_type

string

Example:

"amount"

entry_condition_value

number

Example:

10

discount_method

string

Example:

"percent"

discount_value

number

Example:

100

discount_type

string

Example:

"buy_x_get_y"

accumulate

boolean

Example:

false

start_at

object

Show child attributes

start_at.date

string

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

Example:

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

start_at.timezone_type

integer

Número de representação do timezone.

Example:

3

start_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

end_at

object

Show child attributes

end_at.date

string

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

Example:

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

end_at.timezone_type

integer

Número de representação do timezone.

Example:

3

end_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

created_at

object

Show child attributes

created_at.date

string

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

Example:

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

created_at.timezone_type

integer

Número de representação do timezone.

Example:

3

created_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

updated_at

object

Show child attributes

updated_at.date

string

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

Example:

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

updated_at.timezone_type

integer

Número de representação do timezone.

Example:

3

updated_at.timezone

string

Fuso horário associado.

Example:

"America/Sao_Paulo"

Listar descontos da loja Visualizar um desconto da loja

⌘I

Referência da API

Authorizations

Path Parameters

Body

Response