• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/tmsx_ope/romaneios
Mais pesquisados:Customização, Tutorial, Documentação

romaneios

45 views 0 09/11/2026 integrador

2.0info: 0.8.0 romaneios x-senior-domain: tmsx_ope x-senior-domain-path: tmsx_ope x-senior-service-path: romaneios contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmsx_opesecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /romaneios/queries/consultarRomaneio: post: description: Consulta os dados de um romaneio pelo número (transportadora passiva → TMSX) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – numero properties: numero: type: string description: Número do romaneio gerado pelo TMSX responses: 200: description: Ok schema: type: object required: – numero – status – quantidadeDocumentosEmbarque properties: numero: type: string description: Número do romaneio status: type: string allOf: – #/definitions/statusRomaneio description: Status atual empresa: type: object allOf: – #/definitions/consultaRomaneioEmpresa description: Empresa (filial expedidora) transportador: type: object allOf: – #/definitions/consultaRomaneioTransportador description: Transportador origem: type: object allOf: – #/definitions/consultaRomaneioOrigem description: Origem (ponto de coleta) totais: type: object allOf: – #/definitions/consultaRomaneioTotais description: Totais calculados (somente documentos resolvidos) quantidadeDocumentosEmbarque: type: integer format: int64 description: Quantidade de documentos de embarque vinculados historicoStatus: type: array items: type: object allOf: – #/definitions/consultaRomaneioHistorico description: Trilha de status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta os dados de um romaneio pelo número (transportadora passiva → TMSX) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: numero description: Número do romaneio gerado pelo TMSX in: query required: true type: string responses: 200: description: Ok schema: type: object required: – numero – status – quantidadeDocumentosEmbarque properties: numero: type: string description: Número do romaneio status: type: string allOf: – #/definitions/statusRomaneio description: Status atual empresa: type: object allOf: – #/definitions/consultaRomaneioEmpresa description: Empresa (filial expedidora) transportador: type: object allOf: – #/definitions/consultaRomaneioTransportador description: Transportador origem: type: object allOf: – #/definitions/consultaRomaneioOrigem description: Origem (ponto de coleta) totais: type: object allOf: – #/definitions/consultaRomaneioTotais description: Totais calculados (somente documentos resolvidos) quantidadeDocumentosEmbarque: type: integer format: int64 description: Quantidade de documentos de embarque vinculados historicoStatus: type: array items: type: object allOf: – #/definitions/consultaRomaneioHistorico description: Trilha de status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/consultarDocumentosEmbarqueRomaneio: post: description: Lista, de forma paginada, os documentos de embarque vinculados a um romaneio (transportadora passiva → TMSX) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – numero properties: numero: type: string description: Número do romaneio gerado pelo TMSX limit: type: integer format: int64 description: Quantidade máxima de registros (default 20, máx 50) offset: type: integer format: int64 description: Deslocamento inicial (default 0) responses: 200: description: Ok schema: type: object required: – numero – total – limit – offset properties: numero: type: string description: Número do romaneio total: type: integer format: int64 description: Total de documentos de embarque resolvidos vinculados ao romaneio limit: type: integer format: int64 description: Limite aplicado offset: type: integer format: int64 description: Deslocamento aplicado documentosEmbarque: type: array items: type: object allOf: – #/definitions/consultaNotaItem description: Documentos de embarque da página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista, de forma paginada, os documentos de embarque vinculados a um romaneio (transportadora passiva → TMSX) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: numero description: Número do romaneio gerado pelo TMSX in: query required: true type: string – name: limit description: Quantidade máxima de registros (default 20, máx 50) in: query type: integer format: int64 – name: offset description: Deslocamento inicial (default 0) in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – numero – total – limit – offset properties: numero: type: string description: Número do romaneio total: type: integer format: int64 description: Total de documentos de embarque resolvidos vinculados ao romaneio limit: type: integer format: int64 description: Limite aplicado offset: type: integer format: int64 description: Deslocamento aplicado documentosEmbarque: type: array items: type: object allOf: – #/definitions/consultaNotaItem description: Documentos de embarque da página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportRomaneio: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportRomaneioDocumentoEmbarque: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportRomaneioStatusHistorico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportRomaneioVariavel: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportEndereco: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportNivelServico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportEmpresa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportPessoa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportPessoaTransportadora: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportCidade: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportEstado: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportPais: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportDocumentoEmbarque: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/exportDocumentoEmbarqueDadosTransporte: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/initialLoadDefaultBase: post: description: Carga inicial de dados da base padrão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: wizardCall: type: boolean description: Indica se quem está chamando a carga inicial é o Wizard na preparação de ambiente responses: 200: description: Ok schema: type: object properties: migrationVersion: type: string description: Indica a versão do migration migrated: type: boolean description: Indica se já foi migrado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/criarRomaneio: post: description: Cria o cabeçalho de um romaneio de embarque em EM_DIGITACAO (WMS → TMSX) tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codigoRomaneioOrigem – cnpjEmpresa properties: codigoRomaneioOrigem: type: string description: Código/identificador do romaneio no sistema de origem (WMS) cnpjEmpresa: type: string description: CNPJ da empresa/filial expedidora cnpjTransportador: type: string description: CNPJ da transportadora responsável, se já conhecida enderecoOrigem: type: object allOf: – #/definitions/enderecoOrigemInput description: Endereço do ponto de coleta. Cidade/estado/país são resolvidos automaticamente a partir do CEP observacao: type: string description: Observação livre responses: 200: description: Ok schema: type: object required: – romaneio properties: romaneio: type: object allOf: – #/definitions/romaneio description: Romaneio criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/incluirDocumentosEmbarqueRomaneio: post: description: Inclui um ou mais documentos de embarque em um romaneio em elaboração (WMS → TMSX) tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – numeroRomaneio – documentosEmbarque properties: numeroRomaneio: type: string description: Número do romaneio gerado pelo TMSX documentosEmbarque: type: array items: type: object allOf: – #/definitions/romaneioDocumentoEmbarqueInput minimum: 1 description: Lista de documentos de embarque a incluir responses: 200: description: Ok schema: type: object required: – quantidadeDocumentosEmbarque – protocolo properties: quantidadeDocumentosEmbarque: type: integer format: int64 description: Quantidade de documentos recebidos protocolo: type: string description: Protocolo de recebimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/atualizarStatusRomaneio: post: description: Atualiza o status de um romaneio (WMS/transportadora → TMSX). Nesta versão apenas LIBERADO e ACEITO tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – numeroRomaneio – status – dataHoraEvento properties: numeroRomaneio: type: string description: Número do romaneio gerado pelo TMSX status: type: string allOf: – #/definitions/statusRomaneio description: Status a aplicar (nesta versão apenas LIBERADO e ACEITO) dataHoraEvento: type: string format: date-time description: Data/hora em que o evento ocorreu na origem shipmentId: type: string description: Identificador do pedido de coleta gerado pela transportadora. Opcional; quando informado no ACEITO, é gravado no romaneio e no histórico observacao: type: string description: Observação livre da transportadora sobre o evento de status variaveis: type: array items: type: object allOf: – #/definitions/atualizarStatusVariavelInput description: Variáveis livres (pares nome/valor) para rastreamento. Cada envio cria novos registros — registros anteriores não são substituídos responses: 200: description: Ok schema: type: object required: – romaneio properties: romaneio: type: object allOf: – #/definitions/romaneio description: Romaneio atualizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importRomaneio: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importRomaneioDocumentoEmbarque: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importRomaneioStatusHistorico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importRomaneioVariavel: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importEndereco: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importNivelServico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importEmpresa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importPessoa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importPessoaTransportadora: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importCidade: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importEstado: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importPais: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importDocumentoEmbarque: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/actions/importDocumentoEmbarqueDadosTransporte: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/events/onShippingStatusChanged: post: description: Emitido a cada mudança de status do romaneio (inclui a criação em EM_DIGITACAO). Permite integração via Webhook x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – evento – dataHoraEvento – romaneio properties: evento: type: string description: Nome do evento dataHoraEvento: type: string format: date-time description: Data/hora em que a mudança de status ocorreu (com timezone) empresa: type: object allOf: – #/definitions/romaneioEventoEmpresa description: Empresa (filial expedidora) do romaneio romaneio: type: object allOf: – #/definitions/romaneioEventoRomaneio description: Dados do romaneio transportador: type: object allOf: – #/definitions/romaneioEventoTransportador description: Transportadora responsável, quando definida responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/onShippingStatusLiberado: post: description: Emitido especificamente quando o romaneio é liberado (status LIBERADO). Permite integração via Webhook x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – evento – dataHoraEvento – romaneio properties: evento: type: string description: Nome do evento dataHoraEvento: type: string format: date-time description: Data/hora em que a liberação ocorreu (com timezone) empresa: type: object allOf: – #/definitions/romaneioEventoEmpresa description: Empresa (filial expedidora) do romaneio romaneio: type: object allOf: – #/definitions/romaneioEventoRomaneio description: Dados do romaneio transportador: type: object allOf: – #/definitions/romaneioEventoTransportador description: Transportadora responsável, quando definida responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importRomaneioEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportRomaneioEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importRomaneioDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportRomaneioDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importRomaneioStatusHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportRomaneioStatusHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importRomaneioVariavelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportRomaneioVariavelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importEnderecoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportEnderecoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importNivelServicoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportNivelServicoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importEmpresaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportEmpresaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importPessoaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportPessoaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importPessoaTransportadoraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportPessoaTransportadoraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importCidadeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportCidadeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importEstadoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportEstadoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importPaisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportPaisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/importDocumentoEmbarqueDadosTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/events/exportDocumentoEmbarqueDadosTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneio: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/romaneio responses: 200: description: The created resource schema: #/definitions/romaneio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/romaneio responses: 200: description: The created resource schema: #/definitions/romaneio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/romaneio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneio/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRomaneio responses: 200: description: Ok schema: #/definitions/editRomaneio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/romaneio responses: 200: description: Ok schema: #/definitions/romaneio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/romaneio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneio/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/romaneio responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioDocumentoEmbarque: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/romaneioDocumentoEmbarque responses: 200: description: The created resource schema: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/romaneioDocumentoEmbarque responses: 200: description: The created resource schema: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioDocumentoEmbarque/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRomaneioDocumentoEmbarque responses: 200: description: Ok schema: #/definitions/editRomaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/romaneioDocumentoEmbarque responses: 200: description: Ok schema: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneio/{parentId}/documentosEmbarque: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/romaneioDocumentoEmbarque responses: 200: description: The created resources schema: type: array items: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/romaneioDocumentoEmbarque responses: 200: description: The created resources schema: type: array items: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneio/{parentId}/documentosEmbarque/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRomaneioDocumentoEmbarque responses: 200: description: Ok schema: #/definitions/editRomaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/romaneioDocumentoEmbarque responses: 200: description: Ok schema: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/romaneioDocumentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioDocumentoEmbarque/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/romaneioDocumentoEmbarque responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioStatusHistorico: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/romaneioStatusHistorico responses: 200: description: The created resource schema: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/romaneioStatusHistorico responses: 200: description: The created resource schema: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioStatusHistorico/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRomaneioStatusHistorico responses: 200: description: Ok schema: #/definitions/editRomaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/romaneioStatusHistorico responses: 200: description: Ok schema: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneio/{parentId}/historicoStatus: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/romaneioStatusHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/romaneioStatusHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneio/{parentId}/historicoStatus/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRomaneioStatusHistorico responses: 200: description: Ok schema: #/definitions/editRomaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/romaneioStatusHistorico responses: 200: description: Ok schema: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/romaneioStatusHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioStatusHistorico/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/romaneioStatusHistorico responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioVariavel: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/romaneioVariavel responses: 200: description: The created resource schema: #/definitions/romaneioVariavel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/romaneioVariavel responses: 200: description: The created resource schema: #/definitions/romaneioVariavel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/romaneioVariavel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioVariavel/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRomaneioVariavel responses: 200: description: Ok schema: #/definitions/editRomaneioVariavel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/romaneioVariavel responses: 200: description: Ok schema: #/definitions/romaneioVariavel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/romaneioVariavel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/romaneioVariavel/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/romaneioVariavel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/endereco: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/endereco responses: 200: description: The created resource schema: #/definitions/endereco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/endereco responses: 200: description: The created resource schema: #/definitions/endereco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/endereco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/endereco/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEndereco responses: 200: description: Ok schema: #/definitions/editEndereco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/endereco responses: 200: description: Ok schema: #/definitions/endereco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/endereco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /romaneios/entities/endereco/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/endereco responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: tipoRomaneio: type: string enum: – EMBARCADOR – TRANSPORTADORA description: Tipificação do romaneio (embarcador ou transportadora): * `EMBARCADOR` – Embarcador * `TRANSPORTADORA` – Transportadora statusRomaneio: type: string enum: – EM_DIGITACAO – LIBERADO – ACEITO – RECUSADO – FINALIZADO – CANCELADO description: Status do romaneio de embarque: * `EM_DIGITACAO` – Em digitacao * `LIBERADO` – Liberado * `ACEITO` – Aceito * `RECUSADO` – Recusado * `FINALIZADO` – Finalizado * `CANCELADO` – Cancelado categoriaNivelServico: type: string enum: – EXPRESSO – NORMAL – ECONOMICO description: Categoria do nível de serviço: * `EXPRESSO` – Expresso * `NORMAL` – Normal * `ECONOMICO` – Economico origemStatus: type: string enum: – AUTOMATICO – MANUAL – API_INTEGRACAO description: Origem da mudança de status: * `AUTOMATICO` – Automatico * `MANUAL` – Manual * `API_INTEGRACAO` – Api integracao enumTipoPagador: type: string enum: – EMITENTE – DESTINATARIO – CONSIGNATARIO – TRANSPORTADOR description: Tipo do pagador: * `EMITENTE` – Emitente * `DESTINATARIO` – Destinatario * `CONSIGNATARIO` – Consignatario * `TRANSPORTADOR` – Transportador enumTipoPessoa: type: string enum: – PESSOA_JURIDICA – PESSOA_FISICA description: Tipo da pessoa: * `PESSOA_JURIDICA` – Pessoa juridica * `PESSOA_FISICA` – Pessoa fisica enumStatusItemRomaneio: type: string enum: – PENDENTE – REALIZADO_SUCESSO – REALIZADO_SEM_SUCESSO – NAO_REALIZADO description: Status do item do romaneio: * `PENDENTE` – Pendente * `REALIZADO_SUCESSO` – Realizado sucesso * `REALIZADO_SEM_SUCESSO` – Realizado sem sucesso * `NAO_REALIZADO` – Nao realizado userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim romaneioDocumentoEmbarqueInput: description: Documento de embarque (nota) a incluir no romaneio via WMS type: object properties: chaveAcesso: type: string description: Chave de acesso da NF-e (44 dígitos). Identificador preferencial numero: type: string description: Número do documento de embarque serie: type: string description: Série do documento de embarque emitente: type: string description: CNPJ do emitente modeloDocumento: type: string description: Modelo do documento (ex: NFe) enderecoOrigemInput: description: Endereço informado pelo WMS. Cidade/estado/país são resolvidos automaticamente a partir do CEP type: object required: – cep properties: cep: type: string maxLength: 20 description: CEP do ponto de coleta logradouro: type: string maxLength: 100 description: Logradouro (rua/avenida) numero: type: string maxLength: 60 description: Número complemento: type: string maxLength: 200 description: Complemento bairro: type: string maxLength: 75 description: Bairro romaneioEventoEmpresa: description: Dados da empresa (filial expedidora) no payload de evento do romaneio type: object properties: id: type: string description: Id da filial expedidora codigo: type: string description: Código da filial nome: type: string description: Nome da filial cnpj: type: string description: CNPJ da filial expedidora romaneioEventoRomaneio: description: Dados do romaneio no payload de evento de status type: object required: – numero – status properties: id: type: string description: Id do romaneio numero: type: string description: Número do romaneio status: type: string allOf: – #/definitions/statusRomaneio description: Status atual do romaneio romaneioEventoTransportador: description: Dados do transportador no payload de evento do romaneio type: object properties: id: type: string description: Id da pessoa transportadora codigo: type: string description: Código da transportadora nome: type: string description: Nome da transportadora cnpj: type: string description: CNPJ/CPF da transportadora consultaRomaneioEmpresa: description: Empresa (filial expedidora) na consulta de romaneio type: object properties: codigo: type: string description: Código da filial nome: type: string description: Nome da filial cnpj: type: string description: CNPJ da filial expedidora consultaRomaneioTransportador: description: Transportador na consulta de romaneio type: object properties: codigo: type: string description: Código da transportadora nome: type: string description: Nome da transportadora cnpj: type: string description: CNPJ/CPF da transportadora consultaRomaneioEndereco: description: Endereço de origem na consulta de romaneio type: object properties: cep: type: string description: CEP logradouro: type: string description: Logradouro numero: type: string description: Número complemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: string description: Cidade estado: type: string description: Estado pais: type: string description: País consultaRomaneioOrigem: description: Origem (ponto de coleta) na consulta de romaneio type: object properties: pontoColeta: type: string description: Nome do ponto de coleta endereco: type: object allOf: – #/definitions/consultaRomaneioEndereco description: Endereço de origem consultaRomaneioTotais: description: Totais calculados do romaneio (somente documentos resolvidos) type: object properties: valorTotalMercadoria: type: number format: double description: Valor total da mercadoria quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes pesoFisico: type: number format: double description: Peso físico total pesoCubadoCalculado: type: number format: double description: Peso cubado calculado total metrosCubicos: type: number format: double description: Metros cúbicos totais consultaRomaneioHistorico: description: Item do histórico de status na consulta de romaneio type: object required: – status – dataHora properties: status: type: string allOf: – #/definitions/statusRomaneio description: Status registrado dataHora: type: string format: date-time description: Data/hora do evento origem: type: string allOf: – #/definitions/origemStatus description: Origem da mudança de status usuario: type: string description: Usuário/origem detalhada observacao: type: string description: Observação do evento shipmentId: type: string description: shipmentId do evento consultaDocumentoPessoa: description: Pessoa (emitente, destinatário ou pagador) na consulta de documentos de embarque type: object properties: codigo: type: integer format: int64 description: Código nome: type: string description: Nome nomeFantasia: type: string description: Nome fantasia tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa cnpjCpf: type: string description: CNPJ/CPF consultaDocumentoEndereco: description: Endereço de origem ou destino na consulta de documentos de embarque type: object properties: cep: type: string description: CEP logradouro: type: string description: Logradouro numero: type: string description: Número complemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: string description: Cidade estado: type: string description: Estado pais: type: string description: País consultaDocumentoDadosTransporte: description: Dados de transporte na consulta de documentos de embarque type: object properties: pagador: type: object allOf: – #/definitions/consultaDocumentoPessoa description: Pagador tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo de pagador quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes pesoFisico: type: number format: double description: Peso físico em kg pesoCubadoCalculado: type: number format: double description: Peso cubado calculado pesoCubadoOperacional: type: number format: double description: Peso cubado operacional fatorCubagem: type: number format: double description: Fator de cubagem metrosCubicos: type: number format: double description: Metros cúbicos consultaDocumentoEmbarqueVariavel: description: Variável livre vinculada ao documento de embarque (somente leitura — id não é enviado no POST) type: object properties: id: type: string description: Identificador do vínculo da variável com o documento de embarque nome: type: string description: Nome/chave da variável (ex: Pedido, CodigoRastreio) valor: type: string description: Valor da variável atualizarStatusVariavelInput: description: Variável livre para envio no atualizarStatusRomaneio (nome e valor — sem id) type: object required: – nome – valor properties: nome: type: string description: Nome/chave da variável (ex: shipmentId, previsaoColeta) valor: type: string description: Valor da variável consultaNotaItem: description: Documento de embarque na consulta de documentos de embarque do romaneio type: object required: – status properties: id: type: string description: Identificador do vínculo romaneioDocumentoEmbarque chaveAcesso: type: string description: Chave de acesso da NF-e numero: type: string description: Número do documento serie: type: string description: Série do documento sequencia: type: integer format: int64 description: Sequência do documento no romaneio (ordenação) dataEmissao: type: string format: date-time description: Data de emissão observacao: type: string description: Observação valorDocumento: type: number format: double description: Valor total do documento emitente: type: object allOf: – #/definitions/consultaDocumentoPessoa description: Emitente destinatario: type: object allOf: – #/definitions/consultaDocumentoPessoa description: Destinatário origem: type: object allOf: – #/definitions/consultaDocumentoEndereco description: Endereço de origem destino: type: object allOf: – #/definitions/consultaDocumentoEndereco description: Endereço de destino dadosTransporte: type: object allOf: – #/definitions/consultaDocumentoDadosTransporte description: Dados do transporte variaveis: type: array items: type: object allOf: – #/definitions/consultaDocumentoEmbarqueVariavel description: Variáveis livres vinculadas ao documento de embarque status: type: string allOf: – #/definitions/enumStatusItemRomaneio description: Status do vínculo RomaneioDocumentoEmbarque movimentacaoFinalizadora: type: string description: Movimentação finalizadora romaneio: description: Romaneio de embarque (raiz de agregado) type: object required: – numero – codigoOrigem – tipo – status – filial properties: id: type: string format: uuid description: Id da entidade numero: type: string description: Número definitivo gerado pelo TMSX (único) codigoOrigem: type: string description: Referência externa do romaneio no WMS (usado para idempotência) tipo: type: string allOf: – #/definitions/tipoRomaneio description: Tipificação do romaneio (embarcador ou transportadora) status: type: string allOf: – #/definitions/statusRomaneio description: Status atual do romaneio filial: type: object allOf: – #/definitions/filial description: Filial expedidora transportadora: type: object allOf: – #/definitions/pessoa description: Transportadora responsável (pode ser definida depois) enderecoOrigem: type: object allOf: – #/definitions/endereco description: Endereço do ponto de coleta enderecoDestino: type: object allOf: – #/definitions/endereco description: Endereço do ponto de entrega pontoColeta: type: string description: Nome do ponto de coleta (ex: CD Central) shipmentId: type: string description: Protocolo da transportadora (último shipmentId enviado) observacao: type: string description: Observação livre documentosEmbarque: type: array items: type: object allOf: – #/definitions/romaneioDocumentoEmbarque description: Documentos de embarque vinculados historicoStatus: type: array items: type: object allOf: – #/definitions/romaneioStatusHistorico description: Trilha de mudanças de status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editRomaneio: type: object required: – id allOf: – #/definitions/romaneio romaneioDocumentoEmbarque: description: Vínculo entre o romaneio e cada documento de embarque type: object required: – status properties: id: type: string format: uuid description: Id da entidade romaneio: type: object allOf: – #/definitions/romaneio description: Romaneio pai documentoEmbarque: type: object allOf: – #/definitions/documentoEmbarque description: Documento de embarque vinculado (tmsx_exp), quando já existe na base chaveAcesso: type: string maxLength: 44 description: Chave de acesso informada pelo WMS numeroDocumento: type: string description: Número do documento informado pelo WMS serieDocumento: type: string maxLength: 3 description: Série do documento informada pelo WMS emitenteCnpj: type: string description: CNPJ do emitente informado pelo WMS modeloDocumento: type: string description: Modelo do documento informado pelo WMS (ex: NFe) sequencia: type: integer format: int64 description: Sequência do documento no romaneio — atribuída na inclusão, usada para ordenação status: type: string allOf: – #/definitions/enumStatusItemRomaneio description: Status movimentacaoFinalizadora: type: string format: uuid description: Movimentação finalizadora createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editRomaneioDocumentoEmbarque: type: object required: – id allOf: – #/definitions/romaneioDocumentoEmbarque romaneioStatusHistorico: description: Trilha de mudanças de status do romaneio type: object required: – status – dataHora properties: id: type: string format: uuid description: Id da entidade romaneio: type: object allOf: – #/definitions/romaneio description: Romaneio pai status: type: string allOf: – #/definitions/statusRomaneio description: Status registrado dataHora: type: string format: date-time description: Data/hora em que o status ocorreu origemDetalhes: type: string description: Quem disparou (usuário, e-mail ou sistema) origem: type: string allOf: – #/definitions/origemStatus description: Origem da mudança de status observacao: type: string description: Observação livre do evento shipmentId: type: string description: shipmentId enviado no evento (aceite/coleta) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editRomaneioStatusHistorico: type: object required: – id allOf: – #/definitions/romaneioStatusHistorico romaneioVariavel: description: Variável livre do romaneio (par nome/valor, append-only). type: object required: – nome – valor properties: id: type: string format: uuid description: Id da entidade romaneio: type: object allOf: – #/definitions/romaneio description: Romaneio pai nome: type: string description: Nome/chave da variável valor: type: string description: Valor da variável createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editRomaneioVariavel: type: object required: – id allOf: – #/definitions/romaneioVariavel endereco: description: Endereço de origem/destino do romaneio type: object properties: id: type: string format: uuid description: Id da entidade cep: type: string maxLength: 20 description: Código postal (CEP) logradouro: type: string maxLength: 100 description: Logradouro (rua/avenida) numero: type: string maxLength: 60 description: Número complemento: type: string maxLength: 200 description: Complemento bairro: type: string maxLength: 75 description: Bairro cidade: type: object allOf: – #/definitions/cidade description: Cidade estado: type: object allOf: – #/definitions/estado description: Estado pais: type: object allOf: – #/definitions/pais description: País createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEndereco: type: object required: – id allOf: – #/definitions/endereco nivelServico: description: Nível de serviço contratado (informativo) type: object required: – nome – categoria properties: id: type: string format: uuid description: Id da entidade codigo: type: string description: Código do nível de serviço (ex: EXP, NORMAL, ECO) nome: type: string description: Descrição legível categoria: type: string allOf: – #/definitions/categoriaNivelServico description: Categoria do nível de serviço extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: empresa: description: Entidade de Empresa type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código empresa nome: type: string description: Nome empresa sigla: type: string description: Nome fantasia empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filial: description: Entidade de Filial type: object properties: id: type: string format: uuid description: Id da entidade empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: integer format: int64 description: Código filial nome: type: string description: Nome filial sigla: type: string description: Nome fantasia filial numeroCgc: type: string description: CPF/CNPJ matriz: type: boolean description: Filial matriz default: false excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoa: description: Entidade de Pessoa type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código pessoa nome: type: string description: Nome pessoa nomeFantasia: type: string description: Nome fantasia pessoa tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa pessoaTransportadora: type: object allOf: – #/definitions/pessoaTransportadora description: Transportadora cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoaTransportadora: description: Transportadora type: object properties: id: type: string format: uuid description: Id da entidade pessoa: type: object allOf: – #/definitions/pessoa description: Pessoa ativo: type: boolean description: Situação da transportadora default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cidade: description: Cidade type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade estado: type: object allOf: – #/definitions/estado description: Estado codigoIbge: type: integer format: int64 description: Código IBGE município excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: estado: description: Estado type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome pais: type: object allOf: – #/definitions/pais description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pais: description: País type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código codigoIso: type: string description: Código ISO do país nome: type: string description: Nome codigoMoeda: type: string description: Código moeda mercosul: type: boolean description: Mercosul default: false excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentoEmbarque: description: Documento de embarque type: object properties: id: type: string format: uuid description: Id da entidade numero: type: string description: Número serie: type: string maxLength: 3 description: Série emitente: type: object allOf: – #/definitions/pessoa description: Emitente destinatario: type: object allOf: – #/definitions/pessoa description: Destinatário origemCep: type: string maxLength: 20 description: CEP endereço origem origemLogradouro: type: string description: Logradouro endereço origem origemNumero: type: string maxLength: 255 description: Número endereço origem origemComplemento: type: string description: Complemento endereço origem origemBairro: type: string description: Bairro endereço origem origemCidade: type: string description: Cidade endereço origem origemEstado: type: string description: Estado endereço origem origemPais: type: string description: País endereço origem documentoEmbarqueDadosTransporte: type: object allOf: – #/definitions/documentoEmbarqueDadosTransporte description: Dados do transporte destinoCep: type: string maxLength: 20 description: CEP endereço destino destinoLogradouro: type: string description: Logradouro endereço destino destinoNumero: type: string maxLength: 255 description: Número endereço destino destinoComplemento: type: string description: Complemento endereço destino destinoBairro: type: string description: Bairro endereço destino destinoCidade: type: string description: Cidade endereço destino destinoEstado: type: string description: Estado endereço destino destinoPais: type: string description: País endereço destino dataEmissao: type: string format: date-time description: Data de emissão chave: type: string description: Chave valorDocumento: type: number format: double description: Valor documento observacao: type: string maxLength: 2000 description: Observação extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentoEmbarqueDadosTransporte: description: Dados do transporte do documento de embarque type: object properties: id: type: string format: uuid description: Id da entidade documentoEmbarque: type: object allOf: – #/definitions/documentoEmbarque description: Documento de embarque pagador: type: object allOf: – #/definitions/pessoa description: Pagador tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo de pagador quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes pesoFisico: type: number format: double description: Peso físico pesoCubadoCalculado: type: number format: double description: Peso cubado calculado pesoCubadoOperacional: type: number format: double description: Peso cubado operacional fatorCubagem: type: number format: double description: Fator cubagem metrosCubicos: type: number format: double description: Metros cúbicos extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação