Transportadora

transportadora

Obter Listagem de Transportadora

get

/transportadora

Autorizações

AuthorizationstringObrigatório

Parâmetros de consulta

situacaostringOpcional

Situação da Transportadora (0-Inativo, 1-Ativo)

continuationTokenstringOpcional

Identificador da Paginação da Consulta

campoFiltroDinamicostringOpcional

Campo para filtrar dinamicamente no SQL

valorFiltroDinamicostringOpcional

Valor para filtrar dinamicamente no SQL

paginacaointegerOpcional

Quantidade de itens na paginação de retorno

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/transportadora

GET /cadastrosgerais/v10/transportadora HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "codEmpresa": 1,
      "codTransportadora": 1,
      "nome": "text",
      "endereco": "text",
      "cep": "text",
      "cpfCnpj": "text",
      "nomeFantasia": "text",
      "inscEstadual": "text",
      "situacao": 0,
      "telefone": "text",
      "teleFax": "text",
      "bairro": "text",
      "contato": "text",
      "email": "text",
      "obsNotaFiscal": 1,
      "tipo": 1,
      "dataValidadeSeguro": "text",
      "paisCidadeExterior": "text",
      "paisBacen": 1,
      "codRUC": 1,
      "emailNfe": "text",
      "numero": "text",
      "rntrc": "text",
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar uma Transportadora

put

/transportadora

Autorizações

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codEmpresaintegerOpcional

Código da Empresa da Transportadora

codTransportadoraintegerOpcional

Código da Transportadora

nomestring · máx: 60Opcional

Nome da Transportadora

enderecostring · máx: 60Opcional

Endereço da Transportadora

cepstring · máx: 8Opcional

Código do CEP da Transportadora (sem formatação)

cpfCnpjstringOpcional

Código do CPF ou CNPJ da Transportadora (sem formatação)

nomeFantasiastring · máx: 30Opcional

Nome Fantasia da Transportadora

inscEstadualstring · máx: 15Opcional

Inscrição Estadual da Transportadora (sem formatação)

situacaointeger · enumOpcional

Situação da Transportadora (0-Inativo, 1-Ativo)

Valores possíveis:

telefonestring · máx: 15Opcional

Telefone da Transportadora

teleFaxstring · máx: 15Opcional

Telefone/Fax da Transportadora

bairrostring · máx: 30Opcional

Bairro da Transportadora

contatostring · máx: 30Opcional

Contato da Transportadora

emailstring · máx: 60Opcional

E-mail da Transportadora

obsNotaFiscalintegerOpcional

Código da Observação para a Nota Fiscal

tipointeger · enumOpcional

Tipo da Transportadora (1-Transportadora, 2-Consignatário)

Valores possíveis:

dataValidadeSegurostring · dateOpcional

Data de Validade do Seguro da Transportadora (YYYY-MM-DD)

paisCidadeExteriorstringOpcional

País e Cidade do Exterior da Transportadora

paisBaceninteger · máx: 999999Opcional

Código do Pais/Bacen da Transportadora

codRUCinteger · máx: 99999999999Opcional

Código RUC da Transportadora

emailNfestring · máx: 60Opcional

E-mail da Nota Fiscal Eletrônica da Transportadora

numerostring · máx: 10Opcional

Número do Endereço da Transportadora

rntrcstring · máx: 14Opcional

Registro Nacional de Transportador da Transportadora

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/transportadora

PUT /cadastrosgerais/v10/transportadora HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "codEmpresa": 1,
  "codTransportadora": 1,
  "nome": "text",
  "endereco": "text",
  "cep": "text",
  "cpfCnpj": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "situacao": 0,
  "telefone": "text",
  "teleFax": "text",
  "bairro": "text",
  "contato": "text",
  "email": "text",
  "obsNotaFiscal": 1,
  "tipo": 1,
  "dataValidadeSeguro": "2025-11-28",
  "paisCidadeExterior": "text",
  "paisBacen": 1,
  "codRUC": 1,
  "emailNfe": "text",
  "numero": "text",
  "rntrc": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codEmpresa": 1,
  "codTransportadora": 1,
  "nome": "text",
  "endereco": "text",
  "cep": "text",
  "cpfCnpj": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "situacao": 0,
  "telefone": "text",
  "teleFax": "text",
  "bairro": "text",
  "contato": "text",
  "email": "text",
  "obsNotaFiscal": 1,
  "tipo": 1,
  "dataValidadeSeguro": "text",
  "paisCidadeExterior": "text",
  "paisBacen": 1,
  "codRUC": 1,
  "emailNfe": "text",
  "numero": "text",
  "rntrc": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter uma Transportadora

