Árvore de páginas

Objetivo

Método de consulta de promoções do tipo normal no ERP.

Chamada

GET [URLAPI]/PromocaoAPI/api/v1/Promocao

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 Promoções Normais do ERP


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)

NomeDescriçãoTipo (Type)Exigência
CnpjEmpresaCNPJ da empresa utilizada como filtro de informações das promoçõesstringOpcional
NroEmpresaNúmero de Empresa para filtrar as promoçõesinteger($int32)Opcional
NroSegmentoNúmero do segmento de venda para filtrar as promoçõesinteger($int32)Opcional
StatusA = ativo (somente produtos ativos), I = inativo (somente produtos inativos),  T = todos (produtos ativos e inativos). Status padrão: A.

string

Opcional
VigenteSomente Promoções em vigor no momentostringOpcional
SeqPromocaoFiltro de promoção normal específicainteger($int32)Opcional

DtaHoraAlteracao

Filtro para buscar promoções alteradas a partir de uma data (item / cabeçalho)string($date-time)Opcional
DataInicioFiltro para buscar promoções que tem início a partir de uma datastring($date-time)Opcional
FieldsCamposstringNão há
OrderOrdenação dos CamposstringNão há
PageNúmero da Página

integer($int32)

Não há
PageSizeTamanho da Página

integer($int32)

Não há

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

 Informações de Resposta

Nome

Descrição

Tipo

Origem

seqPromocao

Número do código da promoção

 integer($int32)

Código gerado internamente a cada promoção criada. Promoções > Promoção (parte numérica)

descricao

Descrição da promoção

 string

Promoções > Promoção (parte texto)

dtaInicio

Data inicial da promoção

 string($date-time)

Promoções > Período > Data Inicial

dtaFim

Data final da promoção

 string($date-time)

Promoções > Período > Data Final

faixaAcrFinanceiro

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.

 string

Promoções > aba Financeiro Promoção > Faixa de Acréscimo

seqGrupoPromoc

Indica o código e descrição do grupo que a promoção pertence

 integer($int32)

Interno banco de dados

indUsaAcrescTabVenda

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.

 string

Interno banco de dados

tipoMediaVda

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.

 string

Gerenciador de Preços > Pesquisa de Promoções > coluna Média Vda.

inativaPromocaoCCAcord

Indica se inativa a promoção quando não houver saldo do conta corrente de acordo promocional vinculado.

 string

Interno banco de dados

dtaHoraInclusao

Data e hora em que a promoção foi incluída no ERP

 string($date-time)

Interno banco de dados

dtaHoraAlteracao

Data e hora em que a promoção foi alterada no ERP

 string($date-time)

Interno banco de dados

empresas (EmpresaRetornoDto)

nroEmpresa

Número da empresa participante da promoção

 string

Promoções > aba Promoção >    Nro (grid Empresas)

cnpjEmpresa

CNPJ da empresa participante da promoção

 integer($int32)

Interno banco de dados


segmentos (SegmentoRetornoDto)

nroSegmento

Número do Segmento de Venda

 integer($int32)

Promoções > aba Itens da Promoção > Segmento

descSegmento

Descrição do Segmento de Venda

 string

Módulo    Parâmetros    >     menu                Dealer            > Manutenção de Segmentos de Venda







produtos (PromocaoItemDto)







seqPromocao

Código sequencial da promoção no ERP

integer($int32)


seqProdutoCódigo sequencial do produto no ERPinteger($int32)Promoções > aba Itens da Promoção > Código
descricaoCompleta

Descrição completa do produto

stringNão há.

codAcesso

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.

string

Cadastro de Produtos > aba Códigos


qtdEmbalagem


Embalagem do produto para promoção

number($double)

Promoções > aba Itens  da Promoção > Embalagem 

status

Situação do produto na promoção. A = Ativo ou I = Inativo.

string

Interno banco de dados

precoPromocional

Valor do preço de promoção do produto

number($double)

Promoções > aba Itens da Promoção > Preço

dtaHoraInclusao

Data e hora em que o produto foi incluído na promoção

string($date-time)

Interno banco de dados

dtaHoraAlteracao

Data e hora em que houve alteração do produto na promoção

string($date-time)

Interno banco de dados

empresas (EmpresaPromocaoItemDto)

nroEmpresa

Conjunto das empresas em promoção para o produto. Número Empresa.

integer($int32)

Promoções > aba Promoção >    Nro (grid Empresas)

segmentos (SegmentoPromocaoItemDto)

nroSegmento

Conjunto dos segmentos de venda que se aplica a promoção para o produto. Número de segmento.

integer($int32)

Promoções > aba Itens da Promoção > Segmento

{
  "hasNext": true,
  "items": [
    {
      "seqPromocao": 0,
      "descricao": "string",
      "dtaInicio": "2020-12-22T13:14:54.266Z",
      "dtaFim": "2020-12-22T13:14:54.266Z",
      "faixaAcrFinanceiro": "string",
      "seqGrupoPromoc": 0,
      "indUsaAcrescTabVenda": "string",
      "tipoMediaVda": "string",
      "inativaPromocaoCCAcord": "string",
      "dtaHoraInclusao": "2020-12-22T13:14:54.266Z",
      "dtaHoraAlteracao": "2020-12-22T13:14:54.266Z",
      "empresas": [
        {
          "nroEmpresa": 0,
          "cnpjEmpresa": "string"
        }
      ],
      "segmentos": [
        {
          "nroSegmento": 0,
          "descSegmento": "string"
        }
      ],
      "produtos": [
        {
          "seqPromocao": 0,
          "seqProduto": 0,
		  "descricaoCompleta": "string",
          "codAcesso": "string",
          "qtdEmbalagem": 0,
          "status": "string",
          "precoPromocional": 0,
          "dtaHoraInclusao": "2020-12-22T13:14:54.266Z",
          "dtaHoraAlteracao": "2020-12-22T13:14:54.266Z",
          "empresas": [
            {
              "nroEmpresa": 0
            }
          ],
          "segmentos": [
            {
              "nroSegmento": 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"
    }
  ]
}