Class CommercetoolsApi

constructor

• new CommercetoolsApi(config): CommercetoolsApi

• Parameters

  • config: CommercetoolsApiConfig

  Returns CommercetoolsApi

Readonly auth

Readonly config

Readonly endpoints

applyStore

• applyStore(path, storeKey): string

• Applies the store key to a given path

  Parameters

  • path: string

  • storeKey: undefined | null | string

  Returns string

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>

createAccount

• createAccount(options): Promise<CustomerSignInResult>

• Create a customer account: https://docs.commercetools.com/api/projects/customers#create-customer-sign-up

  Parameters

  • options: CommonStoreEnabledRequestOptions & {
        data: CustomerDraft;
    }

  Returns Promise<CustomerSignInResult>

createCart

• createCart(options): Promise<Cart>

• Create a new cart: https://docs.commercetools.com/api/projects/carts#create-a-cart-1

  Parameters

  • options: CommonStoreEnabledRequestOptions & {
        data: CartDraft;
    }

  Returns Promise<Cart>

createCategory

• createCategory(options): Promise<Category>

• Create a category: https://docs.commercetools.com/api/projects/categories#create-a-category

  Parameters

  • options: CommonRequestOptions & {
        data: CategoryDraft;
    }

  Returns Promise<Category>

createCustomerGroup

• createCustomerGroup(options): Promise<CustomerGroup>

• Create a customer group: https://docs.commercetools.com/api/projects/customerGroups#create-a-customergroup

  Parameters

  • options: CommonRequestOptions & {
        data: CustomerGroupDraft;
    }

  Returns Promise<CustomerGroup>

createInventoryEntry

• createInventoryEntry(options): Promise<InventoryEntry>

• Create InventoryEntry https://docs.commercetools.com/api/projects/inventory#create-inventoryentry

  Parameters

  • options: CommonRequestOptions & {
        data: InventoryEntryDraft;
    }

  Returns Promise<InventoryEntry>

createMyAccount

• createMyAccount(options): Promise<CustomerSignInResult>

• Create a customer account given an (optional) anonymous access token: https://docs.commercetools.com/api/projects/me-profile#create-customer-sign-up

  Parameters

  • options: CommonStoreEnabledRequestOptions & {
        accessToken?: string;
        data: MyCustomerDraft;
    }

  Returns Promise<CustomerSignInResult>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

extractCommonRequestOptions

• extractCommonRequestOptions(options?): CommonRequestOptions

• Type-guard against any additional unexpected properties being passed in.

  Parameters

  • Optional options: CommonRequestOptions

  Returns CommonRequestOptions

getCartById

• getCartById(options): Promise<Cart>

• Get a cart by id https://docs.commercetools.com/api/projects/carts#update-a-cart-by-id

  Parameters

  • options: CommonStoreEnabledRequestOptions & {
        id: string;
    }

  Returns Promise<Cart>

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>

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>

getCategory

• getCategory(options): Promise<Category>

• Get an category by id or key. Either the id or the key must be provided.

  Parameters

  • options: CommonRequestOptions & {
        id?: string;
        key?: string;
    }

  Returns Promise<Category>

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>

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>

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>

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[]>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

getStandalonePriceById

• getStandalonePriceById(options): Promise<StandalonePrice>

• Get a standalone price given it's id https://docs.commercetools.com/api/projects/standalone-prices#get-standaloneprice-by-id

  Parameters

  • options: CommonRequestOptions & {
        id: string;
    }

  Returns Promise<StandalonePrice>

getStandalonePriceByKey

• getStandalonePriceByKey(options): Promise<StandalonePrice>

• Get a standalone price given it's key https://docs.commercetools.com/api/projects/standalone-prices#get-standaloneprice-by-key

  Parameters

  • options: CommonRequestOptions & {
        key: string;
    }

  Returns Promise<StandalonePrice>

getStateById

• getStateById(options): Promise<State>

• Get a state given it's id https://docs.commercetools.com/api/projects/states#get-state-by-id

  Parameters

  • options: CommonRequestOptions & {
        id: string;
    }

  Returns Promise<State>

getStateByKey

• getStateByKey(options): Promise<State>

• Get a state given it's key https://docs.commercetools.com/api/projects/states#get-state-by-key

  Parameters

  • options: CommonRequestOptions & {
        key: string;
    }

  Returns Promise<State>

getStoreById

• getStoreById(options): Promise<Store>

• Get a store given it's id https://docs.commercetools.com/api/projects/stores#get-a-store-by-id

  Parameters

  • options: CommonRequestOptions & {
        id: string;
    }

  Returns Promise<Store>

getStoreByKey

• getStoreByKey(options): Promise<Store>

• Get a store given it's key https://docs.commercetools.com/api/projects/stores#get-a-store-by-key

  Parameters

  • options: CommonRequestOptions & {
        key: string;
    }

  Returns Promise<Store>

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>

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>

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>

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>

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>

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>

queryCartDiscounts

• queryCartDiscounts(options?): Promise<CartDiscountPagedQueryResponse>

• Query cart discounts: https://docs.commercetools.com/api/projects/cartDiscounts#query-cartdiscounts

  Parameters

  • Optional options: CommonRequestOptions

  Returns Promise<CartDiscountPagedQueryResponse>

queryCarts

• queryCarts(options?): Promise<CartPagedQueryResponse>

• Query carts https://docs.commercetools.com/api/projects/carts#query-carts-1

  Parameters

  • Optional options: CommonStoreEnabledRequestOptions

  Returns Promise<CartPagedQueryResponse>

queryCategories

• queryCategories(options?): Promise<CategoryPagedQueryResponse>

• Query categories https://docs.commercetools.com/api/projects/categories#query-categories

  Parameters

  • Optional options: CommonRequestOptions

  Returns Promise<CategoryPagedQueryResponse>

queryChannels

• queryChannels(options?): Promise<ChannelPagedQueryResponse>

• Query channels: https://docs.commercetools.com/api/projects/channels#query-channels

  Parameters

  • Optional options: CommonRequestOptions

  Returns Promise<ChannelPagedQueryResponse>

queryCustomerGroups

• queryCustomerGroups(options?): Promise<CustomerGroupPagedQueryResponse>

• Query customer groups: https://docs.commercetools.com/api/projects/customerGroups#query-customergroups

  Parameters

  • Optional options: CommonRequestOptions

  Returns Promise<CustomerGroupPagedQueryResponse>

queryCustomers

• queryCustomers(options): Promise<CustomerPagedQueryResponse>

• Query customers: https://docs.commercetools.com/api/projects/customers#query-customers

  Parameters

  • options: CommonStoreEnabledRequestOptions

  Returns Promise<CustomerPagedQueryResponse>

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>

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>

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>

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>

queryOrders

• queryOrders(options): Promise<OrderPagedQueryResponse>

• Query orders: https://docs.commercetools.com/api/projects/orders#query-orders-1

  Parameters

  • options: CommonStoreEnabledRequestOptions

  Returns Promise<OrderPagedQueryResponse>

queryPayments

• queryPayments(options): Promise<PaymentPagedQueryResponse>

• Query payment objects: https://docs.commercetools.com/api/projects/payments#query-payments

  Parameters

  • options: CommonRequestOptions

  Returns Promise<PaymentPagedQueryResponse>

queryProductProjections

• queryProductProjections(options?): Promise<ProductProjectionPagedQueryResponse>

• Query product projections https://docs.commercetools.com/api/projects/productProjections#query-productprojections

  Parameters

  • Optional options: CommonRequestOptions

  Returns Promise<ProductProjectionPagedQueryResponse>

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>

queryProductTypes

• queryProductTypes(options): Promise<ProductTypePagedQueryResponse>

• Query product types: https://docs.commercetools.com/api/projects/productTypes#query-producttypes

  Parameters

  • options: CommonRequestOptions

  Returns Promise<ProductTypePagedQueryResponse>

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>

queryShippingMethods

• queryShippingMethods(options?): Promise<ShippingMethodPagedQueryResponse>

• Query shipping methods: https://docs.commercetools.com/api/projects/shippingMethods#query-shippingmethods

  Parameters

  • Optional options: CommonRequestOptions

  Returns Promise<ShippingMethodPagedQueryResponse>

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>

queryStates

• queryStates(options?): Promise<StatePagedQueryResponse>

• Query state https://docs.commercetools.com/api/projects/states#query-states

  Parameters

  • Optional options: CommonRequestOptions

  Returns Promise<StatePagedQueryResponse>

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>

queryTypes

• queryTypes(options): Promise<TypePagedQueryResponse>

• Query types: https://docs.commercetools.com/api/projects/types#query-types

  Parameters

  • options: CommonRequestOptions

  Returns Promise<TypePagedQueryResponse>

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>

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>

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>

searchProductProjections

• searchProductProjections(options): Promise<ProductProjectionPagedQueryResponse>

• Search product projections https://docs.commercetools.com/api/projects/products-search#search-productprojections

  Parameters

  • options: CommonStoreEnabledRequestOptions

  Returns Promise<ProductProjectionPagedQueryResponse>

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>