erp_sup

ig5_sku

9 views 22/10/2018 22/10/2018 integrador 0

2.0info: 0.1.1 ig5_sku description: Serviço para integração de SKU x-senior-domain: erp_sup x-senior-domain-path: erp_sup x-senior-service-path: ig5_sku contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_supsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ig5_sku/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: 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 in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /ig5_sku/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /ig5_sku/actions/integrarSku: post: description: Grava os dados do SKU tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operacaoIntegracao – sku – skuComplemento properties: operacaoIntegracao: type: string allOf: – #/definitions/enumOperacaoIntegracao description: Operação a ser efetuada sku: type: object allOf: – #/definitions/sku description: Retorna os dados gerais do SKU skuComplemento: type: object allOf: – #/definitions/skuComplemento description: Retorna o complemento do SKU skuEquivalente: type: array items: type: object allOf: – #/definitions/skuEquivalente description: Retorna Skus equivalentes do SKU responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/sku: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sku responses: 200: description: The created resource schema: #/definitions/sku 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/sku responses: 200: description: The created resource schema: #/definitions/sku 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 responses: 200: description: Ok schema: type: array items: #/definitions/sku default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/sku/{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/sku responses: 200: description: Ok schema: #/definitions/sku 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/sku responses: 200: description: Ok schema: #/definitions/sku 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/sku 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 default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/sku/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/sku responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/skuComplemento: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/skuComplemento responses: 200: description: The created resource schema: #/definitions/skuComplemento 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/skuComplemento responses: 200: description: The created resource schema: #/definitions/skuComplemento 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 responses: 200: description: Ok schema: type: array items: #/definitions/skuComplemento default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/skuComplemento/{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/skuComplemento responses: 200: description: Ok schema: #/definitions/skuComplemento 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/skuComplemento responses: 200: description: Ok schema: #/definitions/skuComplemento 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/skuComplemento 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 default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/skuComplemento/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/skuComplemento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/skuEquivalente: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/skuEquivalente responses: 200: description: The created resource schema: #/definitions/skuEquivalente 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/skuEquivalente responses: 200: description: The created resource schema: #/definitions/skuEquivalente 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 responses: 200: description: Ok schema: type: array items: #/definitions/skuEquivalente default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/skuEquivalente/{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/skuEquivalente responses: 200: description: Ok schema: #/definitions/skuEquivalente 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/skuEquivalente responses: 200: description: Ok schema: #/definitions/skuEquivalente 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/skuEquivalente 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 default: description: Error response schema: #/definitions/genericError /ig5_sku/entities/skuEquivalente/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/skuEquivalente responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumOperacaoIntegracao: description: Enumerador de operação de integração type: string enum: – Insercao – Atualizacao – Exclusao enumAtivoInativo: description: Enumeração para Ativo/Inativo type: string enum: – Ativo – Inativo enumTipoReposicaoSKU: description: Enumeração para tipo de reposição do SKU type: string enum: – Produzido – Comprado – Servico enumTipoSKU: description: Enumerador de tipo de SKU type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufatura – EmFabricacao – Subproduto – UsoCosumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumTipoQualidadeSKU: description: Enumeração para tipo de reposição do SKU type: string enum: – Normal – Refugo – SegundaQualidade – TerceiraQualidade 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 sku: description: SKU – produto/serviço type: object required: – empresaCodigo – codigoSKU – descricao – tipoProduto – tipoReposicao – familiaCodigo – unidadeMedidaEstoque – situacao properties: empresaCodigo: type: integer format: int64 description: Código da empresa codigoSKU: type: string maxLength: 30 description: Código descricao: type: string maxLength: 250 description: Descrição descricaoComplementar: type: string maxLength: 250 description: Descrição complementar tipoProduto: type: string allOf: – #/definitions/enumTipoReposicaoSKU description: Tipo de produto tipoReposicao: type: string allOf: – #/definitions/enumTipoSKU description: Tipo de reposição familiaCodigo: type: string description: Código da familia unidadeMedidaEstoque: type: string description: Unidade de medida para estoque situacao: type: string allOf: – #/definitions/enumAtivoInativo description: Situação marcaCodigo: type: string maxLength: 10 description: Marca categoriaId: type: string maxLength: 36 description: Categoria skuComplemento: description: Complemento do SKU type: object required: – empresaCodigo – skuCodigo properties: empresaCodigo: type: integer format: int64 description: Código da empresa skuCodigo: type: string description: Código do SKU skuCodigoSegunda: type: string description: Código do SKU para segunda qualidade skuCodigoTerceira: type: string description: Código do SKU para terceira qualidade skuCodigoRefugo: type: string description: Código do SKU para refugo tipoQualidade: type: string allOf: – #/definitions/enumTipoQualidadeSKU description: Tipo de Qualidade quantidadeMinimaCompra: type: number format: double description: Quantidade minima para compra quantidadeMaximaCompra: type: number format: double description: Quantidade maxima para compra quantidadeMultiplaCompra: type: number format: double description: Quantidade multipla para compra skuEquivalente: description: SKU Equivalente type: object required: – empresaCodigo – skuCodigo – skuCodigoEquivalente properties: empresaCodigo: type: integer format: int64 description: Código da empresa skuCodigo: type: string description: Identificador único do SKU skuCodigoEquivalente: type: string description: Identificador único do SKU notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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 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

Este artigo foi útil para você?

Leave A Comment