erp_est

sku_produto (Serviço para gestão de produtos)

55 views 22/10/2018 16/09/2020 integrador 0

2.0info: 2.4.1 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: http://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 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 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/mascaraSkuComponente description: Componentes da máscara de SKU totalRegistros: type: integer format: int64 description: Quantidade total de registros default: description: Error response schema: #/definitions/genericError /sku_produto/queries/buscarEmpresa: post: description: Busca por múltiplas empresas podendo ser todas caso nenhum filtro seja informado, ou uma lista filtrada caso algum seja. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: id: type: integer format: int64 description: Id da empresa texto: type: string description: Texto para busca parcial no código ou nome fantasia da empresa pagina: type: object allOf: – #/definitions/recPaginacaoLimit description: Dados para paginação responses: 200: description: Ok schema: type: object required: – totalRegistros properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa description: Retorna lista de empresas filtrada pelos parâmetros informados totalRegistros: type: integer format: int64 description: Total de registros para paginação default: description: Error response schema: #/definitions/genericError /sku_produto/queries/buscarIdsTodasEmpresas: post: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os IDs das empresas tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas default: description: Error response schema: #/definitions/genericError /sku_produto/queries/buscarFiliaisMultiplasEmpresas: post: description: Retornar empresas com suas filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – todas – pagina properties: texto: type: string description: Texto para busca parcial no código ou nome fantasia da empresa todas: type: boolean description: Flag indicando se a busca por filiais deve considerar todas as empresas. somente: type: array items: type: integer format: int64 description: Caso todas == false, devem ser informadas as empresas selecionadas para buscar suas filiais. Nesse caso o campo exceto é ignorado. exceto: type: array items: type: integer format: int64 description: Caso todas == true, as filiais de todas as empresas devem ser consideradas na busca. Caso o usuário selecione todas as empresas e desmarca algumas poucas, o componente enviará os IDs das empresas desmarcadas nesse campo pagina: type: object allOf: – #/definitions/recPaginacaoLimit description: Dados para paginação responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaComFiliais minimum: 1 description: Retorna lista de empresas e filiais filtrada pelos parâmetros informados default: description: Error response schema: #/definitions/genericError /sku_produto/queries/buscarIdsFiliaisPorEmpresas: post: description: Retorna todos os IDs das filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das empresas responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das filiais default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os IDs das filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaIds description: IDs das empresas in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: IDs das filiais 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 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 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: 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: default: description: Error response schema: #/definitions/genericError /sku_produto/queries/exportPessoa: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/queries/exportFamilia: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/queries/exportSku: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/queries/exportDeposito: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/queries/exportMascaraSku: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/queries/exportMascaraSkuComponente: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/queries/exportMascaraSkuFamilia: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: 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: 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 /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 default: description: Error response schema: #/definitions/genericError /sku_produto/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /sku_produto/actions/importPessoa: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/actions/importFamilia: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/actions/importSku: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/actions/importDeposito: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/actions/importMascaraSku: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/actions/importMascaraSkuComponente: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/actions/importMascaraSkuFamilia: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /sku_produto/entities/pessoa: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pessoa responses: 200: description: The created resource schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pessoa responses: 200: description: The created resource schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/pessoa default: description: Error response schema: #/definitions/genericError /sku_produto/entities/pessoa/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pessoa responses: 200: description: Ok schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pessoa responses: 200: description: Ok schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pessoa default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /sku_produto/entities/pessoa/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pessoa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /sku_produto/entities/familia: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/familia responses: 200: description: The created resource schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/familia default: description: Error response schema: #/definitions/genericError /sku_produto/entities/familia/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/familia responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/familia default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /sku_produto/entities/familia/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/familia responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /sku_produto/entities/sku: post: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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 /sku_produto/entities/sku/{id}: put: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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: description: This entity is customizable. 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 /sku_produto/entities/sku/bulk: post: description: This entity is customizable. 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 /sku_produto/entities/deposito: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposito responses: 200: description: The created resource schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposito responses: 200: description: The created resource schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/deposito default: description: Error response schema: #/definitions/genericError /sku_produto/entities/deposito/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposito responses: 200: description: Ok schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposito responses: 200: description: Ok schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/deposito default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /sku_produto/entities/deposito/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/deposito responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /sku_produto/entities/mascaraSku: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mascaraSku responses: 200: description: The created resource schema: #/definitions/mascaraSku default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mascaraSku responses: 200: description: The created resource schema: #/definitions/mascaraSku default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/mascaraSku default: description: Error response schema: #/definitions/genericError /sku_produto/entities/mascaraSku/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mascaraSku responses: 200: description: Ok schema: #/definitions/mascaraSku default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mascaraSku responses: 200: description: Ok schema: #/definitions/mascaraSku default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/mascaraSku default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /sku_produto/entities/mascaraSku/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mascaraSku responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /sku_produto/entities/mascaraSkuComponente: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mascaraSkuComponente responses: 200: description: The created resource schema: #/definitions/mascaraSkuComponente default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mascaraSkuComponente responses: 200: description: The created resource schema: #/definitions/mascaraSkuComponente default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/mascaraSkuComponente default: description: Error response schema: #/definitions/genericError /sku_produto/entities/mascaraSkuComponente/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mascaraSkuComponente responses: 200: description: Ok schema: #/definitions/mascaraSkuComponente default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mascaraSkuComponente responses: 200: description: Ok schema: #/definitions/mascaraSkuComponente default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/mascaraSkuComponente default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /sku_produto/entities/mascaraSkuComponente/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mascaraSkuComponente responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /sku_produto/entities/mascaraSkuFamilia: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mascaraSkuFamilia responses: 200: description: The created resource schema: #/definitions/mascaraSkuFamilia default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mascaraSkuFamilia responses: 200: description: The created resource schema: #/definitions/mascaraSkuFamilia default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/mascaraSkuFamilia default: description: Error response schema: #/definitions/genericError /sku_produto/entities/mascaraSkuFamilia/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mascaraSkuFamilia responses: 200: description: Ok schema: #/definitions/mascaraSkuFamilia default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mascaraSkuFamilia responses: 200: description: Ok schema: #/definitions/mascaraSkuFamilia default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/mascaraSkuFamilia default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. 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 /sku_produto/entities/mascaraSkuFamilia/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mascaraSkuFamilia responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumTipoSKU: description: Enumerador de tipo de produto type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufaturado – EmFabricacao – SubProduto – UsoCosumo – AtivoImobilizado – Servico – OutrosInsumos – Outros enumSituacaoSKU: description: Enumerador de situação do SKU type: string enum: – Inativo – Ativo – Bloqueado enumTipoReposicao: description: Tipo reposição type: string enum: – Produzido – Comprado – Servico enumTiposConsumo: description: Tipos para movimento de estoque type: string enum: – Venda – RemessaParaIndustrializacao – TransferenciaEntreFiliais – DevolucaoParaFornecedor – AbastecimentoDeProducao – Compra – DevolucaoDeCliente – ApontamentoDeProducao – ConsumoProprio – AcertoSobra – AcertoPerda – RetornoRemessaIndustrializacao – Bloqueio enumInativoAtivo: description: Enumerador de situação do registro type: string enum: – Inativo – Ativo enumEntradaSaida: description: Enumerador de situação do registro type: string enum: – Entrada – Saida enumSimNao: description: Sim / não type: string enum: – Nao – Sim enumFormaValorizacao: description: Forma de valorização type: string enum: – Movimento – Fechamento enumTipoMovimentoEstoque: description: Tipo do movimento de estoque G5 type: string enum: – Normal – NormalReservado – NormalBloqueado – Reservado – Bloqueado – ConsignadoCliente – ConsignadoFornecedor enumTipoMovimento: description: Tipo do movimento de estoque type: string enum: – Entrada – Saida – Reserva – Bloqueio enumSituacaoIntegracao: description: Situação integração type: string enum: – NaoIntegrado – Integrado enumTipoComposicao: description: Tipo de composição type: string enum: – Alfanumerico – Numerico – SequenciaFixa enumTipoPessoa: 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – 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 recMascaraSku: description: Dados de uma máscara de produto type: object required: – id – codigo – descricao – abreviatura – quantidadePosicoes – utilizaComponentes – tipoComposicao – autoIncrementavel – situacao 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/enumSimNao description: Indicativo se a máscara utiliza componentes tipoComposicao: type: string allOf: – #/definitions/enumTipoComposicao description: Indicativo do tipo de composição da máscara autoIncrementavel: type: string allOf: – #/definitions/enumSimNao description: Indicativo se a máscara é autoincrementável, isto é, se seu valor é sequencial ou não situacao: type: string allOf: – #/definitions/enumInativoAtivo description: Situação máscara sequenciaFixa: type: string maxLength: 10 description: Valor da sequência fixa selecionavelPeloUsuario: type: string allOf: – #/definitions/enumSimNao description: Indicativo se permite informar/selecionar um valor 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 recPaginacaoLimit: description: Dados de paginação type: object required: – offset – limit properties: offset: type: integer format: int64 description: Número da página. limit: type: integer format: int64 description: Quantidade 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 recEmpresa: description: Empresa type: object required: – codigo – tipo properties: id: type: integer format: int64 description: Id da empresa codigo: type: string maxLength: 4 description: Código da empresa nome: type: string maxLength: 100 description: Nome fantasia da empresa tipo: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa recEmpresaComFiliais: description: Empresas type: object required: – id – codigo – nome – filiais properties: id: type: integer format: int64 description: Id da empresa codigo: type: string description: Código da empresa nome: type: string description: Nome fantasia da empresa filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Filiais recFilial: description: Filiais type: object required: – id – nome – codigo properties: id: type: integer format: int64 description: Id da filial nome: type: string description: Nome fantasia da filial codigo: type: string description: Código da filial 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 pessoa: description: Entidade mantém cadastro de empresa e filiais type: object required: – tipo – codigo – nome – fantasia – pessoaIdOrigem properties: id: type: integer format: int64 description: Identificados único tipo: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo da pessoa (Empresa/Filial) codigo: type: integer format: int64 description: Código da empresa/filial nome: type: string maxLength: 100 description: Nome da empresa/filial fantasia: type: string maxLength: 50 description: Nome fantasia da empresa/filial pessoaIdOrigem: type: object allOf: – #/definitions/pessoa description: Empresa origem usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: familia: description: Entidade família type: object required: – codigo – descricao – pessoa properties: id: type: integer format: int64 description: Identificados único codigo: type: string description: Código da família descricao: type: string description: Descrição da família pessoa: type: object allOf: – #/definitions/pessoa description: Empresa tipoReposicao: type: string allOf: – #/definitions/enumTipoReposicao description: Tipo de reposição controlaLote: type: boolean description: Indicativo se família controla lote controlaSerie: type: boolean description: Indicativo se família controla série mascara: type: array items: type: object allOf: – #/definitions/mascaraSkuFamilia description: Mascaras Sku usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: sku: description: Entidade de SKU type: object required: – codigo – empresa – descricao – tipoProduto – unidadeMedidaEstoque – situacao – familia properties: id: type: integer format: int64 description: Identificados único codigo: type: string maxLength: 23 description: Código do produto empresa: type: object allOf: – #/definitions/pessoa description: Empresa descricao: type: string maxLength: 100 description: Descrição do produto descricaoComplementar: type: string maxLength: 150 description: Descrição complementar do produto tipoProduto: type: integer format: int64 description: Tipo do produto unidadeMedidaEstoque: type: integer format: int64 description: Unidade de medida do estoque situacao: type: string maxLength: 1 description: Situação do produto familia: type: object allOf: – #/definitions/familia description: Família do produto ultimoLote: type: string maxLength: 50 description: Último lote ultimaSerie: type: string maxLength: 50 description: Última série usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: deposito: description: Entidade depósito type: object properties: id: type: integer format: int64 description: Identificados único usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: mascaraSku: description: Máscara de produto type: object required: – empresa – codigo – descricao – abreviatura – utilizaComponentes – tipoComposicao – situacao properties: id: type: string format: uuid description: Identificados único empresa: type: object allOf: – #/definitions/pessoa description: Empresa codigo: type: string maxLength: 8 description: Código da máscara de produtos descricao: type: string maxLength: 50 description: Descrição da máscara abreviatura: type: string maxLength: 20 description: Abreviatura da máscara quantidadePosicoes: type: integer format: int64 description: Quantidade de posições (algarismos ou caracteres) que podem compor a máscara minimum: 0 maximum: 14 utilizaComponentes: type: string allOf: – #/definitions/enumSimNao description: Indicativo se utiliza componentes tipoComposicao: type: string allOf: – #/definitions/enumTipoComposicao description: Tipo de composição da máscara 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 situacao: type: string allOf: – #/definitions/enumInativoAtivo description: Situação do registro sequenciaFixa: type: string maxLength: 10 description: Valor da sequência fixa usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: mascaraSkuComponente: description: Componentes de máscaras de produtos type: object required: – mascara – codigo – sequencia – descricao – abreviatura – situacao properties: id: type: string format: uuid description: Identificados único mascara: type: object allOf: – #/definitions/mascaraSku 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/enumInativoAtivo description: Situação do componente usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: mascaraSkuFamilia: description: Máscaras por família type: object required: – familia – sequencia – mascara properties: id: type: string format: uuid description: Identificados único familia: type: object allOf: – #/definitions/familia description: Id da família sequencia: type: integer format: int64 description: Sequência da máscara minimum: 0 maximum: 99 mascara: type: object allOf: – #/definitions/mascaraSku description: ID da máscara usuarioGeracao: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: 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

Este artigo foi útil para você?

Leave A Comment