Help

1 min read

BigCommerce Sdk Services

All services APIs are defined using interfaces. The recommended way of customization when using BigCommerce SDK is to provide custom implementation of services and register it as scoped in IoC.

List of Available Services

AccountService

AccountService is designed to be used by BFC by handling user account operations: login, register, profile, etc. This services proxies relevant requests to BigCommerce endpoints for complete integration.

Methods

  • CreateGuestTokenAsync creates token for guest user

  • LoginAsync logs user in

  • LogoutAsync logs user out

  • GetProfileAsync returns user profile

  • RegisterAsync register new user.

  • UpdateProfileAsync updates user profile

  • RefreshTokenAsync refresh logged in user access token

  • GetContentAsync returns screen content configuration setup in Poq App Manager

  • GetRedirectTokenUrl creates redirect token for desired url

  • GetAccessTokenFromAuthHeader decodes authorization header value

  • GetTokenInfoFromAuthHeader decodes authorization header value

SearchService

SearchService provides set of methods required to show product listing page by category and keyword, in addition to this handles search by barcode functionality.

Methods
  • GetProductBySkuAsync returns product listing page by sku.

ProductService

ProductService provides set of methods required to show product details page.

Methods
  • GetProductAsync returns product by product id.
  • GetProductsAsync returns products by product ids.
  • GetProductsByListingIdsAsync returns products by listing ids.
  • GetProductsByVariantIdsAsync returns products by variant ids.
  • GetProductBySkuAsync returns products by skus.

CheckoutService

CheckoutService provides set of methods required to handle checkout

Methods
  • StartAsync handles checkout start and returns appropriate url.

CartService

CartService provides set of methods required to manipulate customer cart

Methods
  • GetCartAsync returns Cart data
  • UpdateCartAsync updates inderliying cart
  • AddToCartAsync adds item to underlying cart

WishlistService

WishlistService provides set of methods required to manipulate customer wishlist

Methods
  • GetAllWishlistItemsAsync returns all wishlist items
  • AddWishlistItemAsync add wishlist item
  • DeleteWishlistAsync deletes wishlist
  • DeleteWishlistItemAsync deletes wishlist item
  • GetWishlistItemsAsync returns wishlit items