商品一覧取得

呼び出し元のショップの商品を一覧で取得します。

公開・非公開の両方を対象に、商品詳細（GET /api/items/{id}）と同じ形式で返します。取得による商品情報の変更や通知の送信はありません。

総件数は返しません。取得件数が limit 未満の場合は、次のページはありません。

GET /api/items

スコープ items.read

リクエスト例

curl

curl -X GET "https://apiv2.thebase.com/api/items" \
  -H "Authorization: Bearer <your-token>"

パラメータ

visible "true" | "false" · query 任意

公開状態での絞り込み。true=公開中の商品のみ、false=非公開の商品のみ。未指定時は公開・非公開の両方を返します。

category_id integer · query 任意

絞り込み対象のカテゴリ ID。指定したカテゴリ自身、またはその配下のカテゴリに属する商品だけを返します。未指定時は絞り込みません。指定したカテゴリを参照できない場合も、参照できるカテゴリに該当商品がない場合と同様に、ステータスコード 200 で空配列を返します。レスポンスから両者を区別できません。

order "list_order" | "created" | "modified" · query 任意

並び替えの基準。list_order=ショップ内の表示順、created=作成日時、modified=最終更新日時。未指定時は表示順で並びます。

sort "asc" | "desc" · query 任意

並び順。asc=昇順、desc=降順。未指定時は昇順です。`order` で指定した基準に対して適用されます。

limit integer · query 任意

1 回のリクエストで取得する件数。1〜100 を指定できます。既定は 20 です。

offset integer | null · query 任意

取得を開始する位置。先頭から読み飛ばす件数を 0〜1,000,000 で指定します。既定は 0 です。

レスポンス

200 取得成功

200 のレスポンスボディ（application/json）:

配列。各要素: ItemDetailWithLinks

type の値により分岐します。

ItemDetailNormalWithLinks

type"normal"必須
商品種別。normal=デジタルコンテンツ・テイクアウト・定期便・抽選販売のいずれにも該当しない通常商品。
idinteger必須≥ 0
商品 ID
namestring必須
商品名
detailstring必須
商品説明文。利用者入力をそのまま返すため利用側で必ずエスケープしてください。未設定時は空文字列です。
identifierstring必須nullable
商品コード。ショップ運営者が任意で設定する識別子です。未設定時は null です。
priceinteger必須nullable
販売価格（税込、円）。未設定時は null です。
proper_priceinteger必須nullable
セール元値（税込、円）。セール未設定時は null です。
stockinteger必須
在庫数。種類がある場合は各種類の在庫数の合計、無い場合は商品本体の在庫数です。
visibleboolean必須
公開状態。false の間はショップ画面に表示されず購入もできません。
sales_statusItemSalesStatus必須
販売状態。item_waiting_for_sale=販売開始前、item_now_on_sale=販売中、item_end_of_sale=販売終了後。
item_tax_typeItemTaxType必須
税区分。standard=標準税率、reduced=軽減税率。
created_atstring (date-time)必須
商品の作成日時（ISO 8601・UTC）
modified_atstring (date-time)必須
商品の最終更新日時（ISO 8601・UTC）
imagesItemImage[]必須
商品画像（最大 20 件）。表示順に並びます。
- idinteger必須≥ 0
  画像 ID
- urlstring (uri)必須
  画像の公開 URL。アップロードされたままのサイズで返します。
- scaled_urlstring (uri)必須
  縦横比を保ったまま幅を変えた画像の URL。幅 640px を指定した例です。URL に含まれる幅の値を変えると、任意の幅で取得できます。
- square_urlstring (uri)必須
  中央を切り抜いて正方形にした画像の URL。一辺 900px を指定した例です。URL に含まれる寸法の値を変えると、任意の大きさで取得できます。
variationsItemVariation[]必須
種類一覧（最大 1000 件）。表示順に並びます。種類を持たない商品では空配列です。
- idinteger必須≥ 0
  種類 ID
