Consulta de Ordens de Carga

Regras de negócio

Permite gerar uma ordem de carga com base nos pedidos de venda e informando os dados da entrega,como região, veículo e motorista. Uma ordem de carga é emitida e utilizada na rotina de formação de cargas, agrupando e vinculando os pedidos a elas.
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/360045119713-Ordens-de-Carga

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a OrdemCarga que por sua vez instancia a tabela TGFORD 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 foram utilizados como filtro os campos CODEMP e ORDEMCARGA, porém você pode utilizar outros campos da entidade .

• CODEMP – Código da Empresa.

• ORDEMCARGA – Número da Ordem de carga.

Para utilizarmos o filtro, basta acrescentar no corpo da requisição o código abaixo utilizando o criteria:
      "criteria": {
        "expression": {
          "$": "this.CODEMP = ? and this.ORDEMCARGA = ?" 
        },
        "parameter":[
          {
             "type":"I",
             "value":"1"
          },
          {
             "type":"I",
             "value":"19"
          }
        ]
      }

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 TGFORD

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": "OrdemCarga",
      "includePresentationFields": "S",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODEMP = ? and this.ORDEMCARGA = ?" 
        },
        "parameter":[
          {
             "type":"I",
             "value":"1"
          },
          {
             "type":"I",
             "value":"19"
          }
        ]
      },
      "entity": {
        "fieldset": {
              "list":"CODEMP,ORDEMCARGA,TOTALCARGA,CODREG"
        }
      }
    }
  }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.loadRecords",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "1F8B41F8F96622039906D599031ECF9E",
    "responseBody": {
        "entities": {
            "total": "1",
            "hasMoreResult": "false",
            "offsetPage": "0",
            "offset": "0",
            "metadata": {
                "fields": {
                    "field": [
                        {
                            "name": "CODEMP"
                        },
                        {
                            "name": "ORDEMCARGA"
                        },
                        {
                            "name": "TOTALCARGA"
                        },
                        {
                            "name": "CODREG"
                        },
                        {
                            "name": "Empresa_NOMEFANTASIA"
                        },
                        {
                            "name": "Regiao_NOMEREG"
                        }
                    ]
                }
            },
            "entity": {
                "f0": {
                    "$": "1"
                },
                "f1": {
                    "$": "19"
                },
                "f2": {},
                "f3": {
                    "$": "10200"
                },
                "f4": {
                    "$": "WCS PRESTAÇÃO DE SERVIÇOS"
                },
                "f5": {
                    "$": "Sul de Minas"
                }
            }
        }
    }
}
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!