non-print
API Index
Introduction
Cafe24 API
cafe24のショップAPIは、cafe24のショップと連動してサービスを提供するアプリストアパートナー、サードパーティソリューション提供者などに提供するAPIです。
cafe24のAPIはRESTfulなアーキテクチャーで、OAuth2.0基盤の認証システムと標準HTTP Request Method、リソースの予測ができるエンドポイントURL、HTTPコード基盤のエラーメッセージを提供します。
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": "エラーコード",
"message": "エラーメッセージ",
"more_info": {
}
}
}
Method
リソース別にCreate、Read、Update、Deleteを提供し、標準HTTP Methodを使ってAPIを使用することができます。
POST : リソースを生成(Create)します。
GET : リソースの情報を検索(Read)します。
PUT : リソースを修正(Update)します。
DELETE : リソースを削除(Delete)します。
Admin API Intro
Admin API
Admin APIはショップの管理者によるショップ情報の検索、生成、修正、削除に適合しています。Admin APIはリソースの情報の大半を検索することができ、OAuth2.0方式の別途認証をパスした場合のみ使用できます。
使用例
https://{mallid}.cafe24api.com/api/v2/admin/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文書を参考に確認します。 |
422 | 検索/処理を要求した時、値が決まっているスペックと違う場合 1) 必須パラメーター抜け 2) 決まっているスペックと違う場合 | API文書を参考に必須パラメーターが入力されていないか、有効でない値が入力されているか確認します。 |
429 | クライアントのAPI要求がBucketを超過した場合 | API最大許容要求件数を超過しないようにしばらくしてからもう一度要求します。 |
500 | 内部サーバーエラー、不明なエラー | 一時的にエラーが発生しました。しばらくしてからもう一度お試しください。 |
503 | 現在のサーバーがダウンした場合 | 開発者センターにお問い合わせください。 |
503 | サーバーがダウンした場合。APIが使用できない | 開発者センターにお問い合わせください。 |
504 | 要求時間を超過した場合(Timeout) | 一時的にエラーが発生し、応答が遅れています。しばらくしてからもう一度お試しください。 |
How to use GET API
cafe24のAPIはデータを検索する多様な方法を提供しています。
次はAPIの検索時に多様なパラメーターを使って多様な方法でデータを呼び出す方法を説明しています。
1. 検索条件を追加
API検索時に検索条件はエンドポイントにパラメーターを追加して検索できます。
複数の条件で同時に検索する場合は、区切り文字「&」を使って検索条件を追加することができます。
開始日、終了日などの範囲を検索する場合にも区切り文字「&」を使って検索することができます。
全てのショップの情報検索
例) 特定のブランド内で価格が100円以上の商品を検索する場合
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
2. パラメーターで色々な条件検索
APIで対応する場合、コンマ(,)を使って複数の値を同時に検索することができます。 (ただし、100項目以下で入力してください)
コンマ(,)を使って追加した検索条件はOR条件で、その検索条件に該当するすべての値が検索されます。
パラメーターで複数の条件で検索する
例) 11番、12番、13番商品の情報を検索する場合
GET https://{mallid}.cafe24api.com/api/v2/products?product_no=11,12,13
3. すべてのショップ情報検索
API検索時に特定のshop_noを明示すると、該当する全てのショップの情報を検索することができます。
特定のshop_noを明示しない場合は1番目のショップ(基本ショップ)の情報を検索します。
全てのショップの情報検索
例) 2番ショップの商品を検索する
GET https://{mallid}.cafe24api.com/api/v2/products?shop_no=2
4. 詳細検索と1件検索
ほとんどのリソースはURLにリソースのIDを明示して詳細検索ができます。
詳細検索はリソース一つしか検索できませんが、リスト検索よりたくさんの項目が返還されます。
詳細検索と1件検索
例) 128番商品を詳細検索する方法
GET https://{mallid}.cafe24api.com/api/v2/admin/products/128
例) 128番商品をパラメーターを使って1件検索する場合
GET https://{mallid}.cafe24api.com/api/v2/admin/products?product_no=128
5. Pagination
リスト検索時に検索する項目が多すぎる場合は、すべての結果が一気に検索されないこともあります。
1回の検索でより多くの結果を得たい場合は、「limit」パラメーターを使って検索件数を拡張することができます。
「limit」パラメーターを使わない場合は「limit」の基本値だけ検索されます。
「limit」パラメーターで拡張できる検索件数は、各APIに定義されている「最大値」までです。
もし「limit 最大値」ですべてのデータを検索することができない場合は、「offset」パラメーターを使うことができます。
「offset」パラメーターは何番目の商品から検索を始めるかを決定し、その商品から「limit」数だけの商品を再度検索します。
Pagination
例) 商品を1回に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. Fieldパラメーター
API検索値の中で特定の値だけ検索したい場合は、fieldパラメーターを使ってその値を検索することができます。
Fieldパラメーター
例) 商品検索時に商品名と商品番号パラメーターのみ検索する
GET https://{mallid}.cafe24api.com/api/v2/admin/products?fields=product_name,product_no
7. Embedパラメーター
商品検索時に商品に属する下位リソース(例: 品目、在庫)を一緒に検索したい場合は、 「embed」パラメーターを使って下位リソースのデータを一緒に検索することができます。
「embed」パラメーターは対応する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 2020-12-01 (latest)
以前のバージョンと互換されていない変更事項に対し、日付でバージョンを提供します。
custom headers "X-Cafe24-Api-Version"を通してご希望のバージョンを指定することができ、バージョンを保存しない場合、最新バージョンで動作します。
例示コード(要求)
Authentication
Get Authentication Code
トークン発行要求時に使われたcodeは再使用できず、コード発行後1分が経過すると満了します。
{mallid} : ショップのIDを入力します。
{client_id} : 開発者センターで作成したアプリのclient_idを入力します。
{state} : 偽変造を防止するために入力する値にコード返還時に同じ値が返還されます。
{redirect_uri} : 開発者センターで作成したアプリのRedirect URLを入力します。
{scope} : アクセストークンでアクセスするリソースサーバーの権限を入力することができます。
アクセストークンの発行のためにはまずアクセスコードを要求しなければなりません。アクセスコードはクライアントがウェブアプリケーションの形態である場合に利用されます。コードの要求はcURLではなくウェブブラウザーで行わなければなりません。
例示コード(要求)
GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}'
例示コード(応答)
HTTP/1.1 302 Found
Location: {redirect_uri}?code={authorize_code}&state={state}
Get Access Token
発行された認証コードを使用し、実際にAPIの呼び出しができるユーザートークン(Access Token、Refresh Token)をもらうことができます。
{mallid}: ショップのIDを入力します。
{client_id}: 開発者センターで作成したアプリのclient_idを入力します。
{client_secret}: 開発者センターで作成したアプリのclient_secretを入力します。
{code}: 発行されたコードを入力します。
{redirect_uri}: 開発者センターで作成したアプリのRedirect URLを入力します。
access_token: アクセストークンで、クライアントがリソースサーバーにアクセスする時に使われます。
refresh_token: アクセストークン満了後に再発行するために使うトークンです。
例示コード(要求)
例示コード(応答)
HTTP/1.1 200 OK
{
"access_token": "0iqR5nM5EJIq.......",
"expires_at": "2017-10-19T19:17:57.902",
"refresh_token": "Cuq6H1WLKBxqqf.......",
"client_id": "BrIfqEKoP.......",
"mall_id": "yourmall",
"user_id": "test",
"scopes": [
"mall.read_order",
"mall.read_product",
"mall.read_store",
"...etc...",
],
"issued_at": "2017-10-19T17:17:57.911"
}
Get Access Token using refresh token
アクセストークンは発行後2時間が経過すると使えません。リソースサーバーにアクセスするためにはアクセストークン満了後に再発行が必要です。すでにアクセストークンが発行された場合はrefresh_tokenを使ってアクセストークンの再発行が可能です。
refresh tokenは2週間有効で、refresh token満了前に要求すると更新されたaccess tokenと更新されたrefresh tokenが一緒に返還されます。既存のrefresh tokenは満了処理され、使用できません。
発行された認証コードを使って実際にAPIの呼び出しができるユーザートークン(Access Token、Refresh Token)をもらうことができます。
{mallid} : ショップのIDを入力します。
{domain}:ショップのドメインを入力します。
{client_id} : 開発者センターで作成したアプリのclient_idを入力します。
{client_secret}: 開発者センターで作成したアプリのclient_secretを入力します。
{refresh_token}:トークン発行時にもらったrefresh_tokenを入力します。
access_token : アクセストークンで、クライアントがリソースサーバーにアクセスする時に使われます。
refresh_token : アクセストークン満了後に再発行するために使うトークンです。
例示コード(要求)
例示コード(応答)
HTTP/1.1 200 OK
{
"access_token": "0iqR5nM5EJIq.......",
"expires_at": "2017-10-19T19:17:57.902",
"refresh_token": "Cuq6H1WLKBxqqf.......",
"client_id": "BrIfqEKoP.......",
"mall_id": "yourmall",
"user_id": "test",
"scopes": [
"mall.read_order",
"mall.read_product",
"mall.read_store",
"...etc...",
],
"issued_at": "2017-10-19T17:17:57.911"
}
Category
Autodisplay
Autodisplay properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
display_ | 自動入替番号 |
use_ | メインカテゴリかどうか T: メインカテゴリ |
category_ | カテゴリ番号 |
display_ | 商品カテゴリの詳細 |
display_ Min : [1]~Max : [200] | 自動入替え可能な最大商品数 |
use_ | 入替予約機能の使用有無 T: 使用 |
start_ timezone | 予約開始日 |
use_ | ハッシュタグ使用有無 T: 使用 |
hash_ | ハッシュタグ |
display_ | ソート順 AOD: 現在の注文数(降順) |
timetable Array Max : [24] | アップデート時間 |
period | データの集計期間 1.1日 |
except_ | 除外カテゴリ |
List all autodisplay
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
display_ | 自動入替番号 |
Create an autodisplay
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの投稿権限 (mall.write_category) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
use_ Required | メインカテゴリかどうか T: メインカテゴリ |
category_ Required | カテゴリ番号 |
display_ Required | 商品カテゴリの詳細 |
display_ Required Min : [1]~Max : [200] | 自動入替え可能な最大商品数 |
use_ Required | 入替予約機能の使用有無 T: 使用 |
start_ timezone | 予約開始日 |
use_ Required | ハッシュタグ使用有無 T: 使用 |
hash_ | ハッシュタグ |
display_ | ソート順 AOD: 現在の注文数(降順) |
timetable Array Max : [24] | アップデート時間 |
period | データの集計期間 1.1日 |
except_ | 除外カテゴリ |
Update an autodisplay
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの投稿権限 (mall.write_category) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
display_ Required | 自動入替番号 |
display_ Min : [1]~Max : [200] | 自動入替え可能な最大商品数 |
use_ | 入替予約機能の使用有無 T: 使用 |
start_ timezone | 予約開始日 |
use_ | ハッシュタグ使用有無 T: 使用 |
hash_ | ハッシュタグ |
display_ | ソート順 AOD: 現在の注文数(降順) |
timetable Array Max : [24] | アップデート時間 |
period | データの集計期間 1.1日 |
except_ | 除外カテゴリ |
Delete an autodisplay
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの投稿権限 (mall.write_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
display_ Required | 自動入替番号 |
Categories
商品カテゴリ(Categories)はショップの顧客が見つけやすい方法で商品を表示したり分類できるカテゴリです。商品を一つ以上の商品カテゴリに表示しないと販売できません。一つの商品を複数の商品カテゴリに表示することができます。
Categories properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
category_ | カテゴリ番号 商品カテゴリ固有の一連番号。ショップ内で商品カテゴリ番号は重複しない。 |
category_ Min : [1]~Max : [4] | カテゴリdepth 下位何次の商品カテゴリにあるカテゴリかを表示する。1~4次まで商品カテゴリが存在する。 |
parent_ | 親カテゴリ番号 商品カテゴリが2次(中カテゴリ)、3次(小カテゴリ)、4次(細カテゴリ)の場合、上位にある商品カテゴリの番号を表示する。 |
category_ Max Length : [50] | カテゴリ名 商品カテゴリの名前を示す。 |
display_ | ショップの表示設定 商品カテゴリをPCショップとモバイルショップ、両方に表示するかどうかを設定 A:PC + モバイル |
full_ | カテゴリ全体の名前 商品カテゴリが属している上位商品カテゴリの名前をすべて表示 |
full_ | 全てのカテゴリ番号 該当する商品カテゴリが属している上位の商品カテゴリの番号をすべて表示 |
root_ | 最上位カテゴリ番号 商品カテゴリが属している最上位商品カテゴリのカテゴリ番号表示 |
use_ | メインカテゴリの表示ステータス 商品カテゴリがショップのトップページに表示されるかどうかの有無。メインカテゴリに表示する場合は中/小/細カテゴリも大カテゴリのように最上位に表示される。 T:表示する |
use_ | 表示ステータス 商品カテゴリ表示の設定。「表示しない」の場合、その商品カテゴリにアクセスできない。 T:表示する |
display_ | 表示順序 商品カテゴリをショップの運営者が配置した順序 |
soldout_ | 在庫切れ商品の表示 在庫切れ商品を商品カテゴリの一番前に表示するか、一番後ろに表示するかの設定 B:在庫切れ商品を一番後ろに |
sub_ | 下位カテゴリ商品の表示 現在の商品カテゴリの下位カテゴリに表示されている商品まで含めて表示するか否かの設定 T:表示する |
hashtag_ | ハッシュタグ商品の表示 ハッシュタグ商品表示機能の使用設定 T:表示する |
hash_ | ハッシュタグ 該当する商品カテゴリのハッシュタグリスト |
product_ | 商品カテゴリの表示エリアの区分 商品カテゴリに商品を一括表示するか、エリア別に表示するかの設定 A:すべて |
product_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「すべて」の場合、その商品カテゴリの表示方法 A : 自動並べ替え |
product_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「すべて」で、商品カテゴリの表示方法が「自動表示」または「自動表示+使用者指定」の場合、その商品カテゴリをどのような基準で表示するかの設定 A:最近追加された商品 |
product_ | 商品カテゴリの表示方法の順序 商品カテゴリの表示方法を降順にするか、昇順にするかの設定 D:降順 |
product_ | 表示順序に対する期間 表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
normal_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアの表示方法 A : 自動並べ替え |
normal_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
normal_ | 商品カテゴリの表示方法の順序 一般商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
normal_ | 表示順序に対する期間 一般商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
recommend_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアの表示方法 A : 自動並べ替え |
recommend_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
recommend_ | 商品カテゴリの表示方法の順序 おすすめ商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
recommend_ | 表示順序に対する期間 おすすめ商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
new_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアの表示方法 A : 自動並べ替え |
new_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
new_ | 商品カテゴリの表示方法の順序 新着商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
new_ | 表示順序に対する期間 新着商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
access_ | アクセス権限 F : 全て利用可能 |
List all categories
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
category_ Min : [1]~Max : [4] | カテゴリdepth 検索したい商品カテゴリの次数検索 |
category_ | カテゴリ番号 検索したい商品カテゴリの番号 |
parent_ | 親カテゴリ番号 検索したい商品カテゴリの親商品カテゴリ番号検索 |
category_ | カテゴリ名 検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない) |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 検索結果の開始位置 |
Count all categories
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
category_ Min : [1]~Max : [4] | カテゴリdepth 検索したい商品カテゴリの次数検索 |
category_ | カテゴリ番号 検索したい商品カテゴリの番号 |
parent_ | 親カテゴリ番号 検索したい商品カテゴリの親商品カテゴリ番号検索 |
category_ | カテゴリ名 検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない) |
Get a category
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 検索したい商品カテゴリの番号 |
Create a category
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの投稿権限 (mall.write_category) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
parent_ | 親カテゴリ番号 登録する商品カテゴリの親カテゴリ番号 |
category_ Required Max Length : [50] | カテゴリ名 該当する商品カテゴリ名 |
display_ | ショップの表示設定 該当する商品カテゴリを PC ショップに表示するか、モバイルショップに表示するか、両方に表示するかの設定 A:PC + モバイル |
use_ | メインカテゴリの表示ステータス 商品カテゴリがショップのトップページに表示されるかどうかの有無。メインカテゴリに表示する場合は中/小/細カテゴリも大カテゴリのように最上位に表示される。 T:表示する |
use_ | 表示ステータス 商品カテゴリ表示の設定。「表示しない」の場合、その商品カテゴリにアクセスできない。 T:表示する |
soldout_ | 在庫切れ商品の表示 在庫切れ商品を商品カテゴリの一番前に表示するか、一番後ろに表示するかの設定 B:在庫切れ商品を一番後ろに |
sub_ | 下位カテゴリ商品の表示 現在の商品カテゴリの下位カテゴリに表示されている商品まで含めて表示するか否かの設定 T:表示する |
hashtag_ | ハッシュタグ商品の表示 ハッシュタグ商品表示機能の使用設定 T:表示する |
hash_ | ハッシュタグ 該当する商品カテゴリのハッシュタグリスト |
product_ | 商品カテゴリの表示エリアの区分 商品カテゴリに商品を一括表示するか、エリア別に表示するかの設定 A:すべて |
product_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「すべて」の場合、その商品カテゴリの表示方法 A : 自動並べ替え |
product_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「すべて」で、商品カテゴリの表示方法が「自動表示」または「自動表示+使用者指定」の場合、その商品カテゴリをどのような基準で表示するかの設定 A:最近追加された商品 |
product_ | 商品カテゴリの表示方法の順序 商品カテゴリの表示方法を降順にするか、昇順にするかの設定 D:降順 |
product_ | 表示順序に対する期間 表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
normal_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアの表示方法 A : 自動並べ替え |
normal_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
normal_ | 商品カテゴリの表示方法の順序 一般商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
normal_ | 表示順序に対する期間 一般商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
recommend_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアの表示方法 A : 自動並べ替え |
recommend_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
recommend_ | 商品カテゴリの表示方法の順序 おすすめ商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
recommend_ | 表示順序に対する期間 おすすめ商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
new_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアの表示方法 A : 自動並べ替え |
new_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
new_ | 商品カテゴリの表示方法の順序 新着商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
new_ | 表示順序に対する期間 新着商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
Update a category
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの投稿権限 (mall.write_category) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
category_ Max Length : [50] | カテゴリ名 該当する商品カテゴリ名 |
display_ | ショップの表示設定 該当する商品カテゴリを PC ショップに表示するか、モバイルショップに表示するか、両方に表示するかの設定 A:PC + モバイル |
use_ | メインカテゴリの表示ステータス 商品カテゴリがショップのトップページに表示されるかどうかの有無。メインカテゴリに表示する場合は中/小/細カテゴリも大カテゴリのように最上位に表示される。 T:表示する |
use_ | 表示ステータス 商品カテゴリ表示の設定。「表示しない」の場合、その商品カテゴリにアクセスできない。 T:表示する |
soldout_ | 在庫切れ商品の表示 在庫切れ商品を商品カテゴリの一番前に表示するか、一番後ろに表示するかの設定 B:在庫切れ商品を一番後ろに |
sub_ | 下位カテゴリ商品の表示 現在の商品カテゴリの下位カテゴリに表示されている商品まで含めて表示するか否かの設定 T:表示する |
hashtag_ | ハッシュタグ商品の表示 ハッシュタグ商品表示機能の使用設定 T:表示する |
hash_ | ハッシュタグ 該当する商品カテゴリのハッシュタグリスト |
product_ | 商品カテゴリの表示エリアの区分 商品カテゴリに商品を一括表示するか、エリア別に表示するかの設定 A:すべて |
product_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「すべて」の場合、その商品カテゴリの表示方法 A : 自動並べ替え |
product_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「すべて」で、商品カテゴリの表示方法が「自動表示」または「自動表示+使用者指定」の場合、その商品カテゴリをどのような基準で表示するかの設定 A:最近追加された商品 |
product_ | 商品カテゴリの表示方法の順序 商品カテゴリの表示方法を降順にするか、昇順にするかの設定 D:降順 |
product_ | 表示順序に対する期間 表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
normal_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアの表示方法 A : 自動並べ替え |
normal_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、一般商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
normal_ | 商品カテゴリの表示方法の順序 一般商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
normal_ | 表示順序に対する期間 一般商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
recommend_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアの表示方法 A : 自動並べ替え |
recommend_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、おすすめ商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
recommend_ | 商品カテゴリの表示方法の順序 おすすめ商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
recommend_ | 表示順序に対する期間 おすすめ商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
new_ | 商品カテゴリの表示方法 商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアの表示方法 A : 自動並べ替え |
new_ | 商品カテゴリの表示方法キー 商品カテゴリ表示エリアの設定が「エリア別」の場合、新着商品エリアをどのような基準で表示するかの設定 A:最近追加された商品 |
new_ | 商品カテゴリの表示方法の順序 新着商品エリアの表示方法を降順にするか、昇順にするかの設定 D:降順 |
new_ | 表示順序に対する期間 新着商品エリアの表示方法が販売数の多い商品(S)、検索数の多い商品(C)の場合、基準となる期間 W:すべての期間 |
Delete a category
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの投稿権限 (mall.write_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
category_ Required | カテゴリ番号 |
Categories decorationimages
Categories decorationimages properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
category_ | カテゴリ番号 |
use_ | カテゴリメニュー画像の使用設定(PC) T:使用する |
menu_ | カテゴリメニューのデフォルト画像(PC) |
menu_ | カテゴリメニューのマウスオーバー画像(PC) |
use_ | カテゴリ上部画像の使用設定(PC) T:使用する |
top_ | カテゴリの上部画像(PC) |
use_ | カテゴリタイトル画像の使用設定(PC) T:使用する |
title_ | カテゴリのタイトル画像(PC) |
use_ | カテゴリメニュー画像の使用設定(モバイル) T:使用する |
menu_ | カテゴリメニューのデフォルト画像(モバイル) |
use_ | カテゴリ上部画像の使用設定(モバイル) T:使用する |
top_ Array Max : [3] | カテゴリの上部画像(モバイル) |
use_ | カテゴリタイトル画像の使用設定(モバイル) T:使用する |
title_ | カテゴリのタイトル画像(モバイル) |
List all categories decoration images
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
Update a categories decorationimage
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの投稿権限 (mall.write_category) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
use_ | カテゴリメニュー画像の使用設定(PC) T:使用する |
menu_ | カテゴリメニューのデフォルト画像(PC) |
menu_ | カテゴリメニューのマウスオーバー画像(PC) |
use_ | カテゴリ上部画像の使用設定(PC) T:使用する |
top_ Array Max : [3] | カテゴリの上部画像(PC) |
use_ | カテゴリタイトル画像の使用設定(PC) T:使用する |
title_ | カテゴリのタイトル画像(PC) |
use_ | カテゴリメニュー画像の使用設定(モバイル) T:使用する |
menu_ | カテゴリメニューのデフォルト画像(モバイル) |
use_ | カテゴリ上部画像の使用設定(モバイル) T:使用する |
top_ Array Max : [3] | カテゴリの上部画像(モバイル) |
use_ | カテゴリタイトル画像の使用設定(モバイル) T:使用する |
title_ | カテゴリのタイトル画像(モバイル) |
Categories seo
Categories seo properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
category_ | カテゴリ番号 |
search_ | 検索エンジンでの表示設定 T:使用する |
meta_ | ブラウザでのタイトル |
meta_ | メタタグ1:Author |
meta_ | メタタグ2:Description |
meta_ | メタタグ3:Keywords |
List all categories seo
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
Update a categories seo
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの投稿権限 (mall.write_category) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
search_ | 検索エンジンでの表示設定 T:使用する |
meta_ | ブラウザでのタイトル |
meta_ | メタタグ1:Author |
meta_ | メタタグ2:Description |
meta_ | メタタグ3:Keywords |
Mains
メインカテゴリ(Mains)はショップの商品をトップページに表示できる商品カテゴリです。
Endpoints
Mains properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
module_ | モジュールコード 各メインカテゴリに指定されたモジュールコード |
display_ | メインカテゴリ番号 |
group_ | メインカテゴリ名 メインカテゴリの生成時に指定したカテゴリ名 |
soldout_ | 在庫切れ商品の表示 在庫切れ商品が表示される位置 B:在庫切れ商品を一番後ろに |
List all mains
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品カテゴリの閲覧権限 (mall.read_category) |
呼び出し件数制限 | 40 |
Product
Bundleproducts
Bundleproducts properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
product_ | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
product_ Type : [A-Z0-9] | 商品コード システムにより商品に付与されたコード。ショップ内で商品コードは重複しない。 |
bundle_ | セット商品の構成商品情報 |
custom_ Max Length : [40] | 独自商品コード ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
product_ Max Length : [250] | 商品名 商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。HTMLを使って入力できる。 |
eng_ Max Length : [250] | 英語商品名 商品の英語名。海外配送などに使用可能 |
supply_ Max Length : [250] | 供給会社の商品名 供給会社が登録した商品の名前。供給会社が商品を区分するために任意で入力することができる。商品名には影響しない。 |
internal_ Max Length : [50] | 管理用商品名 |
model_ Max Length : [100] | モデル名 商品のモデル名 |
display | 表示ステータス 商品をショップに表示するかどうかを設定。商品をショップに表示すると設定した商品カテゴリとトップページに表示される。商品がショップに表示されないとショップの画面に表示されないためアクセスができず、商品を購入することもできない。 T:表示する |
selling | 販売ステータス 商品をショップで販売するかどうかを設定。商品が表示されている状況で販売を中止する場合、ショップに商品は表示されるが「在庫切れ」と表示されるため、商品を購入することができない。商品のステータスが「表示しない」の場合、ステータスが「販売」であっても商品にアクセスできないため、購入できない。 T:販売する |
product_ | 商品ステータス 販売する商品のステータス表示 N:新着商品 |
product_ Max : [2147483647] | 中古商品の使用月数 |
summary_ Max Length : [255] | 商品要約説明 商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 |
product_ Max Length : [200] | 商品検索キーワード 検索または分類のために商品に入力する検索キーワード情報(ハッシュタグ) |
price_ Max Length : [20] | 販売価格の代替メッセージ 商品の価格の代わりに表示されるメッセージ。在庫切れや商品が一時的に販売できない場合に使用 |
buy_ | 購入制限の個別設定の有無 T: 使用する |
buy_ | 購入制限 商品を購入することができる会員情報の表示 N:会員のみ購入でき |
buy_ | 購入できる会員ランク |
repurchase_ | 再購入制限 T : 再購入不可 |
single_ | 単独購入制限 T : 単独購入不可 |
points_ | ポイントの個別設定を使用するかどうか F : 基本設定使用 |
points_ | 決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 |
points_ | ポイント設定情報 |
except_ | 会員ランク別の追加ポイントを付与しない T:会員ランク追加付与除外を設定する |
adult_ | 年齢認証 年齢認証(確認)が必要な商品かどうかの有無。年齢認証が必要な商品を購入するためには本人認証(確認)をしなければならない。 T:使用する |
detail_ | 詳細画像 商品詳細画面に表示される商品画像 |
list_ | 一覧画像 商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像 |
tiny_ | 縮小一覧画像 最近チェックした商品領域に表示される商品の一覧画像 |
small_ | 縮小画像 商品詳細画面の下部に表示される商品の一覧画像 |
use_ | Naver Payの使用有無 T:使用する |
naverpay_ | Naver Pay販売タイプ C : Naver Pay + ショップ 同時販売 商品 |
icon_ | アイコンの表示期間 商品に設定したアイコンが表示される期間 |
icon Array Max : [5] | アイコン 商品に表示されるアイコン。商品販売をアピールするための目的で使用可能 |
hscode | HSコード 海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。 |
product_ | 商品重量 商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。 |
product_ | 商品素材 商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。 |
created_ timezone | 作成日 商品が生成された日時 |
updated_ timezone | 修正日 商品が修正された日時 |
english_ | 英語商品素材 商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。 |
cloth_ | 生地 商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) |
list_ | おすすめ / 在庫切れ / 新着商品アイコン表示の設定 おすすめ、在庫切れ、新着商品アイコンをリストに表示するかどうかを設定 |
sold_ | 在庫切れ状況 T:在庫切れ |
discountprice | 商品の割引価格リソース
|
decorationimages | デコ画像リソース
|
benefits | 特典リソース
|
additionalimages Array Max : [20] | 追加の画像リソース
|
exposure_ | 商品表示制限の範囲 A:すべての顧客に表示 |
exposure_ | 商品表示対象の会員ランク |
bundle_ | セット割引情報 |
category | カテゴリ番号 商品が表示されている商品カテゴリ |
project_ | キャンペーン番号 |
description | 商品詳細説明 商品に対するより詳細な情報が含まれている説明。HTMLを使って入力できる。 |
mobile_ | モバイル商品詳細説明 入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。 |
separated_ | モバイル用登録 T : 直接登録 |
additional_ Array Max : [20] | 追加画像 商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。 |
payment_ | 商品決済ガイド 商品の決済方法に対する案内文。HTMLを使って入力できる。 |
shipping_ | 商品配送ガイド 商品の配送方法に対するガイド。HTMLを使って入力できる。 |
exchange_ | 交換・返品ガイド 商品の交換・返品方法に対する説明。HTMLを使って入力できる。 |
service_ | サービスに関するお問い合わせ/ガイド 製品の事後顧客サービス方法に関するガイド。HTMLを使って入力できる。 |
country_ | 国別HSコード 海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。 |
simple_ | 商品簡略説明 商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 |
shipping_ | 個別配送の設定 送料を商品別に払わせるか共通送料を払わせるかを設定 T:使用する |
shipping_ | 配送方法 (個別送料を使う場合)配送手段及び方法 01:宅配 |
prepaid_ | 送料前払いの設定 C:着払い |
shipping_ | 配送期間 (個別送料を使う場合)商品の配送時に平均的にかかる配送期間 |
shipping_ | 配送情報 国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ管理 > 配送管理 > 配送・返品の設定]で商品別の個別送料設定が「使用しない」の場合は設定できない。 A:国内配送 |
shipping_ Max Length : [255] | 配送地域 (個別送料を使う場合)商品の配送ができる地域 |
shipping_ | 送料タイプ (個別送料を利用する場合)商品の送料タイプ T:送料無料 |
shipping_ | 範囲別送料 個別送料を使う場合、商品の個別送料 |
clearance_ | 海外通関用商品区分(英語名) 海外通関時に通関用商品区分情報として使う情報。日本語名の入力時に入力した区分名が自動翻訳された項目 |
clearance_ | 海外通関用商品区分(日本語名) 海外通関時に通関用商品区分情報として使う情報。英語に自動翻訳されて海外送状の商品名情報に含まれて送られる。 |
clearance_ Type : [A-Z0-9] | 海外通関コード |
additional_ | 追加項目 商品管理 > 商品表示設定 > 商品情報項目設定で追加した追加項目 |
image_ | 画像アップロードタイプ 画像をアップロードする時、画像のアップロードタイプ A:メイン画像登録 |
main | メイン表示 商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。 |
relational_ Array Max : [200] | 関連商品 似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。 |
memos | メモリソース
詳細検索時のみ確認可能である。 |
hits | 商品閲覧数リソース
詳細検索時のみ確認可能である。 |
seo | 商品Seo リソース
詳細検索時のみ確認可能である。 |
tags | 商品タグリソース
詳細検索時のみ確認可能である。 |
List all bundleproducts
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
discountprice embed | 商品の割引価格リソース |
decorationimages embed | デコ画像リソース |
benefits embed | 特典リソース |
additionalimages embed | 追加の画像リソース |
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ | 商品番号 検索したい商品の番号 ,(コンマ)で複数の件を検索することができる。 |
display | 表示ステータス T:表示する |
selling | 販売ステータス T:販売する |
product_ | 商品コード ,(コンマ)で複数の件を検索することができる。 |
product_ | 商品検索キーワード ,(コンマ)で複数の件を検索することができる。 |
custom_ | 独自商品コード ,(コンマ)で複数の件を検索することができる。 |
product_ | 商品名 ,(コンマ)で複数の件を検索することができる。 |
eng_ | 英語商品名 ,(コンマ)で複数の件を検索することができる。 |
supply_ | 供給会社の商品名 ,(コンマ)で複数の件を検索することができる。 |
internal_ | 管理用商品名 ,(コンマ)で複数の件を検索することができる。 |
model_ | モデル名 ,(コンマ)で複数の件を検索することができる。 |
price_ | 商品販売価格の検索最小値 |
price_ | 商品販売価格の検索最大値 |
created_ timezone | 商品登録日の検索開始日 |
created_ timezone | 商品登録日の検索終了日 |
updated_ timezone | 商品修正日の検索開始日 |
updated_ timezone | 商品修正日の検索終了日 |
category | カテゴリ番号 |
category_ | 未適用カテゴリを検索 T:未適用カテゴリを検索 |
include_ | 下位カテゴリを含めて検索 T:含む |
product_ | 商品重量 |
additional_ | 追加項目の検索条件キー |
additional_ | 追加項目の検索条件値 |
sort | 並べ替え順序の値 created_date:登録日 |
order | 並べ替え順序 asc:並べ替え(昇順) |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 検索結果の開始位置 |
Get a bundleproduct
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 検索したい商品の番号 |
discountprice embed | 商品の割引価格リソース |
decorationimages embed | デコ画像リソース |
benefits embed | 特典リソース |
memos embed | メモリソース |
hits embed | 商品閲覧数リソース |
seo embed | 商品Seo リソース |
tags embed | 商品タグリソース |
additionalimages embed | 追加の画像リソース |
Create a bundleproduct
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required Max Length : [250] | 商品名 |
bundle_ Required | セット商品の構成商品情報 |
product_no purchase_quantity | |
bundle_ Required | セット割引情報 |
discount_value discount_type discount_round_unit discount_round_type | |
display | 表示ステータス T:表示する DEFAULT F |
selling | 販売ステータス T:販売する DEFAULT F |
add_ | 追加カテゴリ番号 カテゴリ番号を使って表示したいカテゴリに商品登録 |
category_no recommend new | |
custom_ Max Length : [40] | 独自商品コード ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
eng_ Max Length : [250] | 英語商品名 |
supply_ Max Length : [250] | 供給会社の商品名 |
internal_ Max Length : [50] | 管理用商品名 |
model_ Max Length : [100] | モデル名 |
use_ | Naver Payの使用有無 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する |
naverpay_ | Naver Pay販売タイプ Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : Naver Pay + ショップ 同時販売 商品 |
product_ Min : [0]~Max : [999999.99] | 商品重量 |
description | 商品詳細説明 |
mobile_ | モバイル商品詳細説明 入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。 |
summary_ Max Length : [255] | 商品要約説明 |
simple_ | 商品簡略説明 |
product_ Max Length : [200] | 商品検索キーワード |
payment_ | 商品決済ガイド |
shipping_ | 商品配送ガイド |
exchange_ | 交換・返品ガイド |
service_ | サービスに関するお問い合わせ/ガイド |
icon Array Max : [5] | アイコン |
hscode Max Length : [20] | HSコード 配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力 |
shipping_ | 配送情報 国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ管理 > 配送管理 > 配送・返品の設定]で商品別の個別送料設定が「使用しない」の場合は設定できない。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A:国内配送 DEFAULT A |
shipping_ | 配送方法 01:宅配 DEFAULT 01 |
shipping_ | 個別配送の設定 T:個別配送 DEFAULT F |
shipping_ Max Length : [255] | 配送地域 |
shipping_ Array Max : [2] | 配送期間 |
minimum maximum | |
shipping_ | 送料タイプ 個別送料を使う場合、商品の送料タイプ T:送料無料 DEFAULT T |
shipping_ | 送料金額 個別送料を使う場合、商品の個別送料 |
prepaid_ | 送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C:着払い DEFAULT B |
clearance_ Type : [A-Z0-9] | 海外通関コード 配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力 |
detail_ | 詳細画像 |
list_ | 一覧画像 |
tiny_ | 縮小一覧画像 |
small_ | 縮小画像 |
image_ | 画像アップロードタイプ 画像をアップロードする時、画像のアップロードタイプ A:メイン画像登録 DEFAULT A |
additional_ | 追加項目 |
key value | |
price_ Max Length : [20] | 販売価格の代替メッセージ |
buy_ | 購入制限の個別設定の有無 T: 使用する DEFAULT F |
buy_ | 購入制限 N:会員のみ購入でき DEFAULT F |
buy_ | 購入できる会員ランク |
repurchase_ | 再購入制限 T : 再購入不可 DEFAULT F |
single_ | 単独購入制限 T : 単独購入不可 DEFAULT F |
points_ | ポイントの個別設定を使用するかどうか F : 基本設定使用 DEFAULT F |
points_ | 決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 |
points_ | ポイント設定情報 |
except_ | 会員ランク別の追加ポイントを付与しない T:会員ランク追加付与除外を設定する DEFAULT F |
main | メイン表示 商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。 |
relational_ Array Max : [200] | 関連商品 似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。 |
product_no interrelated | |
product_ | 商品素材 商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。 |
english_ | 英語商品素材 商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。 |
cloth_ | 生地 商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) |
additional_ | 追加画像 商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。 |
adult_ | 年齢認証 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する DEFAULT F |
exposure_ | 商品表示制限の範囲 A:すべての顧客に表示 DEFAULT A |
exposure_ | 商品表示対象の会員ランク |
Update a bundleproduct
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
product_ Max Length : [250] | 商品名 |
bundle_ | セット商品の構成商品情報 |
product_no purchase_quantity | |
bundle_ | セット割引情報 |
discount_value discount_type discount_round_unit discount_round_type | |
display | 表示ステータス 商品をショップに表示するかどうかを変更 T:表示する |
selling | 販売ステータス T:販売する |
product_ | 商品ステータス N:新着商品 |
product_ Max : [2147483647] | 中古商品の使用月数 商品状態(product_condition)が中古である場合、該当商品の使用月数 |
add_ | 追加カテゴリ番号 商品カテゴリ番号を入力してその商品に特定の商品カテゴリを追加登録 |
category_no recommend new | |
delete_ | 削除されたカテゴリ番号 商品カテゴリ番号を入力してその商品から特定の商品カテゴリを削除 |
custom_ Max Length : [40] | 独自商品コード ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
eng_ Max Length : [250] | 英語商品名 |
supply_ Max Length : [250] | 供給会社の商品名 |
internal_ Max Length : [50] | 管理用商品名 |
model_ Max Length : [100] | モデル名 |
use_ | Naver Payの使用有無 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する |
naverpay_ | Naver Pay販売タイプ Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : Naver Pay + ショップ 同時販売 商品 |
product_ Min : [0]~Max : [999999.99] | 商品重量 |
description | 商品詳細説明 |
mobile_ | モバイル商品詳細説明 入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。 |
summary_ Max Length : [255] | 商品要約説明 |
simple_ | 商品簡略説明 |
product_ Max Length : [200] | 商品検索キーワード |
payment_ | 商品決済ガイド |
shipping_ | 商品配送ガイド |
exchange_ | 交換・返品ガイド |
service_ | サービスに関するお問い合わせ/ガイド |
icon Array Max : [5] | アイコン |
use_ | 表示期間の使用の有無 T:使用する |
icon_ | 表示期間の開始日 |
icon_ | 表示期間の終了日 |
hscode Max Length : [20] | HSコード 配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力 |
shipping_ | 配送情報 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A:国内配送 |
prepaid_ | 送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C:着払い |
shipping_ | 配送方法 01:宅配 |
shipping_ | 個別配送の設定 T:個別配送 |
shipping_ Max Length : [255] | 配送地域 |
shipping_ Array Max : [2] | 配送期間 |
minimum maximum | |
shipping_ | 送料タイプ 個別送料を使う場合、商品の送料タイプ T:送料無料 |
shipping_ | 送料金額 個別送料を使う場合、商品の個別送料 |
clearance_ Type : [A-Z0-9] | 海外通関コード 配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力 |
detail_ | 詳細画像 |
list_ | 一覧画像 |
tiny_ | 縮小一覧画像 |
small_ | 縮小画像 |
image_ | 画像アップロードタイプ 画像をアップロードする時、画像のアップロードタイプ A:メイン画像登録 |
additional_ | 追加項目 |
key value | |
price_ Max Length : [20] | 販売価格の代替メッセージ |
buy_ | 購入制限の個別設定の有無 T: 使用する |
buy_ | 購入制限 N:会員のみ購入でき |
buy_ | 購入できる会員ランク |
repurchase_ | 再購入制限 T : 再購入不可 |
single_ | 単独購入制限 T : 単独購入不可 |
points_ | ポイントの個別設定を使用するかどうか F : 基本設定使用 |
points_ | 決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 |
points_ | ポイント設定情報 |
except_ | 会員ランク別の追加ポイントを付与しない T:会員ランク追加付与除外を設定する |
main | メイン表示 商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。 |
relational_ Array Max : [200] | 関連商品 似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。 |
product_no interrelated | |
product_ | 商品素材 商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。 |
english_ | 英語商品素材 商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。 |
cloth_ | 生地 商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) |
additional_ | 追加画像 商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。 |
adult_ | 年齢認証 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する |
exposure_ | 商品表示制限の範囲 A:すべての顧客に表示 |
exposure_ | 商品表示対象の会員ランク |
Delete a bundleproduct
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Categories products
「Categories products」は、あるカテゴリに属する商品の表示順、固定機能の使用有無、表示エリアなどを照会/変更できるリレーショナル(関係)リソースです。
Categories products properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
product_ | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
sequence_ | 表示順序 |
auto_ | 「自動並べ替え」設定の有無 |
sold_ | 在庫切れ状況 |
fixed_ | 「固定」設定の有無 |
not_ | 「販売しない」設定の有無 |
display_ Min : [1]~Max : [3] | 商品カテゴリの詳細 1: 一般商品 DEFAULT 1 |
sequence Min : [1]~Max : [999998] | 表示順序 |
List all categories products
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
display_ Required Min : [1]~Max : [3] | 商品カテゴリの詳細 1: 一般商品 |
limit Min : [1]~Max : [50000] | 検索結果の最大件数 DEFAULT 50000 |
Count all categories products
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
display_ Required Min : [1]~Max : [3] | 商品カテゴリの詳細 1: 一般商品 |
Create a categories product
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
category_ Required | カテゴリ番号 |
display_ Min : [1]~Max : [3] | 商品カテゴリの詳細 1: 一般商品 DEFAULT 1 |
product_ Required | 商品番号 |
Update a categories product
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
category_ Required | カテゴリ番号 |
display_ Required Min : [1]~Max : [3] | 商品カテゴリの詳細 1: 一般商品 |
product_ Required | 商品番号 |
sequence Min : [1]~Max : [999999] | 表示順序 |
auto_ | 「自動並べ替え」設定の有無 T:自動並べ替えを使用する |
fixed_ | 「固定」設定の有無 T:表示順位固定を使用する |
Delete a categories product
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
category_ Required | カテゴリ番号 |
product_ Required | 商品番号 |
display_ Min : [1]~Max : [3] | 商品カテゴリの詳細 一般商品エリアで「表示しない」に処理する場合、おすすめ商品/新着商品エリアでも同時に非表示処理されます。 1: 一般商品 DEFAULT 1 |
Mains products
「Mains products」は、商品のメイン表示順に関するメインカテゴリのリレーショナル(関係)リソースです。
Mains products properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
product_ | 商品番号 |
product_ | 商品名 |
fixed_ | 「固定」設定の有無 |
List all mains products
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
display_ Required | メインカテゴリ番号 |
Count all mains products
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
display_ Required | メインカテゴリ番号 |
Create a mains product
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
display_ Required | メインカテゴリ番号 |
product_ Required | 商品番号 |
Update a mains product
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
display_ Required | メインカテゴリ番号 |
product_ Required | 商品番号 要求した商品番号の順序で表示順位が指定される。 |
fix_ | 表示順位固定商品の番号 表示順位を固定したい商品番号を指定 |
Delete a mains product
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
display_ Required | メインカテゴリ番号 |
product_ Required | 商品番号 |
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] | 英語商品名 商品の英語名。海外配送などに使用可能 |
supply_ Max Length : [250] | 供給会社の商品名 供給会社が登録した商品の名前。供給会社が商品を区分するために任意で入力することができる。商品名には影響しない。 |
internal_ Max Length : [50] | 管理用商品名 |
model_ Max Length : [100] | モデル名 商品のモデル名 |
price_ | 商品価格(税別) |
price | 商品販売価格 商品の販売価格。クーポン及び特典を適用する前の価格 |
retail_ | 商品の定価 市場で販売される消費者価格。ショップの価格をアピールする比較の目的で使う。 |
supply_ | 商品仕入れ価格 商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。 |
display | 表示ステータス 商品をショップに表示するかどうかを設定。商品をショップに表示すると設定した商品カテゴリとトップページに表示される。商品がショップに表示されないとショップの画面に表示されないためアクセスができず、商品を購入することもできない。 T:表示する |
selling | 販売ステータス 商品をショップで販売するかどうかを設定。商品が表示されている状況で販売を中止する場合、ショップに商品は表示されるが「在庫切れ」と表示されるため、商品を購入することができない。商品のステータスが「表示しない」の場合、ステータスが「販売」であっても商品にアクセスできないため、購入できない。 T:販売する |
product_ | 商品ステータス 販売する商品のステータス表示 N:新着商品 |
product_ Max : [2147483647] | 中古商品の使用月数 |
summary_ Max Length : [255] | 商品要約説明 商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 |
product_ Max Length : [200] | 商品検索キーワード 検索または分類のために商品に入力する検索キーワード情報(ハッシュタグ) |
margin_ Min : [-999.99]~Max : [999.99] | 売上総利益率 商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。 |
tax_ | 課税区分 商品の課税情報 A:課税商品 |
tax_ Min : [0]~Max : [100] | 税率 課税商品の場合、その商品に適用される消費税率を明示する。 |
price_ Max Length : [20] | 販売価格の代替メッセージ 商品の価格の代わりに表示されるメッセージ。在庫切れや商品が一時的に販売できない場合に使用 |
buy_ | 購入制限の個別設定の有無 T: 使用する |
buy_ | 購入制限 商品を購入することができる会員情報の表示 N:会員のみ購入でき |
buy_ | 購入できる会員ランク |
repurchase_ | 再購入制限 T : 再購入不可 |
single_ | 単独購入制限 T : 単独購入不可 |
buy_ | 購入単位のタイプ 商品の購入単位を1個以上に設定した場合、その購入単位を品目単位にするか、商品単位にするかの設定 P:商品基準 |
buy_ | 購入単位 購入できる最小限の単位表示 |
order_ | 注文数量の制限基準 商品の注文数量を制限する場合、制限基準を品目単位にするか、商品単位にするかの設定 P:商品基準 |
minimum_ Max : [2147483647] | 最小注文数量 注文可能な最小限の注文数量。注文数量未満は購入できない。 |
maximum_ Max : [2147483647] | 最大注文数量 注文可能な最大限の注文数量。注文数量を超過して購入することはできない。 |
points_ | ポイントの個別設定を使用するかどうか F : 基本設定使用 |
points_ | 決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 |
points_ | ポイント設定情報 |
except_ | 会員ランク別の追加ポイントを付与しない T:会員ランク追加付与除外を設定する |
product_ | 商品容積情報 |
adult_ | 年齢認証 年齢認証(確認)が必要な商品かどうかの有無。年齢認証が必要な商品を購入するためには本人認証(確認)をしなければならない。 T:使用する |
detail_ | 詳細画像 商品詳細画面に表示される商品画像 |
list_ | 一覧画像 商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像 |
tiny_ | 縮小一覧画像 最近チェックした商品領域に表示される商品の一覧画像 |
small_ | 縮小画像 商品詳細画面の下部に表示される商品の一覧画像 |
has_ | オプション使用の設定 商品にオプションが付いているかの有無。オプションのある商品はサイズや色など多様な選択肢を提供する。 T:オプションを使用する |
option_ | オプション構成方式 オプションを使う場合、オプションのタイプを表示 C:組み合わせ一体選択型 |
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] | ブランドコード ブランドを登録すると自動生成されるコードで、商品に特定ブランドを指定する場合に使う。 |
supplier_ Type : [A-Z0-9] | 供給会社のコード 供給会社を登録すると自動生成されるコードで、商品に特定供給会社を指定する時に使う。 |
made_ | 製造日 商品を製造した製造日 |
release_ | 発売開始日 商品が市場で発売開始された日 |
expiration_ Array Max : [2] | 有効期間 商品を正常に使える期間。商品券やチケットのような無形商品、食品や化粧品のような有形商品の有効期間を表示 |
origin_ | 原産国 国内/国外/その他 F:国内 |
origin_ | 原産国番号 List all Origin APIで原産国を検索して原産国番号を入力 |
origin_ Max Length : [30] | 原産国のその他の情報 原産国が「その他(1800)」の場合、原産国として入力可能な情報 |
made_ | 国名(原産国)コード |
icon_ | アイコンの表示期間 商品に設定したアイコンが表示される期間 |
icon Array Max : [5] | アイコン 商品に表示されるアイコン。商品販売をアピールするための目的で使用可能 |
hscode | HSコード 海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。 |
product_ | 商品重量 商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。 |
product_ | 商品素材 商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。 |
created_ timezone | 作成日 商品が生成された日時 |
updated_ timezone | 修正日 商品が修正された日時 |
english_ | 英語商品素材 商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。 |
cloth_ | 生地 商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) |
list_ | おすすめ / 在庫切れ / 新着商品アイコン表示の設定 おすすめ、在庫切れ、新着商品アイコンをリストに表示するかどうかを設定 |
select_ | オプション別に1個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する |
approve_ | 承認申込結果 N:承認申込(新規商品) |
classification_ Type : [A-Z0-9] | 独自カテゴリコード 独自カテゴリを登録すると自動生成されるコードで、商品に特定の独自カテゴリを指定する場合に使う。 |
sold_ | 在庫切れ状況 T:在庫切れ |
additional_ | 販売価格の追加金額 |
discountprice | 商品の割引価格リソース
|
decorationimages | デコ画像リソース
|
benefits | 特典リソース
|
options | 商品オプションリソース
|
variants | 品目リソース
|
clearance_ | 海外通関用商品区分(英語名) 海外通関時に通関用商品区分情報として使う情報。日本語名の入力時に入力した区分名が自動翻訳された項目 |
clearance_ | 海外通関用商品区分(日本語名) 海外通関時に通関用商品区分情報として使う情報。英語に自動翻訳されて海外送状の商品名情報に含まれて送られる。 |
clearance_ Type : [A-Z0-9] | 海外通関コード |
additionalimages | 追加の画像リソース
|
exposure_ | 商品表示制限の範囲 A:すべての顧客に表示 |
exposure_ | 商品表示対象の会員ランク |
set_ | セット商品のタイプ C:一般セット |
memos | メモリソース
|
hits | 商品閲覧数リソース
|
seo | 商品Seo リソース
|
category | カテゴリ番号 商品が表示されている商品カテゴリ |
project_ | キャンペーン番号 |
description | 商品詳細説明 商品に対するより詳細な情報が含まれている説明。HTMLを使って入力できる。 |
mobile_ | モバイル商品詳細説明 入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。 |
separated_ | モバイル用登録 T : 直接登録 |
additional_ Array Max : [20] | 追加画像 商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。 |
payment_ | 商品決済ガイド 商品の決済方法に対する案内文。HTMLを使って入力できる。 |
shipping_ | 商品配送ガイド 商品の配送方法に対するガイド。HTMLを使って入力できる。 |
exchange_ | 交換・返品ガイド 商品の交換・返品方法に対する説明。HTMLを使って入力できる。 |
service_ | サービスに関するお問い合わせ/ガイド 製品の事後顧客サービス方法に関するガイド。HTMLを使って入力できる。 |
product_ | 消費税表示メッセージ 商品管理 > 商品表示管理 > 商品情報表示設定 > 販売価格付加価値税表示メッセージで設定したメッセージ表示 |
country_ | 国別HSコード 海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。 |
simple_ | 商品簡略説明 商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 |
tags | 商品タグリソース
|
shipping_ | 個別配送の設定 送料を商品別に払わせるか共通送料を払わせるかを設定 T:使用する |
shipping_ | 配送方法 (個別送料を使う場合)配送手段及び方法 01:宅配 |
prepaid_ | 送料前払いの設定 C:着払い |
shipping_ | 配送期間 (個別送料を使う場合)商品の配送時に平均的にかかる配送期間 |
shipping_ | 配送情報 国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ管理 > 配送管理 > 配送・返品の設定]で商品別の個別送料設定が「使用しない」の場合は設定できない。 A:国内配送 |
shipping_ Max Length : [255] | 配送地域 (個別送料を使う場合)商品の配送ができる地域 |
shipping_ | 送料タイプ (個別送料を利用する場合)商品の送料タイプ T:送料無料 |
shipping_ | 範囲別送料 個別送料を使う場合、商品の個別送料 |
origin_ | 原産国コード 商品の原産国コード |
additional_ | 追加項目 商品管理 > 商品表示設定 > 商品情報項目設定で追加した追加項目 |
image_ | 画像アップロードタイプ 画像をアップロードする時、画像のアップロードタイプ A:メイン画像登録 |
main | メイン表示 商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。 |
relational_ Array Max : [200] | 関連商品 似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。 |
List all products
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
discountprice embed | 商品の割引価格リソース |
decorationimages embed | デコ画像リソース |
benefits embed | 特典リソース |
options embed | 商品オプションリソース |
variants embed | 品目リソース 商品1点あたりの品目情報を100件まで照会可能 |
additionalimages embed | 追加の画像リソース |
product_ | セット商品の有無 T:使用する |
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_ timezone | 商品登録日の検索開始日 商品登録日が該当日以後である商品検索 |
created_ timezone | 商品登録日の検索終了日 商品登録日が該当日以前である商品検索 |
updated_ timezone | 商品修正日の検索開始日 商品修正日が該当日以後である商品検索 |
updated_ timezone | 商品修正日の検索終了日 商品修正日が該当日以前である商品検索 |
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] | 該当する商品番号以降の番号から検索 特定の商品番号より数字が大きい商品番号を検索 |
sort | 並べ替え順序の値 created_date:登録日 |
order | 並べ替え順序 asc:並べ替え(昇順) |
offset Max : [5000] | 検索結果の開始位置 検索結果の開始位置 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
Count all products
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_ timezone | 商品登録日の検索開始日 商品登録日が該当日以後である商品検索 |
created_ timezone | 商品登録日の検索終了日 商品登録日が該当日以前である商品検索 |
updated_ timezone | 商品修正日の検索開始日 商品修正日が該当日以後である商品検索 |
updated_ timezone | 商品修正日の検索終了日 商品修正日が該当日以前である商品検索 |
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] | 該当する商品番号以降の番号から検索 特定の商品番号より数字が大きい商品番号を検索。 |
Get a product
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 | 追加の画像リソース |
Create a product
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
display | 表示ステータス T:表示する DEFAULT F |
selling | 販売ステータス T:販売する DEFAULT F |
product_ | 商品ステータス N:新着商品 DEFAULT N |
product_ Max : [2147483647] | 中古商品の使用月数 商品状態(product_condition)が中古である場合、該当商品の使用月数 |
add_ | 追加カテゴリ番号 カテゴリ番号を使って表示したいカテゴリに商品登録 |
category_no recommend new | |
custom_ Max Length : [40] | 独自商品コード ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
product_ Required Max Length : [250] | 商品名 |
eng_ Max Length : [250] | 英語商品名 |
supply_ Max Length : [250] | 供給会社の商品名 |
internal_ Max Length : [50] | 管理用商品名 |
model_ Max Length : [100] | モデル名 |
price_ Min : [0]~Max : [2147483647] | 商品価格(税別) |
price Min : [0]~Max : [2147483647] | 商品販売価格 |
retail_ Min : [0]~Max : [2147483647] | 商品の定価 |
supply_ Required Min : [0]~Max : [2147483647] | 商品仕入れ価格 商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。 |
has_ | オプション使用の設定 T:オプションを使用する DEFAULT F |
options | オプション |
name value | |
use_ | Naver Payの使用有無 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する |
naverpay_ | Naver Pay販売タイプ Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : Naver Pay + ショップ 同時販売 商品 |
manufacturer_ Type : [A-Z0-9] | メーカーコード DEFAULT M0000000 |
trend_ Type : [A-Z0-9] | トレンドコード DEFAULT T0000000 |
brand_ Type : [A-Z0-9] | ブランドコード DEFAULT B0000000 |
supplier_ Type : [A-Z0-9] | 供給会社のコード DEFAULT S0000000 |
product_ Min : [0]~Max : [999999.99] | 商品重量 |
made_ | 製造日 |
release_ | 発売開始日 |
expiration_ Array Max : [2] | 有効期間 |
start_date end_date | |
description | 商品詳細説明 |
mobile_ | モバイル商品詳細説明 入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。 |
summary_ Max Length : [255] | 商品要約説明 |
simple_ | 商品簡略説明 |
product_ Max Length : [200] | 商品検索キーワード |
payment_ | 商品決済ガイド |
shipping_ | 商品配送ガイド |
exchange_ | 交換・返品ガイド |
service_ | サービスに関するお問い合わせ/ガイド |
icon Array Max : [5] | アイコン |
hscode Max Length : [20] | HSコード 配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力 |
shipping_ | 配送情報 国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ管理 > 配送管理 > 配送・返品の設定]で商品別の個別送料設定が「使用しない」の場合は設定できない。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A:国内配送 |
shipping_ | 配送方法 01:宅配 |
shipping_ | 個別配送の設定 T:個別配送 DEFAULT F |
shipping_ Max Length : [255] | 配送地域 |
shipping_ Array Max : [2] | 配送期間 |
minimum maximum | |
shipping_ | 送料タイプ 個別送料を使う場合、商品の送料タイプ T:送料無料 |
shipping_ Array Max : [200] | 送料金額 個別送料を使う場合、商品の個別送料 |
shipping_rates_min shipping_rates_max shipping_fee | |
prepaid_ | 送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C:着払い |
clearance_ Type : [A-Z0-9] | 海外通関コード 配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力 |
detail_ | 詳細画像 |
list_ | 一覧画像 |
tiny_ | 縮小一覧画像 |
small_ | 縮小画像 |
image_ | 画像アップロードタイプ 画像をアップロードする時、画像のアップロードタイプ A:メイン画像登録 DEFAULT A |
additional_ | 追加項目 |
key value | |
price_ Max Length : [20] | 販売価格の代替メッセージ |
buy_ | 購入制限の個別設定の有無 T: 使用する DEFAULT F |
buy_ | 購入制限 N:会員のみ購入でき DEFAULT F |
buy_ | 購入できる会員ランク |
repurchase_ | 再購入制限 T : 再購入不可 DEFAULT F |
single_ | 単独購入制限 T : 単独購入不可 DEFAULT F |
buy_ | 購入単位のタイプ 商品の購入単位を1個以上に設定した場合、その購入単位を品目単位にするか、商品単位にするかの設定 P:商品基準 DEFAULT O |
buy_ Max : [2147483647] | 購入単位 DEFAULT 1 |
order_ | 注文数量の制限基準 商品の注文数量を制限する場合、制限基準を品目単位にするか、商品単位にするかの設定 P:商品基準 DEFAULT O |
minimum_ Max : [2147483647] | 最小注文数量 注文可能な最小限の注文数量。注文数量未満は購入できない。 DEFAULT 1 |
maximum_ Max : [2147483647] | 最大注文数量 注文可能な最大限の注文数量。注文数量を超過して購入することはできない。 |
points_ | ポイントの個別設定を使用するかどうか F : 基本設定使用 DEFAULT F |
points_ | 決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 |
points_ | ポイント設定情報 |
payment_method points_rate points_unit_by_payment | |
except_ | 会員ランク別の追加ポイントを付与しない T:会員ランク追加付与除外を設定する DEFAULT F |
product_ | 商品容積情報 |
use_product_volume product_width product_height product_length | |
origin_ | 原産国 国内/国外/その他 F:国内 |
origin_ | 原産国番号 List all Origin APIで原産国を検索して原産国番号を入力 |
origin_ Max Length : [30] | 原産国のその他の情報 原産国が「その他(1800)」の場合、原産国として入力可能な情報 |
made_ | 国名(原産国)コード |
main | メイン表示 商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。 |
relational_ Array Max : [200] | 関連商品 似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。 |
product_no interrelated | |
product_ | 商品素材 商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。 |
english_ | 英語商品素材 商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。 |
cloth_ | 生地 商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) |
classification_ Type : [A-Z0-9] | 独自カテゴリ |
additional_ Max : [2147483647] | 販売価格の追加金額 販売価格の計算時に商品の原価と売上総利益率に加えて追加計算される金額。APIでその金額は参照の目的でしか使われない。 |
margin_ Min : [-999.99]~Max : [999.99] | 売上総利益率 商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。 |
tax_ | 課税区分 商品の課税情報 A:課税商品 DEFAULT A |
tax_ Min : [0]~Max : [100] | 税率 課税商品の場合、その商品に適用される消費税率を明示する。 |
additional_ | 追加画像 商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。 |
adult_ | 年齢認証 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する DEFAULT F |
exposure_ | 商品表示制限の範囲 A:すべての顧客に表示 DEFAULT A |
exposure_ | 商品表示対象の会員ランク |
Update a product
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
display | 表示ステータス 商品をショップに表示するかどうかを変更 T:表示する |
selling | 販売ステータス T:販売する |
product_ | 商品ステータス N:新着商品 |
product_ Max : [2147483647] | 中古商品の使用月数 商品状態(product_condition)が中古である場合、該当商品の使用月数 |
add_ | 追加カテゴリ番号 商品カテゴリ番号を入力してその商品に特定の商品カテゴリを追加登録 |
category_no recommend new | |
delete_ | 削除されたカテゴリ番号 商品カテゴリ番号を入力してその商品から特定の商品カテゴリを削除 |
custom_ Max Length : [40] | 独自商品コード ユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
product_ Max Length : [250] | 商品名 |
eng_ Max Length : [250] | 英語商品名 |
supply_ Max Length : [250] | 供給会社の商品名 |
internal_ Max Length : [50] | 管理用商品名 |
model_ Max Length : [100] | モデル名 |
price_ Min : [0]~Max : [2147483647] | 商品価格(税別) |
price Min : [0]~Max : [2147483647] | 商品販売価格 |
retail_ Min : [0]~Max : [2147483647] | 商品の定価 |
supply_ Min : [0]~Max : [2147483647] | 商品仕入れ価格 商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。 |
has_ | オプション使用の設定 F:オプション使用しない |
use_ | Naver Payの使用有無 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する |
naverpay_ | Naver Pay販売タイプ Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : Naver Pay + ショップ 同時販売 商品 |
manufacturer_ Type : [A-Z0-9] | メーカーコード |
trend_ Type : [A-Z0-9] | トレンドコード |
brand_ Type : [A-Z0-9] | ブランドコード |
supplier_ Type : [A-Z0-9] | 供給会社のコード |
product_ Min : [0]~Max : [999999.99] | 商品重量 |
made_ | 製造日 |
release_ | 発売開始日 |
expiration_ Array Max : [2] | 有効期間 |
start_date end_date | |
description | 商品詳細説明 |
mobile_ | モバイル商品詳細説明 入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。 |
summary_ Max Length : [255] | 商品要約説明 |
simple_ | 商品簡略説明 |
product_ Max Length : [200] | 商品検索キーワード |
payment_ | 商品決済ガイド |
shipping_ | 商品配送ガイド |
exchange_ | 交換・返品ガイド |
service_ | サービスに関するお問い合わせ/ガイド |
icon Array Max : [5] | アイコン |
use_ | 表示期間の使用の有無 T:使用する |
icon_ | 表示期間の開始日 |
icon_ | 表示期間の終了日 |
hscode Max Length : [20] | HSコード 配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力 |
shipping_ | 配送情報 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A:国内配送 |
shipping_ | 配送方法 01:宅配 |
shipping_ | 個別配送の設定 T:個別配送 |
shipping_ Max Length : [255] | 配送地域 |
shipping_ | 配送期間 |
minimum maximum | |
shipping_ | 送料タイプ 個別送料を使う場合、商品の送料タイプ T:送料無料 |
shipping_ Array Max : [200] | 送料金額 個別送料を使う場合、商品の個別送料 |
shipping_rates_min shipping_rates_max shipping_fee | |
prepaid_ | 送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C:着払い |
clearance_ Type : [A-Z0-9] | 海外通関コード 配送情報(shipping_scope)がB(国内/海外)またはC(海外配送)の場合、必須入力 |
detail_ | 詳細画像 |
list_ | 一覧画像 |
tiny_ | 縮小一覧画像 |
small_ | 縮小画像 |
image_ | 画像アップロードタイプ 画像をアップロードする時、画像のアップロードタイプ A:メイン画像登録 |
additional_ | 追加項目 |
key value | |
price_ Max Length : [20] | 販売価格の代替メッセージ |
buy_ | 購入制限の個別設定の有無 T: 使用する |
buy_ | 購入制限 N:会員のみ購入でき |
buy_ | 購入できる会員ランク |
repurchase_ | 再購入制限 T : 再購入不可 |
single_ | 単独購入制限 T : 単独購入不可 |
buy_ | 購入単位のタイプ 商品の購入単位を1個以上に設定した場合、その購入単位を品目単位にするか、商品単位にするかの設定 P:商品基準 |
buy_ Max : [2147483647] | 購入単位 |
order_ | 注文数量の制限基準 商品の注文数量を制限する場合、制限基準を品目単位にするか、商品単位にするかの設定 P:商品基準 |
minimum_ Max : [2147483647] | 最小注文数量 |
maximum_ Max : [2147483647] | 最大注文数量 注文可能な最大限の注文数量。注文数量を超過して購入することはできない。 |
points_ | ポイントの個別設定を使用するかどうか F : 基本設定使用 |
points_ | 決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 |
points_ | ポイント設定情報 |
payment_method points_rate points_unit_by_payment | |
except_ | 会員ランク別の追加ポイントを付与しない T:会員ランク追加付与除外を設定する |
product_ | 商品容積情報 |
use_product_volume product_width product_height product_length | |
origin_ | 原産国 国内/国外/その他 F:国内 |
origin_ | 原産国番号 List all Origin APIで原産国を検索して原産国番号を入力 |
origin_ Max Length : [30] | 原産国のその他の情報 原産国が「その他(1800)」の場合、原産国として入力可能な情報 |
made_ | 国名(原産国)コード |
main | メイン表示 商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。 |
relational_ Array Max : [200] | 関連商品 似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。 |
product_no interrelated | |
product_ | 商品素材 商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。 |
english_ | 英語商品素材 商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。 |
cloth_ | 生地 商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) |
classification_ Type : [A-Z0-9] | 独自カテゴリ |
additional_ Max : [2147483647] | 販売価格の追加金額 販売価格の計算時に商品の原価と売上総利益率に加えて追加計算される金額。APIでその金額は参照の目的でしか使われない。 |
margin_ Min : [-999.99]~Max : [999.99] | 売上総利益率 商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。 |
tax_ | 課税区分 商品の課税情報 A:課税商品 |
tax_ Min : [0]~Max : [100] | 税率 課税商品の場合、その商品に適用される消費税率を明示する。 |
additional_ | 追加画像 商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。 |
adult_ | 年齢認証 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する |
exposure_ | 商品表示制限の範囲 A:すべての顧客に表示 |
exposure_ | 商品表示対象の会員ランク |
Delete a product
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Products additionalimages
「Products additionalimages」は商品の追加画像を照会できるサブリソースであり、「Products」の以下で使用できます。
Products additionalimages properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
additional_ | 追加画像 |
Create a products additionalimage
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
additional_ Required | 追加画像 |
Update a products additionalimage
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
additional_ Required | 追加画像 |
Products approve
供給会社の商品承認機能を使っているショップでしか使えないAPIです。
Products approve properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
status Required | ステータス 供給会社が承認要求した商品の承認ステータス N:承認申込(新規商品)ステータス値 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
Get products approve status
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
Create a products approve
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
user_ Required | 供給会社の運営者ID 承認を要求した供給会社のID |
Update a products approve
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
user_ Required | 供給会社の運営者ID 承認を要求した供給会社のID |
status Required | ステータス 供給会社が承認要求した商品の承認ステータス C:承認完了ステータス値 |
Products decorationimages
「Decorationimages」は、ショップに表示中の商品画像の上に追加して商品をより目立たせる機能です。ショップに登録されているデコ画像を照会して商品ごとにデコ画像を指定したり、商品に登録されているデコ画像を照会することができます。
デコ画像はサブリソースであるため、「Products」の以下で使用可能です。
Products decorationimages properties
Attribute | Description |
---|---|
code | デコ画像コード |
path | デコ画像URL |
shop_ | ショップ番号 |
use_ | 表示期間の使用の有無 T:使用する |
show_ timezone | 表示期間の開始日 |
show_ timezone | 表示期間の終了日 |
image_ | デコ画像一覧 |
List all decoration images
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
List all products decoration images
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Select decoration images to a product
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
use_ | 表示期間の使用の有無 T:使用する |
show_ Date | 表示期間の開始日 |
show_ Date | 表示期間の終了日 |
image_ Required | デコ画像一覧 |
code path image_horizontal_position image_vertical_position |
Update a decoration images to a product
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
use_ | 表示期間の使用の有無 T:使用する |
show_ Date | 表示期間の開始日 |
show_ Date | 表示期間の終了日 |
image_ Required | デコ画像一覧 |
code path image_horizontal_position image_vertical_position |
Deselect a decoration images to a product
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
code Required | デコ画像コード |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Products discountprice
「Discountprice」は、商品の割引価格を表示するリソースです。 「Benefits」が適用された商品の場合、商品の割引価格を照会することができます。
商品の割引価格はサブリソースであるため、「Products」の以下で使用可能です。 商品リストを照会する際に、Embedパラメータで呼び出して商品の割引価格を同時に照会することができます。
Products discountprice properties
Attribute | Description |
---|---|
pc_ | PC割引価格 |
mobile_ | モバイル割引価格 |
List all products discountprice
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
Products hits
商品照会数(Hits)は商品をショップの顧客がどれほど照会したかを示す指標です。商品照会数を確認することで顧客がどんな商品を一番たくさん照会したかがわかります。
商品照会数は下位Resourceで、商品(Products)の下位でしか使えません。
Count all products hits
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
Products icons
商品アイコンは商品をアピールするために商品の横に追加する小さい画像です。表示されている商品に割引情報、「在庫わずか」などのメッセージを追加して商品をアピールすることができます。
商品アイコンは下位Resourceで、商品(Products)の下位でしか使えません。
Products icons properties
Attribute | Description |
---|---|
code | 商品アイコンコード |
path | アイコンURL |
shop_ | ショップ番号 |
use_ | 表示期間の使用の有無 T:使用する |
show_ timezone | 表示期間の開始日 |
show_ timezone | 表示期間の終了日 |
image_ | 商品アイコン一覧 |
List all icons
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
List all products icons
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Select product icons to a product
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
image_ Required Array Max : [5] | 商品アイコン一覧 |
code |
Update a product icons to a product
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
use_ | 表示期間の使用の有無 T:使用する |
show_ Date | 表示期間の開始日 |
show_ Date | 表示期間の終了日 |
image_ Array Max : [5] | 商品アイコン一覧 |
code |
Deselect a product icons to a product
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
code Required | 商品アイコンコード |
Products images
商品画像(Products Images)は商品を販売するためにアップロードした商品の写真や絵を意味します。商品画像APIを使って商品詳細説明に使う画像や商品の画像をアップロードすることができます。
商品の画像はBase64コードでエンコードしてアップロードできます。
Products images properties
Attribute | Description |
---|---|
path | 詳細画像 |
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
product_ | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
detail_ | 詳細画像 商品詳細画面に表示される商品画像 |
list_ | 一覧画像 商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像 |
tiny_ | 縮小一覧画像 商品詳細画面の下部に表示される商品の一覧画像 |
small_ | 縮小画像 最近チェックした商品領域に表示される商品の一覧画像 |
Upload Images
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 20 |
要求スペック
Parameter | Description |
---|---|
image Required | 詳細画像 |
Upload product images
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
detail_ | 詳細画像 商品詳細画面に表示される商品画像 |
list_ | 一覧画像 商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像 |
tiny_ | 縮小一覧画像 商品詳細画面の下部に表示される商品の一覧画像 |
small_ | 縮小画像 最近チェックした商品領域に表示される商品の一覧画像 |
image_ Required | 画像アップロードタイプ 画像のタイプが代表画像か個別画像か、アップロードタイプを指定することができる。代表画像(A)としてアップロードする場合、詳細画像(detail_image)に画像をアップロードすると残りの画像にもすべて反映される。 A:メイン画像登録 |
Delete a products image
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
Products memos
商品メモは商品に添付する簡単なメモで、商品に関する特異事項を書いたり運営者同士のコミュニケーションツールとして活用することができます。
商品メモは下位Resourceで、商品(Products)の下位でしか使えません。
Products memos properties
Attribute | Description |
---|---|
memo_ | メモ番号 システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。 |
author_ Max Length : [20] | 作成者ID メモを作成した管理者のID情報 |
created_ timezone | 作成日 メモを作成した時間 |
memo | メモ メモの内容。HTMLを使って登録できる。 |
List all products memos
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Get a products memo
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
memo_ Required | メモ番号 システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。 |
Create a products memo
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
author_ Required Max Length : [20] | 作成者ID メモを作成した管理者のID情報 |
memo Required | メモ メモの内容。HTMLを使って登録できる。 |
Update a products memo
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
memo_ Required | メモ番号 システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。 |
author_ Required Max Length : [20] | 作成者ID メモを作成した管理者のID情報 |
memo Required | メモ メモの内容。HTMLを使って登録できる。 |
Delete a products memo
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
memo_ Required | メモ番号 システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。 |
Products options
「Options」は、顧客がカラー・サイズなど商品のオプションの中から好きなものを選択して購入できるようにする機能です。 オプションはカラー、サイズなどの「オプション名(option_name)」とカラーのうち赤、黄のような「オプション値(option_value)」で構成されています。 商品にオプションを登録すると、オプションに基づいて「品目(variants)」が作成されます。
オプションはサブリソースであるため、「Products」の以下で使用可能です。
Products options properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
has_ | オプション使用の設定 T:使用する |
option_ | オプション構成方式 オプションを使う場合、オプションのタイプを表示 T:組み合わせ型 |
option_ | オプション表示方式 組合型オプションを使う場合、組合型オプションのタイプを表示 C:一体型 |
option_ Type : [A-Z0-9] | バリエーションコード 商品連動型オプションを使う場合、オプションセットコード表示 |
options | オプション |
select_ | オプション別に1個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する |
option_ | 連動型バリエーション名 商品連動型オプションを使う場合、オプションセットの名前表示 |
use_ | 追加入力オプション使用の設定 T:使用する |
additional_ | 追加入力オプション |
use_ | ファイル添付オプション使用の設定 T:使用する |
attached_ | ファイル添付オプション |
List all products options
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Create a products option
POST
商品オプション登録APIを使ってオプションを登録することができます。オプション登録APIでオプションを登録すると、品目は自動生成されます。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
has_ | オプション使用の設定 T:使用する |
option_ | オプション構成方式 オプションを使う場合、オプションのタイプを入力 T:組み合わせ型 |
option_ | オプション表示方式 組合型オプションを使う場合、組合型オプションのタイプを入力 S:組み合わせ分離選択型 |
options | オプション |
option_name option_value Array option_text option_image_file option_color option_display_type | |
select_ | オプション別に1個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する |
option_ Type : [A-Z0-9] | バリエーションコード |
option_ | 連動型バリエーション名 商品連動型オプションを使う場合、オプションセットの名前を入力 |
use_ | 追加入力オプション使用の設定 T:使用する |
additional_ | 追加入力オプション |
additional_option_name additional_option_text_length required_additional_option | |
use_ | ファイル添付オプション使用の設定 T:使用する |
attached_ | ファイル添付オプション |
Update a products option
PUT
商品オプション修正APIはオプションを修正しながら品目を初期化しません。オプション名とオプション値、追加入力オプションとファイル添付オプションの修正のみ可能で、オプション項目の追加や削除はできません。
オプションを追加または削除したい場合は、オプション削除APIで削除した後、再度登録しなければなりません。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
option_ | オプション表示方式 組合型オプションを使う場合、組合型オプションのタイプを入力 S:組み合わせ分離選択型 |
option_ Type : [A-Z0-9] | バリエーションコード 商品連動型オプションを使う場合、オプションセットコード入力 |
options | オプション |
option_name option_value Array option_text option_image_file option_link_image option_color option_display_type | |
original_ | 修正前のオプション値 |
option_name option_value Array option_text | |
select_ | オプション別に1個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する |
option_ | 連動型バリエーション名 商品連動型オプションを使う場合、オプションセットの名前を入力 |
use_ | 追加入力オプション使用の設定 T:使用する |
additional_ | 追加入力オプション |
additional_option_name additional_option_text_length required_additional_option | |
use_ | ファイル添付オプション使用の設定 T:使用する |
attached_ | ファイル添付オプション |
Delete a products option
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
Products seo
SEOは検索エンジンの最適化(Search Engine Optimization)の略語で、SEO APIは検索エンジンで商品やショップがよりよく検索できるようにします。
商品の下位Resourceで、SEO APIは商品の検索エンジンの最適化設定ができます。
Products seo properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
meta_ | ブラウザでのタイトル 商品詳細ページのTitleタグに表示される情報。Titleタグはブラウザーに表示される情報で、検索エンジンで検索時に一番基本的な情報である。 |
meta_ | メタタグ1:Author 商品詳細ページのタグに表示される情報。authorメタタグにはその商品を製造した人または登録した人を記入する。 |
meta_ | メタタグ2:Description 商品詳細ページのタグに表示される情報。descriptionタグに検索結果ページで検索結果の下に表示される簡単な情報を入力することができる。 |
meta_ | メタタグ3:Keywords 商品詳細ページのタグに表示される情報。keywordタグにその商品が検索されてほしいと思う検索キーワードを入力することができる。 |
meta_ | 商品画像のalt属性 商品画像に表示されるAltテキスト情報。Altテキストを入力しておくと検索エンジンで画像検索時に検索される可能性が高くなり、ブラウザーで画像の代わりに関連テキストを出力することができるため、ウェブのアクセス性にも有利である。 |
search_ | 検索エンジンでの表示設定 商品を検索エンジンに表示するかどうかを設定。「表示しない」に設定する場合、その商品が検索エンジンに表示されない。 T:使用する |
Get products seo
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
Update a products seo
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
meta_ | ブラウザでのタイトル 商品詳細ページのTitleタグに表示される情報。Titleタグはブラウザーに表示される情報で、検索エンジンで検索時に一番基本的な情報である。 |
meta_ | メタタグ1:Author 商品詳細ページのタグに表示される情報。authorメタタグにはその商品を製造した人または登録した人を記入する。 |
meta_ | メタタグ2:Description 商品詳細ページのタグに表示される情報。descriptionタグに検索結果ページで検索結果の下に表示される簡単な情報を入力することができる。 |
meta_ | メタタグ3:Keywords 商品詳細ページのタグに表示される情報。keywordタグにその商品が検索されてほしいと思う検索キーワードを入力することができる。 |
meta_ | 商品画像のalt属性 商品画像に表示されるAltテキスト情報。Altテキストを入力しておくと検索エンジンで画像検索時に検索される可能性が高くなり、ブラウザーで画像の代わりに関連テキストを出力することができるため、ウェブのアクセス性にも有利である。 |
search_ | 検索エンジンでの表示設定 商品を検索エンジンに表示するかどうかを設定。「表示しない」に設定する場合、その商品が検索エンジンに表示されない。 |
Products tags
「Tags」は、商品を特定のキーワードで検索したときにその検索結果に商品を表示させる機能です。 商品名や商品詳細説明に含まれていないキーワードで商品を検索結果に表示させるためには、キーワードを追加することができます。
検索キーワードはサブリソースであるため、「Products」の以下で使用可能です。
Products tags properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
tag | 商品タグ 検索または分類のために商品に入力する検索キーワード情報(ハッシュタグ) |
tags Required | 商品タグ |
product_ | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
List all products tags
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
Count all products tags
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
Create a products tag
POST
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
tag Required | 商品タグ 検索または分類のために商品に入力する検索キーワード情報(ハッシュタグ) |
tags Required | 商品タグ |
Delete a products tag
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
tag | 商品タグ 検索または分類のために商品に入力する検索キーワード情報(ハッシュタグ) |
Products variants
品目(Variants)はショップで販売される商品の基本単位です。ショップは一般的に顧客に多様な選択肢を提供するために同じ商品でもサイズや色が違う品目を販売します。
品目は下記のようなResourceを下位Resourceとして持っています。
● 在庫(Inventories)
Endpoints
Products variants properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
variant_ Type : [A-Z0-9] | 商品品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
options | オプション |
custom_ Max Length : [40] | 独自品目コード ユーザーが品目に付与可能なコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
display | 表示ステータス 品目を表示するかどうかを設定。品目を表示する場合、商品詳細または商品リストでその品目を選択することができる。品目が設定されていない場合、その品目が表示されないため、その品目を購入することができない。 T:販売する |
selling | 販売ステータス 品目を販売するかどうかを設定。表示されているが販売はしない場合、その品目は「在庫切れ」と表示され、その品目を購入することができない。品目のステータスが「販売」であっても「表示しない」になっているとその品目は購入できない。 T:表示する |
additional_ | 追加金額 品目を購入する時、商品の販売価格に加えて支払わなければならない追加価格 |
use_ | 在庫使用の設定 T:使用する |
important_ | 重要在庫の有無 A:一般在庫 |
inventory_ | 在庫数量チェックの基準 A:注文基準 |
display_ | 在庫切れ表示の設定 T:在庫切れ表示を使用する |
quantity | 数量 |
safety_ | 安全在庫数量 |
inventories | 在庫リソース 品目の在庫Resource |
duplicated_ | 独自品目コードの重複有無 T:重複する |
product_ | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
List all products variants
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
inventories embed | 在庫リソース 品目の在庫Resource ,(コンマ)で複数の件を検索することができる。 |
Get a products variant
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
variant_ Required Type : [A-Z0-9] | 品目コード |
inventories embed | 在庫リソース |
Update a products variant
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
variant_ Required Type : [A-Z0-9] | 商品品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
custom_ Max Length : [40] | 独自品目コード ユーザーが品目に付与可能なコード。在庫管理などの理由で独自に商品を管理している場合に使う。 |
display | 表示ステータス 品目を表示するかどうかを設定。品目を表示する場合、商品詳細または商品リストでその品目を選択することができる。品目が設定されていない場合、その品目が表示されないため、その品目を購入することができない。 T:表示する |
selling | 販売ステータス 品目を販売するかどうかを設定。表示されているが販売はしない場合、その品目は「在庫切れ」と表示され、その品目を購入することができない。品目のステータスが「販売」であっても「表示しない」になっているとその品目は購入できない。 T:販売する |
additional_ | 追加金額 品目を購入する時、商品の販売価格に加えて支払わなければならない追加価格 |
quantity | 数量 |
use_ | 在庫使用の設定 T:使用する |
important_ | 重要在庫の有無 A:一般在庫 |
inventory_ | 在庫数量チェックの基準 A:注文基準 |
display_ | 在庫切れ表示の設定 T:在庫切れ表示を使用する |
safety_ | 安全在庫数量 |
Update products variants(batch)
PUT
一つの商品に対する複数の品目を同時に修正できる品目修正(マルチ)APIです。
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 100 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
variant_ Required Type : [A-Z0-9] | 商品品目コード |
custom_ Max Length : [40] | 独自品目コード |
display | 表示ステータス T:表示する |
selling | 販売ステータス T:販売する |
additional_ | 追加金額 |
quantity | 数量 |
use_ | 在庫使用の設定 T:使用する |
important_ | 重要在庫の有無 A:一般在庫 |
inventory_ | 在庫数量チェックの基準 A:注文基準 |
display_ | 在庫切れ表示の設定 T:在庫切れ表示を使用する |
safety_ | 安全在庫数量 |
Delete a products variant
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
product_ Required | 商品番号 システムにより付与された商品の番号。商品番号はショップ内で重複しない。 |
variant_ Required Type : [A-Z0-9] | 商品品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
Products variants inventories
在庫(Inventories)は販売可能な品目の数量を意味します。在庫は品目(Variants)別に存在し、在庫以上の品目が販売されるとその商品は在庫切れになります。
Products variants inventories properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
variant_ Type : [A-Z0-9] | 品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
use_ | 在庫使用の設定 品目に対して在庫管理を使うかどうかを設定。在庫管理を使う場合、在庫数を入力することができる。在庫管理を使わない場合、その商品は在庫と関係なく販売可能で、在庫数、在庫数チェック基準、在庫切れ表示の設定を使うことができない。 T:使用する |
important_ | 重要在庫の有無 在庫を重要管理するかどうかを設定。ショップでは検索するための区分データとして使う。 A:一般在庫 |
inventory_ | 在庫数量チェックの基準 在庫数量をどの時点で差し引くかという基準。銀行振込のように決済時点と注文時点が異なる場合は在庫を差し引く基準をそれぞれ設定することができる。 A:注文基準 |
display_ | 在庫切れ表示の設定 在庫がすべて販売された場合、その品目を在庫切れと表示するかどうかの設定。在庫切れと表示されると注文ができない。すべての品目が在庫切れになる場合はその商品に在庫切れアイコンが表示される。 T:在庫切れ表示を使用する |
quantity | 数量 販売可能な在庫数。在庫数は注文または決済時に差し引かれ、在庫切れの表示のためにチェックされる。 |
safety_ | 安全在庫数量 |
Get products variants inventory
GET
基本スペック
Property | Description |
---|---|
SCOPE | 商品の閲覧権限 (mall.read_product) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
variant_ Required Type : [A-Z0-9] | 品目コード 販売数量を検索する品目コード |
Update a products variants inventory
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 商品の投稿権限 (mall.write_product) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
product_ Required | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
variant_ Required Type : [A-Z0-9] | 品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
use_ | 在庫使用の設定 品目に対して在庫管理を使うかどうかを設定。在庫管理を使う場合、在庫数を入力することができる。在庫管理を使わない場合、その商品は在庫と関係なく販売可能で、在庫数、在庫数チェック基準、在庫切れ表示の設定を使うことができない。 T:使用する |
important_ | 重要在庫の有無 在庫を重要管理するかどうかを設定。ショップでは検索するための区分データとして使う。 A:一般在庫 |
inventory_ | 在庫数量チェックの基準 在庫数量をどの時点で差し引くかという基準。銀行振込のように決済時点と注文時点が異なる場合は在庫を差し引く基準をそれぞれ設定することができる。 A:注文基準 |
display_ | 在庫切れ表示の設定 在庫がすべて販売された場合、その品目を在庫切れと表示するかどうかの設定。在庫切れと表示されると注文ができない。すべての品目が在庫切れになる場合はその商品に在庫切れアイコンが表示される。 T:在庫切れ表示を使用する |
quantity | 数量 販売可能な在庫数。在庫数は注文または決済時に差し引かれ、在庫切れの表示のためにチェックされる。 |
safety_ | 安全在庫数量 |
Collection
Brands
ブランド(Brands)は商品の「製作情報」の中でブランドに入力する情報を意味します。ブランドはショップの商品を区分する販売カテゴリの一つで、商品は必ず一つのブランドを持っています(指定しない場合は「独自ブランド」を使う)。
Brands properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
brand_ | ブランドコード |
brand_ Max Length : [50] | ブランド名 |
use_ | ブランドの使用有無 T:使用する |
search_ Max Length : [200] | 検索キーワード設定 |
product_ | 商品数 |
created_ timezone | 作成日 |
List all brands
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
brand_ | ブランドコード ,(コンマ)で複数の件を検索することができる。 |
brand_ | ブランド名 ,(コンマ)で複数の件を検索することができる。 |
use_ | ブランドの使用有無 T:使用する |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Count all brands
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
brand_ | ブランドコード ,(コンマ)で複数の件を検索することができる。 |
brand_ | ブランド名 ,(コンマ)で複数の件を検索することができる。 |
use_ | ブランドの使用有無 T:使用する |
Create a brand
POST
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの投稿権限 (mall.write_collection) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
brand_ Required | ブランド名 |
use_ | ブランドの使用有無 T:使用する DEFAULT T |
search_ Max Length : [200] | 検索キーワード設定 |
Update a brand
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの投稿権限 (mall.write_collection) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
brand_ Required Type : [A-Z0-9] | ブランドコード |
brand_ | ブランド名 |
use_ | ブランドの使用有無 T:使用する DEFAULT T |
search_ Max Length : [200] | 検索キーワード設定 |
Delete a brand
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの投稿権限 (mall.write_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
brand_ Required Type : [A-Z0-9] | ブランドコード |
Classifications
独自カテゴリ(Classifications)は商品の「製作情報」の中で独自カテゴリに入力する情報を意味します。商品を区分する販売カテゴリの一つで、商品は必ず一つの独自カテゴリを持っています(指定しない場合は「基本の独自カテゴリ」を使う)。
Classifications properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
classification_ Type : [A-Z0-9] | 独自カテゴリコード |
classification_ Max Length : [200] | 独自カテゴリ名 |
classification_ Max Length : [300] | 独自カテゴリの説明 |
use_ | 使用設定 |
created_ timezone | 作成日 |
product_ | 商品数 |
List all classifications
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
classification_ | 独自カテゴリコード ,(コンマ)で複数の件を検索することができる。 |
classification_ | 独自カテゴリ名 ,(コンマ)で複数の件を検索することができる。 |
use_ | 使用設定 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Count all classifications
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
classification_ | 独自カテゴリコード ,(コンマ)で複数の件を検索することができる。 |
classification_ | 独自カテゴリ名 ,(コンマ)で複数の件を検索することができる。 |
use_ | 使用設定 |
Manufacturers
メーカー(Manufacturers)は商品の「製作情報」の中でメーカーに入力する情報を意味します。メーカーは商品を製作、生産する主体を示し、商品を区分する販売カテゴリの一つです。商品は必ず一つのメーカーを持っています(指定しない場合は「独自メーカー」を使う)。
Manufacturers properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
manufacturer_ Type : [A-Z0-9] | メーカーコード システムにより付与されたメーカーのコード。ショップ内でメーカーコードは重複しない。 |
manufacturer_ Max Length : [50] | メーカー名 メーカーの名前。メーカー名はショップ管理者画面でメーカーを区分する基本的な情報である。 |
president_ Max Length : [30] | 代表者名 メーカーの代表者の名前 |
use_ | 使用設定 そのメーカーを使うかどうかを表示 T:使用する |
email Max Length : [255] | メールアドレス メーカーのお問い合わせメールアドレス 詳細検索時のみ確認可能である。 |
phone Max Length : [20] | 電話番号 メーカーの電話番号 詳細検索時のみ確認可能である。 |
homepage Max Length : [255] | ホームページ メーカーのホームページアドレス 詳細検索時のみ確認可能である。 |
zipcode | 郵便番号 メーカーの事業所の郵便番号 詳細検索時のみ確認可能である。 |
address1 Max Length : [255] | 基本住所 メーカーの住所(市区町村単位で表記) 詳細検索時のみ確認可能である。 |
address2 Max Length : [255] | 詳細住所 メーカーの住所(詳細住所表記) 詳細検索時のみ確認可能である。 |
created_ timezone | 作成日 詳細検索時のみ確認可能である。 |
List all manufacturers
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
manufacturer_ | メーカーコード 検索したいメーカーのコード ,(コンマ)で複数の件を検索することができる。 |
manufacturer_ | メーカー名 ,(コンマ)で複数の件を検索することができる。 |
use_ | メーカー使用の設定 T:使用する |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 検索結果の開始位置 |
Count all manufacturers
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
manufacturer_ | メーカーコード 検索したいメーカーのコード ,(コンマ)で複数の件を検索することができる。 |
manufacturer_ | メーカー名 検索キーワードがメーカー名に含まれている供給会社検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。 |
use_ | メーカー使用の設定 T:使用する |
Get a manufacturer
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
manufacturer_ Required Type : [A-Z0-9] | メーカーコード |
Create a manufacturer
POST
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの投稿権限 (mall.write_collection) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
manufacturer_ Required | メーカー名 |
president_ Required Max Length : [30] | 代表者名 |
email Max Length : [255] | メールアドレス |
phone Max Length : [20] | 電話番号 |
homepage Max Length : [255] | ホームページ |
zipcode | 郵便番号 |
address1 Max Length : [255] | 基本住所 |
address2 Max Length : [255] | 詳細住所 |
use_ | 使用設定 T:使用する |
Update a manufacturer
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの投稿権限 (mall.write_collection) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
manufacturer_ Required Type : [A-Z0-9] | メーカーコード |
manufacturer_ | メーカー名 |
president_ | 代表者名 |
email Max Length : [255] | メールアドレス |
phone Max Length : [20] | 電話番号 |
homepage Max Length : [255] | ホームページ |
zipcode | 郵便番号 |
address1 Max Length : [255] | 基本住所 |
address2 Max Length : [255] | 詳細住所 |
use_ | 使用設定 T:使用する |
Origin
原産国(Origin)は商品が生産された地域を意味します。原産国は国外配送などに重要なデータです。カフェ24は多数の原産国をコード化しているため、原産国検索APIで原産国コード情報を確認することができます。
Endpoints
Origin properties
Attribute | Description |
---|---|
origin_ | 原産国番号 |
origin_ | 原産国名 |
foreign | 海外 |
made_ | 国名(原産国)コード |
List all origin
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
origin_ | 原産国番号 |
origin_ Max Length : [50] | 原産国名 |
foreign | 海外 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Trends
トレンド(Trends)は商品の「製作情報」の中でトレンドに入力する情報を意味します。トレンドは商品を区分する販売カテゴリの一つで、商品は必ず一つのトレンドを持っています(指定しない場合は「基本トレンド」を使う)。
Trends properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
trend_ Type : [A-Z0-9] | トレンドコード |
trend_ Max Length : [50] | トレンド名 |
use_ | トレンド使用の設定 T:使用する |
created_ timezone | 作成日 |
product_ | 商品数 |
List all trends
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
trend_ | トレンドコード ,(コンマ)で複数の件を検索することができる。 |
trend_ | トレンド名 ,(コンマ)で複数の件を検索することができる。 |
use_ | トレンド使用の設定 T:使用する |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Count all trends
GET
基本スペック
Property | Description |
---|---|
SCOPE | 販売カテゴリの閲覧権限 (mall.read_collection) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
trend_ | トレンドコード ,(コンマ)で複数の件を検索することができる。 |
trend_ | トレンド名 ,(コンマ)で複数の件を検索することができる。 |
use_ | トレンド使用の設定 T:使用する |
Supply
Suppliers
供給会社(Suppliers)は商品の「製作情報」の中で供給会社に入力する情報を意味します。供給会社はショップに商品を供給して販売できるようにする会社または個人を意味します。供給会社は商品を区分する販売カテゴリの一つで、商品は必ず一つの供給会社を持っています(指定しない場合は「独自供給」を使う)。
Suppliers properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
supplier_ | 供給会社のコード システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 |
supplier_ Max Length : [100] | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 |
status | ステータス 供給会社との取引現況情報 A:取引中 |
commission | 手数料 精算タイプが手数料型(P)の場合に使う手数料情報 |
payment_ | 精算周期 供給会社に対する精算周期を設定することができる。 0:選択しない |
business_ Max Length : [255] | 取引商品タイプ 供給会社と取り引きする商品のタイプ情報 |
payment_ | 精算タイプ 供給会社に払う金額をどのようなタイプで精算するかを設定することができる。 P:手数料型 |
supplier_ | 供給会社のタイプ 供給会社の営業形態 WS:卸売業者 |
use_ | 使用設定 その供給会社を使うかどうかを表示 T:使用する |
created_ timezone | 登録日 供給会社の情報が登録された日付 |
updated_ timezone | 修正日 供給会社情報が変更された日付 |
country_ | 事業所住所の国コード KOR : 韓国 |
zipcode Max Length : [10] | 郵便番号 供給会社の住所の郵便番号 |
address1 Max Length : [255] | 基本住所 供給会社の住所(市区町村単位で表記) |
address2 Max Length : [255] | 詳細住所 供給会社の住所(詳細住所表記) |
manager_ | 担当者 供給会社の担当者の連絡先情報 |
trading_ | 供給会社の仕入れ方法 商品が供給会社から配送される形態 詳細検索時のみ確認可能である。 D:仕入れ |
payment_ | 精算時期 精算基準時期 詳細検索時のみ確認可能である。 10 : 決済完了 |
payment_ Min : [0]~Max : [6] | 精算開始曜日 精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 詳細検索時のみ確認可能である。 0 : 日曜日 |
payment_ Min : [0]~Max : [6] | 精算終了曜日 精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 詳細検索時のみ確認可能である。 0 : 日曜日 |
payment_ Min : [1]~Max : [31] | 精算開始日 精算周期が月間精算(A)である場合、該当日付を精算開始日とする。 詳細検索時のみ確認可能である。 |
payment_ Min : [1]~Max : [31] | 精算終了日 精算周期が月間精算(A)である場合、該当日付を精算終了日とする。 詳細検索時のみ確認可能である。 |
bank_ Max Length : [50] | 銀行コード 供給会社精算時に使う口座の入金銀行コード 詳細検索時のみ確認可能である。 |
bank_ | 口座番号 供給会社精算時に使う口座の番号 詳細検索時のみ確認可能である。 |
bank_ | 口座名義 供給会社精算時に使う口座の名義 詳細検索時のみ確認可能である。 |
phone Max Length : [20] | 電話番号 供給会社の事業所の電話番号 詳細検索時のみ確認可能である。 |
fax Max Length : [20] | ファックス番号 供給会社のファックス番号 詳細検索時のみ確認可能である。 |
market_ | 市場の住所の国コード 詳細検索時のみ確認可能である。 KOR : 韓国 |
market_ Max Length : [10] | 市場の郵便番号 詳細検索時のみ確認可能である。 |
market_ | 市場の住所(基本) 詳細検索時のみ確認可能である。 |
market_ | 市場の住所(詳細) 詳細検索時のみ確認可能である。 |
exchange_ | 事業所住所の国コード 詳細検索時のみ確認可能である。 KOR : 韓国 |
exchange_ Max Length : [10] | 返品先の郵便番号 詳細検索時のみ確認可能である。 |
exchange_ Max Length : [255] | 返品先の住所(基本) 詳細検索時のみ確認可能である。 |
exchange_ Max Length : [255] | 返品先の住所(詳細) 詳細検索時のみ確認可能である。 |
homepage_ Max Length : [100] | ホームページアドレス 詳細検索時のみ確認可能である。 |
mall_ Max Length : [100] | ショップのアドレス 詳細検索時のみ確認可能である。 |
account_ Max Length : [10] | 取引開始日 詳細検索時のみ確認可能である。 |
account_ Max Length : [10] | 取引中止日 詳細検索時のみ確認可能である。 |
show_ Max Length : [100] | 供給会社情報の表示 詳細検索時のみ確認可能である。 SP:電話番号 |
memo Max Length : [255] | メモ 供給会社に対する管理用メモ 詳細検索時のみ確認可能である。 |
company_ Max Length : [12] | 事業者登録番号 供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。 詳細検索時のみ確認可能である。 |
company_ | 商号 事業者登録時に供給会社が登録した商号 詳細検索時のみ確認可能である。 |
president_ | 代表者名 事業者登録時に供給会社が登録した代表者名 詳細検索時のみ確認可能である。 |
company_ | 業態 事業者登録時に供給会社が登録した業態 詳細検索時のみ確認可能である。 |
company_ | 種目 事業者登録時に供給会社が登録した業種 詳細検索時のみ確認可能である。 |
company_ | 会社紹介 供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。 詳細検索時のみ確認可能である。 |
List all suppliers
GET
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の閲覧権限 (mall.read_supply) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
supplier_ | 供給会社のコード システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 ,(コンマ)で複数の件を検索することができる。 |
supplier_ | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 ,(コンマ)で複数の件を検索することができる。 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Count all suppliers
GET
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の閲覧権限 (mall.read_supply) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
supplier_ | 供給会社のコード システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 ,(コンマ)で複数の件を検索することができる。 |
supplier_ | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 ,(コンマ)で複数の件を検索することができる。 |
Get a supplier
GET
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の閲覧権限 (mall.read_supply) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
supplier_ Required | 供給会社のコード システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 |
Create a supplier
POST
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の投稿権限 (mall.write_supply) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
supplier_ Required Max Length : [50] | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 |
manager_ Array Max : [3] | 担当者 |
no name phone email | |
use_ | 使用設定 その供給会社を使うかどうかを表示 T:使用する DEFAULT T |
trading_ | 供給会社の仕入れ方法 商品が供給会社から配送される形態 D:仕入れ DEFAULT D |
supplier_ | 供給会社のタイプ 供給会社の営業形態 WS:卸売業者 DEFAULT WS |
status | ステータス 供給会社との取引現況情報 A:取引中 DEFAULT A |
business_ Max Length : [255] | 取引商品タイプ 供給会社と取り引きする商品のタイプ情報 |
payment_ | 精算タイプ 供給会社に払う金額をどのようなタイプで精算するかを設定することができる。 P:手数料型 DEFAULT P |
payment_ | 精算周期 供給会社に対する精算周期を設定することができる。 0:選択しない |
payment_ | 精算時期 精算基準時期 10 : 決済完了 |
payment_ Min : [0]~Max : [6] | 精算開始曜日 精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 日曜日 |
payment_ Min : [0]~Max : [6] | 精算終了曜日 精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 日曜日 |
payment_ Min : [1]~Max : [31] | 精算開始日 精算周期が月間精算(A)である場合、該当日付を精算開始日とする。 |
payment_ Min : [1]~Max : [31] | 精算終了日 精算周期が月間精算(A)である場合、該当日付を精算終了日とする。 |
commission | 手数料率 精算タイプが手数料型(P)の場合に使う手数料情報 DEFAULT 10 |
phone Max Length : [20] | 電話番号 供給会社の事業所の電話番号 |
fax Max Length : [20] | ファックス番号 供給会社のファックス番号 |
country_ | 事業所住所の国コード KOR : 韓国 |
zipcode Max Length : [10] | 郵便番号 供給会社の住所の郵便番号 |
address1 Max Length : [255] | 基本住所 供給会社の住所(市区町村単位で表記) |
address2 Max Length : [255] | 詳細住所 供給会社の住所(詳細住所表記) |
market_ | 市場の住所の国コード KOR : 韓国 |
market_ Max Length : [10] | 市場の郵便番号 |
market_ | 市場の住所(基本) |
market_ | 市場の住所(詳細) |
exchange_ | 事業所住所の国コード KOR : 韓国 |
exchange_ Max Length : [10] | 返品先の郵便番号 |
exchange_ Max Length : [255] | 返品先の住所(基本) |
exchange_ Max Length : [255] | 返品先の住所(詳細) |
homepage_ Max Length : [100] | ホームページアドレス |
mall_ Max Length : [100] | ショップのアドレス |
account_ Max Length : [10] | 取引開始日 |
account_ Max Length : [10] | 取引中止日 |
memo Max Length : [255] | メモ 供給会社に対する管理用メモ |
company_ Max Length : [12] | 事業者登録番号 供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。 |
company_ Max Length : [30] | 商号 事業者登録時に供給会社が登録した商号 |
president_ Max Length : [20] | 代表者名 事業者登録時に供給会社が登録した代表者名 |
company_ Max Length : [20] | 業態 事業者登録時に供給会社が登録した業態 |
company_ Max Length : [20] | 種目 事業者登録時に供給会社が登録した業種 |
company_ | 会社紹介 供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。 |
Update a supplier
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の投稿権限 (mall.write_supply) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
supplier_ Required Type : [A-Z0-9] | 供給会社のコード システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 |
supplier_ Max Length : [50] | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 |
use_ | 使用設定 その供給会社を使うかどうかを表示 T:使用する |
trading_ | 供給会社の仕入れ方法 商品が供給会社から配送される形態 D:仕入れ |
supplier_ | 供給会社のタイプ 供給会社の営業形態 WS:卸売業者 |
status | ステータス 供給会社との取引現況情報 A:取引中 |
payment_ | 精算タイプ 供給会社に払う金額をどのようなタイプで精算するかを設定することができる。 P:手数料型 |
payment_ | 精算周期 供給会社に対する精算周期を設定することができる。 0:選択しない |
commission | 手数料率 精算タイプが手数料型(P)の場合に使う手数料情報 |
manager_ Array Max : [3] | 担当者 |
no name phone email use_sms | |
business_ Max Length : [255] | 取引商品タイプ 供給会社と取り引きする商品のタイプ情報 |
payment_ | 精算時期 精算基準時期 10 : 決済完了 |
payment_ Min : [0]~Max : [6] | 精算開始曜日 精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 日曜日 |
payment_ Min : [0]~Max : [6] | 精算終了曜日 精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 日曜日 |
payment_ Min : [1]~Max : [31] | 精算開始日 精算周期が月間精算(A)である場合、該当日付を精算開始日とする。 |
payment_ Min : [1]~Max : [31] | 精算終了日 精算周期が月間精算(A)である場合、該当日付を精算終了日とする。 |
phone Max Length : [20] | 電話番号 供給会社の事業所の電話番号 |
fax Max Length : [20] | ファックス番号 供給会社のファックス番号 |
country_ | 事業所住所の国コード KOR : 韓国 |
zipcode Max Length : [10] | 郵便番号 供給会社の住所の郵便番号 |
address1 Max Length : [255] | 基本住所 供給会社の住所(市区町村単位で表記) |
address2 Max Length : [255] | 詳細住所 供給会社の住所(詳細住所表記) |
market_ | 市場の住所の国コード KOR : 韓国 |
market_ Max Length : [10] | 市場の郵便番号 |
market_ | 市場の住所(基本) |
market_ | 市場の住所(詳細) |
exchange_ | 事業所住所の国コード KOR : 韓国 |
exchange_ Max Length : [10] | 返品先の郵便番号 |
exchange_ Max Length : [255] | 返品先の住所(基本) |
exchange_ Max Length : [255] | 返品先の住所(詳細) |
homepage_ Max Length : [100] | ホームページアドレス |
mall_ Max Length : [100] | ショップのアドレス |
account_ Max Length : [10] | 取引開始日 |
account_ Max Length : [10] | 取引中止日 |
memo Max Length : [255] | メモ 供給会社に対する管理用メモ |
company_ Max Length : [12] | 事業者登録番号 供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。 |
company_ Max Length : [30] | 商号 事業者登録時に供給会社が登録した商号 |
president_ Max Length : [20] | 代表者名 事業者登録時に供給会社が登録した代表者名 |
company_ Max Length : [20] | 業態 事業者登録時に供給会社が登録した業態 |
company_ Max Length : [20] | 種目 事業者登録時に供給会社が登録した業種 |
company_ | 会社紹介 供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。 |
Delete a supplier
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の投稿権限 (mall.write_supply) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
supplier_ Required Type : [A-Z0-9] | 供給会社のコード |
Suppliers users
供給会社の運営者(Supplier Users)は供給会社がショップにログインして商品を直接登録する場合に使います。供給会社の運営者に商品のアップロード、カテゴリ管理、掲示板管理など制限的な権限を付与することができます。
Suppliers users properties
Attribute | Description |
---|---|
user_ Type : [a-zA-Z0-9] | 供給会社の運営者ID 供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。 |
supplier_ Max Length : [8] | 供給会社のコード システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 |
supplier_ Max Length : [100] | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 |
permission_ | 商品登録時のカテゴリ選択権限 供給会社の運営者が商品登録時に商品カテゴリを選択して登録できる権限を設定 T:許容する |
permission_ | 商品修正の権限 供給会社の運営者が商品を登録した後、商品情報を修正できる権限を設定 T:許容する |
permission_ | 商品表示の権限 供給会社の運営者が商品を登録した後、ショップの画面に表示できる権限を設定 T:許容する |
permission_ | 商品販売の権限 供給会社の運営者が商品を登録した後、その商品の販売有無を設定できる権限を設定 T:許容する |
permission_ | 登録商品の削除権限 供給会社の運営者が自分で登録した商品を削除できる権限を設定 T:許容する |
permission_ | 掲示板の権限設定 供給会社の運営者がショップの掲示板にアクセスできる権限を設定 T:許容する |
user_ | 供給会社の運営者 供給会社の運営者の名前。供給会社の運営者名は供給会社の運営者がショップ管理者画面で作業をする場合、「作業を実行した人(処理者)」の部分に表示される名前を意味する。 詳細検索時のみ確認可能である。 |
nick_ Length Min : [4]~Max : [20] | 運営者ニックネーム 供給会社の運営者のニックネーム。供給会社の運営者のニックネームは供給会社の運営者が掲示板に投稿する際に「投稿者」に表示されるニックネームを意味する(ただ、その掲示板が作成者名の代わりに「ニックネーム」を表示するように設定されている場合に限る)。 詳細検索時のみ確認可能である。 |
nick_ | ニックネームアイコンのタイプ 供給会社の運営者のニックネームの横に表示されるアイコンを設定することができる。 詳細検索時のみ確認可能である。 D:直接 |
nick_ Max Length : [255] | ニックネームアイコンのURL 供給会社の運営者のニックネームアイコンの画像経路 詳細検索時のみ確認可能である。 |
use_ | 掲示板へのニックネームアイコン表示設定 供給会社の運営者が掲示板に投稿する際、ニックネームアイコンを表示するかどうかを設定 詳細検索時のみ確認可能である。 T:表示 |
use_ | 掲示板への作成者表示設定 供給会社の運営者が掲示板に投稿する際、作成者名を表示するかどうかを設定 詳細検索時のみ確認可能である。 T:表示 |
メールアドレス 供給会社の運営者のメールアドレス。供給会社の運営者の連絡先を保存する目的で使う。 詳細検索時のみ確認可能である。 | |
phone | 電話番号 供給会社の運営者の電話番号。供給会社の運営者の連絡先を保存する目的で使う。 詳細検索時のみ確認可能である。 |
permission_ | アクセス可能ショップ マルチショップを区分するために使うショップ番号 詳細検索時のみ確認可能である。 |
permitted_ | 商品登録時に許容される商品カテゴリ 供給会社の運営者が商品登録時に選択可能な商品カテゴリ。供給会社の運営者は商品登録時にその商品カテゴリにしか商品をアップロードすることができない。 詳細検索時のみ確認可能である。 |
List all suppliers users
GET
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の閲覧権限 (mall.read_supply) |
呼び出し件数制限 | 10 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
user_ Type : [a-zA-Z0-9] | 供給会社の運営者ID 供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。 |
supplier_ Max Length : [8] | 供給会社のコード システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 |
supplier_ Max Length : [100] | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 |
Count all suppliers users
GET
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の閲覧権限 (mall.read_supply) |
呼び出し件数制限 | 10 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
user_ Type : [a-zA-Z0-9] | 供給会社の運営者ID 供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。 |
supplier_ Max Length : [8] | 供給会社のコード システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 |
supplier_ Max Length : [100] | 供給会社名 供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 |
Get a suppliers user
GET
基本スペック
Property | Description |
---|---|
SCOPE | 供給会社の情報の閲覧権限 (mall.read_supply) |
呼び出し件数制限 | 10 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
user_ Type : [a-zA-Z0-9] | 供給会社の運営者ID 供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。 |
Personal
Carts
Endpoints
Carts properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
basket_ | カート内の商品番号 |
member_ | 会員ID |
created_ timezone | 追加日 |
product_ | 商品番号 |
additional_ | 追加入力オプション |
variant_ Type : [A-Z0-9] | 商品品目コード |
quantity | 数量 |
product_ | 商品販売価格 |
option_ | オプション追加価格 |
product_ | セット商品の有無 T:セット商品 |
shipping_ | 配送タイプ A:国内 |
category_ | カテゴリ番号 |
List all carts
GET
基本スペック
Property | Description |
---|---|
SCOPE | 個人化情報の閲覧権限 (mall.read_personal) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
member_ Required | 会員ID ,(コンマ)で複数の件を検索することができる。 |
offset Max : [10000] | 検索結果の開始位置 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 DEFAULT 10 |
Customers wishlist
「Customers wishlist」は会員のお気に入りを照会できるリレーショナルリソースです。
Customers wishlist properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
wishlist_ | お気に入り番号 |
product_ | 商品番号 |
variant_ Type : [A-Z0-9] | 品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
additional_ | 追加入力オプション |
attached_ | ファイル添付オプション |
price | 商品販売価格 商品の販売価格。クーポン及び特典を適用する前の価格 |
product_ | セット商品の有無 |
created_ timezone | 追加日 商品をお気に入りに追加した日付 |
price_ Max Length : [20] | 販売価格の代替メッセージ |
List all customers wishlist
GET
会員のお気に入り商品リストを照会
基本スペック
Property | Description |
---|---|
SCOPE | 個人化情報の閲覧権限 (mall.read_personal) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
member_ Required | 会員ID |
shop_ | ショップ番号 DEFAULT 1 |
Count all customers wishlist
GET
会員のお気に入り商品数を照会
基本スペック
Property | Description |
---|---|
SCOPE | 個人化情報の閲覧権限 (mall.read_personal) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
member_ Required | 会員ID |
shop_ | ショップ番号 DEFAULT 1 |
Products carts
Products carts properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
member_ | 会員ID |
created_ timezone | 追加日 |
product_ | 商品番号 |
variant_ | 商品品目コード |
quantity | 数量 |
product_ | セット商品の有無 T:セット商品 |
List all products carts
GET
基本スペック
Property | Description |
---|---|
SCOPE | 個人化情報の閲覧権限 (mall.read_personal) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
limit Min : [1]~Max : [100] | 検索結果の最大件数 DEFAULT 10 |
offset Max : [10000] | 検索結果の開始位置 |
Count all products carts
GET
基本スペック
Property | Description |
---|---|
SCOPE | 個人化情報の閲覧権限 (mall.read_personal) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
product_ Required | 商品番号 |
Order
Cancellation
Cancellation properties
Attribute | Description |
---|---|
shop_ Min : [1] | ショップ番号 |
order_ | 注文番号 |
claim_ | キャンセル番号 |
claim_ | 区分 詳細検索時のみ確認可能である。 A : お客様都合 |
claim_ | 理由 詳細検索時のみ確認可能である。 |
refund_ | 返金方式 詳細検索時のみ確認可能である。 |
refund_ | 備考 詳細検索時のみ確認可能である。 |
order_ | 商品購入金額 詳細検索時のみ確認可能である。 |
refund_ | 返金額 詳細検索時のみ確認可能である。 |
shipping_ | 送料 詳細検索時のみ確認可能である。 |
return_ | 返品送料の適用区分 詳細検索時のみ確認可能である。 |
defer_ | 後払い手数料 詳細検索時のみ確認可能である。 |
partner_ | 提携割引のキャンセル金額 詳細検索時のみ確認可能である。 |
add_ | 商品別追加割引の 詳細検索時のみ確認可能である。 |
member_ | 会員ランク割引の 詳細検索時のみ確認可能である。 |
shipping_ | 送料割引のキャンセル金額 詳細検索時のみ確認可能である。 |
coupon_ | クーポン割引の 詳細検索時のみ確認可能である。 |
point_ | 使用済みポイントの返還額 詳細検索時のみ確認可能である。 |
credit_ | 使用済み預り金の返還額 詳細検索時のみ確認可能である。 |
items | 品目別注文コード |
status | 注文ステータス canceled:キャンセル完了 |
Get a cancellation
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
claim_ Required | キャンセル番号 |
Create cancellation
POST
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 100 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
status Required | 注文ステータス canceled:キャンセル完了 |
recover_ | 在庫の回復 T : 復元する DEFAULT F |
recover_ | クーポン復元 T : 復元する DEFAULT F |
add_ | 運営者メモに追加する T:使用する DEFAULT F |
reason Max Length : [2000] | キャンセル理由 |
claim_ | キャンセル理由の区分 A : お客様都合 |
naverpay_ | Naver Payで注文した件のキャンセル理由の区分 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 51 : 心変わり |
refund_ | 返金方式 T : 現金 |
combined_ | 複合 返金 方式 T : 現金 |
refund_ | 返金先の銀行コード |
refund_ Max Length : [250] | 返金先の銀行名 |
refund_ Max Length : [50] | 返金の口座番号 |
refund_ Max Length : [15] | 返金先の口座名義 |
items | 品目別注文コード |
order_item_code quantity |
Cashreceipt
Cashreceipt properties
Attribute | Description |
---|---|
cashreceipt_ | 現金領収証番号 |
approval_ | 承認番号 |
request_ | 申込日 |
order_ | 注文番号 |
member_ | 会員ID |
name | 要請者名 |
order_ | 商品購入金額 |
vat | 消費税 |
subtotal | 申込み金額合計 |
order_ | 注文ステータス 入金前:unpaid |
status | 処理ステータス 申込み:request |
type | 発行タイプ 個人:personal |
company_ | 事業者登録番号 |
cellphone | 電話番号(携帯) |
tax_ | 課税金額 |
tax_ | 免税金額 |
supply_ | 仕入れ価格 |
List all cashreceipt
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
start_ Required Date | 検索開始日 |
end_ Required Date | 検索終了日 |
order_ Order ID | 注文番号 |
approval_ Max Length : [9] | 承認番号 |
name Max Length : [20] | 要請者名 |
member_ Max Length : [20] | 会員ID |
status | 処理ステータス すべて:all DEFAULT all |
limit Min : [1]~Max : [500] | 検索結果の最大件数 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Create a cashreceipt
POST
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
order_ Required Order ID | 注文番号 |
type Required | 発行タイプ 個人:personal |
company_ Business Number | 事業者登録番号 |
cellphone Mobile | 電話番号(携帯) |
Update a cashreceipt
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
cashreceipt_ Required Min : [1] | 現金領収証番号 |
order_ Required Order ID | 注文番号 |
type | 発行タイプ 個人:personal |
company_ Business Number | 事業者登録番号 |
cellphone Mobile | 電話番号(携帯) |
Cashreceipt cancellation
Cashreceipt cancellation properties
Attribute | Description |
---|---|
cashreceipt_ | 現金領収証番号 |
order_ | 注文番号 |
status | 処理ステータス 申込み取消し:canceled_request |
Update a cashreceipt cancellation
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
cashreceipt_ Required Min : [1] | 現金領収証番号 |
order_ Required Order ID | 注文番号 |
type Required | 取消しタイプ 申込み取消し:request |
Collectrequests
Collectrequests properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
request_ | LIBSPECDATAREQUEST.NUMBER |
order_ | 注文番号 |
order_ | 品目別注文コード |
shipping_ | LIBSPECDATACOLLECT.SHIPPING.COMPANY.NAME |
collect_ | LIBSPECDATACOLLECTION.TRACKING.NUMBER |
Update a collectrequest
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 30 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
request_ Required | LIBSPECDATAREQUEST.NUMBER |
collect_ Required Max Length : [30] | LIBSPECDATACOLLECTION.TRACKING.NUMBER |
Exchange
Endpoints
Exchange properties
Attribute | Description |
---|---|
shop_ | ショップ番号 詳細検索時のみ確認可能である。 |
order_ | 注文番号 詳細検索時のみ確認可能である。 |
claim_ | 交換番号 詳細検索時のみ確認可能である。 |
claim_ | 区分 詳細検索時のみ確認可能である。 A : お客様都合 |
claim_ | 理由 詳細検索時のみ確認可能である。 |
claim_ | 交換処理の予定日 詳細検索時のみ確認可能である。 |
receiver | 受取人 詳細検索時のみ確認可能である。 |
reshipping_ | 交換による再発送の情報 詳細検索時のみ確認可能である。 |
pickup | 受取人の住所 詳細検索時のみ確認可能である。 |
additional_ | 追加決済 詳細検索時のみ確認可能である。 |
return_ | 返品用送り状の送り状番号 詳細検索時のみ確認可能である。 |
return_ | 返品に使用する配送会社名 詳細検索時のみ確認可能である。 |
refund_ | 返金方式 詳細検索時のみ確認可能である。 |
refund_ | 備考 詳細検索時のみ確認可能である。 |
order_ | 商品購入金額 詳細検索時のみ確認可能である。 |
refund_ | 返金額 詳細検索時のみ確認可能である。 |
shipping_ | 送料 詳細検索時のみ確認可能である。 |
return_ | 返品送料の適用区分 詳細検索時のみ確認可能である。 |
defer_ | 後払い手数料 詳細検索時のみ確認可能である。 |
partner_ | 提携割引のキャンセル金額 詳細検索時のみ確認可能である。 |
add_ | 商品別追加割引の 詳細検索時のみ確認可能である。 |
member_ | 会員ランク割引の 詳細検索時のみ確認可能である。 |
shipping_ | 送料割引のキャンセル金額 詳細検索時のみ確認可能である。 |
coupon_ | クーポン割引の 詳細検索時のみ確認可能である。 |
point_ | 使用済みポイントの返還額 詳細検索時のみ確認可能である。 |
credit_ | 使用済み預り金の返還額 詳細検索時のみ確認可能である。 |
items | 品目別注文エンティティ 詳細検索時のみ確認可能である。 |
exchanged_ | 交換商品 詳細検索時のみ確認可能である。 |
Get an exchange
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
claim_ Required | 交換番号 |
Orders
注文(order)はショップでショップの顧客が商品を購入するためにショップに要求した内訳です。ショップの運営者は決済済みの注文情報を見てショップの顧客に商品を配送します。注文情報には注文と決済を行った注文者の情報と商品を受け取る受取人の情報が含まれています。
注文は下記のようなResourceを下位Resourceとして持っています。
● 品目別注文(Items)
● 受取人情報(Receivers)
Orders properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
currency | 通貨単位 マルチショップの通貨単位 |
order_ | 注文番号 |
market_ | モール型ECサイトの区分値 価格比較サイトを経由してモール型ECサイトなどで商品を購入する場合、そのサイトを区分するためのID |
market_ | モール型ECサイトのその他の情報 モール型ECサイトまたは注文経路に関するその他の情報 |
member_ | 会員ID |
member_ | 会員メールアドレス |
member_ | 会員認証の有無 会員認証の設定。設定によって会員は3つのタイプに分けられる。 T:承認 |
billing_ | 決済者名 入金者の名前。注文者または受取人の名前と違う場合がある。 |
bank_ | 銀行コード |
bank_ | 入金銀行名 |
payment_ | 決済方法コード 注文者が利用した決済方法のコード cash : 銀行振込 |
payment_ | 決済方法名 注文者が利用した決済方法の名前 |
payment_ | 決済代行サービス名 注文者が利用した決済代行会社の名前 |
sub_ | 海外決済方法名 |
sub_ | 海外決済方法のコード |
paid | 決済の有無 決済が完了したかどうかの表示 T:決済 |
order_ timezone | 注文日 |
first_ | 初注文の有無 初めての注文であるかどうかの表示 T:初注文 |
payment_ timezone | 決済日 |
order_ | モバイル区分 注文をモバイルで行ったかどうかの区分 T:モバイル注文 |
use_ | エスクロー使用設定 エスクローを使ったかどうかを設定 T:エスクローを使用する |
group_ | 注文時の会員ランク |
initial_ | 最初の注文金額 |
actual_ | 現在の注文金額 |
bank_ | 口座番号 注文件に対するショップの口座番号 |
bank_ | 口座名義 |
market_ | モール型ECサイトの注文者ID |
market_ | ECサイト販売者ID |
payment_ | 最終決済金額 |
cancel_ timezone | 注文キャンセル日 |
order_ | 注文ルートテキスト |
order_ | 注文ルート |
payment_ | 後払いの入金確認可能の設定 T:入金確認 |
commission | 決済手数料 |
postpay | 後払い決済かどうか T:後払い決済 |
admin_ | 運営者入力金額 |
additional_ | 追加送料 |
international_ | 海外配送保険料 |
additional_ | 海外配送付加金額 |
shipping_ | 配送タイプ 配送タイプ。国内配送か海外配送か両方とも可能かを設定 A:国内 |
shipping_ | 配送タイプ名 配送タイプの説明。国内配送か海外配送か両方とも可能かを説明 |
shipping_ | 配送ステータス F:配送前 |
wished_ | 配送希望日 |
wished_ | 配達希望時間 |
wished_ | 希望配送会社コード |
wished_ | 希望配送会社名 |
return_ timezone | 返品承認日時 |
total_ | 仕入れ価格合計 |
naver_ | Naverポイント |
additional_ | 注文書の追加項目 |
store_ | 店舗受取の設定 T:店舗にて受取り |
easypay_ | 簡単決済の決済代行会社名 |
loan_ | 与信状態 OK : GOOD |
subscription | 定期購入利用状況 T : 利用中 |
items | 品目別注文エンティティ
|
receivers | 受取人情報エンティティ
|
buyer | 注文者情報のリソース
|
shipping_ | 送料情報 |
regional_ | 地域別送料情報 |
return | 返品詳細リソース
|
cancellation | キャンセル詳細リソース
|
exchange | 交換詳細リソース
|
multiple_ | 複数配送注文かどうか T : 複数配送注文 |
exchange_ | 決済通貨の為替レート情報 |
first_ | 最初に使用した決済方法のコード cash : 銀行振込 |
naverpay_ | Naver Pay決済代行サービス(PG)の決済情報 P:決済代行サービス(PG)決済 |
customer_ | 注文時の会員ランク 注文当時の会員ランク 詳細検索時のみ確認可能である。 |
benefits | 特典リソース
詳細検索時のみ確認可能である。 |
coupons | クーポンリソース
詳細検索時のみ確認可能である。 |
refunds | 返金詳細リソース
詳細検索時のみ確認可能である。 |
process_ | 注文ステータス prepare:発送準備中 |
order_ | 品目別注文コード |
List all orders
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
items embed | 品目別注文エンティティ |
receivers embed | 受取人情報エンティティ |
buyer embed | 注文者情報のリソース |
return embed | 返品詳細リソース |
cancellation embed | キャンセル詳細リソース |
exchange embed | 交換詳細リソース |
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
start_ Required Date | 検索開始日 検索を開始する基準日 |
end_ Required Date | 検索終了日 検索を終了する基準日 |
order_ Order ID | 注文番号 ,(コンマ)で複数の件を検索することができる。 |
order_ | 注文ステータス 注文ステータス。注文ステータス別にそれぞれのコードがある。 ,(コンマ)で複数の件を検索することができる。 N00:入金前 |
member_ | 会員/非会員 会員の有無。会員と非会員、それぞれのコードがある。 2:会員 |
group_ | 会員ランク番号 |
buyer_ | 注文者名 注文者の名前。入金者または受取人の名前と異なる場合がある。 |
receiver_ | 受取人名 受取人の名前。注文者または入金者の名前と違う場合がある。 |
name_ | 受取人名(フリガナ) |
receiver_ | 受取人の住所 受取人の住所。注文者または入金者の住所と違う場合がある。 |
member_ | 会員ID 会員ID |
member_ | 会員メールアドレス |
product_ | 商品番号 商品番号 |
product_ | 商品コード 商品コード |
date_ | 検索日付のタイプ 検索するための日付タイプ基準。基本値は注文日に設定されている。 order_date:注文日 DEFAULT order_date |
supplier_ | 供給会社のID ,(コンマ)で複数の件を検索することができる。 |
order_ | 注文ルート ,(コンマ)で複数の件を検索することができる。 cafe24:Cafe24 |
buyer_ | 注文者の携帯電話番号 |
buyer_ | 注文者の固定電話番号 |
buyer_ | 注文者のメールアドレス |
inflow_ | アクセスルート |
subscription | 定期購入利用状況 T : 利用中 |
market_ | ECサイトキャンセル申込み有無 T : キャンセル申込みされたECサイトからの注文 |
payment_ | 決済方法コード ,(コンマ)で複数の件を検索することができる。 cash : 銀行振込 |
payment_ | 決済代行サービス名 ,(コンマ)で複数の件を検索することができる。 |
market_ | ECサイト販売者ID |
limit Min : [1]~Max : [500] | 検索結果の最大件数 検索したい最大件数を指定することができる。 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Count all orders
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
start_ Required Date | 検索開始日 検索を始める基準日 |
end_ Required Date | 検索終了日 検索を終了する基準日 |
order_ Order ID | 注文番号 ,(コンマ)で複数の件を検索することができる。 |
order_ | 注文ステータス 注文ステータス。注文ステータス別にそれぞれのコードがある。 ,(コンマ)で複数の件を検索することができる。 N00:入金前 |
member_ | 会員/非会員 会員の有無。会員と非会員、それぞれのコードがある。 2:会員 |
group_ | 会員ランク番号 |
buyer_ | 注文者名 注文者の名前。入金者または受取人の名前と異なる場合がある。 |
receiver_ | 受取人名 受取人の名前。注文者または入金者の名前と違う場合がある。 |
name_ | 受取人名(フリガナ) |
receiver_ | 受取人の住所 受取人の住所。注文者または入金者の住所と違う場合がある。 |
member_ | 会員ID 会員ID |
member_ | 会員メールアドレス |
product_ | 商品番号 商品番号 |
product_ | 商品コード 検索キーワードが商品コードに含まれている商品検索(大文字・小文字を区別する) |
date_ | 検索日付のタイプ 検索するための日付タイプ基準。基本値は注文日に設定されている。 order_date:注文日 DEFAULT order_date |
supplier_ | 供給会社のID ,(コンマ)で複数の件を検索することができる。 |
order_ | 注文ルート ,(コンマ)で複数の件を検索することができる。 cafe24:Cafe24 |
buyer_ | 注文者の携帯電話番号 |
buyer_ | 注文者の固定電話番号 |
buyer_ | 注文者のメールアドレス |
inflow_ | アクセスルート |
subscription | 定期購入利用状況 T : 利用中 |
market_ | ECサイトキャンセル申込み有無 T : キャンセル申込みされたECサイトからの注文 |
payment_ | 決済方法コード ,(コンマ)で複数の件を検索することができる。 cash : 銀行振込 |
payment_ | 決済代行サービス名 ,(コンマ)で複数の件を検索することができる。 |
market_ | ECサイト販売者ID |
Get an order
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
items embed | 品目別注文エンティティ |
receivers embed | 受取人情報エンティティ |
buyer embed | 注文者情報のリソース |
benefits embed | 特典リソース |
coupons embed | クーポンリソース |
return embed | 返品詳細リソース |
cancellation embed | キャンセル詳細リソース |
exchange embed | 交換詳細リソース |
refunds embed | 返金詳細リソース |
Update an order
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
process_ Required | 注文ステータス prepare:発送準備中 |
order_ | 品目別注文コード |
Update orders
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 100 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
process_ Required | 注文ステータス prepare:発送準備中 |
order_ | 品目別注文コード |
Orders autocalculation
Orders autocalculation properties
Attribute | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ | 注文番号 |
Delete an orders autocalculation
DELETE
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
Orders buyer
「Buyer」は、注文者の名前、連絡先、住所などを表示します。 購入者情報はサブリソースであるため、「Order」の以下で使用可能です。
Orders buyer properties
Attribute | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 |
member_ | 会員ID |
member_ | 注文当時の注文者の会員ランク番号 |
name | 注文者名 |
names_ | 注文者名のふりがな |
注文者のメールアドレス 会員のメールアドレス | |
phone | 注文者の固定電話番号 |
cellphone | 注文者の携帯電話番号 |
customer_ | お客様へのお知らせ お客様へのお知らせ |
updated_ timezone | 修正日 |
user_ | 注文者を変更した人のID 注文者情報を修正した人のID |
user_ | 注文者を変更した人の名前 注文者情報を修正した人の名前 |
order_ Order ID | 注文番号 |
Get an orders buyer
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
Update an orders buyer
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
name | 注文者名 |
email | 注文者のメールアドレス 会員のメールアドレス |
phone | 注文者の固定電話番号 |
cellphone | 注文者の携帯電話番号 |
customer_ | お客様へのお知らせ お客様へのお知らせ |
Orders buyer history
Orders buyer history properties
Attribute | Description |
---|---|
shop_ Min : [1] | ショップ番号 |
name | 注文者名 |
email | 注文者のメールアドレス |
phone | 注文者の固定電話番号 |
cellphone | 注文者の携帯電話番号 |
customer_ | お客様へのお知らせ |
updated_ timezone | 修正日 |
user_ | 注文者を変更した人のID |
user_ | 注文者を変更した人の名前 |
List all orders buyer history
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
Orders cancellation
Orders cancellation properties
Attribute | Description |
---|---|
shop_ Min : [1] | ショップ番号 |
order_ | 注文番号 |
status | 注文ステータス canceled:キャンセル完了 |
claim_ | キャンセル番号 |
items | 品目別注文コード |
Create an orders cancellation
POST
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
payment_ | 決済代行会社の注文キャンセルを申込むかどうか T : キャンセルする DEFAULT F |
status Required | 注文ステータス canceled:キャンセル完了 |
recover_ | 在庫の回復 T : 復元する DEFAULT F |
recover_ | クーポン復元 T : 復元する DEFAULT F |
add_ | 運営者メモに追加する T:使用する DEFAULT F |
reason Max Length : [2000] | キャンセル理由 |
claim_ | キャンセル理由の区分 A : お客様都合 |
naverpay_ | Naver Payで注文した件のキャンセル理由の区分 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 51 : 心変わり |
refund_ | 返金方式 T : 現金 |
combined_ | 複合 返金 方式 T : 現金 |
refund_ | 返金先の銀行コード |
refund_ Max Length : [250] | 返金先の銀行名 |
refund_ Max Length : [50] | 返金の口座番号 |
refund_ Max Length : [15] | 返金先の口座名義 |
items | 品目別注文コード |
order_item_code quantity |
Orders inflowgroups
Orders inflowgroups properties
Attribute | Description |
---|---|
inflow_ | アクセスルートのサイトID |
inflow_ | アクセスルートのサイト名 |
List all orders inflowgroups
GET
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
Create an orders inflowgroup
POST
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
inflow_ Required Max Length : [40] | アクセスルートのサイトID |
inflow_ Required Max Length : [100] | アクセスルートのサイト名 |
Update an orders inflowgroup
PUT
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
inflow_ Required Type : [a-zA-Z0-9] | アクセスルートのサイトID |
inflow_ Required Max Length : [100] | アクセスルートのサイト名 |
Delete an orders inflowgroup
DELETE
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
inflow_ Required Max Length : [40] | アクセスルートのサイトID |
Orders inflowgroups inflows
Orders inflowgroups inflows properties
Attribute | Description |
---|---|
inflow_ | アクセスルートのサービスーID |
inflow_ | アクセスルートのサービス名 |
inflow_ | アクセスルートアイコン |
group_ | アクセスルートのサイトID |
List all orders inflowgroups inflows
GET
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
group_ Required Max Length : [40] | アクセスルートのサイトID |
Create an orders inflowgroups inflow
POST
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
group_ Required Max Length : [40] | アクセスルートのサイトID |
inflow_ Required Max Length : [40] | アクセスルートのサービスーID |
inflow_ Required Max Length : [100] | アクセスルートのサービス名 |
inflow_ Required URL | アクセスルートアイコン |
Update an orders inflowgroups inflow
PUT
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
group_ Required Max Length : [40] | アクセスルートのサイトID |
inflow_ Required Max Length : [40] | アクセスルートのサービスーID |
inflow_ Required Max Length : [100] | アクセスルートのサービス名 |
inflow_ Required URL | アクセスルートアイコン |
Delete an orders inflowgroups inflow
DELETE
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
group_ Required Max Length : [40] | アクセスルートのサイトID |
inflow_ Required Max Length : [40] | アクセスルートのサービスーID |
Orders items
品目別注文(Items)はショップの顧客が注文時に購入した品目の情報です。ショップの品目はショップで販売する商品の基本単位で、品目別注文では購入した商品の品目情報と共に購入時に選択したオプション、注文数量などの情報を追加で確認することができます。
品目別注文番号は下位 Resourceで、注文(Order)の下位でしか使えません。
Orders items properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
item_ | 品目別注文ID 品目別注文番号のID |
order_ | 品目別注文コード 品目別注文番号のコード |
variant_ | 品目コード システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。 |
product_ | 商品番号 商品固有の一連番号。ショップ内で商品番号は重複しない。 |
product_ | 商品コード システムにより商品に付与されたコード。ショップ内で商品コードは重複しない。 |
custom_ Max Length : [40] | 独自商品コード |
custom_ | 独自品目コード |
eng_ | 英語商品名 商品の英語名。海外配送などに使用可能 |
option_ | 商品オプションID 商品オプションのID |
option_ | オプション値 注文した商品のオプション値 |
option_ | 基本オプション値 |
additional_ | 追加入力オプション値 |
additional_ | 追加入力オプション一覧 |
product_ | 商品名 商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。 |
product_ | 基本商品名 |
product_ | 商品販売価格 商品の販売価格。マルチショップを運営する場合には販売価格をショッピング別通貨単位で換算して表示 |
option_ | オプション追加価格 オプション別に追加価格がある場合、その追加価格 |
additional_ | 商品追加割引金額 商品に対する追加割引金額 |
coupon_ | 商品別のクーポンによる割引金額 |
app_ | アプリによる商品割引金額 |
actual_ | 実際の決済金額(品目別) |
quantity | 数量 注文した商品の数量 |
product_ | 商品の税金区分 A : 課税 |
tax_ | 税率 |
supplier_ | 供給会社の商品名 供給会社の商品名 |
supplier_ | 供給会社の取引タイプ 供給会社の取引タイプ D:直接登録型 |
supplier_ | 供給会社のID 供給会社のID |
supplier_ | 供給会社名 供給会社の名前 |
tracking_ | 送り状番号 |
shipping_ | 配送番号 配送番号。品目別注文番号を配送準備中に処理すると、システムにより自動的に付与される番号 |
claim_ | キャンセル/交換/返品番号 |
claim_ | キャンセル/交換/返品の申込理由のタイプ 購入者のキャンセル/交換/返品の申込み理由の区分 |
claim_ | キャンセル/交換/返品の理由 購入者のキャンセル/交換/返品の申込み理由の詳細 |
refund_ | 返金先の銀行名 |
refund_ | 返金の口座番号 |
refund_ | 返金先の口座名義 |
post_ | ゆうパック連動 ゆうパック連動ステータス |
order_ | 注文ステータス 注文ステータス。注文ステータス別にそれぞれのコードがある。 |
request_ | 取消ステータス Cancellation:キャンセル取消し |
order_ | 注文ステータスの追加情報 注文ステータスの追加情報 |
claim_ | キャンセル/交換/返品の申込数量 |
status_ | 現在の処理ステータスコード 現在の処理ステータスのコード N1:正常 |
status_ | 現在の処理ステータス 現在の処理ステータスに関する説明 |
open_ | モール型ECサイト連動ステータス値 |
bundled_ | まとめて配送のタイプ 配送対象の注文に対してまとめて配送するタイプ N:単一注文の一般配送(Normal) |
shipping_ | 配送会社ID 配送会社のID |
shipping_ | 配送会社名 配送会社の名前 |
shipping_ | 配送会社コード |
product_ | セット商品の有無 T:セット商品 |
product_ | セット商品番号 分離型セット商品の番号 |
product_ | セット商品名 分離型セット商品の名前 |
product_ | セット商品名(基本) 分離型セット商品の名前 |
product_ | セット商品のタイプ セット商品のタイプ C:一体型 |
was_ | セット品目別注文の分離設定 セット商品の品目注文番号を分離するかどうかを設定 T:分離履歴ある |
original_ | 分離したセット商品の既存の品目別注文番号 分離されたセット商品の既存の品目別注文番号 |
naver_ | Naver Pay商品別注文番号 Naver Pay注文の商品別注文番号 |
naver_ | Naver Payクレームタイプ Naver Pay注文のクレームタイプ PAYMENT_WAITING:入金待ち |
individual_ | 個別送料 個別送料 |
shipping_ | 送料タイプ (個別送料を利用する場合)商品の送料タイプ T:無料 |
shipping_ | 送料タイプ 送料タイプの説明 |
shipping_ | 前払い/着払いの区分 C:着払い |
payment_ | 決済情報ID |
original_ | 既存の品目別注文ID |
store_ | 店舗受取の設定 実店舗で受け取る商品かどうかを設定 T:店舗にて受取り |
ordered_ timezone | 注文日 |
shipped_ timezone | 配送開始日 配送開始日 |
delivered_ timezone | 配送完了日 配送完了日 |
cancel_ timezone | 注文キャンセル日 注文のキャンセル日 |
return_ timezone | 返品承認日時 |
return_ timezone | 返品申込日 返品申込日 |
return_ timezone | 返品集荷日 |
cancel_ timezone | キャンセル申込日 注文の取消申込日 |
refund_ timezone | 返金完了日 返金完了日 |
exchange_ timezone | 交換申込日 交換申込日 |
exchange_ timezone | 交換完了日 交換完了日 |
product_ | 商品素材 商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。 |
product_ | 英語商品素材 商品素材の英語説明 |
cloth_ | 生地 商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 |
product_ | 商品重量 商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。 |
volume_ | 商品容積 商品の体積 |
volume_ | 商品の容積・重量 商品の体積と重量 |
clearance_ | 海外通関用商品区分 |
clearance_ | 海外通関用商品情報 |
clearance_ | 海外通関コード |
hs_ | HSコード 通関のためのHSコード |
one_ | 1+Nイベントの有無 1個購入時にN個を提供するイベントの設定 |
origin_ | 原産国情報 商品の原産国 |
origin_ | 原産国コード |
made_ | 国名(原産国)コード |
gift | ノベルティであるかどうか 商品がプレミアムかどうかを設定 T:ノベルティ |
item_ | ノベルティ贈呈条件となる品目の一覧 |
subscription | 定期購入利用状況 T : 利用中 |
product_ | セット商品一覧 |
market_ | ECサイトキャンセル申込み有無 T : キャンセル申込みしたECサイト注文 |
market_ | モール型ECサイトからのキャンセル申込数量 |
market_ | モール型ECサイトでの処理失敗の原因 |
market_ | モール型ECサイトでの処理失敗の原因に対する説明 |
market_ | モール型ECサイト独自品目コード |
order_ | 注文番号 |
claim_ | キャンセル/交換/返品のタイプ |
claim_ | キャンセル/交換/返品の申込み状態 |
List all orders items
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
Update an orders item
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
order_ Required | 品目別注文コード |
claim_ Required | キャンセル/交換/返品のタイプ C : キャンセル |
claim_ Required | キャンセル/交換/返品の申込み状態 T : 申し込む |
claim_ Required | キャンセル/交換/返品の申込理由のタイプ A : お客様都合 |
claim_ | キャンセル/交換/返品の理由 |
claim_ | キャンセル/交換/返品の申込数量 |
Orders memos
Orders memos properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
memo_ | メモ番号 |
created_ timezone | メモ登録日 |
author_ | 作成者ID |
ip | 作成者IP |
use_ | お問い合わせに対する回答の同時登録の使用状態 T:使用する |
attach_ | 登録基準 O:注文別 |
content | メモ内容 |
starred_ | 重要メモの有無 T:重要メモ |
fixed | 上部に固定する機能の使用状態 T:使用する |
product_ | 商品リスト |
topic_ | お問い合わせカテゴリ cs_01 : 配送に関するお問い合わせ |
status | お問い合わせ対応の結果 F:処理中 |
List all orders memos
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
Create an orders memo
POST
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
content Required Max Length : [1000] | メモ内容 |
use_ | お問い合わせに対する回答の同時登録の使用状態 T:使用する DEFAULT F |
topic_ | お問い合わせカテゴリ cs_01 : 配送に関するお問い合わせ |
status | お問い合わせ対応の結果 F:処理中 |
attach_ | 登録基準 O:注文別 DEFAULT O |
starred_ | 重要メモの有無 T:重要メモ DEFAULT F |
fixed | 上部に固定する機能の使用状態 T:使用する DEFAULT F |
product_ | 商品リスト |
Update an orders memo
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
memo_ Required | メモ番号 |
content Max Length : [1000] | メモ内容 |
use_ | お問い合わせに対する回答の同時登録の使用状態 T:使用する DEFAULT F |
topic_ | お問い合わせカテゴリ cs_01 : 配送に関するお問い合わせ |
status | お問い合わせ対応の結果 F:処理中 |
attach_ | 登録基準 O:注文別 DEFAULT O |
starred_ | 重要メモの有無 T:重要メモ DEFAULT F |
fixed | 上部に固定する機能の使用状態 T:使用する DEFAULT F |
product_ | 商品リスト |
Delete an orders memo
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
memo_ Required | メモ番号 |
Orders payments
Orders payments properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
order_ | 注文番号 |
change_ | 決済金額変更の有無 T:使用する |
change_ | 決済方法変更の有無 T:使用する |
payment_ | 決済方法 |
payment_ | 決済代行会社の決済キャンセルエラーメッセージ |
admin_ | 運営者入力金額 |
commission | 決済手数料 |
initial_ | 初期決済予定金額 |
change_ | 決済金額変更の理由 |
Update an orders payment
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
change_ Required | 決済金額変更の有無 T:使用する |
change_ Required | 決済方法変更の有無 T:使用する |
payment_ | 決済方法 cash:銀行振込 |
billing_ Max Length : [40] | 入金者名 |
bank_ | 振込銀行のID |
admin_ Min : [0] | 運営者入力金額 |
commission Min : [0] | 決済手数料 |
change_ Max Length : [255] | 決済金額変更の理由 |
Orders paymenttimeline
Orders paymenttimeline properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
payment_ | 決済番号 |
payment_ | 決済タイプ O:最初決済 |
order_ | 注文金額 |
additional_ | 併用決済金額 |
paid_ | 決済金額 |
payment_ | 決済方法 |
payment_ timezone | 決済日 |
created_ timezone | 入力日 |
payment_ | 決済方法別の決済金額 詳細検索時のみ確認可能である。 |
order_ | 注文金額の詳細 詳細検索時のみ確認可能である。 |
List all orders paymenttimeline
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
Get an orders paymenttimeline
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
payment_ Required Min : [1] | 決済番号 |
Orders receivers
受取人情報(Receivers)は注文した商品を受け取る人の名前、連絡先、住所情報です。
受取人情報は下位Resourceで、注文(Order)の下位でしか使えません。
Orders receivers properties
Attribute | Description |
---|---|
shop_ Min : [1] | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
name | 受取人名 |
name_ | 受取人名(フリガナ) |
phone | 電話番号 |
cellphone | 受取人の電話番号(携帯) |
virtual_ | 受取人の安心番号 |
zipcode | 郵便番号 |
address1 | 基本住所 |
address2 | 詳細住所 |
address_ | 都道府県 |
address_ | 市区町村 |
address_ | 道路名 |
address_ | アドレス |
name_ | 受取人名(ローマ字) |
city_ | 受取人の都市(ローマ字) |
state_ | 受取人の住所(ローマ字) |
street_ | 受取人の住所 (ローマ字) |
country_ | 国コード |
country_ | 国名 |
country_ | 国名(ローマ字) |
shipping_ | 配送メッセージ |
clearance_ | 通関情報タイプ I:身分証明書(ID)番号 |
clearance_ | 通関情報 |
wished_ | 配送希望日 |
wished_ | 配達希望時間 |
shipping_ | 配送番号 |
change_ | 基本お届け先の変更有無 T:変更する |
List all orders receivers
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 マルチショップを区分するために使うショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
shipping_ | 配送番号 ,(コンマ)で複数の件を検索することができる。 |
Update orders receivers
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 100 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
name Max Length : [20] | 受取人名 |
phone Max Length : [20] | 受取人の電話番号(固定) |
cellphone Max Length : [20] | 受取人の電話番号(携帯) |
shipping_ | 配送メッセージ |
name_ | 受取人名(フリガナ) |
zipcode Min Length : [2] | 郵便番号 |
address1 Max Length : [255] | 基本住所 |
address2 Max Length : [255] | 詳細住所 |
address_ | 都道府県 |
address_ | 市区町村 |
name_ | 受取人名(ローマ字) |
city_ | 受取人の都市(ローマ字) |
state_ | 受取人の住所(ローマ字) |
street_ | 受取人の住所 (ローマ字) |
country_ | 国コード |
clearance_ | 通関情報タイプ I:身分証明書(ID)番号 |
clearance_ | 通関情報 |
shipping_ | 配送番号 |
change_ | 基本お届け先の変更有無 T:変更する DEFAULT F |
virtual_ | 受取人の安心番号 |
Update an orders receiver
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
shipping_ Required | 配送番号 |
name Max Length : [20] | 受取人名 |
phone Max Length : [20] | 受取人の電話番号(固定) |
cellphone Max Length : [20] | 受取人の電話番号(携帯) |
shipping_ | 配送メッセージ |
name_ | 受取人名(フリガナ) |
zipcode Min Length : [2] | 郵便番号 |
address1 Max Length : [255] | 基本住所 |
address2 Max Length : [255] | 詳細住所 |
address_ | 都道府県 |
address_ | 市区町村 |
name_ | 受取人名(ローマ字) |
city_ | 受取人の都市(ローマ字) |
state_ | 受取人の住所(ローマ字) |
street_ | 受取人の住所 (ローマ字) |
country_ | 国コード |
clearance_ | 通関情報タイプ I:身分証明書(ID)番号 |
clearance_ | 通関情報 |
change_ | 基本お届け先の変更有無 T:変更する DEFAULT F |
virtual_ | 受取人の安心番号 |
Orders receivers history
Orders receivers history properties
Attribute | Description |
---|---|
shop_ Min : [1] | ショップ番号 |
name | 受取人名 |
phone | 電話番号 |
cellphone | 受取人の電話番号(携帯) |
zipcode | 郵便番号 |
address1 | 基本住所 |
address2 | 詳細住所 |
address_ | 都道府県 |
address_ | 市区町村 |
address_ | 道路名 |
address_ | アドレス |
name_ | 受取人名(ローマ字) |
city_ | 受取人の都市(ローマ字) |
state_ | 受取人の住所(ローマ字) |
street_ | 受取人の住所 (ローマ字) |
country_ | 国コード |
country_ | 国名 |
country_ | 国名(ローマ字) |
shipping_ | 配送メッセージ |
updated_ timezone | 修正日 |
user_ | 注文者を変更した人のID |
user_ | 注文者を変更した人の名前 |
shipping_ | 配送番号 |
List all orders receivers history
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
Orders return
Orders return properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
order_ | 注文番号 |
status | 注文ステータス canceled:キャンセル完了 |
claim_ | キャンセル番号 |
items | 品目別注文コード |
Create an orders return
POST
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
payment_ | 決済代行会社の注文キャンセルを申込むかどうか T : キャンセルする DEFAULT F |
status Required | 注文ステータス returned : 返品完了 |
recover_ | 在庫の回復 T : 復元する DEFAULT F |
recover_ | クーポン復元 T : 復元する DEFAULT F |
add_ | 運営者メモに追加する T:使用する DEFAULT F |
reason Max Length : [2000] | 返品理由 |
claim_ | 返品理由区分 A : お客様都合 |
naverpay_ | LIBSPECDATAPAY.ORDER.RETURN Cafe24管理画面(ベトナム, フィリピン, 日本) では使用できません。 51:心変わり |
refund_ | 返金方式 T : 現金 |
combined_ | 複合 返金 方式 T : 現金 |
refund_ | 返金先の銀行コード |
refund_ Max Length : [250] | 返金先の銀行名 |
refund_ Max Length : [50] | 返金の口座番号 |
refund_ Max Length : [15] | 返金先の口座名義 |
items | 品目別注文コード |
order_item_code quantity |
Orders shipments
「Shipments」は、注文の配送処理をするために必要な配送情報を意味します。 注文の配送情報には送り状番号や配送会社の情報、配送ステータスなどがあります。
Orders shipments properties
Attribute | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
shipping_ | 配送番号 |
order_ | 注文番号 |
tracking_ | 送り状番号 |
tracking_ timezone | 送り状情報の入力日 |
shipping_ | 配送会社コード |
items | 品目別注文一覧 |
status | 注文ステータス standby : 配送待ち |
order_ | 品目別注文コード |
status_ | 注文ステータスの追加情報 |
List all orders shipments
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required Order ID | 注文番号 |
Register shipments information
POST
注文に配送情報を登録して注文を出荷待ち状態にしたり、配送中処理をすることができます。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
tracking_ Required Max Length : [30] | 送り状番号 |
shipping_ Required | 配送会社コード |
order_ | 品目別注文コード |
status Required | 注文ステータス standby : 配送待ち |
shipping_ | 配送番号 |
Update orders shipment information
PUT
注文の配送情報(配送ステータスなど)を変更することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
shipping_ Required | 配送番号 |
status | 注文ステータス standby : 配送待ち |
status_ Max Length : [30] | 注文ステータスの追加情報 |
tracking_ Max Length : [30] | 送り状番号 |
shipping_ | 配送会社コード |
Delete an orders shipment
DELETE
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
shipping_ Required | 配送番号 |
Orders shippingfeecancellation
Orders shippingfeecancellation properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
order_ | 注文番号 |
default_ | 基本送料 |
supplier_ | ショップ基本送料 |
individual_ | 個別送料 |
international_ | 해외배송비 |
international_ | 海外配送保険料 |
additional_ | 追加送料 |
additional_ | 海外配送付加金額 |
regional_ | 地域別送料 |
claim_ | キャンセル番号 |
claim_ | 区分 A : お客様都合 |
claim_ | 理由 |
refund_ | 返金方式 |
shipping_ | 送料割引のキャンセル金額 |
coupon_ | クーポン割引の |
refund_ | 返金額 |
point_ | 使用済みポイントの返還額 |
credit_ | 使用済み預り金の返還額 |
mixed_ | 複合返金金額 |
mixed_ | 複合 返金 方式 |
status | 注文ステータス LIBSPECDATACANCELING.PROCESSING |
List all orders shippingfeecancellation
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
Create an orders shippingfeecancellation
POST
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
reason Max Length : [2000] | キャンセル理由 |
claim_ | キャンセル理由の区分 A : お客様都合 |
recover_ | クーポン復元 T : 復元する DEFAULT F |
refund_ | 返金方式 T : 現金 |
combined_ | 複合 返金 方式 T : 現金 |
refund_ | 返金先の銀行コード |
refund_ Max Length : [250] | 返金先の銀行名 |
refund_ Max Length : [50] | 返金の口座番号 |
refund_ Max Length : [15] | 返金先の口座名義 |
payment_ | 決済代行会社の注文キャンセルを申込むかどうか T : キャンセルする DEFAULT F |
Orders shortagecancellation
Orders shortagecancellation properties
Attribute | Description |
---|---|
shop_ Min : [1] | ショップ番号 |
order_ | 注文番号 |
status | 注文ステータス canceled:キャンセル完了 |
claim_ | キャンセル番号 |
items | 品目別注文コード |
Create an orders shortagecancellation
POST
本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 1 |
要求スペック
Parameter | Description |
---|---|
shop_ Min : [1] | ショップ番号 |
order_ Required | 注文番号 |
payment_ | 決済代行会社の注文キャンセルを申込むかどうか T : キャンセルする DEFAULT F |
keep_ | LIBSPECDATAWHETHER.PRESERVE.FLAG LIBSPECDATAPRESERVED.REMOVED DEFAULT F |
collect_ | ノベルティを自動回収するかどうかの有無 T:使用する DEFAULT F |
status Required | 注文ステータス canceled:キャンセル完了 |
recover_ | 在庫の回復 T : 復元する DEFAULT F |
recover_ | クーポン復元 T : 復元する DEFAULT F |
add_ | 運営者メモに追加する T:使用する DEFAULT F |
reason Max Length : [2000] | キャンセル理由 |
claim_ | キャンセル理由の区分 A : お客様都合 |
naverpay_ | Naver Payで注文した件のキャンセル理由の区分 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 51 : 心変わり |
refund_ | 返金方式 T : 現金 |
combined_ | 複合 返金 方式 T : 現金 |
refund_ | 返金先の銀行コード |
refund_ Max Length : [250] | 返金先の銀行名 |
refund_ Max Length : [50] | 返金の口座番号 |
refund_ Max Length : [15] | 返金先の口座名義 |
items | 品目別注文コード |
order_item_code quantity |
Payments
Endpoints
Payments properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
order_ | 注文番号 |
status | 注文ステータス paid:入金確認 |
Update payments
PUT
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 10 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
status Required | 注文ステータス paid:入金確認 |
recover_ | 在庫の回復 T : 復元する |
Refunds
Refunds properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
member_ | 会員メールアドレス |
buyer_ | 注文者のメールアドレス |
order_ timezone | 注文日 |
accepted_ timezone | 返金受付日 |
refund_ timezone | 返金完了日 |
order_ | 注文番号 |
refund_ | 返金番号 |
order_ | 品目別注文コード一覧 |
quantity | 数量 |
actual_ | 実際の返金額 |
used_ | 使用済みポイントの返還額 |
used_ | 使用済み預り金の返還額 |
used_ | 使用済みの総合ポイント返金額 |
currency | 通貨単位 |
payment_ | 決済方法 cash : 銀行振込 |
refund_ | 返金方法 cash : 銀行振込 |
payment_ | 決済代行会社でのキャンセル状態 F:キャンセル前 |
payment_ timezone | 決済代行会社でのキャンセル日付 |
status | 返金ステータス T:返金前 |
refund_ | ポイント返還額 詳細検索時のみ確認可能である。 |
refund_ | 預り金の返還額 詳細検索時のみ確認可能である。 |
refund_ | Naverポイント返還額 詳細検索時のみ確認可能である。 |
refund_ | Naverキャッシュ返還額 詳細検索時のみ確認可能である。 |
refund_ | 返金額 詳細検索時のみ確認可能である。 |
product_ | 商品販売価格 詳細検索時のみ確認可能である。 |
shipping_ | 送料 詳細検索時のみ確認可能である。 |
shipping_ | 送料割引 詳細検索時のみ確認可能である。 |
cod_ | 後払い手数料 詳細検索時のみ確認可能である。 |
foreign_ | 海外配送付加金額 詳細検索時のみ確認可能である。 |
product_ | 商品別の割引金額 詳細検索時のみ確認可能である。 |
member_ | 会員ランク割引金額 詳細検索時のみ確認可能である。 |
app_ | アプリによる商品割引金額 詳細検索時のみ確認可能である。 |
app_ | アプリによる注文割引金額 詳細検索時のみ確認可能である。 |
coupon_ | クーポン割引金額 詳細検索時のみ確認可能である。 |
product_ | セット商品割引金額 詳細検索時のみ確認可能である。 |
points_ | ポイント使用金額 詳細検索時のみ確認可能である。 |
credits_ | 預り金の使用金額 詳細検索時のみ確認可能である。 |
transferable_ | 総合ポイント使用金額 詳細検索時のみ確認可能である。 |
naver_ | Naverポイント 詳細検索時のみ確認可能である。 |
naver_ | Naverキャッシュ 詳細検索時のみ確認可能である。 |
additional_ | 商品追加決済金額 詳細検索時のみ確認可能である。 |
manually_ | 運営者入力金額 詳細検索時のみ確認可能である。 |
changed_ | 変更された返金額 詳細検索時のみ確認可能である。 |
refund_ | 返金先の銀行名 詳細検索時のみ確認可能である。 |
refund_ | 返金の口座番号 詳細検索時のみ確認可能である。 |
refund_ | 返金先の口座名義 詳細検索時のみ確認可能である。 |
refund_ | 返金担当者 詳細検索時のみ確認可能である。 |
refund_ | 返金理由 詳細検索時のみ確認可能である。 |
refund_ | 返金方法 詳細検索時のみ確認可能である。 |
send_ | 返金処理後SMS送信の設定 詳細検索時のみ確認可能である。 T : 送信する |
send_ | 返金処理後メール送信の設定 詳細検索時のみ確認可能である。 T : 送信する |
items | 品目別注文エンティティ
詳細検索時のみ確認可能である。 |
List all refunds
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
start_ Required Date | 検索開始日 |
end_ Required Date | 検索終了日 |
date_ | 検索日付のタイプ accepted_refund_date : 返金受付日 DEFAULT refund_date |
member_ | 会員メールアドレス |
buyer_ | 注文者のメールアドレス |
limit Min : [1]~Max : [500] | 検索結果の最大件数 DEFAULT 10 |
offset Max : [8000] | 検索結果の開始位置 |
Get a refund
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
refund_ Required | 返金番号 |
items embed | 品目別注文エンティティ |
Return
「Return」は、配送後に顧客が注文をキャンセルことを意味します。返品リソースは返品情報を照会したり、または返品を処理できます。
返品リソースは返品の受付以降から完了までのステータスを照会できます。
Return properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
order_ | 注文番号 |
claim_ | キャンセル番号 |
claim_ | 区分 販売者の返品受付理由の区分 詳細検索時のみ確認可能である。 A : お客様都合 |
claim_ | 理由 販売者の返品受付理由の詳細 詳細検索時のみ確認可能である。 |
claim_ | 返品処理予定日 詳細検索時のみ確認可能である。 |
return_ | 返品先の住所 詳細検索時のみ確認可能である。 |
pickup | 受取人の住所 詳細検索時のみ確認可能である。 |
return_ | 返品用送り状の送り状番号 詳細検索時のみ確認可能である。 |
return_ | 返品に使用する配送会社名 詳細検索時のみ確認可能である。 |
pickup_ | 回収申込みのステータス 詳細検索時のみ確認可能である。 E:回収申込み前 |
refund_ | 返金方式 詳細検索時のみ確認可能である。 |
refund_ | 備考 詳細検索時のみ確認可能である。 |
order_ | 商品購入金額 詳細検索時のみ確認可能である。 |
refund_ | 返金額 詳細検索時のみ確認可能である。 |
shipping_ | 送料 詳細検索時のみ確認可能である。 |
return_ | 返品送料の適用区分 詳細検索時のみ確認可能である。 |
return_ | 返品送料 詳細検索時のみ確認可能である。 |
return_ | 返品送料詳細 詳細検索時のみ確認可能である。 |
return_ | 地域別返品送料 詳細検索時のみ確認可能である。 |
return_ | 地域別返品送料の詳細 詳細検索時のみ確認可能である。 |
defer_ | 後払い手数料 詳細検索時のみ確認可能である。 |
partner_ | 提携割引のキャンセル金額 詳細検索時のみ確認可能である。 |
add_ | 商品別追加割引の 詳細検索時のみ確認可能である。 |
member_ | 会員ランク割引の 詳細検索時のみ確認可能である。 |
shipping_ | 送料割引のキャンセル金額 詳細検索時のみ確認可能である。 |
coupon_ | クーポン割引の 詳細検索時のみ確認可能である。 |
point_ | 使用済みポイントの返還額 詳細検索時のみ確認可能である。 |
credit_ | 使用済み預り金の返還額 詳細検索時のみ確認可能である。 |
items | 品目別注文コード |
status | 注文ステータス canceled:キャンセル完了 |
Get a return
GET
基本スペック
Property | Description |
---|---|
SCOPE | 注文の閲覧権限 (mall.read_order) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
claim_ Required | 返品番号 |
Create return
POST
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 100 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
status Required | 注文ステータス returned : 返品完了 |
recover_ | 在庫の回復 T : 復元する DEFAULT F |
recover_ | クーポン復元 T : 復元する DEFAULT F |
add_ | 運営者メモに追加する T:使用する DEFAULT F |
reason Max Length : [2000] | 返品理由 |
claim_ | 返品理由区分 A : お客様都合 |
naverpay_ | LIBSPECDATAPAY.ORDER.RETURN Cafe24管理画面(ベトナム, フィリピン, 日本) では使用できません。 51:心変わり |
refund_ | 返金方式 T : 現金 |
combined_ | 複合 返金 方式 T : 現金 |
refund_ | 返金先の銀行コード |
refund_ Max Length : [250] | 返金先の銀行名 |
refund_ Max Length : [50] | 返金の口座番号 |
refund_ Max Length : [15] | 返金先の口座名義 |
items | 品目別注文コード |
order_item_code quantity |
Shipments
Shipments properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
order_ | 注文番号 |
tracking_ | 送り状番号 |
shipping_ | 配送番号 |
shipping_ | 配送会社コード |
status | 注文ステータス standby : 配送待ち |
order_ | 品目別注文コード |
status_ | 注文ステータスの追加情報 |
Create shipments
POST
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 100 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
order_ Required | 注文番号 |
tracking_ Required Max Length : [30] | 送り状番号 |
shipping_ Required | 配送会社コード |
status Required | 注文ステータス standby : 配送待ち |
order_ | 品目別注文コード |
shipping_ | 配送番号 |
Update shipments
PUT
注文の配送情報(配送ステータスなど)を変更することができます。
基本スペック
Property | Description |
---|---|
SCOPE | 注文の投稿権限 (mall.write_order) |
呼び出し件数制限 | 40 |
1回当たり申込件数の制限 | 100 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
status | 注文ステータス standby : 配送待ち |
status_ Max Length : [30] | 注文ステータスの追加情報 |
order_ Required | 注文番号 |
shipping_ Required | 配送番号 |
tracking_ Max Length : [30] | 送り状番号 |
shipping_ | 配送会社コード |
Community
Boards
Endpoints
Boards properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
board_ | 掲示板番号 |
board_ | 掲示板のカテゴリ 1:運営 |
board_ | 掲示板タイトル |
use_ | 掲示板の追加有無 T:追加掲示板 |
use_ | 掲示板の使用有無 T:使用する |
use_ | 表示有無 T:表示する |
display_ | 並べ替え順序 |
List all boards
GET
基本スペック
Property | Description |
---|---|
SCOPE | 掲示板の閲覧権限 (mall.read_community) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
Boards articles
「Boards articles」は掲示板の投稿についての情報を意味します。
Boards articles properties
Attribute | Description |
---|---|
shop_ | ショップ番号 |
article_ | 投稿番号 |
parent_ | 親投稿の番号 |
board_ Required | 掲示板番号 |
product_ | 商品番号 |
category_ | カテゴリ番号 |
board_ | 掲示板カテゴリ番号 |
reply_ | 回答投稿の順序 |
reply_ | 回答順序 |
created_ Date | 生成日 |
writer | 作成者名 |
writer_ | 作成者Eメール |
member_ | 会員ID |
title | タイトル |
content | 内容 |
client_ IP | 作成者IP |
nick_ | ニックネーム |
rating Min : [1]~Max : [5] | 評価 |
sales_ Max Length : [20] | 媒体社 |
reply_ | My質問への回答メールの有無 Y:使用する |
display | 掲示設定 T : 掲示する |
secret | 非公開の有無 T:使用する |
notice | 告知の有無 T:使用する |
fixed | 固定投稿の有無 T:使用する |
deleted | 削除区分 T : 削除 |
input_ | 投稿作成のルート P:PC |
order_ | 注文番号 |
attach_ | 添付ファイルの詳細 |
hit | 観覧数 |
reply | My質問への回答の有無 T:使用する |
reply_ | 処理中または回答完了した運営者ID |
reply_ | 回答処理状態 N:回答前 |
naverpay_ | Naver PayのレビューID |
display_ | 表示時間使用の有無 |
display_ | 表示時間の開始時刻 |
display_ | 表示時間の終了時刻 |
attached_ | 添付ファイルの詳細 |
attached_ | 添付ファイルの詳細 |
List all boards articles
GET
基本スペック
Property | Description |
---|---|
SCOPE | 掲示板の閲覧権限 (mall.read_community) |
呼び出し件数制限 | 40 |
要求スペック
Parameter | Description |
---|---|
shop_ | ショップ番号 DEFAULT 1 |
board_ Required | 掲示板番号 |
board_ | 掲示板カテゴリ番号 |
start_ Date | 作成日の開始日 |
end_ Date | 作成日の終了日 |
input_ | ショップ区分 P : PC |
search | 検索エリア subject : タイトル |
keyword | 検索キーワード |
reply_ | 回答状態 N : 回答前 |
comment | コメントの有無 T : 有り |
attached_ |
|