Objetivo
A finalidade deste método é possibilitar a consulta dos combos promocionais
Chamada
GET [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)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| Cnpj | CNPJ da empresa utilizada como filtro de informações das promoções | String | Opcional. |
| NroEmpresa | Número de Empresa para filtrar as promoções | Integer | Opcional. |
| Status | A = ativo (somente produtos ativos), I = inativo (somente produtos inativos). Padrão: A. | String | Opcional |
| Vigente | Somente Promoções em vigor no momento. Opções: T = Todas; S = Somente Vigentes (valor padrão); F = Vigentes e Futuras. | String | Opcional. |
| SeqPromocaoPdv | Filtro por código de promoção combinada específica | Integer | Opcional. |
| DataHoraAlteracao | Filtro para buscar promoções alteradas a partir de uma data | Date | Opcional. |
| DataInicio | Filtro para buscar promoções que tem início a partir de uma data | Date | Opcional. |
| DataTermino | Filtro para buscar promoções que finalizam em uma determinada data | Date | Opcional. |
| Page | integer | Opcional. | |
| PageSize | integer | Opcional. |
Parâmetros do Corpo (Body Parameters)
Não há.
Formatos de Resposta (Response Formats)
application/json, text/json
Nome | Descrição | Tipo | |
seqPromocaoPdv | Número do código da promoção combinada | Integer | |
descricao | Descrição da promoção combinada | String | |
| status | Situação da promoção. A = Ativo ou I = Inativo. | String | |
dataInicio | Data inicial da promoção | Datetime | |
dataFim | Data final da promoção | Datetime | |
tipoPromocao | Indica o tipo de configuração da promoção. Opções: Nulo ou I = Item e G = Grupo. | String | |
tipoQuantidade | Indica o tipo de verificação de quantidade para aplicação da ação promocional na venda. Opções: Nulo ou I = Itens Distintos e T = Total Itens Grupo. Informado apenas quando o tipo de Promoção é igual a G (Grupo). | String | |
tipoQtdeCargaPdv | Indica o tipo de ação do combo promocional. Utilizado para integração com algumas frentes de caixa. Opções: M = “Múltiplos”, L = “Leve X Pague Y” e A = “Acima de / A partir de” | String | |
| controlaVerbaPdv | Indica se a promoção faz o controle de verba nas vendas por PDV, para posterior apuração e geração de acordo promocional com fornecedores. Opções: S = Sim / N ou Nulo = Não. | String | |
baixaQtdeVerbaBonif | Indica se baixa verba, somente dos produtos e quantidades bonificados. Opções: S = Sim / N ou Nulo = Não (padrão). | String | |
| descricaoEtiqueta | Indica a descrição a ser emitida em etiquetas ou cartazes de divulgação da promoção. | String | |
codParceiro | Indica se a promoção possui integração com algum parceiro de CRM, e seu respectivo código de referência. | Integer | |
| usuAlteracao | Usuário que realizou a alteração. | Datetime | |
| dtaAlteracao | Data em que a alteração foi realizada. | Datetime | |
itens | seqProduto | Código sequencial do produto no ERP | Integer |
| codBarras | Código de barras do produto (GTIN – EAN ou DUN) de acordo com a embalagem da promoção. Quando existir mais de um código cadastrado, retorna o maior. | String | |
| qtdEmbalagem | Quantidade da Embalagem do produto para a promoção | Integer | |
| quantidade | Indica a quantidade a ser vendida do produto, para estar apto à ação promocional. Quantidade de acordo com a embalagem definida. | Integer | |
| tipoItem | Indica o tipo de verificação da venda do item no combo. Opções: N = Normal ou P = Promoção. | String | |
| 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, retorna valor zero. | Integer | |
| 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, retorna valor zero. | Integer | |
| validoFamilia | Indica se a promoção é válida para os demais produtos da mesma família do item informado. Opções: S = Sim ou N = Não. | String | |
| valorRefAcordoPromoc | Indica o tipo de valor que será usado como referência para a geração do acordo promocional, na apuração das vendas, quando se controla Verba em vendas por PDV. Opções: 1 = Preço Promocional; nulo ou 2 = Preço Atual de Venda; 3 = Custo Líquido; 4 = Custo Bruto; 5 = Custo da Última Entrada; 6 = Livre. Campo considerado apenas em itens do tipo P (Promoção). | Integer | |
| valorLivreRefAcordoPromoc | Valor que será usado como referência para a geração do acordo promocional, na apuração das vendas, quando se controla Verba em vendas por PDV. Somente será informado quando o tipo de Valor Referência Acordo Promocional é igual a 6. Campo considerado apenas em itens do tipo P (Promoção). | Integer | |
| status | Situação do item na promoção. A = Ativo ou I = Inativo. | String | |
| seqFamilia | Código sequencial da família. | Integer | |
| promocaoPorFamilia | Promoção por família | String | |
| familia | Lista os dados das famílias. | ||
| seqFamilia | Código sequencial da família no ERP | Integer | |
| descricao | Descrição da família | String | |
| produto | Lista os dados dos produtos. | ||
| seqProduto | Código sequencial do produto no ERP | Integer | |
| descricaoReduzida | Descrição reduzida do produto | String | |
| listaPrecoAPartirDe | Lista as condições dos preços | Integer | |
| valorDesconto | Valor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 3 = Valor do Desconto | Integer | |
| percentualDesconto | Percentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 2 = Percentual Desconto | Integer | |
| precoPromocao | Valor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. Quando Tipo Desconto é igual a 1 = Preço de Venda | Integer | |
| tipoDesconto | Define o tipo de ação promocional configurada para o item. Opções: 1 = Preço de Venda; 2 = Percentual Desconto; 3 = Valor do Desconto. | String | |
| qtdApartirDe | Define a quantidade mínima de venda do grupo para aplicar a promoção | Integer | |
| empresa | Lista os dados das empresas. | ||
| numeroEmpresa | Número da empresa participante da promoção | Integer | |
| nomeReduzido | Nome reduzido da empresa participante | String | |
| cnpj | CNPJ da empresa participante da promoção | String | |
| status | Situação da empresa na promoção. A = Ativa ou I = Inativa. | String | |
grupos | seqGrupo | Número de código do grupo | Integer |
| descricao | Descrição do grupo de produtos para promoção | String | |
| qtdItemGrupo | Define a quantidade de venda necessária, de itens pertencentes ao grupo, conforme verificação do parâmetro Tipo Quantidade, sendo em itens distintos, ou quantidade total entre os itens | Integer | |
| status | Situação do grupo na promoção. A = Ativo ou I = Inativo. | String | |
| listaGrupoPrecoAPartirDe | Define a quantidade mínima de venda do grupo para aplicar a promoção | ||
| valorDesconto | Valor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 3 = Valor do Desconto | Integer | |
| percentualDesconto | Percentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 2 = Percentual Desconto | Integer | |
| precoPromocao | Valor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. Quando Tipo Desconto é igual a 1 = Preço de Venda | Integer | |
| qtdApartirDe | Define a quantidade mínima de venda do grupo para aplicar a promoção | Integer | |
| itens | Lista os dados dos produtos | ||
| seqProduto | Código sequencial do produto no ERP | Integer | |
| codBarras | Código de barras EAN ou DUN do produto. Será considerada a embalagem em que o código informado está cadastrado. | String | |
| qtdEmbalagem | Quantidade da Embalagem do produto para a promoção | Integer | |
| quantidade | Indica a quantidade a ser vendida do produto, para estar apto à ação promocional. Quantidade de acordo com a embalagem definida. | Integer | |
| tipoItem | Indica o tipo de verificação da venda do item no combo. Opções: N = Normal ou P = Promoção. | String | |
| 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, retorna valor zero. | Integer | |
| 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, retorna valor zero. | Integer | |
| validoFamilia | Indica se a promoção é válida para os demais produtos da mesma família do item informado. Opções: S = Sim ou N = Não. | String | |
| valorRefAcordoPromoc | Indica o tipo de valor que será usado como referência para a geração do acordo promocional, na apuração das vendas, quando se controla Verba em vendas por PDV. Opções: 1 = Preço Promocional; nulo ou 2 = Preço Atual de Venda; 3 = Custo Líquido; 4 = Custo Bruto; 5 = Custo da Última Entrada; 6 = Livre. Campo considerado apenas em itens do tipo P (Promoção). | Integer | |
| valorLivreRefAcordoPromoc | Valor que será usado como referência para a geração do acordo promocional, na apuração das vendas, quando se controla Verba em vendas por PDV. Somente será informado quando o tipo de Valor Referência Acordo Promocional é igual a 6. Campo considerado apenas em itens do tipo P (Promoção). | Integer | |
| status | Situação do item na promoção. A = Ativo ou I = Inativo. | String | |
| seqFamilia | Código sequencial da família | Integer | |
| promocaoPorFamilia | Promoção por família | String | |
| familia | Lista os dados das famílias. | ||
| seqFamilia | Código sequencial da família no ERP | Integer | |
| descricao | Descrição da família | String | |
| produto | Lista os dados dos produtos. | ||
| seqProduto | Código sequencial do produto no ERP | Integer | |
| descricaoReduzida | Descrição reduzida do produto | String | |
| listaPrecoAPartirDe | Lista as condições dos preços | ||
| valorDesconto | Valor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 3 = Valor do Desconto | Integer | |
| percentualDesconto | Percentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. Quando Tipo Desconto é igual a 2 = Percentual Desconto | Integer | |
| precoPromocao | Valor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. Quando Tipo Desconto é igual a 1 = Preço de Venda | Integer | |
| tipoDesconto | Define o tipo de ação promocional configurada para o item. Opções: 1 = Preço de Venda; 2 = Percentual Desconto; 3 = Valor do Desconto. | String | |
| qtdApartirDe | Define a quantidade mínima de venda do grupo para aplicar a promoção | Integer | |
| empresa | Lista os dados das empresas. | ||
| numeroEmpresa | Número da empresa participante da promoção | Integer | |
| nomeReduzido | Nome reduzido da empresa participante | String | |
| cnpj | CNPJ da empresa participante da promoção | String | |
| status | Situação da empresa na promoção. A = Ativa ou I = Inativa. | String | |
empresas | numeroEmpresa | Número da empresa participante da promoção | Integer |
| nomeReduzido | Nome reduzido da empresa participante | String | |
| cnpj | CNPJ da empresa participante da promoção | String | |
| status | Situação da empresa na promoção. A = Ativa ou I = Inativa. | String | |
| _expandables | _expandables | Propriedade para expandir os campos. | String |
{
"hasNext":true,
"items":[
{
"seqPromocaoPdv":0,
"descricao":"string",
"status":"string",
"dataInicio":"2021-05-17T19:28:16.916Z",
"dataFim":"2021-05-17T19:28:16.916Z",
"tipoPromocao":"string",
"tipoQuantidade":"string",
"tipoQtdeCargaPdv":"string",
"controlaVerbaPdv":"string",
"baixaQtdeVerbaBonif":"string",
"descricaoEtiqueta":"string",
"codParceiro":0,
"usuAlteracao":"string",
"dtaAlteracao":"2021-05-17T19:28:16.916Z",
"itens":[
{
"seqProduto":0,
"codBarras":"string",
"qtdEmbalagem":0,
"quantidade":0,
"tipoItem":"string",
"precoItem":0,
"percentualDesconto":0,
"validoFamilia":"string",
"valorRefAcordoPromoc":0,
"valorLivreRefAcordoPromoc":0,
"status":"string",
"seqFamilia":0,
"promocaoPorFamilia":"string",
"familia":{
"seqFamilia":0,
"descricao":"string"
},
"produto":{
"seqProduto":0,
"descricaoReduzida":"string"
},
"listaPrecoAPartirDe":[
{
"valorDesconto":0,
"percentualDesconto":0,
"precoPromocao":0,
"tipoDesconto":"string",
"qtdApartirDe":0,
"empresa":{
"numeroEmpresa":0,
"nomeReduzido":"string",
"cnpj":"string",
"status":"string"
}
}
]
}
],
"grupos":[
{
"seqGrupo":0,
"descricao":"string",
"qtdItemGrupo":0,
"status":"string",
"listaGrupoPrecoAPartirDe":[
{
"valorDesconto":0,
"percentualDesconto":0,
"precoPromocao":0,
"qtdApartirDe":0
}
],
"itens":[
{
"seqProduto":0,
"codBarras":"string",
"qtdEmbalagem":0,
"quantidade":0,
"tipoItem":"string",
"precoItem":0,
"percentualDesconto":0,
"validoFamilia":"string",
"valorRefAcordoPromoc":0,
"valorLivreRefAcordoPromoc":0,
"status":"string",
"seqFamilia":0,
"promocaoPorFamilia":"string",
"familia":{
"seqFamilia":0,
"descricao":"string"
},
"produto":{
"seqProduto":0,
"descricaoReduzida":"string"
},
"listaPrecoAPartirDe":[
{
"valorDesconto":0,
"percentualDesconto":0,
"precoPromocao":0,
"tipoDesconto":"string",
"qtdApartirDe":0,
"empresa":{
"numeroEmpresa":0,
"nomeReduzido":"string",
"cnpj":"string",
"status":"string"
}
}
]
}
]
}
],
"empresas":[
{
"numeroEmpresa":0,
"nomeReduzido":"string",
"cnpj":"string",
"status":"string"
}
],
"_expandables":[
"string"
]
}
]
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas