2.0info: 0.1.1 ig5_movestoque x-senior-domain: erp_est x-senior-domain-path: erp_est x-senior-service-path: ig5_movestoque 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: /ig5_movestoque/queries/buscarEstoque: post: description: Buscar estoque disponível tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro properties: filtro: type: array items: type: object allOf: – #/definitions/recFiltroEstoque minimum: 1 description: paginacao: type: object allOf: – #/definitions/recPaginacao description: Dados de paginação responses: 200: description: Ok schema: type: object required: – dadosEstoque properties: dadosEstoque: type: array items: type: object allOf: – #/definitions/recDadosEstoque minimum: 1 description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Retorno de paginação default: description: Error response schema: #/definitions/genericError get: description: Buscar estoque disponível tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filtro in: query required: true type: array items: type: object allOf: – #/definitions/recFiltroEstoque minimum: 1 – name: paginacao in: query type: object allOf: – #/definitions/recPaginacao responses: 200: description: Ok schema: type: object required: – dadosEstoque properties: dadosEstoque: type: array items: type: object allOf: – #/definitions/recDadosEstoque minimum: 1 description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: Retorno de paginação default: description: Error response schema: #/definitions/genericError /ig5_movestoque/queries/buscarSaldoEstoqueRetroativo: post: description: Buscar saldo de estoque em data retroativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro properties: filtro: type: array items: type: object allOf: – #/definitions/recFiltroBuscarSaldoEstoqueRetroativo minimum: 1 description: Filtro dos parâmetros para busca do saldo responses: 200: description: Ok schema: type: object required: – dadosEstoque properties: dadosEstoque: type: array items: type: object allOf: – #/definitions/recSaldoEstoqueRetroativo minimum: 1 description: Dados de resposta da busca default: description: Error response schema: #/definitions/genericError get: description: Buscar saldo de estoque em data retroativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filtro in: query required: true type: array items: type: object allOf: – #/definitions/recFiltroBuscarSaldoEstoqueRetroativo minimum: 1 responses: 200: description: Ok schema: type: object required: – dadosEstoque properties: dadosEstoque: type: array items: type: object allOf: – #/definitions/recSaldoEstoqueRetroativo minimum: 1 description: Dados de resposta da busca default: description: Error response schema: #/definitions/genericError /ig5_movestoque/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_movestoque/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_movestoque/actions/movimentarEstoque: post: description: Movimentar documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial – tipoMovimento – tipoDocumento – observacao – origem – skus properties: codigoEmpresa: type: integer format: int64 description: Código da empresa, onde será movimentado o estoque codigoFilial: type: integer format: int64 description: Código da filial, onde será movimentado o estoque, conforme empresa informada tipoMovimento: type: string allOf: – #/definitions/enumTipoMovimentoDocumento description: Tipo do movimento do documento, entrada ou saída tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do movimento do documento, Produto ou Reserva numeroDocumentoMovimento: type: integer format: int64 description: Número do documento que será registrado da tabela de movimento da G5 observacao: type: string maxLength: 250 description: Observação para o documento codigoDocumento: type: string maxLength: 32 description: Código do documento movimentado origem: type: string maxLength: 50 description: Origem do movimento de estoque skus: type: array items: type: object allOf: – #/definitions/recSKUMovimentoEstoque minimum: 1 description: SKUs e suas respectivas quantidades que serão movimentadas codigoUsuario: type: string description: Usuario responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ig5_movestoque/actions/gerarSequenciaMascara: post: description: Gerar sequência para mascara do produto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigosMascaras properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigosMascaras: type: array items: type: string minimum: 1 description: Códigos de mascaras responses: 200: description: Ok schema: type: object required: – mascaras properties: mascaras: type: array items: type: object allOf: – #/definitions/recMascara minimum: 1 description: Retorno dos códigos de mascaras gerados default: description: Error response schema: #/definitions/genericError definitions: enumTipoMovimentoDocumento: description: Tipos de movimentações de estoque permitidas type: string enum: – Entrada – Saida enumTipoDocumento: description: tipos de documentos permitidos type: string enum: – Produto – Reserva 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 recSKUMovimentoEstoque: description: SKUs que serão movimentados type: object required: – codigoSKU – quantidade properties: codigoSKU: type: string maxLength: 23 description: Sku que está sendo movimentado quantidade: type: number format: double description: Quantidade movimentada do SKU codigoDepositos: type: array items: type: string description: Opcional – Código do depósito(quando não informado irá considerar o depósito padrão) documentoReservas: type: array items: type: object allOf: – #/definitions/recDocumentoReserva description: Documentos de reservar que serão considerados no momento da baixa quantMovimentada: type: array items: type: object allOf: – #/definitions/recQuantidadeMovimentada description: Quantidades movimentadas de lote e série recFiltroEstoque: description: Tipos de movimentações de estoque permitidas type: object required: – codigoEmpresa – codigoSKU properties: codigoEmpresa: type: integer format: int64 description: Código da empresa, onde será movimentado o estoque codigoFilial: type: integer format: int64 description: Opcional – Código da filial, onde será movimentado o estoque, conforme empresa informada deposito: type: string maxLength: 10 description: Opcional – Código do depósito codigoSKU: type: string maxLength: 23 description: Código do SKU lote: type: string maxLength: 50 description: Código do lote serie: type: string maxLength: 50 description: Número da série recDocumentoReserva: description: Documentos de reservar de estoque type: object required: – origem – codigo properties: origem: type: string maxLength: 50 description: origem do documento codigo: type: string maxLength: 32 description: código do documento recPaginacao: description: Registro de dados de paginação type: object required: – pagina – quantidadeRegistrosPagina properties: pagina: type: integer format: int64 description: Número da página sendo requisitada (inicia em 1) quantidadeRegistrosPagina: type: integer format: int64 description: Quantidade de registros a serem retornados por página (no mínimo 1) recPaginacaoRetorno: description: Registro de dados de retorno sobre a paginação type: object required: – pagina – quantidadeRegistrosPagina – quantidadeRegistrosEncontrados properties: pagina: type: integer format: int64 description: Página sendo retornada quantidadeRegistrosPagina: type: integer format: int64 description: Quantidade de registros requisitados por página quantidadeRegistrosEncontrados: type: integer format: int64 description: Quantidade de registros encontrados ao total recLoteSerie: description: Registros do tipo lote ou série type: object required: – numeroSerie – numeroLote – sequencia – qtdBloqueadoManualmente – qtdEstocagem – qtdFisicaDeposito – qtdPendente – qtdReservaExclusiva – qtdReservadoEmpenho – qtdDisponivelFaturamento – dataValidade properties: numeroSerie: type: string maxLength: 50 description: Número de série numeroLote: type: string maxLength: 50 description: Número do lote sequencia: type: integer format: int64 description: Seqüência de entrada do registro maximum: 9999 qtdBloqueadoManualmente: type: number format: double description: Quantidade de estoque bloqueado manualmente qtdEstocagem: type: number format: double description: Quantidade em embalagens de estocagem do produto qtdFisicaDeposito: type: number format: double description: Quantidade física total do estoque no depósito qtdPendente: type: number format: double description: Quantidade pendente em ordens de produção ou compra qtdReservaExclusiva: type: number format: double description: Quantidade de reserva exclusiva do estoque qtdReservadoEmpenho: type: number format: double description: Quantidade do estoque reservado (empenho) qtdDisponivelFaturamento: type: number format: double description: Quantidade de estoque disponível para faturamento dataValidade: type: string format: date description: Data de validade recDadosEstoque: description: Tipos de movimentações de estoque permitidas type: object required: – codigoEmpresa – codigoFilial – deposito – codigoSKU – qtdBloqueadoManualmente – qtdConsignadaClientes – qtdConsumoMedio – qtdConsignadaFornecedores – qtdEstocagem – qtdFisicaDeposito – qtdPendente – qtdReservaExclusiva – qtdReservadoEmpenho – qtdDisponivelFaturamento – aceitaEstoqueNegativo – lotesSerie properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial deposito: type: string maxLength: 10 description: Número do depósito codigoSKU: type: string maxLength: 23 description: Código do SKU qtdBloqueadoManualmente: type: number format: double description: Quantidade de estoque bloqueado manualmente qtdConsignadaClientes: type: number format: double description: Quantidade consiguinada para clientes qtdConsumoMedio: type: number format: double description: Quantidade de consumo médio qtdConsignadaFornecedores: type: number format: double description: Quantidade consiguinada de fornecedores qtdEstocagem: type: number format: double description: Quantidade em embalagens de estocagem do produto qtdFisicaDeposito: type: number format: double description: Quantidade física total do estoque no depósito qtdPendente: type: number format: double description: Quantidade pendente em ordens de produção ou compra qtdReservaExclusiva: type: number format: double description: Quantidade de reserva exclusiva do estoque qtdReservadoEmpenho: type: number format: double description: Quantidade do estoque reservado (empenho) qtdDisponivelFaturamento: type: number format: double description: Quantidade de estoque disponível para faturamento aceitaEstoqueNegativo: type: boolean description: Indicativo se o estoque aceita saldo de estoque negativo lotesSerie: type: array items: type: object allOf: – #/definitions/recLoteSerie minimum: 1 description: Lista de lote ou série recMascara: description: Código de mascaras gerados type: object required: – codigoMascara – sequencia properties: codigoMascara: type: string description: Código da mascaras sequencia: type: integer format: int64 description: Sequência da mascara gerada recQuantidadeMovimentada: description: Quantidade de registros movimentados type: object required: – quantidade properties: quantidade: type: number format: double description: Quantidade movimentada numeroSerie: type: string maxLength: 50 description: Número de série numeroLote: type: string maxLength: 50 description: Número do lote recFiltroBuscarSaldoEstoqueRetroativo: description: Contém parâmetros para buscar saldo de estoque de produtos em data retroativa type: object required: – codigoEmpresa – codigoDeposito – sku – data properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoDeposito: type: string maxLength: 10 description: Código do depósito sku: type: string maxLength: 23 description: SKU data: type: string format: date description: Data para obtenção do saldo de estoque recSaldoEstoqueRetroativo: description: Resposta para busca de saldo de estoque em data retroativa type: object required: – codigoEmpresa – codigoDeposito – sku – data – qtdFisicaDeposito properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoDeposito: type: string maxLength: 10 description: Número do depósito sku: type: string maxLength: 23 description: SKU data: type: string format: date description: Data para obtenção do saldo de estoque qtdFisicaDeposito: type: number format: double description: Quantidade física total do estoque no depósito 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