TOYOMART 食材館

• 商品を検索 — 商品名のキーワード(部分一致・日本語/中国語対応)で商品を検索する。価格は呼び出した顧客のアカウント種別(個人 / 法人など)に対応した単価で返る(price_list 未登録の variant は価格 null)。カテゴリで絞り込みたい場合は先に list_categories で得たカテゴリ id を categoryIds に渡す。1 ページ既定 20 件、最大 100 件。返るのは id / slug / name / 代表規格 defaultVariant / 代表価格 defaultPrice のサマリのみ。キーワードだけの検索は関連度順の上位 N 件を返しページングしない(nextOffset は常に null。total で全体件数は分かる) — ページングしたい場合は offset か categoryIds を指定すると一覧順のページングになり、次ページがあるとき nextOffset に次の offset が入る。商品詳細(全 variant・単価)は get_product で取得する。
• 商品の詳細 — 商品の slug を指定してその商品の詳細(全バリエーション SKU と、呼び出した顧客の価格ティアの単価)を取得する。slug は search_products の結果に含まれる。公開されていない(下書き/アーカイブ)商品は「存在しない」扱い(isError)。
• カテゴリ一覧 — トップレベルのカテゴリ一覧を、各カテゴリ配下(子孫含む)の商品件数つきで返す。search_products の categoryIds に渡す id を得るために使う。引数なし。
• 自分の注文一覧 — 呼び出した顧客自身の注文を新しい順(注文日時の降順)に、サマリ(注文番号 orderSn、注文日時 orderedAt、配達希望日、注文/支払い/出荷ステータス、合計金額 total、商品名の要約 itemSummary)で返す。明細・配送先・支払い内訳は含まれない — 個別注文の中身は get_order で取得する。1 ページ既定 20 件、最大 100 件。次ページがあるときは nextOffset に次の offset が入る(無ければ null。ページが満杯のときは次ページが空のことがある)。注文が無ければ orders は空配列(エラーではない)。
• 注文の詳細 — 注文番号(orderSn)を指定して、その注文の詳細(明細 items、配送先 snapshot、注文ステータス、支払い状況 stripePayment)を取得する。orderSn は list_my_orders の結果に含まれる。呼び出した顧客が所有しない注文番号(または存在しない番号)は「存在しない」扱いになる(isError、他人の注文の存在有無は漏れない)。

Schemas and invoke metadata: Directory API