Exibir origem

Objetivo

Método de consulta de grupos de promoções cadastradas no ERP.

Chamada

GET /api/v1/GrupoPromocao

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome	Descrição	Tipo (Type)	Exigência
CNPJ Empresa	CNPJ da empresa utilizada como filtro de informações das promoções	string	Opcional
Número Empresa	Número de Empresa para filtrar as promoções	integer($int32)	Opcional
Segmento	Número do segmento de venda para filtrar as promoções	integer($int32)	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	string	Opcional
Código Promoção	Filtro de promoção normal específica	integer($int32)	Opcional
Data Hora de Alteração	Filtro para buscar promoções alteradas a partir de uma data (item / cabeçalho)	string($date-time)	Opcional
Data Início	Filtro para buscar promoções que tem início a partir de uma data	string($date-time)	Opcional

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

PromocaoDtoIListDto

Nome	Descrição	Origem
Código da Promoção	Número do código da promoção	Código gerado internamente a cada promoção criada. Promoções > Promoção (parte numérica)
Descrição	Descrição da promoção	Promoções > Promoção (parte texto)
Data Início da Promoção	Data inicial da promoção	Promoções > Período > Data Inicial
Data Fim da Promoção	Data final da promoção	Promoções > Período > Data Final
Faixa de Acréscimo Financeiro	Indica a faixa de acréscimo para cálculo do preço de tabela, na venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.	Promoções > aba Promoção > Faixa de Acréscimo Financeiro
Grupo de Promoção	Indica o código e descrição do grupo que a promoção pertence	Interno banco de dados
Indicador se Usa Acréscimo de Tabela de venda	Indica se aplica acréscimo de tabela de venda, ao calcular o preço de venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.	Interno banco de dados
Tipo de Média de Venda	Indica o tipo cálculo de média de venda em que deve se enquadrar as vendas dos produtos da promoção. P = Promoção / N = Normal.	Gerenciador de Preços > Pesquisa de Promoções > coluna Média Vda.
Inativa Promoção sem Saldo de Acordo	Indica se inativa a promoção quando não houver saldo do conta corrente de acordo promocional vinculado.	Interno banco de dados
Data e hora de inclusão	Data e hora em que a promoção foi incluída no ERP	Interno banco de dados
Data e hora de alteração	Data e hora em que a promoção foi alterada no ERP	Interno banco de dados

Informações de Resposta
Nome	Descrição		Origem
Código da Promoção	Número do código da promoção		Código gerado internamente a cada promoção criada. Promoções > Promoção (parte numérica)
Descrição	Descrição da promoção		Promoções > Promoção (parte texto)
Data Início da Promoção	Data inicial da promoção		Promoções > Período > Data Inicial
Data Fim da Promoção	Data final da promoção		Promoções > Período > Data Final
Faixa de Acréscimo Financeiro	Indica a faixa de acréscimo para cálculo do preço de tabela, na venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.		Promoções > aba Financeiro Promoção > Faixa de Acréscimo
Grupo de Promoção	Indica o código e descrição do grupo que a promoção pertence		Interno banco de dados
Indicador se Usa Acréscimo de Tabela de venda	Indica se aplica acréscimo de tabela de venda, ao calcular o preço de venda dos produtos da promoção. Utilizado em vendas pelo módulo Venda Balcão.		Interno banco de dados
Tipo de Média de Venda	Indica o tipo cálculo de média de venda em que deve se enquadrar as vendas dos produtos da promoção. P = Promoção / N = Normal.		Gerenciador de Preços > Pesquisa de Promoções > coluna Média Vda.
Inativa Promoção sem Saldo de Acordo	Indica se inativa a promoção quando não houver saldo do conta corrente de acordo promocional vinculado.		Interno banco de dados
Data e hora de inclusão	Data e hora em que a promoção foi incluída no ERP		Interno banco de dados
Data e hora de alteração	Data e hora em que a promoção foi alterada no ERP		Interno banco de dados
Lista de Empresas da Promoção	Número da Empresa	Número da empresa participante da promoção		Promoções > aba Promoção > Nro (grid Empresas)
	CNPJ Empresa	CNPJ da empresa participante da promoção		Interno banco de dados
Lista de Segmentos de Venda da Promoção	Segmento de Venda	Número do Segmento de Venda		Promoções > aba Itens da Promoção > Segmento
	Descrição	Descrição do Segmento de Venda	Módulo Parâmetros > menu Dealer > Manutenção de Segmentos de Venda

Lista de Produtos incluídos na promoção	Código Sequencial do Produto	Código sequencial do produto no ERP	Promoções > aba Itens da Promoção > Código
	Código de Barras do Produto	Código de barras do produto (GTIN) de acordo com a embalagem da promoção. Quando existir mais de um código cadastrado, retorna o maior.	Cadastro de Produtos > aba Códigos
	Embalagem de Venda	Embalagem do produto para promoção	Promoções > aba Itens da Promoção > Embalagem
	Status	Situação do produto na promoção. A = Ativo ou I = Inativo.	Interno banco de dados
	Preço Promocional	Valor do preço de promoção do produto	Promoções > aba Itens da Promoção > Preço
	Data e hora de inclusão	Data e hora em que o produto foi incluído na promoção	Interno banco de dados
	Data e hora de alteração	Data e hora em que houve alteração do produto na promoção	Interno banco de dados
	Empresas	Conjunto das empresas em promoção para o produto. Número Empresa.	Promoções > aba Promoção > Nro (grid Empresas)
	Segmento de Venda	Conjunto dos segmentos de venda que se aplica a promoção para o produto. Número de segmento.	Promoções > aba Itens da Promoção > Segmento