get

/transportadora/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Transportadora

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/transportadora/{id}

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

{
  "codEmpresa": 1,
  "codTransportadora": 1,
  "nome": "text",
  "endereco": "text",
  "cep": "text",
  "cpfCnpj": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "situacao": 0,
  "telefone": "text",
  "teleFax": "text",
  "bairro": "text",
  "contato": "text",
  "email": "text",
  "obsNotaFiscal": 1,
  "tipo": 1,
  "dataValidadeSeguro": "text",
  "paisCidadeExterior": "text",
  "paisBacen": 1,
  "codRUC": 1,
  "emailNfe": "text",
  "numero": "text",
  "rntrc": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Atualizar uma Transportadora

put

/transportadora/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Transportadora

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

codEmpresaintegerOpcional

Código da Empresa da Transportadora

codTransportadoraintegerOpcional

Código da Transportadora

nomestring · máx: 60Opcional

Nome da Transportadora

enderecostring · máx: 60Opcional

Endereço da Transportadora

cepstring · máx: 8Opcional

Código do CEP da Transportadora (sem formatação)

cpfCnpjstringOpcional

Código do CPF ou CNPJ da Transportadora (sem formatação)

nomeFantasiastring · máx: 30Opcional

Nome Fantasia da Transportadora

inscEstadualstring · máx: 15Opcional

Inscrição Estadual da Transportadora (sem formatação)

situacaointeger · enumOpcional

Situação da Transportadora (0-Inativo, 1-Ativo)

Valores possíveis:

telefonestring · máx: 15Opcional

Telefone da Transportadora

teleFaxstring · máx: 15Opcional

Telefone/Fax da Transportadora

bairrostring · máx: 30Opcional

Bairro da Transportadora

contatostring · máx: 30Opcional

Contato da Transportadora

emailstring · máx: 60Opcional

E-mail da Transportadora

obsNotaFiscalintegerOpcional

Código da Observação para a Nota Fiscal

tipointeger · enumOpcional

Tipo da Transportadora (1-Transportadora, 2-Consignatário)

Valores possíveis:

dataValidadeSegurostring · dateOpcional

Data de Validade do Seguro da Transportadora (YYYY-MM-DD)

paisCidadeExteriorstringOpcional

País e Cidade do Exterior da Transportadora

paisBaceninteger · máx: 999999Opcional

Código do Pais/Bacen da Transportadora

codRUCinteger · máx: 99999999999Opcional

Código RUC da Transportadora

emailNfestring · máx: 60Opcional

E-mail da Nota Fiscal Eletrônica da Transportadora

numerostring · máx: 10Opcional

Número do Endereço da Transportadora

rntrcstring · máx: 14Opcional

Registro Nacional de Transportador da Transportadora

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/transportadora/{id}

PUT /cadastrosgerais/v10/transportadora/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "codEmpresa": 1,
  "codTransportadora": 1,
  "nome": "text",
  "endereco": "text",
  "cep": "text",
  "cpfCnpj": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "situacao": 0,
  "telefone": "text",
  "teleFax": "text",
  "bairro": "text",
  "contato": "text",
  "email": "text",
  "obsNotaFiscal": 1,
  "tipo": 1,
  "dataValidadeSeguro": "2025-11-28",
  "paisCidadeExterior": "text",
  "paisBacen": 1,
  "codRUC": 1,
  "emailNfe": "text",
  "numero": "text",
  "rntrc": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "codEmpresa": 1,
  "codTransportadora": 1,
  "nome": "text",
  "endereco": "text",
  "cep": "text",
  "cpfCnpj": "text",
  "nomeFantasia": "text",
  "inscEstadual": "text",
  "situacao": 0,
  "telefone": "text",
  "teleFax": "text",
  "bairro": "text",
  "contato": "text",
  "email": "text",
  "obsNotaFiscal": 1,
  "tipo": 1,
  "dataValidadeSeguro": "text",
  "paisCidadeExterior": "text",
  "paisBacen": 1,
  "codRUC": 1,
  "emailNfe": "text",
  "numero": "text",
  "rntrc": "text",
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Excluir uma Transportadora

delete

/transportadora/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código da Transportadora

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/transportadora/{id}

DELETE /cadastrosgerais/v10/transportadora/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

AnteriorFornecedor PróximoPortador

Atualizado há 1 hora

Boa noite

Obter Listagem de Transportadora

Cadastrar uma Transportadora

Obter uma Transportadora

Atualizar uma Transportadora

Excluir uma Transportadora