- namestring任意
  種類名（例: カラー・サイズの表示名）。種類名を持たない（種類コードのみを保持する）種類では省略されます。
- stockinteger必須
  当該種類の在庫数
- identifierstring必須nullable
  種類コード（種類ごとの商品コード）。未設定時は null です。
- barcodestring必須nullable
  種類ごとの JAN / GTIN。未設定時は null です。
categoriesItemCategorySummary[]必須
所属カテゴリ一覧。未所属時は空配列です。
- idinteger必須≥ 0
  カテゴリ ID
- namestring必須
  カテゴリ名
- parentItemCategorySummary必須nullable
  上位カテゴリ。最上位カテゴリでは null です。
  ↻ ItemCategorySummary を再帰参照
optionsItemOption[]必須
商品オプション一覧（最大 6 件）。表示順に並びます。未設定時は空配列です。
option_type で分岐
ItemOptionSelect
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"select"必須
- choicesItemOptionChoice[]必須
  選択肢一覧。表示順に並びます。
  - idinteger必須≥ 0
    選択肢 ID。購入時にどの選択肢を選んだかを指します。
  - namestring必須
    選択肢名
  - extra_priceinteger必須
    選択時に加算される金額（税込、円）
ItemOptionForm
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"form"必須
- option_variation_idinteger必須nullable≥ 0
  購入時に指定する ID。値が未設定のオプションでは null です。
- extra_priceinteger必須
  入力時に加算される金額（税込、円）。選択肢ごとに変わる select と違い一律です。
- max_lengthinteger必須nullable
  自由入力の最大文字数。未設定時は null です。
- free_text_descriptionstring必須nullable
  自由入力欄に表示する補足説明。未設定時は null です。
quantity_limitinteger必須nullable
1 回の購入における同時購入数の上限。未設定時は null です。
_linksobject必須
このリソースに関連する操作へのリンク集合。リソースの状態やトークンのスコープによってリンクの有無は変わりません。
- update_itemLink必須
  商品編集
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- delete_itemLink必須
  商品削除
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_stockLink必須
  在庫設定
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_visibilityLink必須
  公開状態の切り替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_list_orderLink必須
  並び順の変更
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_imageLink必須
  画像追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_imagesLink必須
  画像の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- create_file_uploadLink必須
  アップロード先発行
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_variationLink必須
  種類追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_variationsLink必須
  種類の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL

ItemDetailDigitalWithLinks

type"digital"必須
商品種別。digital=デジタルコンテンツ。
idinteger必須≥ 0
商品 ID
namestring必須
商品名
detailstring必須
商品説明文。利用者入力をそのまま返すため利用側で必ずエスケープしてください。未設定時は空文字列です。
identifierstring必須nullable
商品コード。ショップ運営者が任意で設定する識別子です。未設定時は null です。
priceinteger必須nullable
販売価格（税込、円）。未設定時は null です。
proper_priceinteger必須nullable
セール元値（税込、円）。セール未設定時は null です。
stockinteger必須
在庫数。種類がある場合は各種類の在庫数の合計、無い場合は商品本体の在庫数です。
visibleboolean必須
公開状態。false の間はショップ画面に表示されず購入もできません。
sales_statusItemSalesStatus必須
販売状態。item_waiting_for_sale=販売開始前、item_now_on_sale=販売中、item_end_of_sale=販売終了後。
item_tax_typeItemTaxType必須
税区分。standard=標準税率、reduced=軽減税率。
created_atstring (date-time)必須
商品の作成日時（ISO 8601・UTC）
modified_atstring (date-time)必須
商品の最終更新日時（ISO 8601・UTC）
imagesItemImage[]必須
商品画像（最大 20 件）。表示順に並びます。
- idinteger必須≥ 0
  画像 ID
- urlstring (uri)必須
  画像の公開 URL。アップロードされたままのサイズで返します。
