Presence API ECOMMERCE - ECM-DADOS-NF (completo)

Presence API ECOMMERCE - ECM-DADOS-NF (completo)

ECM-DADOS-NF

Este método é responsável por listar as Notas Fiscais na base da dados.

Parâmetros

Nome
Obrigatório
Tipo
Descrição
id_webservice
SIM
Inteiro
Id do webservice
data_at
NãoData (AAAA-MM-DDT00:00:00)
Data de atualização dos dados. Padrão ISO8601.
serie_nf
Não
Inteiro
Série da Nota Fiscal
numero_nf
Sim quando informada a serie
Inteiro
Número da Nota fiscal
codigo_externo
Não
Texto(100)
Código interno do pedido na plataforma
serie
Não
Inteiro
Série do pedido
numero
Sim quando informada a serie
Inteiro
Número do pedido
exibirItens 
 Não
 Boolean
Apresentar os itens da Nota Fiscal

MÉTODOS DE BUSCA

Por data de atualização da Nota Fiscal (podem ser retornadas várias Notas Fiscais);

BODY
  1. {
  2.   "id_webservice": (Integer),
  3.   "data_at" : (Date, AAAA-MM-DD) ou (Date, AAAA-MM-DDT00:00:00)
  4. }

Por série e número da Nota Fiscal (será retornada uma Nota Fiscal);

BODY
  1. {
  2.   "id_webservice": (Integer),
  3.   "serie_nf" : (Integer),
  4.   "numero_nf" : (Integer)
  5. }

Por código externo do pedido (podem ser retornadas várias Notas Fiscais);

BODY
  1. {
  2.   "id_webservice": (Integer),
  3.   "codigo_externo" : (Texto(100))
  4. }

Por série e número do pedido (podem ser retornadas várias Notas Fiscais);

BODY
  1. {
  2.   "id_webservice": (Integer),
  3.   "serie" : (Integer),
  4.   "numero" : (Integer)
  5. }

JSON de Retorno

Nome
Tipo
Descrição
seriepedido*
String
Série do pedido
numeroPedido *
Integer
Número do pedido
codigoPedidoExterno*
Integer
Código do pedido na plataforma
dtTransmissao
Data (AAAA-MM-DDT00:00:00)
Data de atualização dos dados. Padrão ISO8601
modeloNF
String
Modelo da NF-e
serieNF
String
Serie da NF-e
subserieNF
String
Subsérie da NF-e
numero
Integer
Numero da nota fiscal eletrônica
ChaveAcesso
String
Chave de acesso da NF-e
codigoRastreio
String
 Código de Rastreio do envio
codTransportadora
String
Código da transportadora
modoTransporte
String
Modalidade de transporte
codigoExterno
String
Código interno da transportadora na plataforma
nomeFantasia
String
Nome fantasia da transportadora
razaoSocial
String
Razão social da transportadora
cnpj
String
CNPJ da transportadora
inscricaoEstadual
String
I.E da transportadora
email
String
E-mail
status
String
Situação do cadastro(Ativo/Inativo)
dddTelefone
String
DDD do telefone fixo
telefone
String
Número do telefone fixo
dddCelular
String
DDD do Celular
celular
String
Número do Celular
dddFax
String
DDD do fax
fax
String
Número do fax 
cep
String
CEP
endereco
String
Logradouro do cliente
complemento
String
Complemento do endereço
bairro
String
Nome do Bairro
cidade
String
Nome da Cidade
estado
String
Nome do Estado
país
String
País
Loja
Char (2)
Código da Loja
dtMov
Data (AAAA-MM-DDT00:00:00)
Data de movimentação. Padrão ISO8601.
controle
Integer
Controle interno da Nota Fiscal
terminal
Integer
Terminal de faturamento
valortotal
Real
 Valor total da Nota Fiscal

*tags fora de uso. Utilizar essas mesmas tags do grupo Itens.

Se parâmetro exibirItens = True

Nome
Tipo
Descrição

