POST Acoes promocionais - Varejonline/api GitHub Wiki
POST https://integrador.varejonline.com.br/apps/api/acoes-promocionais
Parâmetros
Envie um JSON no corpo da requisição, contendo:
- descricao: (String) (obrigatório)
- localizador: (String) (obrigatório)
- objetivo: objetivo da ação promocional (String) (obrigatório)
- vigenciaInicial: (string dd-MM-yyyy) (obrigatório)
- vigenciaFinal: (string dd-MM-yyyy) (obrigatório)
- considerarTodoEstoque: (boolean) (opcional, padrão: false)
- entidades: Lista de objetos complexos das entidades que farão parte da ação (obrigatório)
- id: id da entidade (Long) (obrigatório)
- motivoDesconto: (string) (opcional)
- franquias: A ação promocional será replicada para as franquias informadas (Lista de objetos complexos) (opcional)
- regra: (objeto complexo) (obrigatório)
- modalidade: QUANTIDADE, VALOR ou COMBINACAO (String) (obrigatório)
- restricao: (obrigatório)
- documentoObrigatorio: (opcional, padrão: false)
- somentePagamentoDinheiro: (opcional, padrão: false)
- usoUnicoCliente: possível true somente se documentoObrigatorio = true (opcional, padrão: false)
- utilizarAtivador: (opcional, padrão: false)
- permiteAcumuloComOutrasAcoes: (opcional, padrão: false)
- aplicacaoObrigatoria: (opcional, padrão: false)
- As propriedades faixaFixa e faixas são mutuamente exclusivas. Uma delas é obrigatória para modalidades QUANTIDADE e VALOR e não podem ser informadas quando COMBINACAO
- faixaFixa: objeto complexo
- faixas: Lista de objetos complexos
- item: objeto complexo. Deve conter uma estrutura de categorias ou uma lista de produtos que irão ativar a ação promocional (Obrigatório e usado somente quando a modalidade é QUANTIDADE ou VALOR). As propriedades produtos e estruturaCategorias são mutuamente exclusivas
- produtos: Lista de produtos. (Obrigatório um identificador para cada produto)
- id:
- codigoSistema:
- codigoInterno:
- codigoBarras:
- estruturaCategorias: Lista de uma lista de ids de categorias. Uma categoria não pode ser repetida em uma lista. Cada lista deve ser única. (List(List(Long)))
- produtos: Lista de produtos. (Obrigatório um identificador para cada produto)
- combinacoes: objeto complexo. Deve conter uma lista de combinação de estruturas ou uma lista de combinação de produtos que irão ativar a ação promocional e os prêmios de cada combinação (Obrigatório e usado somente quando a modalidade é COMBINACAO). As propriedades combinacaoProdutos e combinacaoEstruturas são mutuamente exclusivas
- combinacaoProdutos: Lista de objetos complexos
- produtos: Lista de produtos. (Obrigatório um identificador para cada produto)
- id:
- codigoSistema:
- codigoInterno:
- codigoBarras:
- quantidade: (decimal) (obrigatório)
- produtos: Lista de produtos. (Obrigatório um identificador para cada produto)
- combinacaoEstruturas: Lista de objetos complexos
- categoriasProduto: Lista de ids de categorias (List(Long)) (obrigatório)
- quantidade: (decimal) (obrigatório)
- premios: Lista de prêmios (obrigatório)
- combinacaoProdutos: Lista de objetos complexos
- restringirFormasPagamento: formas de pagamento. Separados por vírgula (List String)
Exemplo 1
Neste exemplo, a ação tem como alvo combinações de categorias de produtos, cada combinação possui seus prêmios.
POST https://integrador.varejonline.com.br/apps/api/acoes-promocionais
{
"descricao": "Exemplo combinação de itens com estrutura mercadológica",
"entidades": [
{
"id": 3
},
{
"id": 7
}
],
"considerarTodoEstoque": false,
"vigenciaInicial": "01-09-2023",
"motivoDesconto": "exemplo desconto",
"vigenciaFinal": "02-09-2023",
"franquias": [
{
"id": 111
},
{
"documento": "00.000.000/0000-03"
},
],
"combinacoes": [
{
"combinacaoEstruturas": [
{
"categoriasProduto": [1,11,7],
"quantidade": 1
}
],
"premios": [
{
"desconto": 10,
"tipoConfiguracao": "MAIOR_VALOR_VENDA",
"pontoFidelidade": 0,
"tipoDesconto": "VALOR",
"tipoPremio": "DESCONTO_NO_ITEM_DE"
}
]
},
{
"combinacaoEstruturas": [
{
"categoriasProduto": [1, 6],
"quantidade": 1
},
{
"categoriasProduto": [2, 8],
"quantidade": 2
}
],
"premios": [
{
"produtos": [
{
"id": 24,
"descricao": "AGUA MINERAL SEM GÁS",
"codigoBarras": "7896451198143",
"codigoInterno": "102030",
"codigoSistema": "0042"
}
],
"tipoConfiguracao": "PRODUTO",
"tipoPremio": "BRINDE"
},
{
"desconto": 5,
"tipoConfiguracao": "MENOR_VALOR_VENDA",
"tipoDesconto": "PERCENTUAL",
"tipoPremio": "DESCONTO_NO_ITEM_DE"
}
]
}
],
"regra": {
"modalidade": "COMBINACAO",
"restricao": {
"permiteAcumuloComOutrasAcoes": true,
"documentoObrigatorio": false,
"somentePagamentoDinheiro": false,
"usoUnicoCliente": false,
"utilizarAtivador": false,
"aplicacaoObrigatoria": false
}
},
"localizador": "exemplo localizador",
"objetivo": "BAIXAR_EXCESSO_ESTOQUE"
}
Exemplo 2
Neste exemplo, a ação tem como alvo uma lista de produtos, onde a cada 2 quantidades vendidas (faixa fixa), premia-se R$ 10,00 de desconto no total dos itens da ação promocional.
POST https://integrador.varejonline.com.br/apps/api/acoes-promocionais
{
"descricao": "Exemplo modalidade quantidade com faixa fixa",
"objetivo": "ELEVAR_VENDAS_CURTO_PRAZO",
"item": {
"produtos": [
{
"id": 25,
"descricao": "JOGO VIDEO GAME NOVO",
"codigoBarras": "7891033760398",
"codigoSistema": "0062"
},
{
"id": 26,
"descricao": "JOGO VIDEO GAME SEMINOVO",
"codigoBarras": "7891000248768",
"codigoSistema": "0063"
}
]
},
"entidades": [
{
"id": 3
}
],
"considerarTodoEstoque": false,
"integraRedeFranquia": false,
"vigenciaInicial": "01-09-2023",
"vigenciaFinal": "02-09-2023",
"regra": {
"modalidade": "QUANTIDADE",
"restricao": {
"permiteAcumuloComOutrasAcoes": true,
"documentoObrigatorio": true,
"somentePagamentoDinheiro": false,
"usoUnicoCliente": true,
"utilizarAtivador": false
},
"faixaFixa": {
"valorBase": 2,
"premios": [
{
"desconto": 10,
"tipoDesconto": "VALOR",
"tipoPremio": "DESCONTO_ITENS_ACAOPROMOCIONAL"
}
]
}
}
}