Presence API ECOMMERCE - ECM-DADOS-NF

Presence API ECOMMERCE - ECM-DADOS-NF

ECM-DADOS-NF (header)

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.
codigo_externo
Não
Texto(100)Código interno do E-commerce quando criado no plataforma
serie
Não
Inteiro
Série interna do Presence Domain (normalmente número da Loja)
numero
Sim quando informada a serie
Inteiro
Número interno do Presence Domain


BODY
  1. {
  2.   "id_webservice": (Integer),
  3.   "data_at" : (Date, AAAA-MM-DD) ou (Date, AAAA-MM-DDT00:00:00)
  4. }
OU
  1. {
  2.   "id_webservice": (Integer),
  3.   "codigo_externo" : String(100)
  4. }
OU
  1. {
  2.   "id_webservice": (Integer),
  3.   "serie" : (Integer),
  4.   "numero" : (Integer)
  5. }

JSON de Retorno

Nome
Tipo
Descrição
lojaPresence
Char(2)
Código da loja no Presence Domain
ecmIdLoja
String
ID Loja configurado nos atributos de Loja.
seriepedido*StringSérie do pedido
numeroPedido *IntegerNúmero do pedido
codigoPedidoExterno*IntegerCódigo do pedido na plataforma
dtTransmissaoData (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
dtMovData (AAAA-MM-DDT00:00:00)Data de movimentação. Padrão ISO8601.
controleIntegerControle interno da Nota Fiscal
terminalIntegerTerminal de faturamento
valortotalReal Valor total da Nota Fiscal

*tags fora de uso. Utilizar essas mesmas tags do grupo Itens.
  1. {
  2.     "status": "ok",
  3.     "serverTime": "2022-07-27T06:11:52.946Z",
  4.     "versionCode": 1,
  5.     "method": "ECM-DADOS_NF",
  6.     "data": [
  7.         {
  8.             "lojaPresence": "99",
  9.             "ecmIdLoja": "ID_99",
  10.             "seriepedido": 0,
  11.             "numeropedido": 3184,
  12.             "dtTransmissao": "2021-11-27 09:52:32.000",
  13.             "codigopedidoexterno": "1_210079",
  14.             "modeloNf": "55",
  15.             "serieNf": "12",
  16.             "subserieNf": "",
  17.             "numero": 4,
  18.             "chaveAcesso": "35211162014808002129550120000000041000100600",
  19.             "codigoRastreio": "",
  20.             "codTransportadora": 6624,
  21.             "modoTransporte": "1",
  22.             "codigoExterno": "1",
  23.             "nomeFantasia": "AVIAT CARGO EXPRESS",
  24.             "razaoSocial": "AVIAT CARGO EXPRESS TRANSPORTES LTDA.",
  25.             "cnpj": "17452926000110",
  26.             "inscricaoEstadual": "796.063.575.115",
  27.             "email": "CLEBER@AVIATCARGO-EXPRESS.COM.BR",
  28.             "status": "Ativo",
  29.             "dddTelefone": "11",
  30.             "telefone": "24635191",
  31.             "dddCelular": "11",
  32.             "celular": "940152882",
  33.             "dddFax": "11",
  34.             "fax": "",
  35.             "cep": "07196220",
  36.             "endereco": "AV BOM CLIMA",
  37.             "complemento": "",
  38.             "bairro": "JARDIM BOM CLIMA",
  39.             "cidade": "GUARULHOS",
  40.             "estado": "SP",
  41.             "pais": "BRASIL",
  42.             "dataAtualizacao": "2022-01-24 13:50:41.000",
  43.             "idProcesso": 15,
  44.             "pk": "1_210079&55&12&4",
  45.             "loja": "99",
  46.             "dtMov": "2022-01-24 13:50:41.000",
  47.             "controle": 39104,
  48.             "terminal": 0,
  49.             "valorTotal": 124.80
  50.         }
  51.     ]
  52. }

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.




    • Related Articles

    • 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ão Data (AAAA-MM-DDT00:00:00) Data de atualização dos dados. Padrão ...

    • Presence API - INCLUIR_PRODUTO

      Inclusão de Produtos (Atualização e Inclusão) Este módulo é responsável por incluir produtos na base da dados. Parâmetros Campos Tipo Obrigatório Descrição codigo string(8) Não para inclusão, sim para alteração, quando codigoExterno ou codigoLegado ...

    • Presence API - Página Inicial

      Essa API permite o consumo de informações disponíveis nos sistemas Presence através de chamadas de serviço, bem como a inserção de dados nos sistemas. Para ter acesso aos métodos já existentes, ou solicitação da criação de novos métodos, consulte as ...

    • Presence API - NFE

      Nota Fiscal Este módulo é responsável por listar as notas fiscais da base da dados. Parâmetros Nome Obrigatório Tipo Descrição data_at SIM quando não informado demais campos. Data (AAAA-MM-DDT00:00:00) Data de atualização dos dados. Padrão ISO8601. ...

    • Presence API - INCLUIR_PEDIDO

      Inclusão de Pedidos (Somente Inclusão) Este módulo é responsável por incluir pedidos na base da dados. BODY Pedido Nome Obrigatório Tipo Descrição codigoPedidoExterno Sim String Código do pedido na plataforma dataEmissão Não Data ...