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)

NomeDescriçãoTipo (Type)Exigência
CNPJ EmpresaCNPJ da empresa utilizada como filtro de informações das promoçõesstringOpcional
Número EmpresaNúmero de Empresa para filtrar as promoçõesinteger($int32)Opcional
SegmentoNúmero do segmento de venda para filtrar as promoçõesinteger($int32)Opcional
StatusA = ativo (somente produtos ativos), I = inativo (somente produtos inativos). Padrão: A.

string

Opcional
VigenteSomente Promoções em vigor no momentostringOpcional
Código PromoçãoFiltro de promoção normal específicainteger($int32)Opcional
Data Hora de AlteraçãoFiltro para buscar promoções alteradas a partir de uma data (item / cabeçalho)string($date-time)Opcional
Data InícioFiltro para buscar promoções que tem início a partir de uma datastring($date-time)Opcional


Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

PromocaoDtoIListDto

 Informações de Resposta

Nome

Descrição

Tipo

Origem

Código da Promoção

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)

Descrição

Descrição da promoção

 string

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

Data Início da Promoção

Data inicial da promoção

 string($date-time)

Promoções > Período > Data Inicial

Data Fim da Promoção

Data final da promoção

 string($date-time)

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.

 string

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

 integer($int32)

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.

 string

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.

 string

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.

 string

Interno banco de dados

Data e hora de inclusão

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

 string($date-time)

Interno banco de dados

Data e hora de alteração

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

 string($date-time)

Interno banco de dados

Lista de Empresas da Promoção

Número da Empresa

Número da empresa participante da promoção

 string

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

CNPJ Empresa

CNPJ da empresa participante da promoção

 integer($int32)

Interno banco de dados

Lista de Segmentos de Venda da Promoção

Segmento de Venda

Número do Segmento de Venda

 integer($int32)

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

Descrição

Descrição do Segmento de Venda

 string

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

integer($int32)

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.

string

Cadastro de Produtos > aba Códigos


Embalagem de Venda


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

Preço Promocional

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

number($double)

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

string($date-time)

Interno banco de dados

Data e hora de alteração

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

string($date-time)

Interno banco de dados

Empresas

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

integer($int32)

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.

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,
          "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"
    }
  ]
}