2.0info: 2.21.0 Serviço para gestão de produtos description: Serviço para gestão de produtos x-senior-domain: Estoque x-senior-domain-path: erp_est x-senior-service-path: sku_produto 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_estsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /sku_produto/queries/buscarMascarasSku: post: description: Busca máscaras de codificação de SKU conforme família de produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFamilia properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFamilia: type: string description: Código da família de produtos responses: 200: description: Ok schema: type: object properties: mascaras: type: array items: type: object allOf: – #/definitions/recMascaraSku description: Relação de máscaras de SKU aplicáveis à família 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca máscaras de codificação de SKU conforme família de produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa description: Código da empresa in: query required: true type: integer format: int64 – name: codigoFamilia description: Código da família de produtos in: query required: true type: string responses: 200: description: Ok schema: type: object properties: mascaras: type: array items: type: object allOf: – #/definitions/recMascaraSku description: Relação de máscaras de SKU aplicáveis à família 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sku_produto/queries/buscarComponentesMascaraSku: post: description: Busca componentes de máscara de codificação de SKU tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoMascaraSku – paginacao properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoMascaraSku: type: string description: Código da máscara de SKU filtro: type: string description: Filtro de pesquisa por código ou descrição paginacao: type: object allOf: – #/definitions/recPaginacao description: Dados para paginação responses: 200: description: Ok schema: type: object required: – totalRegistros properties: componentes: type: array items: type: object allOf: – #/definitions/recMascaraSkuComponente description: Componentes da máscara de SKU totalRegistros: type: integer format: int64 description: Quantidade total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sku_produto/queries/healthcheck: post: description: Query para o SRE verificar a disponibildade 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 disponibildade 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 /sku_produto/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 /sku_produto/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 /sku_produto/actions/gerarSku: post: description: Gera SKU a partir de uma máscara tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFamilia properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFamilia: type: string description: Família do produto itens: type: array items: type: object allOf: – #/definitions/recItensGeracaoSku description: Itens para geração de SKU responses: 200: description: Ok schema: type: object required: – sku – descricao properties: sku: type: string description: sku gerado descricao: type: string description: descrição do produto gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: inativoAtivo: description: Enumerador de situação do registro type: string enum: – Inativo – Ativo simNao: description: Sim / não type: string enum: – Nao – Sim tipoComposicao: description: Tipo de composição type: string enum: – Alfanumerico – Numerico – SequenciaFixa tipoPessoa: description: Tipo de pessoa Empresa/Filial type: string enum: – Empresa – Filial upDown: description: Up or down type: string enum: – UP – DOWN 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 recMascaraSku: description: Dados de uma máscara de produto type: object required: – id – codigo – descricao – abreviatura – quantidadePosicoes – utilizaComponentes – tipoComposicao – autoIncrementavel – situacao – empresa properties: id: type: string description: ID do registro codigo: type: string description: Código da máscara descricao: type: string description: Descrição da máscara abreviatura: type: string description: Abreviatura da máscara quantidadePosicoes: type: integer format: int64 description: Quantidade de algarismos/caracteres que podem compor a máscara utilizaComponentes: type: string allOf: – #/definitions/simNao description: Indicativo se a máscara utiliza componentes tipoComposicao: type: string allOf: – #/definitions/tipoComposicao description: Indicativo do tipo de composição da máscara autoIncrementavel: type: string allOf: – #/definitions/simNao description: Indicativo se a máscara é autoincrementável, isto é, se seu valor é sequencial ou não situacao: type: string allOf: – #/definitions/inativoAtivo description: Situação máscara sequenciaFixa: type: string maxLength: 10 description: Valor da sequência fixa selecionavelPeloUsuario: type: string allOf: – #/definitions/simNao description: Indicativo se permite informar/selecionar um valor empresa: type: object allOf: – #/definitions/recPessoa description: Empresa valorIncremento: type: integer format: int64 description: Valor do incremento para máscaras numéricas que não utilizam componentes minimum: 0 maximum: 9999 ultimaSequencia: type: integer format: int64 description: Última sequência gerada minimum: 0 maximum: 999999999 recPaginacao: description: Dados de paginação type: object required: – offset – size – orderBy properties: offset: type: integer format: int64 description: Número da página. size: type: integer format: int64 description: Quantidade máxima de registros na página orderBy: type: string description: Campos para ordenação recItensGeracaoSku: description: Definição de máscara para geração de SKU type: object required: – codigoMascara properties: codigoMascara: type: string description: Código da máscara valor: type: string description: Código do componente ou valor da máscara. Obrigatório quando a máscara utilizar componente ou quando a máscara for alfanumérica recPessoa: description: Empresa type: object required: – codigo – tipo properties: id: type: integer format: int64 description: Id da empresa codigo: type: integer format: int64 description: Código da empresa nome: type: string maxLength: 100 description: Nome fantasia da empresa tipo: type: string allOf: – #/definitions/tipoPessoa description: Tipo de pessoa 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 recMascaraSkuComponente: description: Componentes de máscaras de produtos type: object required: – mascara – codigo – sequencia – descricao – abreviatura – situacao properties: id: type: string description: Identificados único mascara: type: object allOf: – #/definitions/recMascaraSku description: Ligação com o cadastro de máscara codigo: type: string maxLength: 14 description: Código do componente sequencia: type: integer format: int64 description: Sequência do componente na máscara minimum: 0 maximum: 999999999 descricao: type: string maxLength: 50 description: Descrição do componente abreviatura: type: string maxLength: 20 description: Abreviatura do componente agrupamento: type: integer format: int64 description: Código do agrupamento para produto minimum: 0 maximum: 9999 situacao: type: string allOf: – #/definitions/inativoAtivo description: Situação do componente 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