Help

1 min read

BigCommerce Api Clients

Poq.Backend.BigCommerce.Client namespace provides Contracts and Clients that allow quick usage of BigCommerce API.

Contracts

Contain all necessary contracts to use BigCommerce clients effectively.

Clients

List of Available Clients

CartClient

Provides cart manipulation capabilities

Methods
  • CreateCartAsync creates a user cart - endpoint
  • CreateEmptyCartAsync creates an empty cart for guest user - endpoint
  • GetCartAsync get the cart by cartId - endpoint
  • CreateCartRedirectUrlAsync creates a cart redirect URL for redirecting a shopper to an already created cart using the cartId - endpoint
  • AddUserToCartAsync updates a carts customerId - endpoint
  • DeleteCartAsync deletes a cart - endpoint
  • AddCartItemsAsync add line item to the cart - endpoint
  • UpdateCartItemAsync updates an existing, single line item in the cart - endpoint
  • DeleteCartItemAsync deletes a Cart line item - endpoint

CategoryClient

Provides methods to retrieve categories

Methods
  • GetAllCategoriesAsync returns all categories. - endpoint

CustomerClient

Provides creation of user account in BigCommerce, accessing user account details and etc

Methods

  • CreateCustomerAsync creates customer account with provided parameters. - endpoint

  • GetCustomerByIdAsync get customer by id. - endpoint

  • UpdateCustomerAsync updates customer account - endpoint

  • UpdateCustomerAttributeValuesAsync updates customer account details. - endpoint

  • ValidateCustomerAsync validates customer account. - endpoint

ProductsClient

Provides methods to retrieve products

Methods

  • GetProductByIdAsync returns product by productId - endpoint

  • GetProductVariantAsync returns variant details of a product's variant. - endpoint

  • GetProductsAsync returns list of a products. - endpoint

ProductGraphqlClient

Provides methods to retrieve product information using BigCommerce GraphQl API. - endpoint

Methods
  • SearchProductsOnProductAttributesAsync searches for products by attribute value.
  • GetProductsAsync returns products by their ids.
  • GetProductsAsync returns product by its id.
  • GetProductBySkuAsync returns products by their sku.

SearchGraphqlClient

Provides methods to search for products in BigCommerce Graphql API - endpoint

Methods
  • GetProductBySkuAsync returns products by their skus.

StorefrontClient

Obtains storefront token

Methods
  • GetStorefrontTokenAsync Get storefront token - endpoint

StorefrontTokenGenerator

Provides methods to generate storefront token for customer

Methods
  • GenerateJwtToken generates jwt
  • GenerateJwtToken generates jwt overload

SubscribersClient

Provides methods to manage subscribers

Methods
  • CreateSubscriberAsync creates a Subscriber - endpoint
  • GetSubscribersAsync returns a list of Subscribers. Optional filter parameters can be passed in - endpoint
  • DeleteSubscriberAsync deletes a Subscriber - endpoint

WishlistClient

Provides methods to manage customer wish list

Methods
  • CreateWishlistAsync creates wishlist - endpoint
  • AddWishlistItemAsync creates wishlist item - endpoint
  • GetWishlistAsync returns wishlist - endpoint
  • GetAllWishlistsAsync returns all wishlists of a customer - endpoint
  • DeleteWishlistAsync deletes wishlist - endpoint
  • DeleteWishlistItemAsync deletes wishlist item - endpoint