Exibir origem

Nessa área encontraremos os métodos disponibilizados pela Shopping API, que permite a gestão do carrinho de um cliente. Para a identificação na API, podemos usar ShopperID, ShopperTicketID, CustomerID, BasketID e SessionID. As alterações feitas no carrinho pela shopping API de um cliente ativo já alteram o mesmo na sessão necessitando apenas de um refresh da página.

URL de acesso: /web-api/v1/Shopping/Basket/

Métodos

/GetShopperSession
- Busca um pedido pelo ID (é usado internamente nos métodos abaixo para recuperar a session).

ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
ShopperID	Guid	Identificador do visitante da loja.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.

/Get
- Busca a basket, a partir de um identificador.

ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
ShopperID	Guid	Identificador do visitante da loja.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário

/AddProduct
- Adiciona novos produtos ao carrinho de compra.

ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente.
SessionID	String	Customer da sessão do usuário.
WebSiteID	Int
FeatureID	Int
QueryString	String
Products	List	Lista de produtos.

/RemoveBasketItem
- Remove um item do carrinho de compra.

ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.
BasketItemID	Int	Identificador do item

/UpdateBasketItem
- Atualiza um item do carrinho de compra.

ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.
BasketItemID	Int	Identificador do item
Quantity	Decimal	Quantidade do item

/RemoveAll
- Remove todos os item do carrinho de compra.

Parâmetros	Tipo	Descrição
ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.

/AddAdditionalProduct
- Adiciona adicionais do produto no carrinho de compra.

Parâmetros	Tipo	Descrição
ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário
BasketItemID	Int	Identificador do item

/RemoveAdditionalProduct
- Remove adicionais do produto de um item do carrinho de compra.

Parâmetros	Tipo	Descrição
ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.
BasketItemID	Int	Identificador do item.
ProductID	Int	Identificador do produto.

/AddCustomMetadata
- Adiciona uma personalização em um item do carrinho.

Parâmetros	Tipo	Descrição
ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema
BasketID	Int	Identificador do carrinho de compra
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário
BasketItemID	Int	Identificador do item
ProductID	Int	Identificador do produto
SkuID	Int	Identificador do SKU
Metas	AddCustomMetadataItemRequest[]	Lista de objeto com os metadados a incluir.

/AddCustomMetadataItemRequest

Parâmetros	Tipo	Descrição
PropertyMetadataID	Int	Identificador do metadado (ID)
PropertyName	String	Identificador do metadado (Name)
Value	String	O Valor a ser inserido na personalização

/RemoveCustomMetadata
- Remove uma personalização de um item.

Parâmetros	Tipo	Descrição
ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.
BasketItemID	Int	Identificador do item.
ProductID	Int	Identificador do produto.
SkuID	Int	Identificador do sku.
Metas	RemoveCustomMetadataItemRequest[]	Lista de objeto com os metadados a remover

/RemoveCustomMetadataItemRequest
- Remove uma personalização de um item.

Parâmetros	Tipo	Descrição
PropertyMetadataID	Int	Identificador do metadado (ID)
PropertyName	String	Identificador do metadado (Name)

/SetPostalCode
- Adiciona um código postal ao carrinho de compra.

Parâmetros	Tipo	Descrição
ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.
PostalCode	String	Codigo postal

/SetDeliveryOption
- Adiciona uma opção de entrega no carrinho de compra.

Parâmetros	Tipo	Descrição
ShopperTicketID	Guild	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.
DeliveryOptionID	String	Identificador da opão de entrega

/AddCoupon
- Adiciona um cupom no carrinho de compra

Parâmetros	Tipo	Descrição
ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário.
CouponCode	String	Cupom

/RemoveCoupon
- Adiciona um cupom no carrinho de compra

Parâmetros	Tipo	Descrição
ShopperTicketID	Guid	Identificador do pedido que é utilizado pelo sistema.
BasketID	Int	Identificador do carrinho de compra.
CustomerID	Int	Identificador do cliente
SessionID	String	Customer da sessão do usuário
CouponCode	String	Cupom