ApiMethods
All API endpoints available in the integration out of the box
export interface ApiMethods {
addBillingAddress(params: AddBillingAddressParams, customQuery?: CustomQuery): Promise<AddBillingAddressResponse>;
addMultipleToMyShoppingList(params: AddMultipleToMyShoppingListParams, customQuery?: CustomQuery): Promise<AddMultipleToMyShoppingListResponse>;
addReview(params: AddReviewParams, customQuery?: CustomQuery): Promise<AddReviewResponse>;
addShippingAddress(params: AddShippingAddressParams, customQuery?: CustomQuery): Promise<AddShippingAddressResponse>;
addToCart(cart: AddToCartParams, product: AddToCartProductParams, customQuery?: CustomQuery): Promise<AddToCartResponse>;
addToMyShoppingList(params: AddToMyShoppingListParams, customQuery?: CustomQuery): Promise<AddToMyShoppingListResponse>;
applyCartCoupon(params: ApplyCartCouponParams, discountCode: string, customQuery?: CustomQuery): Promise<ApplyCartCouponResponse>;
createCart(cartDraft?: CreateCartParams, customQuery?: CustomQuery): Promise<CreateCartResponse>;
createMyOrderFromCart(draft: CreateMyOrderFromCartParams, customQuery?: CustomQuery): Promise<CreateMyOrderFromCartResponse>;
createMyShoppingList(draft: CreateMyShoppingListParams, customQuery?: CustomQuery): Promise<CreateMyShoppingListResponse>;
customerChangeMyPassword(version: string, currentPassword: string, newPassword: string): Promise<CustomerChangeMyPasswordResponse>;
customerCreatePasswordResetToken(email: string, expose: boolean, customQuery?: CustomQuery): Promise<CustomerCreatePasswordResetTokenResponse>;
customerResetPassword(tokenValue: string, newPassword: string, customQuery?: CustomQuery): Promise<CustomerResetPasswordResponse>;
customerSignMeIn(draft: CustomerSignMeInDraft): Promise<CustomerSignMeInResponse>;
customerSignMeUp(draft: CustomerSignMeUpDraft): Promise<CustomerSignMeUpResponse>;
customerSignOut(): Promise<void>;
customerUpdateMe(currentUser: CustomerUpdateCurrentUser, updatedUserData: UpdatedUserData, customQuery?: CustomQuery): Promise<CustomerUpdateMeResponse>;
deleteBillingAddress(params: DeleteBillingAddressParams, customQuery?: CustomQuery): Promise<DeleteBillingAddressResponse>;
deleteCart(params: DeleteCartParams, customQuery?: CustomQuery): Promise<DeleteCartResponse>;
deleteReview(params: DeleteReviewParams, customQuery?: CustomQuery): Promise<DeleteReviewResponse>;
deleteShippingAddress(params: DeleteShippingAddressParams, customQuery?: CustomQuery): Promise<DeleteShippingAddressResponse>;
getCart(cartId: string): Promise<GetCartResponse>;
getCategory(params: CategoryWhereSearch, customQuery?: CustomQuery): Promise<GetCategoryResponse>;
getChannel(params: GetChannelParams): Promise<GetChannelResponse>;
getFacet(params: GetFacetParams, customQuery?: CustomQuery): Promise<GetFacetResponse>;
getFacetCategories(params: CategoryWhereSearch, customQuery?: CustomQuery): Promise<GetFacetCategoriesResponse>;
getFacetProductProjection(params: GetFacetProductProjectionParams, customQuery?: CustomQuery): Promise<GetFacetProductProjectionResponse>;
getInventory(params: GetInventoryParams, customQuery?: CustomQuery): Promise<GetInventoryResponse>;
getMe(params?: GetMeParams, customQuery?: CustomQuery): Promise<GetMeResponse>;
getMyShoppingList(customQuery?: CustomQuery): Promise<GetMyShoppingListResponse>;
getOrders(params: GetOrdersParams, customQuery?: CustomQuery): Promise<GetOrdersResponse>;
getProduct(params: ProductWhereSearch, customQuery?: CustomQuery): Promise<GetProductResponse>;
getReview(params: GetReviewParams, customQuery?: CustomQuery): Promise<GetReviewResponse>;
getShippingMethods(cartId?: string, customQuery?: CustomQuery): Promise<GetShippingMethodsResponse>;
getShoppingList(params: GetShoppingListParams, customQuery?: CustomQuery): Promise<GetShoppingListResponse>;
getStores(params: StoresWhereSearch): Promise<GetStoresResponse>;
isGuest(): Promise<isGuestResponse>;
isLoggedIn(): Promise<isLoggedInResponse>;
removeCartCoupon(params: RemoveCartCouponParams, discountCode: ReferenceInput, customQuery?: CustomQuery): Promise<RemoveCartCouponResponse>;
removeFromCart(cart: RemoveFromCartParams, product: LineItem, customQuery?: CustomQuery): Promise<RemoveFromCartResponse>;
removeFromMyShoppingList(params: RemoveFromMyShoppingListParams, customQuery?: CustomQuery): Promise<RemoveFromMyShoppingListResponse>;
setDefaultBillingAddress(params: SetDefaultBillingAddressParams, customQuery?: CustomQuery): Promise<SetDefaultBillingAddressResponse>;
setDefaultShippingAddress(params: SetDefaultShippingAddressParams, customQuery?: CustomQuery): Promise<SetDefaultShippingAddressResponse>;
updateBillingAddress(params: UpdateBillingAddressParams, customQuery?: CustomQuery): Promise<UpdateBillingAddressResponse>;
updateCart(params: UpdateCartParams, customQuery?: CustomQuery): Promise<UpdateCartResponse>;
updateCartItemChannel(cart: UpdateCartItemChannelParams, product: UpdateCartItemChannelProductParams, customQuery?: CustomQuery): Promise<UpdateCartItemChannelResponse>;
updateCartQuantity(cart: UpdateCartQuantityParams, product: UpdateCartQuantityProductParams, customQuery?: CustomQuery): Promise<UpdateCartQuantityResponse>;
updateMyCustomer(params: UpdateMyCustomerParams, customQuery?: CustomQuery): Promise<UpdateMyCustomerResponse>;
updateShippingAddress(params: UpdateShippingAddressParams, customQuery?: CustomQuery): Promise<UpdateShippingAddressResponse>;
updateShippingDetails(cart: UpdateShippingDetailsParams, shippingDetails: AddressInput, customQuery?: CustomQuery): Promise<UpdateShippingDetailsResponse>;
}addBillingAddress
See the addBillingAddress function
Signature
addBillingAddress(
params: AddBillingAddressParams,
customQuery?: CustomQuery
): Promise<AddBillingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | AddBillingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
addMultipleToMyShoppingList
See the addMultipleToMyShoppingList function
Signature
addMultipleToMyShoppingList(
params: AddMultipleToMyShoppingListParams,
customQuery?: CustomQuery
): Promise<AddMultipleToMyShoppingListResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | AddMultipleToMyShoppingListParams | |
customQuery | Optional | CustomQuery |
Referenced Types
addReview
See the addReview function
Signature
addReview(
params: AddReviewParams,
customQuery?: CustomQuery
): Promise<AddReviewResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | AddReviewParams | |
customQuery | Optional | CustomQuery |
Referenced Types
addShippingAddress
See the addShippingAddress function
Signature
addShippingAddress(
params: AddShippingAddressParams,
customQuery?: CustomQuery
): Promise<AddShippingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | AddShippingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
addToCart
See the addToCart function
Signature
addToCart(
cart: AddToCartParams,
product: AddToCartProductParams,
customQuery?: CustomQuery
): Promise<AddToCartResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cart | Required | AddToCartParams | |
product | Required | AddToCartProductParams | |
customQuery | Optional | CustomQuery |
Referenced Types
addToMyShoppingList
See the addToMyShoppingList function
Signature
addToMyShoppingList(
params: AddToMyShoppingListParams,
customQuery?: CustomQuery
): Promise<AddToMyShoppingListResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | AddToMyShoppingListParams | |
customQuery | Optional | CustomQuery |
Referenced Types
applyCartCoupon
See the applyCartCoupon function
Signature
applyCartCoupon(
params: ApplyCartCouponParams,
discountCode: string,
customQuery?: CustomQuery
): Promise<ApplyCartCouponResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | ApplyCartCouponParams | |
discountCode | Required | string | |
customQuery | Optional | CustomQuery |
Referenced Types
createCart
See the createCart function
Signature
createCart(
cartDraft?: CreateCartParams,
customQuery?: CustomQuery
): Promise<CreateCartResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cartDraft | Optional | CreateCartParams | |
customQuery | Optional | CustomQuery |
Referenced Types
createMyOrderFromCart
See the createMyOrderFromCart function
Signature
createMyOrderFromCart(
draft: CreateMyOrderFromCartParams,
customQuery?: CustomQuery
): Promise<CreateMyOrderFromCartResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
draft | Required | CreateMyOrderFromCartParams | |
customQuery | Optional | CustomQuery |
Referenced Types
createMyShoppingList
See the createMyShoppingList function
Signature
createMyShoppingList(
draft: CreateMyShoppingListParams,
customQuery?: CustomQuery
): Promise<CreateMyShoppingListResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
draft | Required | CreateMyShoppingListParams | |
customQuery | Optional | CustomQuery |
Referenced Types
customerChangeMyPassword
See the customerChangeMyPassword function
Signature
customerChangeMyPassword(
version: string,
currentPassword: string,
newPassword: string
): Promise<CustomerChangeMyPasswordResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
version | Required | string | |
currentPassword | Required | string | |
newPassword | Required | string |
Referenced Types
customerCreatePasswordResetToken
See the customerCreatePasswordResetToken function
Signature
customerCreatePasswordResetToken(
email: string,
expose: boolean,
customQuery?: CustomQuery
): Promise<CustomerCreatePasswordResetTokenResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
email | Required | string | |
expose | Required | boolean | |
customQuery | Optional | CustomQuery |
Referenced Types
customerResetPassword
See the customerResetPassword function
Signature
customerResetPassword(
tokenValue: string,
newPassword: string,
customQuery?: CustomQuery
): Promise<CustomerResetPasswordResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
tokenValue | Required | string | |
newPassword | Required | string | |
customQuery | Optional | CustomQuery |
Referenced Types
customerSignMeIn
See the customerSignMeIn function
Signature
customerSignMeIn(
draft: CustomerSignMeInDraft
): Promise<CustomerSignMeInResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
draft | Required | CustomerSignMeInDraft |
Referenced Types
customerSignMeUp
See the customerSignMeUp function
Signature
customerSignMeUp(
draft: CustomerSignMeUpDraft
): Promise<CustomerSignMeUpResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
draft | Required | CustomerSignMeUpDraft |
Referenced Types
customerSignOut
See the customerSignOut function
Signature
customerSignOut(
): Promise<void>;customerUpdateMe
See the customerUpdateMe function
Signature
customerUpdateMe(
currentUser: CustomerUpdateCurrentUser,
updatedUserData: UpdatedUserData,
customQuery?: CustomQuery
): Promise<CustomerUpdateMeResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
currentUser | Required | CustomerUpdateCurrentUser | |
updatedUserData | Required | UpdatedUserData | |
customQuery | Optional | CustomQuery |
Referenced Types
deleteBillingAddress
See the deleteBillingAddress function
Signature
deleteBillingAddress(
params: DeleteBillingAddressParams,
customQuery?: CustomQuery
): Promise<DeleteBillingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | DeleteBillingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
deleteCart
See the deleteCart function
Signature
deleteCart(
params: DeleteCartParams,
customQuery?: CustomQuery
): Promise<DeleteCartResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | DeleteCartParams | |
customQuery | Optional | CustomQuery |
Referenced Types
deleteReview
See the deleteReview function
Signature
deleteReview(
params: DeleteReviewParams,
customQuery?: CustomQuery
): Promise<DeleteReviewResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | DeleteReviewParams | |
customQuery | Optional | CustomQuery |
Referenced Types
deleteShippingAddress
See the deleteShippingAddress function
Signature
deleteShippingAddress(
params: DeleteShippingAddressParams,
customQuery?: CustomQuery
): Promise<DeleteShippingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | DeleteShippingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
getCart
See the getCart function
Signature
getCart(
cartId: string
): Promise<GetCartResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cartId | Required | string |
Referenced Types
getCategory
See the getCategory function
Signature
getCategory(
params: CategoryWhereSearch,
customQuery?: CustomQuery
): Promise<GetCategoryResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | CategoryWhereSearch | |
customQuery | Optional | CustomQuery |
Referenced Types
getChannel
See the getChannel function
Signature
getChannel(
params: GetChannelParams
): Promise<GetChannelResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | GetChannelParams |
Referenced Types
getFacet
See the getFacet function
Signature
getFacet(
params: GetFacetParams,
customQuery?: CustomQuery
): Promise<GetFacetResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | GetFacetParams | |
customQuery | Optional | CustomQuery |
Referenced Types
getFacetCategories
See the getFacetCategories function
Signature
getFacetCategories(
params: CategoryWhereSearch,
customQuery?: CustomQuery
): Promise<GetFacetCategoriesResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | CategoryWhereSearch | |
customQuery | Optional | CustomQuery |
Referenced Types
getFacetProductProjection
See the getFacetProductProjection function
Signature
getFacetProductProjection(
params: GetFacetProductProjectionParams,
customQuery?: CustomQuery
): Promise<GetFacetProductProjectionResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | GetFacetProductProjectionParams | |
customQuery | Optional | CustomQuery |
Referenced Types
getInventory
See the getInventory function
Signature
getInventory(
params: GetInventoryParams,
customQuery?: CustomQuery
): Promise<GetInventoryResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | GetInventoryParams | |
customQuery | Optional | CustomQuery |
Referenced Types
getMe
See the getMe function
Signature
getMe(
params?: GetMeParams,
customQuery?: CustomQuery
): Promise<GetMeResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Optional | GetMeParams | |
customQuery | Optional | CustomQuery |
Referenced Types
getMyShoppingList
See the getMyShoppingList function
Signature
getMyShoppingList(
customQuery?: CustomQuery
): Promise<GetMyShoppingListResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
customQuery | Optional | CustomQuery |
Referenced Types
getOrders
See the getOrders function
Signature
getOrders(
params: GetOrdersParams,
customQuery?: CustomQuery
): Promise<GetOrdersResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | GetOrdersParams | |
customQuery | Optional | CustomQuery |
Referenced Types
getProduct
See the getProduct function
Signature
getProduct(
params: ProductWhereSearch,
customQuery?: CustomQuery
): Promise<GetProductResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | ProductWhereSearch | |
customQuery | Optional | CustomQuery |
Referenced Types
getReview
See the getReview function
Signature
getReview(
params: GetReviewParams,
customQuery?: CustomQuery
): Promise<GetReviewResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | GetReviewParams | |
customQuery | Optional | CustomQuery |
Referenced Types
getShippingMethods
See the getShippingMethods function
Signature
getShippingMethods(
cartId?: string,
customQuery?: CustomQuery
): Promise<GetShippingMethodsResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cartId | Optional | string | |
customQuery | Optional | CustomQuery |
Referenced Types
getShoppingList
See the getShoppingList function
Signature
getShoppingList(
params: GetShoppingListParams,
customQuery?: CustomQuery
): Promise<GetShoppingListResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | GetShoppingListParams | |
customQuery | Optional | CustomQuery |
Referenced Types
getStores
See the getStores function
Signature
getStores(
params: StoresWhereSearch
): Promise<GetStoresResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | StoresWhereSearch |
Referenced Types
isGuest
See the isGuest function
Signature
isGuest(
): Promise<isGuestResponse>;Referenced Types
isLoggedIn
See the isLoggedIn function
Signature
isLoggedIn(
): Promise<isLoggedInResponse>;Referenced Types
removeCartCoupon
See the removeCartCoupon function
Signature
removeCartCoupon(
params: RemoveCartCouponParams,
discountCode: ReferenceInput,
customQuery?: CustomQuery
): Promise<RemoveCartCouponResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | RemoveCartCouponParams | |
discountCode | Required | ReferenceInput | |
customQuery | Optional | CustomQuery |
Referenced Types
removeFromCart
See the removeFromCart function
Signature
removeFromCart(
cart: RemoveFromCartParams,
product: LineItem,
customQuery?: CustomQuery
): Promise<RemoveFromCartResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cart | Required | RemoveFromCartParams | |
product | Required | LineItem | |
customQuery | Optional | CustomQuery |
Referenced Types
removeFromMyShoppingList
See the removeFromMyShoppingList function
Signature
removeFromMyShoppingList(
params: RemoveFromMyShoppingListParams,
customQuery?: CustomQuery
): Promise<RemoveFromMyShoppingListResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | RemoveFromMyShoppingListParams | |
customQuery | Optional | CustomQuery |
Referenced Types
setDefaultBillingAddress
See the setDefaultBillingAddress function
Signature
setDefaultBillingAddress(
params: SetDefaultBillingAddressParams,
customQuery?: CustomQuery
): Promise<SetDefaultBillingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | SetDefaultBillingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
setDefaultShippingAddress
See the setDefaultShippingAddress function
Signature
setDefaultShippingAddress(
params: SetDefaultShippingAddressParams,
customQuery?: CustomQuery
): Promise<SetDefaultShippingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | SetDefaultShippingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
updateBillingAddress
See the updateBillingAddress function
Signature
updateBillingAddress(
params: UpdateBillingAddressParams,
customQuery?: CustomQuery
): Promise<UpdateBillingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | UpdateBillingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
updateCart
See the updateCart function
Signature
updateCart(
params: UpdateCartParams,
customQuery?: CustomQuery
): Promise<UpdateCartResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | UpdateCartParams | |
customQuery | Optional | CustomQuery |
Referenced Types
updateCartItemChannel
See the updateCartItemChannel function
Signature
updateCartItemChannel(
cart: UpdateCartItemChannelParams,
product: UpdateCartItemChannelProductParams,
customQuery?: CustomQuery
): Promise<UpdateCartItemChannelResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cart | Required | UpdateCartItemChannelParams | |
product | Required | UpdateCartItemChannelProductParams | |
customQuery | Optional | CustomQuery |
Referenced Types
updateCartQuantity
See the updateCartQuantity function
Signature
updateCartQuantity(
cart: UpdateCartQuantityParams,
product: UpdateCartQuantityProductParams,
customQuery?: CustomQuery
): Promise<UpdateCartQuantityResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cart | Required | UpdateCartQuantityParams | |
product | Required | UpdateCartQuantityProductParams | |
customQuery | Optional | CustomQuery |
Referenced Types
updateMyCustomer
See the updateMyCustomer function
Signature
updateMyCustomer(
params: UpdateMyCustomerParams,
customQuery?: CustomQuery
): Promise<UpdateMyCustomerResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | UpdateMyCustomerParams | |
customQuery | Optional | CustomQuery |
Referenced Types
updateShippingAddress
See the updateShippingAddress function
Signature
updateShippingAddress(
params: UpdateShippingAddressParams,
customQuery?: CustomQuery
): Promise<UpdateShippingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
params | Required | UpdateShippingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
updateShippingDetails
See the updateShippingDetails function
Signature
updateShippingDetails(
cart: UpdateShippingDetailsParams,
shippingDetails: AddressInput,
customQuery?: CustomQuery
): Promise<UpdateShippingDetailsResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
cart | Required | UpdateShippingDetailsParams | |
shippingDetails | Required | AddressInput | |
customQuery | Optional | CustomQuery |