- scaled_urlstring (uri)必須
  縦横比を保ったまま幅を変えた画像の URL。幅 640px を指定した例です。URL に含まれる幅の値を変えると、任意の幅で取得できます。
- square_urlstring (uri)必須
  中央を切り抜いて正方形にした画像の URL。一辺 900px を指定した例です。URL に含まれる寸法の値を変えると、任意の大きさで取得できます。
variationsItemVariation[]必須
種類一覧（最大 1000 件）。表示順に並びます。種類を持たない商品では空配列です。
- idinteger必須≥ 0
  種類 ID
- namestring任意
  種類名（例: カラー・サイズの表示名）。種類名を持たない（種類コードのみを保持する）種類では省略されます。
- stockinteger必須
  当該種類の在庫数
- identifierstring必須nullable
  種類コード（種類ごとの商品コード）。未設定時は null です。
- barcodestring必須nullable
  種類ごとの JAN / GTIN。未設定時は null です。
categoriesItemCategorySummary[]必須
所属カテゴリ一覧。未所属時は空配列です。
- idinteger必須≥ 0
  カテゴリ ID
- namestring必須
  カテゴリ名
- parentItemCategorySummary必須nullable
  上位カテゴリ。最上位カテゴリでは null です。
  ↻ ItemCategorySummary を再帰参照
optionsItemOption[]必須
商品オプション一覧（最大 6 件）。表示順に並びます。未設定時は空配列です。
option_type で分岐
ItemOptionSelect
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"select"必須
- choicesItemOptionChoice[]必須
  選択肢一覧。表示順に並びます。
  - idinteger必須≥ 0
    選択肢 ID。購入時にどの選択肢を選んだかを指します。
  - namestring必須
    選択肢名
  - extra_priceinteger必須
    選択時に加算される金額（税込、円）
ItemOptionForm
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"form"必須
- option_variation_idinteger必須nullable≥ 0
  購入時に指定する ID。値が未設定のオプションでは null です。
- extra_priceinteger必須
  入力時に加算される金額（税込、円）。選択肢ごとに変わる select と違い一律です。
- max_lengthinteger必須nullable
  自由入力の最大文字数。未設定時は null です。
- free_text_descriptionstring必須nullable
  自由入力欄に表示する補足説明。未設定時は null です。
quantity_limitinteger必須nullable
1 回の購入における同時購入数の上限。未設定時は null です。
digitalItemDigital必須
ダウンロード用ファイルの名前・サイズ・拡張子。type=digital のとき必ず存在します。
- file_namestring必須
  ダウンロード用ファイルの表示名
- file_sizeinteger必須
  ファイルサイズ（バイト）
- file_extstring必須
  ファイル拡張子（小文字）
_linksobject必須
このリソースに関連する操作へのリンク集合。リソースの状態やトークンのスコープによってリンクの有無は変わりません。
- update_itemLink必須
  商品編集
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- delete_itemLink必須
  商品削除
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_stockLink必須
  在庫設定
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_visibilityLink必須
  公開状態の切り替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_list_orderLink必須
  並び順の変更
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_imageLink必須
  画像追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_imagesLink必須
  画像の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- create_file_uploadLink必須
  アップロード先発行
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_variationLink必須
  種類追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_variationsLink必須
  種類の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL

ItemDetailTakeoutWithLinks

