Referências de API

Criar promoção

post
https://{loja}.commerce-wake.tech/api/promotions

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Dados da promoção. O mesmo corpo é usado em Atualizar promoção.

generalInformation
object
required

Obrigatório. Nome, vigência, prioridade, acúmulo e limites de uso.

couponInformation
object
required

Obrigatório. Cupons da promoção; envie mesmo sem cupom, com couponCodes: [].

conditionGroups
array of objects | null

Grupos de condições. Entre grupos vale OU; dentro de um grupo, E. Omitido ou [] = sem condições.

conditionGroups
discounts
array of objects | null

Descontos (ações) aplicados quando as condições são atendidas.

discounts
stamps
array of objects | null

Selos exibidos nos produtos da promoção.

stamps
disclosure
array of objects | null

Textos de divulgação.

disclosure
partners
array of int32s | null

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

partners
entityRules
array of objects | null

Regras adicionais por entidade (ex.: não aplicar em produtos remarcados). Opções em GET /api/promotions/structure/rules.

entityRules
accumulationLinks
array of int64s | null

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

accumulationLinks
Headers
string
enum
required
Defaults to 2.0

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

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated about 3 hours ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 3 hours ago