2.0info: 5.3.12 int_integrador description: Serviço de integração da silt x-senior-domain: erp_isl x-senior-domain-path: erp_isl x-senior-service-path: int_integrador contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_islsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /int_integrador/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade 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 properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/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 /int_integrador/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 /int_integrador/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/actions/ajustarProdutos: post: description: Ajusta produto de para tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: quantidadeAjustados: type: integer format: int64 description: Retorna quantidade de registros ajustados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/actions/resetarSobrefalha: post: description: Tira sobrefalha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: quantidadePendencias: type: integer format: int64 description: Quantidade de pendências resetadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/actions/adjustStatusEventIntegration: post: description: Ajustar situação de integração do evento ERP e WMS tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idIntegracao – situacaoIntegracao – logIntegracao – sistemaIntegracao properties: idIntegracao: type: array items: type: string minimum: 1 description: ID de integração situacaoIntegracao: type: integer format: int64 description: Nova situação de integração logIntegracao: type: string description: Novo log status integracao sistemaIntegracao: type: string description: Sistema podendo ser ERP ou WMS responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/actions/forcarFalhaPendencia: post: description: Forçar falha em uma pendência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: UUID da pendencia responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/actions/apagarRegistroInitialLoadControl: post: description: Apagar initialLoadControl para nova carga de uma tabela expecífica tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: UUID da pendencia responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/actions/ajustarNotasEntrada: post: description: Ajustar notas de entrada que atualizaram e geraram movimento de bloqueio para depósito que não integra com WMS tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: numeroNotaEntrada: type: integer format: int64 description: Número de uma nota fiscal de entrada responses: 200: description: Ok schema: type: object properties: quantidadeNotasAjustadas: type: integer format: int64 description: Retorna quantidade de notas ajustadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/actions/reprocessarEnvioDocumentosErpParaWMS: post: description: Reprocessar o envio de documentos (NF entrada, NF saída e pedido de venda) para o WMS tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tipoDocumento: type: string allOf: – #/definitions/recTipoDocumento description: Tipos de documentos (NF entrada, NF saída e pedido de venda) empresa: type: integer format: int64 description: Código da empresa filial: type: integer format: int64 description: Código da filial numero: type: array items: type: integer format: int64 description: Número do documento serie: type: string description: Série do documento fornecedor: type: integer format: int64 description: Código do fornecedor responses: 200: description: Ok schema: type: object properties: retorno: type: string description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarEventosIntegracaoOrdemRecebimento: post: description: Processar os eventos de integração da Ordem de Recebimento tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoOrdemRecebimento: post: description: Replica os eventos de integração da Ordem de Recebimento para o WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoCadastroProduto: post: description: Replica os eventos de integração de cadastro de produto tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoCadastroCliente: post: description: Replica os eventos de integração de cadastro de cliente tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoCadastroFornecedor: post: description: Replica os eventos de integração de cadastro de fornecedor tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoCadastroTransportadora: post: description: Replica os eventos de integração de cadastro de transportadora tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoOrdemSeparacao: post: description: Replica os eventos de integração de ordem de separação para o WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoFaturamento: post: description: Replica os eventos de integração de faturamento para o WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoRefaturamento: post: description: Replica os eventos de integração de refaturamento para o WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoCancelamento: post: description: Replica os eventos de integração de cancelamento para o WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: abrirSinaleiro: type: string description: Abrir o semaforo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/removerEventosIntegracaoNotaFiscalEntradaConcluidos: post: description: Remover os eventos de integração de nota fiscal de entrada que estão concluídos tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/replicarParaWmsEventosIntegracaoFaturamentoServico: post: description: Replica os eventos de integração da faturamento serviço para o WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarOrdemRecebimento: post: description: Importar ordem de recebimento tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idOrdemRecebimento: type: string description: Identificador da ordem de recebimento tipoDocumentoIntegracao: type: integer format: int64 description: Tipo de documento integração ordemRecebimento: type: object allOf: – #/definitions/recExportacaoOrdemRecebimento description: Notas Fiscais de entrada responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarOrdemRecebimento: post: description: Processar ordem de recebimento tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/confirmacaoRecebimentoNotaFiscal: post: description: Confirmação recebimento nota fiscal tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idIntegracao: type: string description: Identificador único da tabela de ordem de recebimento site: type: string description: Descricao do lugar de entrega numeroDoRecebimento: type: string description: Numero do recebimento controller: type: string description: Controller que retorna as informações responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarRetornoOrdemSeparacao: post: description: Processar retorno da ordem de separação tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/confirmarRetornoOrdemRecebimento: post: description: Confirmar retorno da ordem de recebimento tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de recebimento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarOrdemSeparacao: post: description: Reenvio da ordem de separação tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de separação do ERP responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarFaturamento: post: description: Reenvio do faturamento da ordem de separação tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de separação faturada do ERP responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarOrdemSeparacaoWms: post: description: Reenvio da ordem de separação do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de separação do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarCancelamento: post: description: Reenvio do cancelamento do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de separação do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarRefaturamento: post: description: Reenvio do refaturamento do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de separação do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarCancelamentoWMS: post: description: Reenvio do cancelamento do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de separação do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarOrdemRecebimento: post: description: Reenvio da ordem de recebimento tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de recebimento do ERP responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarOrdemRecebimentoWMS: post: description: Reenvio da ordem de recebimento do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de recebimento do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarMovimentoEstoqueWMS: post: description: Reenvio do movimento de estoque do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id do movimento de estoque do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarAjusteInventarioWMS: post: description: Reenvio do ajuste de inventário do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id do ajuste de inventário do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarConfirmacaoCancelamentoWMS: post: description: Reenvio da confirmação cancelamento do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da ordem de separação do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarCadastroCliente: post: description: Reenvio do cadastro de cliente tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id do cadastro de cliente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarCadastroProduto: post: description: Reenvio do cadastro de produto tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id do cadastro de produto responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarCadastroTransportadora: post: description: Reenvio do cadastro de transportadora tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id do cadastro de transportadora responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarCadastroFornecedor: post: description: Reenvio do cadastro de fornecedor tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id do cadastro de fornecedor responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarFaturamentoServicoWms: post: description: Reenvio de faturamento de serviço do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id do faturamento do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarFaturamentoServico: post: description: Contrato para reenviar o faturamento para o SeniorX tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: Id do faturamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/moverParaHistoricoEventoIntegracaoOrdemRecebimento: post: description: Mover para histórico o evento de integracao da ordem de recebimento tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/removerHistoricoEventoIntegracaoOrdemRecebimento: post: description: Remover histórico do evento de integracao da Ordem de Recebimento tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarMovimentoSilt: post: description: Processa um movimento gerado no Silt tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: chavelayout: type: string description: Indicação do tipo do movimento list: type: array items: type: object allOf: – #/definitions/recDadosMovimentoSilt description: Dados dos movimentos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarAjusteInventario: post: description: Importa um ajuste de inventário tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: chavelayout: type: string description: Chave layout para definir integração inventarioLote: type: array items: type: object allOf: – #/definitions/recDadosAjusteInventario description: Dados dos movimentos site: type: string description: site cnpjFilial: type: string description: CNPJ da filial/depositante numeroDaTransacao: type: integer format: int64 description: Número da transação idIntegracao: type: string description: Id gerado pelo WMS idInventario: type: string description: Id do inventário tipoInventario: type: string description: Tipo do inventário Cíclico/Rotativo – C; Estático/Geral – E codigoDepositante: type: string description: Código do depositante codigoProduto: type: string description: Código do produto quantidadeAjustada: type: number format: double description: Quantidade inventariada lote: type: string description: Lote do produto tipoDeAjuste: type: string description: Tipo de ajuste P (ajuste positivo) N (ajuste negativo) indicador: type: string description: Indicador de estoque 00 (Livre) 90 (Bloqueado) codigoBloqueio: type: string description: Código de bloqueio motivoBloqueio: type: string description: Motivo de bloqueio serial: type: string description: Serie do produto dataDeValidade: type: string description: Data de validade do lote responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarImportacaoAjusteInventario: post: description: Processar ajuste de inventário vindo do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/finalizarAjusteInventario: post: description: Finalizar ajuste de inventário tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idIntegracao: type: string description: Id de integração situacao: type: string allOf: – #/definitions/enumSituacao description: Situação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarProduto: post: description: Importar cadastro produto do ERP tags: – Signals parameters: – name: input in: body required: true schema: 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/recExportacaoProduto description: Produtos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarTransportadora: post: description: Importar cadastro transportadora do ERP tags: – Signals parameters: – name: input in: body required: true schema: 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 transportadora: type: array items: type: object allOf: – #/definitions/recExportacaoEntidade description: Transportadora responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarFornecedor: post: description: Importar cadastro fornecedor do ERP tags: – Signals parameters: – name: input in: body required: true schema: 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 fornecedor: type: array items: type: object allOf: – #/definitions/recExportacaoEntidade description: Fornecedor responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarCliente: post: description: Importar cadastro cliente do ERP tags: – Signals parameters: – name: input in: body required: true schema: 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 cliente: type: array items: type: object allOf: – #/definitions/recExportacaoEntidade description: Cliente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/finalizarMovimentoEstoque: post: description: Finalizar movimento estoque tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idIntegracao: type: string description: Id de integração situacao: type: string allOf: – #/definitions/enumSituacao description: Situação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarOrdemSeparacao: post: description: Importar Ordem separação do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idOrdemSeparacao: type: string description: id da ordem de separação do ERP tipoDocumentoIntegracao: type: integer format: int64 description: Tipo de documento integração ordemSeparacao: type: object allOf: – #/definitions/recOrdemSeparacao description: Payload do documento da ordem de separação do ERP responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarFaturamento: post: description: Importar Faturamento do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idOrdemSeparacao: type: string description: id da ordem de separação do ERP tipoDocumentoIntegracao: type: integer format: int64 description: Tipo de documento integração ordemSeparacao: type: object allOf: – #/definitions/recExportacaoFaturamento description: Payload do documento de faturamento do ERP responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarRefaturamento: post: description: Importar Refaturamento do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idOrdemSeparacao: type: string description: id da ordem de separação do ERP tipoDocumentoIntegracao: type: integer format: int64 description: Tipo de documento integração ordemSeparacao: type: object allOf: – #/definitions/recExportacaoRefaturamento description: Payload do documento de refaturamento do ERP responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarFaturamentoServico: post: description: Importar Faturamento Servico do erp tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: identificadorUnico: type: string description: Identificador único tipoDocumento: type: integer format: int64 description: Tipo de documento chaveDocumento: type: string description: Chave documento site: type: string description: Site wms cnpjFilial: type: string description: Cnpj filial do ERP alias: type: string description: Alias wms cnpjDepositante: type: string description: Cnpj do depositante ordemFaturamento: type: string description: Número ordem de faturamento numeroNotaFiscal: type: string description: Número da nota fiscal serieNotaFiscal: type: string description: Série da nota fiscal dataEmissao: type: string format: date description: Data emissão da nota fiscal dataVencimento: type: string format: date description: Data vencimento da nota fiscal customizados: type: array items: type: object allOf: – #/definitions/recExportacaoCustomizacao description: Customizacao entidade responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/importarCancelamento: post: description: Importar Refaturamento do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idOrdemSeparacao: type: string description: id da ordem de separação do ERP tipoDocumentoIntegracao: type: integer format: int64 description: Tipo de documento integração ordemSeparacao: type: object allOf: – #/definitions/recExportacaoCancelamento description: Payload do documento de refaturamento do ERP responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarEventosIntegracaoOrdemSeparacao: post: description: Processar os eventos de integração da ordem de separacao tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarEventosIntegracaoFaturamento: post: description: Processar os eventos de integração da ordem de separacao tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/gravarLogIntegracaoERP: post: description: Gravar logs de integração do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Id da mensagem mensagem: type: string description: Mensagem de log chaveDocumento: type: string description: Chave documento tipoDocumento: type: integer format: int64 description: Tipo de documento situacao: type: integer format: int64 description: Situação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/excluirRegistroIntegracaoERP: post: description: Excluir registros no monitor tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Id da mensagem customizados: type: array items: type: object allOf: – #/definitions/recExportacaoCustomizacao description: Campos customizados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarAndamentoSeparacao: post: description: Processa um registro de Andamento da Separação tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: chavelayout: type: string description: Indicação do tipo do movimento list: type: array items: type: object allOf: – #/definitions/recDadosAndamentoSeparacao description: Dados dos andamentos site: type: string description: Site WMS codigoDepositante: type: string description: Código do depositante numeroPedido: type: string description: Número do pedido subPedido: type: integer format: int64 description: Subpedido idIntegracao: type: string description: Identificdor único da integração statusAnterior: type: string description: Status anterior descricaoStatusAnterior: type: string description: Descrição do status anterior statusAtual: type: string description: Status atual descricaoStatusAtual: type: string description: Descrição do status atual controller: type: string description: Controller do WMS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/confirmarRetornoOrdemSeparacao: post: description: Confirmar retorno da ordem separação tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id da nota fiscal de entrada situacao: type: integer format: int64 description: Situação integração customizados: type: array items: type: object allOf: – #/definitions/recExportacaoCustomizacaoOrdemSeparacao description: Customizados – chave/valor responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarCancelamentoWMS: post: description: Processa retorno de confirmação de cancelamento e cancelamento de ordem separação ainda não faturado ou nota de entrada tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: chavelayout: type: string description: Indicação do tipo do movimento list: type: array items: type: object allOf: – #/definitions/recDadosCancelamentoWMS description: Dados do retorno da confirmação de cancelamento idIntegracao: type: string description: Identificador único da tabela de ordem de recebimento site: type: string description: Código do site notificado codigoDepositante: type: string description: Código do depositante notificado numeroNotaFiscal: type: integer format: int64 description: Número da nota fiscal de recebimento serieNotaFiscal: type: string description: Série da nota fiscal de recebimento numeroPedido: type: string description: Número do pedido notificado subPedido: type: integer format: int64 description: Número do pedido notificado controller: type: string description: Controller que retorna as informações responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/registrarFinalizacaoCancelamentoOrdemSeparacao: post: description: Sinal para registrar finalização do cancelamento da ordem separação tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: identificadorUnico: type: string description: Identificar único da tabela de ordem de separação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/registrarFinalizacaoCancelamentoOrdemRecebimento: post: description: Sinal para registrar finalização do cancelamento da ordem recebimento tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: identificadorUnico: type: string description: Identificar único da tabela de ordem de recebimento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarPendenciasComProtocoloContingencia: post: description: Processa todos os registros que estão com erro e foram processados 50 vezes tentando obter o resultado do protocolo tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarPendenciasSituacaoWms: post: description: Processa todos os registros que estão na situação recebida tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: situacao: type: string description: Situação Wms responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarLimpezaHistorico: post: description: Exclui os registros da tabela histórico – tempo configurado na plataforma tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: situacao: type: string description: Situação Wms responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/migrarEventosParaHistorico: post: description: Processa os registros dos eventos e logs concluídos para a tabela histórico – tempo configurado na plataforma tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/agendarRecuperarProduto: post: description: Agendamento para replicar inclusão e alteração de produto tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/confirmacaoPedido: post: description: Endpoint para confirmação de pedido realizado no wms tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idIntegracao: type: string description: Identificador único da tabela de ordem de recebimento site: type: string description: Código do site notificado codigoDepositante: type: string description: Código do depositante notificado numeroPedido: type: string description: Número do pedido notificado subPedido: type: integer format: int64 description: Número do pedido notificado controller: type: string description: Controller que retorna as informações responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/agendarRecuperarTransportadora: post: description: Agendamento para replicar inclusão e alteração de transportadora tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/agendarRecuperarFornecedor: post: description: Agendamento para replicar inclusão e alteração de fornecedor tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/agendarRecuperarCliente: post: description: Agendamento para replicar inclusão e alteração de cliente tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/movimentoEstoque: post: description: Endpoint para inclusão de movimento do estoque tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: site: type: string description: Site numeroDaTransacao: type: integer format: int64 description: Número da transação controller: type: string description: Controller idIntegracao: type: string description: Id da nota fiscal de entrada referenciada chavelayout: type: string description: Chave layout list: type: array items: type: object allOf: – #/definitions/recItensMovimentoEstoque description: Lista de itens responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarImportacaoMovimentoEstoque: post: description: Processar importação do movimento de estoque vindo do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarImportacaoFaturamentoServico: post: description: Processar importação do faturamento de serviço vindo do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/faturamentoServico: post: description: Endpoint para envio de faturamento de serviço tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: alias: type: string description: Alias site: type: string description: site ordemFaturamento: type: string description: Número ordem de serviço gerada no WMS dataOrdemServico: type: string description: Data da ordem de serviço cnpjFilialErp: type: string description: Cnpj filial do ERP cnpjCpfFaturarPara: type: string description: Cnpj ou cpf faturar para codigoCondicaoPagamento: type: string description: Código condição de pagamento observacao: type: string description: Observação enviada pelo WMS itensFaturamentoServico: type: array items: type: object allOf: – #/definitions/recItemFaturamentoServico description: Itens faturamento serviço romaneio: type: array items: type: object allOf: – #/definitions/recRomaneio description: Romaneio responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/updateRegisterStatus: post: description: Processar importação do faturamento de serviço vindo do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – user – register properties: user: type: string description: Usuário register: type: array items: type: string minimum: 1 description: Registro recebido a ser executado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/insertBifrostInitLoadCtrl: post: description: Inseri os registros necessário para carga inicial tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: resetLoad: type: boolean description: Refazer carga incial responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/sinalSeniorX: post: description: Contrato que deve ser implementado pelo integrador SeniorX para que o serviço da g5 envie os pacotes para o SeniorX tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: eventos: type: array items: type: object allOf: – #/definitions/recEvento description: Sinal de eventos do ERP responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/insertIntegrationParameters: post: description: Contrato que deve ser implementado pelo integrador SeniorX para que o serviço da g5 envie os parâmetros de integrações tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: parameters: type: array items: type: object allOf: – #/definitions/recParameter description: Parametros de integração responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarDocumento: post: description: Contrato para reenviar um documento do senior X para o WMS ou para o ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: Id do evento de integração responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarLimpezaRegistros: post: description: Processar limpeza de registros antigos tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: vencimento: type: integer format: int64 description: Validade do registro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reopenDocument: post: description: Contrato para reabrir o documento no ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id evento de integração responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reprocessErrors: post: description: Endpoint para reprocessar os registros com erros tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/processarImportacaoNotaFiscalEscrituracao: post: description: Processar nota fiscal para escrituração vindo do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/reenviarNotaFiscalEscrituracao: post: description: Processar reenvio nota fiscal para escrituração vindo do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: idProcessoIntegracao: type: string description: id do documento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /int_integrador/signals/testarNotaEscrituracao: post: description: Processar reenvio nota fiscal de entrada para escrituração vindo do WMS tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – json properties: json: type: string description: id do documento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN recTipoDocumento: description: Tipos de documentos (NF entrada, NF saída e pedido de venda) type: string enum: – NOTAENTRADA – NOTASAIDA – PEDIDOVENDA enumSituacao: description: Situacao movimentação type: string enum: – AGUARDANDO – EXCLUIR – CONCLUIDO 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 checkData: description: Dados do healthcheck type: object properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recDadosMovimentoSilt: description: Record com os dados da movimentação enviada pelo Silt type: object properties: idmovimentacao: type: integer format: int64 description: Id do movimento do Silt idprocessointegracao: type: string description: Id de integração enviado pelo ERP cnpjdepositante: type: string description: CNPJ do depositante cnpjunidade: type: string description: CNPJ da unidade recItensMovimentoEstoque: description: Record dos itens do movimento de estoque type: object properties: cnpjarmazem: type: string description: CNPJ do armazem cnpjdepositante: type: string description: CNPJ do depositante estoqueorigem: type: string description: Código de integração do estoque de origem estoquedestino: type: string description: Código de integração do estoque destino tipomovto: type: string description: Indica o tipo da movimentação. 2 = Ajuste de Movimentação Entrada; 3 = Ajuste de Movimentação Saída; 6 = Controle de Avaria; 7 = Produto Recuperado; 8 = Mudança entre códigos de setores; codproduto: type: string description: Código do produto qtde: type: string description: Quantidade movimento idmovimento_wms: type: string description: Identificador do documento no WMS loteindustria: type: string description: Lote do produto vencimento: type: string description: Data de vencimento do lote serie: type: string description: Série do produto motivo: type: string description: Motivo do movimento datamovimentacao: type: string description: Data da movimentação informacaoespecifica: type: string description: Informação específica valorinfoespecifica: type: string description: Valor da informação específica codsetororigem: type: string description: Código setor origem codsetordestino: type: string description: Código setor destino idintegracaoerp: type: string description: ID de integração com ERP recDadosAjusteInventario: description: Record com os dados do ajuste de inventário type: object properties: idInventarioSequencia: type: string description: UUID inventário idInventario: type: string description: Id do inventário cnpjDepositante: type: string description: CNPJ Depositante codigoInterno: type: string description: Código Interno do Produto estoque: type: number format: double description: Estoque do Sistema inventariado: type: number format: double description: Inventariado barra: type: string description: Código de Barras do Produto descr: type: string description: Descrição do Produto estado: type: string description: Estado do produto. N- Normal; D – Danificado; T – Truncado/Vencido. lote: type: string description: Lote Indústria vencimento: type: string description: Vencimento do Lote Indústria fabricacaoCalc: type: string description: Data de Fabricação calculada do Lote Indústria codSetor: type: string description: Identifica o Código de Integração Definido no Vínculo entre Setor/Depositante tipoInventario: type: string description: Tipo do inventário Cíclico/Rotativo – C; Estático/Geral – E informacaoEspecificaLote: type: array items: type: object allOf: – #/definitions/recDadosCustomizadosSilt description: Series do produto recDadosCustomizadosSilt: description: Record de customizados chave e valor do silt type: object properties: informacao: type: string description: Informação do valor que está vindo valor: type: string description: Valor recDadosAndamentoSeparacao: description: Record com os dados do andamento da separação type: object properties: situacao: type: integer format: int64 description: Indica o status de movimentacão do documento de saida idprocessointegracao: type: string description: Id de integração enviado pelo ERP idnotafiscal: type: string description: Identificador do documento no WMS tipo: type: string description: Tipo do documento: (E)ntrada ou (S)aida recDadosCancelamentoWMS: description: Record com os dados do retorno da confirmação de cancelamento type: object properties: situacao: type: string description: Indica a situação de aceito ou negado pelo WMS descricao: type: string description: Motivo do cancelamento motivocancelamento: type: string description: Motivo do cancelamento idprocessointegracao: type: string description: Id de integração enviado pelo ERP tipo: type: string description: Tipo do documento (E)ntrada ou (S)aida recOrdemSeparacao: 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 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: Subpedido 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 redespachho 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 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 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 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: Telefone 2 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 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 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 recExportacaoFaturamento: 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 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 cnpjDestinatario: type: string description: CNPJ do destinatário cnpjFilialEmitente: type: string description: CNPJ da filial emitente nomeFilialEmitente: type: string description: Nome da filial emitente subPedido: type: integer format: int64 description: Sub pedido dadosTransportadora: type: object allOf: – #/definitions/recDadosTransportadora description: Dados da transportadora dadosTransportadoraRedespacho: type: object allOf: – #/definitions/recDadosTransportadora description: Dados da transportadora de redespachho itens: type: array items: type: object allOf: – #/definitions/recExportacaoItemFaturamento description: Itens da ordem de separação recExportacaoRefaturamento: description: Exportação da ordem de separação do refaturamento do ERP type: object properties: identificadorUnico: type: string description: Identificar único da tabela de ordem de separação codigoFilial: type: integer format: int64 description: Código filial cnpjDestinatario: type: string description: CNPJ do destinatário cnpjFilialEmitente: type: string description: CNPJ da filial emitente numeroDocumentoAnterior: type: string description: Número do documento fiscal anterior numeroDocumento: type: string description: Número do documento fiscal pedidoCliente: type: string description: Número do pedido do cliente serieNotaFiscalSaidaAnterior: type: string description: Série da nota fiscal de saída anterior serieNotaFiscalSaida: type: string description: Série da nota fiscal de saída 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 tipoDocumento: type: string description: Tipo documento entrada/saída subPedido: type: integer format: int64 description: Sub pedido dadosTransportadora: type: object allOf: – #/definitions/recDadosTransportadora description: Dados da transportadora dadosTransportadoraRedespacho: type: object allOf: – #/definitions/recDadosTransportadora description: Dados da transportadora de redespachho recExportacaoItemFaturamento: description: Exportação do item do faturamento da ordem de separação do ERP type: object required: – valorLiquido 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 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 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 recExportacaoCancelamento: description: Exportação do cancelamento da ordem de separação do ERP type: object properties: identificadorUnico: type: string description: Identificar único da tabela de ordem de separação cnpjDestinatario: type: string description: CNPJ do destinatário cnpjFilialEmitente: type: string description: CNPJ da filial emitente numeroDocumento: type: string description: Número do documento fiscal pedidoCliente: type: string description: Número do pedido do cliente serieNotaFiscalSaida: type: string description: Série da nota fiscal de saída tipoDocumento: type: string description: Tipo documento entrada/saída status: type: string description: Status cancelar/pausar ordem de separação motivoCancelamento: type: string description: Motivo cancelamento subPedido: type: integer format: int64 description: Subpedido 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 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 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 recExportacaoProduto: description: Exportação do cadastro de produto do ERP 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/recExportacaoCustomizacao description: Customizacao produto embalagem: type: array items: type: object allOf: – #/definitions/recExportacaoEmbalagemProduto description: Embalagens do produto recExportacaoEmbalagemProduto: description: Exportacao das embalagens do produto 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/recExportacaoCustomizacao description: Customizacao embalagem recExportacaoEntidade: description: Exportacao de entidade type: object properties: identificadorUnico: type: string description: identificador único site: type: string description: site codigoInterno: type: string description: Código interno codigoDepositante: type: string description: Código depositante codigoFilial: type: integer format: int64 description: Código filial codigoCliente: type: string description: Código cliente codigoFornecedor: type: string description: Código fornecedor codigoTransportadora: type: string description: Código transportadora cnpj: type: string description: CNPJ razaoSocial: type: string description: Razão social nomeFantasia: type: string description: Nome fantasia tipoPessoa: type: string description: Tipo de pessoa tipoEntidade: type: string description: Tipo de entidade inscricaoSulframa: type: string description: Inscrição sulframa codigoSorter: type: string description: Código sorter controleShelfLife: type: string description: Controle shelf life valorShelfLife: type: string description: Valor shelf life idEstrangeiro: type: string description: ID estrangeiro estrangeiro: type: string description: Estrangeiro ativo: type: string description: Ativo cpf: type: string description: CPF rg: type: string description: RG inscricaoEstadual: type: string description: Inscrição estadual customizados: type: array items: type: object allOf: – #/definitions/recExportacaoCustomizacao description: Customizacao entidade endereco: type: array items: type: object allOf: – #/definitions/recExportacaoEndereco description: Endereços contato: type: array items: type: object allOf: – #/definitions/recExportacaoContato description: Contatos recExportacaoEndereco: description: Exportacao de entidade type: object properties: tipoEndereco: type: string description: Tipo de endereço cep: type: string description: CEP numero: type: string description: Número complemento: type: string description: Complemento rota: type: string description: Rota codigoPais: type: integer format: int64 description: Código país pais: type: string description: País siglaEstado: type: string description: Sigla estado estado: type: string description: Estado cidade: type: string description: Cidade bairro: type: string description: Bairro logradouro: type: string description: Logradouro codigoEndereco: type: string description: Código endereço enderecoEntrega: type: string description: Endereço de entrega enderecoCobranca: type: string description: Endereço de cobrança customizados: type: array items: type: object allOf: – #/definitions/recExportacaoCustomizacao description: Customizacao endereço recExportacaoContato: description: Exportacao de entidade type: object properties: tipoContato: type: string description: Tipo de contato contato: type: string description: Contato telefone: type: string description: Telefone primário telefone2: type: string description: Telefone secundário email: type: string description: E-mail customizados: type: array items: type: object allOf: – #/definitions/recExportacaoCustomizacao description: Customizacao contato recExportacaoCustomizacao: description: Exportacao de campos e valores customizados type: object properties: chave: type: string description: Chave valor: type: string description: Valor recItemFaturamentoServico: description: Record do item serviço type: object properties: codigoItem: type: string description: Código item descricaoItem: type: string description: Descrição do item precoUnitario: type: number format: double description: Preço unitário do item quantidade: type: number format: double description: Quantidade do item desconto: type: number format: double description: Desconto do item recRomaneio: description: Record de campos e valores customizados type: object properties: data: type: string description: Data observacao: type: string description: Observação recEvento: description: Record cabeçalho do evento ERP type: object properties: identificadorUnico: type: string description: id para recuperar documento tipoDocumento: type: integer format: int64 description: Tipo de documento integração ISL chaveDocumento: type: string description: Chave do documento situacaoIntegracao: type: integer format: int64 description: Situação integração recParameter: description: Record de parâmetros type: object properties: codigoEmpresa: type: integer format: int64 description: Código empresa codigoFilial: type: integer format: int64 description: Código filial destinoWms: type: integer format: int64 description: Destino WMS url: type: string description: URL configuração usuario: type: string description: Usuário senha: type: string description: Senha token: type: string description: Token alias: type: string description: Alias siteCnpjArmazem: type: string description: Site ou CNPJ armazém codigoCnpjDepositante: type: string description: Código ou CNPJ depositante integraAduaneiro: type: string description: Integra aduaneiro modeloIntegracao: type: string description: Modelo de integração keyint notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE