Home > @vsf-enterprise/bigcommerce-api > Endpoints
# Endpoints interface
Definition of all API-client methods available in context.
Signature:
export interface Endpoints
# Methods
| Method | Description |
|---|---|
| addCartItems(context, params) | Adds new items to the cart |
| addWishlistItems(context, params) | Adds a wishlist item. More than one item can be added at a time. |
| createCart(context, params) | Creates a new Cart. |
| createCustomer(context, params) | Creates the new customer |
| createCustomerAddress(context, params) | Creates a new Address. |
| createProductReview(context, props) | Creates a Product Review. |
| createWishlist(context, params) | Creates a wishlist and wishlist item. More than one item can be added. |
| deleteCart(context, params) | Deletes a Cart. |
| deleteCustomerAddress(context, params) | Deletes an Address. |
| deleteWishlist(context, wishlistId) | Deletes a wishlist. |
| getAllWishlists(context, query) | Returns a list of wishlists. Optional filter parameters can be passed in. |
| getCart(context, params) | Get a cart |
| getCategory(context, params) | Returns a single Category. |
| getCategoryTree(context) | Returns a CategoryTree. |
| getChannel(context, params) | Return a Channel. |
| getCurrencies(context) | Returns a list of available currencies. |
| getCustomerAddress(context, params) | Get an Adddress |
| getCustomers(context, params) | Get customers |
| getCustomerSettings(context) | Get Customer Settings per Channel |
| getFilters(context, params) | Returns a list of Filters. |
| getOrderByCart(context, params) | Returns the order related to the given cart. |
| getOrderProducts(context, params) | Returns the products of the given order. Optional filter parameters can be passed in. |
| getOrders(context, params) | Returns a list of orders. Optional filter parameters can be passed in. |
| getOrderShippingAddresses(context, params) | Returns the shipping addresses of the given order. Optional filter parameters can be passed in. |
| getOrdersWithDetails(context, params) | Returns the order related to the given cart. |
| getProductById(context, params) | Returns a Product by IdBy default, the product's options, modifiers and custom fields are not returned. See params argument object to see how it's added.Only up to 250 product images are returned (this is less than the Bigcommerce total limit of 1000 images on a single product). If the thumbnail/default image is set, it's guaranteed to be the first in the returned images array and have is_thumbnail: true. |
| getProductReview(context, props) | Returns a single Product Review. |
| getProductReviewCollection(context, props, query) | Returns a colection of Product Reviews. |
| getProducts(context, params) | Returns a list of Products. |
| getProductsByCategory(context, params) | Returns a list of Products by Category |
| getProductsById(context, params) | Returns a list of Products by Id |
| getProductsWithFilter(context, params) | Returns a list of Products by search result. |
| getSite(context) | Return a Site. |
| getStoreMeta(context) | |
| loginCustomer(context, params) | Logs in a customer using the Customer Login API and saves her data in cookie in the format of a JWT token coming from the Current Customer API. Return an object containing the status of authentication and an error message if applicable |
| loginCustomerGql(context, params) | Logs in a customer using a GraphQL mutation. Returns an object containing the status of authentication and customer ID on the successful login. |
| logoutCustomer(context) | Logs out the currently logged-in customer by deleting the authentication related cookies. |
| removeCartItem(context, params) | Removes an item from the cart |
| removeWishlistItem(context, params) | Deletes a wishlist item. |
| updateCart(context, params) | Update the customer_id of a cart |
| updateCartItem(context, params) | Updates the list price or the quantity of an item from the cart |
| updateCustomer(context, params) | Update customers |
| updateCustomerAddress(context, params) | Update an address |
| updateCustomerFormFields(context, params) | Updates form field values on the Customer or Customer Address objects. |
| validateCredentials(context, params) | Checks if customer credentials are valid and is used as part of the authentication process |