商品自由項目一覧取得

GET

/products/{product_id}/reserve_items

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/products/example/reserve_items';
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/pos/products/example/reserve_items \
  --header 'Authorization: Bearer <token>'

商品自由項目情報一覧を取得します。

対象プラン

スタンダード
プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

Authorizations

AppAccessToken
pos.products:read
UserAccessToken
pos.products:read

Parameters

Path Parameters

product_id

required

string

商品ID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

no：商品自由項目番号

limit

integer

上限数

page

integer

ページ

Responses

200

取得成功

application/json

Array<object>

object

productId

商品ID：数字15桁以内

string

商品自由項目番号：1-99 の商品自由項目に付与されている連番。

string

value

値：85文字以内。自由項目の値。

string

Example

[
  {
    "productId": "string",
    "no": "string",
    "value": "string"
  }
]