Árvore de páginas

Objetivo

Método para atualização de informações da API de combos promocionais.

Chamada

PATCH [URLAPI]/SMPromocoesAPI/api/v1/CombosPromocionais

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 de Combos Promocionais


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)

seqPromocaoIdentificados da promoção

integer($int64)

Não há

Parâmetros do Corpo (Body Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

pathCaminhostringSomente "/descricao", "/datainicio", "/datafim", "/status", "/descricaoEtiqueta" e "/statusempresa" estão habilitados.
opTipo de Operação -  “replace”stringSomente a operação "replace" está habilitada.
valueValorstringNã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

{
  "seqPromocaoPdv": 0,
  "descricao": "string",
  "status": "string",
  "dataInicio": "2021-05-17T18:32:56.360Z",
  "dataFim": "2021-05-17T18:32:56.361Z",
  "tipoPromocao": "string",
  "tipoQuantidade": "string",
  "tipoQtdeCargaPdv": "string",
  "controlaVerbaPdv": "string",
  "baixaQtdeVerbaBonif": "string",
  "descricaoEtiqueta": "string",
  "usuAlteracao": "string",
  "dtaAlteracao": "2021-05-17T18:32:56.361Z",
  "itens": [
      {
      "seqProduto": 0,
      "codBarras": "string",
      "qtdEmbalagem": 0,
      "quantidade": 0,
      "tipoItem": "string",
      "precoItem": 0,
      "percentualDesconto": 0,
      "validoFamilia": "string",
      "valorRefAcordoPromoc": 0,
      "valorLivreRefAcordoPromoc": 0,
      "status": "string",
      "seqFamilia": 0,
      "promocaoPorFamilia": "string",
      "familia": {
        "seqFamilia": 0,
        "descricao": "string"
      },
      "produto": {
        "seqProduto": 0,
        "descricaoReduzida": "string"
      },
      "listaPrecoAPartirDe": [
        {
          "valorDesconto": 0,
          "percentualDesconto": 0,
          "precoPromocao": 0,
          "qtdApartirDe": 0,
          "empresa": {
            "numeroEmpresa": 0,
            "nomeReduzido": "string",
            "cnpj": "string",
            "status": "string"
          ]
        }
      ]
    }
  ],
  "grupos": [
    {
      "seqGrupo": 0,
      "descricao": "string",
      "qtdItemGrupo": 0,
      "status": "string",
      "listaGrupoPrecoAPartirDe": [
        {
          "valorDesconto": 0,
          "percentualDesconto": 0,
          "precoPromocao": 0,
          "qtdApartirDe": 0
        }
      ],
      "itens": [
        {
          "seqProduto": 0,
          "codBarras": "string",
          "qtdEmbalagem": 0,
          "quantidade": 0,
          "tipoItem": "string",
          "precoItem": 0,
          "percentualDesconto": 0,
          "validoFamilia": "string",
          "valorRefAcordoPromoc": 0,
          "valorLivreRefAcordoPromoc": 0,
          "status": "string",
          "seqFamilia": 0,
          "promocaoPorFamilia": "string",
          "familia": {
            "seqFamilia": 0,
            "descricao": "string"
          },
          "produto": {
            "seqProduto": 0,
            "descricaoReduzida": "string"
          },
          "listaPrecoAPartirDe": [
            {
              "valorDesconto": 0,
              "percentualDesconto": 0,
              "precoPromocao": 0,
              "qtdApartirDe": 0,
              "empresa": {
                "numeroEmpresa": 0,
                "nomeReduzido": "string",
                "cnpj": "string",
                "status": "string"
              }
            }
          ]
        }
      ]
    }
  ],
  "empresas": [
    {
      "numeroEmpresa": 0,
      "nomeReduzido": "string",
      "cnpj": "string",
      "status": "string"
    }
  ],
  "_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"
    }
  ]
}