Shop MCP server for AI agents

Let Claude, ChatGPT or your own agent read and act on Shop: 34 typed functions through one MCP server. No Shop API key needed.

Functions
34
Sign-in
For account actions
Works with
MCP, HTTP, Node, Python

Connect

Just Shop

An MCP server for Shop alone, with one tool per function. Paste it into Claude, ChatGPT, Cursor or any MCP client as a remote server.

https://api.bowmark.ai/mcp/site/shop_app
Every site

One MCP server for Shop and every other site Bowmark covers. Your agent looks up what it needs and calls it.

https://api.bowmark.ai/mcp
Set it up in your client

Both need a Bowmark API key. The quickstart gets you one and a first result in a few minutes. Functions that need a login use the person's own account: how sign-in works.

Functions

Open a function to see its arguments, what it returns and how to call it.

Read 25
  • browseCategoryBrowses one Shop product category by the id listCategories returns.

    Arguments

    NameTypeRequired
    categoryIdstringYes
    afterstringNo

    Returns ShopAppCategoryFeed

    interface ShopAppDiscoveryProduct {
      id: string;
      title: string;
      url: string;
      price: number | null;
      originalPrice: number | null;
      currency: string | null;
      imageUrl: string | null;
      rating: number | null;
      reviewCount: number | null;
      variantsCount: number | null;
      store: { id: string | null; name: string | null; handle: string | null };
    }
    
    interface ShopAppCategoryFeed {
      categoryId: string;
      name: string | null;
      breadcrumbs: string[];
      subcategories: { id: string; name: string }[];
      sections: { title: string | null; categoryId: string | null; products: ShopAppDiscoveryProduct[] }[];
      hasNextPage: boolean;
      cursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/browseCategory

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.browseCategory({ categoryId: "25" });
  • getAccountReads the caller's Shop account settings: whether they opted out of data sharing, and the country and EU status Shop resolved for them.

    Arguments

    None.

    Returns ShopAppAccount

    interface ShopAppAccount {
      dataSharingOptOut: boolean | null;
      countryCode: string | null;
      isMemberOfEuropeanUnion: boolean | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getAccount

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getAccount();
  • getCartReads the caller's Shop cart: one cart per store with its lines and the store's checkout url.

    Arguments

    None.

    Returns ShopAppCart

    interface ShopAppCartLine {
      id: string;
      variantId: string | null;
      title: string | null;
      quantity: number | null;
      price: number | null;
      currency: string | null;
    }
    
    interface ShopAppStoreCart {
      id: string;
      store: string | null;
      storeUuid: string | null;
      totalQuantity: number | null;
      checkoutUrl: string | null;
      lines: ShopAppCartLine[];
    }
    
    interface ShopAppCart {
      carts: ShopAppStoreCart[];
      totalItemCount: number | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getCart

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getCart();
  • getDiscoveryFeedReads Shop's home discovery feed.

    Arguments

    NameTypeRequired
    args{ pageSize?: number; after?: string }No

    Returns ShopAppDiscoveryFeed

    interface ShopAppDiscoveryProduct {
      id: string;
      title: string;
      url: string;
      price: number | null;
      originalPrice: number | null;
      currency: string | null;
      imageUrl: string | null;
      rating: number | null;
      reviewCount: number | null;
      variantsCount: number | null;
      store: { id: string | null; name: string | null; handle: string | null };
    }
    
    interface ShopAppFeedSection {
      kind: string | null;
      title: string | null;
      categoryId: string | null;
      products: ShopAppDiscoveryProduct[];
      stores: { id: string; name: string | null; handle: string | null; rating: number | null }[];
    }
    
    interface ShopAppDiscoveryFeed {
      feedId: string | null;
      sections: ShopAppFeedSection[];
      hasNextPage: boolean;
      cursor: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getDiscoveryFeed

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getDiscoveryFeed();
  • getOrderReads one of the caller's orders.

    Arguments

    NameTypeRequired
    idstringYes

    Returns ShopAppOrderDetail

    interface ShopAppOrderItem {
      title: string;
      variant: string | null;
      quantity: number | null;
      total: number | null;
      image: string | null;
    }
    
    interface ShopAppOrderShipment {
      status: string | null;
      carrier: string | null;
      trackingCode: string | null;
      trackingUrl: string | null;
      items: ShopAppOrderItem[];
    }
    
    interface ShopAppOrderDetail {
      id: string;
      orderNumber: string | null;
      placedAt: string | null;
      status: string | null;
      store: string | null;
      currency: string | null;
      subtotal: number | null;
      shipping: number | null;
      tax: number | null;
      total: number | null;
      shippingAddress: string[];
      items: ShopAppOrderItem[];
      shipments: ShopAppOrderShipment[];
      url: string;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getOrder

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getOrder("1234567890");
  • getProductOne product by its numeric id or a shop.app/products/<id>/<slug> url: title, description, store, rating, review count, every option axis ("Color"…

    Arguments

    NameTypeRequired
    inputstringYes

    Returns ShopAppProduct

    interface ShopAppProductOption {
      name: string;
      values: string[];
    }
    
    interface ShopAppSelectedVariant {
      id: string;
      title: string;
      availableForSale: boolean;
      price: number | null;
      currency: string | null;
      imageUrl: string | null;
      selectedOptions: { name: string; value: string }[];
    }
    
    interface ShopAppProduct {
      id: string;
      title: string;
      description: string | null;
      descriptionHtml: string | null;
      url: string;
      store: { id: string; name: string; handle: string | null };
      rating: number | null;
      reviewCount: number | null;
      variantsCount: number | null;
      options: ShopAppProductOption[];
      selectedVariant: ShopAppSelectedVariant | null;
      imageUrls: string[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getProduct

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getProduct("7454740152417");
  • getProductReviewsA product's reviews, a page at a time.

    Arguments

    NameTypeRequired
    productstringYes
    firstnumberNo
    afterstringNo
    searchQuerystringNo

    Returns ShopAppProductReviews

    interface ShopAppProductReview {
      id: string;
      rating: number;
      title: string | null;
      body: string | null;
      reviewerName: string | null;
      submittedAt: string | null;
      helpfulCount: number | null;
      variantTitle: string | null;
      variantId: string | null;
      imageUrls: string[];
    }
    
    interface ShopAppProductReviews {
      productId: string;
      totalCount: number | null;
      reviews: ShopAppProductReview[];
      hasNextPage: boolean;
      cursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getProductReviews

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getProductReviews({ product: "7084852019339", first: 3 });
  • getShopCashReads the caller's Shop Cash balance and its recent activity.

    Arguments

    None.

    Returns ShopAppShopCash

    interface ShopAppShopCash {
      amount: number | null;
      currency: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getShopCash

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getShopCash();
  • getStoreReads one store's Shop page.

    Arguments

    NameTypeRequired
    inputstringYes

    Returns ShopAppStore

    interface ShopAppStore {
      id: string;
      name: string;
      description: string | null;
      descriptionHtml: string | null;
      url: string;
      handle: string;
      logoUrl: string | null;
      rating: number | null;
      reviewCount: number | null;
      followerCount: number | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getStore

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getStore("baggu");
  • getStoreCollectionLists the products in one of a store's collections ("Best Sellers", "Sugar-Free"), taking a shop.app/m/<handle>/collections/<id>/<slug> url or the…

    Arguments

    NameTypeRequired
    handleOrUrlstringYes
    collectionIdstringNo

    Returns ShopAppStoreCollection

    interface ShopAppStoreProduct {
      id: string;
      title: string;
      price: number | null;
      currency: string | null;
      imageUrl: string | null;
      rating: number | null;
      reviewCount: number | null;
      url: string;
    }
    
    interface ShopAppStoreCollection {
      id: string;
      title: string;
      slug: string;
      products: ShopAppStoreProduct[];
      hasNextPage: boolean;
      cursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getStoreCollection

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getStoreCollection("liquidiv", "273501224996");
  • getStoreContactsReads how to reach a store.

    Arguments

    NameTypeRequired
    handlestringYes

    Returns ShopAppStoreContacts

    interface ShopAppStoreContact {
      method: string;
      target: string;
    }
    
    interface ShopAppStoreContacts {
      email: string | null;
      phone: string | null;
      website: string | null;
      contactPage: string | null;
      contacts: ShopAppStoreContact[];
      address: string[] | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getStoreContacts

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getStoreContacts("liquidiv");
  • getStorePoliciesReads a store's refund, shipping and privacy policies as plain text.

    Arguments

    NameTypeRequired
    handlestringYes

    Returns ShopAppStorePolicies

    interface ShopAppStorePolicy {
      url: string;
      text: string;
    }
    
    interface ShopAppStorePolicies {
      refund: ShopAppStorePolicy | null;
      shipping: ShopAppStorePolicy | null;
      privacy: ShopAppStorePolicy | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getStorePolicies

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getStorePolicies("liquidiv");
  • getStoreReviewsLists the reviews left across a whole store.

    Arguments

    NameTypeRequired
    handlestringYes
    options{ first?: number }No

    Returns ShopAppStoreReviews

    interface ShopAppStoreReview {
      id: string;
      rating: number;
      body: string | null;
      reviewerName: string | null;
      submittedAt: string | null;
      productId: string | null;
      productTitle: string | null;
    }
    
    interface ShopAppStoreReviews {
      rating: number | null;
      reviewCount: number | null;
      reviews: ShopAppStoreReview[];
      hasNextPage: boolean;
      cursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getStoreReviews

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getStoreReviews("liquidiv");
  • getVariantPicks one variant of a product by its options ({ Size: "Large", Color: "Powder Blue" }, one value for EVERY axis getProduct lists) and returns that…

    Arguments

    NameTypeRequired
    productstringYes
    optionsRecord<string, string>Yes

    Returns ShopAppVariant

    interface ShopAppSelectedVariant {
      id: string;
      title: string;
      availableForSale: boolean;
      price: number | null;
      currency: string | null;
      imageUrl: string | null;
      selectedOptions: { name: string; value: string }[];
    }
    
    interface ShopAppVariant extends ShopAppSelectedVariant {
      compareAtPrice: number | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/getVariant

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.getVariant({
      product: "7084852019339",
      options: { Pack: "1 Band", Size: "Large", Color: "Powder Blue" }
    });
  • listAddressesLists the caller's saved shipping addresses on Shop.

    Arguments

    None.

    Returns ShopAppAddressList

    interface ShopAppAddress {
      id: string | null;
      firstName: string | null;
      lastName: string | null;
      company: string | null;
      address1: string | null;
      address2: string | null;
      city: string | null;
      zoneCode: string | null;
      postalCode: string | null;
      country: string | null;
      phone: string | null;
      formatted: string[];
      preferred: boolean;
    }
    
    interface ShopAppAddressList {
      addresses: ShopAppAddress[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/listAddresses

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.listAddresses();
  • listCategoriesLists Shop's product categories (Women, Men, Beauty, Home, Fitness, Baby, Food …).

    Arguments

    NameTypeRequired
    parentIdstringNo

    Returns ShopAppCategoryList

    interface ShopAppCategory {
      id: string;
      name: string;
      hasChildren: boolean;
      filters: string[];
      path: string[];
    }
    
    interface ShopAppCategoryList {
      parentId: string | null;
      categories: ShopAppCategory[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/listCategories

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.listCategories();
  • listFollowedStoresLists the stores the signed-in caller follows on Shop, a page at a time.

    Arguments

    NameTypeRequired
    firstnumberNo
    cursorstringNo

    Returns ShopAppFollowedStores

    interface ShopAppFollowedStore {
      id: string;
      name: string | null;
      logo: string | null;
      followedByMe: boolean | null;
    }
    
    interface ShopAppFollowedStores {
      stores: ShopAppFollowedStore[];
      nextCursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/listFollowedStores

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.listFollowedStores();
  • listOffersLists the current Shop offers and promotions.

    Arguments

    NameTypeRequired
    args{ pageSize?: number; after?: string }No

    Returns ShopAppOffers

    interface ShopAppDiscoveryProduct {
      id: string;
      title: string;
      url: string;
      price: number | null;
      originalPrice: number | null;
      currency: string | null;
      imageUrl: string | null;
      rating: number | null;
      reviewCount: number | null;
      variantsCount: number | null;
      store: { id: string | null; name: string | null; handle: string | null };
    }
    
    interface ShopAppOffer {
      store: { id: string | null; name: string | null; handle: string | null };
      summary: string | null;
      shopCashMinimumOrder: { amount: number | null; currency: string | null } | null;
      products: ShopAppDiscoveryProduct[];
    }
    
    interface ShopAppOffers {
      offers: ShopAppOffer[];
      hasNextPage: boolean;
      cursor: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/listOffers

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.listOffers();
  • listOrdersLists the signed-in caller's orders from every store they bought from with Shop.

    Arguments

    NameTypeRequired
    status"active" | "past" | "all"No
    querystringNo
    cursorstringNo

    Returns ShopAppOrderList

    interface ShopAppOrder {
      id: string;
      placedAt: string | null;
      status: string | null;
      deliveryStatus: string | null;
      paymentStatus: string | null;
      total: number | null;
      currency: string | null;
      store: string | null;
      itemCount: number | null;
      images: string[];
      url: string;
    }
    
    interface ShopAppOrderList {
      orders: ShopAppOrder[];
      nextCursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/listOrders

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.listOrders();
  • listProductListsLists the caller's own Shop collections (wishlists) with a preview of each list's items, a page at a time.

    Arguments

    NameTypeRequired
    firstnumberNo
    cursorstringNo

    Returns ShopAppProductLists

    interface ShopAppProductList {
      id: string;
      name: string | null;
      publicId: string | null;
      privacy: string | null;
      isDefault: boolean;
      ownedByMe: boolean | null;
      coverImage: string | null;
      inviteUrl: string | null;
      items: { variantId: string; image: string | null }[];
    }
    
    interface ShopAppProductLists {
      lists: ShopAppProductList[];
      nextCursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/listProductLists

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.listProductLists();
  • listSavedProductsLists the products the signed-in caller has saved (hearted) on Shop, a page at a time.

    Arguments

    NameTypeRequired
    firstnumberNo
    cursorstringNo

    Returns ShopAppSavedProducts

    interface ShopAppSavedProduct {
      productId: string | null;
      variantId: string;
      title: string | null;
      variantTitle: string | null;
      price: number | null;
      compareAtPrice: number | null;
      currency: string | null;
      available: boolean | null;
      image: string | null;
      store: string | null;
      url: string | null;
    }
    
    interface ShopAppSavedProducts {
      products: ShopAppSavedProduct[];
      nextCursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/listSavedProducts

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.listSavedProducts();
  • listStoreProductsLists a store's products, sorted by best-selling, newest or price, filtered to in-stock or by the store's own filters, with id, title, price, image…

    Arguments

    NameTypeRequired
    handlestringYes
    options{ first?: number; sortBy?: string; search?: string }No

    Returns ShopAppStoreProductList

    interface ShopAppStoreProduct {
      id: string;
      title: string;
      price: number | null;
      currency: string | null;
      imageUrl: string | null;
      rating: number | null;
      reviewCount: number | null;
      url: string;
    }
    
    interface ShopAppStoreProductList {
      products: ShopAppStoreProduct[];
      hasNextPage: boolean;
      cursor: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/listStoreProducts

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.listStoreProducts("baggu");
  • searchProductsSearches every Shopify store on Shop for products matching free text ("trail running shoes", "linen duvet cover") and returns each product's id…

    Arguments

    NameTypeRequired
    argsstring | { query: string; pageSize?: number; after?: string }Yes

    Returns ShopAppProductSearch

    interface ShopAppDiscoveryProduct {
      id: string;
      title: string;
      url: string;
      price: number | null;
      originalPrice: number | null;
      currency: string | null;
      imageUrl: string | null;
      rating: number | null;
      reviewCount: number | null;
      variantsCount: number | null;
      store: { id: string | null; name: string | null; handle: string | null };
    }
    
    interface ShopAppProductSearch {
      query: string;
      /** Products from every Shopify store on Shop, Shop's own relevance order. */
      products: ShopAppDiscoveryProduct[];
      hasNextPage: boolean;
      /** Pass as `after` for the next page. */
      cursor: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/searchProducts

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.searchProducts("running shoes");
  • searchStoreSearches inside one store for products matching free text ("strawberry" in Liquid I.V.), with the store's own alternate query phrases for a miss or a…

    Arguments

    NameTypeRequired
    handlestringYes
    querystringYes

    Returns ShopAppStoreSearchResults

    interface ShopAppStoreProduct {
      id: string;
      title: string;
      price: number | null;
      currency: string | null;
      imageUrl: string | null;
      rating: number | null;
      reviewCount: number | null;
      url: string;
    }
    
    interface ShopAppStoreSearchResults {
      products: ShopAppStoreProduct[];
      suggestedTerms: string[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/searchStore

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.searchStore("liquidiv", "strawberry");
  • suggestSearchesAutocompletes a partial search ("running sh") into Shop's own query suggestions plus the stores whose names match, each store with its handle, logo…

    Arguments

    NameTypeRequired
    querystringYes

    Returns ShopAppSearchSuggestions

    interface ShopAppSearchSuggestion {
      text: string;
      type: string;
      storeHandle?: string;
      storeName?: string;
      storeRating?: number | null;
      storeReviewCount?: number | null;
    }
    
    interface ShopAppSearchSuggestions {
      suggestions: ShopAppSearchSuggestion[];
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/suggestSearches

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.suggestSearches("running");
Act 9
  • addAddressAdds a shipping address to the caller's Shop account, or sets one as preferred.

    Arguments

    NameTypeRequired
    firstNamestringYes
    lastNamestringYes
    address1stringYes
    address2stringNo
    citystringYes
    zoneCodestringNo
    postalCodestringNo
    countrystringYes
    companystringNo
    phonestringNo

    Returns ShopAppAddress

    interface ShopAppAddress {
      id: string | null;
      firstName: string | null;
      lastName: string | null;
      company: string | null;
      address1: string | null;
      address2: string | null;
      city: string | null;
      zoneCode: string | null;
      postalCode: string | null;
      country: string | null;
      phone: string | null;
      formatted: string[];
      preferred: boolean;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/addAddress

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.addAddress({
      firstName: "<firstName>",
      lastName: "<lastName>",
      address1: "<address1>",
      city: "<city>",
      country: "<country>"
    });
  • addToCartAdds a product variant to the caller's Shop cart at its store (quantity 1 by default, or a selling plan).

    Arguments

    NameTypeRequired
    storestringYes
    variantIdstringYes
    quantitynumberNo
    sellingPlanIdstringNo

    Returns ShopAppAddedToCart

    interface ShopAppCheckoutAccount { site: string; hint: string; signedInAs?: string; signInUrl?: string; }
    
    interface ShopAppCheckoutItem { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string; } // prices are decimal strings
    
    interface ShopAppCheckoutSummary { items: ShopAppCheckoutItem[]; total: string | null; currency: string; }
    
    /** Where to finish: open url, signed in as account. Bowmark never pays. status is ready_to_checkout, needs_login or unavailable (reason + detail say why). */
    interface ShopAppCheckoutHandoff { status: "ready_to_checkout" | "needs_login" | "unavailable"; url: string; urlKind?: "carries_items" | "signed_in_cart" | "product_page"; account: ShopAppCheckoutAccount; summary: ShopAppCheckoutSummary | null; reason?: string; detail?: string; expiresAt?: string; warnings: string[]; }
    
    interface ShopAppAddedToCart {
      storeId: string;
      variantId: string;
      quantity: number;
      cartId: string | null;
      lineCount: number;
      warnings: string[];
      checkout?: ShopAppCheckoutHandoff;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/addToCart

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.addToCart({ store: "<store>", variantId: "<variantId>" });
  • addToProductListAdds a product to one of the caller's lists, or removes it (remove: true).

    Arguments

    NameTypeRequired
    listIdstringYes
    variantIdstringYes
    storestringNo
    removebooleanNo

    Returns ShopAppListItemState

    interface ShopAppListItemState {
      variantId: string;
      listId: string | null;
      inList: boolean;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/addToProductList

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.addToProductList({ listId: "<listId>", variantId: "<variantId>" });
  • createProductListCreates a new named product list for the caller.

    Arguments

    NameTypeRequired
    namestringYes
    privacy"PRIVATE" | "PUBLIC"No

    Returns ShopAppCreatedProductList

    interface ShopAppCreatedProductList {
      id: string;
      name: string | null;
      publicId: string | null;
      privacy: "PRIVATE" | "PUBLIC";
      inviteUrl: string | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/createProductList

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.createProductList({ name: "<name>" });
  • followStoreFollows a store on Shop for the caller, or unfollows it (follow: false), by its Shop store id or handle.

    Arguments

    NameTypeRequired
    storestringYes
    followbooleanNo

    Returns ShopAppFollowState

    interface ShopAppFollowState {
      storeId: string;
      following: boolean;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/followStore

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.followStore({ store: "<store>" });
  • markOrderDeliveredMarks one of the caller's Shop deliveries as delivered, or un-marks it (delivered: false), by the deliveryId trackPackage returns.

    Arguments

    NameTypeRequired
    deliveryIdstringYes
    deliveredbooleanNo

    Returns ShopAppDeliveryState

    interface ShopAppDeliveryState {
      deliveryId: string;
      delivered: boolean;
      url: string;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/markOrderDelivered

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.markOrderDelivered({ deliveryId: "<deliveryId>" });
  • saveProductSaves a product to the caller's Shop favourites, or removes it (saved: false).

    Arguments

    NameTypeRequired
    variantIdstringYes
    storestringNo
    savedbooleanNo

    Returns ShopAppListItemState

    interface ShopAppListItemState {
      variantId: string;
      listId: string | null;
      inList: boolean;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/saveProduct

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.saveProduct({ variantId: "<variantId>" });
  • startCheckoutOpens a checkout for the caller's cart at one store and returns the checkout url for the caller to review and pay.

    Arguments

    NameTypeRequired
    storestringYes

    Returns ShopAppCheckout

    interface ShopAppCheckoutAccount { site: string; hint: string; signedInAs?: string; signInUrl?: string; }
    
    interface ShopAppCheckoutItem { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string; } // prices are decimal strings
    
    interface ShopAppCheckoutSummary { items: ShopAppCheckoutItem[]; total: string | null; currency: string; }
    
    /** Where to finish: open url, signed in as account. Bowmark never pays. status is ready_to_checkout, needs_login or unavailable (reason + detail say why). */
    interface ShopAppCheckoutHandoff { status: "ready_to_checkout" | "needs_login" | "unavailable"; url: string; urlKind?: "carries_items" | "signed_in_cart" | "product_page"; account: ShopAppCheckoutAccount; summary: ShopAppCheckoutSummary | null; reason?: string; detail?: string; expiresAt?: string; warnings: string[]; }
    
    interface ShopAppCheckout {
      storeId: string;
      checkoutId: string | null;
      url: string;
      warnings: string[];
      checkout?: ShopAppCheckoutHandoff;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/startCheckout

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.startCheckout({ store: "<store>" });
  • trackPackageAdds a package to the caller's Shop by its tracking number and carrier, so Shop tracks it, and returns its current status.

    Arguments

    NameTypeRequired
    trackingCodestringYes
    carrierstringNo
    namestringNo
    destinationPostalCodestringNo

    Returns ShopAppTrackedPackage

    interface ShopAppTrackedPackage {
      deliveryId: string;
      trackingCode: string;
      carrier: string;
      alreadyTracked: boolean;
      url: string;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/shop_app/trackPackage

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.shop_app.trackPackage({ trackingCode: "<trackingCode>" });

Use it from code