Class CommercetoolsApi

A collection of convenience methods for interacting with the commercetools API.

Index

Constructors

Properties

Methods

applyStore changeMyPassword checkCartExistsById checkCartExistsByKey createAccount createCart createCategory createCustomerGroup createInventoryEntry createMyAccount createMyCart createMyOrderFromActiveCart createMyPayment createOrderFromCart createPayment createProduct createProductSelection createStandalonePrice createStore deleteCartById deleteCategoryById deleteCategoryByKey deleteCustomObject deleteCustomerById deleteCustomerByKey deleteCustomerGroupById deleteCustomerGroupByKey deleteInventoryEntryById deleteInventoryEntryByKey deleteMyActiveCart deleteMyCartById deleteMyPaymentById deleteOrderById deleteOrderByOrderNumber deletePaymentById deleteProductById deleteProductByKey deleteProductSelectionByKey deleteStandalonePriceById deleteStandalonePriceByKey deleteStoreById deleteStoreByKey extractCommonRequestOptions getCartById getCartByKey getCartDiscountById getCartDiscountByKey getCategory getCategoryById getCategoryByKey getCategoryBySlug getCategoryParents getChannelById getChannelByKey getCustomObject getCustomObjectById getCustomerById getCustomerByKey getCustomerByPasswordToken getCustomerGroupById getCustomerGroupByKey getDiscountCodeById getInventoryEntryById getInventoryEntryByKey getMyAccount getMyActiveCart getMyCartById getMyOrderById getMyPaymentById getOrderById getOrderByOrderNumber getPasswordResetToken getPaymentById getProductById getProductByKey getProductProjectionById getProductProjectionByKey getProductProjectionBySlug getProductSelectionById getProductSelectionByKey getProductTypeById getProductTypeByKey getRequestOptions getShippingMethodById getShippingMethodByKey getShippingMethodsForCart getShippingMethodsForCartAndLocation getShippingMethodsForLocation getStandalonePriceById getStandalonePriceByKey getStateById getStateByKey getStoreById getStoreByKey getTaxCategoryById getTaxCategoryByKey getTypeById getTypeByKey graphql importOrder login loginMyAccount queryCartDiscounts queryCarts queryCategories queryChannels queryCustomerGroups queryCustomers queryInventory queryMyCarts queryMyOrders queryMyPayments queryOrders queryPayments queryProductProjections queryProductSelections queryProductTypes queryProductsInStore queryShippingMethods queryStandalonePrices queryStates queryStores queryTaxCategories queryTypes replicate request resetMyPassword saveCustomObject searchProductProjections unpublishProductById unpublishProductByKey updateCartById updateCategoryById updateCategoryByKey updateCustomerById updateCustomerByKey updateCustomerGroupById updateCustomerGroupByKey updateInventoryEntryById updateInventoryEntryByKey updateMyAccount updateMyActiveCart updateMyCart updateMyPaymentById updateOrderById updateOrderByOrderNumber updatePaymentById updateProductById updateProductByKey updateProductSelectionByKey updateStandalonePriceById updateStandalonePriceByKey updateStoreById updateStoreByKey validateConfig

Constructors

constructor

new CommercetoolsApi(config): CommercetoolsApi
Parameters
- config: CommercetoolsApiConfig
Returns CommercetoolsApi
- Defined in src/lib/api/CommercetoolsApi.ts:249

Properties

`Readonly` auth

auth: CommercetoolsAuth

This is the instance of the {@see CommercetoolsAuth} class that this class uses internally. It's exposed publicly so that it can be used by consumer's of this class in order to access authorization API related functionality.

`Readonly` config

config: CommercetoolsApiConfig

The configuration passed in to the constructor.

`Readonly` endpoints

endpoints: RegionEndpoints

The Auth and API endpoints driven by the user's setting of CommercetoolsApiConfig.region https://docs.commercetools.com/api/general-concepts#regions

`Private` `Readonly` requestExecutor

requestExecutor: RequestExecutor<any>

The request executor that's responsible for making the request to commercetools

Methods

applyStore

applyStore(path, storeKey): string
Applies the store key to a given path
Parameters
- path: string
- storeKey: undefined | null | string
Returns string
- Defined in src/lib/api/CommercetoolsApi.ts:2675

changeMyPassword

changeMyPassword(options): Promise<Customer>
Change the customer's password: https://docs.commercetools.com/api/projects/me-profile#change-customers-password
Parameters
- options: CommonStoreEnabledRequestOptions & {
      accessToken: string;
      data: {
          currentPassword: string;
          newPassword: string;
          version: number;
      };
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1875

checkCartExistsById

checkCartExistsById(options): Promise<boolean>
Check if a cart exists by id https://docs.commercetools.com/api/projects/carts#check-if-cart-exists-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  id: string;
  }
Returns Promise<boolean>
- Defined in src/lib/api/CommercetoolsApi.ts:908

checkCartExistsByKey

checkCartExistsByKey(options): Promise<boolean>
Check if a cart exists by key https://docs.commercetools.com/api/projects/carts#check-if-cart-exists-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  key: string;
  }
Returns Promise<boolean>
- Defined in src/lib/api/CommercetoolsApi.ts:930

createMyCart

createMyCart(options): Promise<Cart>
Create a new cart for the customer associated with the given accessToken parameter: https://docs.commercetools.com/api/projects/me-carts#create-a-cart-1
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  data: MyCartDraft;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1083

createMyOrderFromActiveCart

createMyOrderFromActiveCart(options): Promise<Order>
Create an order from the given cart id. The cart id and version are automatically retrieved by looking up the customers active cart: https://docs.commercetools.com/api/projects/me-orders#create-order-from-a-cart
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1190

createMyPayment

createMyPayment(options): Promise<MyPayment>
Create a payment object using the customer's access token: https://docs.commercetools.com/api/projects/me-payments#create-mypayment
Parameters
- options: CommonRequestOptions & {
  accessToken: string;
  data: MyPaymentDraft;
  }
Returns Promise<MyPayment>
- Defined in src/lib/api/CommercetoolsApi.ts:1318

createOrderFromCart

createOrderFromCart(options): Promise<Order>
Create an order from the given cart id. The cart id and version are automatically retrieved by looking up the cart: https://docs.commercetools.com/api/projects/orders#create-order
Parameters
- options: CommonStoreEnabledRequestOptions & {
  id: string;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1211

createPayment

createPayment(options): Promise<Payment>
Create a payment object: https://docs.commercetools.com/api/projects/payments#create-a-payment
Parameters
- options: CommonRequestOptions & {
  data: PaymentDraft;
  }
Returns Promise<Payment>
- Defined in src/lib/api/CommercetoolsApi.ts:1246

createProduct

createProduct(options): Promise<Product>
Create a product: https://docs.commercetools.com/api/projects/products#create-a-product
Parameters
- options: CommonRequestOptions & {
  data: ProductDraft;
  }
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:1534

createProductSelection

createProductSelection(options): Promise<ProductSelection>
Create a product selection https://docs.commercetools.com/api/projects/product-selections#create-product-selection
Parameters
- options: CommonStoreEnabledRequestOptions & {
  data: ProductSelectionDraft;
  }
Returns Promise<ProductSelection>
- Defined in src/lib/api/CommercetoolsApi.ts:716

createStandalonePrice

createStandalonePrice(options): Promise<StandalonePrice>
Create a standalone price object: https://docs.commercetools.com/api/projects/standalone-prices#create-standaloneprice
Parameters
- options: CommonRequestOptions & {
  data: StandalonePriceDraft;
  }
Returns Promise<StandalonePrice>
- Defined in src/lib/api/CommercetoolsApi.ts:2483

createStore

createStore(options): Promise<Store>
Create a store: https://docs.commercetools.com/api/projects/stores#create-a-store
Parameters
- options: CommonRequestOptions & {
  data: StoreDraft;
  }
Returns Promise<Store>
- Defined in src/lib/api/CommercetoolsApi.ts:306

deleteCartById

deleteCartById(options): Promise<Cart>
Delete a cart by the given id: https://docs.commercetools.com/api/projects/carts#delete-a-cart-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  id: string;
  version: number;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1228

deleteCategoryById

deleteCategoryById(options): Promise<Category>
Delete a category by id: https://docs.commercetools.com/api/projects/categories#delete-category-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  version: number;
  }
Returns Promise<Category>
- Defined in src/lib/api/CommercetoolsApi.ts:1714

deleteCategoryByKey

deleteCategoryByKey(options): Promise<Category>
Delete a category by key: https://docs.commercetools.com/api/projects/categories#delete-category-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  version: number;
  }
Returns Promise<Category>
- Defined in src/lib/api/CommercetoolsApi.ts:1732

deleteCustomObject

deleteCustomObject(options): Promise<CustomObject>
Delete a custom object https://docs.commercetools.com/api/projects/custom-objects#delete-customobject-by-container-and-key
Parameters
- options: CommonRequestOptions & {
  container: string;
  key: string;
  }
Returns Promise<CustomObject>
- Defined in src/lib/api/CommercetoolsApi.ts:2174

deleteCustomerById

deleteCustomerById(options): Promise<Customer>
Delete a customer account by id https://docs.commercetools.com/api/projects/customers#delete-customer-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
      dataErasure?: boolean;
      id: string;
      version: number;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1761

deleteCustomerByKey

deleteCustomerByKey(options): Promise<Customer>
Delete a customer account by key https://docs.commercetools.com/api/projects/customers#delete-customer-by-key
Parameters
- options: CommonStoreEnabledRequestOptions & {
      dataErasure?: boolean;
      key: string;
      version: number;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1782

deleteCustomerGroupById

deleteCustomerGroupById(options): Promise<CustomerGroup>
Delete a customer group by id: https://docs.commercetools.com/api/projects/customerGroups#delete-customergroup-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  version: number;
  }
Returns Promise<CustomerGroup>
- Defined in src/lib/api/CommercetoolsApi.ts:2373

deleteCustomerGroupByKey

deleteCustomerGroupByKey(options): Promise<CustomerGroup>
Delete a customer group by key: https://docs.commercetools.com/api/projects/customerGroups#delete-customergroup-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  version: number;
  }
Returns Promise<CustomerGroup>
- Defined in src/lib/api/CommercetoolsApi.ts:2391

deleteInventoryEntryById

deleteInventoryEntryById(options): Promise<InventoryEntry>
Delete InventoryEntry by id https://docs.commercetools.com/api/projects/inventory#delete-inventoryentry-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  version: number;
  }
Returns Promise<InventoryEntry>
- Defined in src/lib/api/CommercetoolsApi.ts:872

deleteInventoryEntryByKey

deleteInventoryEntryByKey(options): Promise<InventoryEntry>
Delete InventoryEntry by key https://docs.commercetools.com/api/projects/inventory#delete-inventoryentry-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  version: number;
  }
Returns Promise<InventoryEntry>
- Defined in src/lib/api/CommercetoolsApi.ts:890

deleteMyActiveCart

deleteMyActiveCart(options): Promise<Cart>
Delete the active cart This method uses {@see getMyActiveCart} to first get the active cart, in order to find the cart id and version: https://docs.commercetools.com/api/projects/me-carts#delete-a-cart
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1127

deleteMyCartById

deleteMyCartById(options): Promise<Cart>
Delete my cart by id https://docs.commercetools.com/api/projects/me-carts#delete-a-cart
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  cartId: string;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1145

deleteMyPaymentById

deleteMyPaymentById(options): Promise<MyPayment>
Delete payment object using the customer's access token: https://docs.commercetools.com/api/projects/me-payments#delete-mypayment
Parameters
- options: CommonRequestOptions & {
      accessToken: string;
      id: string;
      version: number;
  }
Returns Promise<MyPayment>
- Defined in src/lib/api/CommercetoolsApi.ts:1378

deleteOrderById

deleteOrderById(options): Promise<Order>
Delete an order by id: https://docs.commercetools.com/api/projects/orders#delete-order-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
      dataErasure?: boolean;
      id: string;
      version: number;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1482

deleteOrderByOrderNumber

deleteOrderByOrderNumber(options): Promise<Order>
Delete an order by order number: https://docs.commercetools.com/api/projects/orders#delete-order-by-ordernumber
Parameters
- options: CommonStoreEnabledRequestOptions & {
      dataErasure?: boolean;
      orderNo: string;
      version: number;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1503

deletePaymentById

deletePaymentById(options): Promise<Payment>
Delete a payment object by id: https://docs.commercetools.com/api/projects/payments#delete-payment-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  version: number;
  }
Returns Promise<Payment>
- Defined in src/lib/api/CommercetoolsApi.ts:1259

deleteProductById

deleteProductById(options): Promise<Product>
Delete a product by id: https://docs.commercetools.com/api/projects/products#delete-product-by-id
Parameters
- options: CommonRequestOptions & {
      id: string;
      unpublish?: boolean;
      version: number;
  }
  Request options
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:1578

deleteProductByKey

deleteProductByKey(options): Promise<Product>
Delete a product by key: https://docs.commercetools.com/api/projects/products#delete-product-by-key
Parameters
- options: CommonRequestOptions & {
      key: string;
      unpublish?: boolean;
      version: number;
  }
  Request options
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:1609

deleteProductSelectionByKey

deleteProductSelectionByKey(options): Promise<ProductSelection>
Delete a product selection by key https://docs.commercetools.com/api/projects/product-selections#delete-product-selection-by-key
Parameters
- options: CommonStoreEnabledRequestOptions & {
  key: string;
  version: number;
  }
Returns Promise<ProductSelection>
- Defined in src/lib/api/CommercetoolsApi.ts:750

deleteStandalonePriceById

deleteStandalonePriceById(options): Promise<StandalonePrice>
Delete a standalone price object by id: https://docs.commercetools.com/api/projects/standalone-prices#delete-standaloneprice-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  version: number;
  }
Returns Promise<StandalonePrice>
- Defined in src/lib/api/CommercetoolsApi.ts:2528

deleteStandalonePriceByKey

deleteStandalonePriceByKey(options): Promise<StandalonePrice>
Delete a standalone price object by key: https://docs.commercetools.com/api/projects/standalone-prices#delete-standaloneprice-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  version: number;
  }
Returns Promise<StandalonePrice>
- Defined in src/lib/api/CommercetoolsApi.ts:2546

deleteStoreById

deleteStoreById(options): Promise<Store>
Delete a store by id: https://docs.commercetools.com/api/projects/stores#delete-store-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  version: number;
  }
Returns Promise<Store>
- Defined in src/lib/api/CommercetoolsApi.ts:345

deleteStoreByKey

deleteStoreByKey(options): Promise<Store>
Delete a store by key: https://docs.commercetools.com/api/projects/stores#delete-store-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  version: number;
  }
Returns Promise<Store>
- Defined in src/lib/api/CommercetoolsApi.ts:363

extractCommonRequestOptions

extractCommonRequestOptions(options?): CommonRequestOptions
Type-guard against any additional unexpected properties being passed in.
Parameters
- Optional options: CommonRequestOptions
Returns CommonRequestOptions
- Defined in src/lib/api/CommercetoolsApi.ts:2661

getCartById

getCartById(options): Promise<Cart>
Get a cart by id https://docs.commercetools.com/api/projects/carts#get-a-cart-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  id: string;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:952

getCartByKey

