Regras de negócio

Para realizar consulta de marca de produto primeiramente, se deve realizar cadastramento da marca que tem por objetivo a padronização das marcas empregadas nos produtos; uma vez que existem algumas marcas que podem ser cadastradas de maneira equivocada (utilização de hífens, espaços etc), a uniformidade deste cadastro atua na prevenção desse tipo de ocorrência.
Além disso, ao inserir uma marca no ERP da mesma nomenclatura de uma marca contida, as modificações efetuadas na nova marca não atingiram a marca anterior, reciprocamente. Deste modo, mantêm-se dois cadastros diferentes que podem causar a perda de padronização das marcas empregadas nos produtos. OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:
https://ajuda.sankhya.com.br/hc/pt-br/articles/360044602814-Marcas

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a MarcaProduto que por sua vez instancia a tabela TGFMAR mapeando os campos principais.
Para realizarmos a busca através do Json, utilizamos o serviço "CRUDServiceProvider.loadRecords".

O serviço CRUDServiceProvider.loadRecords é um otimo serviço para ser utilizado para consulta de dados através do JSON.

No exemplo abaixo foi utilizado como filtro o campo CODIGO, porém você pode utilizar outros campos da entidade.

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:

    "criteria": {
      "expression": {
        "$": "this.CODIGO = ?"
      },
      "parameter":[
        {
           "type":"I",
           "value":"666"
        }
      ]
    }

Para melhor performance sempre utilize nas suas consultas apenas os campos necessários, para evitar tráfego de dados que não serão utilizados.

Descritivo de campos da entidade

Acesse aqui o dicionário de dados da tabela TGFMAR

Exemplo de uso:

URL de chamada: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecords&outputType=json

Corpo de requisição

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "requestBody": {
    "dataSet": {
      "rootEntity": "MarcaProduto",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODIGO = ?"
        },
        "parameter":[
          {
             "type":"I",
             "value":"666"
          }
        ]
      },
      "entity": {
        "fieldset": {
          "list": "CODIGO,DESCRICAO"
        }
      }
    }
  }
}

Retorno em json:

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "status": "1",
  "pendingPrinting": "false",
  "transactionId": "79C87EB2A2F72A2AA50BF04410B9EC6D",
  "responseBody": {
      "entities": {
          "total": "1",
          "hasMoreResult": "false",
          "offsetPage": "0",
          "offset": "0",
          "metadata": {
              "fields": {
                  "field": [
                      {
                          "name": "CODIGO"
                      },
                      {
                          "name": "DESCRICAO"
                      }
                  ]
              }
          },
          "entity": {
              "f0": {
                  "$": "666"
              },
              "f1": {
                  "$": "MARCATESTE"
              }
          }
      }
  }
}