type"takeout"必須
商品種別。takeout=テイクアウト。
idinteger必須≥ 0
商品 ID
namestring必須
商品名
detailstring必須
商品説明文。利用者入力をそのまま返すため利用側で必ずエスケープしてください。未設定時は空文字列です。
identifierstring必須nullable
商品コード。ショップ運営者が任意で設定する識別子です。未設定時は null です。
priceinteger必須nullable
販売価格（税込、円）。未設定時は null です。
proper_priceinteger必須nullable
セール元値（税込、円）。セール未設定時は null です。
stockinteger必須
在庫数。種類がある場合は各種類の在庫数の合計、無い場合は商品本体の在庫数です。
visibleboolean必須
公開状態。false の間はショップ画面に表示されず購入もできません。
sales_statusItemSalesStatus必須
販売状態。item_waiting_for_sale=販売開始前、item_now_on_sale=販売中、item_end_of_sale=販売終了後。
item_tax_typeItemTaxType必須
税区分。standard=標準税率、reduced=軽減税率。
created_atstring (date-time)必須
商品の作成日時（ISO 8601・UTC）
modified_atstring (date-time)必須
商品の最終更新日時（ISO 8601・UTC）
imagesItemImage[]必須
商品画像（最大 20 件）。表示順に並びます。
- idinteger必須≥ 0
  画像 ID
- urlstring (uri)必須
  画像の公開 URL。アップロードされたままのサイズで返します。
- scaled_urlstring (uri)必須
  縦横比を保ったまま幅を変えた画像の URL。幅 640px を指定した例です。URL に含まれる幅の値を変えると、任意の幅で取得できます。
- square_urlstring (uri)必須
  中央を切り抜いて正方形にした画像の URL。一辺 900px を指定した例です。URL に含まれる寸法の値を変えると、任意の大きさで取得できます。
variationsItemVariation[]必須
種類一覧（最大 1000 件）。表示順に並びます。種類を持たない商品では空配列です。
- idinteger必須≥ 0
  種類 ID
- namestring任意
  種類名（例: カラー・サイズの表示名）。種類名を持たない（種類コードのみを保持する）種類では省略されます。
- stockinteger必須
  当該種類の在庫数
- identifierstring必須nullable
  種類コード（種類ごとの商品コード）。未設定時は null です。
- barcodestring必須nullable
  種類ごとの JAN / GTIN。未設定時は null です。
categoriesItemCategorySummary[]必須
所属カテゴリ一覧。未所属時は空配列です。
- idinteger必須≥ 0
  カテゴリ ID
- namestring必須
  カテゴリ名
- parentItemCategorySummary必須nullable
  上位カテゴリ。最上位カテゴリでは null です。
  ↻ ItemCategorySummary を再帰参照
optionsItemOption[]必須
商品オプション一覧（最大 6 件）。表示順に並びます。未設定時は空配列です。
option_type で分岐
ItemOptionSelect
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"select"必須
- choicesItemOptionChoice[]必須
  選択肢一覧。表示順に並びます。
  - idinteger必須≥ 0
    選択肢 ID。購入時にどの選択肢を選んだかを指します。
  - namestring必須
    選択肢名
  - extra_priceinteger必須
    選択時に加算される金額（税込、円）
ItemOptionForm
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"form"必須
- option_variation_idinteger必須nullable≥ 0
  購入時に指定する ID。値が未設定のオプションでは null です。
- extra_priceinteger必須
  入力時に加算される金額（税込、円）。選択肢ごとに変わる select と違い一律です。
- max_lengthinteger必須nullable
  自由入力の最大文字数。未設定時は null です。
- free_text_descriptionstring必須nullable
  自由入力欄に表示する補足説明。未設定時は null です。
quantity_limitinteger必須nullable
1 回の購入における同時購入数の上限。未設定時は null です。
_linksobject必須
このリソースに関連する操作へのリンク集合。リソースの状態やトークンのスコープによってリンクの有無は変わりません。
- update_itemLink必須
  商品編集
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- delete_itemLink必須
  商品削除
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_stockLink必須
  在庫設定
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_visibilityLink必須
  公開状態の切り替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_list_orderLink必須
  並び順の変更
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_imageLink必須
  画像追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_imagesLink必須
  画像の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- create_file_uploadLink必須
  アップロード先発行
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_variationLink必須
  種類追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_variationsLink必須
  種類の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL

ItemDetailSubscriptionWithLinks

type"subscription"必須
商品種別。subscription=定期便。
idinteger必須≥ 0
商品 ID
namestring必須
商品名
detailstring必須
商品説明文。利用者入力をそのまま返すため利用側で必ずエスケープしてください。未設定時は空文字列です。
identifierstring必須nullable
商品コード。ショップ運営者が任意で設定する識別子です。未設定時は null です。
priceinteger必須nullable
販売価格（税込、円）。未設定時は null です。
proper_priceinteger必須nullable
セール元値（税込、円）。セール未設定時は null です。
stockinteger必須
在庫数。種類がある場合は各種類の在庫数の合計、無い場合は商品本体の在庫数です。
visibleboolean必須
公開状態。false の間はショップ画面に表示されず購入もできません。
sales_statusItemSalesStatus必須
販売状態。item_waiting_for_sale=販売開始前、item_now_on_sale=販売中、item_end_of_sale=販売終了後。
item_tax_typeItemTaxType必須
税区分。standard=標準税率、reduced=軽減税率。
created_atstring (date-time)必須
商品の作成日時（ISO 8601・UTC）
modified_atstring (date-time)必須
商品の最終更新日時（ISO 8601・UTC）
imagesItemImage[]必須
商品画像（最大 20 件）。表示順に並びます。
- idinteger必須≥ 0
  画像 ID
- urlstring (uri)必須
  画像の公開 URL。アップロードされたままのサイズで返します。
- scaled_urlstring (uri)必須
  縦横比を保ったまま幅を変えた画像の URL。幅 640px を指定した例です。URL に含まれる幅の値を変えると、任意の幅で取得できます。
- square_urlstring (uri)必須
  中央を切り抜いて正方形にした画像の URL。一辺 900px を指定した例です。URL に含まれる寸法の値を変えると、任意の大きさで取得できます。
variationsItemVariation[]必須
種類一覧（最大 1000 件）。表示順に並びます。種類を持たない商品では空配列です。
- idinteger必須≥ 0
  種類 ID
- namestring任意
  種類名（例: カラー・サイズの表示名）。種類名を持たない（種類コードのみを保持する）種類では省略されます。
- stockinteger必須
  当該種類の在庫数
- identifierstring必須nullable
  種類コード（種類ごとの商品コード）。未設定時は null です。
- barcodestring必須nullable
  種類ごとの JAN / GTIN。未設定時は null です。
categoriesItemCategorySummary[]必須
所属カテゴリ一覧。未所属時は空配列です。
- idinteger必須≥ 0
  カテゴリ ID
- namestring必須
  カテゴリ名
- parentItemCategorySummary必須nullable
  上位カテゴリ。最上位カテゴリでは null です。
  ↻ ItemCategorySummary を再帰参照
optionsItemOption[]必須
商品オプション一覧（最大 6 件）。表示順に並びます。未設定時は空配列です。
option_type で分岐
ItemOptionSelect
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"select"必須
- choicesItemOptionChoice[]必須
  選択肢一覧。表示順に並びます。
  - idinteger必須≥ 0
    選択肢 ID。購入時にどの選択肢を選んだかを指します。
  - namestring必須
    選択肢名
  - extra_priceinteger必須
    選択時に加算される金額（税込、円）
ItemOptionForm
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"form"必須
- option_variation_idinteger必須nullable≥ 0
  購入時に指定する ID。値が未設定のオプションでは null です。
- extra_priceinteger必須
  入力時に加算される金額（税込、円）。選択肢ごとに変わる select と違い一律です。
- max_lengthinteger必須nullable
  自由入力の最大文字数。未設定時は null です。
- free_text_descriptionstring必須nullable
  自由入力欄に表示する補足説明。未設定時は null です。
quantity_limitinteger必須nullable
1 回の購入における同時購入数の上限。未設定時は null です。
subscriptionItemSubscription必須
定期便の価格・リピート回数・課金周期。type=subscription のとき必ず存在します。
- repeat_priceinteger必須
  リピート時の価格（税込、円）。セール適用後の値です。
- repeat_proper_priceinteger必須nullable
  リピート時のセール元値（税込、円）。セール未設定時は null です。
- initial_priceinteger必須nullable
  初回価格（税込、円）。未設定時は null です。
- repeat_timesItemSubscriptionRepeatTimes必須
  リピート回数。repeat_3_times / repeat_6_times / repeat_12_times は指定回数で終了し、unlimited は停止されるまで継続します。
- cycle_planItemSubscriptionCyclePlan必須
  課金周期。weekly=毎週、every_2_weeks=隔週、monthly=毎月、every_45_days=45日ごと、every_2_months=隔月、every_3_months=3ヶ月ごと。
_linksobject必須
このリソースに関連する操作へのリンク集合。リソースの状態やトークンのスコープによってリンクの有無は変わりません。
- update_itemLink必須
  商品編集
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- delete_itemLink必須
  商品削除
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_stockLink必須
  在庫設定
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_visibilityLink必須
  公開状態の切り替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_list_orderLink必須
  並び順の変更
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_imageLink必須
  画像追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_imagesLink必須
  画像の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- create_file_uploadLink必須
  アップロード先発行
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_variationLink必須
  種類追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_variationsLink必須
  種類の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL

ItemDetailLotteryWithLinks

type"lottery"必須
商品種別。lottery=抽選販売。
idinteger必須≥ 0
商品 ID
namestring必須
商品名
detailstring必須
商品説明文。利用者入力をそのまま返すため利用側で必ずエスケープしてください。未設定時は空文字列です。
identifierstring必須nullable
商品コード。ショップ運営者が任意で設定する識別子です。未設定時は null です。
priceinteger必須nullable
販売価格（税込、円）。未設定時は null です。
proper_priceinteger必須nullable
セール元値（税込、円）。セール未設定時は null です。
stockinteger必須
在庫数。種類がある場合は各種類の在庫数の合計、無い場合は商品本体の在庫数です。
visibleboolean必須
公開状態。false の間はショップ画面に表示されず購入もできません。
sales_statusItemSalesStatus必須
販売状態。item_waiting_for_sale=販売開始前、item_now_on_sale=販売中、item_end_of_sale=販売終了後。
item_tax_typeItemTaxType必須
税区分。standard=標準税率、reduced=軽減税率。
created_atstring (date-time)必須
商品の作成日時（ISO 8601・UTC）
modified_atstring (date-time)必須
商品の最終更新日時（ISO 8601・UTC）
imagesItemImage[]必須
商品画像（最大 20 件）。表示順に並びます。
- idinteger必須≥ 0
  画像 ID
- urlstring (uri)必須
  画像の公開 URL。アップロードされたままのサイズで返します。
- scaled_urlstring (uri)必須
  縦横比を保ったまま幅を変えた画像の URL。幅 640px を指定した例です。URL に含まれる幅の値を変えると、任意の幅で取得できます。
- square_urlstring (uri)必須
  中央を切り抜いて正方形にした画像の URL。一辺 900px を指定した例です。URL に含まれる寸法の値を変えると、任意の大きさで取得できます。
variationsItemVariation[]必須
種類一覧（最大 1000 件）。表示順に並びます。種類を持たない商品では空配列です。
- idinteger必須≥ 0
  種類 ID
- namestring任意
  種類名（例: カラー・サイズの表示名）。種類名を持たない（種類コードのみを保持する）種類では省略されます。
- stockinteger必須
  当該種類の在庫数
- identifierstring必須nullable
  種類コード（種類ごとの商品コード）。未設定時は null です。
- barcodestring必須nullable
  種類ごとの JAN / GTIN。未設定時は null です。
categoriesItemCategorySummary[]必須
所属カテゴリ一覧。未所属時は空配列です。
- idinteger必須≥ 0
  カテゴリ ID
- namestring必須
  カテゴリ名
- parentItemCategorySummary必須nullable
  上位カテゴリ。最上位カテゴリでは null です。
  ↻ ItemCategorySummary を再帰参照
optionsItemOption[]必須
商品オプション一覧（最大 6 件）。表示順に並びます。未設定時は空配列です。
option_type で分岐
ItemOptionSelect
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"select"必須
- choicesItemOptionChoice[]必須
  選択肢一覧。表示順に並びます。
  - idinteger必須≥ 0
    選択肢 ID。購入時にどの選択肢を選んだかを指します。
  - namestring必須
    選択肢名
  - extra_priceinteger必須
    選択時に加算される金額（税込、円）
ItemOptionForm
- idinteger必須≥ 0
  オプション ID
- namestring必須
  オプション名
- requiredboolean必須
  購入時に入力／選択が必須か
- option_type"form"必須
- option_variation_idinteger必須nullable≥ 0
  購入時に指定する ID。値が未設定のオプションでは null です。
- extra_priceinteger必須
  入力時に加算される金額（税込、円）。選択肢ごとに変わる select と違い一律です。
- max_lengthinteger必須nullable
  自由入力の最大文字数。未設定時は null です。
- free_text_descriptionstring必須nullable
  自由入力欄に表示する補足説明。未設定時は null です。
quantity_limitinteger必須nullable
1 回の購入における同時購入数の上限。未設定時は null です。
lotteryItemLottery必須
抽選販売の応募期間・抽選状態・抽選や当落通知の日時・購入締切。type=lottery のとき必ず存在します。
- application_start_atstring (date-time)必須
  応募開始日時（ISO 8601・UTC）
- application_end_atstring (date-time)必須
  応募終了日時（ISO 8601・UTC）
- scheduled_drawing_atstring (date-time)必須nullable
  抽選実施予定日時（ISO 8601・UTC）。抽選日が未確定の場合は null です。
- scheduled_announce_atstring (date-time)必須
  当落通知予定日時（ISO 8601・UTC）
- expiration_atstring (date-time)必須nullable
  購入締切日時（ISO 8601・UTC）。設定されていない場合は null です。
- drawn_atstring (date-time)必須nullable
  実際に抽選を実施した日時（ISO 8601・UTC）。未実施の場合は null です。
- announced_atstring (date-time)必須nullable
  当落通知を実際に行った日時（ISO 8601・UTC）。未通知の場合は null です。
- cancelled_atstring (date-time)必須nullable
  抽選をキャンセルした日時（ISO 8601・UTC）。キャンセルされていない場合は null です。
- lottery_statusItemLotteryStatus必須
  抽選状態。before_lottery=抽選前、during_lottery=抽選中、announced=当落通知済み、cancelled=キャンセル済み、errored=エラー。
_linksobject必須
このリソースに関連する操作へのリンク集合。リソースの状態やトークンのスコープによってリンクの有無は変わりません。
- update_itemLink必須
  商品編集
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- delete_itemLink必須
  商品削除
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_stockLink必須
  在庫設定
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_visibilityLink必須
  公開状態の切り替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- update_item_list_orderLink必須
  並び順の変更
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_imageLink必須
  画像追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_imagesLink必須
  画像の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- create_file_uploadLink必須
  アップロード先発行
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- add_item_variationLink必須
  種類追加
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL
- reorder_item_variationsLink必須
  種類の並び替え
  - hrefstring (uri)必須
    エンドポイントの絶対 URL
  - method"GET" | "POST" | "PUT" | "DELETE"必須
    エンドポイントを呼び出す際に使う HTTP メソッド
  - document_hrefstring (uri)必須
    ドキュメントサイト上でこのエンドポイントを説明するページの URL

エラー

エラーは application/problem+json の Problem 形式で返します。認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと構造・判別方法はエラーレスポンスを参照してください。

このエンドポイントが返すその他のエラーは次のとおりです。

400 /errors/request/invalid-query 1 つ以上のクエリパラメータがエンドポイントのスキーマを満たさない場合に返します。