getCartByKey(options): Promise<Cart>
Get a cart by key https://docs.commercetools.com/api/projects/carts#get-a-cart-by-key
Parameters
- options: CommonStoreEnabledRequestOptions & {
  key: string;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:966

getCartDiscountById

getCartDiscountById(options): Promise<CartDiscount>
Get a cart discount code by id: https://docs.commercetools.com/api/projects/cartDiscounts#get-cartdiscount-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<CartDiscount>
- Defined in src/lib/api/CommercetoolsApi.ts:2097

getCartDiscountByKey

getCartDiscountByKey(options): Promise<CartDiscount>
Get a cart discount by key: https://docs.commercetools.com/api/projects/cartDiscounts#get-cartdiscount-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<CartDiscount>
- Defined in src/lib/api/CommercetoolsApi.ts:2111

getCategory

getCategory(options): Promise<Category>
Get a category by id or key. Either the id or the key must be provided.
Parameters
- options: CommonRequestOptions & {
  id?: string;
  key?: string;
  }
Returns Promise<Category>
- Defined in src/lib/api/CommercetoolsApi.ts:463

getCategoryById

getCategoryById(options): Promise<Category>
Get an individual category by id: https://docs.commercetools.com/api/projects/categories#get-category-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<Category>
- Defined in src/lib/api/CommercetoolsApi.ts:379

getCategoryByKey

getCategoryByKey(options): Promise<Category>
Get an individual category by key: https://docs.commercetools.com/api/projects/categories#get-category-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<Category>
- Defined in src/lib/api/CommercetoolsApi.ts:393

getCategoryBySlug

getCategoryBySlug(options): Promise<Category>
Get a category projection by slug and locale Queries the categories for the given slug + locale using: https://docs.commercetools.com/api/projects/categories#query-categories
Parameters
- options: CommonRequestOptions & {
      languageCode?: string;
      languageCodes?: string[];
      slug: string;
  }
Returns Promise<Category>
- Defined in src/lib/api/CommercetoolsApi.ts:488

getCategoryParents

getCategoryParents(options): Promise<Category[]>
Get the parent categories of a given category. This method returns an array of {@see Category} items representing the ancestry of categories for the given category id. The list is ordered from top down. In other words, the root category is always the first item in the list.
Parameters
- options: CommonRequestOptions & {
  id?: string;
  key?: string;
  }
Returns Promise<Category[]>
- Defined in src/lib/api/CommercetoolsApi.ts:539

getChannelById

getChannelById(options): Promise<Channel>
Get channel by id: https://docs.commercetools.com/api/projects/channels#get-channel-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<Channel>
- Defined in src/lib/api/CommercetoolsApi.ts:430

getChannelByKey

getChannelByKey(options): Promise<Channel>
Get channel by key: https://docs.commercetools.com/api/projects/channels#get-channel-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<Channel>
- Defined in src/lib/api/CommercetoolsApi.ts:444

getCustomObject

getCustomObject(options): Promise<CustomObject>
Get a custom object https://docs.commercetools.com/api/projects/custom-objects#get-customobject-by-container-and-key
Parameters
- options: CommonRequestOptions & {
  container: string;
  key: string;
  }
Returns Promise<CustomObject>
- Defined in src/lib/api/CommercetoolsApi.ts:2135

getCustomObjectById

getCustomObjectById(options): Promise<CustomObject>
Get a custom object by id https://docs.commercetools.com/api/projects/custom-objects#get-customobject
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<CustomObject>
- Defined in src/lib/api/CommercetoolsApi.ts:2147

getCustomerById

getCustomerById(options): Promise<Customer>
Get a customer by id: https://docs.commercetools.com/api/projects/customers#get-customer-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  id: string;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1925

getCustomerByKey

getCustomerByKey(options): Promise<Customer>
Get a customer by key: https://docs.commercetools.com/api/projects/customers#get-customer-by-key
Parameters
- options: CommonStoreEnabledRequestOptions & {
  key: string;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1939

getCustomerByPasswordToken

getCustomerByPasswordToken(options): Promise<Customer>
Get a customer by password token: https://docs.commercetools.com/api/projects/customers#get-customer-by-password-token
Parameters
- options: CommonStoreEnabledRequestOptions & {
  token: string;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1951

getCustomerGroupById

getCustomerGroupById(options): Promise<CustomerGroup>
Get an individual customer group by id: https://docs.commercetools.com/api/projects/customerGroups#get-customergroup-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<CustomerGroup>
- Defined in src/lib/api/CommercetoolsApi.ts:2292

getCustomerGroupByKey

getCustomerGroupByKey(options): Promise<CustomerGroup>
Get an individual customer group by key: https://docs.commercetools.com/api/projects/customerGroups#get-customergroup-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<CustomerGroup>
- Defined in src/lib/api/CommercetoolsApi.ts:2306

getDiscountCodeById

getDiscountCodeById(options): Promise<DiscountCode>
Get a discount code by id: https://docs.commercetools.com/api/projects/discountCodes#get-discountcode-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<DiscountCode>
- Defined in src/lib/api/CommercetoolsApi.ts:2083

getInventoryEntryById

getInventoryEntryById(options): Promise<InventoryEntry>
Get an InventoryEntry by id https://docs.commercetools.com/api/projects/inventory#get-inventoryentry-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<InventoryEntry>
- Defined in src/lib/api/CommercetoolsApi.ts:779

getInventoryEntryByKey

getInventoryEntryByKey(options): Promise<InventoryEntry>
Get an InventoryEntry by key https://docs.commercetools.com/api/projects/inventory#get-inventoryentry-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<InventoryEntry>
- Defined in src/lib/api/CommercetoolsApi.ts:793

getMyAccount

getMyAccount(options): Promise<Customer>
Get a customer's account/profile: https://docs.commercetools.com/api/projects/me-profile#get-customer
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1846

getMyActiveCart

getMyActiveCart(options): Promise<Cart>
Get the active cart. Requires a logged in or anonymous customer access token: https://docs.commercetools.com/api/projects/me-carts#get-active-cart
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1053

getMyCartById

getMyCartById(options): Promise<Cart>
Get my cart. Requires a logged in or anonymous customer access token: https://docs.commercetools.com/api/projects/me-carts#get-cart-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  cartId: string;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1066

getMyOrderById

getMyOrderById(options): Promise<Order>
Get an order by id using the customer's access token: https://docs.commercetools.com/api/projects/me-orders#get-order-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  id: string;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1398

getMyPaymentById

getMyPaymentById(options): Promise<MyPayment>
Get a payment object by id using the customer's access token: https://docs.commercetools.com/api/projects/me-payments#get-mypayment-by-id
Parameters
- options: CommonRequestOptions & {
  accessToken: string;
  id: string;
  }
Returns Promise<MyPayment>
- Defined in src/lib/api/CommercetoolsApi.ts:1350

getOrderById

getOrderById(options): Promise<Order>
Get an order by id: https://docs.commercetools.com/api/projects/orders#get-order-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  id: string;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1456

getOrderByOrderNumber

getOrderByOrderNumber(options): Promise<Order>
Get an order by order number: https://docs.commercetools.com/api/projects/orders#get-order-by-ordernumber
Parameters
- options: CommonStoreEnabledRequestOptions & {
  orderNumber: string;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1470

getPasswordResetToken

getPasswordResetToken(options): Promise<CustomerToken>
Get a password reset token https://docs.commercetools.com/api/projects/customers#create-a-token-for-resetting-the-customers-password
Parameters
- options: CommonStoreEnabledRequestOptions & {
  data: CustomerCreatePasswordResetToken;
  }
Returns Promise<CustomerToken>
- Defined in src/lib/api/CommercetoolsApi.ts:1910

getPaymentById

getPaymentById(options): Promise<Payment>
Get a payment object by id: https://docs.commercetools.com/api/projects/payments#get-payment-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<Payment>
- Defined in src/lib/api/CommercetoolsApi.ts:1292

getProductById

getProductById(options): Promise<Product>
Get an individual product by id: https://docs.commercetools.com/api/projects/products#get-product-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:559

getProductByKey

getProductByKey(options): Promise<Product>
Get an individual product by key: https://docs.commercetools.com/api/projects/products#get-product-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:573

getProductProjectionById

getProductProjectionById(options): Promise<ProductProjection>
Get a product projection by id https://docs.commercetools.com/api/projects/productProjections#get-productprojection-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  id: string;
  }
Returns Promise<ProductProjection>
- Defined in src/lib/api/CommercetoolsApi.ts:585

getProductProjectionByKey

getProductProjectionByKey(options): Promise<ProductProjection>
Get a product projection by key https://docs.commercetools.com/api/projects/productProjections#get-productprojection-by-key
Parameters
- options: CommonStoreEnabledRequestOptions & {
  key: string;
  }
Returns Promise<ProductProjection>
- Defined in src/lib/api/CommercetoolsApi.ts:599

getProductProjectionBySlug

getProductProjectionBySlug(options): Promise<ProductProjection>
Get a product projection by searching the slug with a given locale or array of locales

Utilises the product projection query endpoint: https://docs.commercetools.com/api/projects/productProjections#query-productprojections

You must pass either the {@see options.languageCode} or {@see options.languageCodes} property in the {@see options} parameter. If both are provided, only the {@see options.languageCodes} is actually used.
Parameters
- options: CommonRequestOptions & {
      languageCode?: string;
      languageCodes?: string[];
      slug: string;
  }
Returns Promise<ProductProjection>
- Defined in src/lib/api/CommercetoolsApi.ts:617

getProductSelectionById

getProductSelectionById(options): Promise<ProductSelection>
Get a product selection by id https://docs.commercetools.com/api/projects/product-selections#get-product-selection
Parameters
- options: CommonStoreEnabledRequestOptions & {
  id: string;
  }
Returns Promise<ProductSelection>
- Defined in src/lib/api/CommercetoolsApi.ts:678

getProductSelectionByKey

getProductSelectionByKey(options): Promise<ProductSelection>
Get a product selection by key https://docs.commercetools.com/api/projects/product-selections#get-product-selection-by-key
Parameters
- options: CommonStoreEnabledRequestOptions & {
  key: string;
  }
Returns Promise<ProductSelection>
- Defined in src/lib/api/CommercetoolsApi.ts:692

getProductTypeById

getProductTypeById(options): Promise<ProductType>
Get a product type by id: https://docs.commercetools.com/api/projects/productTypes#get-a-producttype-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<ProductType>
- Defined in src/lib/api/CommercetoolsApi.ts:2007

getProductTypeByKey

getProductTypeByKey(options): Promise<ProductType>
Get a product type by key: https://docs.commercetools.com/api/projects/productTypes#get-a-producttype-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<ProductType>
- Defined in src/lib/api/CommercetoolsApi.ts:2021

getRequestOptions

getRequestOptions(options): Promise<CommercetoolsRequest>
Generate request options. These are then fed in to axios when making the request to commercetools.
Parameters
- options: FetchOptions<any>
Returns Promise<CommercetoolsRequest>
- Defined in src/lib/api/CommercetoolsApi.ts:2625

getShippingMethodById

getShippingMethodById(options): Promise<ShippingMethod>
Get a shipping method by id: https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethod-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<ShippingMethod>
- Defined in src/lib/api/CommercetoolsApi.ts:2186

getShippingMethodByKey

getShippingMethodByKey(options): Promise<ShippingMethod>
Get a shipping method by key: https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethod-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<ShippingMethod>
- Defined in src/lib/api/CommercetoolsApi.ts:2200

getShippingMethodsForCart

getShippingMethodsForCart(options): Promise<ShippingMethodPagedQueryResponse>
Get shipping methods applicable to a given cart id: https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethods-for-a-cart
Parameters
- options: CommonStoreEnabledRequestOptions & {
  cartId: string;
  }
Returns Promise<ShippingMethodPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2234

getShippingMethodsForCartAndLocation

getShippingMethodsForCartAndLocation(options): Promise<ShippingMethodPagedQueryResponse>
Get shipping methods applicable for a Cart and Location: https://docs.commercetools.com/api/projects/shippingMethods#for-a-cart-and-location
Parameters
- options: CommonStoreEnabledRequestOptions & {
      cartId: string;
      country: string;
      state?: string;
  }
Returns Promise<ShippingMethodPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2254

getShippingMethodsForLocation

getShippingMethodsForLocation(options): Promise<ShippingMethodPagedQueryResponse>
Get shipping method by location: https://docs.commercetools.com/api/projects/shippingMethods#get-shippingmethods-for-a-location
Parameters
- options: CommonRequestOptions & {
      country: string;
      currency?: string;
      state?: string;
  }
Returns Promise<ShippingMethodPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2212

getStandalonePriceById

getStandalonePriceById(options): Promise<StandalonePrice>
Get a standalone price given its id https://docs.commercetools.com/api/projects/standalone-prices#get-standaloneprice-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<StandalonePrice>
- Defined in src/lib/api/CommercetoolsApi.ts:2445

getStandalonePriceByKey

getStandalonePriceByKey(options): Promise<StandalonePrice>
Get a standalone price given its key https://docs.commercetools.com/api/projects/standalone-prices#get-standaloneprice-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<StandalonePrice>
- Defined in src/lib/api/CommercetoolsApi.ts:2459

getStateById

getStateById(options): Promise<State>
Get a state given its id https://docs.commercetools.com/api/projects/states#get-state-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<State>
- Defined in src/lib/api/CommercetoolsApi.ts:2407

getStateByKey

getStateByKey(options): Promise<State>
Get a state given its key https://docs.commercetools.com/api/projects/states#get-state-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<State>
- Defined in src/lib/api/CommercetoolsApi.ts:2421

getStoreById

getStoreById(options): Promise<Store>
Get a store given its id https://docs.commercetools.com/api/projects/stores#get-a-store-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<Store>
- Defined in src/lib/api/CommercetoolsApi.ts:268

getStoreByKey

getStoreByKey(options): Promise<Store>
Get a store given its key https://docs.commercetools.com/api/projects/stores#get-a-store-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<Store>
- Defined in src/lib/api/CommercetoolsApi.ts:282

getTaxCategoryById

getTaxCategoryById(options): Promise<TaxCategory>
Get a tax category given its id https://docs.commercetools.com/api/projects/taxCategories#get-taxcategory-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<TaxCategory>
- Defined in src/lib/api/CommercetoolsApi.ts:2564

getTaxCategoryByKey

getTaxCategoryByKey(options): Promise<TaxCategory>
Get a tax category given its key https://docs.commercetools.com/api/projects/taxCategories#get-taxcategory-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<TaxCategory>
- Defined in src/lib/api/CommercetoolsApi.ts:2578

getTypeById

getTypeById(options): Promise<Type>
Get a type by id: https://docs.commercetools.com/api/projects/types#get-type-by-id
Parameters
- options: CommonRequestOptions & {
  id: string;
  }
Returns Promise<Type>
- Defined in src/lib/api/CommercetoolsApi.ts:2045

getTypeByKey

getTypeByKey(options): Promise<Type>
Get a type by key: https://docs.commercetools.com/api/projects/types#get-type-by-key
Parameters
- options: CommonRequestOptions & {
  key: string;
  }
Returns Promise<Type>
- Defined in src/lib/api/CommercetoolsApi.ts:2059

graphql

graphql(options): Promise<GraphQLResponse>
Execute a GraphQL statement: https://docs.commercetools.com/api/graphql
Parameters
- options: CommonRequestOptions & {
  accessToken?: string;
  data: GraphQLRequest;
  }
Returns Promise<GraphQLResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2603

importOrder

importOrder(options): Promise<Order>
Import an order. https://docs.commercetools.com/api/projects/orders-import#orderimportdraft
Parameters
- options: CommonRequestOptions & {
  data: OrderImportDraft;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:417

login

login(options): Promise<CustomerSignInResult>
Login to customer's account: https://docs.commercetools.com/api/projects/customers#authenticate-customer-sign-in
Parameters
- options: CommonStoreEnabledRequestOptions & {
  data: CustomerSignin;
  }
Returns Promise<CustomerSignInResult>
- Defined in src/lib/api/CommercetoolsApi.ts:1833

loginMyAccount

loginMyAccount(options): Promise<CustomerSignInResult>
Login to customer's account given an (optional) anonymous access token: https://docs.commercetools.com/api/projects/me-profile#authenticate-customer-sign-in
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken?: string;
  data: CustomerSignin;
  }
Returns Promise<CustomerSignInResult>
- Defined in src/lib/api/CommercetoolsApi.ts:1817

queryCartDiscounts

queryCartDiscounts(options?): Promise<CartDiscountPagedQueryResponse>
Query cart discounts: https://docs.commercetools.com/api/projects/cartDiscounts#query-cartdiscounts
Parameters
- Optional options: CommonRequestOptions
Returns Promise<CartDiscountPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2123

queryCarts

queryCarts(options?): Promise<CartPagedQueryResponse>
Query carts https://docs.commercetools.com/api/projects/carts#query-carts-1
Parameters
- Optional options: CommonStoreEnabledRequestOptions
Returns Promise<CartPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:980

queryCategories

queryCategories(options?): Promise<CategoryPagedQueryResponse>
Query categories https://docs.commercetools.com/api/projects/categories#query-categories
Parameters
- Optional options: CommonRequestOptions
Returns Promise<CategoryPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:525

queryChannels

queryChannels(options?): Promise<ChannelPagedQueryResponse>
Query channels: https://docs.commercetools.com/api/projects/channels#query-channels
Parameters
- Optional options: CommonRequestOptions
Returns Promise<ChannelPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:405

queryCustomerGroups

queryCustomerGroups(options?): Promise<CustomerGroupPagedQueryResponse>
Query customer groups: https://docs.commercetools.com/api/projects/customerGroups#query-customergroups
Parameters
- Optional options: CommonRequestOptions
Returns Promise<CustomerGroupPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2318

queryCustomers

queryCustomers(options): Promise<CustomerPagedQueryResponse>
Query customers: https://docs.commercetools.com/api/projects/customers#query-customers
Parameters
- options: CommonStoreEnabledRequestOptions
Returns Promise<CustomerPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:1963

queryInventory

queryInventory(options?): Promise<InventoryPagedQueryResponse>
Query the inventory of Skus https://docs.commercetools.com/api/projects/inventory#query-inventory
Parameters
- Optional options: CommonRequestOptions
Returns Promise<InventoryPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:807

queryMyCarts

queryMyCarts(options): Promise<CartPagedQueryResponse>
Query my carts https://docs.commercetools.com/api/projects/me-carts#query-carts-1
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  }
Returns Promise<CartPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:992

queryMyOrders

queryMyOrders(options): Promise<OrderPagedQueryResponse>
Query my orders: https://docs.commercetools.com/api/projects/me-orders#query-orders-1
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  }
Returns Promise<OrderPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:1413

queryMyPayments

queryMyPayments(options): Promise<MyPaymentPagedQueryResponse>
Query payment objects using the customer's access token: https://docs.commercetools.com/api/projects/me-payments#query-mypayments
Parameters
- options: CommonRequestOptions & {
  accessToken: string;
  }
Returns Promise<MyPaymentPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:1365

queryOrders

queryOrders(options): Promise<OrderPagedQueryResponse>
Query orders: https://docs.commercetools.com/api/projects/orders#query-orders-1
Parameters
- options: CommonStoreEnabledRequestOptions
Returns Promise<OrderPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:1522

queryPayments

queryPayments(options): Promise<PaymentPagedQueryResponse>
Query payment objects: https://docs.commercetools.com/api/projects/payments#query-payments
Parameters
- options: CommonRequestOptions
Returns Promise<PaymentPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:1306

queryProductProjections

queryProductProjections(options?): Promise<ProductProjectionPagedQueryResponse>
Query product projections https://docs.commercetools.com/api/projects/productProjections#query-productprojections
Parameters
- Optional options: CommonRequestOptions
Returns Promise<ProductProjectionPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:654

queryProductSelections

queryProductSelections(options?): Promise<ProductSelectionPagedQueryResponse>
Query product selections https://docs.commercetools.com/api/projects/product-selections#query-product-selections
Parameters
- Optional options: CommonStoreEnabledRequestOptions
Returns Promise<ProductSelectionPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:704

queryProductTypes

queryProductTypes(options): Promise<ProductTypePagedQueryResponse>
Query product types: https://docs.commercetools.com/api/projects/productTypes#query-producttypes
Parameters
- options: CommonRequestOptions
Returns Promise<ProductTypePagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2033

queryProductsInStore

queryProductsInStore(options): Promise<ProductsInStorePagedQueryResponse>
Query the products available in a store through active Product Selections https://docs.commercetools.com/api/projects/product-selections#query-products-available-in-a-store-through-active-product-selections
Parameters
- options: CommonStoreEnabledRequestOptions
Returns Promise<ProductsInStorePagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:767

queryShippingMethods

queryShippingMethods(options?): Promise<ShippingMethodPagedQueryResponse>
Query shipping methods: https://docs.commercetools.com/api/projects/shippingMethods#query-shippingmethods
Parameters
- Optional options: CommonRequestOptions
Returns Promise<ShippingMethodPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2280

queryStandalonePrices

queryStandalonePrices(options?): Promise<StandalonePricePagedQueryResponse>
Query standalone prices https://docs.commercetools.com/api/projects/standalone-prices#query-standaloneprices
Parameters
- Optional options: CommonRequestOptions
Returns Promise<StandalonePricePagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2471

queryStates

queryStates(options?): Promise<StatePagedQueryResponse>
Query state https://docs.commercetools.com/api/projects/states#query-states
Parameters
- Optional options: CommonRequestOptions
Returns Promise<StatePagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2433

queryStores

queryStores(options?): Promise<StorePagedQueryResponse>
Query stores https://docs.commercetools.com/api/projects/stores#get-a-store-by-key
Parameters
- Optional options: CommonRequestOptions
Returns Promise<StorePagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:294

queryTaxCategories

queryTaxCategories(options?): Promise<TaxCategoryPagedQueryResponse>
Query tax categories https://docs.commercetools.com/api/projects/taxCategories#query-taxcategories
Parameters
- Optional options: CommonRequestOptions
Returns Promise<TaxCategoryPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2591

queryTypes

queryTypes(options): Promise<TypePagedQueryResponse>
Query types: https://docs.commercetools.com/api/projects/types#query-types
Parameters
- options: CommonRequestOptions
Returns Promise<TypePagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:2071

replicate

replicate(options): Promise<Cart>
Replicate an existing cart from a Cart or Order https://docs.commercetools.com/api/projects/carts#replicate-cart
Parameters
- options: CommonRequestOptions & {
  data: ReplicaCartDraft;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1020

request

request<T, R>(options): Promise<R>
Make the request to the commercetools REST API.
Type Parameters
- T = any
- R = any
Parameters
- options: FetchOptions<T>
Returns Promise<R>
- Defined in src/lib/api/CommercetoolsApi.ts:2616

resetMyPassword

resetMyPassword(options): Promise<Customer>
Reset the customer's password: https://docs.commercetools.com/api/projects/me-profile#reset-customers-password
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  data: CustomerResetPassword;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1894

saveCustomObject

saveCustomObject(options): Promise<CustomObject>
Save a custom object https://docs.commercetools.com/api/projects/custom-objects#create-or-update-a-customobject
Parameters
- options: CommonRequestOptions & {
  data: CustomObjectDraft;
  }
Returns Promise<CustomObject>
- Defined in src/lib/api/CommercetoolsApi.ts:2161

searchProductProjections

searchProductProjections(options): Promise<ProductProjectionPagedQueryResponse>
Search product projections https://docs.commercetools.com/api/projects/products-search#search-productprojections
Parameters
- options: CommonStoreEnabledRequestOptions
Returns Promise<ProductProjectionPagedQueryResponse>
- Defined in src/lib/api/CommercetoolsApi.ts:666

unpublishProductById

unpublishProductById(options): Promise<Product>
Unpublish a product by id

Issues an 'unpublish' action for the given product: https://docs.commercetools.com/api/projects/products#unpublish
Parameters
- options: CommonRequestOptions & {
  id: string;
  version: number;
  }
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:1656

unpublishProductByKey

unpublishProductByKey(options): Promise<Product>
Unpublish a product by key

Issues an 'unpublish' action for the given product: https://docs.commercetools.com/api/projects/products#unpublish
Parameters
- options: CommonRequestOptions & {
  key: string;
  version: number;
  }
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:1637

updateCartById

updateCartById(options): Promise<Cart>
Update a cart by id https://docs.commercetools.com/api/projects/carts#update-a-cart-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
      actions: CartUpdateAction[];
      id: string;
      version: number;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1033

updateCategoryById

updateCategoryById(options): Promise<Category>
Update a category by id: https://docs.commercetools.com/api/projects/categories#update-category-by-id
Parameters
- options: CommonRequestOptions & {
  data: CategoryUpdate;
  id: string;
  }
Returns Promise<Category>
- Defined in src/lib/api/CommercetoolsApi.ts:1699

updateCategoryByKey

updateCategoryByKey(options): Promise<Category>
Update a category by key: https://docs.commercetools.com/api/projects/categories#update-category-by-key
Parameters
- options: CommonRequestOptions & {
  data: CategoryUpdate;
  key: string;
  }
Returns Promise<Category>
- Defined in src/lib/api/CommercetoolsApi.ts:1687

updateCustomerById

updateCustomerById(options): Promise<Customer>
Update a customer by id: https://docs.commercetools.com/api/projects/customers#update-customer-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  data: CustomerUpdate;
  id: string;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1975

updateCustomerByKey

updateCustomerByKey(options): Promise<Customer>
Update a customer by key: https://docs.commercetools.com/api/projects/customers#update-customer-by-key
Parameters
- options: CommonStoreEnabledRequestOptions & {
  data: CustomerUpdate;
  key: string;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1992

updateCustomerGroupById

updateCustomerGroupById(options): Promise<CustomerGroup>
Update a customer group by id: https://docs.commercetools.com/api/projects/customerGroups#update-customergroup-by-id
Parameters
- options: CommonRequestOptions & {
  data: CustomerGroupUpdate;
  id: string;
  }
Returns Promise<CustomerGroup>
- Defined in src/lib/api/CommercetoolsApi.ts:2356

updateCustomerGroupByKey

updateCustomerGroupByKey(options): Promise<CustomerGroup>
Update a customer group by key: https://docs.commercetools.com/api/projects/customerGroups#update-customergroup-by-key
Parameters
- options: CommonRequestOptions & {
  data: CustomerGroupUpdate;
  key: string;
  }
Returns Promise<CustomerGroup>
- Defined in src/lib/api/CommercetoolsApi.ts:2342

updateInventoryEntryById

updateInventoryEntryById(options): Promise<InventoryEntry>
Update InventoryEntry by id https://docs.commercetools.com/api/projects/inventory#update-inventoryentry-by-id
Parameters
- options: CommonRequestOptions & {
      data: {
          actions: InventoryEntryUpdateAction[];
          version: number;
      };
      id: string;
  }
Returns Promise<InventoryEntry>
- Defined in src/lib/api/CommercetoolsApi.ts:834

updateInventoryEntryByKey

updateInventoryEntryByKey(options): Promise<InventoryEntry>
Update InventoryEntry by key https://docs.commercetools.com/api/projects/inventory#update-inventoryentry-by-key
Parameters
- options: CommonRequestOptions & {
      data: {
          actions: InventoryEntryUpdateAction[];
          version: number;
      };
      key: string;
  }
Returns Promise<InventoryEntry>
- Defined in src/lib/api/CommercetoolsApi.ts:853

updateMyAccount

updateMyAccount(options): Promise<Customer>
Update a customer's account/profile: https://docs.commercetools.com/api/projects/me-profile#update-customer
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  data: CustomerUpdate;
  }
Returns Promise<Customer>
- Defined in src/lib/api/CommercetoolsApi.ts:1859

updateMyActiveCart

updateMyActiveCart(options): Promise<Cart>
Update a customer's cart with the given actions. Note that we automatically retrieve the customer's active cart using the given access token: https://docs.commercetools.com/api/projects/me-carts#update-cart https://docs.commercetools.com/api/projects/me-carts#update-actions
Parameters
- options: CommonStoreEnabledRequestOptions & {
  accessToken: string;
  actions: MyCartUpdateAction[];
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1169

updateMyCart

updateMyCart(options): Promise<Cart>
Update a customer's cart with the given actions: https://docs.commercetools.com/api/projects/me-carts#update-cart https://docs.commercetools.com/api/projects/me-carts#update-actions
Parameters
- options: CommonStoreEnabledRequestOptions & {
      accessToken: string;
      actions: MyCartUpdateAction[];
      cartId: string;
      cartVersion: number;
  }
Returns Promise<Cart>
- Defined in src/lib/api/CommercetoolsApi.ts:1100

updateMyPaymentById

updateMyPaymentById(options): Promise<MyPayment>
Update a payment object using the customer's access token: https://docs.commercetools.com/api/projects/me-payments#update-mypayment
Parameters
- options: CommonRequestOptions & {
      accessToken: string;
      data: MyPaymentUpdate;
      id: string;
  }
Returns Promise<MyPayment>
- Defined in src/lib/api/CommercetoolsApi.ts:1332

updateOrderById

updateOrderById(options): Promise<Order>
Update an order by id: https://docs.commercetools.com/api/projects/orders#update-order-by-id
Parameters
- options: CommonStoreEnabledRequestOptions & {
  data: OrderUpdate;
  id: string;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1426

updateOrderByOrderNumber

updateOrderByOrderNumber(options): Promise<Order>
Update an order by order number: https://docs.commercetools.com/api/projects/orders#update-order-by-ordernumber
Parameters
- options: CommonStoreEnabledRequestOptions & {
  data: OrderUpdate;
  orderNumber: string;
  }
Returns Promise<Order>
- Defined in src/lib/api/CommercetoolsApi.ts:1441

updatePaymentById

updatePaymentById(options): Promise<Payment>
Update a payment object by id: https://docs.commercetools.com/api/projects/payments#update-payment-by-id
Parameters
- options: CommonRequestOptions & {
  data: PaymentUpdate;
  id: string;
  }
Returns Promise<Payment>
- Defined in src/lib/api/CommercetoolsApi.ts:1277

updateProductById

updateProductById(options): Promise<Product>
Update a product by id: https://docs.commercetools.com/api/projects/products#update-product-by-id
Parameters
- options: CommonRequestOptions & {
  data: ProductUpdate;
  id: string;
  }
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:1560

updateProductByKey

updateProductByKey(options): Promise<Product>
Update a product by key: https://docs.commercetools.com/api/projects/products#update-product-by-key
Parameters
- options: CommonRequestOptions & {
  data: ProductUpdate;
  key: string;
  }
Returns Promise<Product>
- Defined in src/lib/api/CommercetoolsApi.ts:1547

updateProductSelectionByKey

updateProductSelectionByKey(options): Promise<ProductSelection>
Update a product selection by key https://docs.commercetools.com/api/projects/product-selections#update-product-selection-by-key
Parameters
- options: CommonStoreEnabledRequestOptions & {
      actions: ProductSelectionUpdateAction[];
      key: string;
      version: number;
  }
Returns Promise<ProductSelection>
- Defined in src/lib/api/CommercetoolsApi.ts:731

updateStandalonePriceById

updateStandalonePriceById(options): Promise<StandalonePrice>
Update a standalone price object by id: https://docs.commercetools.com/api/projects/standalone-prices#update-standaloneprice-by-id
Parameters
- options: CommonRequestOptions & {
  data: StandalonePriceUpdate;
  id: string;
  }
Returns Promise<StandalonePrice>
- Defined in src/lib/api/CommercetoolsApi.ts:2496

updateStandalonePriceByKey

updateStandalonePriceByKey(options): Promise<StandalonePrice>
Update a standalone price object by key: https://docs.commercetools.com/api/projects/standalone-prices#update-standaloneprice-by-key
Parameters
- options: CommonRequestOptions & {
  data: StandalonePriceUpdate;
  key: string;
  }
Returns Promise<StandalonePrice>
- Defined in src/lib/api/CommercetoolsApi.ts:2513

updateStoreById

updateStoreById(options): Promise<Store>
Update a store by id: https://docs.commercetools.com/api/projects/stores#update-store-by-id
Parameters
- options: CommonRequestOptions & {
  data: StoreUpdate;
  id: string;
  }
Returns Promise<Store>
- Defined in src/lib/api/CommercetoolsApi.ts:318

updateStoreByKey

updateStoreByKey(options): Promise<Store>
Update a store by key: https://docs.commercetools.com/api/projects/stores#update-store-by-key
Parameters
- options: CommonRequestOptions & {
  data: StoreUpdate;
  key: string;
  }
Returns Promise<Store>
- Defined in src/lib/api/CommercetoolsApi.ts:333

`Static` validateConfig

validateConfig(config): void
Ensure that all required properties on the {@see CommercetoolsApiConfig} object have been populated. These are currently:

projectKey: string clientId: string clientSecret: string region: Region clientScopes: string[]
Parameters
- config: any
Returns void
- Defined in src/lib/api/CommercetoolsApi.ts:2694

Class CommercetoolsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommercetoolsApi

Properties

Readonly auth

Readonly config

Readonly endpoints

Private Readonly requestExecutor

Methods

applyStore

Parameters

Returns string

changeMyPassword

Parameters

Returns Promise<Customer>

checkCartExistsById

Parameters

Returns Promise<boolean>

checkCartExistsByKey

Parameters

Returns Promise<boolean>

createAccount

Parameters

Returns Promise<CustomerSignInResult>

createCart

Parameters

Returns Promise<Cart>

createCategory

Parameters

Returns Promise<Category>

createCustomerGroup

Parameters

Returns Promise<CustomerGroup>

createInventoryEntry

Parameters

Returns Promise<InventoryEntry>

createMyAccount

Parameters

Returns Promise<CustomerSignInResult>

createMyCart

Parameters

Returns Promise<Cart>

createMyOrderFromActiveCart

Parameters

Returns Promise<Order>

createMyPayment

Parameters

Returns Promise<MyPayment>

createOrderFromCart

Parameters

Returns Promise<Order>

createPayment

Parameters

Returns Promise<Payment>

createProduct

Parameters

Returns Promise<Product>

createProductSelection

Parameters

Returns Promise<ProductSelection>

createStandalonePrice

Parameters

Returns Promise<StandalonePrice>

createStore

Parameters

Returns Promise<Store>

deleteCartById

Parameters

Returns Promise<Cart>

deleteCategoryById

Parameters

Returns Promise<Category>

deleteCategoryByKey

Parameters

`Readonly` auth

`Readonly` config

`Readonly` endpoints

`Private` `Readonly` requestExecutor