INTEGRAÇÃO
Operações
HISTÓRICO DE ATUALIZAÇÕES
Cliente
Busca informações sobre clientes de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Listar informações do Cliente autenticado
-
Credenciais necessárias: cliente.
-
Entidades relacionadas: –
Busca informações do cliente atualmente autenticado em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Criar um novo Cliente
-
Credenciais necessárias: administrador ou autenticação padrão (veja nossa seção de “Autenticação” para mais informações).
-
Entidades relacionadas: –
Cria um novo cliente em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Quando se utilizando da autenticação de administrador, este endpoint permite a criação de um cliente com menos informações do que quando requerido utilizando-se da autenticação padrão. Isto ocorre por que o endpoint que se utiliza da autenticação padrão remete à operação do cadastro regular de um cliente na loja em questão, enquanto o endpoint que se utiliza da autenticação de administrador remete à criação de um cliente por um administrador.
A criação de um novo cliente por um administrador requer menos dados pois muitas vezes o lojista obtém os dados dos clientes via telefone ou outros meios de comunicação nos quais não é comum requerir dados como documento (CPF), entre outros.
Editar informações de um Cliente
-
Credenciais necessárias: administrador ou cliente.
-
Entidades relacionadas: –
Edita informações sobre um cliente de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Nenhum destes endpoints (tanto na visão do administrador quanto na do cliente) permite a atualização da senha de um determinado cliente. Para realizar esta operação, consultar o endpoint de atualização de senha de um cliente.
Atualiza a senha do cliente atualmente autenticado em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Apaga um cliente de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Listar estatísticas de um Cliente de uma determinada Loja
-
Credenciais necessárias: administrador.
-
Entidades relacionadas: –
Busca informações sobre estatísticas de um cliente de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Listar preferências de campanhas do Cliente autenticado
-
Credenciais necessárias: cliente.
-
Entidades relacionadas: –
Busca informações sobre as preferências de campanhas de um cliente de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Estas preferências são referentes à possibilidade do cliente receber determinadas notificações de campanhas emitidas pela loja, como por exemplo de promoções da loja. Estas notificações podem ser emitidas para o aplicativo da loja (caso o cliente o tenha), ou por e-mail. É possível que o cliente decida por não receber tais notificações.
Editar preferências de campanhas do Cliente autenticado
-
Credenciais necessárias: cliente.
-
Entidades relacionadas: –
Edita informações sobre as preferências de campanhas de um cliente de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Estas preferências são referentes à possibilidade do cliente receber determinadas notificações de campanhas emitidas pela loja, como por exemplo de promoções da loja. Estas notificações podem ser emitidas para o aplicativo da loja (caso o cliente o tenha), ou por e-mail. É possível que o cliente decida por não receber tais notificações.
Listar os últimos Pedidos do Cliente autenticado
-
Credenciais necessárias: cliente.
-
Entidades relacionadas: Pedido.
Busca informações sobre os últimos pedidos feitos por um cliente em uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Listar Endereços de Entrega de um Cliente
-
Credenciais necessárias: administrador ou cliente.
-
Entidades relacionadas: Endereço de Entrega.
Busca informações dos endereços de entrega de um cliente de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Na visão do administrador, busca-se um cliente por seu id, enquanto na visão do cliente, busca-se as informações do cliente atualmente autenticado.
Criar um novo Endereço de Entrega para um Cliente
-
Credenciais necessárias: administrador ou cliente.
-
Entidades relacionadas: Endereço de Entrega.
Cria um novo endereço de entrega para um cliente de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
O comportamento desta operação difere entre as visões de administrador e de cliente.
Para a visão do administrador, basta utilizar-se do endpoint em questão, passando o endereço de entrega como parâmetro, e este será automaticamente associado ao cliente em questão.
Para a visão do cliente, no entanto, é necessário primeiro utilizar-se do endpoint de criação de endereço de entrega, e então utilizar-se do endpoint de associação de endereço de entrega com cliente para ligá-los.
Apagar um Endereço de Entrega de um Cliente
-
Credenciais necessárias: administrador ou cliente.
-
Entidades relacionadas: Endereço de Entrega.
Apaga endereço de entrega para de cliente de uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição).
Listar os Endereços de Entrega do Cliente nos quais uma determinada Loja realiza entregas
-
Credenciais necessárias: cliente.
-
Entidades relacionadas: Endereço de Entrega, Loja.
Lista os endereços de entrega de um cliente para os quais uma determinada loja (determinada pelo parâmetro X-DeliveryDireto-ID enviado pelos headers da requisição) consegue realizar pedidos da modalidade entrega.
Listar Cartões de Crédito cadastrados pelo Cliente
-
Credenciais necessárias: cliente.
-
Entidades relacionadas: Cartão de Crédito.
Lista informações sobre cartões de crédito de um determinado usuário.
Não são inclusas informações sensitivas sobre cartões de crédito neste endpoint. É enviado, também, o endereço de cobrança associado a cada cartão de crédito.
Criar Cartão de Crédito para um Cliente
-
Credenciais necessárias: cliente.
-
Entidades relacionadas: Cartão de Crédito.
Cria um novo cartão de crédito para um determinado usuário.
Apagar Cartões de Crédito cadastrados pelo Cliente
-
Credenciais necessárias: cliente.
-
Entidades relacionadas: Cartão de Crédito.
Apaga informações sobre cartões de crédito de um determinado usuário.
Estes endpoints são utilizados para obter informações sobre os clientes de uma loja, e operar sobre os mesmos.
Este conjunto de endpoints contempla todas as operações referentes a clientes de uma determinada loja. Para estas operações, é importante ter em vista o tipo de autenticação utilizado. Podemos observar as operações tanto do ponto de vista do administrador de uma loja, quanto do ponto de vista do cliente de uma loja, e dependendo do ponto de vista a forma com que a operação deve ser realizar pode mudar. Por exemplo: a criação de um novo cliente para uma determinada loja possui um conjunto de dados maior quando pelo ponto de vista do cliente, comparativamente a quando realizamos a operação do ponto de vista de um administrador.
É importante a consulta à referência da API da loja e da API do admin para entender os parâmetros necessários para cada tipo de operação. Para esta documentação, agrupamos as operações que são semânticamente similares, e denotamos quando houver distinção entre uma operação sendo feita do ponto de vista de um administrador ou de um cliente.