Adicionar um desconto

Cadastra um desconto na loja. O desconto passa a valer em startsAt e vale só no canal de venda da própria loja.

Requisição

uuid

obrigatório

A loja.

string

obrigatório

SMART (automático) ou COUPON (cupom). Veja tipos de desconto.

string

Nome do desconto. Obrigatório quando type é SMART.

string

Código que o cliente digita. Obrigatório quando type é COUPON. Só letras e números, sem espaços, e único entre os cupons não removidos da loja, sem diferenciar maiúsculas de minúsculas.

datetime

obrigatório

A partir de quando o desconto vale. Uma data no futuro deixa o desconto SCHEDULED.

datetime

Até quando o desconto vale. Precisa ser depois de startsAt. Sem ele, o desconto não expira.

object

obrigatório

Regras de valor e de uso.

Mostrar propriedades

number

obrigatório

Valor do desconto, maior que zero. Em PERCENTAGE, no máximo 100.

string

padrão:"PERCENTAGE"

PERCENTAGE (porcentagem) ou FIXED_AMOUNT (valor em reais).

string

padrão:"TOTAL"

Sobre o que o desconto incide: SUBTOTAL (soma dos produtos), TOTAL (produtos mais entrega) ou DELIVERY (só a entrega).

number

padrão:"0"

Valor mínimo dos produtos na sacola para o desconto valer. 0 não exige mínimo.

integer

padrão:"0"

Quantas vezes o desconto pode ser usado no total, somando todos os clientes. 0 é ilimitado.

string

padrão:"ONCE"

MANY (qualquer cliente, quantas vezes quiser), ONCE (uma vez por cliente) ou FIRST_ORDER (só no primeiro pedido do cliente na loja).

string[]

Opções extras:

NON_PROMOTION_PRODUCTS: o desconto só incide sobre produtos que não estão em promoção, e o mínimo do pedido considera só esses produtos.
CUMULATIVE_WITH_SMART: o cupom se soma ao desconto automático em vez de substituí-lo. Só para COUPON: em SMART, a API responde 422.

status não é aceito e é ignorado se enviado: ele é calculado a partir das datas. Veja status.

curl --request POST 'https://api.deliveryvip.com.br/merchant/v3/{merchantId}/discounts' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "COUPON",
    "code": "BEMVINDO10",
    "startsAt": "2024-05-01T00:00:00-03:00",
    "endsAt": "2024-05-31T23:59:59-03:00",
    "rules": {
      "valueType": "PERCENTAGE",
      "value": 10,
      "minimumOrderValue": 50,
      "usageLimit": 100,
      "usagePerCustomer": "FIRST_ORDER",
      "discountType": "SUBTOTAL"
    },
    "options": ["CUMULATIVE_WITH_SMART"]
  }'

const response = await fetch(`https://api.deliveryvip.com.br/merchant/v3/${merchantId}/discounts`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    type: 'COUPON',
    code: 'BEMVINDO10',
    startsAt: '2024-05-01T00:00:00-03:00',
    endsAt: '2024-05-31T23:59:59-03:00',
    rules: {
      valueType: 'PERCENTAGE',
      value: 10,
      minimumOrderValue: 50,
      usageLimit: 100,
      usagePerCustomer: 'FIRST_ORDER',
      discountType: 'SUBTOTAL',
    },
    options: ['CUMULATIVE_WITH_SMART'],
  }),
})
const discount = await response.json()

response = requests.post(
    f"https://api.deliveryvip.com.br/merchant/v3/{merchant_id}/discounts",
    headers={"Authorization": f"Bearer {token}"},
    json={
        "type": "COUPON",
        "code": "BEMVINDO10",
        "startsAt": "2024-05-01T00:00:00-03:00",
        "endsAt": "2024-05-31T23:59:59-03:00",
        "rules": {
            "valueType": "PERCENTAGE",
            "value": 10,
            "minimumOrderValue": 50,
            "usageLimit": 100,
            "usagePerCustomer": "FIRST_ORDER",
            "discountType": "SUBTOTAL",
        },
        "options": ["CUMULATIVE_WITH_SMART"],
    },
)
discount = response.json()

Exemplo de desconto automático (SMART)

{
  "type": "SMART",
  "name": "10% acima de R$ 32",
  "startsAt": "2024-04-28T17:18:00-03:00",
  "rules": {
    "valueType": "PERCENTAGE",
    "value": 10,
    "minimumOrderValue": 32,
    "usagePerCustomer": "MANY",
    "discountType": "SUBTOTAL"
  },
  "options": ["NON_PROMOTION_PRODUCTS"]
}

Resposta

Retorna 200 OK com o objeto desconto.

200 OK

{
  "id": "4572126a-6161-4b68-af04-3cb2fb4fa7a5",
  "createdAt": "2024-04-20T19:43:15-03:00",
  "startsAt": "2024-05-01T00:00:00-03:00",
  "endsAt": "2024-05-31T23:59:59-03:00",
  "type": "COUPON",
  "code": "BEMVINDO10",
  "status": "SCHEDULED",
  "rules": {
    "valueType": "PERCENTAGE",
    "value": 10.0,
    "minimumOrderValue": 50.0,
    "usageLimit": 100,
    "usagePerCustomer": "FIRST_ORDER",
    "discountType": "SUBTOTAL"
  },
  "options": ["CUMULATIVE_WITH_SMART"]
}

Erros

Em 422, o title traz os campos com problema e as mensagens de validação.

422 Unprocessable Content

{
  "status": "422",
  "title": { "code": ["has already been taken"] }
}

Status	Quando
`403 Forbidden`	A loja não contratou o módulo de descontos.
`404 Not Found`	O `merchantId` não autorizou o seu app.
`422 Unprocessable Content`	`type` ausente ou inválido, `name` ou `code` faltando, `code` repetido ou com espaços, `value` zero ou acima de 100% em `PERCENTAGE`, `endsAt` antes de `startsAt`, `CUMULATIVE_WITH_SMART` num `SMART`.

Visão geral

Pedidos

Catálogo

Indoor

Descontos

Ferramentas

Referência

Requisição

Resposta

Erros

​Requisição

​Resposta

​Erros

Requisição

Resposta

Erros