BoothMate API Documentation - v0.4.0
    Preparing search index...

    Class ShopService

    Index

    Constructors

    constructor

    Methods

    get getItems getItemList

    Constructors

    Methods

    • ショップ情報を取得します。

      指定されたサブドメインのショップの基本情報を取得します。

      Parameters

      • subdomain: string

        ショップのサブドメイン 例: https://example.booth.pm → example

      Returns Promise<undefined | Shop>

      ショップ情報(存在しない場合はundefined)

      // ショップの説明文を出力
      const shop = await client.shop.get('alphahub');
      if (shop) {
        console.log(shop.description);
      }

    • ショップの商品一覧を新着順で取得します。

      指定されたショップで販売されている商品の一覧をページ単位で取得します。

      Parameters

      • subdomain: string

        ショップのサブドメイン 例: https://example.booth.pm → example

      • page: number = 1

        取得するページ番号(デフォルト: 1)

      Returns Promise<undefined | ShopItems>

      ショップの商品一覧(ショップが存在しない場合はundefined)

      セッショントークン sessionToken は任意です。 指定すると、スキリストに追加済みかどうかの情報も各商品に含まれます。

      // ショップの最新の商品の商品名を出力
      const shopItems = await client.shop.getItems('alphahub');
      if (shopItems) {
        console.log(shopItems.items[0].name);
      }

    • ショップの商品リストを新着順で取得します。

      ショップが作成した特定の商品リスト(カテゴリ別商品一覧など) を取得します。

      Parameters

      • subdomain: string

        ショップのサブドメイン 例: https://example.booth.pm → example

      • itemListId: string

        商品リストのID 例: https://example.booth.pm/item_lists/8OVTLANn → 8OVTLANn

      • page: number = 1

        取得するページ番号(デフォルト: 1)

      Returns Promise<undefined | ItemList>

      商品リスト(商品リストが存在しない場合はundefined)

      セッショントークン sessionToken は任意です。 指定すると、スキリストに追加済みかどうかの情報も各商品に含まれます。

      // 商品リストの最新商品の商品名を出力
      const itemList = await client.shop.getItemList('mukumi', '8OVTLANn');
      if (itemList) {
        console.log(itemList.items[0].name);
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods