Árvore de páginas

Versões comparadas

Chave

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

...

Parâmetros do Corpo (Body Parameters)












Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
descricao
Descrever a promoção do produto.

Descrição da promoção

string

Não há

dataInicio
Informar o

Data de início da promoção

do produto.

string ($date-time)Não há.
dataFim
Informar o fim

Data do término da promoção

do produto.

string ($date-time)
Não há.
tipoPromocao
Descrever o tipo de promoção do produto.

Tipo da promoção. (I - Itens ou G - Grupo)

string

Não há.

tipoQuantidade
Descrever a quantidade.

Tipo da Quantidade. (I - Itens Distintos ou T - Total Itens Grupo)

string
Não há.
tipoQtdeCargaPdv
Informar a quantidade de carga pdv.

Indica o tipo de ação do combo promocional. (M = “Múltiplos”, L = “Leve X Pague Y” e A = “Acima de / A partir de)”

stringNão há.
tipoVenda
Informar

Indica o tipo de

venda do produto.

venda para aplicação da ação promocional na venda. (1 = Venda a Vista / 2 = Cartão Cliente)

integer($int32)Não há.
controlaVerbaPdv
Controlar a verba pfv

Indica se a promoção faz o controle de verba nas vendas por PDV. (S = Sim / N = Não)

stringNão há.
baixaQtdeVerbaBonif
Baixar a quantidade de verba pfv

Indica se baixa verba, somente dos produtos e quantidades bonificados. (S = Sim / N = Não)

stringNão há.
descricaoEtiqueta
descrever a etiqueta do produto

Indica a descrição a ser emitida em etiquetas ou cartazes de divulgação da promoção.

stringNão há.


empresas

AdicionarMflPromocPdvEmpDto


nroEmpresaNúmero da
empresa
empresa participante da promoçãointeger($int64)Não há.
cnpj
Cnpj
Cnpj da empresa participante da promoçãostringNão há.
_expandablesPropriedade para expandir os camposstringNão há.













itens









AdicionarMflPromocPdvItemDto


seqProdutoCódigo sequencial do produto no ERPinteger($int64)Não há.
codAcesso

Código

do acesso

de barras do produto de acordo com a embalagem da promoção

stringNão há.
qtdEmbalagem
quantidade embalagem

Embalagem do produto para a ação promocional

number($double)Não há.
quantidade  Indica a quantidade a ser vendida do produto, para estar apto à ação promocional. Quantidade de acordo com a embalagem definida.number($double)Não há.
tipoItemIndica o tipo de verificação da venda do item no combo. (N = Normal ou P = Promoção) Não deve ser preenchido quando Tipo Qtde Carga PDV igual a "Acima de/ A partir de"stringNão há.
precoItem
   Preço item 
 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, sempre grava valor zero.number($double)Não há.
percentualDescontoPercentual 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, sempre grava valor zero.number($double)Não há.
validoFamilia
Válido para família 
Indica se a promoção é válida para os demais produtos da mesma família do item informado. (S = Sim ou N = Não)stringNão há.
valorRefAcordoPromoc
Valor referência acordo promocional
Indica o tipo de valor que será usado como referência para a geração do acordo promocional. (1 - Preço Promocional, 2 - Preço Atual de Venda, 3 - Custo Líquido, 4 - Custo Bruto, 5 - Custo da Última Entrada, 6 - Livre)integer($int32)Não há.
valorLivreRefAcordoPromoc
valor livre referência acordo promocional
Valor que será usado como referência para a geração do acordo promocional. Deverá ser informado somente quando o tipo de Valor Referência Acordo Promocional é igual a 6.number($double)Não há.
descApartirDeLista das informações de faixas da promoção por quantidade e valores de desconto

qtdApartirDeDefine a quantidade mínima de venda para aplicar a promoçãonumber($double)Não há.
tipoDescontoDefine o tipo de ação promocional a ser configurada para o item. Opções: 1. Preço de Venda; 2. Percentual Desconto; 3. Valor do DescontostringNão há.
precoPromocaoValor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. number($double)(Obrigatório quando Tipo Desconto é igual a 1- Preço de Venda)
percentualDescontoPercentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. number($double)(Obrigatório quando Tipo Desconto é igual a 2- Percentual Desconto)
valorDescontoValor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. number($double)(Obrigatório quando Tipo Desconto é igual a 3- Valor do Desconto)
_expandablespropriedade para expandir camposstringNão há.





















grupos

AdicionarMflPromocPdvGrupoDto


descricaoDescriçãostringNão há.
qtdItemGrupoQuantidade itens do grupointeger($int32)Não há.
descApartDeGrupo

Lista das informações de faixas da promoção por quantidade e valores de desconto



qtdApartirDe

Define a quantidade mínima de venda para aplicar a promoção


Não há.
tipoDesconto

Define o tipo de ação promocional a ser configurada para o item. Opções: 1. Preço de Venda; 2. Percentual Desconto; 3. Valor do Desconto


Não há.
precoPromocao  Valor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. 
(Obrigatório quando Tipo Desconto é igual a 1- Preço de Venda)
percentualDescontoPercentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. 
(Obrigatório quando Tipo Desconto é igual a 2- Percentual Desconto)
valorDescontoValor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. 
(Obrigatório quando Tipo Desconto é igual a 3- Valor do Desconto)
itensLista de Produtos do grupo a ser incluído na promoção

AdicionarMflPromocPdvItemDto


seqProdutoCódigo sequencial do produto no ERPinteger($int64)Não há.
codAcesso

Código de barras do produto de acordo com a embalagem da promoção

stringNão há.
qtdEmbalagem

Embalagem do produto para a ação promocional

number($double)Não há.
quantidade  Indica a quantidade a ser vendida do produto, para estar apto à ação promocional. Quantidade de acordo com a embalagem definida.number($double)Não há.
tipoItemIndica o tipo de verificação da venda do item no combo. (N = Normal ou P = Promoção) Não deve ser preenchido quando Tipo Qtde Carga PDV igual a "Acima de/ A partir de"stringNão há.
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, sempre grava valor zero.number($double)Não há.
percentualDescontoPercentual 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, sempre grava valor zero.number($double)Não há.
validoFamiliaIndica se a promoção é válida para os demais produtos da mesma família do item informado. (S = Sim ou N = Não)stringNão há.
valorRefAcordoPromocIndica o tipo de valor que será usado como referência para a geração do acordo promocional. (1 - Preço Promocional, 2 - Preço Atual de Venda, 3 - Custo Líquido, 4 - Custo Bruto, 5 - Custo da Última Entrada, 6 - Livre)integer($int32)Não há.
valorLivreRefAcordoPromocValor que será usado como referência para a geração do acordo promocional. Deverá ser informado somente quando o tipo de Valor Referência Acordo Promocional é igual a 6.number($double)Não há.
descApartirDeLista das informações de faixas da promoção por quantidade e valores de desconto

qtdApartirDeDefine a quantidade mínima de venda para aplicar a promoçãonumber($double)Não há.
tipoDescontoDefine o tipo de ação promocional a ser configurada para o item. Opções: 1. Preço de Venda; 2. Percentual Desconto; 3. Valor do DescontostringNão há.
precoPromocaoValor do preço do item promocional, em R$, a ser aplicado a partir da quantidade definida. number($double)(Obrigatório quando Tipo Desconto é igual a 1- Preço de Venda)
percentualDescontoPercentual de desconto a ser aplicado no item promocional, a partir da quantidade definida. number($double)(Obrigatório quando Tipo Desconto é igual a 2- Percentual Desconto)
valorDescontoValor de desconto, em R$, a ser aplicado no item promocional, a partir da quantidade definida. number($double)(Obrigatório quando Tipo Desconto é igual a 3- Valor do Desconto)
_expandablespropriedade para expandir camposstringNão há.



Bloco de código
languageactionscript3
[
  {
    "descricao": "string",
    "dataInicio": "2021-04-27T12:21:43.501Z",
    "dataFim": "2021-04-27T12:21:43.501Z",
    "tipoPromocao": "string",
    "tipoQuantidade": "string",
    "tipoQtdeCargaPdv": "string",
    "tipoVenda": 0,
    "controlaVerbaPdv": "string",
    "baixaQtdeVerbaBonif": "string",
    "descricaoEtiqueta": "string",
    "empresas": [
      {
        "nroEmpresa": 0,
        "cnpj": "string",
        "_expandables": [
          "string"
        ]
      }
    ],
    "itens": [
      {
        "seqProduto": 0,
        "codAcesso": "string",
        "qtdEmbalagem": 0,
        "quantidade": 0,
        "tipoItem": "string",
        "precoItem": 0,
        "percentualDesconto": 0,
        "validoFamilia": "string",
        "valorRefAcordoPromoc": 0,
        "valorLivreRefAcordoPromoc": 0,
        "descApartirDe": [
          {
            "qtdApartirDe": 0,
            "tipoDesconto": "string",
            "precoPromocao": 0,
            "percentualDesconto": 0,
            "valorDesconto": 0,
            "_expandables": [
              "string"
            ]
          }
        ],
        "_expandables": [
          "string"
        ]
      }
    ],
    "grupos": [
      {
        "descricao": "string",
        "qtdItemGrupo": 0,
        "descApartDeGrupo": [
          {
            "qtdApartirDe": 0,
            "tipoDesconto": "string",
            "precoPromocao": 0,
            "percentualDesconto": 0,
            "valorDesconto": 0,
            "_expandables": [
              "string"
            ]
          }
        ],
        "itens": [
          {
            "seqProduto": 0,
            "codAcesso": "string",
            "qtdEmbalagem": 0,
            "quantidade": 0,
            "tipoItem": "string",
            "precoItem": 0,
            "percentualDesconto": 0,
            "validoFamilia": "string",
            "valorRefAcordoPromoc": 0,
            "valorLivreRefAcordoPromoc": 0,
            "descApartirDe": [
              {
                "qtdApartirDe": 0,
                "tipoDesconto": "string",
                "precoPromocao": 0,
                "percentualDesconto": 0,
                "valorDesconto": 0,
                "_expandables": [
                  "string"
                ]
              }
            ],
            "_expandables": [
              "string"
            ]
          }
        ],
        "_expandables": [
          "string"
        ]
      }
    ],
    "_expandables": [
      "string"
    ]
  }
]


Informações para Resposta (Response Information)

...