Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Método de consulta de grupos de promoções cadastradas 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


Image Added

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ênciaInformações Adicionais (Adittional Information)
CnpjEmpresaCNPJ da empresa utilizada como filtro de informações das promoçõesstringOpcionalNão há
NroEmpresaNúmero de Empresa para filtrar as promoçõesinteger($int32)OpcionalNão há
NroSegmentoNúmero do segmento de venda para filtrar as promoçõesinteger($int32)OpcionalNão há
StatusA = ativo (somente produtos ativos), I = inativo (somente produtos inativos), T = todos (produtos ativos e inativos). PadrãoStatus padrão: A.

string

OpcionalNão há
VigenteSomente Promoções em vigor no momentostringOpcionalNão há
SeqPromocaoFiltro de promoção normal específicainteger($int32)OpcionalNão há

DtaHoraAlteracao

Filtro para buscar promoções alteradas a partir de uma data (item / cabeçalho)string($date-time)OpcionalNão há
DataInicioFiltro para buscar promoções que tem início a partir de uma datastring($date-time)OpcionalNão há
FieldsCamposstringNão háValores aceitáveis: seqPromocao, descricao, dtaInicio, dtaFim, faixaAcrFinanceiro, seqGrupoPromoc, indUsaAcrescTabVenda, tipoMediaVda, inativaPromocaoCCAcord, dtaHoraInclusao, dtaHoraAlteracao
OrderOrdenação dos CamposstringNão háValores aceitáveis: seqPromocao, descricao, dtaInicio, dtaFim, faixaAcrFinanceiro, seqGrupoPromoc, indUsaAcrescTabVenda, tipoMediaVda, inativaPromocaoCCAcord, dtaHoraInclusao, dtaHoraAlteracao
PageNúmero da Página

integer($int32)

Não háNão há
PageSizeTamanho da Página

integer($int32)

Não háNão há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

PromocaoDtoIListDto

Lista de Produtos incluídos na promoção

Código Sequencial do Produto

 Informações de Resposta

Nome

Descrição

Tipo

Origem

Código da PromoçãoseqPromocao

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çãodescricao

Descrição da promoção

 string

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

Data Início da PromoçãodtaInicio

Data inicial da promoção

 string($date-time)

Promoções > Período > Data Inicial

Data Fim da PromoçãodtaFim

Data final da promoção

 string($date-time)

Promoções > Período > Data Final

Faixa      de              Acréscimo FinanceirofaixaAcrFinanceiro

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çãoseqGrupoPromoc

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 vendaindUsaAcrescTabVenda

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 VendatipoMediaVda

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 AcordoinativaPromocaoCCAcord

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ãodtaHoraInclusao

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çãodtaHoraAlteracao

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

 string($date-time)

Interno banco de dados

empresas (EmpresaRetornoDto)

nroEmpresa

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 EmpresacnpjEmpresa

CNPJ da empresa participante da promoção

 integer($int32)

Interno banco de dados


segmentos (SegmentoRetornoDto)

nroSegmento

Lista de Segmentos de Venda da Promoção

Segmento de Venda

Número do Segmento de Venda

 integer integer($int32)

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

DescriçãodescSegmento

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á.

codAcessoCó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 VendaqtdEmbalagem


Embalagem do produto para promoção

number($double)

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

Statusstatus

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

string

Interno banco de dados

Preço PromocionalprecoPromocional

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ãodtaHoraInclusao

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çãodtaHoraAlteracao

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

string($date-time)

Interno banco de dados

empresas (EmpresaPromocaoItemDto)

EmpresasnroEmpresa

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

integer($int32)

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

segmentos (SegmentoPromocaoItemDto)

Segmento de VendanroSegmento

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

Bloco de código
languageactionscript3
{
  "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


Bloco de código
languageactionscript3
{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "string",
      "message": "string",
      "detailedMessage": "string"
    }
  ]
}

...