2.0info: rework-wmspdt-5495-1724272610-SNAPSHOT Extração de dados WMS description: Serviço que faz extração de dados do WMS x-senior-domain: WMS Integração x-senior-domain-path: wms_int x-senior-service-path: extractor 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/wms_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /extractor/queries/healthcheck: post: description: Verificação disponibilidade do serviço 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 do serviço checks: type: object allOf: – #/definitions/checkDTO description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verificação disponibilidade do serviço 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 do serviço checks: type: object allOf: – #/definitions/checkDTO description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/queries/getChecklist: post: description: Checklist de Configuração da extração tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: checksList: type: array items: type: string description: Lista de Checagens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Checklist de Configuração da extração tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: checksList: type: array items: type: string description: Lista de Checagens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/queries/checkConnectionForTenant: post: description: Verifica se a conexão com o cliente está online tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Cliente responses: 200: description: Ok schema: type: object required: – online properties: online: type: boolean description: Se está online ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se a conexão com o cliente está online tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object required: – online properties: online: type: boolean description: Se está online ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/queries/checkTotalsForPeriodForTenant: post: description: Verifica os Totais da blackfriday de um ano tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – year – tenant – salesEventId properties: year: type: integer format: int64 description: Ano referencia tenant: type: string description: Cliente relative: type: boolean description: Periodo Relativo default: true salesEventId: type: string description: Id do evento responses: 200: description: Ok schema: type: object allOf: – #/definitions/resumee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica os Totais da blackfriday de um ano tags: – Queries x-senior-visibility: PRIVATE parameters: – name: year description: Ano referencia in: query required: true type: integer format: int64 – name: tenant description: Cliente in: query required: true type: string – name: relative description: Periodo Relativo in: query type: boolean – name: salesEventId description: Id do evento in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/resumee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/queries/checkTotalsOfADayForTenant: post: description: Verifica os Totais para um dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – referenceDate – tenant properties: referenceDate: type: string format: date description: Dia referencia tenant: type: string description: Cliente responses: 200: description: Ok schema: type: object allOf: – #/definitions/resumee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica os Totais para um dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceDate description: Dia referencia in: query required: true type: string format: date – name: tenant description: Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/resumee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/queries/checkTotalsOfADay: post: description: Verifica os Totais para um dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – referenceDate properties: referenceDate: type: string format: date description: Dia referencia responses: 200: description: Ok schema: type: object allOf: – #/definitions/resumee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica os Totais para um dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: referenceDate description: Dia referencia in: query required: true type: string format: date responses: 200: description: Ok schema: type: object allOf: – #/definitions/resumee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/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 /extractor/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 /extractor/actions/createSchedulerForTenant: post: description: Criar os agendamentos para chamar o endpoint processPendingData para um tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Tenant que é para criar o scheduler responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/deleteScheduler: post: description: Deleta o agendamento que chama ao endpoint processPendingData tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: integer format: int64 description: Numero de jobs deletados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/createRetroactiveSchedulerForTenant: post: description: Cria o scheduler retroativo para deixar um outro tenant no automático – Apenas master. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Tenant alvo responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Se deu certo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/actions/createRetroactiveScheduler: post: description: Cria o scheduler retroativo para deixar o tenant no automático tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Se deu certo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /extractor/signals/createScheduler: post: description: Cria os agendamentos para chamar o endpoint processPendingData tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /extractor/signals/processPendingData: post: description: Processa dados de dias pendentes para envio ao datalake tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /extractor/signals/processDataInPeriod: post: description: Processa os dados em um periodo específico tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – initialDate – finalDate properties: initialDate: type: string format: date description: Data Inicial finalDate: type: string format: date description: Data final responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /extractor/signals/processDataInPeriodForTenant: post: description: Processa os dados em um periodo específico para um tenant tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenant – initialDate – finalDate properties: tenant: type: string description: Tenant initialDate: type: string format: date description: Data Inicial finalDate: type: string format: date description: Data final responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Define o Status do serviço type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/healthcheckDTO description: Status do healthcheck resumee: description: Dados do resumo de um periodo / dia type: object required: – totalOrders – totalItems properties: totalOrders: type: integer format: int64 description: Número de notas totalItems: type: integer format: int64 description: Número de produtos 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. 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 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