Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método para alterar promoções.

Chamada

PUT [URLAPI]/PromocaoAPI/api/v1/Promocao/{seqPromocao}

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)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
seqPromocao Sequencial da Promoçãointeger($int32)Obrigatório

Parâmetros do Corpo (Body Parameters)

AtualizarPromocaoDto

Informações para alteração








NomeDescriçãoTipo(Type)Exigência
descricaoDescrição da promoçãostringObrigatório
dtaInicioData inicial da promoçãostring($date-time)Obrigatório
dtaFimData final da promoçãostring($date-time)Obrigatório
faixaAcrFinanceiroIndica 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.stringOpcional. Valor padrão = A.
seqGrupoPromocIndica o grupo que a promoção pertenceinteger($int32)Opcional
indUsaAcrescTabVendaIndica 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.stringOpcional
tipoMediaVdaIndica 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.stringOpcional. Valor padrão = P.



empresas (AtualizarEmpresaDto)

nroEmpresaNúmero de cadastro da empresa no ERP que está vinculada a promoçãointeger($int32)Opcional. Obrigatório quando não informado CNPJ da empresa.
cnpjEmpresaCNPJ da empresa que está vinculada a promoçãostringOpcional. Obrigatório quando não informado número da empresa. Se enviar número e CNPJ, prevalece o número.
statusSituação da empresa na promoção. A = Ativa, I = Inativa.stringOpcional. Valor padrão = A.

segmentos (AtualizarSegmentoDto)

nroSegmentoNúmeros dos segmentos de venda, que se aplicam a promoçãointeger($int32)
Obrigatório no mínimo 1.
statusSituação do segmento de venda na promoção. A = Ativa, I = Inativa.stringOpcional. Valor padrão = A.




produtos (AtualizarPromocaoItemDto)

seqProduto
Código sequencial do produto no ERP		integer($int32)Opcional. Obrigatório quando não informado código de barras.
codAcesso
Código de barras EAN ou DUN do produto. Será considerada a embalagem em que o código informado está cadastrado.		stringOpcional. Obrigatório quando não informado o código sequencial do produto. Se enviar os dois códigos, prevalece o sequencial.
statusSituação do produto na promoção. A = Ativa, I = Inativa.stringOpcional. Valor padrão = A.
qtdEmbalagemEmbalagem do produto para promoçãonumber($double)Obrigatório quando não informado o código de barras do produto.
precoPromocionalValor do preço de promoção do produtonumber($double)Obrigatório

expandablesPropriedade de expandir os campos.stringNão há.
{
  "descricao": "string",
  "dtaInicio": "2020-12-31T14:40:38.142Z",
  "dtaFim": "2020-12-31T14:40:38.142Z",
  "faixaAcrFinanceiro": "string",
  "seqGrupoPromoc": 0,
  "indUsaAcrescTabVenda": "string",
  "tipoMediaVda": "string",
  "empresas": [
    {
    "nroEmpresa": 0,
    "cnpjEmpresa": "string",
    "status": "string"
    }
  ],
  "segmentos": [
    {
    "nroSegmento": 0,
    "status": "string"
    }
  ],
  "produtos": [
    {
    "seqProduto": 0,
    "codAcesso": "string",
    "qtdEmbalagem": 0,
    "precoPromocional": 0,
    "status": "string"
    }
  ],
  "_expandables": [
  "string"
  ]
}


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 201 - SUCCESS

ErrorResponse


{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "string",
      "message": "string",
      "detailedMessage": "string"
    }
  ]
}