2.0info: 2.0.0 sup_mrp description: Serviço de integração demandas MRP x-senior-domain: Dominio do integrador x-senior-domain-path: erpx_int x-senior-service-path: sup_mrp 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/erpx_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /sup_mrp/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sup_mrp/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 /sup_mrp/queries/exportMrpBatchPreparation: 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 /sup_mrp/queries/exportMrpPreparation: 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 /sup_mrp/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 /sup_mrp/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sup_mrp/actions/importMrpBatchPreparation: 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 /sup_mrp/actions/importMrpPreparation: 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 /sup_mrp/signals/processPreparationBatchMrp: post: description: Processar Lote Preparação MRP tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sup_mrp/signals/demandMRPCallback: post: description: chamada de retorno da geração da demanda tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – data properties: transactionalId: type: string description: ID da transação batchId: type: string description: ID do lote de processamento data: type: array items: type: object allOf: – #/definitions/demandMrpCallbackData minimum: 1 description: Dados do payload responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sup_mrp/signals/serviceMRPCallback: post: description: CallBack dos atendimentos MRP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – serviceMrp properties: serviceMrp: type: array items: type: object allOf: – #/definitions/mrpCallback minimum: 1 description: Lista de demandas atendidas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sup_mrp/events/demandsFromMrpCalculationProcessed: post: description: Evento de conclusão do processamento do lote x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – batchId – calculationSkuDocumentDemands properties: batchId: type: string description: Id do Lote calculationSkuDocumentDemands: type: array items: type: object allOf: – #/definitions/calculationSkuDocumentDemands minimum: 1 description: demandas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sup_mrp/events/importMrpBatchPreparationEvent: 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 /sup_mrp/events/exportMrpBatchPreparationEvent: 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 /sup_mrp/events/importMrpPreparationEvent: 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 /sup_mrp/events/exportMrpPreparationEvent: 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 definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumSuplyOfDemandType: description: Tipo de atendimento type: string enum: – PURCHASE – PRODUCE – RESERVE enumSitProcess: description: Situação de processamento type: string enum: – NOT_PROCESSED – PROCESSING – PROCESSED – ERROR enumMrpPreparationStatus: description: Status da preparação type: string enum: – PREPARATION_CRIATION_ERROR – NOT_PROCESSED – CREATING_DEMAND_ON_WAIT – CREATING_MRP_DEMAND – DEMAND_CREATED – MRP_DEMAND_CREATED – MRP_DEMAND_CREATION_ERROR – CREATING_SUPPLY_OF_DEMAND – SUPPLY_OF_DEMAND_CREATION_ERROR – SUPPLY_OF_DEMAND_CREATED 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 checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck mrpCallback: description: Record da chamada de callback discriminator: _discriminator type: object required: – _discriminator properties: externalId: type: string description: Id Externo msgError: type: string description: Mensagem de erro _discriminator: type: string description: demandMrpCallbackData: description: Record da chamada de callback allOf: – #/definitions/mrpCallback – type: object properties: demandId: type: string description: Id da demanda calculationSkuDocumentDemands: description: Documentos das demandas type: object required: – id – status properties: id: type: string description: ID do documento status: type: string allOf: – #/definitions/enumMrpPreparationStatus description: Status mrpBatchPreparation: description: Lote de preparação de processamento de demandas com origem no MRP type: object required: – branchId – mrpId – typePreparation – status – processId properties: id: type: string format: uuid description: ID branchId: type: string description: Identifcador da filial mrpId: type: string description: Identificador do calculo do MRP que originou o lote typePreparation: type: string allOf: – #/definitions/enumSuplyOfDemandType description: Tipo de atendimento da demanda a ser processada pelo lote startDate: type: string format: date-time description: Data e hora inicial do processamento do lote endDate: type: string format: date-time description: Data e hora final do processamento do lote status: type: string allOf: – #/definitions/enumSitProcess description: Situação do processamento do lote processId: type: string format: uuid description: Identificador único do processo (evento) que gerou o lote usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: mrpPreparation: description: Preparação de processamento de demandas com origem no MRP type: object required: – mrpBatchPreparation – mrpId – mrpCode – branchId – startDate – deliveryDate – calculationSkuDocumentId – productId – quantity – demandQuantity – status – processId properties: id: type: string format: uuid description: Identificador da preparação mrpBatchPreparation: type: object allOf: – #/definitions/mrpBatchPreparation description: Identificador do lote de preparação de processamento de demandas mrpId: type: string description: Identificador do calculo do MRP que originou a preparação mrpCode: type: integer format: int64 description: Código do cálculo do MRP que originou a preparação branchId: type: string description: Identificador da filial startDate: type: string format: date description: Data de entrega recomendada para inicio do atendimento da demanda deliveryDate: type: string format: date description: Data de entrega da demanda calculationSkuDocumentId: type: string description: Identificador do cálculo do documento por SKU MRP productId: type: string description: Identificador do produto quantity: type: string description: Quantidade total calculada pelo MRP para o SKU externalId: type: string description: Id externo demandId: type: string description: Identificador da demanda calculada pelo MRP para atendimento demandMrpId: type: string description: Identificador da demanda do tipo MRP gerada pelo gestão de demandas demandQuantity: type: string description: Quantidade a ser atendida da demanda supplyOfDemandId: type: string description: Identificador do atendimento da demanda urgent: type: boolean description: Indicativo de urgência para demandas do tipo MRP default: false warehouseId: type: string description: Identificador do depósito reserv: type: boolean description: Reserva default: false documentNumber: type: string description: Número do documento para demandas do tipo MRP status: type: string allOf: – #/definitions/enumMrpPreparationStatus description: Situação da preparação errorMsg: type: string description: Mensagem de erro do processo processId: type: string format: uuid description: Identificador único do processo (evento) que gerou a preparacao usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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