商品タグ更新

PATCH

/product_tags/{product_tag_id}

curl --request PATCH \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/product_tags/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "特売品（更新）", "attachProducts": [ { "id": "55555555-5555-5555-5555-555555555555" } ], "detachProducts": [ { "id": "66666666-6666-6666-6666-666666666666" } ] }'

• サンドボックス
• 本番

商品タグ情報を更新します。

Authorizations

• AppAccessToken
  ec-b2b.product-tags:write

Parameters

Path Parameters

product_tag_id

required

string format: uuid

商品タグID

Request Body^required

Media typeapplication/json

ProductTagUpdateRequest

object

name

タグ名

string

>= 1 characters <= 255 characters

attachProducts

紐付けを追加する商品

既に紐付いているIDを指定しても重複は追加されません（冪等）。 指定するIDは既存の商品である必要があります（存在しない場合は 400）。

Array<object>

<= 255 items

object

id

required

商品ID

string format: uuid

detachProducts

紐付けを解除する商品

紐付いていないIDを指定しても無視されます。 attachProducts と detachProducts に同一IDを指定した場合、attach → detach の順で処理されるため最終的に解除されます。

Array<object>

<= 255 items

object

id

required

商品ID

string format: uuid

Examples

Exampledefault

{
  "name": "特売品（更新）",
  "attachProducts": [
    {
      "id": "55555555-5555-5555-5555-555555555555"
    }
  ],
  "detachProducts": [
    {
      "id": "66666666-6666-6666-6666-666666666666"
    }
  ]
}

Responses

200

更新成功

Media typeapplication/json

ProductTagResponse

object

id

商品タグID

string format: uuid

name

タグ名

string

>= 1 characters <= 255 characters

Examples

Exampledefault

{
  "id": "11111111-1111-1111-1111-111111111111",
  "name": "特売品"
}

400

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

Media typeapplication/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[name]は255文字以下で指定してください。",
  "status": 400
}

404

指定されたIDのリソースが見つからない場合

Media typeapplication/json

object

type

required

string

title

required

string

detail

string

status

integer

Example

{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}