Integração WMS e ERP (erp)

2.0info: 0.9.0 Integração WMS e ERP description: Serviço de integração WMS e ERP x-senior-domain: Integrações WMS-X x-senior-domain-path: wmsx_int x-senior-service-path: erp 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/wmsx_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /erp/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 /erp/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 /erp/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/actions/importOrderFromErp: post: description: Importa um Documento (Pedido de Venda) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do pedido no ERP orderNumber: type: string description: Número do Pedido responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/actions/createReceivingDocumentFromOrderProduction: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vendorCode – documentNumber – documentDate properties: vendorCode: type: string description: Código do Fornecedor Depositante documentNumber: type: string description: Número do Documento documentDate: type: string format: date description: Data Documento de Ordem produção items: type: array items: type: object allOf: – #/definitions/productItem description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/apis/erpx_receiving_confirmed: post: description: API confirmação de Recebimento mapeado para ERP X – WIP tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/receivingConfirmationPayload responses: 200: description: Ok schema: #/definitions/erpx_receiving_confirmedFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/apis/erpx_product_owner: post: description: API integração Produto ERP com Depositante tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/productOwnerFromErpx responses: 200: description: Ok schema: #/definitions/erpx_product_ownerFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/apis/erpxt_product: post: description: Importa produtos do ERP XT tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/erpxt_productFacade responses: 200: description: Ok schema: #/definitions/erpxt_productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/apis/erpxt_order_receiving: post: description: Importa um Documento (Pedido de Venda) do ERP XT tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recExportacaoOrdemRecebimento responses: 200: description: Ok schema: #/definitions/recExportacaoOrdemRecebimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/apis/erpxt_outbound_document: post: description: Importa um Documento de Saida do ERP XT tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recExportacaoOrdemSeparacao responses: 200: description: Ok schema: #/definitions/recExportacaoOrdemSeparacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/apis/erpxt_outbound_authorization: post: description: Importa um Documento de Saida do ERP XT tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recExportacaoFaturamento responses: 200: description: Ok schema: #/definitions/recExportacaoFaturamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/apis/erpxt_receiving_confirmed: post: description: Exporta uma confirmação de recebimento para o ERP XT tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/receivingConfirmationPayload responses: 200: description: Ok schema: #/definitions/receivingConfirmationPayload 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /erp/apis/erpxt_stock_movement_performed: post: description: Exporta um movimento de estoque para o ERP XT tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/exportStockOperationPayload responses: 200: description: Ok schema: #/definitions/exportStockOperationPayload 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumProductSituation: type: string enum: – GOOD – DAMAGED – EXPIRED – TRUNCATED description: Situação do Produto: * `GOOD` – Bom * `DAMAGED` – Danificado * `EXPIRED` – Vencido * `TRUNCATED` – Truncado enumStockOperationType: type: string enum: – ALLOCATION – RELOCATION – STOCK_ENTRY_CORRECTION – STOCK_OUT_CORRECTION – DISPATCH – SEPARATION – CKECKOUT – VOLUME – STOCK_OUT – INVENTORY – MATERIAL_STATE_CORRECTION – REVERSE_DISPATCH – REVERSE_ALLOCATION – CHARACTERISTICS_CHANGE – BATCH_BLOCK – BATCH_UNBLOCK description: Tipo de Operação de Estoque: * `ALLOCATION` – Alocação * `RELOCATION` – Remanejamento * `STOCK_ENTRY_CORRECTION` – Ajuste de Estoque de Entrada * `STOCK_OUT_CORRECTION` – Ajuste de Estoque de Saída * `DISPATCH` – Expedição * `SEPARATION` – Separação * `CKECKOUT` – Conferência Saída * `VOLUME` – Volume * `STOCK_OUT` – Baixa de Estoque * `INVENTORY` – Inventário * `MATERIAL_STATE_CORRECTION` – Ajuste de Estado de Material * `REVERSE_DISPATCH` – Estorno da Expedição * `REVERSE_ALLOCATION` – Estorno Alocação * `CHARACTERISTICS_CHANGE` – Alteração de características de lote * `BATCH_BLOCK` – Bloqueio de lote * `BATCH_UNBLOCK` – Desbloqueio de lote userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim productItem: description: type: object required: – productCode – quantity properties: productCode: type: string description: Código do Produto quantity: type: number format: double description: Quantidade Produzida recImportacaoProdutoXt: description: importação do cadastro de produto do ERP XT type: object properties: identificadorUnico: type: string description: identificador único codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial site: type: string description: site cnpjDepositante: type: string description: CNPJ Depositante codreferencia: type: string description: código referência codigoProduto: type: string description: Código do produto codigoDerivacao: type: string description: Código derivação codigoInterno: type: string description: Código interno descricaoComplementar: type: string description: Descrição complementar descricao: type: string description: Descrição descricaoDerivacao: type: string description: Descrição derivação tipoProduto: type: string description: Tipo de produto unidadeDeMedida: type: string description: Unidade de medida cnpjFamilia: type: string description: CNPJ do produtor codigoNcm: type: string description: Código NCM marca: type: string description: Marca codigoBarras: type: string description: Código de barras submarca: type: string description: Submarca familia: type: string description: Família ativo: type: string description: Ativo cor: type: string description: Cor subGrupo: type: string description: Sub grupo ativaControleDeDataDeValidade: type: boolean description: Ativa controle de data de validade manufaturado: type: string description: Manufatura ativaControleDeLote: type: boolean description: Ativa controle de lote sazonal: type: string description: Sazonal ativaSeparacaoUnitizadorCompleto: type: boolean description: Ativa separação unitizador completo segregado: type: string description: Segregado ativaSeparacaoDePickingDinamico: type: boolean description: Ativa separação de picking dinâmico prazoValidade: type: string format: date description: Prazo de validade ativaConferenciaDoProduto: type: boolean description: Ativa conferência do produto prazoComercializacao: type: string description: Prazo de comercialização importaRastro: type: boolean description: Importar Rastro prazoCritico: type: string description: Prazo critíco shelfLifeEstoque: type: integer format: int64 description: Shelf life de estoque subTipoProd: type: string description: Sub tipo de produto shelfLifeRecebimento: type: integer format: int64 description: Self life de recebimento subfamilia: type: string description: Subfamilia classeABC: type: string description: Classe ABC lastro: type: integer format: int64 description: Lastro camada: type: integer format: int64 description: Camada codigoTipoProduto: type: string description: Código interno do tipo de produto tipoDePeso: type: string description: Tipo de peso cest: type: string description: Código CEST grupo: type: string description: Grupo codigoProdutoAnvisa: type: string description: Código do produto anvisa precoMaximoConsumidor: type: number format: double description: Preço máximo consumidor unidadePadraoDeEstoque: type: string description: Unidade padrão de estoque codigoInmetro: type: string description: Código inmetro quantidadePadraoDeEstoque: type: number format: double description: Quantidade padrão de estoque motivoIsencao: type: string description: Motivo insenção kitExpExplodida: type: string description: Kit de expedição explodida agruparArmazenagemCmpKit: type: integer format: int64 description: Agrupar na armazenagem os componentes do kit customizados: type: array items: type: object allOf: – #/definitions/recImportacaoCustomizacaoXt description: Customizacao produto embalagem: type: array items: type: object allOf: – #/definitions/recImportacaoEmbalagemProdutoXt description: Embalagens do produto recImportacaoEmbalagemProdutoXt: description: Importação das embalagens do produto XT type: object properties: unidade: type: string description: Unidade codigoBarras: type: string description: Código de barras quantidade: type: number format: double description: Quantidade descrReduzido: type: string description: Descrição reduzida unidadeComprimento: type: string description: Unidade de comprimento descricao: type: string description: Descrição pesoBruto: type: number format: double description: Peso bruto apresentacao: type: string description: Apresentação unidadePeso: type: string description: Unidade de peso fatorConversao: type: number format: double description: Fator de conversão altura: type: number format: double description: Altura largura: type: number format: double description: Largura comprimento: type: number format: double description: Comprimento volume: type: number format: double description: Volume unidadeVenda: type: string description: Unidade de venda unidadeVolume: type: string description: Unidade do volume unidadeCompra: type: string description: Unidade de compra lastro: type: number format: double description: Quantidade de lastros quantidadeCamada: type: number format: double description: Quantidade em uma camada pesoLiquido: type: number format: double description: Peso liquído empilhamentoMaximo: type: number format: double description: Empilhamento Máximo ativo: type: string description: Ativo caixafechada: type: string description: Caixa fechada controlaEstoque: type: string description: Controla estoque sequenciaEmbalagem: type: string description: Sequencia embalagem descrReduzido2: type: string description: Descrição reduzida 2 codigoInterno: type: string description: Código interno codInterno: type: string description: Código interno inscricaoEstadualDepositante: type: string description: Inscrição estadual depositante customizados: type: array items: type: object allOf: – #/definitions/recImportacaoCustomizacaoXt description: Customizacao embalagem recImportacaoCustomizacaoXt: description: Importação de campos e valores customizados type: object properties: chave: type: string description: Chave valor: type: string description: Valor receivingConfirmationPayload: description: Payload da confirmação de recebimento type: object required: – orderReceivingId – orderReceivingNumber – ownerId – ownerCode – warehouseId – warehouseCode – registrationDate – receivedDate properties: orderReceivingId: type: string description: Id da Ordem de Recebimento orderReceivingNumber: type: integer format: int64 description: Número da Ordem de Recebimento ownerId: type: string description: Id do depositante ownerCode: type: string description: Código de Integração do depositante warehouseId: type: string description: Código do Armazém warehouseCode: type: string description: Código de Integração do Armazém registrationDate: type: string format: date-time description: Data que a ordem de recebimento foi cadastrada receivedDate: type: string format: date description: Data que a ordem de recebimento foi conferida carrierId: type: string description: ID da Transportadora carrierCode: type: string description: Código de Integração da Transportadora licensePlate: type: string description: Identificação do veículo utilizado na ordem de recebimento transportType: type: string description: Identificação do tipo de transporte (ROAD/ RAILWAY/ AIR) documents: type: array items: type: object allOf: – #/definitions/documentChecked description: Documentos da Order Recebimento productOwnerFromErpx: description: Importação Produto Depositante do Erpx type: object required: – codDer – desDer properties: codDer: type: string description: Codigo Produto desDer: type: string description: Descrição do Produto documentChecked: description: Documento Conferido type: object required: – documentNumber – vendorId – vendorCode properties: documentNumber: type: string description: Número do Documento expected: type: boolean description: Indica se é um documento previsto na ordem de recebimento default: true vendorId: type: string description: ID do Fornecedor vendorCode: type: string description: Código de Integração do Fornecedor documentSeries: type: string description: Serie da Nota accessKey: type: string description: Chave da Nota displayDescription: type: string maxLength: 255 description: Rótulo para exibição amigável do documento sourceDocumentType: type: string maxLength: 50 description: Classificação do tipo de documento conforme definido pelo sistema de origem externalId: type: string maxLength: 255 description: ID do sistema externo items: type: array items: type: object allOf: – #/definitions/itemChecked description: Items Checados itemChecked: description: type: object required: – productId – productCode – packagingBarCode – expectedQuantity – receivedQuantity properties: itemNumber: type: integer format: int64 description: Número do item externalId: type: string maxLength: 255 description: ID do item do documento no sistema externo productId: type: string description: ID do Produto productCode: type: string description: Código do Produto packagingBarCode: type: string description: Código da Embalagem uom: type: string description: Unidade de Medida expectedQuantity: type: number format: double description: Quantidade Esperada receivedQuantity: type: number format: double description: Quantidade Recebida details: type: array items: type: object allOf: – #/definitions/itemCheckedDetails description: Detalhamento dos items itemCheckedDetails: description: Item Conferido type: object required: – productSituation – quantity – grossWeight – netWeight – sectorId properties: productSituation: type: string description: Situação do Produto quantity: type: number format: double description: Quantidade grossWeight: type: number format: double description: Peso Bruto da embalagem em gramas multiplicado pela quantidade da linha netWeight: type: number format: double description: Peso Líquido da embalagem em gramas multiplicado pela quantidade da linha industryBatch: type: string description: Lote industria fabricationDate: type: string format: date description: Data de Fabricação expirationDate: type: string format: date description: Data de Vencimento sectorId: type: string description: ID do Setor sectorCode: type: string description: Código de integração do Setor recExportacaoOrdemRecebimento: description: Exportação da ordem de recebimento do ERP type: object properties: identificadorUnico: type: string description: Identificar único da tabela de ordem de recebimento codigoEmpresa: type: integer format: int64 description: Código empresa codigoFilial: type: integer format: int64 description: Código filial serieNotaFiscalEntrada: type: string description: Série da nota fiscal de entrada numeroDocumento: type: string description: Número do documento fiscal sequenciaDocumento: type: string description: Sequência do documento fiscal cfop: type: string description: CFOP descricaoCfop: type: string description: Descrição da CFOP tipoRecebimento: type: string description: Tipo de recebimento no WMS dataEmissao: type: string format: date description: Data de emissão tipoNf: type: string description: Tipo da Nota Fiscal unidadeFederacaoVeiculoTransporte: type: string description: Unidade da federação (Estado) do veículo de transporte placaVeiculoTransporte: type: string description: Placa do veículo de transporte valorFrete: type: number format: double description: Valor do frete tipoFrete: type: string description: Tipo do frete (CIF/FOB) quantidadeEmbalagens: type: integer format: int64 description: Quantidade de embalagens pesoLiquido: type: number format: double description: Peso líquido quantidadeItensProduto: type: integer format: int64 description: Quantidade de itens de produto chaveNotaEletronica: type: string description: Chave da nota fiscal eletrônica protocoloNfe: type: string description: Protocolo da nota fiscal eletrônica dataAutorizacaoSefaz: type: string description: Data recebimento autorização do sefaz valorSeguro: type: number format: double description: Valor do seguro valorPis: type: number format: double description: Valor do PIS valorCofins: type: number format: double description: Valor Cofins valorLiquidoProdutos: type: number format: double description: Valor líquido dos produtos valorLiquidoTotal: type: number format: double description: Valor líquido total valorBaseIcms: type: number format: double description: Valor base do Icms valorIcms: type: number format: double description: Valor do Icms valorBaseIcmsSubstituido: type: number format: double description: Valor base do Icms substituído valorIcmsSubstituido: type: number format: double description: Valor do Icms substituído valorIpi: type: number format: double description: Valor do Ipi valorIss: type: number format: double description: Valor do Iss valorLiquidoServicos: type: number format: double description: Valor líquido dos serviços cnpjFilialEmitente: type: string description: CNPJ da filial emitente nomeFilialEmitente: type: string description: Nome da filial emitente observacao: type: string description: Observacao dadosTransportadora: type: object allOf: – #/definitions/recDadosTransportadora description: Dados da transportadora dadosFilial: type: object allOf: – #/definitions/recDadosFilial description: Dados da filial, depositante no WMS dadosFornecedor: type: object allOf: – #/definitions/recDadosFornecedor description: Dados da fornecedor, emitente no WMS itens: type: array items: type: object allOf: – #/definitions/recExportacaoItemOrdemRecebimento description: Itens da ordem de recebimento recDadosTransportadora: description: Exportação dos dados da transportadora na ordem de separação do ERP type: object properties: nome: type: string description: Nome da transportadora cnpj: type: string description: CNPJ da transportadora endereco: type: string description: Endereço da transportadora codigoTransportadora: type: integer format: int64 description: Código da transportadora numero: type: string description: Número da transportadora bairro: type: string description: Bairro da transportadora cidade: type: string description: Cidade da transportadora estado: type: string description: Estado da transportadora cep: type: string description: CEP da transportadora inscricaoEstadual: type: string description: Inscrição estadual da transportadora recDadosFilial: description: Exportação dos dados da filial na ordem de recebimento do ERP type: object properties: pessoaDestinatario: type: string description: Tipo pessoa destinatário codigoDestinatario: type: string description: Código do destinatário nomeDestinatario: type: string description: Nome do destinatário fantasiaDestinatario: type: string description: Fantasia do destinatário cnpjDestinatario: type: string description: CNPJ do destinatário enderecoDestinatario: type: string description: Endereço do destinatário numeroDestinatario: type: string description: Número do destinatário complementoDestinatario: type: string description: Complemento do destinatário bairroDestinatario: type: string description: Bairro do destinatário cepDestinatario: type: string description: Cep do destinatário cidadeDestinatario: type: string description: Cidade do destinatário estadoDestinatario: type: string description: Estado do destinatário telefoneDestinatario: type: string description: Telefone do destinatário inscricaoEstatualDestinatario: type: string description: Inscrição estadual do destinatário recDadosFornecedor: description: Exportação dos dados da filial na ordem de recebimento do ERP type: object properties: pessoaEmitente: type: string description: Tipo pessoa emitente codigoEmitente: type: string description: Codigo emitente nomeEmitente: type: string description: Nome emitente fantasiaEmitente: type: string description: Fantasia emitente enderecoEmitente: type: string description: Endereço emitente numeroEmitente: type: string description: Número emitente cidadeEmitente: type: string description: Cidade emitente bairroEmitente: type: string description: Bairro emitente estadoEmitente: type: string description: Estado emitente cepEmitente: type: string description: Cep emitente cnpjEmitente: type: string description: CNPJ emitente complementoEmitente: type: string description: Complemento emitente telefoneEmitente: type: string description: Telefone do emitente inscricaoEstadualEmitente: type: string description: Inscrição estadual emitente recExportacaoItemOrdemRecebimento: description: Exportação do item da ordem de recebimento do ERP type: object properties: sequenciaItem: type: integer format: int64 description: Sequência do item codigoProduto: type: string description: Código do produto descricaoProduto: type: string description: Descrição do produto codigoBarrasLivre: type: string description: Código de barras livre codigoDerivacao: type: string description: Codigo da derivação quantidade: type: number format: double description: Quantidade do item unidadeMedida: type: string description: Unidade de medida deposito: type: string description: Código do depósito precoUnitario: type: number format: double description: Preço unitário valorTotal: type: number format: double description: Valor total do item valorLiquido: type: number format: double description: Valor líquido do item percentualIcms: type: number format: double description: Percentual do Icms valorIcms: type: number format: double description: Valor do Icms percentualIpi: type: number format: double description: Percentual do Ipi valorIpi: type: number format: double description: Valor do Ipi percentualDesconto: type: number format: double description: Percentual de desconto valorDesconto: type: number format: double description: Valor do desconto codigoBloqueio: type: string description: Código bloqueio motivoBloqueio: type: string description: Motivo bloqueio observacao: type: string description: Observacao lotes: type: array items: type: object allOf: – #/definitions/recLote description: Lote series: type: array items: type: object allOf: – #/definitions/recSerie description: Série recLote: description: Lote do item de produto da separação type: object properties: codigoLote: type: string description: Código do lote quantidade: type: number format: double description: Quantidade do lote dataValidade: type: string format: date description: Data de validade dataFabricacao: type: string format: date description: Data de fabricação recSerie: description: Série do item de produto da separação type: object properties: numeroSerie: type: string description: Número da série quantidade: type: number format: double description: Quantidade da série dataFabricacao: type: string format: date description: Data de fabricação dataValidade: type: string format: date description: Data de validade recAtualizacaoOrdemRecebimento: description: Atualização da ordem de recebimento type: object properties: bloqueioLote: type: boolean description: Mantém movimentos de bloqueio do lote itensAtualizacao: type: array items: type: object allOf: – #/definitions/recAtualizacaoItem description: Itens do recebimento movimentos: type: array items: type: object allOf: – #/definitions/recMovimentoItem description: Movimentos do recebimento recAtualizacaoItem: description: Atualização de itens da ordem de recebimento type: object properties: identificador: type: string description: Identificador único do item codigoProduto: type: string description: Código do produto codigoDerivacao: type: string description: Código da derivação quantidadeConferida: type: number format: double description: Quantidade conferida estadoProduto: type: string description: Estado do produto Normal/Danificado deposito: type: string description: Depósito lotes: type: array items: type: object allOf: – #/definitions/recLote description: Lotes series: type: array items: type: object allOf: – #/definitions/recSerie description: Séries sequencia: type: integer format: int64 description: Sequência recMovimentoItem: description: Exportação de movimento da ordem de recebimento do ERP type: object properties: codigoProduto: type: string description: Código do produto codigoDerivacao: type: string description: Código da derivação quantidadeBloqueada: type: integer format: int64 description: Quantidade bloqueada lote: type: string description: Lote serial: type: string description: Serial motivoBloqueio: type: string description: Motivo do bloqueio codigoMotivo: type: string description: Código motivo exportErpXt: description: Exportação dados para o ERP XT type: object required: – layoutKey – processId – data properties: integrationId: type: string description: Id do evento layoutKey: type: string description: Nome do hub que gerou o evento processId: type: string description: id do processo no wmsx data: type: string format: byte description: dados do processo no Wmsx recExportacaoOrdemSeparacao: description: Exportação da ordem de separação do ERP type: object properties: identificadorUnico: type: string description: Identificar único da tabela de ordem de separação codigoEmpresa: type: integer format: int64 description: Código empresa codigoFilial: type: integer format: int64 description: Código filial codigoPessoa: type: integer format: int64 description: Código pessoa serieNotaFiscalSaida: type: string description: Série da nota fiscal de saída numeroDocumento: type: string description: Número do documento fiscal sequenciaDocumento: type: string description: Sequência do documento fiscal cfop: type: string description: CFOP descricaoCfop: type: string description: Descrição da CFOP tipoSeparacao: type: string description: Tipo da separação no WMS dataEmissao: type: string format: date description: Data de emissão tipoNf: type: string description: Tipo da Nota Fiscal numItens: type: integer format: int64 description: Número de itens da ordem de separação dataPrevisaoEntrega: type: string format: date description: Data previsão de entrega unidadeFederacaoVeiculoTransporte: type: string description: Unidade da federação (Estado) do veículo de transporte placaVeiculoTransporte: type: string description: Placa do veículo de transporte valorFrete: type: number format: double description: Valor do frete tipoFrete: type: string description: Tipo do frete (CIF/FOB) quantidadeEmbalagens: type: integer format: int64 description: Quantidade de embalagens pesoLiquido: type: number format: double description: Peso líquido quantidadeItensProduto: type: integer format: int64 description: Quantidade de itens de produto pedidoCliente: type: string description: Número do pedido do cliente chaveNotaEletronica: type: string description: Chave da nota fiscal eletrônica protocoloNfe: type: string description: Protocolo da nota fiscal eletrônica dataAutorizacaoSefaz: type: string description: Data recebimento autorização do sefaz valorSeguro: type: number format: double description: Valor do seguro valorPis: type: number format: double description: Valor do PIS valorCofins: type: number format: double description: Valor Cofins valorLiquidoProdutos: type: number format: double description: Valor líquido dos produtos valorLiquidoTotal: type: number format: double description: Valor líquido total valorBaseIcms: type: number format: double description: Valor base do Icms valorIcms: type: number format: double description: Valor do Icms valorBaseIcmsSubstituido: type: number format: double description: Valor base do Icms substituído valorIcmsSubstituido: type: number format: double description: Valor do Icms substituído valorIpi: type: number format: double description: Valor do Ipi valorIss: type: number format: double description: Valor do Iss valorLiquidoServicos: type: number format: double description: Valor líquido dos serviços observacao: type: string description: Observação da ordem de separacao observacaoPersonalizacao: type: string description: Observação da perzonalização da ordem de separação utilizaZpl: type: integer format: int64 description: Indicativo da utilização da etiqueta ZPL tipoConsistenciaZpl: type: integer format: int64 description: Indica o tipo de consistência que será feita nas informações referetens a etiqueta ZPL codigoRastreio: type: string description: Código de rastreio codigoServicoExterno: type: string description: Código da prestadora de serviço externo para impressão de etiqueta codigoServicoTransportadora: type: string description: Código do serviço da transportadora tipoPrioridade: type: string description: Tipo de prioridade cnpjFilialEmitente: type: string description: CNPJ da filial emitente nomeFilialEmitente: type: string description: Nome da filial emitente subPedido: type: integer format: int64 description: Sub pedido indicativoProducao: type: string description: Indicativo de produção interno/externo dadosTransportadora: type: object allOf: – #/definitions/recDadosTransportadora description: Dados da transportadora dadosTransportadoraRedespacho: type: object allOf: – #/definitions/recDadosTransportadora description: Dados da transportadora de redespacho dadosCliente: type: object allOf: – #/definitions/recDadosCliente description: Dados do cliente itens: type: array items: type: object allOf: – #/definitions/recExportacaoItemOrdemSeparacao description: Itens da ordem de separação customizados: type: array items: type: object allOf: – #/definitions/recExportacaoCustomizacaoOrdemSeparacao description: Dados customizados da ordem de separação redespacho: type: string description: CNPJ transportadora de redespacho recDadosCliente: description: Exportação dos dados do cliente na ordem de separação do ERP type: object properties: pessoaDestinatario: type: string description: Tipo pessoa destinatário codigoDestinatario: type: string description: Código do destinatário nomeDestinatario: type: string description: Nome do destinatário fantasiaDestinatario: type: string description: Fantasia do destinatário cnpjDestinatario: type: string description: CNPJ do destinatário enderecoDestinatario: type: string description: Endereço do destinatário numeroDestinatario: type: string description: Número do destinatário complementoDestinatario: type: string description: Complemento do destinatário bairroDestinatario: type: string description: Bairro do destinatário cepDestinatario: type: string description: Cep do destinatário cidadeDestinatario: type: string description: Cidade do destinatário estadoDestinatario: type: string description: Estado do destinatário telefoneDestinatario: type: string description: Telefone do destinatário telefone2: type: string description: Segundo telefone do destinatário inscricaoEstatualDestinatario: type: string description: Inscrição estadual do destinatário pessoaEntrega: type: string description: Tipo pessoa entrega nomeEntrega: type: string description: Nome entrega fantasiaEntrega: type: string description: Fantasia entrega enderecoEntrega: type: string description: Endereço entrega numeroEntrega: type: string description: Número entrega cidadeEntrega: type: string description: Cidade entrega bairroEntrega: type: string description: Bairro entrega estadoEntrega: type: string description: Estado entrega cepEntrega: type: string description: Cep entrega cnpjEntrega: type: string description: CNPJ entrega complementoEntrega: type: string description: Complemento entrega inscricaoEstadualEntrega: type: string description: Inscrição estadual entrega recExportacaoItemOrdemSeparacao: description: Exportação do item da ordem de separação do ERP type: object properties: sequenciaItem: type: integer format: int64 description: Sequência do item sequenciaItemSuperior: type: integer format: int64 description: Sequência do item pai/superior codigoProduto: type: string description: Código do produto descricaoProduto: type: string description: Descrição do produto codigoBarrasLivre: type: string description: Código de barras livre codigoDerivacao: type: string description: Codigo da derivação quantidade: type: number format: double description: Quantidade do item unidadeMedida: type: string description: Unidade de medida deposito: type: string description: Código do depósito observacao: type: string description: Observação do item de produto observacaoItemPersonalizacao: type: string description: Observação da perzonalização do item da ordem de separação precoUnitario: type: number format: double description: Preço unitário valorTotal: type: number format: double description: Valor total do item valorLiquido: type: number format: double description: Valor líquido do item percentualIcms: type: number format: double description: Percentual do Icms valorIcms: type: number format: double description: Valor do Icms percentualIpi: type: number format: double description: Percentual do Ipi valorIpi: type: number format: double description: Valor do Ipi percentualDesconto: type: number format: double description: Percentual de desconto valorDesconto: type: number format: double description: Valor do desconto codigoBloqueio: type: string description: Código bloqueio motivoBloqueio: type: string description: Motivo bloqueio lotes: type: array items: type: object allOf: – #/definitions/recLote description: Lotes do item de separação series: type: array items: type: object allOf: – #/definitions/recSerie description: Séries do item de separação customizados: type: array items: type: object allOf: – #/definitions/recExportacaoCustomizacaoOrdemSeparacao description: Dados customizados do item da ordem de separação recExportacaoCustomizacaoOrdemSeparacao: description: Exportação das informações de customização dos documentos de ordem de separação do ERP type: object properties: chave: type: string description: Nome da chave do valor customizado valor: type: string description: Valor personalizado recExportacaoFaturamento: description: type: object properties: identificadorUnico: type: string description: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: codigoPessoa: type: integer format: int64 description: serieNotaFiscalSaida: type: string description: numeroDocumento: type: string description: sequenciaDocumento: type: string description: cfop: type: string description: descricaoCfop: type: string description: tipoSeparacao: type: string description: dataEmissao: type: string format: date description: unidadeFederacaoVeiculoTransporte: type: string description: placaVeiculoTransporte: type: string description: valorFrete: type: number format: double description: tipoFrete: type: string description: quantidadeEmbalagens: type: integer format: int64 description: pesoLiquido: type: number format: double description: quantidadeItensProduto: type: integer format: int64 description: pedidoCliente: type: string description: chaveNotaEletronica: type: string description: protocoloNfe: type: string description: dataAutorizacaoSefaz: type: string description: utilizaZpl: type: integer format: int64 description: tipoConsistenciaZpl: type: integer format: int64 description: codigoRastreio: type: string description: codigoServicoExterno: type: string description: codigoServicoTransportadora: type: string description: tipoPrioridade: type: string description: valorSeguro: type: number format: double description: valorPis: type: number format: double description: valorCofins: type: number format: double description: valorLiquidoProdutos: type: number format: double description: valorLiquidoTotal: type: number format: double description: valorBaseIcms: type: number format: double description: valorIcms: type: number format: double description: valorBaseIcmsSubstituido: type: number format: double description: valorIcmsSubstituido: type: number format: double description: valorIpi: type: number format: double description: valorIss: type: number format: double description: valorLiquidoServicos: type: number format: double description: observacao: type: string description: cnpjDestinatario: type: string description: cnpjFilialEmitente: type: string description: nomeFilialEmitente: type: string description: subPedido: type: integer format: int64 description: dadosTransportadora: type: object allOf: – #/definitions/recDadosTransportadora description: dadosTransportadoraRedespacho: type: object allOf: – #/definitions/recDadosTransportadora description: itens: type: array items: type: object allOf: – #/definitions/recExportacaoItemFaturamento description: recExportacaoItemFaturamento: description: type: object properties: sequenciaItem: type: integer format: int64 description: sequenciaItemSuperior: type: integer format: int64 description: codigoProduto: type: string description: descricaoProduto: type: string description: codigoBarrasLivre: type: string description: codigoDerivacao: type: string description: quantidade: type: number format: double description: unidadeMedida: type: string description: deposito: type: string description: observacao: type: string description: precoUnitario: type: number format: double description: valorTotal: type: number format: double description: valorLiquido: type: number format: double description: percentualIcms: type: number format: double description: valorIcms: type: number format: double description: percentualIpi: type: number format: double description: valorIpi: type: number format: double description: percentualDesconto: type: number format: double description: valorDesconto: type: number format: double description: lotes: type: array items: type: object allOf: – #/definitions/recLote description: series: type: array items: type: object allOf: – #/definitions/recSerie description: exportStockOperationPayload: description: Payload da exportação de movimentação de estoque type: object required: – ownerCode – warehouseCode – operationType – productCode – productDescription – packagingCode – packagingShortDescription – conversionFactor – quantity – fromProductSituation – toProductSituation properties: ownerCode: type: string description: Código do Depositante detentor do estoque warehouseCode: type: string description: Código do Armazém operationType: type: string allOf: – #/definitions/enumStockOperationType description: Tipo de Operação operationCode: type: string description: Identificador da operação reasonOccurrenceCode: type: string description: Código do Motivo de Ocorrência reasonOccurrenceDescription: type: string description: Motivo de Ocorrência productCode: type: string description: Código do Produto productDescription: type: string description: Produto packagingCode: type: string description: Código de Barras packagingShortDescription: type: string description: Descrição Reduzida da Embalagem conversionFactor: type: number format: double description: Fator de Conversão da Embalagem quantity: type: number format: double description: Quantidade unitária fromProductSituation: type: string allOf: – #/definitions/enumProductSituation description: Estado do material antes toProductSituation: type: string allOf: – #/definitions/enumProductSituation description: Estado do material fromCodeSector: type: string description: Código de integração do setor do estoque de origem toCodeSector: type: string description: Código de integração do setor de Destino fromFabricationDate: type: string format: date description: Data de Fabricação Antes toFabricationDate: type: string format: date description: Data de Fabricação Depois fromShelfLife: type: string format: date description: Data de Vencimento Antes toShelfLife: type: string format: date description: Data de Vencimento Depois fromIndustrialBatch: type: string description: Lote Indústria Antes toIndustrialBatch: type: string description: Lote Indústria Depois batchBlockingReason: type: string description: Motivo Bloqueio de Lote 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status erpx_receiving_confirmedFacadeOutput: description: API confirmação de Recebimento mapeado para ERP X – WIP type: object required: – id properties: id: type: string description: ID ticket de retorno erpx_product_ownerFacadeOutput: description: API integração Produto ERP com Depositante type: object required: – id properties: id: type: string description: ID ticket de retorno erpxt_productFacade: description: Importa produtos do ERP XT type: object properties: identificadorUnico: type: string description: Identificador único tipoDocumento: type: integer format: int64 description: Tipo de documento integração ISL chaveDocumento: type: string description: Chave do documento produto: type: array items: type: object allOf: – #/definitions/recImportacaoProdutoXt description: Produtos genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage