コンテンツにスキップ

商品画像登録

POST
/product_images
curl --request POST \
--url https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/product_images \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "url": "https://example.com/images/product01.jpg", "alt": "商品画像01" }'

商品画像情報を登録します。

Media typeapplication/json
ProductImageRequest
object
url

画像URL

完全なURLを推奨します。ただし現行システムからの移行データではファイル名(相対パス)が格納・返却される場合があるため、URL形式の検証は行わず素の文字列として扱います。

string
alt

代替テキスト

string
nullable
Examples
Exampledefault
{
"url": "https://example.com/images/product01.jpg",
"alt": "商品画像01"
}

登録成功

Media typeapplication/json
ProductImageResponse
object
id

商品画像ID

string format: uuid
url

画像URL

完全なURLを推奨します。ただし現行システムからの移行データではファイル名(相対パス)が格納・返却される場合があるため、URL形式の検証は行わず素の文字列として扱います。

string
alt

代替テキスト

string
nullable
Examples
Exampledefault
{
"id": "33333333-3333-3333-3333-333333333333",
"url": "https://example.com/images/product01.jpg",
"alt": "商品画像01"
}

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

Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Example
{
"type": "about:blank",
"title": "Bad Request",
"detail": "request_json:[url]は文字列で指定してください。",
"status": 400
}

指定されたURLが既に登録されている場合

Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Example
{
"type": "about:blank",
"title": "Conflict",
"detail": "request_json:[url]はこの項目の値は既に存在しています。違う値を指定してください。",
"status": 409
}