non-print
API Index
Request/Response Format
API要求と応答はJSON Formatに対応します。
個人情報保護のため、cafe24のAPIはHTTPSプロトコルのみ対応します。
Dates属性は ISO_8601 Formatで提供します。 : YYYY-MM-DDTHH:MM:SS+09:00
要求例題(検索)
要求例題(登録/修正)
正常応答例題
{
"resource": {
"key": "value",
"key": "value"
}
}
エラー応答例題
{
"error": {
"code": "error code",
"message": "error message",
"more_info": {
}
}
}
Front API Intro
Front APIは公開されている情報(商品表示情報)またはショップの顧客が本人の情報を検索したり投稿を作成したりする場合に適合しています。Front APIはAdmin APIに比べて一部の情報は制限されています。
使用例
https://{mallid}.cafe24api.com/api/v2/sampleapi
API Status Code
Code | 発生事例 | エラーの解決方法 |
---|---|---|
200 | GET成功、PUT成功、DELETE成功時 | |
201 | POST成功時 | |
207 | 多重要求登録時、ステータスが客体別に異なる場合 | エラーの状況を客体別に確認し、状況によって対応します。 |
400 | サーバーが要求を理解できない 1) Content- 2) application/ | 要求時に「Content- |
400 | 要求API URLにハングルまたは記号をエンコードせずにそのまま使った場合 | 要求API URLにハングルまたは記号をURLエンコードしたか確認します。 |
401 | 1) Access Token がない状況で呼び出した場合 2) Access Tokenが有効ではない場合 3) Access Tokenが満了した場合 4) 不明なクライアントの場合 | 有効な手続きを踏んで発行されたAccess Tokenを使っているか確認します。 |
401 | Front APIの使用時にclient_ | 有効なクライアントIDを使っているか確認します。 |
403 | 1) Access Tokenはあるが、Scopeに対する権限がない 2) FrontAPIで見る権限がない場合 | APIを呼び出す権限があるか、APIのScopeまたはショップの設定を確認します。 |
403 | httpsプロトコルではない場合 | API要求時にhttpsで要求したか確認します。 |
403 | 新バージョンの商品管理を使うショップではない場合 | 新バージョンの商品管理にショップを更新しないと使用できません。 |
403 | (Admin API呼び出し時)ショップでそのアプリが削除された場合 | ショップにアプリがインストールされているか確認し、アプリを再インストールします。 |
403 | (Front API呼び出し時)ショップでそのアプリが削除された場合 | ショップにアプリがインストールされているか確認し、アプリを再インストールします。 |
404 | 1) API URLを間違って呼び出した場合 2) リソースが見つからない場合 3) {#id}がない場合 | エンドポイントURLにエラーがないか、API文書を参考に確認します。 |
409 | 同じリソースで同じ内容を更新する場合 | 編集するデータをリクエストしてください。 |
422 | 検索/処理を要求した時、値が決まっているスペックと違う場合 1) 必須パラメーター抜け 2) 決まっているスペックと違う場合 | API文書を参考に必須パラメーターが入力されていないか、有効でない値が入力されているか確認します。 |
429 | クライアントのAPI要求がBucketを超過した場合 | API最大許容要求件数を超過しないようにしばらくしてからもう一度要求します。 |
500 | 内部サーバーエラー、不明なエラー | 一時的にエラーが発生しました。しばらくしてからもう一度お試しください。 |
503 | 現在のサーバーがダウンした場合 | 開発者センターにお問い合わせください。 |
503 | サーバーがダウンした場合。APIが使用できない | 開発者センターにお問い合わせください。 |
504 | 要求時間を超過した場合(Timeout) | 一時的にエラーが発生し、応答が遅れています。しばらくしてからもう一度お試しください。 |
1. 検索条件の追加
検索を行う際、エンドポイントにパラメーターを追加すると検索条件を追加することができます。
複数の条件に一致する結果を見つけたい場合、「&」を使用して検索条件を追加することができます。
APIで対応している場合、タイムゾーンを使用して日付・時間の検索も可能です。
検索条件の追加
例) 特定のブランドの商品の中で、商品の販売価格が1,000円以上の商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000
例) 商品登録日の範囲を指定して商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03
例) 商品修正日の範囲を指定して商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?updated_start_date=2018-01-03T14:01:26+09:00&updated_end_date=2018-02-03T14:01:26+09:00
2. カンマ(,)を使用した複数の値の検索
APIで対応している場合、カンマ(,)を使用して複数の値を同時に検索することができます。 (ただし、入力する項目の数は100件以下に調整してください。)
カンマ(,)で追加した検索条件はOR条件となり、条件を満たすすべての値が検索されます。
カンマ(,)を使用した複数の値の検索
例) 特定の商品番号を指定して商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13
例) 特定の商品番号と商品コードを指定して商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13&product_code=P000000X,P000000W
3. 越境ECショップ情報の検索
特定の越境ECショップ番号を明示することで、該当するショップの情報を検索することができます。
越境ECショップ番号を明示しない場合は基本ショップの情報が検索されます。
越境ECショップ情報の検索
例) 特定の越境ECショップの商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2
4. 詳細検索と単独(1件)検索
リソースのIDを明示することで詳細検索を行うことができます。
詳細検索では1件のリソースのみを対象に検索を行うことが可能ですが、リスト検索より多くの項目が返されます。
詳細検索と単独(1件)検索
例) 特定の商品番号を指定して商品の詳細検索を行う場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products/128
例) 特定の商品番号を指定して商品の単独(1件)検索を行う場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?product_no=128
5. Pagination
検索結果が多い場合、指定された「limit」のデフォルト値に基づいて結果が返されます。
「limit」パラメーターを利用して検索件数を増やすことが可能ですが、値が各APIに定義されている上限(最大値)を超えることはできません。
「limit」を利用する際の最大値ですべてのデータを検索できない場合、「offset」パラメーターで問題を解決することができます。
Pagination
例) 100点の商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100
例) 201番目から300番目までの商品を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100&offset=200
6. 特定項目の検索
「fields」パラメーターを利用すると、特定の項目のみを検索することができます
特定項目の検索
例) 「商品名」と「商品番号」項目のみを検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no
7. サブリソースの検索
APIで対応している場合、「embed」パラメーターを利用することでサブリソースのデータを一緒に検索することができます。
サブリソースの検索
例) 商品を検索する際において「品目」と「在庫」のデータを一緒に検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products/570?embed=variants,inventories
API Limit
cafe24のAPIは「Leaky Bucket」アルゴリズムで動きます。Leaky Bucketアルゴリズムは性能を高めるために非正常的に多いAPI要求のみ制限し、日常的なAPI要求は特に制限なく使えます。
cafe24のAPIはAPI要求をBucketに蓄積しておきます。Bucketはショップ当たり「呼び出し件数制限」を超過するとAPI呼び出しが制限されます。Bucketは1秒に2回ずつ減少し、減少した分だけ再度API呼び出しができます。
アプリが1秒に2回ずつAPIを呼び出す場合は特に制限なくAPI呼び出しを使い続けることができます。
瞬間的に1秒以内に「呼び出し件数制限」以上のコールが発生する場合は、429エラー(Too Many Request)を返還します。
Bucket限度内の呼び出しであっても、該当のショップにて同一IPによる1秒あたり10回以上の呼び出しが発生した場合、異常な呼び出しとみなされることがあります。
Headerに「X-Api-Call-Limit」を確認すると429 エラーを避けることができます。ショップのAPI呼び出し件数とBucketの余裕分を確認することができます。
X-Api-Call-Limit : 1/40
Versioning
Version 2024-12-01 (latest) 以前のバージョンと互換性のない変更事項に対して、日付形式でバージョンを提供します。
custom headers "X-Cafe24-Api-Version"を利用して希望のバージョンを指定することができ、バージョンを指定せずAPIにリクエストする場合は、アプリのバージョンで動作します。
アプリのバージョンは、以下の方法で確認及び変更することができます。
- 管理コンソールにログイン > Apps > アプリ管理 > 開発関連情報 > 認証情報のバージョン管理
バージョンの満了期間は、最新バージョンがリリースされた時点から最大1年となります。
該当のバージョンの満了後は、満了日の時点でリリース日が最も古いバージョンで動作します。
例示コード(要求)
Product
Categories products
「Categories products」は、あるカテゴリに属する商品の表示順、固定機能の使用有無、表示エリアなどを照会/変更できるリレーショナル(関係)リソースです。
Categories products properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
product_ | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
product_ | 商品名 |
manufacturer_ | メーカー |
origin_ | 原産国 |
retail_ | 商品の定価 |
price | 販売価格 |
interest_ | 分割払い(手数料無料)期間 |
eng_ | 商品名(英語) |
custom_ | 独自商品コード |
point_ | ポイント |
brand_ | ブランド名 |
model_ | モデル名 |
price_ | 商品販売価格 |
tax | 税額 |
product_ | 商品コード |
simple_ | 商品簡略説明 |
summary_ | 商品要約説明 |
supplier_ | 供給会社名 |
made_ | 製造日 |
review_ | 商品レビュー数 |
expiration_ | 有効期間 |
coupon_ | クーポン適用価格 |
trend_ | トレンド名 |
shipping_ | 配送情報 |
shipping_ | 送料タイプ T:送料無料 |
shipping_ | 範囲別送料 |
shipping_ | 送料 |
discount_ | 割引販売価格 |
optimum_ | 割引適用価格 |
shipping_ | 配送方法 |
promotion_ | 割引期間 |
color | カラー |
translated_ | 商品追加説明の翻訳情報 |
stock_ | 在庫数量 |
question_ | 商品に関する問い合わせの数 |
product_ | 自由掲示板 |
Retrieve a list of products by category cafe24 youtube
GET /api/v2/categories/{category_no}/products
GET
特定のカテゴリーに割り当てられた商品をリストで照会することができます。
商品は同時に複数のカテゴリーに割り当てることができます。
商品番号、表示順、販売可否などを照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
mobile | モバイル設定値で照会するか否か T:使用する |
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
display_ Required Min : [1]~Max : [3] | 商品カテゴリの詳細 1: 一般商品 |
limit Min : [1]~Max : [200] | 検索結果の最大件数 DEFAULT 100 |
offset Max : [8000] | 検索結果の開始位置 DEFAULT 0 |
Retrieve a count of products by category cafe24 youtube
GET /api/v2/categories/{category_no}/products/count
GET
特定のカテゴリに割り当てられた商品の数を照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
display_ Required Min : [1]~Max : [3] | 商品カテゴリの詳細 1: 一般商品 |
Mains products
「Mains products」は、商品のメイン表示順に関するメインカテゴリのリレーショナル(関係)リソースです。
Mains products properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
product_ | 商品番号 |
product_ | 商品名 |
manufacturer_ | メーカー |
origin_ | 原産国 |
retail_ | 商品の定価 |
price | 販売価格 |
interest_ | 分割払い(手数料無料)期間 |
eng_ | 商品名(英語) |
custom_ | 独自商品コード |
point_ | ポイント |
brand_ | ブランド名 |
model_ | モデル名 |
price_ | 商品販売価格 |
tax | 税額 |
product_ | 商品コード |
simple_ | 商品簡略説明 |
summary_ | 商品要約説明 |
supplier_ | 供給会社名 |
made_ | 製造日 |
review_ | 商品レビュー数 |
expiration_ | 有効期間 |
coupon_ | クーポン適用価格 |
trend_ | トレンド名 |
shipping_ | 配送情報 |
shipping_ | 送料タイプ T:送料無料 |
shipping_ | 範囲別送料 |
shipping_ | 送料 |
discount_ | 割引販売価格 |
optimum_ | 割引適用価格 |
shipping_ | 配送方法 |
promotion_ | 割引期間 |
color | カラー |
translated_ | 商品追加説明の翻訳情報 |
stock_ | 在庫数量 |
question_ | 商品に関する問い合わせの数 |
product_ | 自由掲示板 |
Retrieve a list of products in main category cafe24 youtube
GET /api/v2/mains/{display_group}/products
GET
特定のメイン分類に割り当てられた商品をリストで照会することができます。
商品番号、商品名、固定可否などを照会することができます。
商品は同時に複数のメイン分類に割り当てられます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
mobile | モバイル設定値で照会するか否か T:使用する |
shop_ | ショップ番号 DEFAULT 1 |
display_ Required | メインカテゴリ番号 |
limit Min : [1]~Max : [200] | 検索結果の最大件数 DEFAULT 100 |
offset Max : [8000] | 検索結果の開始位置 DEFAULT 0 |
Products
商品(Products)はショップで販売されるものやサービスを意味します。商品は多様な色やサイズのオプションによって品目に分けられます。
商品は下記のようなResourceを下位Resourceとして持っています。
● 品目(Variants)
● 商品メモ(Memos)
● SEO(SEO)
● 商品照会数(Hits)
Products properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
product_ | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
product_ Type : [A-Z0-9] | 商品コード システムにより商品に付与されたコード。ショップ内で商品コードは重複しない。 |
custom_ Max Length : [40] | 独自商品コード ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
product_ Max Length : [250] | 商品名 商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。HTMLを使って入力できる。 |
eng_ Max Length : [250] | 商品名(英語) 商品の英語名。海外配送などに使用可能 |
model_ Max Length : [100] | モデル名 商品のモデル名 |
price_ | 商品価格(税別) |
price | 商品販売価格 商品の販売価格。クーポン及び特典を適用する前の価格 |
retail_ | 商品の定価 市場で販売される消費者価格。ショップの価格をアピールする比較の目的で使う。 |
display | 表示ステータス 商品をショップに表示するかどうかを設定。商品をショップに表示すると設定した商品カテゴリとトップページに表示される。商品がショップに表示されないとショップの画面に表示されないためアクセスができず、商品を購入することもできない。 T:表示する |
selling | 販売ステータス 商品をショップで販売するかどうかを設定。商品が表示されている状況で販売を中止する場合、ショップに商品は表示されるが「在庫切れ」と表示されるため、商品を購入することができない。商品のステータスが「表示しない」の場合、ステータスが「販売」であっても商品にアクセスできないため、購入できない。 T:販売する |
product_ Max : [2147483647] | 中古品の使用月数 |
summary_ Max Length : [255] | 商品要約説明 商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 |
product_ | 商品検索キーワード ショッピングキュレーション使用時 - 配列の最大サイズ: [100] |
tax_ | 税金の計算タイプ A:自動計算 |
price_ Max Length : [20] | 販売価格の代替メッセージ 商品の価格の代わりに表示されるメッセージ。在庫切れや商品が一時的に販売できない場合に使用 |
buy_ | 購入制限の個別設定の有無 T: 使用する |
buy_ | 購入制限 商品を購入することができる会員情報の表示 N : 会員のみ購入可能 + 購入ボタン非表示 |
buy_ | 購入できる会員ランク |
buy_ | 購入可能な会員ID |
repurchase_ | 再購入制限 T : 再購入不可 |
single_ | 単独購入制限 T : 単独購入不可 |
buy_ | 購入単位のタイプ 商品の購入単位を1個以上に設定した場合、その購入単位を品目単位にするか、商品単位にするかの設定 P:商品基準 |
buy_ | 購入単位 購入できる最小限の単位表示 |
order_ | 注文数量の制限基準 商品の注文数量を制限する場合、制限基準を品目単位にするか、商品単位にするかの設定 P:商品基準 |
minimum_ Max : [2147483647] | 最小注文数量 注文可能な最小限の注文数量。注文数量未満は購入できない。 |
maximum_ Max : [2147483647] | 最大注文数量 注文可能な最大限の注文数量。注文数量を超過して購入することはできない。 |
points_ | ポイントの個別設定を使用するかどうか F : 基本設定使用 |
points_ | 決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 |
points_ | ポイント設定情報 |
adult_ | 年齢認証 年齢認証(確認)が必要な商品かどうかの有無。年齢認証が必要な商品を購入するためには本人認証(確認)をしなければならない。 T:使用する |
detail_ | 詳細画像 商品詳細画面に表示される商品画像 |
list_ | 一覧画像 商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像 |
tiny_ | 縮小一覧画像 最近チェックした商品領域に表示される商品の一覧画像 |
small_ | 縮小画像 商品詳細画面の下部に表示される商品の一覧画像 |
use_ | Naver Payの使用有無 T:使用する |
naverpay_ | Naver Pay販売タイプ C : Naver Pay + ショップ 同時販売 商品 |
manufacturer_ Type : [A-Z0-9] | メーカーコード メーカーを登録すると自動生成されるコードで、商品に特定メーカーを指定する時に使用 |
trend_ Type : [A-Z0-9] | トレンドコード トレンドを登録すると自動生成されるコードで、商品に特定トレンドを指定する時に使う。 |
brand_ Type : [A-Z0-9] | ブランドコード ブランドを登録すると自動生成されるコードで、商品に特定ブランドを指定する場合に使う。 |
made_ | 製造日 商品を製造した製造日 |
expiration_ Array Max : [2] | 有効期間 商品を正常に使える期間。商品券やチケットのような無形商品、食品や化粧品のような有形商品の有効期間を表示 |
origin_ | 原産国 国内/国外/その他 F:国内 |
origin_ | 原産国番号 List all Origin APIで原産国を検索して原産国番号を入力 |
origin_ Max Length : [30] | 原産国のその他の情報 原産国が「その他(1800)」の場合、原産国として入力可能な情報 |
made_ | 国名(原産国)コード |
icon_ | アイコンの表示期間 商品に設定したアイコンが表示される期間 |
icon Array Max : [5] | アイコン 商品に表示されるアイコン。商品販売をアピールするための目的で使用可能 |
product_ | 商品素材 商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。 |
list_ | おすすめ / 在庫切れ / 新着商品アイコン表示の設定 おすすめ、在庫切れ、新着商品アイコンをリストに表示するかどうかを設定 |
approve_ | 承認申込結果 N:承認申込(新規商品) |
sold_ | 在庫切れ状況 T:在庫切れ |
discountprice | 商品の割引価格リソース |
decorationimages | デコ画像リソース |
benefits | 特典リソース |
options | 商品オプションリソース
|
variants | 品目リソース
|
hits | 商品閲覧数リソース
|
clearance_ Type : [A-Z0-9] | 海外通関コード |
additionalimages | 追加の画像リソース |
exposure_ | 商品表示制限の範囲 A:すべての顧客に表示 |
exposure_ | 商品表示対象の会員ランク |
set_ | セット商品のタイプ C:一般セット |
use_ | カカオページを使用するかどうか T:使用する |
shipping_ | 送料タイプ (個別送料を利用する場合)商品の送料タイプ T:送料無料 |
main | メイン表示 商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。 |
channeldiscountprices | 商品の割引価格リソース |
market_ | ECモール連携を使用するかどうか T:使用する |
cultural_ | 文化費所得控除 |
memos | メモリソース
|
seo | 商品Seo リソース
|
category | カテゴリ番号 商品が表示されている商品カテゴリ |
project_ | キャンペーン番号 |
description | 商品詳細説明 商品に対するより詳細な情報が含まれている説明。HTMLを使って入力できる。 |
mobile_ | モバイル商品詳細説明 入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。 |
separated_ | モバイル用登録 T : 直接登録 |
payment_ | 商品決済ガイド 商品の決済方法に対する案内文。HTMLを使って入力できる。 |
shipping_ | 商品配送ガイド 商品の配送方法に対するガイド。HTMLを使って入力できる。 |
exchange_ | 交換・返品ガイド 商品の交換・返品方法に対する説明。HTMLを使って入力できる。 |
service_ | サービスに関するお問い合わせ/ガイド 製品の事後顧客サービス方法に関するガイド。HTMLを使って入力できる。 |
product_ | 消費税表示メッセージ [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定 > 追加設定'] の販売価格の消費税表示メッセージで設定したメッセージ表示 |
simple_ | 商品簡略説明 商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 |
tags | 商品タグリソース
|
has_ | オプション使用の設定 商品にオプションが付いているかの有無。オプションのある商品はサイズや色など多様な選択肢を提供する。 T:オプションを使用する |
soldout_ Max Length : [250] | 在庫切れ表示メッセージ |
option_ | オプション構成方式 オプションを使う場合、オプションのタイプを表示 C:組み合わせ一体選択型 |
shipping_ | 配送の計算タイプ A:自動計算 |
shipping_ | 配送方法 (個別送料を使う場合)配送手段及び方法 01:宅配 |
prepaid_ | 送料前払いの設定 shipping_calculationがA(自動計算)の場合はnullに返却。 C:着払い |
shipping_ | 配送期間 (個別送料を使う場合)商品の配送時に平均的にかかる配送期間 |
shipping_ | 配送情報 国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ設定 > 配送設定 > '配送基本設定 > 送料の設定 > 個別送料設定']で商品別の個別送料設定が「使用しない」の場合は設定できない。 A:国内配送 |
shipping_ Max Length : [255] | 配送地域 (個別送料を使う場合)商品の配送ができる地域 |
shipping_ | 範囲別送料 個別送料を使う場合、商品の個別送料 |
product_ | 商品配送タイプ D:仕入れ商品の配送 |
origin_ | 原産国コード 商品の原産国コード |
additional_ | 追加項目 [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で追加した追加項目 |
relational_ | 関連商品 似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。 |
select_ | オプション別に1個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する |
custom_ | 商品Seo リソース |
Retrieve a list of products cafe24 youtube
GET /api/v2/products
GET
ショッピングモールに作成されている商品を一覧で照会することができます。
商品コード、商品名、販売価格などを照会することができます。
商品が5,000個を超える場合はoffsetでは照会できませんので、since_product_noパラメータを活用していただければ照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
channeldiscountprices embed | 商品の割引価格リソース |
discountprice embed | 商品の割引価格リソース |
decorationimages embed | デコ画像リソース |
benefits embed | 特典リソース |
options embed | 商品オプションリソース |
variants embed | 品目リソース 商品1点あたりの品目情報を100件まで照会可能 |
additionalimages embed | 追加の画像リソース |
hits embed | 商品閲覧数リソース |
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ | 商品番号 検索したい商品の番号 ,(コンマ)で複数の件を検索することができる。 |
display | 表示ステータス 表示または非表示商品の検索 |
selling | 販売ステータス 「販売中」または「販売しない」状態の商品検索 |
product_ | 商品名 検索キーワードが商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
product_ | 商品コード 検索キーワードが商品コードに含まれている商品検索(大文字・小文字を区別する) ,(コンマ)で複数の件を検索することができる。 |
brand_ | ブランドコード ブランドコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
manufacturer_ | メーカーコード メーカーコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
supplier_ | 供給会社のコード 供給会社コードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
trend_ | トレンドコード トレンドコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
product_ | 商品検索キーワード 検索キーワードが商品検索キーワードまたはタグに含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
custom_ | 独自商品コード 検索キーワードが独自商品コードに含まれている商品検索(大文字・小文字を区別する) ,(コンマ)で複数の件を検索することができる。 |
custom_ | 独自品目コード ,(コンマ)で複数の件を検索することができる。 |
price_ | 商品販売価格の検索最小値 販売価格が最小値以上の商品検索 |
price_ | 商品販売価格の検索最大値 販売価格が最大値以下の商品検索 |
retail_ Min : [0] | 商品の定価の検索最小値 消費者価格が最小値以上の商品検索 |
retail_ Min : [0] | 商品の定価の検索最大値 消費者価格が最大値以下の商品検索 |
supply_ | 商品仕入れ価格の検索最小値 原価が最小値以下の商品検索 |
supply_ | 商品仕入れ価格の検索最大値 原価が最大値以上の商品検索 |
created_ | 商品登録日の検索開始日 商品登録日が該当日以後である商品検索 |
created_ | 商品登録日の検索終了日 商品登録日が該当日以前である商品検索 |
updated_ | 商品修正日の検索開始日 商品修正日が該当日以後である商品検索 |
updated_ | 商品修正日の検索終了日 商品修正日が該当日以前である商品検索 |
category | カテゴリ番号 特定のカテゴリに表示されている商品検索 |
eng_ | 商品名(英語) 検索キーワードが英語商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
supply_ | 供給会社の商品名 検索キーワードが供給会社の商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
internal_ | 管理用商品名 ,(コンマ)で複数の件を検索することができる。 |
model_ | モデル名 検索キーワードがモデル名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
product_ | 商品ステータス 特定商品のステータスを検索 ,(コンマ)で複数の件を検索することができる。 |
origin_ | 原産国情報 原産国が「その他(1800)」の場合、原産国として入力可能な情報 ,(コンマ)で複数の件を検索することができる。 |
stock_ | 在庫数量の検索最大値 在庫が最大値以下の商品検索 |
stock_ | 在庫数量の検索最小値 在庫が最小値以上の商品検索 |
stock_ | 安全在庫数量の検索最大値 |
stock_ | 安全在庫数量の検索最小値 |
product_ | 商品重量 該当する重量の商品検索 ,(コンマ)で複数の件を検索することができる。 |
classification_ | 独自カテゴリ ,(コンマ)で複数の件を検索することができる。 |
use_ | 在庫使用の設定 該当する商品品目の在庫使用の有無 T:使用する |
category_ | 未適用カテゴリを検索 カテゴリが登録されていない商品を検索する。 T:未適用カテゴリを検索 |
include_ | 下位カテゴリを含めて検索 下位カテゴリに登録されている商品を含めて検索する。 T:含む |
additional_ | 追加項目の検索条件キー 追加項目を検索するためのキー。検索のためにはkeyとvalue両方とも必要 |
additional_ | 追加項目の検索条件値 追加項目を検索するためのキーの値。検索のためにはkeyとvalue両方とも必要 |
approve_ | 承認ステータスの検索 N:承認申込(新規商品)のステータス値 |
since_ Min : [0] | 該当する商品番号以降の番号から検索 特定の商品番号より数字が大きい商品番号を検索 |
product_ | セット商品の有無 T:使用する |
option_ | オプション構成方式 ,(コンマ)で複数の件を検索することができる。 C:組み合わせ一体選択型 |
market_ | ECモール連携を使用するかどうか T:使用する |
sort | 並べ替え順序の値 created_date:登録日 |
order | 並べ替え順序 asc:並べ替え(昇順) |
offset Max : [5000] | 検索結果の開始位置 検索結果の開始位置 DEFAULT 0 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
Retrieve a count of products cafe24 youtube
GET /api/v2/products/count
GET
ショッピングモールに登録されている商品の総数を照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ | 商品番号 検索したい商品の番号 ,(コンマ)で複数の件を検索することができる。 |
display | 表示ステータス 表示または非表示商品の検索 |
selling | 販売ステータス 「販売中」または「販売しない」状態の商品検索 |
product_ | 商品名 検索キーワードが商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
product_ | 商品コード 商品コード ,(コンマ)で複数の件を検索することができる。 |
brand_ | ブランドコード ブランドコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
manufacturer_ | メーカーコード メーカーコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
supplier_ | 供給会社のコード 供給会社コードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
trend_ | トレンドコード トレンドコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
product_ | 商品検索キーワード 検索キーワードが商品検索キーワードまたはタグに含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
custom_ | 独自商品コード 検索キーワードが独自商品コードに含まれている商品検索(大文字・小文字を区別する) ,(コンマ)で複数の件を検索することができる。 |
custom_ | 独自品目コード ,(コンマ)で複数の件を検索することができる。 |
price_ | 商品販売価格の検索最小値 販売価格が最小値以上の商品検索 |
price_ | 商品販売価格の検索最大値 販売価格が最大値以下の商品検索 |
retail_ Min : [0] | 商品の定価の検索最小値 消費者価格が最小値以上の商品検索 |
retail_ Min : [0] | 商品の定価の検索最大値 消費者価格が最大値以下の商品検索 |
supply_ | 商品仕入れ価格の検索最小値 原価が最小値以下の商品検索 |
supply_ | 商品仕入れ価格の検索最大値 原価が最大値以上の商品検索 |
created_ | 商品登録日の検索開始日 商品登録日が該当日以後である商品検索 |
created_ | 商品登録日の検索終了日 商品登録日が該当日以前である商品検索 |
updated_ | 商品修正日の検索開始日 商品修正日が該当日以後である商品検索 |
updated_ | 商品修正日の検索終了日 商品修正日が該当日以前である商品検索 |
category | カテゴリ番号 特定のカテゴリに表示されている商品検索 |
eng_ | 商品名(英語) 検索キーワードが英語商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
supply_ | 供給会社の商品名 検索キーワードが供給会社の商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
internal_ | 管理用商品名 ,(コンマ)で複数の件を検索することができる。 |
model_ | モデル名 検索キーワードがモデル名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
product_ | 商品ステータス 特定商品のステータスを検索 ,(コンマ)で複数の件を検索することができる。 |
origin_ | 原産国情報 原産国が「その他(1800)」の場合、原産国として入力可能な情報 ,(コンマ)で複数の件を検索することができる。 |
stock_ | 在庫数量の検索最大値 在庫が最大値以下の商品検索 |
stock_ | 在庫数量の検索最小値 在庫が最小値以上の商品検索 |
stock_ | 安全在庫数量の検索最大値 |
stock_ | 安全在庫数量の検索最小値 |
product_ | 商品重量 該当する重量の商品検索 ,(コンマ)で複数の件を検索することができる。 |
classification_ | 独自カテゴリ 独自カテゴリコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。 |
use_ | 在庫使用の設定 該当する商品品目の在庫使用の有無 T:使用する |
category_ | 未適用カテゴリを検索 カテゴリが登録されていない商品を検索する。 T:未適用カテゴリを検索 |
include_ | 下位カテゴリを含めて検索 下位カテゴリに登録されている商品を含めて検索する。 T:含む |
additional_ | 追加項目の検索条件キー 追加項目を検索するためのキー。検索のためにはkeyとvalue両方とも必要 |
additional_ | 追加項目の検索条件値 追加項目を検索するためのキーの値。検索のためにはkeyとvalue両方とも必要 |
approve_ | 承認ステータスの検索 N:承認申込(新規商品)のステータス値 |
since_ Min : [0] | 該当する商品番号以降の番号から検索 特定の商品番号より数字が大きい商品番号を検索。 |
product_ | セット商品の有無 T:使用する |
option_ | オプション構成方式 ,(コンマ)で複数の件を検索することができる。 C:組み合わせ一体選択型 |
market_ | ECモール連携を使用するかどうか T:使用する |
Retrieve a product resource cafe24 youtube
GET /api/v2/products/{product_no}
GET
ショッピングモールに作成されている商品を照会することができます。
商品コード、自社商品コード、商品名、商品販売価格などを照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 検索したい商品の番号 |
variants embed | 品目リソース |
memos embed | メモリソース |
hits embed | 商品閲覧数リソース |
seo embed | 商品Seo リソース |
tags embed | 商品タグリソース |
options embed | 商品オプションリソース |
discountprice embed | 商品の割引価格リソース |
decorationimages embed | デコ画像リソース |
benefits embed | 特典リソース |
additionalimages embed | 追加の画像リソース |
custom_ embed | 사용자 정의 속성 |
Products decorationimages
「Decorationimages」は、ショップに表示中の商品画像の上に追加して商品をより目立たせる機能です。ショップに登録されているデコ画像を照会して商品ごとにデコ画像を指定したり、商品に登録されているデコ画像を照会することができます。
デコ画像はサブリソースであるため、「Products」の以下で使用可能です。
Retrieve a list of product decoration images cafe24 youtube
GET /api/v2/products/{product_no}/decorationimages
GET
特定の商品に登録されている装飾画像をリストで照会します。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Products discountprice
「Discountprice」は、商品の割引価格を表示するリソースです。 「Benefits」が適用された商品の場合、商品の割引価格を照会することができます。
商品の割引価格はサブリソースであるため、「Products」の以下で使用可能です。 商品リストを照会する際に、Embedパラメータで呼び出して商品の割引価格を同時に照会することができます。
Retrieve a product discounted price cafe24 youtube
GET /api/v2/products/{product_no}/discountprice
GET
商品番号を利用して該当商品の割引価格を照会します。
PC割引販売価格、モバイル割引販売価格を確認できます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
Products hits
商品照会数(Hits)は商品をショップの顧客がどれほど照会したかを示す指標です。商品照会数を確認することで顧客がどんな商品を一番たくさん照会したかがわかります。
商品照会数は下位Resourceで、商品(Products)の下位でしか使えません。
Retrieve a count of product views cafe24 youtube
GET /api/v2/products/{product_no}/hits/count
GET
商品番号を利用して該当商品の照会数を照会します。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
Products icons
商品アイコンは商品をアピールするために商品の横に追加する小さい画像です。表示されている商品に割引情報、「在庫わずか」などのメッセージを追加して商品をアピールすることができます。
商品アイコンは下位Resourceで、商品(Products)の下位でしか使えません。
Endpoints
Products options
「Options」は、顧客がカラー・サイズなど商品のオプションの中から好きなものを選択して購入できるようにする機能です。 オプションはカラー、サイズなどの「オプション名(option_name)」とカラーのうち赤、黄のような「オプション値(option_value)」で構成されています。 商品にオプションを登録すると、オプションに基づいて「品目(variants)」が作成されます。
オプションはサブリソースであるため、「Products」の以下で使用可能です。
Products options properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
has_ | オプション使用の設定 T:使用する |
option_ | オプション構成方式 オプションを使う場合、オプションのタイプを表示 T:組み合わせ型 |
option_ | オプション表示方式 組合型オプションを使う場合、組合型オプションのタイプを表示 C:一体型 |
options | オプション |
select_ | オプション別に1個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する |
use_ | 追加入力オプション使用の設定 T:使用する |
additional_ | 追加入力オプション |
use_ | ファイル添付オプション使用の設定 T:使用する |
attached_ | ファイル添付オプション |
Retrieve a list of product options cafe24 youtube
GET /api/v2/products/{product_no}/options
GET
商品のオプションをリストで照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Products variants
品目(Variants)はショップで販売される商品の基本単位です。ショップは一般的に顧客に多様な選択肢を提供するために同じ商品でもサイズや色が違う品目を販売します。
品目は下記のようなResourceを下位Resourceとして持っています。
● 在庫(Inventories)
Products variants properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
variant_ Type : [A-Z0-9] | 品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
options | オプション |
display | 表示ステータス 品目を表示するかどうかを設定。品目を表示する場合、商品詳細または商品リストでその品目を選択することができる。品目が設定されていない場合、その品目が表示されないため、その品目を購入することができない。 T:表示する |
selling | 販売ステータス 品目を販売するかどうかを設定。表示されているが販売はしない場合、その品目は「在庫切れ」と表示され、その品目を購入することができない。品目のステータスが「販売」であっても「表示しない」になっているとその品目は購入できない。 T:販売する |
additional_ | 追加金額 品目を購入する時、商品の販売価格に加えて支払わなければならない追加価格 |
quantity | 数量 |
safety_ | 安全在庫数量 |
image | 品目画像 |
inventories | 在庫リソース 品目の在庫Resource |
Retrieve a list of product variants cafe24 youtube
GET /api/v2/products/{product_no}/variants
GET
商品の品目を一覧で照会することができます。
商品の品目コード、陳列状態、販売状態などを照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
inventories embed | 在庫リソース 品目の在庫Resource ,(コンマ)で複数の件を検索することができる。 |
Retrieve a product variant cafe24 youtube
GET /api/v2/products/{product_no}/variants/{variant_code}
GET
商品の特定の品目を照会することができます。
オプション情報、独自品目コード、陳列·販売状態などを照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
variant_ Required Type : [A-Z0-9] | 品目コード |
inventories embed | 在庫リソース |
Products variants inventories
在庫(Inventories)は販売可能な品目の数量を意味します。在庫は品目(Variants)別に存在し、在庫以上の品目が販売されるとその商品は在庫切れになります。
Products variants inventories properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
variant_ Type : [A-Z0-9] | 品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
quantity | 数量 販売可能な在庫数。在庫数は注文または決済時に差し引かれ、在庫切れの表示のためにチェックされる。 |
safety_ | 安全在庫数量 |
origin_ | 出荷元コード |
Retrieve inventory details of a product variant cafe24 youtube
GET /api/v2/products/{product_no}/variants/{variant_code}/inventories
GET
商品の在庫を照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
variant_ Required Type : [A-Z0-9] | 品目コード 販売数量を検索する品目コード |
Productsdetail
商品詳細情報(Productsdetail)は、商品詳細ページに表示される項目とその値を照会できる機能です。
Endpoints
Productsdetail properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
product_ | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
detail_ | 詳細画像 商品詳細画面に表示される商品画像 |
small_ | 縮小画像 商品詳細画面の下部に表示される商品の一覧画像 |
additional_ Array Max : [20] | 追加画像 商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。 |
product_ | 商品名 商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。HTMLを使って入力できる。 |
manufacturer_ | メーカー メーカーの名前。メーカー名はショップ管理者画面でメーカーを区分する基本的な情報である。 |
origin_ | 原産国 |
retail_ | 商品の定価 市場で販売される消費者価格。ショップの価格をアピールする比較の目的で使う。 |
price | 販売価格 商品の販売価格。クーポン及び特典を適用する前の価格 |
interest_ | 分割払い(手数料無料)期間 無利子分割払いが設定されたときに適用可能な期間 |
eng_ | 商品名(英語) 商品の英語名。海外配送などに使用可能 |
custom_ | 独自商品コード ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
points_ | ポイント 商品注文時にもらえる積立金の金額。 設定によって積立金を決済手段に関係なく共通して受け取るように設定したり、決済手段別に受け取るように設定することができる。 |
brand_ | ブランド名 |
model_ | モデル名 商品のモデル名 |
price_ | 商品販売価格 税抜き商品の販売価格 |
tax | 税額 |
product_ | 商品コード システムにより商品に付与されたコード。ショップ内で商品コードは重複しない。 |
simple_ | 商品簡略説明 商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 |
summary_ | 商品要約説明 商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 |
supplier_ | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 |
made_ | 製造日 商品を製造した製造日 |
review_ | 商品レビュー数 商品を選択し、使用レビューに書き込みが登録された数 |
expiration_ | 有効期間 商品を正常に使える期間。商品券やチケットのような無形商品、食品や化粧品のような有形商品の有効期間を表示 |
coupon_ | クーポン適用価格 商品にクーポンが設定された場合、そのクーポンを適用した金額 |
trend_ | トレンド名 |
shipping_ | 配送情報 国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ設定 > 配送設定 > '配送基本設定 > 送料の設定 > 個別送料設定']で商品別の個別送料設定が「使用しない」の場合は設定できない。 |
shipping_ | 送料タイプ shipping_calculationがA(自動計算)の場合はnullに返却。 T:送料無料 |
shipping_ | 範囲別送料 個別送料を使用する場合は、商品の個別送料。 |
shipping_ | 送料 |
discount_ | 割引販売価格 商品に割引が設定された場合、割引を適用した販売価格 |
optimum_ | 割引適用価格 |
shipping_ | 配送方法 配送手段および方法 |
promotion_ | 割引期間 商品に割引が設定された場合、その割引が適用される期間 |
colors | カラー |
translated_ | 商品追加説明の翻訳情報 |
stock_ | 在庫数量 |
question_ | 商品に関する問い合わせの数 商品を選択し、商品お問い合わせに書き込みが登録された数 |
relation_ | 関連商品数 商品登録/修正時に関連商品として登録された商品数 |
product_ | 商品素材 |
product_ | 自由掲示板 商品を選択し、商品自由掲示板に書き込みが登録された数 |
additional_ | 追加項目 商品登録/修正時に追加入力した項目 |
payment_ | 決済方法 |
add_ | 追加構成商品 商品登録/修正時に追加構成商品として登録された商品数 |
Retrieve the details of a product cafe24 youtube
GET /api/v2/productsdetail/{product_no}
GET
商品の詳細ページに表示される項目とその値を照会することができます。
商品名、メーカー、画像などを照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
mobile | モバイル設定値で照会するか否か T:使用する |
Category
Categories
商品カテゴリ(Categories)はショップの顧客が見つけやすい方法で商品を表示したり分類できるカテゴリです。商品を一つ以上の商品カテゴリに表示しないと販売できません。一つの商品を複数の商品カテゴリに表示することができます。
Categories properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
category_ | カテゴリ番号 商品カテゴリ固有の一連番号。ショップ内で商品カテゴリ番号は重複しない。 |
category_ Min : [1]~Max : [4] | カテゴリdepth 下位何次の商品カテゴリにあるカテゴリかを表示する。1~4次まで商品カテゴリが存在する。 |
parent_ | 親カテゴリ番号 商品カテゴリが2次(中カテゴリ)、3次(小カテゴリ)、4次(細カテゴリ)の場合、上位にある商品カテゴリの番号を表示する。 |
category_ Max Length : [50] | カテゴリ名 商品カテゴリの名前を示す。 |
full_ | カテゴリ全体の名前 商品カテゴリが属している上位商品カテゴリの名前をすべて表示 |
full_ | 全てのカテゴリ番号 該当する商品カテゴリが属している上位の商品カテゴリの番号をすべて表示 |
root_ | 最上位カテゴリ番号 商品カテゴリが属している最上位商品カテゴリのカテゴリ番号表示 |
use_ | 表示ステータス 商品カテゴリ表示の設定。「表示しない」の場合、その商品カテゴリにアクセスできない。 T:表示する |
display_ | 表示順序 商品カテゴリをショップの運営者が配置した順序 |
hash_ | ハッシュタグ 該当する商品カテゴリのハッシュタグリスト |
Retrieve a list of product categories cafe24
GET /api/v2/categories
GET
ショッピングモールに登録されている分類をリストで照会します。
分類の分類番号や分類名などを確認できます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
category_ Min : [1]~Max : [4] | カテゴリdepth 検索したい商品カテゴリの次数検索 |
category_ | カテゴリ番号 検索したい商品カテゴリの番号 |
parent_ | 親カテゴリ番号 検索したい商品カテゴリの親商品カテゴリ番号検索 |
category_ | カテゴリ名 検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない) |
offset Max : [8000] | 検索結果の開始位置 検索結果の開始位置 DEFAULT 0 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
Retrieve a count of product categories cafe24
GET /api/v2/categories/count
GET
ショッピングモールに登録されている分類の数を照会します。
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
category_ Min : [1]~Max : [4] | カテゴリdepth 検索したい商品カテゴリの次数検索 |
category_ | カテゴリ番号 検索したい商品カテゴリの番号 |
parent_ | 親カテゴリ番号 検索したい商品カテゴリの親商品カテゴリ番号検索 |
category_ | カテゴリ名 検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない) |
Retrieve a product category cafe24
GET /api/v2/categories/{category_no}
GET
分類番号を使用して、その分類について詳細を照会します。
分類Depth、親分類番号、分類名などを照会することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 検索したい商品カテゴリの番号 |
Personal
Carts
カート(Carts)は商品を注文する前に一度に注文できるように商品をあらかじめ入れておく機能です。
ショッピングカートリソースでは、Front APIを使用して特定の商品をショッピングカートに入れることができ、Admin APIでは特定の会員のショッピングカートを照会することができます。
Endpoints
Create a shopping cart cafe24
POST /api/v2/carts
POST
基本スペック
Property | Description |
---|---|
SCOPE | 個人化情報の投稿権限 (mall.write_personal) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
variants | 品目 品目情報。カートに追加する品目の個数と品目コード |
quantity variants_code options Array option_code value_no additional_option_values Array key type name value | |
addtional_ | 追加構成商品の品目 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
basket_ Required | カートタイプ カートのタイプ。分割払い手数料無料が可能な商品の場合は手数料無料タイプに設定可能 A0000:一般 |
duplicated_ Required | カートの重複チェック カートに追加する品目に対し、重複を許容するかどうかを設定 T:品目の重複をチェックする |
prepaid_ Required | 送料前払いの設定 P:前払い |
Products carts
商品カート(Products carts)は、特定の商品をカートに入れた会員とその数字を照会できるリソースです。
特定の商品をカートに入れた会員のID、入れた日付、会員数情報を照会することができます。
Retrieve a count of carts containing a product cafe24
GET /api/v2/products/{product_no}/carts/count
GET
特定の商品をカートに入れた会員数を確認できます。
基本スペック
Property | Description |
---|---|
SCOPE | 個人化情報の閲覧権限 (mall.read_personal) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |