Objetivo
Incluir combos promocionais.
Chamada
POST [URLAPI]/SMPromocoesAPI/api/v1/CombosPromocionais
Permissionamento
Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.
Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Promoções > API de Combos Promocionais
Imagem 01 - Configurações de Sistemas/Módulos/Aplicações
Assuntos Relacionados
Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.
Informações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
Não há.
Parâmetros do Corpo (Body Parameters)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) | |
| descricao | Descrição da promoção | string | Não há | |
| dataInicio | Data de início da promoção | string ($date-time) | Não há. | |
| dataFim | Data do término da promoção | string ($date-time) | Não há. | |
| tipoPromocao | Tipo da promoção. (I - Itens ou G - Grupo) | string | Não há. | |
| tipoQuantidade | Tipo da Quantidade. (I - Itens Distintos ou T - Total Itens Grupo) | string | Não há. | |
| tipoQtdeCargaPdv | Indica o tipo de ação do combo promocional. (M = “Múltiplos”, L = “Leve X Pague Y” e A = “Acima de / A partir de)” | string | Não há. | |
| tipoVenda | Indica o tipo de venda para aplicação da ação promocional na venda. (1 = Venda a Vista / 2 = Cartão Cliente) | integer($int32) | Não há. | |
| controlaVerbaPdv | Indica se a promoção faz o controle de verba nas vendas por PDV. (S = Sim / N = Não) | string | Não há. | |
| baixaQtdeVerbaBonif | Indica se baixa verba, somente dos produtos e quantidades bonificados. (S = Sim / N = Não) | string | Não há. | |
| descricaoEtiqueta | Indica a descrição a ser emitida em etiquetas ou cartazes de divulgação da promoção. | string | Não há. | |
empresas | AdicionarMflPromocPdvEmpDto | |||
| nroEmpresa | Número da empresa participante da promoção | integer($int64) | Não há. | |
| cnpj | Cnpj da empresa participante da promoção | string | Não há. | |
| _expandables | Propriedade para expandir os campos | string | Não há. | |
itens | AdicionarMflPromocPdvItemDto | |||
| seqProduto | Código sequencial do produto no ERP | integer($int64) | Não há. | |
| codAcesso | Código de barras do produto de acordo com a embalagem da promoção | string | Não há. | |
| qtdEmbalagem | Embalagem do produto para a ação promocional | number($double) | Não há. | |
| quantidade | Indica a quantidade a ser vendida do produto, para estar apto à ação promocional. Quantidade de acordo com a embalagem definida. | number($double) | Não há. | |
| tipoItem | Indica o tipo de verificação da venda do item no combo. (N = Normal ou P = Promoção) Não deve ser preenchido quando Tipo Qtde Carga PDV igual a "Acima de/ A partir de" | string | Não há. | |
| precoItem | Valor do preço do item promocional, em R$. Será considerado somente para as linhas em que o Tipo Item é igual a P - Promoção. Quando Tipo Item é igual a N, sempre grava valor zero. | number($double) | Não há. | |
| percentualDesconto | Percentual de desconto a ser aplicado no item promocional. Será considerado somente para as linhas em que o Tipo Item é igual a P - Promoção. Quando Tipo Item é igual a N, sempre grava valor zero. | number($double) | Não há. | |
| validoFamilia | Indica se a promoção é válida para os demais produtos da mesma família do item informado. (S = Sim ou N = Não) | string | Não há. | |
| valorRefAcordoPromoc | Indica o tipo de valor que será usado como referência para a geração do acordo promocional. (1 - Preço Promocional, 2 - Preço Atual de Venda, 3 - Custo Líquido, 4 - Custo Bruto, 5 - Custo da Última Entrada, 6 - Livre) | integer($int32) | Não há. | |
| valorLivreRefAcordoPromoc | Valor que será usado como referência para a geração do acordo promocional. Deverá ser informado somente quando o tipo de Valor Referência Acordo Promocional é igual a 6. | number($double) | Não há. | |
| descApartirDe | Lista das informações de faixas da promoção por quantidade e valores de desconto | |||
| qtdApartirDe | Define a quantidade mínima de venda para aplicar a promoção | number($double) | Não há. | |
| tipoDesconto | Define o tipo de ação promocional a ser configurada para o item. Opções: 1. Preço de Venda; 2. Percentual Desconto; 3. Valor do Desconto | string | Não há. | |
| precoPromocao | Valor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. | number($double) | (Obrigatório quando Tipo Desconto é igual a 1- Preço de Venda) | |
| percentualDesconto | Percentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. | number($double) | (Obrigatório quando Tipo Desconto é igual a 2- Percentual Desconto) | |
| valorDesconto | Valor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. | number($double) | (Obrigatório quando Tipo Desconto é igual a 3- Valor do Desconto) | |
| _expandables | propriedade para expandir campos | string | Não há. | |
grupos | AdicionarMflPromocPdvGrupoDto | |||
| descricao | Descrição | string | Não há. | |
| qtdItemGrupo | Quantidade itens do grupo | integer($int32) | Não há. | |
| descApartDeGrupo | Lista das informações de faixas da promoção por quantidade e valores de desconto | |||
| qtdApartirDe | Define a quantidade mínima de venda para aplicar a promoção | Não há. | ||
| tipoDesconto | Define o tipo de ação promocional a ser configurada para o item. Opções: 1. Preço de Venda; 2. Percentual Desconto; 3. Valor do Desconto | Não há. | ||
| precoPromocao | Valor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. | (Obrigatório quando Tipo Desconto é igual a 1- Preço de Venda) | ||
| percentualDesconto | Percentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. | (Obrigatório quando Tipo Desconto é igual a 2- Percentual Desconto) | ||
| valorDesconto | Valor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. | (Obrigatório quando Tipo Desconto é igual a 3- Valor do Desconto) | ||
| itens | Lista de Produtos do grupo a ser incluído na promoção | |||
| AdicionarMflPromocPdvItemDto | ||||
| seqProduto | Código sequencial do produto no ERP | integer($int64) | Não há. | |
| codAcesso | Código de barras do produto de acordo com a embalagem da promoção | string | Não há. | |
| qtdEmbalagem | Embalagem do produto para a ação promocional | number($double) | Não há. | |
| quantidade | Indica a quantidade a ser vendida do produto, para estar apto à ação promocional. Quantidade de acordo com a embalagem definida. | number($double) | Não há. | |
| tipoItem | Indica o tipo de verificação da venda do item no combo. (N = Normal ou P = Promoção) Não deve ser preenchido quando Tipo Qtde Carga PDV igual a "Acima de/ A partir de" | string | Não há. | |
| precoItem | Valor do preço do item promocional, em R$. Será considerado somente para as linhas em que o Tipo Item é igual a P - Promoção. Quando Tipo Item é igual a N, sempre grava valor zero. | number($double) | Não há. | |
| percentualDesconto | Percentual de desconto a ser aplicado no item promocional. Será considerado somente para as linhas em que o Tipo Item é igual a P - Promoção. Quando Tipo Item é igual a N, sempre grava valor zero. | number($double) | Não há. | |
| validoFamilia | Indica se a promoção é válida para os demais produtos da mesma família do item informado. (S = Sim ou N = Não) | string | Não há. | |
| valorRefAcordoPromoc | Indica o tipo de valor que será usado como referência para a geração do acordo promocional. (1 - Preço Promocional, 2 - Preço Atual de Venda, 3 - Custo Líquido, 4 - Custo Bruto, 5 - Custo da Última Entrada, 6 - Livre) | integer($int32) | Não há. | |
| valorLivreRefAcordoPromoc | Valor que será usado como referência para a geração do acordo promocional. Deverá ser informado somente quando o tipo de Valor Referência Acordo Promocional é igual a 6. | number($double) | Não há. | |
| descApartirDe | Lista das informações de faixas da promoção por quantidade e valores de desconto | |||
| qtdApartirDe | Define a quantidade mínima de venda para aplicar a promoção | number($double) | Não há. | |
| tipoDesconto | Define o tipo de ação promocional a ser configurada para o item. Opções: 1. Preço de Venda; 2. Percentual Desconto; 3. Valor do Desconto | string | Não há. | |
| precoPromocao | Valor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. | number($double) | (Obrigatório quando Tipo Desconto é igual a 1- Preço de Venda) | |
| percentualDesconto | Percentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. | number($double) | (Obrigatório quando Tipo Desconto é igual a 2- Percentual Desconto) | |
| valorDesconto | Valor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. | number($double) | (Obrigatório quando Tipo Desconto é igual a 3- Valor do Desconto) | |
| _expandables | propriedade para expandir campos | string | Não há. |
[
{
"descricao": "string",
"dataInicio": "2021-04-27T12:21:43.501Z",
"dataFim": "2021-04-27T12:21:43.501Z",
"tipoPromocao": "string",
"tipoQuantidade": "string",
"tipoQtdeCargaPdv": "string",
"tipoVenda": 0,
"controlaVerbaPdv": "string",
"baixaQtdeVerbaBonif": "string",
"descricaoEtiqueta": "string",
"empresas": [
{
"nroEmpresa": 0,
"cnpj": "string",
"_expandables": [
"string"
]
}
],
"itens": [
{
"seqProduto": 0,
"codAcesso": "string",
"qtdEmbalagem": 0,
"quantidade": 0,
"tipoItem": "string",
"precoItem": 0,
"percentualDesconto": 0,
"validoFamilia": "string",
"valorRefAcordoPromoc": 0,
"valorLivreRefAcordoPromoc": 0,
"descApartirDe": [
{
"qtdApartirDe": 0,
"tipoDesconto": "string",
"precoPromocao": 0,
"percentualDesconto": 0,
"valorDesconto": 0,
"_expandables": [
"string"
]
}
],
"_expandables": [
"string"
]
}
],
"grupos": [
{
"descricao": "string",
"qtdItemGrupo": 0,
"descApartDeGrupo": [
{
"qtdApartirDe": 0,
"tipoDesconto": "string",
"precoPromocao": 0,
"percentualDesconto": 0,
"valorDesconto": 0,
"_expandables": [
"string"
]
}
],
"itens": [
{
"seqProduto": 0,
"codAcesso": "string",
"qtdEmbalagem": 0,
"quantidade": 0,
"tipoItem": "string",
"precoItem": 0,
"percentualDesconto": 0,
"validoFamilia": "string",
"valorRefAcordoPromoc": 0,
"valorLivreRefAcordoPromoc": 0,
"descApartirDe": [
{
"qtdApartirDe": 0,
"tipoDesconto": "string",
"precoPromocao": 0,
"percentualDesconto": 0,
"valorDesconto": 0,
"_expandables": [
"string"
]
}
],
"_expandables": [
"string"
]
}
],
"_expandables": [
"string"
]
}
],
"_expandables": [
"string"
]
}
]
Informações para Resposta (Response Information)
Códigos do Recurso (Response Codes)
- Success (201)
- BadRequest (400)
Formatos de Resposta (Response Formats)
application/json, text/json
CODE 201 - SUCCESS
[
{
"descricao": "string",
"promocao": 0,
"_expandables": [
"string"
]
}
]
application/json, text/json
CODE 400 - BAD
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas