Descontos Progressivos

Cadastrar desconto progressivo

Cria um novo preço de atacado. O ID do registro criado é retornado com HTTP 201.

Regras

  • A modalidade de faixa é exclusiva: exatamente uma entre faixaQuantidade e faixaPreco deve estar ativa. Ambas true ou ambas false retornam HTTP 400.
  • Quando tipo="produto", tipoFiltro é obrigatório.
  • Quando tipoFiltro="produtos", produtos é uma lista de referências por id ou codigo.
  • Quando tipoFiltro="categorias", categorias aceita IDs ou códigos de categorias raiz.
  • Apenas um registro do tipo pedido ativo é permitido por lojista.
  • Em cada lista de faixas, aPartirDe e percentualDesconto devem ser maiores que zero (percentual no máximo 99) e estritamente crescentes entre as faixas.
  • nome aceita no máximo 50 caracteres.
post/descontosProgressivos

Request

  • Base URL: https://app.vendizap.com/api
  • URL: https://app.vendizap.com/api/descontosProgressivos
  • Auth: API key in header X-Auth-Id and API key in header X-Auth-Secret

Request body

nomestring required

Nome do preço de atacado (máximo 50 caracteres).

tipo'produto' | 'pedido' required

produto: desconto sobre o preço unitário (combinar com tipoFiltro). pedido: desconto sobre o total do pedido. Apenas um registro do tipo pedido ativo é permitido por lojista.

ativaboolean

Define se o desconto está ativo. Default true.

tipoFiltro'todosProdutos' | 'produtos' | 'categorias'

Obrigatório quando tipo="produto". Quando tipo="pedido", ignorar.

categoriasstring[]

Obrigatório quando tipoFiltro="categorias". Aceita id OU código. Somente categorias raiz.

faixaQuantidadeboolean

Se true, faixaQuantidadeLista deve conter pelo menos uma faixa. Exclusivo com faixaPreco — as duas não podem ser true (nem as duas false) ao mesmo tempo; violar isso retorna HTTP 400.

faixaPrecoboolean

Se true, faixaPrecoLista deve conter pelo menos uma faixa. Exclusivo com faixaQuantidade — as duas não podem ser true (nem as duas false) ao mesmo tempo; violar isso retorna HTTP 400.

permiteCupomboolean

Quando false, os itens cobertos por esta campanha (com a faixa atingida) saem da base de cálculo de cupons no carrinho. Default true (cupom e preço de atacado se acumulam, como antes).

Example request

{
  "nome": "Quanto mais, mais barato",
  "tipo": "produto",
  "ativa": true,
  "tipoFiltro": "produtos",
  "produtos": [
    {
      "id": "6682f7b065be87123fd4d157",
      "codigo": "SKU-001"
    }
  ],
  "categorias": [
    "601d957bb6fa7c11ba209426"
  ],
  "faixaQuantidade": true,
  "faixaQuantidadeLista": [
    {
      "aPartirDe": 2,
      "percentualDesconto": 10
    }
  ],
  "faixaPrecoLista": [
    {
      "aPartirDe": 2,
      "percentualDesconto": 10
    }
  ],
  "permiteCupom": true
}

Response

Preço de atacado criado com sucesso.

idstring

Example response

{
  "id": "6048f2b4b6fa7c28844582d5"
}

Changes

No recorded changes to this operation across all 1 revision of this API.