Atualizar um desconto

Altera um desconto. Os campos são os mesmos do cadastro, todos opcionais: envie só o que quer mudar. O que não for enviado fica como está.

Opções na atualização. Sem options no corpo, as opções atuais ficam como estão. Com options, a lista enviada substitui a atual: uma opção que não estiver nela é desligada, e "options": [] desliga todas.

Para ligar ou desligar o desconto agora, use as ações em vez de mexer nas datas. status é ignorado se enviado.

Requisição

uuid

obrigatório

A loja.

uuid

obrigatório

O id do desconto.

string

SMART ou COUPON.

string

Nome do desconto SMART.

string

Código do cupom COUPON.

datetime

A partir de quando o desconto vale.

datetime

Até quando o desconto vale.

object

Envie só as regras que mudam.

Mostrar propriedades

number

Valor do desconto.

string

PERCENTAGE ou FIXED_AMOUNT.

string

SUBTOTAL, TOTAL ou DELIVERY.

number

Valor mínimo dos produtos na sacola.

integer

Limite total de usos. 0 é ilimitado.

string

MANY, ONCE ou FIRST_ORDER.

string[]

Lista completa de opções: NON_PROMOTION_PRODUCTS e, só em COUPON, CUMULATIVE_WITH_SMART. Substitui a lista atual; omita para manter.

curl --request PATCH 'https://api.deliveryvip.com.br/merchant/v3/{merchantId}/discounts/{discountId}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "rules": { "value": 15 },
    "options": ["NON_PROMOTION_PRODUCTS"]
  }'

const response = await fetch(
  `https://api.deliveryvip.com.br/merchant/v3/${merchantId}/discounts/${discountId}`,
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
    body: JSON.stringify({ rules: { value: 15 }, options: ['NON_PROMOTION_PRODUCTS'] }),
  },
)
const discount = await response.json()

response = requests.patch(
    f"https://api.deliveryvip.com.br/merchant/v3/{merchant_id}/discounts/{discount_id}",
    headers={"Authorization": f"Bearer {token}"},
    json={"rules": {"value": 15}, "options": ["NON_PROMOTION_PRODUCTS"]},
)
discount = response.json()

Resposta

Retorna 200 OK com o objeto desconto atualizado.

200 OK

{
  "id": "4572126a-6161-4b68-af04-3cb2fb4fa7a5",
  "createdAt": "2024-08-01T19:43:15-03:00",
  "startsAt": "2024-04-28T17:18:00-03:00",
  "type": "SMART",
  "name": "Desconto 10%",
  "status": "ACTIVE",
  "rules": {
    "valueType": "PERCENTAGE",
    "value": 15.0,
    "minimumOrderValue": 32.0,
    "usageLimit": 0,
    "usagePerCustomer": "MANY",
    "discountType": "SUBTOTAL"
  },
  "options": ["NON_PROMOTION_PRODUCTS"]
}

A atualização não mexe nos canais de venda. Se o desconto também estava ligado a outros canais pelo painel, como um marketplace, eles continuam ligados.

Erros

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, ou o desconto não existe ou foi removido.
`422 Unprocessable Content`	O resultado da alteração é inválido, pelas mesmas regras do cadastro. O `title` traz os campos com problema.

Visão geral

Pedidos

Catálogo

Indoor

Descontos

Ferramentas

Referência

Requisição

Resposta

Erros

​Requisição

​Resposta

​Erros

Requisição

Resposta

Erros