GET /v1/items

scope

read_items

リクエストパラメーター

名前	位置	型	必須	説明
limit	クエリ	integer	任意
offset	クエリ	integer	任意
category_id	クエリ	integer	任意
q	クエリ	string	任意	keyword on item name

レスポンスの例

{
  "data": [
    {
      "id": "1",
      "sku": "string",
      "name": "string",
      "status": "active",
      "kind": "normal",
      "price": {
        "amount": 3200,
        "currency": "JPY"
      },
      "inventory": 0,
      "category_id": "string",
      "main_image": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}

解説

自ショップの公開商品を一覧取得します。q（商品名の部分一致）・category_id・limit/offset で絞り込めます。

エラーレスポンスの例

{
  "error": {
    "code": "insufficient_scope",
    "message": "requires scope 'read_orders'",
    "request_id": "req_01H..."
  }
}

返しうるエラー: 401 / 403