Presence API ECOMMERCE - ECM-RESULTADO-PROCESSAMENTO

ECM-RESULTADO-PROCESSAMENTO

Objetivo desse endpoint é informar ao ERP, quando aplicável:

1. Sucesso no envio da informação;
   
2. Código externo de novo registro cadastrado na plataforma (quando a
   
3. Erros encontrados na integração.

É possível enviar uma lista de sucessos e falhas, em formato de array.

Parâmetros de entrada:

Nome	Obrigatório	Tipo	Descrição
id_webservice	SIM	Integer	Id do webservice
idProcesso	SIM	Integer	Id do processo sendo reportado (esse id é retornado junto à consulta dos dados)
metodo	SIM	String	Nome do método reportado
pk	SIM	String	PK do registro reportado
codigo_externo	SIM	String	Código externo do registro reportado
erro	SIM, se for erro	String	Descrição do erro. Sugestão, reportar no formato: Descrição amigável do erro [Descrição do erro devolvido pelo endpoint]
codigo_erro	SIM, se for erro	Integer	Status code retornado pelo endpoint

BODY        

1. {
2.     "id_webservice": (Integer),
3.     "idProcesso": (Integer),
4.     "metodo": (String),
5.     "sucessos": [
6.         {
7.             "pk": (String),
8.             "codigo_externo": (String)
9.         }
10.     ],
11.     "erros": [
12.         {
13.             "erro": (String),
14.             "codigo_erro": (Integer),
15.             "codigo_externo": (String),
16.             "pk": (String)
17.         }
18.     ]
19. }

Exemplo com dados preenchidos

1. {
2.     "id_webservice": 995,
3.     "idProcesso": 5,
4.     "metodo": "ECM-PRODUTOS",
5.     "sucessos": [
6.         {
7.             "pk": "0063303",
8.             "codigo_externo": "123456"
9.         },
10.         {
11.             "pk": "0063302",
12.             "codigo_externo": "654321"
13.         }
14.     ],
15.     "erros": [
16.         {
17.             "erro": "Produto não localizado.",
18.             "codigo_erro": "404",
19.             "codigo_externo": "",
20.             "pk": "0063304"
21.         }
22.     ]
23. }

1. JSON de Retorno
2. {
3.     "status": (String),
4.     "serverTime": (Date  "AAAA-MM-DDT00:00:00.000Z")
5.     "method": (String),
6.     "data": []
7. }
   

Orientações importantes

1. Todos os métodos de consulta de dados tem um campo "pk" adicionado no retorno, além de um novo campo "idProcesso";
2. Esses campos deverão ser enviados no ECM-RESULTADO-PROCESSAMENTO, para identificar o registro correspondente.

Algumas entidades de consulta tem chave composta, por isso estamos retornando esse "pk" com um identificador único. Para identificar qual registro deu erro na escrito na Plataforma, basta copiar o valor de "pk" recebido da Presence e enviar no ECM-RESULTADO-PROCESSAMENTO. O mesmo vale para "idProcesso". Basta copiar o valor recebido da Presence e enviar no ECM-RESULTADO-PROCESSAMENTO.

<< voltar para página principal

• Related Articles

• Presence API ECOMMERCE - ECM-WAREHOUSES

  ECM-WAREHOUSES Este método é responsável por listar as Warehouses da base da dados. Parâmetros Nome Obrigatório Tipo Descrição id_webservice SIM Inteiro Id do webservice  dataAt  NÃO  Data (AAAA-MM-DDT00:00:00)  Data da ultima alteração do registro ...

• Presence API ECOMMERCE - ECM-WAREHOUSES-OMNI

  ECM-WAREHOUSES-OMNI Este método é responsável por listar as Warehouses da base da dados. Parâmetros Nome Obrigatório Tipo Descrição id_webservice SIM Inteiro Id do webservice  dataAt  NÃO  Data (AAAA-MM-DDT00:00:00)  Data da ultima alteração do ...

• 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 ECOMMERCE - ECM-PRODUTOS (completo)

  Cadastro de Produtos Este método é responsável por listar os produtos da base da dados. Para os dados retornarem corretamente, o Endpoint de chamada é diferente, deve-se utilizar a seguinte URL: ...

• Presence API ECOMMERCE - ECM-PRECOS-SKU

  Cadastro de Preços por Sku Este método é responsável por listar os preços do produtos/sku da base da dados. Parâmetros Nome Obrigatório Tipo Descrição id_webservice SIM Integer Id do webservice referencia_site SIM quando não informado data_at String ...