2.0info: 1.0.2 motor_calculo x-senior-domain: tmsx_com x-senior-domain-path: tmsx_com x-senior-service-path: motor_calculo 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_comsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /motor_calculo/queries/cotacao: post: description: Query de Cotação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recInputCotacao responses: 200: description: Ok schema: type: object required: – tarifas properties: tarifas: type: array items: type: object allOf: – #/definitions/recResponseCotacao minimum: 1 description: tempoInterno: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query de Cotação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: modalidadeCarga description: in: query type: string allOf: – #/definitions/enumModalidadeCarga – name: cepOrigem description: in: query type: string – name: cidadeOrigem description: in: query type: string – name: estadoOrigem description: in: query type: string – name: cepDestino description: in: query type: string – name: cidadeDestino description: in: query type: string – name: estadoDestino description: in: query type: string – name: dataEmbarque description: in: query type: string format: date – name: nivelServico description: in: query type: string allOf: – #/definitions/enumNivelServico – name: modal description: in: query type: string allOf: – #/definitions/enumModal – name: tipoCarga description: in: query type: string allOf: – #/definitions/enumTipoCarga – name: peso description: in: query required: true type: number format: double – name: debug description: in: query type: boolean – name: cliente description: in: query type: string responses: 200: description: Ok schema: type: object required: – tarifas properties: tarifas: type: array items: type: object allOf: – #/definitions/recResponseCotacao minimum: 1 description: tempoInterno: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /motor_calculo/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 /motor_calculo/queries/exportTabelaPreco: 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 /motor_calculo/queries/exportTarifa: 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 /motor_calculo/queries/exportPercursoDetalhes: 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 /motor_calculo/queries/exportRegiao: 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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/queries/exportCidadeFaixaCep: 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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/actions/importTabelaPreco: 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 /motor_calculo/actions/importTarifa: 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 /motor_calculo/actions/importPercursoDetalhes: 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 /motor_calculo/actions/importRegiao: 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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/actions/importCidadeFaixaCep: 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 /motor_calculo/events/importTabelaPrecoEvent: 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 /motor_calculo/events/exportTabelaPrecoEvent: 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 /motor_calculo/events/importTarifaEvent: 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 /motor_calculo/events/exportTarifaEvent: 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 /motor_calculo/events/importPercursoDetalhesEvent: 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 /motor_calculo/events/exportPercursoDetalhesEvent: 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 /motor_calculo/events/importRegiaoEvent: 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 /motor_calculo/events/exportRegiaoEvent: 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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/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 /motor_calculo/events/importCidadeFaixaCepEvent: 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 /motor_calculo/events/exportCidadeFaixaCepEvent: 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 /motor_calculo/entities/tarifa/{parentId}/percursoDetalhes: 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/percursoDetalhes responses: 200: description: The created resources schema: type: array items: #/definitions/percursoDetalhes 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/percursoDetalhes responses: 200: description: The created resources schema: type: array items: #/definitions/percursoDetalhes 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/percursoDetalhes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /motor_calculo/entities/tarifa/{parentId}/percursoDetalhes/{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/editPercursoDetalhes responses: 200: description: Ok schema: #/definitions/editPercursoDetalhes 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/percursoDetalhes responses: 200: description: Ok schema: #/definitions/percursoDetalhes 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/percursoDetalhes 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 definitions: enumTipoCarga: type: string enum: – CARGA_SECA – CARGA_REFRIGERADA – CARGA_CONGELADA – CARGA_A_GRANEL – CARGA_PERIGOSA – CARGA_VIVA description: Tipo de Carga: * `CARGA_SECA` – Carga Seca * `CARGA_REFRIGERADA` – Carga Refrigerada * `CARGA_CONGELADA` – Carga Congelada * `CARGA_A_GRANEL` – Carga a Granel * `CARGA_PERIGOSA` – Carga Perigosa * `CARGA_VIVA` – Carga Viva enumTipoTabelaFrete: type: string enum: – COMPRA – VENDA description: Tipo da Tabela de Frete: * `COMPRA` – Tipo Compra * `VENDA` – Tipo Venda enumModal: type: string enum: – AEREO – RODOVIARIO – FERROVIARIO – AQUAVIARIO – DUTOVIARIO description: Modal: * `AEREO` – Aéreo * `RODOVIARIO` – Rodoviário * `FERROVIARIO` – Ferroviário * `AQUAVIARIO` – Aquaviário * `DUTOVIARIO` – Dutoviário enumModalidadeCarga: type: string enum: – LOTACAO – FRACIONADO description: Modalidade de Carga: * `LOTACAO` – Lotação * `FRACIONADO` – Fracionado enumNivelServico: type: string enum: – ECONOMICO – NORMAL – EXPRESSO description: Nível de Serviço: * `ECONOMICO` – Econômico * `NORMAL` – Normal * `EXPRESSO` – Expresso enumModalidadeFrete: type: string enum: – FRACIONADO – LOTACAO description: Modalidade de Frete: * `FRACIONADO` – Fracionado * `LOTACAO` – Lotação 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 recInputCotacao: description: Record do input da Cotação type: object required: – peso properties: modalidadeCarga: type: string allOf: – #/definitions/enumModalidadeCarga description: cepOrigem: type: string description: cidadeOrigem: type: string description: estadoOrigem: type: string description: cepDestino: type: string description: cidadeDestino: type: string description: estadoDestino: type: string description: dataEmbarque: type: string format: date description: nivelServico: type: string allOf: – #/definitions/enumNivelServico description: modal: type: string allOf: – #/definitions/enumModal description: tipoCarga: type: string allOf: – #/definitions/enumTipoCarga description: peso: type: number format: double description: debug: type: boolean description: default: false cliente: type: string description: recResponseCotacao: description: Record do response de Cotação type: object required: – tabelaPreco – valor properties: tabelaPreco: type: object allOf: – #/definitions/recTabelaPreco description: Tabela de Preço valor: type: number format: double description: recTransportadora: description: Record da Transportadora type: object required: – nome – cnpj properties: nome: type: string description: Nome da transportadora cnpj: type: string description: CNPJ da transportadora recTarifa: description: Tarifa type: object required: – codigo properties: codigo: type: string description: Código recTabelaPreco: description: Tabela Preço type: object required: – codigo – versao – transportadora – tarifa properties: codigo: type: integer format: int64 description: Código versao: type: string description: Versão transportadora: type: object allOf: – #/definitions/recTransportadora description: Transportadora tarifa: type: object allOf: – #/definitions/recTarifa description: Tarifa tabelaPreco: description: Entidade de Tabela de Preço type: object required: – descricao – tipo – vigenciaInicial – transportadoraNome – transportadoraCNPJ properties: id: type: string format: uuid description: Id da Entidade codigo: type: integer format: int64 description: Codigo descricao: type: string description: Descrição tipo: type: string allOf: – #/definitions/enumTipoTabelaFrete description: Tipo tabela de frete formato: type: string description: Formato Tabela de Preço modal: type: string allOf: – #/definitions/enumModal description: Modal modalidadeCarga: type: string allOf: – #/definitions/enumModalidadeCarga description: Modalidade de Carga vigenciaInicial: type: string format: date description: Vigencia Inicial vigenciaFinal: type: string format: date description: Vigencia Final transportadoraNome: type: string description: Nome da Transportadora transportadoraCNPJ: type: string description: CNPJ da Transportadora status: type: string description: Status impostoIncluso: type: boolean description: Imposto Incluso versao: type: integer format: int64 description: Versao tarifa: type: array items: type: object allOf: – #/definitions/tarifa description: Tarifas clientes: type: string format: byte description: Clientes em jsonb tipoCarga: type: string format: byte description: Tipo carga em jsonb nivelServico: type: string format: byte description: Nivel de servico em jsonb createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tarifa: description: Entidade de Tarifa type: object required: – codigo – tabelaPreco properties: id: type: string format: uuid description: Id da Entidade codigo: type: string description: Código descricao: type: string description: Descrição freteMinimo: type: number format: double description: Frete Mínimo freteMaximo: type: number format: double description: Frete Máximo formula: type: string description: Fórmula de cálculo do frete tabelaPreco: type: object allOf: – #/definitions/tabelaPreco description: Tabela de Preço percursoDetalhes: type: array items: type: object allOf: – #/definitions/percursoDetalhes description: Percurso Detalhes tipoCarga: type: string format: byte description: Tipo carga em jsonb modalidadeCarga: type: string format: byte description: Modalidade carga em jsonb nivelServico: type: string format: byte description: Nivel de servico em jsonb createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: percursoDetalhes: description: Entidade de Detalhes do Percurso type: object required: – nivelServico properties: id: type: string format: uuid description: Id da entidade nivelServico: type: string allOf: – #/definitions/enumNivelServico description: Nivel de Servico diasAtendimento: type: integer format: int64 description: Dias de Atendimento tarifa: type: object allOf: – #/definitions/tarifa description: Tarifa regiaoOrigem: type: array items: type: object allOf: – #/definitions/regiao description: Regioes origem regiaoDestino: type: array items: type: object allOf: – #/definitions/regiao description: Regioes Destino createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPercursoDetalhes: type: object required: – id allOf: – #/definitions/percursoDetalhes regiao: description: Entidade de Região type: object required: – prioridade properties: id: type: string format: uuid description: Id da entidade percursoDetalhes: type: object allOf: – #/definitions/percursoDetalhes description: Percurso Detalhe cepInicial: type: string description: Cep Inicial cepFinal: type: string description: Cep Final cidade: type: string format: uuid description: Cidade estado: type: string format: uuid description: Estado regiaoInicial: type: boolean description: É uma Regiao Inicial regiaoFinal: type: boolean description: É uma Regiao Final prioridade: type: integer format: int64 description: Prioridade de busca createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pais: description: Entidade de Pais type: object required: – codigo – nome properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código nome: type: string description: Nome 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: Entidade de Estado type: object required: – nome 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: cidade: description: Entidade de Cidade type: object required: – codigo – nome – estado 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 faixasCep: type: array items: type: object allOf: – #/definitions/cidadeFaixaCep description: Lista de Faixas de Cep 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: cidadeFaixaCep: description: Entidade da Faixa de Código Postal type: object required: – cepInicial – cepFinal properties: id: type: string format: uuid description: Id da entidade cepInicial: type: string maxLength: 20 description: Cep Inicial cepFinal: type: string maxLength: 20 description: Cep Final cidade: type: object allOf: – #/definitions/cidade description: Cidade 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