GET /v1/items

Scope

read_items

Request parameters

Name	In	Type	Required	Description
limit	query	integer	optional
offset	query	integer	optional
category_id	query	integer	optional
q	query	string	optional	keyword on item name

Response example

{
  "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
  }
}

Description

List items (UCP Catalog: Search & Lookup)

Error response example

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

Possible errors: 401 / 403