2.0info: 0.0.0 integracao /bridge/rest/fis – application/json – application/jsonpaths: /integracao/queries/getMetadata: post: description: This operation is public. Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: This operation is public. Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries parameters: – name: metadataFormat in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/transportadora: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – transportadoras properties: transportadoras: type: array items: type: object allOf: – #/definitions/dadosTransportadora minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/pedido: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – pedidos properties: pedidos: type: array items: type: object allOf: – #/definitions/dadosPedido minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/cancelamentoPedido: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – cancelamentoPedidos properties: origem: type: string description: cancelamentoPedidos: type: array items: type: object allOf: – #/definitions/dadosCancelamentoPedido minimum: 1 description: validacao_sincrona: type: boolean description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/faturamentoNfe: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – faturamentosNfe properties: faturamentosNfe: type: array items: type: object allOf: – #/definitions/dadosFaturamentoNfe minimum: 1 description: validacao_sincrona: type: boolean description: atualiza_nfe_530: type: boolean description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/confirmacaoPagamento: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – confirmacaoPagamentos properties: confirmacaoPagamentos: type: array items: type: object allOf: – #/definitions/dadosConfirmacaoPagamento minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/romaneio: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – romaneios properties: romaneios: type: array items: type: object allOf: – #/definitions/dadosRomaneio minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/cotacaoFrete: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – cotacaoFrete properties: cotacaoFrete: type: object allOf: – #/definitions/dadosCotacaoFrete description: responses: 200: description: Ok schema: type: object required: – saidaCotacao properties: saidaCotacao: type: array items: type: object allOf: – #/definitions/dadosSaidaCotacaoFrete minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/ocorrencia: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – ocorrencias properties: ocorrencias: type: array items: type: object allOf: – #/definitions/cabecalhoOcorrencia minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/saidaServicoPrazo: post: description: This operation is public. tags: – Actions responses: 200: description: Ok schema: type: object required: – servicosPrazo properties: servicosPrazo: type: array items: type: object allOf: – #/definitions/dadosServicoPrazo minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/saidaOcorrencia: post: description: This operation is public. tags: – Actions responses: 200: description: Ok schema: type: object required: – ocorrencias properties: ocorrencias: type: array items: type: object allOf: – #/definitions/dadosOcorren minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/saidaTrocaTransportadora: post: description: This operation is public. tags: – Actions responses: 200: description: Ok schema: type: object required: – trocaTransportadora properties: trocaTransportadora: type: array items: type: object allOf: – #/definitions/dadosTrocaTransportadora minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/saidaPagamentoFrete: post: description: This operation is public. tags: – Actions responses: 200: description: Ok schema: type: object required: – pagamentoFrete properties: pagamentoFrete: type: array items: type: object allOf: – #/definitions/dadosPagamentoFrete minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/saidaPagamentoFreteDetalhado: post: description: This operation is public. tags: – Actions responses: 200: description: Ok schema: type: object required: – pagamentoFreteDetalhe properties: pagamentoFreteDetalhe: type: array items: type: object allOf: – #/definitions/dadosPagamentoFreteDetalhe minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/saidaRastreio: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – rastreio properties: rastreio: type: object allOf: – #/definitions/dadosRastreio description: responses: 200: description: Ok schema: type: object required: – ocorren properties: ocorren: type: object allOf: – #/definitions/dadosOcorren description: default: description: Error response schema: #/definitions/genericError /integracao/actions/saidaTipoEntrega: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – notaSilt properties: notaSilt: type: array items: type: object allOf: – #/definitions/dadosNotaSilt minimum: 1 description: responses: 200: description: Ok schema: type: object required: – notaSilt properties: notaSilt: type: array items: type: object allOf: – #/definitions/dadosNotaSilt minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/saidaHistoricoOcorrencia: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – histOcorren properties: histOcorren: type: object allOf: – #/definitions/dadosPedidoEntrada description: responses: 200: description: Ok schema: type: object required: – ocorren properties: ocorren: type: array items: type: object allOf: – #/definitions/dadosHistoricoOcorrencia minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/recebeCanhoto: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – recebeCanhoto properties: recebeCanhoto: type: array items: type: object allOf: – #/definitions/dadosRecebeCanhoto minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/excluirLgpd: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – lgpd properties: lgpd: type: object allOf: – #/definitions/dadosLgpd description: responses: 200: description: Ok schema: type: object required: – lgpd properties: lgpd: type: object allOf: – #/definitions/dadosLgpdRetorno description: default: description: Error response schema: #/definitions/genericError /integracao/actions/dossieLgpd: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – lgpd properties: lgpd: type: object allOf: – #/definitions/dadosLgpd description: responses: 200: description: Ok schema: type: object required: – lgpd properties: lgpd: type: object allOf: – #/definitions/dadosLgpdRetorno description: default: description: Error response schema: #/definitions/genericError /integracao/actions/lancamentoAtividadeFrotaPropria: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: responses: 200: description: Ok schema: type: object required: – lista properties: registros: type: integer format: int64 description: mensagem: type: string description: lista: type: array items: type: object allOf: – #/definitions/lancamentoAtividade minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/cotacaoFreteSimplificada: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – cotacaoFrete properties: cotacaoFrete: type: object allOf: – #/definitions/cotacaoFreteSmp description: responses: 200: description: Ok schema: type: object required: – cotacaoFrete properties: cotacaoFrete: type: array items: type: object allOf: – #/definitions/cotacaoFreteRetorno minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/cancelarSaldo: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – pedidos properties: pedidos: type: array items: type: object allOf: – #/definitions/pedidoCancelaSaldo minimum: 1 description: responses: 200: description: Ok schema: type: object required: – msg properties: msg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/conemb: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – conemb properties: conemb: type: array items: type: object allOf: – #/definitions/dadosConemb minimum: 1 description: responses: 200: description: Ok schema: type: object required: – mesg properties: mesg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/romaneiosNotfis: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – quantidade – romaneios properties: quantidade: type: integer format: int64 description: romaneios: type: array items: type: string minimum: 1 description: mensagem: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/actions/interfDocFrete: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – nu_pedido_origem properties: cd_empresa: type: string description: nu_pedido_origem: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object required: – saidaDocFrete properties: saidaDocFrete: type: array items: type: object allOf: – #/definitions/saidaDocFrete minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/interfFat: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – nu_pedido_origem properties: cd_empresa: type: string description: nu_pedido_origem: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object required: – saidaFat properties: saidaFat: type: array items: type: object allOf: – #/definitions/saidaFat minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/interfTracking: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – nu_pedido_origem properties: cd_empresa: type: string description: nu_pedido_origem: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object required: – saidaTracking properties: saidaTracking: type: array items: type: object allOf: – #/definitions/saidaTracking minimum: 1 description: default: description: Error response schema: #/definitions/genericError /integracao/actions/confirmaProcessamento: post: description: This operation is public. tags: – Actions parameters: – name: input in: body required: true schema: type: object required: – protocoloWebservice properties: protocoloWebservice: type: array items: type: integer format: int64 minimum: 1 description: responses: 200: description: Ok schema: type: object required: – msg properties: msg: type: string description: default: description: Error response schema: #/definitions/genericError /integracao/signals/enviaServicoPrazo: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobAcompanharPedido: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobCancelarPedido: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobSolicitaPostagemReversa: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobSROCorreios: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobEnviaNotificacaoEmail: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobEnviaPedidoInfoCorreios: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobFechaPlpVariosServicos: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/processarFreteFaturamentoLote: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobProcessarArquivoOcorren: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobProcessarOcorren: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobIntegracaoSnapbot: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobProcessarArquivoConemb: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobProcessarConemb: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobIntegracaoDesativarVigencia: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobMonitoramentoAgendamento: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobMonitoramentoProcessamento: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobProcessaRomaneioTorre: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobPropagarPedidosFreteServico: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobPropagarDetalheConemb: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integracao/signals/jobRomaneioObterPedidos: post: description: This operation is public. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError definitions: 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 dadosTransportadora: description: type: object required: – cnpj_empresa – cd_transportadora – ds_transportadora – nu_cgc – nu_ie – ds_endereco – numero – ds_bairro – ds_cidade – sg_uf properties: cnpj_empresa: type: string description: cd_transportadora: type: integer format: int64 description: ds_transportadora: type: string description: ds_nome_fantasia: type: string description: nu_cgc: type: string description: nu_ie: type: string description: cd_cep: type: string description: ds_endereco: type: string description: numero: type: string description: complemento: type: string description: ds_bairro: type: string description: ds_cidade: type: string description: cd_municipio: type: string description: sg_uf: type: string description: nu_telefone_1: type: string description: nu_telefone_2: type: string description: nm_contato: type: string description: dadosPedido: description: type: object required: – ped_cnpj_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_vlr_nf – ped_ps_real – ped_tp_pedido – cli_nm_cliente – cli_nu_cgc – loc_cep – loc_endereco – loc_endereco_numero – loc_bairro – loc_cidade – loc_sg_uf – tp_frete – cli_id_contribuinte_icms properties: ped_cnpj_empresa: type: string description: ped_cd_cliente: type: string description: ped_nu_pedido_origem: type: string description: ped_nu_nf: type: integer format: int64 description: ped_nu_serie_nf: type: string description: ped_dt_emissao_nf: type: string description: ped_nf_chave_acesso: type: string description: ped_ds_natureza_mercadoria: type: string description: ped_ds_tipo_acondicionamento: type: string description: ped_vlr_nf: type: number format: double description: ped_nu_documento: type: string description: ped_ps_real: type: number format: double description: ped_ps_cubado: type: number format: double description: ped_qt_volume: type: integer format: int64 description: ped_vlr_frete_receber: type: number format: double description: ped_cd_transp_origem: type: integer format: int64 description: ped_tp_pedido: type: string description: fis_uid: type: integer format: int64 description: ped_dt_entrega: type: string description: cli_nm_cliente: type: string description: cli_nu_rg: type: string description: cli_nu_cgc: type: string description: cli_nu_inscricao: type: string description: cli_nu_tel_res: type: string description: cli_nu_tel_cel: type: string description: cli_ds_email: type: string description: loc_cep: type: string description: loc_endereco: type: string description: loc_endereco_numero: type: string description: loc_bairro: type: string description: loc_cidade: type: string description: loc_cidade_cod_ibge: type: string description: loc_sg_uf: type: string description: loc_ds_observacao: type: string description: qt_dias_entrega: type: integer format: int64 description: tp_frete: type: string description: cd_centro: type: integer format: int64 description: cd_custo: type: integer format: int64 description: ped_entrega_tracking_number: type: string description: cli_id_contribuinte_icms: type: string description: ped_cfop: type: string description: loc_complemento_endereco: type: string description: cli_nm_recebedor: type: string description: cli_nu_tel_recebedor: type: string description: ped_cd_tipo_entrega: type: integer format: int64 description: ped_id_periodo: type: string description: ped_diametro_volume: type: integer format: int64 description: ped_cd_produto_categoria: type: string description: ped_qt_km: type: number format: double description: ped_vlr_tde_erp: type: number format: double description: ped_id_carregamento: type: string description: ped_dt_carga_descarga: type: string description: validacao_sincrona: type: boolean description: atualizar_calculado: type: boolean description: ped_observacao: type: string description: ped_comprimento: type: number format: double description: ped_largura: type: number format: double description: ped_altura: type: number format: double description: dadosCancelamentoPedido: description: type: object required: – ped_cnpj_empresa – ped_cd_cliente – ped_nu_pedido_origem properties: ped_cnpj_empresa: type: string description: ped_cd_cliente: type: string description: ped_nu_pedido_origem: type: string description: ped_ds_motivo_cancelamento: type: string description: dadosFaturamentoNfe: description: type: object required: – ped_cnpj_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_nu_nf – ped_nu_serie_nf – ped_dt_emissao_nf – ped_chave_acesso – ped_qt_volume – ped_cfop properties: ped_cnpj_empresa: type: string description: ped_cd_cliente: type: string description: ped_nu_pedido_origem: type: string description: ped_nu_nf: type: integer format: int64 description: ped_nu_serie_nf: type: string description: ped_dt_emissao_nf: type: string description: ped_chave_acesso: type: string description: ped_qt_volume: type: integer format: int64 description: ped_cfop: type: string description: ped_ps_liquido: type: number format: double description: ped_valor_nf: type: number format: double description: ped_canal_venda: type: string description: ped_cnpj_transportadora: type: string description: ped_email_cliente: type: string description: ped_peso_recebido: type: number format: double description: validacao_sincrona: type: boolean description: dt_integracao_nf: type: string description: dadosConfirmacaoPagamento: description: type: object required: – pag_cnpj_empresa – pag_cd_cnpj_transp – pag_nu_cte – pag_nu_cte_serie – pag_vlr_pago – pag_dt_pagamento properties: pag_cnpj_empresa: type: string description: pag_cd_cnpj_transp: type: string description: pag_nu_cte: type: integer format: int64 description: pag_nu_cte_serie: type: string description: pag_nu_titulo: type: string description: pag_vlr_pago: type: number format: double description: pag_dt_pagamento: type: string description: dadosDetalhePagamentoFrete: description: type: object required: – cnpj_empresa – cd_cnpj_transp – nu_cte – nu_cte_serie – dt_emissao_cte – nu_nf – nu_serie_nf properties: cnpj_empresa: type: string description: cd_cnpj_transp: type: string description: nu_cte: type: integer format: int64 description: nu_cte_serie: type: string description: dt_emissao_cte: type: string description: nu_nf: type: integer format: int64 description: nu_serie_nf: type: string description: dadosCteFatura: description: type: object required: – cte_chave_acesso properties: cte_chave_acesso: type: string description: dadosRomaneio: description: type: object required: – cnpj_empresa – nu_romaneio – cnpj_transportadora – qt_total_pedido – dt_expedicao – detalhe properties: cnpj_empresa: type: string description: nu_romaneio: type: integer format: int64 description: cnpj_transportadora: type: string description: cd_placa_carro: type: string description: qt_total_pedido: type: integer format: int64 description: dt_expedicao: type: string description: id_troca: type: string description: ds_motivo_troca: type: string description: tp_carga: type: string description: detalhe: type: array items: type: object allOf: – #/definitions/dadosDetRomaneio minimum: 1 description: dadosDetRomaneio: description: type: object required: – cd_cliente – nu_pedido_origem – nu_nota_fiscal – nu_serie_nf – vlr_nota_fiscal – dt_emissao_nf properties: cd_cliente: type: string description: nu_pedido_origem: type: string description: nu_nota_fiscal: type: integer format: int64 description: nu_serie_nf: type: string description: vlr_nota_fiscal: type: string description: dt_emissao_nf: type: string description: chave_acesso_nfe: type: string description: nu_objeto_postagem: type: string description: qt_volume: type: integer format: int64 description: dadosCotacaoFrete: description: type: object required: – cnpj_empresa – cep – ps_real – ps_cubado – vl_nota_fiscal – id_tipo_cliente – id_contribuinte_icms – cd_tipo_servico – id_tabela_media properties: cnpj_empresa: type: string description: cep: type: string description: cd_transportadora: type: integer format: int64 description: ps_real: type: number format: double description: ps_cubado: type: number format: double description: vl_nota_fiscal: type: number format: double description: id_tipo_cliente: type: string description: id_contribuinte_icms: type: string description: cd_tipo_servico: type: string description: id_tabela_media: type: integer format: int64 description: qtd_total: type: integer format: int64 description: id_ranking: type: string description: permite_tde: type: string maxLength: 1 description: default: S dadosSaidaCotacaoFrete: description: type: object required: – id_mensagem properties: codigo_cotacao: type: integer format: int64 description: id_transportadora: type: integer format: int64 description: ds_transportadora: type: string description: cd_transportadora: type: integer format: int64 description: ds_tipo_transporte: type: string description: id_tipo_entrega: type: integer format: int64 description: cd_tipo_entrega: type: integer format: int64 description: ds_tipo_entrega: type: string description: peso_total: type: number format: double description: valor_cotacao: type: number format: double description: valor_taxas: type: number format: double description: frete_condicao: type: string description: prazo_entrega_min: type: integer format: int64 description: prazo_entrega_max: type: integer format: int64 description: dt_entrega_min: type: string description: dt_entrega_max: type: string description: url_imagem_frete: type: string description: valor_imposto: type: number format: double description: base_calculo_imposto: type: number format: double description: aliquota_imposto: type: number format: double description: tipo_imposto: type: string description: id_mensagem: type: string description: cabecalhoOcorrencia: description: type: object required: – cnpj_empresa – cnpj_transportadora – corpo_ocorrencias properties: cnpj_empresa: type: string description: cnpj_transportadora: type: string description: corpo_ocorrencias: type: array items: type: object allOf: – #/definitions/dadosOcorrencia minimum: 1 description: dadosOcorrencia: description: type: object required: – nu_nota_fiscal – nu_serie_nf – cd_motivo_retorno – dt_atualizacao properties: nu_nota_fiscal: type: integer format: int64 description: nu_serie_nf: type: string description: nu_pedido_origem: type: string description: cd_motivo_retorno: type: integer format: int64 description: dt_atualizacao: type: string description: observacao: type: string description: nu_objeto_postagem: type: string description: dadosConemb: description: type: object required: – cnpj_empresa – cnpj_transportadora – conembConhecimentosEmbarcados properties: cnpj_empresa: type: string description: cnpj_transportadora: type: string description: conembConhecimentosEmbarcados: type: array items: type: object allOf: – #/definitions/dadosConhecimentosEmbarcados minimum: 1 description: dadosConhecimentosEmbarcados: description: type: object required: – numeroConhecimento – numeroSerieConhecimento – dtEmissao – condicaoFrete – pesoReal – valorTotalFrete – icmsBaseValor – icmsPercentual – icmsValor – valorFretePeso – valorFrete – idSubstituiTributacao – cfop – modelo – chaceAcessoCte – conembNotaFiscal properties: numeroConhecimento: type: string description: numeroSerieConhecimento: type: string description: dtEmissao: type: string description: condicaoFrete: type: string description: pesoReal: type: number format: double description: valorTotalFrete: type: number format: double description: icmsBaseValor: type: number format: double description: icmsPercentual: type: number format: double description: icmsValor: type: number format: double description: valorFretePeso: type: number format: double description: valorFrete: type: number format: double description: valorCatSec: type: number format: double description: valorItr: type: number format: double description: valorDespacho: type: number format: double description: valorPedagio: type: number format: double description: valorAdeme: type: number format: double description: idSubstituiTributacao: type: string description: idAcaoDocumento: type: string description: idTipoConhecimento: type: string description: cfop: type: string description: modelo: type: string description: chaceAcessoCte: type: string description: protocoloAutorizacao: type: string description: dtVencimento: type: string description: issBaseValor: type: number format: double description: issPercentual: type: number format: double description: issValor: type: number format: double description: tipoDocumento: type: string description: outros: type: number format: double description: advalorem: type: number format: double description: gris: type: number format: double description: conembNotaFiscal: type: array items: type: object allOf: – #/definitions/conembNotaFiscal minimum: 1 description: cnpjEmpresa: type: string description: cnpjTransportadora: type: string description: nomeArquivo: type: string description: conembNotaFiscal: description: type: object required: – nuNotaFiscal properties: nuNotaFiscal: type: string description: nuSerieNotaFiscal: type: string description: chaveNfe: type: string description: dadosServicoPrazo: description: type: object required: – ped_cd_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_cd_transportadora – ped_tipo_entrega – ped_tipo_imposto – ped_qt_dias_entrega – ped_frete_valor – ped_nf_peso_real – ped_fator_cubagem – ped_entrega_tracking_number properties: ped_cd_empresa: type: integer format: int64 description: ped_cd_cliente: type: string description: ped_nu_pedido_origem: type: string description: ped_cd_transportadora: type: integer format: int64 description: ped_tipo_entrega: type: integer format: int64 description: ped_tipo_imposto: type: string description: ped_qt_dias_entrega: type: integer format: int64 description: ped_frete_valor: type: number format: double description: ped_nf_peso_real: type: number format: double description: ped_fator_cubagem: type: integer format: int64 description: ped_entrega_tracking_number: type: string description: dadosOcorren: description: type: object required: – ped_cd_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_cd_transportadora – ped_nu_nota_fiscal – ped_nu_serie_nf – oco_cd_motivo_retorno – oco_ds_motivo_retorno – ped_observacao – oco_dt_atualizacao – oco_id_finaliza_servico – ped_dt_prevista_entrega – entrega_tracking_number properties: ped_cd_empresa: type: integer format: int64 description: ped_cd_cliente: type: string description: ped_nu_pedido_origem: type: string description: ped_cd_transportadora: type: integer format: int64 description: ped_nu_nota_fiscal: type: integer format: int64 description: ped_nu_serie_nf: type: string description: oco_cd_motivo_retorno: type: string description: oco_ds_motivo_retorno: type: string description: ped_observacao: type: string description: oco_dt_atualizacao: type: string description: oco_id_finaliza_servico: type: string description: ped_dt_prevista_entrega: type: string description: entrega_tracking_number: type: string description: protocolo_webservice: type: integer format: int64 description: dadosTrocaTransportadora: description: type: object required: – ped_cd_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_cd_transportadora – ped_tipo_entrega – ped_tipo_imposto – ped_qt_dias_entrega – ped_frete_valor – ped_nf_peso_real – ped_fator_cubagem properties: ped_cd_empresa: type: integer format: int64 description: ped_cd_cliente: type: string description: ped_nu_pedido_origem: type: string description: ped_cd_transportadora: type: integer format: int64 description: ped_tipo_entrega: type: integer format: int64 description: ped_tipo_imposto: type: string description: ped_qt_dias_entrega: type: integer format: int64 description: ped_frete_valor: type: string description: ped_nf_peso_real: type: string description: ped_fator_cubagem: type: integer format: int64 description: dadosPagamentoFrete: description: type: object required: – cd_empresa – cd_cnpj_transp – tp_entrada – ped_nu_nf – ped_nu_serie_nf – nu_cte – nu_cte_serie – dt_emissao_cte – cte_chave_acesso – cte_protocolo_autorizacao – vlr_frete – vlr_desconto – icms_vlr_base – icms_aliquota – icms_vlr – iss_vlr_base – iss_aliquota – iss_vlr – dt_vencimento – cd_registro – cfop – nu_faturamento properties: cd_empresa: type: integer format: int64 description: cd_cnpj_transp: type: string description: tp_entrada: type: string description: ped_nu_nf: type: integer format: int64 description: ped_nu_serie_nf: type: string description: nu_cte: type: integer format: int64 description: nu_cte_serie: type: string description: dt_emissao_cte: type: string description: cte_chave_acesso: type: string description: cte_protocolo_autorizacao: type: string description: vlr_frete: type: number format: double description: vlr_desconto: type: number format: double description: icms_vlr_base: type: number format: double description: icms_aliquota: type: number format: double description: icms_vlr: type: number format: double description: iss_vlr_base: type: number format: double description: iss_aliquota: type: number format: double description: iss_vlr: type: number format: double description: dt_vencimento: type: string description: cd_registro: type: string description: cfop: type: string description: nu_faturamento: type: integer format: int64 description: dadosPagamentoFreteDetalhe: description: type: object required: – cd_empresa – cd_cnpj_transp – tp_entrada – ped_nu_nf – ped_nu_serie_nf – nu_cte – nu_cte_serie – dt_emissao_cte – cte_chave_acesso – cte_protocolo_autorizacao – vlr_frete – vlr_desconto – icms_vlr_base – icms_aliquota – icms_vlr – iss_vlr_base – iss_aliquota – iss_vlr – dt_vencimento – cd_registro – cfop – nu_faturamento – detalhe properties: cd_empresa: type: integer format: int64 description: cd_cnpj_transp: type: string description: tp_entrada: type: string description: ped_nu_nf: type: integer format: int64 description: ped_nu_serie_nf: type: string description: nu_cte: type: integer format: int64 description: nu_cte_serie: type: string description: dt_emissao_cte: type: string description: cte_chave_acesso: type: string description: cte_protocolo_autorizacao: type: string description: vlr_frete: type: number format: double description: vlr_desconto: type: number format: double description: icms_vlr_base: type: number format: double description: icms_aliquota: type: number format: double description: icms_vlr: type: number format: double description: iss_vlr_base: type: number format: double description: iss_aliquota: type: number format: double description: iss_vlr: type: number format: double description: dt_vencimento: type: string description: cd_registro: type: string description: cfop: type: string description: nu_faturamento: type: integer format: int64 description: detalhe: type: array items: type: object allOf: – #/definitions/dadosDetPagamentoFrete minimum: 1 description: dadosDetPagamentoFrete: description: type: object required: – id – cd_empresa – cd_cnpj_transp – nu_cte – nu_cte_serie – dt_emissao_cte – nu_nf – nu_serie_nf properties: id: type: integer format: int64 description: cd_empresa: type: integer format: int64 description: cd_cnpj_transp: type: string description: nu_cte: type: integer format: int64 description: nu_cte_serie: type: string description: dt_emissao_cte: type: string description: nu_nf: type: integer format: int64 description: nu_serie_nf: type: string description: dadosRastreio: description: type: object required: – ped_cd_empresa – ped_nu_pedido_origem properties: ped_cd_empresa: type: integer format: int64 description: ped_nu_pedido_origem: type: string description: ped_cd_transportadora: type: integer format: int64 description: ped_cd_cliente: type: integer format: int64 description: dadosNotaSilt: description: type: object required: – cnpjDepositante – nuNota – serieNota properties: cnpjDepositante: type: string description: nuNota: type: integer format: int64 description: serieNota: type: string description: tipoEntrega: type: integer format: int64 description: dadosPedidoEntrada: description: type: object required: – ped_cd_empresa – ped_nu_pedido_origem properties: ped_cd_empresa: type: integer format: int64 description: ped_nu_pedido_origem: type: string description: ped_cd_transportadora: type: integer format: int64 description: ped_cd_cliente: type: integer format: int64 description: dadosHistoricoOcorrencia: description: type: object required: – ped_cd_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_cd_transportadora – ped_nu_nota_fiscal – ped_nu_serie_nf – oco_cd_motivo_retorno – oco_ds_motivo_retorno – oco_dt_atualizacao – oco_id_finaliza_servico – ped_dt_prevista_entrega – entrega_tracking_number – ped_observacao – cd_ocorr_cliente – ds_ocorr_cliente properties: ped_cd_empresa: type: integer format: int64 description: ped_cd_cliente: type: string description: ped_nu_pedido_origem: type: string description: ped_cd_transportadora: type: integer format: int64 description: ped_nu_nota_fiscal: type: integer format: int64 description: ped_nu_serie_nf: type: string description: oco_cd_motivo_retorno: type: string description: oco_ds_motivo_retorno: type: string description: oco_dt_atualizacao: type: string description: oco_id_finaliza_servico: type: string description: ped_dt_prevista_entrega: type: string description: entrega_tracking_number: type: string description: ped_observacao: type: string description: cd_ocorr_cliente: type: string description: ds_ocorr_cliente: type: string description: dadosRecebeCanhoto: description: type: object required: – ped_cnpj_empresa – ped_cd_cliente – ped_nu_pedido_origem – ped_nu_nf – ped_data_entrega – ped_ps_liquido_canhoto properties: ped_cnpj_empresa: type: string description: ped_cd_cliente: type: string description: ped_nu_pedido_origem: type: string description: ped_nu_nf: type: integer format: int64 description: ped_chave_acesso: type: string description: ped_data_entrega: type: string description: ped_ps_liquido_canhoto: type: number format: double description: url_imagem_canhoto: type: string description: dadosLgpd: description: type: object required: – cnpj_empresa – cpf_cliente properties: cnpj_empresa: type: string description: cpf_cliente: type: string description: dadosLgpdRetorno: description: type: object required: – dossie properties: msg: type: string description: dossie: type: array items: type: object allOf: – #/definitions/dadosDossie minimum: 1 description: dadosDossie: description: type: object required: – cnpj_empresa – cpf_cliente – ds_cliente – cd_cliente – detalhe properties: cnpj_empresa: type: string description: cpf_cliente: type: string description: ds_cliente: type: string description: cd_cliente: type: string description: nu_dv_cliente: type: string description: ds_abrev_cliente: type: string description: detalhe: type: array items: type: object allOf: – #/definitions/detDossie minimum: 1 description: detDossie: description: type: object required: – tabela – coluna properties: tabela: type: string description: coluna: type: string description: descricao: type: string description: valor: type: string description: lancamentoAtividade: description: type: object required: – cnpj_empresa – cd_empresa – cnpj_transportadora – cd_transportadora properties: cnpj_empresa: type: string description: cd_empresa: type: string description: cnpj_transportadora: type: string description: cd_transportadora: type: string description: placa: type: string description: numero_nf: type: integer format: int64 description: dt_emissao_nf: type: string description: valor_desconto: type: number format: double description: valor_total: type: number format: double description: observacao: type: string description: cotacaoFreteSmp: description: type: object required: – cep – comprimento – largura – altura – cubagem – quantidade – valorUnitario – peso – produto properties: cep: type: string description: comprimento: type: number format: double description: largura: type: number format: double description: altura: type: number format: double description: cubagem: type: number format: double description: quantidade: type: integer format: int64 description: valorUnitario: type: number format: double description: peso: type: number format: double description: produto: type: string description: cotacaoFreteRetorno: description: type: object required: – idCotacao – cdTransportadora – dsTransportadora – servico – transporte – peso – valor – prazoMin – prazoMax – diasUteis properties: idCotacao: type: integer format: int64 description: cdTransportadora: type: integer format: int64 description: dsTransportadora: type: string description: servico: type: string description: transporte: type: string description: peso: type: number format: double description: valor: type: number format: double description: prazoMin: type: integer format: int64 description: prazoMax: type: integer format: int64 description: diasUteis: type: boolean description: pedidoCancelaSaldo: description: type: object required: – cnpjEmpresa – cdCliente – nuPedidoOrigem – novoSaldo properties: cnpjEmpresa: type: string description: cdCliente: type: string description: nuPedidoOrigem: type: string description: novoSaldo: type: number format: double description: pedidoRecord: description: type: object required: – codigoEmpresa – codigoTransportadora – pedido – nota – serie – chaveAcesso – dtEmissao – documentoCliente properties: codigoEmpresa: type: integer format: int64 description: codigoTransportadora: type: integer format: int64 description: pedido: type: string description: nota: type: integer format: int64 description: serie: type: string description: chaveAcesso: type: string description: dtEmissao: type: string description: documentoCliente: type: string description: servicoRecord: description: type: object properties: idTipoServico: type: string description: dsTipoServico: type: string description: pesoReal: type: number format: double description: totalServico: type: number format: double description: tipoImposto: type: string description: issBase: type: number format: double description: issPercentual: type: number format: double description: issValor: type: number format: double description: icmsBase: type: number format: double description: icmsPercentual: type: number format: double description: icmsValor: type: number format: double description: fretePeso: type: number format: double description: freteValor: type: number format: double description: catSec: type: number format: double description: incrementoTransporteRodoviario: type: number format: double description: despacho: type: number format: double description: pedagio: type: number format: double description: ademe: type: number format: double description: cfop: type: string description: dtServico: type: string description: dtEmissao: type: string description: fracaoAgrupadoPercentual: type: number format: double description: fracaoAgrupadoValor: type: number format: double description: descontoAgrupadoValor: type: number format: double description: entradaDocFrete: description: type: object required: – nu_pedido_origem properties: nu_pedido_origem: type: integer format: int64 description: saidaFat: description: type: object required: – id_mensagem properties: cd_empresa: type: string description: cd_transportadora: type: string description: nu_conhecimento: type: string description: nu_serie_conhecimento: type: string description: dt_emissao: type: string description: chave_acesso_cte: type: string description: id_acao_documento: type: string description: id_tipo_conhecimento: type: string description: ds_tipo_rota: type: string description: vlr_total_frete: type: string description: vlr_total_servico: type: string description: id_diferenca: type: string description: id_tipo_diferenca: type: string description: vlr_diferenca: type: string description: protocolo_autorizacao: type: string description: nm_arquivo_conemb_entrada: type: string description: dt_conemb_entrada: type: string description: nm_arquivo_prefat: type: string description: dt_arquivo_frefat: type: string description: nm_arquivo_conemb_saida: type: string description: dt_arquivo_conemb_saida: type: string description: id_aceite: type: string description: nm_funcionario_g7_aceite: type: string description: dt_aceite: type: string description: hr_aceite: type: string description: id_liberado: type: string description: nm_funcionario_g7_liberacao: type: string description: dt_liberacao: type: string description: hr_liberacao: type: string description: nu_faturamento: type: string description: dt_faturamento: type: string description: hr_faturamento: type: string description: id_interface: type: string description: dt_interface: type: string description: hr_interface: type: string description: ps_real: type: string description: vlr_frete_peso: type: string description: vlr_frete_valor: type: string description: vlr_pedagio: type: string description: vlr_itr: type: string description: vlr_cat_sec: type: string description: vlr_despacho: type: string description: vlr_ademe: type: string description: icms_base_valor: type: string description: icms_perc: type: string description: icms_valor: type: string description: cfop: type: string description: dt_emissao_nf: type: string description: nu_nota_fiscal: type: string description: nu_serie_nf: type: string description: nu_pedido_origem: type: string description: id_fretefaturamento: type: string description: id_empresa: type: string description: id_transportadora: type: string description: id_mensagem: type: string description: saidaDocFrete: description: type: object required: – id_mensagem properties: id_documentoFrete: type: string description: cd_empresa: type: string description: nu_pedido_origem: type: string description: cd_situacao: type: string description: ds_situacao: type: string description: cd_cliente: type: string description: ds_abrev_cliente: type: string description: nm_cliente: type: string description: cd_cliente_erp: type: string description: tp_pedido: type: string description: ds_tp_pedido: type: string description: cd_transp_origem: type: string description: ds_transp_origem: type: string description: chave_acesso: type: string description: nu_nota_fiscal: type: string description: nu_serie_nf: type: string description: vlr_nota_fiscal: type: string description: dt_emissao_nf: type: string description: cfop: type: string description: nu_romaneio: type: string description: cd_tipo_entrega: type: string description: ds_tipo_entrega: type: string description: ps_real: type: string description: ps_cubado: type: string description: qt_volume: type: string description: cd_transportadora: type: string description: ds_transportadora: type: string description: vlr_frete_documento_frete: type: string description: qt_dias_entrega: type: string description: dt_entrega: type: string description: dt_limite_entrega: type: string description: dt_previsao_entrega: type: string description: dt_efetiva_entrega: type: string description: dt_previsao_devolucao: type: string description: dt_efetiva_devolucao: type: string description: nu_documento_corp: type: string description: id_agrupamento: type: string description: id_dedicado: type: string description: nu_objeto_postagem: type: string description: id_tipo_cliente: type: string description: ds_tipo_cliente: type: string description: nu_cgc_cpf: type: string description: nu_inscricao: type: string description: fis_uid: type: string description: diametro_volume: type: string description: vlr_frete_receber: type: string description: cd_param_tabela_frete: type: string description: cd_tabela_frete: type: string description: id_periodo: type: string description: id_pi_enviado: type: string description: dt_pi_enviado: type: string description: ds_protocolo_pi: type: string description: dt_addrow: type: string description: vl_altura: type: string description: vl_largura: type: string description: vl_comprimento: type: string description: pedido_agrupado: type: string description: nu_agrupador_pedido: type: string description: id_recalcular_origem: type: string description: id_frete_dedicado: type: string description: vl_calculado: type: string description: qtd_pecas: type: string description: nu_transporte: type: string description: ps_liquido: type: string description: ps_liquido_canhoto: type: string description: data_entrega_canhoto: type: string description: cd_produto_categoria: type: string description: ds_produto_categoria: type: string description: ds_tipo_carga: type: string description: dt_fechamento: type: string description: ds_cidade: type: string description: sg_uf: type: string description: cd_rota: type: string description: ds_rota: type: string description: nm_funcionario_integracao: type: string description: observacao: type: string description: id_agendamentonumber: type: string description: ps_excedente: type: string description: vlr_frete_tabela_frete_aplic: type: string description: vlr_excedente: type: string description: id_perc_tx_gris: type: string description: vlr_tx_gris: type: string description: vlr_gris: type: string description: id_perc_tx_ad_valoren: type: string description: vlr_tx_ad_valoren: type: string description: vlr_ad_valoren: type: string description: vlr_aviso_recebimento: type: string description: vlr_envio_ocorrencia: type: string description: vlr_pedagio_fracao: type: string description: vlr_pedagio: type: string description: vl_carga_descarga: type: string description: vlr_despacho: type: string description: id_perc_tx_reentrega: type: string description: vlr_tx_reentrega: type: string description: qt_reentrega: type: string description: vlr_reentrega: type: string description: vlr_min_reentrega: type: string description: id_perc_tx_devolucao: type: string description: vlr_tx_devolucao: type: string description: qt_devolucao: type: string description: vlr_devolucao: type: string description: vlr_min_devolucao: type: string description: vlr_itr: type: string description: vlr_tde: type: string description: vlr_cto: type: string description: vlr_ademe: type: string description: vlr_sefaz: type: string description: vlr_outros: type: string description: perc_transportadora: type: string description: id_perc_tx_seg_fluvial: type: string description: vlr_tx_seg_fluvial: type: string description: vlr_seg_fluvial: type: string description: id_perc_tx_desemb_suframa: type: string description: vlr_tx_desemb_suframa: type: string description: vlr_desemb_suframa: type: string description: id_perc_tx_trt: type: string description: vlr_tx_trt: type: string description: id_perc_tx_trf: type: string description: vlr_tx_trf: type: string description: id_perc_tx_adm: type: string description: vlr_tx_adm: type: string description: id_perc_tx_tad: type: string description: vlr_tx_tad: type: string description: id_contribuinte_icms: type: string description: tp_imposto: type: string description: icms_base_valor: type: string description: icms_perc: type: string description: icms_valor: type: string description: iss_base_valor: type: string description: iss_perc: type: string description: iss_valor: type: string description: tde_erp: type: string description: id_tabelafretecondicao: type: string description: ds_condicao: type: string description: qtd_dias_estadia: type: string description: qtd_horas_estadia: type: string description: vlr_dia_estadia: type: string description: vlr_hora_estadia: type: string description: base_icms_estadia: type: string description: vlr_icms_estadia: type: string description: vlr_estadia_calculado: type: string description: id_tabelafreteaplicada: type: string description: tp_dif_audit_peso: type: string description: vlr_dif_audit_peso: type: string description: vlr_desc_audit_peso: type: string description: vlr_excedente_nf: type: string description: id_perc_tx_medidas: type: string description: vlr_tx_medidas: type: string description: base_tx_medidas: type: string description: id_mensagem: type: string description: saidaTracking: description: type: object required: – id_mensagem properties: cd_empresa: type: string description: nm_empresa: type: string description: tp_pedido: type: string description: nu_pedido_origem: type: string description: nu_nota_fiscal: type: string description: nu_serie_nf: type: string description: cd_transportadora: type: string description: ds_transportadora: type: string description: vlr_nota_fiscal: type: string description: dt_emissao_nf: type: string description: id_transportadora: type: string description: id_documentofrete: type: string description: id_empresa: type: string description: id_cliente: type: string description: dt_addrow: type: string description: cd_motivo_retorno: type: string description: ds_motivo_retorno: type: string description: dt_atualizacao: type: string description: dias_sem_ocorrencia: type: string description: dt_previsao_entrega: type: string description: sg_uf: type: string description: status_audit_peso: type: string description: data_entrega_canhoto: type: string description: id_mensagem: type: string description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: object allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: object 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: object 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. 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