2.0info: feature-wmspdt-5708-1730139759-SNAPSHOT Tratativa dos datasets de expedição do wms description: Serviço que trata os datasets de expedição do wms x-senior-domain: WMS x-senior-domain-path: wms x-senior-service-path: datasetexpedition 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/wmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /datasetexpedition/queries/getEventPeriod: post: description: Pegar eventPeriod pelo salesEventId tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – year – relative – salesEventId properties: year: type: integer format: int64 description: Ano de referencia relative: type: boolean description: Se o periodo é relativo ou não salesEventId: type: string description: Id do evento responses: 200: description: Ok schema: type: object required: – period properties: period: type: object allOf: – #/definitions/period description: Periodo de inicio e fim 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pegar eventPeriod pelo salesEventId tags: – Queries x-senior-visibility: PRIVATE parameters: – name: year description: Ano de referencia in: query required: true type: integer format: int64 – name: relative description: Se o periodo é relativo ou não in: query required: true type: boolean – name: salesEventId description: Id do evento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – period properties: period: type: object allOf: – #/definitions/period description: Periodo de inicio e fim 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/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 /datasetexpedition/queries/hasPendingReports: post: description: Verifica se existe pendências de extração do relatório tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: system: type: string description: Sistema de referência default: WMS SENIOR responses: 200: description: Ok schema: type: object required: – days properties: days: type: array items: type: string format: date minimum: 1 description: Dias com pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se existe pendências de extração do relatório tags: – Queries x-senior-visibility: PRIVATE parameters: – name: system description: Sistema de referência in: query type: string responses: 200: description: Ok schema: type: object required: – days properties: days: type: array items: type: string format: date minimum: 1 description: Dias com pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/queries/availableEventYearForTenant: post: description: Lista de dados sobre o evento para um tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – salesEventId – tenant properties: salesEventId: type: string description: Id do evento tenant: type: string description: Tenant em análise relative: type: boolean description: Se o dado é relativo, ou se é do periodo completo default: true responses: 200: description: Ok schema: type: object required: – years properties: years: type: array items: type: object allOf: – #/definitions/eventResumee minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista de dados sobre o evento para um tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: salesEventId description: Id do evento in: query required: true type: string – name: tenant description: Tenant em análise in: query required: true type: string – name: relative description: Se o dado é relativo, ou se é do periodo completo in: query type: boolean responses: 200: description: Ok schema: type: object required: – years properties: years: type: array items: type: object allOf: – #/definitions/eventResumee minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/queries/getSalesEvent: post: description: Listar eventos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/salesEvent minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar eventos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/salesEvent minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/queries/getDashboardInfo: post: description: Busca as informações de um evento do ano corrente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – salesEventId properties: tags: type: array items: type: object allOf: – #/definitions/tag description: Filto de tags salesEventId: type: string description: Evento que quer buscar as informacoes responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/dashboardMetrics description: Dados sobre a black friday do ano corrente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/queries/getToggleTenants: post: description: Busca as opereções logisticas que não estão sendo exibidas no board tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/logisticOperationData description: Lista das informacoes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as opereções logisticas que não estão sendo exibidas no board tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: data: type: array items: type: object allOf: – #/definitions/logisticOperationData description: Lista das informacoes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/queries/availableEventDaysForTenant: post: description: Busca as informacoes do evento ingeridos dia a dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – salesEventId – year – tenant properties: salesEventId: type: string description: Id do evento year: type: integer format: int64 description: Ano de referência tenant: type: string description: Tenant responses: 200: description: Ok schema: type: object required: – days properties: days: type: array items: type: object allOf: – #/definitions/dayResumee minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informacoes do evento ingeridos dia a dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: salesEventId description: Id do evento in: query required: true type: string – name: year description: Ano de referência in: query required: true type: integer format: int64 – name: tenant description: Tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – days properties: days: type: array items: type: object allOf: – #/definitions/dayResumee minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/queries/availableTags: post: description: Busca informacões de tags tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tags properties: tags: type: array items: type: object allOf: – #/definitions/tag minimum: 1 description: Lista de tags que existem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca informacões de tags tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tags properties: tags: type: array items: type: object allOf: – #/definitions/tag minimum: 1 description: Lista de tags que existem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/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 /datasetexpedition/queries/exportCompany: 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 /datasetexpedition/queries/exportProduct: 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 /datasetexpedition/queries/exportSale: 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 /datasetexpedition/queries/exportAddress: 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 /datasetexpedition/queries/exportShippingMethod: 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 /datasetexpedition/queries/exportOrders: 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 /datasetexpedition/queries/exportBlackFridayCalendar: 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 /datasetexpedition/queries/exportReportControl: 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 /datasetexpedition/queries/exportFileControl: 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 /datasetexpedition/queries/exportFileError: 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 /datasetexpedition/queries/exportVRelativeBlackfridays: 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 /datasetexpedition/queries/exportVAbsoluteBlackfridays: 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 /datasetexpedition/queries/exportVAbsoluteBlackfridaysDay: 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 /datasetexpedition/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 /datasetexpedition/actions/toggleVisibility: post: description: Altera a visibilidade uma operação logistica no dashboard administrativo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – visible properties: visible: type: boolean description: Retorna a visibilidade aplicada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/actions/deleteControlDays: post: description: Deleta os dias da report_control e file_control tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – days properties: days: type: array items: type: string format: date minimum: 1 description: Dias para serem apagados tenant: type: string description: Nome do tenant para executar responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Resultado da deleção 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/actions/findFileErrors: post: description: Busca pelos dias da report_control e file_control tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: initialDate: type: string format: date description: Data de início da pesquisa finalDate: type: string format: date description: Data de término da pesquisa showReprocessed: type: boolean description: Mostrar Dias que já foram reprocessados default: false page: type: integer format: int64 description: Numero da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/fileError minimum: 1 description: Report control encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/actions/importCompany: 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 /datasetexpedition/actions/importProduct: 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 /datasetexpedition/actions/importSale: 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 /datasetexpedition/actions/importAddress: 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 /datasetexpedition/actions/importShippingMethod: 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 /datasetexpedition/actions/importOrders: 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 /datasetexpedition/actions/importBlackFridayCalendar: 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 /datasetexpedition/actions/importReportControl: 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 /datasetexpedition/actions/importFileControl: 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 /datasetexpedition/actions/importFileError: 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 /datasetexpedition/actions/importVRelativeBlackfridays: 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 /datasetexpedition/actions/importVAbsoluteBlackfridays: 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 /datasetexpedition/actions/importVAbsoluteBlackfridaysDay: 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 /datasetexpedition/signals/sendFile: post: description: Envia um novo arquivo para fila de processamento tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fileData responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /datasetexpedition/signals/updateDaySnapshot: post: description: Pede para atualizar o snapshot de um dia tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – day properties: day: type: string format: date description: Dia de referencia responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /datasetexpedition/signals/updateDaySnapshotForTenant: post: description: Pede para atualizar o snapshot de um dia de um tenant tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – day – tenant properties: day: type: string format: date description: Dia de referencia tenant: type: string description: Tenant que será atualizado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /datasetexpedition/signals/updateDaySnapshotForPastDays: post: description: Pede para atualizar o snapshot para uma quantidade de dias no passado, a partir de ontem. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – numberOfDays properties: numberOfDays: type: integer format: int64 description: Quantidade de dias a serem atualizados (a partir de ontem) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /datasetexpedition/signals/updateDaySnapshotForPastDaysForTenant: post: description: Pede para atualizar o snapshot para uma quantidade de dias no passado, a partir de ontem, para um tenant específico. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – numberOfDays – tenant properties: numberOfDays: type: integer format: int64 description: Quantidade de dias a serem atualizados (a partir de ontem) tenant: type: string description: Tenant que será atualizado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /datasetexpedition/signals/configureDashboard: post: description: Configure Dashboard e Datasets padrão para o tenant tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – type properties: anonymous: type: boolean description: Indica se o dashboard é para base anônima ou do teant default: false type: type: string allOf: – #/definitions/dashboardType description: Indica o tipo de dahboard que deve ser configurado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /datasetexpedition/events/importCompanyEvent: 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 /datasetexpedition/events/exportCompanyEvent: 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 /datasetexpedition/events/importProductEvent: 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 /datasetexpedition/events/exportProductEvent: 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 /datasetexpedition/events/importSaleEvent: 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 /datasetexpedition/events/exportSaleEvent: 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 /datasetexpedition/events/importAddressEvent: 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 /datasetexpedition/events/exportAddressEvent: 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 /datasetexpedition/events/importShippingMethodEvent: 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 /datasetexpedition/events/exportShippingMethodEvent: 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 /datasetexpedition/events/importOrdersEvent: 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 /datasetexpedition/events/exportOrdersEvent: 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 /datasetexpedition/events/importBlackFridayCalendarEvent: 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 /datasetexpedition/events/exportBlackFridayCalendarEvent: 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 /datasetexpedition/events/importReportControlEvent: 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 /datasetexpedition/events/exportReportControlEvent: 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 /datasetexpedition/events/importFileControlEvent: 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 /datasetexpedition/events/exportFileControlEvent: 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 /datasetexpedition/events/importFileErrorEvent: 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 /datasetexpedition/events/exportFileErrorEvent: 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 /datasetexpedition/events/importVRelativeBlackfridaysEvent: 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 /datasetexpedition/events/exportVRelativeBlackfridaysEvent: 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 /datasetexpedition/events/importVAbsoluteBlackfridaysEvent: 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 /datasetexpedition/events/exportVAbsoluteBlackfridaysEvent: 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 /datasetexpedition/events/importVAbsoluteBlackfridaysDayEvent: 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 /datasetexpedition/events/exportVAbsoluteBlackfridaysDayEvent: 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 /datasetexpedition/entities/reportControl/{parentId}/files: post: 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/fileControl responses: 200: description: The created resources schema: type: array items: #/definitions/fileControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/fileControl responses: 200: description: The created resources schema: type: array items: #/definitions/fileControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: array items: #/definitions/fileControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/entities/reportControl/{parentId}/files/{id}: put: 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/fileControl responses: 200: description: Ok schema: #/definitions/fileControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/fileControl responses: 200: description: Ok schema: #/definitions/fileControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/fileControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /datasetexpedition/entities/vRelativeBlackfridays: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vRelativeBlackfridays responses: 200: description: The created resource schema: #/definitions/vRelativeBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vRelativeBlackfridays responses: 200: description: The created resource schema: #/definitions/vRelativeBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: array items: #/definitions/vRelativeBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/entities/vRelativeBlackfridays/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vRelativeBlackfridays responses: 200: description: Ok schema: #/definitions/vRelativeBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vRelativeBlackfridays responses: 200: description: Ok schema: #/definitions/vRelativeBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vRelativeBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /datasetexpedition/entities/vRelativeBlackfridays/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vRelativeBlackfridays responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/entities/vAbsoluteBlackfridays: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vAbsoluteBlackfridays responses: 200: description: The created resource schema: #/definitions/vAbsoluteBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vAbsoluteBlackfridays responses: 200: description: The created resource schema: #/definitions/vAbsoluteBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: array items: #/definitions/vAbsoluteBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/entities/vAbsoluteBlackfridays/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vAbsoluteBlackfridays responses: 200: description: Ok schema: #/definitions/vAbsoluteBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vAbsoluteBlackfridays responses: 200: description: Ok schema: #/definitions/vAbsoluteBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vAbsoluteBlackfridays 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /datasetexpedition/entities/vAbsoluteBlackfridays/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vAbsoluteBlackfridays responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/entities/vAbsoluteBlackfridaysDay: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vAbsoluteBlackfridaysDay responses: 200: description: The created resource schema: #/definitions/vAbsoluteBlackfridaysDay 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vAbsoluteBlackfridaysDay responses: 200: description: The created resource schema: #/definitions/vAbsoluteBlackfridaysDay 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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: array items: #/definitions/vAbsoluteBlackfridaysDay 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datasetexpedition/entities/vAbsoluteBlackfridaysDay/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vAbsoluteBlackfridaysDay responses: 200: description: Ok schema: #/definitions/vAbsoluteBlackfridaysDay 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vAbsoluteBlackfridaysDay responses: 200: description: Ok schema: #/definitions/vAbsoluteBlackfridaysDay 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vAbsoluteBlackfridaysDay 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /datasetexpedition/entities/vAbsoluteBlackfridaysDay/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vAbsoluteBlackfridaysDay responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Define o Status do serviço type: string enum: – UP – DOWN orderType: description: Tipo de pedido type: string enum: – INPUT – OUTPUT cubageType: description: Tipo de cubagem type: string enum: – L – M3 – CM3 – MM3 weightType: description: Tipo de peso type: string enum: – TON – KG – G periodType: description: Define o Status do tipo de período atual type: string enum: – NONE – FREQUENTLY – HOURLY dashboardType: description: Tipo do dashboard que será configurado type: string enum: – BLACKFRIDAY – CHRISTMAS – MONTHLY – MOTHERSDAY – BLACKFRIDAY2022 fileType: description: Define o tipos de arquivos que são processados type: string enum: – INVOICES – PRODUCTS dayStatus: description: Enum que fala o status do dia type: string enum: – REQUESTED – PENDING – PROCESSED fileStatus: description: Enum que fala o status do arquivo type: string enum: – PENDING – PROCESSED 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR company: description: Cadastro de empresa type: object required: – name – companyIdentificationNumber – companyIdentificationType properties: id: type: string format: uuid description: Identificador único do registro name: type: string description: Nome da empresa companyIdentificationNumber: type: string description: Identificação da empresa companyIdentificationType: type: string description: Tipo de identificação da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: product: description: Cadastro de produto type: object required: – type – subtype – ean properties: id: type: string format: uuid description: Identificador único do registro type: type: string description: Tipo do produto subtype: type: string description: Subtipo do produto ean: type: string description: EAN createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: sale: description: Cadastro de vendas type: object required: – referenceDate – product – amount – price – total – system properties: id: type: string format: uuid description: Identificador único do registro referenceDate: type: string format: date description: Data de referencia product: type: object allOf: – #/definitions/product description: Produto amount: type: integer format: int64 description: Quantidade de produtos price: type: string description: Preço por produto total: type: string description: Total da venda dado pela multiplicação dos campos amount e price system: type: string description: Sistema WMS createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: address: description: Cadastro de Endereço type: object required: – uf – city – country properties: id: type: string format: uuid description: Identificador único do registro uf: type: string description: Unidade Federal city: type: string description: Cidade country: type: string 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: shippingMethod: description: Cadastro de método de envio type: object required: – name properties: id: type: string format: uuid description: Identificador único do registro name: type: string description: Nome createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: orders: description: Cadastro de pedido type: object required: – type – invoiceNumber – ownerCompany – cubage – weight – amount – shippedVolumes – issuanceDate – currency – invoiceValue – averageValuePerItem – sender – receiver – shipping – system properties: id: type: string format: uuid description: Identificador único do registro type: type: string allOf: – #/definitions/orderType description: Tipo de pedido invoiceNumber: type: string description: Numero do pedido ownerCompany: type: object allOf: – #/definitions/company description: Empresa proprietaria cubage: type: number format: double description: Cubagem em milimetros cubicos weight: type: number format: double description: Peso em gramas amount: type: integer format: int64 description: Valor do pedido shippedVolumes: type: integer format: int64 description: Volume enviado totalPallets: type: integer format: int64 description: Total de paletes issuanceDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data de emissão currency: type: string description: Sigla da moeda (BRL, EUR, USD, etc) invoiceValue: type: number format: double description: Valor do pedido averageValuePerItem: type: number format: double description: Valor médio por item sender: type: object allOf: – #/definitions/address description: Remetente receiver: type: object allOf: – #/definitions/address description: Destinatário shipping: type: object allOf: – #/definitions/company description: Empresa de transporte shippingMethod: type: object allOf: – #/definitions/shippingMethod description: Tipo de envio system: type: string description: Sistema WMS receiverCompany: type: object allOf: – #/definitions/company description: Empresa/pessoa receptora createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: blackFridayCalendar: description: Calendário Customizado para Black Friday type: object required: – year – blackFriday – firstDayOfMonth – lastDayOfMonth properties: id: type: string format: uuid description: Identificador único do registro year: type: integer format: int64 description: Ano blackFriday: type: string format: date description: Data da Black Friday firstDayOfMonth: type: string format: date description: Primeiro do Mês da Black lastDayOfMonth: type: string format: date description: Ùltimo dia do Mês da Black createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: reportControl: description: Controle de dias que tiveram relatórios extraidos type: object required: – day – system – status – fileType – numberOfZips properties: id: type: string format: uuid description: Identificador único do registro day: type: string format: date description: Dia que foi extraido o relatório system: type: string description: Sistema status: type: string allOf: – #/definitions/dayStatus description: Status do dia fileType: type: string allOf: – #/definitions/fileType description: Tipo do Arquivo numberOfZips: type: integer format: int64 description: Número total de Zips files: type: array items: type: object allOf: – #/definitions/fileControl description: Arquivos que já chegaram createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: fileControl: description: Controle de arquivos de dias solicitados type: object required: – fileName – fileVersion – layoutVersion – status properties: id: type: string format: uuid description: Identificador único do registro reportControl: type: object allOf: – #/definitions/reportControl description: Dia de referencia fileName: type: string description: Nome do arquivo fileVersion: type: string description: Versão do arquivo no blobservice layoutVersion: type: string description: Layout version do arquivo status: type: string allOf: – #/definitions/fileStatus description: Status de processamento do arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: fileError: description: Controle de arquivos de dias solicitados type: object required: – fileName – fileType – processDate – errorMessage – shortErrorMessage – reprocessed properties: id: type: string format: uuid description: Identificador único do registro fileName: type: string description: Nome do arquivo fileType: type: string description: Tipo do arquivo processDate: type: string format: date description: Data de referência do processamento errorMessage: type: string description: Mensagem de erro longa shortErrorMessage: type: string description: Mensagem de erro curta reprocessed: type: boolean description: Flag que diz se o dia foi reprocessado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vRelativeBlackfridays: description: Controle de dados processados da blackfriday com periodo relativo type: object required: – year – totalOrders – totalItems – yoyGrowthOrders – yoyGrowthItems properties: id: type: string format: uuid description: Identificador único do registro year: type: integer format: int64 description: Ano totalOrders: type: integer format: int64 description: Número de notas totalItems: type: integer format: int64 description: Número de produtos yoyGrowthOrders: type: number format: double description: YOY do crescimento da quantidade de notas yoyGrowthItems: type: number format: double description: YOY do crescimento da quantidade de Itens vAbsoluteBlackfridays: description: Controle de dados processados da blackfriday com periodo absoluto type: object required: – year – totalOrders – totalItems – yoyGrowthOrders – yoyGrowthItems properties: id: type: string format: uuid description: Identificador único do registro year: type: integer format: int64 description: Ano totalOrders: type: integer format: int64 description: Número de notas totalItems: type: integer format: int64 description: Número de produtos yoyGrowthOrders: type: number format: double description: YOY do crescimento da quantidade de notas yoyGrowthItems: type: number format: double description: YOY do crescimento da quantidade de Itens vAbsoluteBlackfridaysDay: description: Controle de dados processados da blackfriday no di type: object required: – year – day – totalOrders – totalItems properties: id: type: string format: uuid description: Identificador único do registro year: type: integer format: int64 description: Ano day: type: integer format: int64 description: Dia totalOrders: type: integer format: int64 description: Número de notas totalItems: type: integer format: int64 description: Número de produtos 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 updateSnapshot: description: Dados da fila para atualizar o snapshot que fica salvo na fila type: object required: – day properties: day: type: string format: date description: Dia que será atualizado o snapshot fileData: description: Tipo de arquivo para processamento type: object required: – tenant – urlDownload – targetObjectId – fileName – version – numberOfZips – system – day properties: tenant: type: string description: Tenant dono do arquivo urlDownload: type: string description: Url de download targetObjectId: type: string description: Target do blobservice fileName: type: string description: Nome do arquivo no blobservice type: string description: Versao do arquivo layoutVersion: type: string description: Versão do Layout do Arquivo numberOfZips: type: integer format: int64 description: Número total de Zips system: type: string description: Nome do sistema day: type: string format: date description: Dia de referencia salesEvent: description: Representa a entidade salesEvent type: object required: – id – name properties: id: type: string description: Representa o id da entidade name: type: string description: Representa o nome da entidade period: description: Representa um período type: object required: – startDate – endDate properties: startDate: type: string format: date description: Representa o início do período endDate: type: string format: date description: Representa o fim do período dashboardMetrics: description: Dados para o Dashboard type: object required: – year – periods – clients properties: year: type: integer format: int64 description: Ano de referência periods: type: array items: type: object allOf: – #/definitions/dashboardDataPeriod minimum: 1 description: Periodos fixos clients: type: array items: type: object allOf: – #/definitions/dashboardDataClient minimum: 1 description: Clientes dashboardDataPeriod: description: Dados do periodo allOf: – #/definitions/dashboardData – type: object required: – thisYear – lastYear properties: type: string description: Titulo do cliente thisYear: type: object allOf: – #/definitions/periodReference description: Periodo desse ano lastYear: type: object allOf: – #/definitions/periodReference description: Ano passado dashboardDataClient: description: Dados do cliente allOf: – #/definitions/dashboardData – type: object properties: tenant: type: string description: Tenant do cliente companyName: type: string description: Nome da Empresa lastUpdate: type: string format: date-time description: Data de ultima atualização dashboardData: description: Dados sobre a Black Friday discriminator: _discriminator type: object required: – totalOrders – totalItems – _discriminator properties: totalOrders: type: integer format: int64 description: Total de pedidos no ultimo ano totalItems: type: integer format: int64 description: Total de Itens no ultimo ano yoyOrders: type: number format: double description: Percentual de pedidos ano a ano yoyItems: type: number format: double description: Percentual de itens ano a ano _discriminator: type: string description: logisticOperationData: description: Dados de uma operação logistica type: object required: – tenant – companyName properties: tenant: type: string description: Tenant companyName: type: string description: Nome eventResumee: description: Resumo do evento type: object required: – year – totalOrders – totalItems – yoyGrowthOrders – yoyGrowthItems properties: year: type: integer format: int64 description: Ano totalOrders: type: integer format: int64 description: Número de notas totalItems: type: integer format: int64 description: Número de produtos yoyGrowthOrders: type: number format: double description: YOY do crescimento da quantidade de notas yoyGrowthItems: type: number format: double description: YOY do crescimento da quantidade de Itens dayResumee: description: Dados do resumo de um dia type: object required: – day – totalOrders – totalItems properties: day: type: string format: date description: Dia de referência totalOrders: type: integer format: int64 description: Número de notas ingeridos totalItems: type: integer format: int64 description: Número de produtos ingeridos tag: description: Tag de uma unidade logística type: object required: – title properties: type: string description: Título da tag periodReference: description: Periodo de referência type: object required: – start – end properties: start: type: string format: date description: Quando comeca o periodo end: type: string format: date description: Quando termina o periodo 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 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