Admin API · Promoções

Ativar ou inativar promoção

Liga ou desliga a promoção sem alterar o restante do cadastro.

Sem datas, a promoção é ativada com a vigência atual. Se essa vigência já terminou, a resposta é 400: envie startDate e endDate, que então substituem a vigência. Enviar só uma das datas é recusado. Ao inativar, omita as datas.

Permissão: Ativação de promoções — visualização e edição.

put/api/promotions/{promotionId}/status

Request

  • Base URL
    https://sualoja.commerce-wake.tech
  • URL
    https://sualoja.commerce-wake.tech/api/promotions/{promotionId}/status
  • Auth
    HTTP bearer

Path parameters

promotionIdinteger required

ID da promoção.

Headers

x-api-version'2.0' required

Versão da API. Obrigatório: sem ele a resposta é 400 (API_VERSION_REQUIRED).

Request body

activeboolean required

Obrigatório. true ativa, false inativa.

startDatestring date-time nullable

Nova data de início. Use só ao ativar, junto com endDate.

endDatestring date-time nullable

Nova data de término, maior que o início e que o momento atual. Use só ao ativar, junto com startDate.

Response

Status alterado.

Changes

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