sku 
String
Código SKU do produto
codigoSkuExterno 
String
Código interno do SKU na plataforma
preco
Real
Preço no produto na Nota Fiscal
quantidadeFaturada 
String
Quantidade faturada do item/pedido na Nota Fiscal
seriepedido
String
Série do pedido
numeroPedido 
Integer
Número do pedido
codigoPedidoExterno
Integer
Código do pedido na plataforma
situacao
Integer
Código da situação do pedido
descricaoSituacao
String
Descrição da situação do pedido
SaldoPedido
String
Saldo em aberto do item no pedido


  1. {
  2.     "status": "ok",
  3.     "serverTime": "2022-07-27T06:11:52.946Z",
  4.     "versionCode": 1,
  5.     "method": "ECM-DADOS_NF",
  6.     "data": [
  7.         {
  8.             "dtTransmissao": "2021-11-27 09:52:32.000",
  9.             "seriepedido": 0,
  10.             "numeropedido": 3184,
  11.             "codigopedidoexterno": "1_210079",
  12.             "modeloNf": "55",
  13.             "serieNf": "12",
  14.             "subserieNf": "",
  15.             "numero": 4,
  16.             "chaveAcesso": "35211162014808002129550120000000041000100600",
  17.             "codigoRastreio": "",
  18.             "codTransportadora": 6624,
  19.             "modoTransporte": "1",
  20.             "codigoExterno": "1",
  21.             "nomeFantasia": "AVIAT CARGO EXPRESS",
  22.             "razaoSocial": "AVIAT CARGO EXPRESS TRANSPORTES LTDA.",
  23.             "cnpj": "17452926000110",
  24.             "inscricaoEstadual": "796.063.575.115",
  25.             "email": "CLEBER@AVIATCARGO-EXPRESS.COM.BR",
  26.             "status": "Ativo",
  27.             "dddTelefone": "11",
  28.             "telefone": "24635191",
  29.             "dddCelular": "11",
  30.             "celular": "940152882",
  31.             "dddFax": "11",
  32.             "fax": "",
  33.             "cep": "07196220",
  34.             "endereco": "AV BOM CLIMA",
  35.             "complemento": "",
  36.             "bairro": "JARDIM BOM CLIMA",
  37.             "cidade": "GUARULHOS",
  38.             "estado": "SP",
  39.             "pais": "BRASIL",
  40.             "dataAtualizacao": "2022-01-24 13:50:41.000",
  41.             "idProcesso": 15,
  42.             "pk": "1_210079&55&12&4",
  43.             "loja": "99",
  44.             "dtMov": "2022-01-24 13:50:41.000",
  45.             "controle": 39104,
  46.             "terminal": 0,
  47.             "valorTotal": 124.80
  48.             "Itens": [
  49.                 {
  50.                     "sku": "0001980108",
  51.                     "codigoskuexterno": null,
  52.                     "preco": 15.6,
  53.                     "quantidadefaturada": 4,
  54.                     "seriepedido": 0,
  55.                     "numeropedido": 3184,
  56.                     "codigopedidoexterno": "1_210079",
  57.                     "situacao": 6,
  58.                     "descricaosituacao": "Concluído",
  59.                     "saldopedido": 0
  60.                 },
  61.                 {
  62.                     "sku": "0001980208",
  63.                     "codigoskuexterno": null,
  64.                     "preco": 15.6,
  65.                     "quantidadefaturada": 4,
  66.                     "seriepedido": 0,
  67.                     "numeropedido": 3184,
  68.                     "codigopedidoexterno": "1_210079",
  69.                     "situacao": 6,
  70.                     "descricaosituacao": "Concluído",
  71.                     "saldopedido": 0
  72.                 }
  73.             ]
  74.         }
  75.     ]
  76. }

                                                                                                                                    Reporte de sucessos ou erros

                                                                                                                                    Após consulta da informação e envio para a plataforma, é necessário:
                                                                                                                                    1. Informar o sucesso da operação ao ERP;
                                                                                                                                    2. Informar erro, para dar transparência ao cliente da integração, bem como alimentar o controle de erros.
                                                                                                                                    Para reportar esse status, deverá ser utilizado o método ECM-RESULTADO-PROCESSAMENTO.

                                                                                                                                    O envio dessa sinalização é obrigatório para vinculação dos códigos Presence com códigos Plataforma, bem como para funcionamento do painel de acompanhamento de erros de integração no ERP.