Serviço de integração com parceiros externos (eng_external)

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: api.senior.com.br /erp_man/eng_externalsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /createClient: post: description: Criar novo cliente ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – clients properties: clients: type: array items: #/definitions/clientData description: Lista – Cliente a serem criados responses: 200: description: Ok schema: type: object required: – clients properties: clients: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /deleteBranch: post: description: Excluir uma filial ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: integer description: Lista – Código da filial responses: 200: description: Ok schema: type: object required: – branches properties: branches: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /deleteUnitMeasure: post: description: Deletar unidade de medida ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: string description: Lista – Código unidade de medida responses: 200: description: Ok schema: type: object required: – measurementUnits properties: measurementUnits: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /updateSKU: post: description: Atualizar os dados do SKU ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – skus properties: skus: type: array items: #/definitions/skuData description: Lista – SKUs a serem editados responses: 200: description: Ok schema: type: object required: – skus properties: skus: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /updateBranch: post: description: Atualizar os dados de uma filial ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – branches properties: branches: type: array items: #/definitions/branchData description: Filiais a serem atualizadas responses: 200: description: Ok schema: type: object required: – branches properties: branches: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /deleteClient: post: description: Deletar cliente ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: integer description: Lista – Código do cliente responses: 200: description: Ok schema: type: object required: – clients properties: clients: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /updateClient: post: description: Atualizar os dados do cliente ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – clients properties: clients: type: array items: #/definitions/clientData description: Lista – Clientes a serem editados responses: 200: description: Ok schema: type: object required: – clients properties: clients: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /updateCostCenter: post: description: Atualizar os dados do centro de custo ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – costCenters properties: costCenters: type: array items: #/definitions/costCenterData description: Lista – Centros de custo a serem editados responses: 200: description: Ok schema: type: object required: – costCenters properties: costCenters: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /createCostCenter: post: description: Criar novo centro de custo ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – costCenters properties: costCenters: type: array items: #/definitions/costCenterData description: Lista – Centros de custo a serem criados responses: 200: description: Ok schema: type: object required: – costCenters properties: costCenters: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /createSKU: post: description: Criar novo SKU ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – skus properties: skus: type: array items: #/definitions/skuData description: Lista – SKUs a serem criados responses: 200: description: Ok schema: type: object required: – skus properties: skus: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /deleteUnitMeasureCon post: description: Deletar unidade de medida conversão ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – unitsMeasureConversion properties: unitsMeasureCon type: array items: #/definitions/unitMeasureConversionDeleteData description: Lista – Código unidade de medida responses: 200: description: Ok schema: type: object required: – measurementUnitsConversion properties: measurementUnitsCon #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /deleteSKU: post: description: Deletar SKU ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: string description: Lista – Código do SKU responses: 200: description: Ok schema: type: object required: – skus properties: skus: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /createUnitMeasure: post: description: Criar nova unidade de medida ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – unitsMeasure properties: unitsMeasure: type: array items: #/definitions/unitMeasureData description: Lista – Unidades de medida a serem criadas responses: 200: description: Ok schema: type: object required: – measurementUnits properties: measurementUnits: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /createFamily: post: description: Criar nova familia ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – families properties: families: type: array items: #/definitions/familyData description: Lista – Familias a serem criadas responses: 200: description: Ok schema: type: object required: – families properties: families: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /deleteCostCenter: post: description: Deletar centro de custo ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: string description: Lista – Código do centro de custo responses: 200: description: Ok schema: type: object required: – costCenters properties: costCenters: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /updateUnitMeasure: post: description: Atualizar os dados da unidade de medida ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – unitsMeasure properties: unitsMeasure: type: array items: #/definitions/unitMeasureData description: Lista – Unidades de medida a serem editadas responses: 200: description: Ok schema: type: object required: – measurementUnits properties: measurementUnits: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /updateFamily: post: description: Atualizar os dados da familia ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – families properties: families: type: array items: #/definitions/familyData description: Lista – Familias a serem editadas responses: 200: description: Ok schema: type: object required: – families properties: families: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /updateUnitMeasureCon post: description: Atualizar os dados da unidade de medida conversão ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – unitsMeasureConversion properties: unitsMeasureCon type: array items: #/definitions/unitMeasureConversionData description: Lista – Unidades de medida conversão a serem editadas responses: 200: description: Ok schema: type: object required: – measurementUnitsConversion properties: measurementUnitsCon #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /createUnitMeasureCon post: description: Criar nova unidade de medida conversão ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – unitsMeasureConversion properties: unitsMeasureCon type: array items: #/definitions/unitMeasureConversionData description: Lista – Unidades de medida conversão a serem criadas responses: 200: description: Ok schema: type: object required: – measurementUnitsConversion properties: measurementUnitsCon #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /deleteFamily: post: description: Deletar familia ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – codes properties: codes: type: array items: type: string description: Lista – Código familia responses: 200: description: Ok schema: type: object required: – families properties: families: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericError /createBranch: post: description: Criar uma nova filial ### Resources - res://senior.com.br/erp_man/eng_external/integracao – Processar x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – branches properties: branches: type: array items: #/definitions/branchData description: Filiais a serem criadas responses: 200: description: Ok schema: type: object required: – branches properties: branches: #/definitions/recDefaultData default: description: Error response schema: #/definitions/genericErrordefinitions: enumSpareType: type: string enum: – PRODUCED – BOUGHT – SERVICE enumTypeFactor: type: string enum: – MULTIPLICATION – DIVISION enumTypeCostCenter: type: string enum: – DIRECT_OPERATING_PRODUCTIVE – INDIRECT_OPERATING_PRODUCTIVE – ADMINISTRATIVE – COMMERCIAL – FINANCIAL enumTimeUnitType: type: string enum: – HOURS – MINUTES – SECONDS – DAYS – NOT_APPLICABLE recDefaultData: type: object required: – code properties: id: type: string description: Identificador do registro code: type: string description: Código do registro branchData: type: object required: – code – description – fantasy properties: code: type: integer description: Código da filial description: type: string description: Nome da filial fantasy: type: string description: Nome fantasia da filial familyData: type: object required: – code – description – spareType properties: code: type: string description: Código da familia description: type: string description: Descrição da familia spareType: #/definitions/enumSpareType unitMeasureData: type: object required: – code – description properties: code: type: string description: Código da unidade de medida description: type: string description: Descrição da unidade de medida decimalAmount: type: integer description: Quantidade de decimais suportada pela unidade de medida unitMeasureConversionData: type: object required: – codeOrigin – codeDestiny – typeFactor – factor properties: codeOrigin: type: string description: Código unidade de medida origem codeDestiny: type: string description: Código unidade de medida destino typeFactor: #/definitions/enumTypeFactor factor: type: number description: Fator de conversão format: double unitMeasureConversionDeleteData: type: object required: – codeOrigin – codeDestiny properties: codeOrigin: type: string description: Código unidade de medida origem codeDestiny: type: string description: Código unidade de medida destino clientData: type: object required: – code – description – fantasy properties: code: type: integer description: Código do cliente description: type: string description: Nome do cliente fantasy: type: string description: Nome fantasia do cliente skuData: type: object required: – code – description – spareType – familyCode – unitMeasureCode properties: code: type: string description: Código do SKU description: type: string description: Descrição do SKU descriptionSupplementary: type: string description: Descrição complementar do SKU spareType: #/definitions/enumSpareType familyCode: type: string description: Código da família unitMeasureCode: type: string description: Código da unidade de medida costCenterData: type: object required: – code – description – type – timeUnitType properties: code: type: string description: Código do centro de custo description: type: string description: Descrição do centro de custo type: #/definitions/enumTypeCostCenter timeUnitType: #/definitions/enumTimeUnitType parentCostCenterCode: type: string description: Código do centro de custo pai 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