Nessa área encontraremos os métodos disponibilizados na plataforma CORE para haver a gestão de lista de desejos através de sistemas externos onde poderá realizar a criação de lista, gestão, atualização, exclusão da lista de desejo.

URL de acesso: /v1/Profile/API.svc/web/

 

Criar/Atualizar Lista de Desejos

SaveWishlist

/v1/Profile/API.svc/web/SaveWishlist

Método usado para criar/atualizar uma determinada lista de desejo.

Parâmetros de entrada Tipo Descrição
CustomerID Int Identificação do cliente.
DeliveryAddressID Int ID do endereço do cliente
Description String Descrição da lista de desejo.
EndPurchaseDate Data Data de validade da lista. Padrão timestamp.
Hash GUID  
IsActive Bool  
Name String Nome da Lista de desejo
Password String Senha da lista de desejo
PrivacyType Bit Determina se a lista é pública ou não.
PurchasingBehavior    
WishlistDefinitionID Int ID da definição da lista de desejo.
WishlistID Int ID da lista de desejo. 
{
    
    "CustomerID":252679,
    "DeliveryAddressID":134348,
    "Description":"String content",
    "EndPurchaseDate":"/Date(1543525421000)/",
  "Hash":"1627aea5-8e0a-4371-9022-9b504344e724",
    "IsActive":true,
    "Name":"ListaViaLayer",
    "Password":"layer",
    "PrivacyType":0,
    "PurchasingBehavior":0,
    "WishlistDefinitionID":1,
    "WishlistID":19
    
}

Os campos Hash e WishlistID devem ser informados como parâmetro de entrada somente em caso de atualização da lista de desejo, caso contrário, o parâmetro não deve ser informado na criação.


Consultar Lista de desejo

SearchWishlist

/v1/Profile/API.svc/web/SearchWishlist

Método usado para buscar um registro de uma determinada lista de desejo.

Parâmetros de entrada Tipo Descrição
PageIndex Int Página a ser buscada, o padrão é 0 (zero).
PageSize Int Quantidade por página.
Where String Parâmetro da Busca. Pode ser utilizado o modifiedDate de uma lista ou os outros parâmetros listados no Swagger.
OrderBy String Ordenação da Busca.

Realizando um filtro por e-mail:

{
    
    "Page":{
        "PageIndex":0,
        "PageSize":13
    },
    "Where": "Email == "[email protected]"",
    "OrderBy":"WishlistID desc"
}

Realizando um filtro pela data de modificação da lista:

{
    
    "Page":{
        "PageIndex":0,
        "PageSize":13
    },
    "Where": "ModifiedDate == /Date(1603368771127-0300)/", 
    "OrderBy":"WishlistID desc"
}

Adicionar Produtos à lista de desejo

AddProductsToWishlist

/v1/Profile/API.svc/web/AddProductsToWishlist

Método usado para inserir um produto em uma determinada lista de desejo.

Parâmetros de entrada Tipo Descrição
CustomerID Int Identificação do cliente.
WishlistID Int ID da lista de desejo.
NestedItens String  
ProductID Int ID do Produto
Quantity Int Quantidade do SKU do produto a ser inserido.
SkuID Int ID do SKU
WebSiteID Int ID do Canal 
{
    "CustomerID":252679,
    "WishlistID":19,
    "WishlistProducts":[{
        "NestedItens":"produtoteste",
        "ProductID":984955,
        "Quantity":10,
        "SkuID":984963,
        "WebSiteID":1
    }]
}

Deletar produto da lista de desejo

DeleteProductsFromWishlist

/v1/Profile/API.svc/web/DeleteProductsFromWishlist

Método usado para deletar produto em uma determinada lista de desejo.

Parâmetros de entrada Tipo Descrição
CustomerID Int Identificação do cliente.
WishlistID Int ID da lista de desejo.
WishlistProductIDs Int ID do produto da lista. 
{
    "CustomerID":2147,
    "WishlistID":2147,
    "WishlistProductIDs":[2147]
}

WishlistProductIDs não é o ID do produto inserido no método AddProductsToWishlist e, sim, o ID que recebe no response do método já citado. Também é possível obter essa identificação através do método SearchWishlist .

Deletar lista de desejo

DeleteWishlist

/v1/Profile/API.svc/web/DeleteWishlist

Método usado para deletar uma determinada lista de desejo.

Parâmetro de entrada Tipo Descrição
WishlistID Int Id da lista de desejo 
{
    "WishlistID":2147
}
  • Sem rótulos