商品属性項目登録

POST

/products/attribute_items

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/products/attribute_items';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"no":"1","name":"string","displaySequence":"123"}'
};

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

curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/products/attribute_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "no": "1", "name": "string", "displaySequence": "123" }'

商品属性項目を登録します。

対象プラン

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

Authorizations

AppAccessToken
pos.products:write
UserAccessToken
pos.products:write

Request Body

application/json

object

required

項目番号

商品属性に付与されている連番

string format: int

>= 1 <= 3

name

required

選択肢名

商品属性項目の名称

string format: string

<= 30 characters

displaySequence

表示順

表示順序

string format: int

>= 1 <= 999

Example

{
  "no": "1",
  "name": "string",
  "displaySequence": "123"
}

Responses

200

取得成功

application/json

object

code

商品属性項目を一意にする項目

string

商品属性に付与されている連番

string

name

商品属性項目の名称

string

displaySequence

表示順序

string

Example

{
  "code": "string",
  "no": "string",
  "name": "string",
  "displaySequence": "string"
}

400

項目番号で指定された商品属性が存在しなかった場合
上限を超えて登録しようとした場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された商品属性が存在しません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された商品属性に登録できる商品属性項目の件数の上限をオーバーしたため、登録できません",
  "status": 400
}