商品グループ一覧取得

GET

/product_groups

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/product_groups?limit=10&page=1&sort=name%3Adesc';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/product_groups?limit=10&page=1&sort=name%3Adesc' \
  --header 'Authorization: Bearer <token>'

商品グループ情報の一覧を取得します。

Authorizations

AppAccessToken
ec-b2b.product-groups:read

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

取得件数

page

integer

default: 1 >= 1

ページ

sort

string

default: name:desc

Allowed values: name name:desc

ソート

name: グループ名

Example

name:desc

Responses

200

取得成功

application/json

Array

ProductGroupResponse

object

商品グループID

string format: uuid

referenceIdentifier

管理番号

使用可能文字: 半角英数字および - _ . #

string

>= 1 characters <= 255 characters /^[0-9A-Za-z\-_.#]+$/

name

グループ名

string

>= 1 characters <= 255 characters

publishCode

公開ステータス

1: 公開
2: 下書き

integer

default: 1

Allowed values: 1 2

detailPageText

詳細ページテキスト

null または空文字 "" を指定した場合は、値がクリア（null）されます。

string

nullable <= 65535 characters

updatedAt

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

Examples

default

[
  {
    "id": "12345678-1234-1234-1234-1234567890ab",
    "referenceIdentifier": "group-001",
    "name": "夏季特集グループ",
    "publishCode": 1,
    "detailPageText": "夏季特集の商品グループです。",
    "updatedAt": "2025-06-09T14:15:40+09:00"
  },
  {
    "id": "12345678-1234-1234-1234-1234567890cd",
    "referenceIdentifier": "group-002",
    "name": "冬季特集グループ",
    "publishCode": 2,
    "detailPageText": null,
    "updatedAt": "2025-06-09T14:15:40+09:00"
  }
]

Headers

Link

<前ページURI>; rel="prev", <次ページURI>; rel="next"

string

400

入力チェックエラーの場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[limit]は100以下の数字を指定してください。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[page]は1以上の数字を指定してください。",
  "status": 400
}