Sobre:

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).
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
ShopperIDGuidIdentificador do visitante da loja.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.


  • /Get
    • Busca a basket, a partir de um identificador.
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
ShopperIDGuidIdentificador do visitante da loja.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário


  • /AddProduct
    • Adiciona novos produtos ao carrinho de compra.
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente.
SessionIDStringCustomer da sessão do usuário.
WebSiteIDInt
FeatureIDInt
QueryStringString
ProductsListLista de produtos.


  • /RemoveBasketItem
    • Remove um item do carrinho de compra.
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.
BasketItemIDIntIdentificador do item


  • /UpdateBasketItem
    • Atualiza um item do carrinho de compra.
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.
BasketItemIDIntIdentificador do item
QuantityDecimalQuantidade do item


  • /RemoveAll
    • Remove todos os item do carrinho de compra.
ParâmetrosTipoDescrição
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.




  • /AddAdditionalProduct
    • Adiciona adicionais do produto no carrinho de compra.
ParâmetrosTipoDescrição
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário
BasketItemIDIntIdentificador do item


  • /RemoveAdditionalProduct
    • Remove adicionais do produto de um item do carrinho de compra.
ParâmetrosTipoDescrição
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.
BasketItemIDIntIdentificador do item.
ProductIDIntIdentificador do produto.


  • /AddCustomMetadata
    • Adiciona uma personalização em um item do carrinho.
ParâmetrosTipoDescrição
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema
BasketIDIntIdentificador do carrinho de compra
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário
BasketItemIDIntIdentificador do item
ProductIDIntIdentificador do produto
SkuIDIntIdentificador do SKU
MetasAddCustomMetadataItemRequest[]Lista de objeto com os metadados a incluir.


  • /AddCustomMetadataItemRequest
ParâmetrosTipoDescrição
PropertyMetadataIDIntIdentificador do metadado (ID)
PropertyNameStringIdentificador do metadado (Name)
ValueStringO Valor a ser inserido na personalização


  • /RemoveCustomMetadata
    • Remove uma personalização de um item.
ParâmetrosTipoDescrição
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.
BasketItemIDIntIdentificador do item.
ProductIDIntIdentificador do produto.
SkuIDIntIdentificador do sku.
MetasRemoveCustomMetadataItemRequest[]Lista de objeto com os metadados a remover


  • /RemoveCustomMetadataItemRequest
    • Remove uma personalização de um item.
ParâmetrosTipoDescrição
PropertyMetadataIDIntIdentificador do metadado (ID)
PropertyNameStringIdentificador do metadado (Name)


  • /SetPostalCode
    • Adiciona um código postal ao carrinho de compra.
ParâmetrosTipoDescrição
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.
PostalCodeStringCodigo postal


  • /SetDeliveryOption
    • Adiciona uma opção de entrega no carrinho de compra.
ParâmetrosTipoDescrição
ShopperTicketIDGuildIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.
DeliveryOptionIDStringIdentificador da opão de entrega


  • /AddCoupon
    • Adiciona um cupom no carrinho de compra
ParâmetrosTipoDescrição
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário.
CouponCodeStringCupom


  • /RemoveCoupon
    • Adiciona um cupom no carrinho de compra
ParâmetrosTipoDescrição
ShopperTicketIDGuidIdentificador do pedido que é utilizado pelo sistema.
BasketIDIntIdentificador do carrinho de compra.
CustomerIDIntIdentificador do cliente
SessionIDStringCustomer da sessão do usuário
CouponCodeStringCupom
  • Sem rótulos