Admin API · Promoções

Criar promoção

Cria uma promoção com informações gerais, cupons, grupos de condições, descontos e, opcionalmente, regras adicionais, selos, textos de divulgação, parceiros e lista de acúmulo.

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

Omita listas vazias ou envie [], nunca null. Combinações de grupo, subgrupo e argumentos que não correspondem a nenhuma condição ou desconto conhecido são ignoradas sem erro: consulte a promoção depois de criá-la.

A validação acontece em duas etapas: primeiro as regras de formato e de negócio; só se todas passarem, as regras da gravação são conferidas e voltam como um item PRIVATE_API_VALIDATION em details.

post/api/promotions

Request

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

Headers

x-api-version'2.0' required

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

Request body

partnersinteger[] nullable

IDs de parceiros que podem usar a promoção. [] = sem restrição.

accumulationLinksinteger[] nullable

Ids das promos citadas na lista de acúmulo, conforme GeneralInformation.AccumulationScope. O vínculo é direcional.

Response

Promoção criada. O ID vem em data.promotionId e no header Location (/api/promotions/{promotionId}).

promotionIdinteger nullable

Legado: ID da promoção criada. Prefira data.promotionId.

successboolean

Legado: true quando a promoção foi criada.

Changes

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