tmsentregas

2.0info: 0.1.0 tracking_integration description: x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: tracking_integration contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /tmsentregas/tracking_integrationsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /apis/composicaoDocumentoTracking: post: description: The create request primitive for the composicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/composicaoDocumentoTrackingFacadeInput responses: 200: description: Ok schema: #/definitions/composicaoDocumentoTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the composicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/composicaoDocumentoTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/composicaoDocumentoTracking/{id}: put: description: The update request primitive for the composicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/composicaoDocumentoTrackingFacadeInput responses: 200: description: Ok schema: #/definitions/composicaoDocumentoTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the composicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/composicaoDocumentoTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the composicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/integracaoPontoRegraFaseTracking: post: description: The create request primitive for the integracaoPontoRegraFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/integracaoPontoRegraFaseTrackingFacadeInput responses: 200: description: Ok schema: #/definitions/integracaoPontoRegraFaseTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the integracaoPontoRegraFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/integracaoPontoRegraFaseTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/integracaoPontoRegraFaseTracking/{id}: put: description: The update request primitive for the integracaoPontoRegraFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/integracaoPontoRegraFaseTrackingFacadeInput responses: 200: description: Ok schema: #/definitions/integracaoPontoRegraFaseTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the integracaoPontoRegraFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/integracaoPontoRegraFaseTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the integracaoPontoRegraFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/integracaoOcorrenciaFaseTracking: post: description: The create request primitive for the integracaoOcorrenciaFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/integracaoOcorrenciaFaseTrackingFacadeInput responses: 200: description: Ok schema: #/definitions/integracaoOcorrenciaFaseTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the integracaoOcorrenciaFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/integracaoOcorrenciaFaseTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/integracaoOcorrenciaFaseTracking/{id}: put: description: The update request primitive for the integracaoOcorrenciaFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/integracaoOcorrenciaFaseTrackingFacadeInput responses: 200: description: Ok schema: #/definitions/integracaoOcorrenciaFaseTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the integracaoOcorrenciaFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/integracaoOcorrenciaFaseTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the integracaoOcorrenciaFaseTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/definicaoFilialComposicaoDocumentoTracking: post: description: The create request primitive for the definicaoFilialComposicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/definicaoFilialComposicaoDocumentoTrackingFacadeInput responses: 200: description: Ok schema: #/definitions/definicaoFilialComposicaoDocumentoTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the definicaoFilialComposicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/definicaoFilialComposicaoDocumentoTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/definicaoFilialComposicaoDocumentoTracking/{id}: put: description: The update request primitive for the definicaoFilialComposicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/definicaoFilialComposicaoDocumentoTrackingFacadeInput responses: 200: description: Ok schema: #/definitions/definicaoFilialComposicaoDocumentoTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the definicaoFilialComposicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/definicaoFilialComposicaoDocumentoTrackingFacadeOutput default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the definicaoFilialComposicaoDocumentoTracking facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: composicaoDocumentoTrackingFacadeInput: type: object required: – descricao – numeroTracking – serieTracking – identificadorClienteTracking – tipoDocumentoTracking properties: id: type: string description: format: uuid descricao: type: string description: Descricao numeroTracking: #/definitions/recComposicaoDocumentoTrackingDetalhes serieTracking: #/definitions/recComposicaoDocumentoTrackingDetalhes identificadorClienteTracking: #/definitions/recComposicaoDocumentoTrackingDetalhes tipoDocumentoTracking: #/definitions/recComposicaoDocumentoTrackingDetalhes recComposicaoDocumentoTrackingDetalhes: type: object properties: valor: type: string description: campoRMS: type: string description: posicaoCampoRegex: type: integer description: composicaoDocumentoTrackingFacadeOutput: type: object required: – id – codigo – descricao – numeroTracking – serieTracking – identificadorClienteTracking – tipoDocumentoTracking properties: id: type: string description: Identificador único codigo: type: integer description: codigo descricao: type: string description: Descricao numeroTracking: #/definitions/recComposicaoDocumentoTrackingDetalhes serieTracking: #/definitions/recComposicaoDocumentoTrackingDetalhes identificadorClienteTracking: #/definitions/recComposicaoDocumentoTrackingDetalhes tipoDocumentoTracking: #/definitions/recComposicaoDocumentoTrackingDetalhes createdBy: type: string description: Usuário de criação createdDate: type: string description: Data de criação format: date-time lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string description: Data ultima modificação format: date-time integracaoOcorrenciaFaseTrackingFacadeInput: type: object required: – codigoOcorrencia – codigoFaseTracking – encerraTracking properties: codigoOcorrencia: type: integer description: Código Ocorrência codigoFaseTracking: type: integer description: Código Fase Tracking encerraTracking: type: boolean description: Encerra Tracking integracaoOcorrenciaFaseTrackingFacadeOutput: type: object required: – id – ocorrencia – faseTracking properties: id: type: string description: Id ocorrencia: #/definitions/recMCEOCR faseTracking: #/definitions/recFaseTracking encerraTracking: type: boolean description: Encerra Tracking createdBy: type: string description: Usuário de criação createdDate: type: string description: Data de criação format: date-time lastModifiedBy: type: string description: Usuário última modificação lastModifiedDate: type: string description: Data última modificação format: date-time recMCEOCR: type: object required: – codigo – descricao – ativo properties: codigo: type: integer description: cdocorrencia descricao: type: string description: dsocorrencia ativo: type: boolean description: inativo recFaseTracking: type: object required: – codigo – descricao – ativo properties: codigo: type: integer description: código fase tracking descricao: type: string description: ocorrência fase tracking ativo: type: boolean description: inativo definicaoFilialComposicaoDocumentoTrackingFacadeInput: type: object required: – nrcnpjfilial – integraTracking properties: nrcnpjfilial: type: string description: Cnpj da filial integraTracking: type: boolean description: Integra com tracking composicaoDocumentoTracking: type: string description: Composição documento tracking definicaoFilialComposicaoDocumentoTrackingFacadeOutput: type: object required: – filial – integraTracking – composicaoDocumentoTracking properties: filial: #/definitions/recFilial integraTracking: type: boolean description: Integra com tracking composicaoDocumentoTracking: #/definitions/recComposicaoDocumentoTrackingDefinicao createdBy: type: string description: Usuário de criação createdDate: type: string description: Data de criação format: date-time lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string description: Data ultima modificação format: date-time recFilial: type: object required: – nrcnpjfilial – descricao properties: nrcnpjfilial: type: string description: CNPJ da filial descricao: type: string description: Descrição da filial recComposicaoDocumentoTrackingDefinicao: type: object required: – id – codigo – descricao properties: id: type: string description: Identificador único codigo: type: integer description: Código descricao: type: string description: Descrição integracaoPontoRegraFaseTrackingFacadeInput: type: object required: – pontoRegra – codigoFaseTracking properties: pontoRegra: type: string description: Enum do ponto de regra codigoFaseTracking: type: integer description: Código Fase Tracking encerraTracking: type: boolean description: Encerra Tracking integracaoPontoRegraFaseTrackingFacadeOutput: type: object required: – id – pontoRegra – faseTracking properties: id: type: string description: Id pontoRegra: type: string description: Enum do ponto de regra faseTracking: #/definitions/recFaseTracking encerraTracking: type: boolean description: Encerra Tracking createdBy: type: string description: Usuário de criação createdDate: type: string description: Data de criação format: date-time lastModifiedBy: type: string description: Usuário última modificação lastModifiedDate: type: string description: Data última modificação format: date-time genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE