Métodos Cliente no REST

ti1 · March 21, 2018, 6:13pm

Na documentação não encontramos na seção de API os métodos para Cliente, exemplo:

ClientGetByEmailV3

ClientGetByCPF

ClientGet

...

E também não foi localizado o método atualizar status (UpdateNotifyShipping).

nathan · March 21, 2018, 8:36pm

GET List Orders

https://documenter.getpostman.com/view/487146/vtex-oms-api/6tjSKqi#209cb0dd-4877-4db8-a372-95173f49be07

No caso do CPF, creio que seja: ?document={cpf}

ti1 · March 22, 2018, 12:22pm

Olá @Nathan Prestes obrigado pela reposta mas o problema que precisamos do método do Cliente (cadastrar/alterar) que não esteja atrelado a um pedido. Porque o OMS é referente a pedidos e não pessoas.

E não encontrei na documentação da VTEX sobre essa questão.

eduardo.turconi · March 22, 2018, 5:10pm

Os clientes são armazenados como documentos no MasterData.

Pode usar a API MasterData para alterá-los: https://documenter.getpostman.com/view/164907/master-data-api-v2-beta/7EHbXTe

ti1 · March 22, 2018, 7:45pm

Muito obrigado pela ajuda @Eduardo Turconi .Realizei alguns testes e cheguei nessa conclusão:

Procurar documento CL:
http://{nomeEcommerce}.{vtex}.com.br/api/dataentities/CL/search?email=email@email.com.br
 
[
    {
    "email":"email@email.com.br",
    "id":"22222222222222222222222",              //Esse é o id do CL
    "accountId":"111111111111111111111111",
    "accountName":"nomeEcommerce",
    "dataEntityId":"CL"
  }
]
 
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
Procurar documento AD:
http://{nomeEcommerce}.{vtex}.com.br/api/dataentities/AD/search?userId=22222222222222222222222
 
[
    {
    "addressName":"-xxxxxxxxxxxxxx",
    "userId":"22222222222222222222222",    //Esse é o id do CL
    "id":"3333333333333333333333333",            //Esse é o id do AD
    "accountId":"111111111111111111111111",
    "accountName":"nomeEcommerce",
    "dataEntityId":"AD"
  }
]
 
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
Método GET Document CL: (precisa ser exatamente _fields=_all para retornar todos os campos)
 
http://{nomeEcommerce}.{vtex}.com.br/api/dataentities/CL/documents/22222222222222222222222?_fields=_all
 
 
{
...dados...
  [
      ]
,
  "tags":
  [
      ]
,
  "auto_filter":null
}
 
 
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
Método GET Document AD: (precisa ser exatamente _fields=_all para retornar todos os campos)
 
http://{nomeEcommerce}.{vtex}.com.br/api/dataentities/AD/documents/3333333333333333333333333?_fields=_all
 
 
{
  ...dados...
  [
      ]
,
  "tags":
  [
      ]
,
  "auto_filter":null
}

Existe uma forma mais prática para acessar todos os dados do cliente através do e-mail ou cpf sem precisar executar 4 métodos?

eduardo.turconi · March 22, 2018, 8:51pm

Acho que tu poderia usar:

http://{loja}.vtexcommercestable.com.br/api/dataentities/CL/search?email={email}&_fields=_all

ou

http://{loja}.vtexcommercestable.com.br/api/dataentities/CL/search?document={cpf}&_fields=_all

nathan · March 22, 2018, 10:06pm

Ahhh sim, neste caso você utilizar o MASTER DATA V1 para resgatar dados/alterar do cliente:

GET Search documents

http://api.vtex.com/{{accountName}}/dataentities/{{acronym}}/search

Onde {{acronym}} = CL

Entidade responsável pelo cadastro do CLiente.

https://documenter.getpostman.com/view/164907/masterdata-api-v102/2TqWsD#a0c7c05c-74f9-4367-aaae-5c2bd6cf5b18

Na documentação tem vários filtros que você pode utilizar.

ti1 · March 23, 2018, 11:24am

Obrigado pelas respostas @Nathan Prestes e @Eduardo Turconi .