2.0info: 5.70.0 Serviço de integração com parceiros externos description: Serviço de integração com parceiros externos x-senior-domain: Gestão industrial x-senior-domain-path: erp_man x-senior-service-path: eng_external 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/erp_mansecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /eng_external/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 /eng_external/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 /eng_external/actions/createBranch: post: description: Criar uma nova filial\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – branches properties: branches: type: array items: type: object allOf: – #/definitions/branchData minimum: 1 description: Filiais a serem criadas responses: 200: description: Ok schema: type: object required: – branches properties: branches: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Filiais processadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/updateBranch: post: description: Atualizar os dados de uma filial\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – branches properties: branches: type: array items: type: object allOf: – #/definitions/branchData minimum: 1 description: Filiais a serem atualizadas responses: 200: description: Ok schema: type: object required: – branches properties: branches: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Filiais processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/deleteBranch: post: description: Excluir uma filial\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: integer format: int64 minimum: 1 description: Lista – Código da filial responses: 200: description: Ok schema: type: object required: – branches properties: branches: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Filiais processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/createFamily: post: description: Criar nova familia\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – families properties: families: type: array items: type: object allOf: – #/definitions/familyData minimum: 1 description: Lista – Familias a serem criadas responses: 200: description: Ok schema: type: object required: – families properties: families: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Famílias processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/updateFamily: post: description: Atualizar os dados da familia\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – families properties: families: type: array items: type: object allOf: – #/definitions/familyData minimum: 1 description: Lista – Familias a serem editadas responses: 200: description: Ok schema: type: object required: – families properties: families: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Famílias processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/deleteFamily: post: description: Deletar familia\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: string minimum: 1 description: Lista – Código familia responses: 200: description: Ok schema: type: object required: – families properties: families: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Famílias processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/createUnitMeasure: post: description: Criar nova unidade de medida\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – unitsMeasure properties: unitsMeasure: type: array items: type: object allOf: – #/definitions/unitMeasureData minimum: 1 description: Lista – Unidades de medida a serem criadas responses: 200: description: Ok schema: type: object required: – measurementUnits properties: measurementUnits: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Unidades de medida processadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/updateUnitMeasure: post: description: Atualizar os dados da unidade de medida\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – unitsMeasure properties: unitsMeasure: type: array items: type: object allOf: – #/definitions/unitMeasureData minimum: 1 description: Lista – Unidades de medida a serem editadas responses: 200: description: Ok schema: type: object required: – measurementUnits properties: measurementUnits: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Unidades de medida processadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/deleteUnitMeasure: post: description: Deletar unidade de medida\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: string minimum: 1 description: Lista – Código unidade de medida responses: 200: description: Ok schema: type: object required: – measurementUnits properties: measurementUnits: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Unidades de medida processadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/createUnitMeasureCon post: description: Criar nova unidade de medida conversão\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – unitsMeasureConversion properties: unitsMeasureCon type: array items: type: object allOf: – #/definitions/unitMeasureConversionData minimum: 1 description: Lista – Unidades de medida conversão a serem criadas responses: 200: description: Ok schema: type: object required: – measurementUnitsConversion properties: measurementUnitsCon type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Unidades de medida conversão processadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/updateUnitMeasureCon post: description: Atualizar os dados da unidade de medida conversão\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – unitsMeasureConversion properties: unitsMeasureCon type: array items: type: object allOf: – #/definitions/unitMeasureConversionData minimum: 1 description: Lista – Unidades de medida conversão a serem editadas responses: 200: description: Ok schema: type: object required: – measurementUnitsConversion properties: measurementUnitsCon type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Unidades de medida conversão processadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/deleteUnitMeasureCon post: description: Deletar unidade de medida conversão\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – unitsMeasureConversion properties: unitsMeasureCon type: array items: type: object allOf: – #/definitions/unitMeasureConversionDeleteData minimum: 1 description: Lista – Código unidade de medida responses: 200: description: Ok schema: type: object required: – measurementUnitsConversion properties: measurementUnitsCon type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Unidades de medida conversão processadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/createClient: post: description: Criar novo cliente\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – clients properties: clients: type: array items: type: object allOf: – #/definitions/clientData minimum: 1 description: Lista – Cliente a serem criados responses: 200: description: Ok schema: type: object required: – clients properties: clients: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Clientes processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/updateClient: post: description: Atualizar os dados do cliente\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – clients properties: clients: type: array items: type: object allOf: – #/definitions/clientData minimum: 1 description: Lista – Clientes a serem editados responses: 200: description: Ok schema: type: object required: – clients properties: clients: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Clientes processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/deleteClient: post: description: Deletar cliente\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: integer format: int64 minimum: 1 description: Lista – Código do cliente responses: 200: description: Ok schema: type: object required: – clients properties: clients: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Clientes processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/createSKU: post: description: Criar novo SKU\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – skus properties: skus: type: array items: type: object allOf: – #/definitions/skuData minimum: 1 description: Lista – SKUs a serem criados responses: 200: description: Ok schema: type: object required: – skus properties: skus: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Skus processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/updateSKU: post: description: Atualizar os dados do SKU\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – skus properties: skus: type: array items: type: object allOf: – #/definitions/skuData minimum: 1 description: Lista – SKUs a serem editados responses: 200: description: Ok schema: type: object required: – skus properties: skus: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Skus processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/deleteSKU: post: description: Deletar SKU\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: string minimum: 1 description: Lista – Código do SKU responses: 200: description: Ok schema: type: object required: – skus properties: skus: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Skus processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/createCostCenter: post: description: Criar novo centro de custo\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – costCenters properties: costCenters: type: array items: type: object allOf: – #/definitions/costCenterData minimum: 1 description: Lista – Centros de custo a serem criados responses: 200: description: Ok schema: type: object required: – costCenters properties: costCenters: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Centros de custo processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/updateCostCenter: post: description: Atualizar os dados do centro de custo\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – costCenters properties: costCenters: type: array items: type: object allOf: – #/definitions/costCenterData minimum: 1 description: Lista – Centros de custo a serem editados responses: 200: description: Ok schema: type: object required: – costCenters properties: costCenters: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Centros de custo processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eng_external/actions/deleteCostCenter: post: description: Deletar centro de custo\n### Resources\n- res://senior.com.br/erp_man/eng_external/integracao – Processar tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: string minimum: 1 description: Lista – Código do centro de custo responses: 200: description: Ok schema: type: object required: – costCenters properties: costCenters: type: array items: type: object allOf: – #/definitions/recDefaultData minimum: 1 description: Centros de custo processados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: enumTypeFactor: description: Tipos de fator de conversão type: string enum: – MULTIPLICATION – DIVISION enumSpareType: description: Tipos de reposição type: string enum: – PRODUCED – BOUGHT – SERVICE enumTypeCostCenter: description: Tipos de centro de custo type: string enum: – DIRECT_OPERATING_PRODUCTIVE – INDIRECT_OPERATING_PRODUCTIVE – ADMINISTRATIVE – COMMERCIAL – FINANCIAL enumTimeUnitType: description: Tipos de unidades de tempo type: string enum: – HOURS – MINUTES – SECONDS – DAYS – NOT_APPLICABLE 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 recDefaultData: description: Dados gerais do retorno type: object required: – code properties: id: type: string description: Identificador do registro code: type: string description: Código do registro branchData: description: Dados básicos da filial type: object required: – code – description – fantasy properties: code: type: integer format: int64 description: Código da filial description: type: string maxLength: 100 description: Nome da filial fantasy: type: string maxLength: 100 description: Nome fantasia da filial familyData: description: Dados básicos da familia type: object required: – code – description – spareType properties: code: type: string maxLength: 6 description: Código da familia description: type: string maxLength: 50 description: Descrição da familia spareType: type: string allOf: – #/definitions/enumSpareType description: Tipo de reposição da familia unitMeasureData: description: Dados básicos da unidade de medida type: object required: – code – description properties: code: type: string maxLength: 6 description: Código da unidade de medida description: type: string maxLength: 40 description: Descrição da unidade de medida decimalAmount: type: integer format: int64 description: Quantidade de decimais suportada pela unidade de medida unitMeasureConversionData: description: Dados básicos da unidade de medida conversão type: object required: – codeOrigin – codeDestiny – typeFactor – factor properties: codeOrigin: type: string maxLength: 6 description: Código unidade de medida origem codeDestiny: type: string maxLength: 6 description: Código unidade de medida destino typeFactor: type: string allOf: – #/definitions/enumTypeFactor description: Tipo do fator de conversão factor: type: number format: double description: Fator de conversão unitMeasureConversionDeleteData: description: Dados da unidade de medida conversão a ser excluida type: object required: – codeOrigin – codeDestiny properties: codeOrigin: type: string maxLength: 6 description: Código unidade de medida origem codeDestiny: type: string maxLength: 6 description: Código unidade de medida destino clientData: description: Dados básicos do cliente type: object required: – code – description – fantasy properties: code: type: integer format: int64 description: Código do cliente description: type: string maxLength: 100 description: Nome do cliente fantasy: type: string maxLength: 100 description: Nome fantasia do cliente skuData: description: Dados básicos do SKU usados para inserir type: object required: – code – description – spareType – familyCode – unitMeasureCode properties: code: type: string maxLength: 23 description: Código do SKU description: type: string maxLength: 120 description: Descrição do SKU descriptionSupplementary: type: string maxLength: 120 description: Descrição complementar do SKU spareType: type: string allOf: – #/definitions/enumSpareType description: Tipo de reposição do SKU familyCode: type: string description: Código da família unitMeasureCode: type: string description: Código da unidade de medida checkDTO: description: Record declarado apenas para não gerar a implementação da primitiva HealthCheck type: object costCenterData: description: Dados do centro de custo type: object required: – code – description – type – timeUnitType properties: code: type: string maxLength: 20 description: Código do centro de custo description: type: string maxLength: 80 description: Descrição do centro de custo type: type: string allOf: – #/definitions/enumTypeCostCenter description: Tipo do centro de custo timeUnitType: type: string allOf: – #/definitions/enumTimeUnitType description: Tipo unidade de tempo parentCostCenterCode: type: string description: Código do centro de custo pai notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE