Lista De Transporte

listaTransporte

Obtem Lista de Transporte

get

/listaTransporte/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Lista de Transporte

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

codListaTransporteintegerOpcional

Código da Lista de Transporte

situacaointegerOpcional

Código da Situação de Lista de Transporte

descSituacaostringOpcional

Descrição da Situação da Lista de Transporte

codTransportadoraintegerOpcional

Código da Transportadora da Lista de Transporte

descTransportadorastringOpcional

Descrição da Transportadora da Lista de Transporte

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get/listaTransporte/{id}

GET /comercial/v10/listaTransporte/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codListaTransporte": 1,
  "situacao": 1,
  "descSituacao": "text",
  "codTransportadora": 1,
  "descTransportadora": "text",
  "notasFiscaisListaTransp": [
    {
      "dataEmissao": "2026-01-01",
      "notaFiscal": "text",
      "qtdTotalVolume": 1,
      "qtdVolumeSaldo": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Conferência da Lista de Transporte

post

/listaTransporte/{id}/conferencia

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Lista de Transporte

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

etiquetaVolumestringObrigatório

Código da Etiqueta de Volume da Nota Fiscal da Lista de Transporte

etiquetaRomaneiostringOpcional

Código da Etiqueta do Romaneio da Nota Fiscal da Lista de Transporte

Respostas

200

OK

application/json

qtdVolumePendenteEtqRomintegerOpcional

Quantidade de volumes pendentes de conferência da etiqueta de romaneio

etqVolumeOutraEmpresabooleanOpcional

Indica se a etiqueta de volume conferida pertence a uma nota fiscal de outra empresa

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post/listaTransporte/{id}/conferencia

POST /comercial/v10/listaTransporte/{id}/conferencia HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "etiquetaVolume": "text",
  "etiquetaRomaneio": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "qtdVolumePendenteEtqRom": 1,
  "etqVolumeOutraEmpresa": true,
  "ListaTransporte": {
    "codListaTransporte": 1,
    "situacao": 1,
    "descSituacao": "text",
    "codTransportadora": 1,
    "descTransportadora": "text",
    "notasFiscaisListaTransp": [
      {
        "dataEmissao": "2026-01-01",
        "notaFiscal": "text",
        "qtdTotalVolume": 1,
        "qtdVolumeSaldo": 1,
        "dadosCustomizados": [
          {
            "campo": "text",
            "valor": "text"
          }
        ]
      }
    ],
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
}

Encerra Conferência da Lista de Transporte

post

/listaTransporte/{id}/encerrar

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Lista de Transporte

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

codListaTransporteintegerOpcional

Código da Lista de Transporte

situacaointegerOpcional

Código da Situação de Lista de Transporte

descSituacaostringOpcional

Descrição da Situação da Lista de Transporte

codTransportadoraintegerOpcional

Código da Transportadora da Lista de Transporte

descTransportadorastringOpcional

Descrição da Transportadora da Lista de Transporte

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

post/listaTransporte/{id}/encerrar

POST /comercial/v10/listaTransporte/{id}/encerrar HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "codListaTransporte": 1,
  "situacao": 1,
  "descSituacao": "text",
  "codTransportadora": 1,
  "descTransportadora": "text",
  "notasFiscaisListaTransp": [
    {
      "dataEmissao": "2026-01-01",
      "notaFiscal": "text",
      "qtdTotalVolume": 1,
      "qtdVolumeSaldo": 1,
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}