REST API Documentation - CAFE24 REST API

Code	発生事例	エラーの解決方法
200	GET成功、PUT成功、DELETE成功時
201	POST成功時
207	多重要求登録時、ステータスが客体別に異なる場合	エラーの状況を客体別に確認し、状況によって対応します。
400	サーバーが要求を理解できない 1) Content-Typeの指定が間違っている 2) application/typeがjsonではない	要求時に「Content-Type」がapplication/jsonになっているか確認します。
400	要求API URLにハングルまたは記号をエンコードせずにそのまま使った場合	要求API URLにハングルまたは記号をURLエンコードしたか確認します。
401	1) Access Token がない状況で呼び出した場合 2) Access Tokenが有効ではない場合 3) Access Tokenが満了した場合 4) 不明なクライアントの場合	有効な手続きを踏んで発行されたAccess Tokenを使っているか確認します。
401	Front APIの使用時にclient_idを入力していない場合	有効なクライアントIDを使っているか確認します。
403	1) Access Tokenはあるが、Scopeに対する権限がない 2) FrontAPIで見る権限がない場合	APIを呼び出す権限があるか、APIのScopeまたはショップの設定を確認します。
403	httpsプロトコルではない場合	API要求時にhttpsで要求したか確認します。
403	新バージョンの商品管理を使うショップではない場合	新バージョンの商品管理にショップを更新しないと使用できません。
403	(Admin API呼び出し時)ショップでそのアプリが削除された場合	ショップにアプリがインストールされているか確認し、アプリを再インストールします。
403	(Front API呼び出し時)ショップでそのアプリが削除された場合	ショップにアプリがインストールされているか確認し、アプリを再インストールします。
404	1) API URLを間違って呼び出した場合 2) リソースが見つからない場合 3) {#id}がない場合	エンドポイントURLにエラーがないか、API文書を参考に確認します。
409	同じリソースで同じ内容を更新する場合	編集するデータをリクエストしてください。
422	検索/処理を要求した時、値が決まっているスペックと違う場合 1) 必須パラメーター抜け 2) 決まっているスペックと違う場合	API文書を参考に必須パラメーターが入力されていないか、有効でない値が入力されているか確認します。
429	クライアントのAPI要求がBucketを超過した場合	API最大許容要求件数を超過しないようにしばらくしてからもう一度要求します。
500	内部サーバーエラー、不明なエラー	一時的にエラーが発生しました。しばらくしてからもう一度お試しください。
503	現在のサーバーがダウンした場合	開発者センターにお問い合わせください。
503	サーバーがダウンした場合。APIが使用できない	開発者センターにお問い合わせください。
504	要求時間を超過した場合(Timeout)	一時的にエラーが発生し、応答が遅れています。しばらくしてからもう一度お試しください。

Activitylogs

操作ログは(Activitylog)、ショップ運営者がショップ管理者ページで行った作業の記録です。
操作ログリソースを使用して、ショップの操作ログの生成、照会をすることができます。

Endpoints

GET /api/v2/admin/activitylogs
GET /api/v2/admin/activitylogs/{process_no}

Activitylogs properties

Attribute	Description
process_no	操作ログ番号
mode	モード P：PC管理画面 M：モバイル管理画面 smart：(旧)スマートモード
type	区分
content	業務内容
process_date	操作日時
manager_id Type : [a-z0-9] Length Min : [4]~Max : [16]	処理者
manager_type	処理者区分

Retrieve a list of action logs cafe24

GET /api/v2/admin/activitylogs

GET

操作ログのリストを閲覧します。
処理者、操作日時、業務内容などの確認ができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter	Description
manager_type	処理者区分 P：代表運営者 A：副運営者 S：供給会社
manager_id Type : [a-z0-9] Length Min : [4]~Max : [16]	処理者
mode	モード P：PC管理画面 M：モバイル管理画面 smart：(旧)スマートモード
type	区分
content Max Length : [500]	業務内容
start_date Required Date	検索開始日
end_date Required Date	検索終了日
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Retrieve an action log cafe24

GET /api/v2/admin/activitylogs/{process_no}

GET

操作ログの詳細を照会します。
業務内容、操作日時、処理者などの確認ができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter	Description
process_no Required	操作ログ番号

Request Copy

Response Copy

Automessages arguments

自動メッセージ引数は、自動メッセージを送信するときに使用できる変数をチェックするリソースです。

Endpoints

GET /api/v2/admin/automessages/arguments

Automessages arguments properties

Attribute	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
name	変数名
description	変数の説明
sample	変数の使用例
string_length	メッセージに表示可能な最大文字数文字数：設定した値分の文字数を表示可変：表示する文字数の制限なし
send_case	使用可能な送信状況

Retrieve the list of available variables for automated messages cafe24 youtube

GET /api/v2/admin/automessages/arguments

GET

メッセージの自動送信設定を確認できます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Automessages setting

オートメッセージ設定は、メッセージを自動送信する際に使用している送信方法を確認し、どの送信方法を優先するかを確認、変更するリソースです。

Endpoints

GET /api/v2/admin/automessages/setting
PUT /api/v2/admin/automessages/setting

Automessages setting properties

Attribute	Description
shop_no	ショップ番号 DEFAULT 1
use_sms	SMSを使用するかどうか T：使用する F：使用しない
use_kakaoalimtalk	Kakao通知トークサービスを使用するかどうか T：使用する F：使用しない
use_push	プッシュ通知を使用するかどうか T：使用する F：使用しない
send_method	自動送信メッセージの送信方法 S：SMS K：Kakao通知トーク(送信に失敗した場合 SMSで送信)
send_method_push	プッシュ通知受信対象にはプッシュ通知で優先送信するかどうか T：優先送信する F：優先送信しない

Retrieve the automated message settings cafe24 youtube

GET /api/v2/admin/automessages/setting

GET

メッセージの自動送信設定を確認できます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update an automated message cafe24 youtube

PUT /api/v2/admin/automessages/setting

PUT

自動メッセージ送信の設定を変更できます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

send_method
Required

自動送信メッセージの送信方法

S：SMS
K：Kakao通知トーク(送信に失敗した場合
SMSで送信)

send_method_push

プッシュ通知受信対象にはプッシュ通知で優先送信するかどうか

* Youtube shopping をご利用の場合は提供されません

T：優先送信する
F：優先送信しない

Request Copy

Response Copy

Coupons setting

クーポン設定(Coupons setting)は、ショップで使用するクーポンの基本的な設定を登録及び修正することができるリソースです。
クーポンの割引、ポイントの併用、クーポンの使用制限、並び替えの基準など、多様な設定ができます。

Endpoints

GET /api/v2/admin/coupons/setting
PUT /api/v2/admin/coupons/setting

Coupons setting properties

Attribute	Description
shop_no Min : [1]	ショップ番号
use_coupon	クーポンの使用 T：使用する F：使用しない
available_issue_type	クーポンの使用制限 A：注文書＋商品別クーポン使用 O：注文書クーポンのみ使用 P：商品別クーポンのみ使用
allow_using_coupons_with_points	ポイントの併用 T：使用する F：使用しない
allow_using_coupons_with_discounts	割引併用 A：クーポン＋会員ランク割引を同時使用 C：クーポンのみ使用 G：会員ランク割引のみ使用
allow_using_product_and_order_coupons	商品/注文書クーポンの併用 T：使用する F：使用しない
recover_coupon_setting	クーポン返還の設定
max_coupon_count	クーポン使用枚数の制限
use_additional_coupon	追加クーポン T：使用する F：使用しない
additional_coupon_no	追加クーポンID
expiration_notice_date_setting	クーポン使用期間満了通知の送信タイミングの設定
show_coupon_to_non_members	非会員の表示設定 T：表示する F：表示しない
show_group_coupon_to_non_members	会員ランク割引が指定されたクーポンを含む T:含む F:含まない
show_issued_coupon	ダウンロード済みクーポンの表示有無 T：表示する F：表示しない
sorting_type	並び替えの基準 A：クーポン開始日 B：クーポン終了日 C：クーポン発行日 D：割引額/ポイント E：割引/付与率
download_image_type	クーポンダウンロードボタンの画像(基本画像) 1:TYPE1 2:TYPE2 3:TYPE3 4:TYPE4 5:TYPE5
background_image_type	クーポン画像(基本画像) 1:TYPE1 2:TYPE2 3:TYPE3 4:TYPE4 5:TYPE5

Retrieve coupon settings cafe24

GET /api/v2/admin/coupons/setting

GET

クーポンの使用と割引併用などの設定情報を照会します。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update coupon settings cafe24

PUT /api/v2/admin/coupons/setting

PUT

クーポン設定の情報を修正します。
クーポンの使用、クーポンの使用制限、クーポン使用枚数の制限などの情報を変更することができます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
use_coupon	クーポンの使用 T：使用する F：使用しない
available_issue_type	クーポンの使用制限 A：注文書＋商品別クーポン使用 O：注文書クーポンのみ使用 P：商品別クーポンのみ使用
allow_using_coupons_with_points	ポイントの併用 T：使用する F：使用しない
allow_using_coupons_with_discounts	割引併用 A：クーポン＋会員ランク割引を同時使用 C：クーポンのみ使用 G：会員ランク割引のみ使用
allow_using_product_and_order_coupons	商品/注文書クーポンの併用 T：使用する F：使用しない
recover_coupon_setting	クーポン返還の設定
restore_viewpoint クーポン返還のタイミング A：キャンセル/交換/返品の受付時、B：キャンセル/交換/返品の完了時 cancel_before_pay 入金前キャンセル T：自動で返還する、F：自動で返還しない、M：返還の可否を確認する cancel_after_pay 入金後キャンセル T：自動で返還する、F：自動で返還しない、M：返還の可否を確認する return 返品 T：自動で返還する、F：自動で返還しない、M：返還の可否を確認する exchange 交換 T：自動で返還する、F：自動で返還しない、M：返還の可否を確認する part 一部キャンセル/返品/交換 F：返還しない、M：返還の可否を確認する
max_coupon_count	クーポン使用枚数の制限
product_per_product 商品1点当たりのクーポン使用枚数の制限(商品クーポン) order_per_order 注文1件につき使用可能な注文書クーポン枚数の上限 product_and_order_per_order 注文1件につき使用可能なクーポン枚数の上限 product_per_order 注文1件につき使用可能な商品クーポン枚数の上限 product_and_order_per_day 1日につき使用可能なクーポン枚数の上限 product_per_item 品目1件につき使用可能な商品クーポン枚数の上限
use_additional_coupon	追加クーポン T：使用する F：使用しない
additional_coupon_no Array Max : [5]	追加クーポンID
coupon_no クーポンID
expiration_notice_date_setting	クーポン使用期間満了通知の送信タイミングの設定
expiration_notice_date_type 送信タイミングの設定特定の送信タイミングを選択する：C、すべての送信タイミングに送信する：A expiration_notice_date 送信タイミング(満了日の何日前に送信するか) 1日前：one_day、3日前：three_day、7日前：seven_day
show_coupon_to_non_members	非会員の表示設定 T：表示する F：表示しない
show_group_coupon_to_non_members	会員ランク割引が指定されたクーポンを含む T:含む F:含まない
show_issued_coupon	ダウンロード済みクーポンの表示有無 T：表示する F：表示しない
sorting_type	並び替えの基準 A：クーポン開始日 B：クーポン終了日 C：クーポン発行日 D：割引額/ポイント E：割引/付与率
download_image_type	クーポンダウンロードボタンの画像(基本画像) 1:TYPE1 2:TYPE2 3:TYPE3 4:TYPE4 5:TYPE5
background_image_type	クーポン画像(基本画像) 1:TYPE1 2:TYPE2 3:TYPE3 4:TYPE4 5:TYPE5

Request Copy

Response Copy

Currency

「Currency」ではショップの貨幣/為替レートの情報などを確認することができます。

Endpoints

GET /api/v2/admin/currency

Currency properties

Attribute	Description
exchange_rate	決済通貨の為替レート情報
standard_currency_code	基準通貨コード基本ショップで使う通貨コード。基準通貨とは一般的にショップの運営者が属している国家で通用する通貨を意味する。
standard_currency_symbol	基準通貨シンボル基本ショップで使う通貨の記号。基準通貨とは一般的にショップの運営者が属している国家で通用する通貨を意味する。
shop_currency_code	決済通貨コード
shop_currency_symbol	決済通貨シンボル
shop_currency_format	決済通貨の表示タイプ

Retrieve currency settings cafe24

GET /api/v2/admin/currency

GET

ショップの貨幣/為替レートの情報を照会します。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

Request Copy

Response Copy

Dashboard

ダッシュボード(Dashboard)はショップの注文現況や売上現況などショップの運営に必要な情報を簡単に要約しておいた情報です。

Endpoints

GET /api/v2/admin/dashboard

Dashboard properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
daily_sales_stats	日次現況情報一日単位の売上状況に関する情報
weekly_sales_stats	週間売上状況一週間単位の売上現況情報
monthly_sales_stats	月間売上状況一カ月単位の売上現況情報
sold_out_products_count	在庫切れ商品数在庫切れとなった商品数。在庫管理機能と在庫切れ機能が有効になっている場合は集計に含まれる。
new_members_count	新規会員数新規登録した会員数
board_list	掲示板リストショップの掲示板リスト

Retrieve a dashboard cafe24

GET /api/v2/admin/dashboard

GET

ダッシュボード情報を照会します。
売上現況情報などを確認することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

Request Copy

Response Copy

Financials paymentgateway

Financials paymentgateway(決済代行情報)は、決済代行会社別の契約情報を提供します。

Endpoints

GET /api/v2/admin/financials/paymentgateway

Financials paymentgateway properties

Attribute	Description
partner_id	決済代行会社が発行した加盟店ID
payment_gateway_name	決済代行サービス名 inicis：Inicis､kcp：KCP allat：Allat ksnet：KSNET dacom：Toss payments allthegate：alltheGate settlebank：Settlebank smartro：Smartro kicc：韓国情報通信(KICC) mobilians：KG Mobilians danal：Danal
contract_date	決済代行サービス契約日
setting_date	決済代行サービス初期設定日
bank_code	精算分入金時に使用する銀行コード銀行コードを検索
bank_account_no	精算分入金時に使用する口座情報
status	金融提携の有無 T：提携する F：提携しない
bank_account_name	精算分入金時に使用する口座名義
payment_method_information	決済方法別の精算情報 ※ payment_method_information下位要素の値定義 1) 1) payment_method_information > period(精算期間) D : 日別 W : 週別 M : 月別

Retrieve a list of Payment Gateway contract details cafe24

GET /api/v2/admin/financials/paymentgateway

GET

決済代行会社の契約情報のリストを閲覧することができます。
決済代行サービス契約日、決済方法別の精算情報などの情報を確認することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter	Description
payment_gateway_name	決済代行サービス名
partner_id	決済代行会社が発行した加盟店ID

Request Copy

Response Copy

Financials store

Financials store(商店の取引情報)は、商店の決済代行会社別の取引情報を提供します。

Endpoints

GET /api/v2/admin/financials/store

Financials store properties

Attribute	Description
shop_no	ショップ番号
first_payment_date	初回決済日
payment_gateway_name	決済代行サービス名

Retrieve the transaction information of a store cafe24

GET /api/v2/admin/financials/store

GET

商店の決済手段別の取引情報を照会することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

payment_method
Required

決済方法コード

card：クレジットカード
tcash：口座振込
icash：バーチャル口座
cell：キャリア決済
deferpay：後払い
cvs：コンビニ
point：前払い
etc：その他

Request Copy

Response Copy

Images setting

商品画像のサイズ設定値を照会や修正することができます。

Endpoints

GET /api/v2/admin/images/setting
PUT /api/v2/admin/images/setting

Images setting properties

Attribute	Description
shop_no	ショップ番号
product_image_size	商品画像のサイズ設定値

Retrieve product image size settings cafe24

GET /api/v2/admin/images/setting

GET

商品画像のサイズ設定値を照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update product image size settings cafe24

PUT /api/v2/admin/images/setting

PUT

商品画像のサイズ設定値を修正することができます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

product_image_size
Required

商品画像のサイズ設定値

detail_image_width
詳細画像のサイズ(横)

detail_image_height
詳細画像のサイズ(縦)

list_image_width
一覧画像のサイズ(横)

list_image_height
一覧画像のサイズ(縦)

tiny_image_width
縮小一覧画像のサイズ(横)

tiny_image_height
縮小一覧画像のサイズ(縦)

zoom_image_width
拡大画像のサイズ(横)

zoom_image_height
拡大画像のサイズ(縦)

small_image_width
縮小画像のサイズ(横)

small_image_height
縮小画像のサイズ(縦)

Request Copy

Response Copy

Kakaoalimtalk profile

商店にカカオチャンネルのプロフィールキーを登録しているかどうかを確認できるリソースです。

Endpoints

GET /api/v2/admin/kakaoalimtalk/profile

Kakaoalimtalk profile properties

Attribute

Description

shop_no

ショップ番号

DEFAULT 1

kakao_senderkey

Kakaoチャネル送信プロフィールキー

Retrieve a Kakao Channel sender profile key cafe24

GET /api/v2/admin/kakaoalimtalk/profile

GET

カカオチャンネルの送信者プロフィールキー（senderkey）を確認できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Kakaoalimtalk setting

Kakao Alim Talk サービスが使用されているかどうかを確認し、設定を変更するリソースです。

Endpoints

GET /api/v2/admin/kakaoalimtalk/setting
PUT /api/v2/admin/kakaoalimtalk/setting

Kakaoalimtalk setting properties

Attribute

Description

shop_no

ショップ番号

DEFAULT 1

use_kakaoalimtalk

Kakao通知トークサービスを使用するかどうか

T：使用する
F：使用しない

Retrieve the Kakao Info-Talk settings cafe24

GET /api/v2/admin/kakaoalimtalk/setting

GET

Kakao Alim Talk サービスの配信設定を確認できます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update the Kakao Info-Talk settings cafe24

PUT /api/v2/admin/kakaoalimtalk/setting

PUT

Kakao Alim Talk サービスの配信設定を変更できます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

use_kakaoalimtalk

Kakao通知トークサービスを使用するかどうか

T：使用する
F：使用しない

Request Copy

Response Copy

Kakaopay setting

ショップのKAKAOPAY設定情報を照会または修正することができます。

Endpoints

GET /api/v2/admin/kakaopay/setting
PUT /api/v2/admin/kakaopay/setting

Kakaopay setting properties

Attribute	Description
shop_no	ショップ番号
shop_key	出店時に付与される販売店の一意識別子(UID)
pixel_code	連携会社(ASP型/ソフトウェアインストール型ネットショップ)ですでに使用中のKakao広告ピクセルID
use_kakaopay	KakaoPay購入を使用するかどうか T：使用する F：使用しない
product_detail_button_size	ショップの商品詳細ページボタンのサイズ
basket_button_size	ショップのカートページボタンのサイズ
use_dark_mode	ショップにダークモードを適用するかどうか T : 適用する F：適用しない
button_authorization_key	出店時に付与される販売店のボタン認証
thirdparty_agree	個人情報の第三者提供に関する同意 T：同意する F：同意しない
thirdparty_agree_date	個人情報の第三者提供に同意した日付

Retrieve settings for KakaoPay orders cafe24

GET /api/v2/admin/kakaopay/setting

GET

ショッピングモールのカカオペイ設定を照会します。
カカオペイの購入使用可否、第三者提供同意可否などの情報を確認することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update settings for KakaoPay orders cafe24

PUT /api/v2/admin/kakaopay/setting

PUT

ショッピングモールのカカオペイ設定を修正します。
カカオペイ購入の使用可否、ショッピングモールダークモード適用可否などの情報を修正することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
shop_key	出店時に付与される販売店の一意識別子(UID)
pixel_code	連携会社(ASP型/ソフトウェアインストール型ネットショップ)ですでに使用中のKakao広告ピクセルID
use_kakaopay	KakaoPay購入を使用するかどうか T：使用する F：使用しない
product_detail_button_size	ショップの商品詳細ページボタンのサイズ
pc pc mobile mobile
basket_button_size	ショップのカートページボタンのサイズ
pc pc mobile mobile
use_dark_mode	ショップにダークモードを適用するかどうか T : 適用する F：適用しない
button_authorization_key	出店時に付与される販売店のボタン認証
thirdparty_agree	個人情報の第三者提供に関する同意 T：同意する F：同意しない
thirdparty_agree_date Date	個人情報の第三者提供に同意した日付

Request Copy

Response Copy

Menus

メニュー(Menus)は、ショップのメニューモード関連の機能です。
ショップのメニューモードとメニュー経路などを照会することができます。
ショップのメニューモードには、New プロモード、プロモード、スマートモード、モバイル管理画面があります。

Endpoints

GET /api/v2/admin/menus

Menus properties

Attribute	Description
shop_no	ショップ番号
mode	メニューモード new_pro：PC管理画面 mobile_admin：モバイル管理画面
menu_no	メニュー番号
name	メニュー名
path	メニュー経路
contains_app_url	アプリURLを含むかどうか T：含む F：含まない

Retrieve menus cafe24

GET /api/v2/admin/menus

GET

ショップのメニューモードとメニュー経路などをリストで照会することができます。
メニューモード、メニュー番号、アプリURLを含むかどうかなどを確認することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
mode	メニューモード new_pro：PC管理画面 mobile_admin：モバイル管理画面 DEFAULT new_pro
menu_no	メニュー番号 ,(コンマ)で複数の件を検索することができる。
contains_app_url	アプリURLを含むかどうか T：含む F：含まない

Request Copy

Response Copy

Mobile setting

モバイル設定(Mobile setting)は、ショップのモバイルショップ設定に関するリソースです。
モバイルショッピングモール有効とモバイル用URLへのリダイレクトの使用状態を照会することができます。

Endpoints

GET /api/v2/admin/mobile/setting

Mobile setting properties

Attribute

Description

shop_no

ショップ番号

use_mobile_page

モバイルショッピングモール有効

T:使用する
F:使用しない

use_mobile_domain_redirection

モバイル用URLへのリダイレクト

T:使用する
F:使用しない

Retrieve mobile settings cafe24

GET /api/v2/admin/mobile/setting

GET

ショップのモバイル設定を照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	10

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Naverpay setting

Naverpay Settingは、ショップのNaverpay共通認証キーを照会または修正することができます。

Endpoints

GET /api/v2/admin/naverpay/setting
POST /api/v2/admin/naverpay/setting
PUT /api/v2/admin/naverpay/setting

Naverpay setting properties

Attribute	Description
shop_no	ショップ番号
authentication_key	Naver共通認証キー
naverpay_version	Naver Pay連携バージョン
shop_id	Naver PayセンターID
is_button_show	Naver Pay購入ボタンの表示
is_used_order	Naver Pay注文の連携
is_used_review	Naver Pay注文レビューの連携
is_show_review	Naver Pay注文レビューの表示
is_order_page	「Naver Payで購入」ボタンクリック時のページ移動
certi_key	Naver加盟店認証キー
image_key	Naverボタン認証キー
naver_button_pc_product	Naver Payボタンのデザイン：商品詳細ページ(PC)用
naver_button_pc_basket	Naver Payボタンのデザイン：カートページ(PC)用
naver_button_mobile_product	Naver Payボタンのデザイン：商品詳細ページ(モバイル)用
naver_button_mobile_basket	Naver Payボタンのデザイン：カートページ(モバイル)用

Retrieve Naver Pay settings cafe24

GET /api/v2/admin/naverpay/setting

GET

ショップのNaverpay共通認証キーを照会します。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Create Naver Pay settings cafe24

POST /api/v2/admin/naverpay/setting

POST

NAVERが発行した共通認証キーをショッピングモール管理者に登録することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
authentication_key Type : [a-zA-Z0-9_-] Max Length : [50]	Naver共通認証キー
naverpay_version	Naver Pay連携バージョン DEFAULT 2.1
shop_id Required	Naver PayセンターID
is_button_show	Naver Pay購入ボタンの表示 DEFAULT T
is_used_order	Naver Pay注文の連携 DEFAULT T
is_used_review	Naver Pay注文レビューの連携 DEFAULT T
is_show_review	Naver Pay注文レビューの表示 DEFAULT T
is_order_page	「Naver Payで購入」ボタンクリック時のページ移動 DEFAULT N
certi_key Required	Naver加盟店認証キー
image_key Required	Naverボタン認証キー
naver_button_pc_product	Naver Payボタンのデザイン：商品詳細ページ(PC)用 DEFAULT A\|1\|2
naver_button_pc_basket	Naver Payボタンのデザイン：カートページ(PC)用 DEFAULT A\|1\|1
naver_button_mobile_product	Naver Payボタンのデザイン：商品詳細ページ(モバイル)用 DEFAULT MA\|1\|2
naver_button_mobile_basket	Naver Payボタンのデザイン：カートページ(モバイル)用 DEFAULT MA\|1\|1

Request Copy

Response Copy

Update Naver Pay settings cafe24

PUT /api/v2/admin/naverpay/setting

PUT

ショップのNaverpay共通認証キーを修正します。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

authentication_key

Type : [a-zA-Z0-9_-]
Max Length : [50]

Naver共通認証キー

Request Copy

Response Copy

Orders setting

キャンセル/返品時の在庫数量の自動復元及び割引/ポイント金額など、注文の設定について照会・修正できます。

Endpoints

GET /api/v2/admin/orders/setting
PUT /api/v2/admin/orders/setting

Orders setting properties

Attribute	Description
shop_no Min : [1]	ショップ番号
claim_request	購入者によるキャンセル/交換/返品申込の使用設定 T:使用する F:使用しない
claim_request_type	購入者によるキャンセル/交換/返品申込時における表示項目の設定 claim_request項目がTの場合のみ確認が可能である。 S：基本申込項目の表示 D：詳細申込項目の表示
claim_request_button_exposure	キャンセル/交換/返品申込ボタンの表示範囲の設定 cancel_N10：キャンセル申込 - 商品準備中 cancel_N20：キャンセル申込 - 発送準備中 cancel_N22：キャンセル申込 - 配送保留 cancel_N21：キャンセル申込 - 出荷待ち exchange_N00：交換申込 - 入金前 exchange_N10：交換申込 - 商品準備中 exchange_N20：交換申込 - 発送準備中 exchange_N22：交換申込 - 配送保留 exchange_N21：交換申込 - 出荷待ち exchange_N30：交換申込 - 配送中 exchange_N40：交換申込 - 配送完了 return_N30：返品申込 - 配送中 return_N40：返品申込 - 配送完了
claim_request_button_date_type	キャンセル/交換/返品申込ボタンの表示開始日設定基準 order_date：注文完了日 shipend_date：配送完了日
claim_request_button_period	キャンセル/交換/返品申込ボタンの表示期間
stock_recover	キャンセル・返品時における数量の自動復元 T：基本設定 F：個別設定
stock_recover_base	キャンセル・返品時における数量の自動復元 - 基本設定 T：自動で復元する F：自動で復元しない M：復元の可否を確認する
stock_recover_individual	キャンセル・返品時における数量の自動復元 - 個別設定
claim_request_auto_accept	キャンセル/返品申込の自動受付設定 T:使用する F:使用しない
refund_benefit_setting	キャンセル/交換/返品受付時の割引/ポイント金額設定
refund_processing_setting	キャンセル・交換・返品受付時の返金受付処理設定 S：同時に処理する D：分けて処理する
use_product_prepare_status	商品準備中ステータスを使用するかどうか T：使用する F：使用しない
use_purchase_confirmation_button	購入確定ボタンを使用するかどうか T：使用する F：使用しない
purchase_confirmation_button_set_date	購入確定ボタンの適用日
use_purchase_confirmation_auto_check	購入確定自動チェックを使用するかどうか T：使用する F：使用しない
purchase_confirmation_auto_check_day	購入確定自動チェックの基準日
purchase_confirmation_auto_check_set_date	購入確定自動チェックの適用日
use_additional_fields	LIBSPECDATAUSE.ADDITIONAL.FIELDS T：使用する F：使用しない
customer_pays_return_shipping	LIBSPECDATACUSTOMER.RETURN.SHIPPING T：使用する F：使用しない
refund_bank_account_required	LIBSPECDATAREFUND.ACCOUNT.REQUIRED T：必須 F：任意

Retrieve Order Settings cafe24

GET /api/v2/admin/orders/setting

GET

キャンセル・返品時における数量の自動復元及びキャンセル/交換/返品受付時の割引/ポイント金額設定などの注文設定情報を照会します。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update Order settings cafe24

PUT /api/v2/admin/orders/setting

PUT

キャンセル/交換/返品受付時の割引/ポイント金額設定を変更することができます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
refund_benefit_setting	キャンセル/交換/返品受付時の割引/ポイント金額設定 F：合計金額を基準に表示 T：選択品目を基準に表示 U：割引金額自動計算(設定以降受け付けた注文から適用)
use_product_prepare_status	商品準備中ステータスを使用するかどうか T：使用する F：使用しない
use_purchase_confirmation_button	購入確定ボタンを使用するかどうか T：使用する F：使用しない
purchase_confirmation_button_set_date Date	購入確定ボタンの適用日
use_purchase_confirmation_auto_check	購入確定自動チェックを使用するかどうか T：使用する F：使用しない
purchase_confirmation_auto_check_day Min : [1]~Max : [30]	購入確定自動チェックの基準日
purchase_confirmation_auto_check_set_date Date	購入確定自動チェックの適用日

Request Copy

Response Copy

Orders status

Endpoints

GET /api/v2/admin/orders/status
PUT /api/v2/admin/orders/status

Orders status properties

Attribute	Description
status_name_id	注文ステータスの表記名の一連番号
status_type	注文ステータスのタイプ P：決済および配送 D：後払い C：キャンセル R：返品 E：交換 U：返金 O：その他
basic_name	注文ステータス名(基本表記)
custom_name	注文ステータス名(カスタム)
reservation_custom_name	予約注文の注文ステータス名(カスタム)

Retrieve order status displayed cafe24

GET /api/v2/admin/orders/status

GET

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update order status displayed cafe24

PUT /api/v2/admin/orders/status

PUT

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
status_name_id Required	注文ステータスの表記名の一連番号
custom_name	注文ステータス名(カスタム)
reservation_custom_name	予約注文の注文ステータス名(カスタム)

Request Copy

Response Copy

Payment setting

Endpoints

GET /api/v2/admin/payment/setting
PUT /api/v2/admin/payment/setting

Payment setting properties

Attribute	Description
shop_no	ショップ番号
use_escrow	エスクローを使用するかどうか
use_escrow_account_transfer	エスクロー(口座振込)を使用するかどうか
use_escrow_virtual_account	エスクロー(バーチャル口座)を使用するかどうか
pg_shipping_registration	決済代行会社(PG)への配送登録
purchase_protection_amount	取引安全保障サービスの適用対象(決済金額)

Retrieve Escrow Settings cafe24 youtube

GET /api/v2/admin/payment/setting

GET

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update Escrow Settings cafe24 youtube

PUT /api/v2/admin/payment/setting

PUT

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
use_escrow Required	エスクローを使用するかどうか T：使用する F：使用しない
use_escrow_account_transfer	エスクロー(口座振込)を使用するかどうか T：使用する F：使用しない
use_escrow_virtual_account	エスクロー(バーチャル口座)を使用するかどうか T：使用する F：使用しない
pg_shipping_registration	決済代行会社(PG)への配送登録 A：自動登録(毎日午後8時にデータ収集) M：手動登録

Request Copy

Response Copy

Paymentgateway

PG(Paymentgateway)を通じて、PGアプリの照会、登録、修正、削除ができます。

Endpoints

POST /api/v2/admin/paymentgateway
PUT /api/v2/admin/paymentgateway/{client_id}
DELETE /api/v2/admin/paymentgateway/{client_id}

Paymentgateway properties

Attribute	Description
shop_no	ショップ番号
partner_id	決済代行会社が発行した加盟店ID
client_id	アプリクライアントID
additional_information	追加情報
membership_fee_type	料金タイプ PRE : 前払い PAD : 後払い FREE : 無料
service_limit_type	サービスの制限 A:会員登録の有無(会員/非会員)による制限なし B:会員にのみ提供

Create a Payment Gateway cafe24

POST /api/v2/admin/paymentgateway

POST

ショップに新しいPGを登録することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
partner_id Required Max Length : [50]	決済代行会社が発行した加盟店ID
additional_information Array Max : [5]	追加情報
key 追加項目のキー value 追加項目の値
membership_fee_type Max Length : [4]	料金タイプ PRE : 前払い PAD : 後払い FREE : 無料
service_limit_type Max Length : [1]	サービスの制限 A:会員登録の有無(会員/非会員)による制限なし B:会員にのみ提供 DEFAULT A

Request Copy

Response Copy

Update a Payment Gateway cafe24

PUT /api/v2/admin/paymentgateway/{client_id}

PUT

ショップに登録されているPGを修正することができます。
決済代行会社が発行した加盟店ID、料金タイプなどの情報を修正することができます。
修正のためには、PGアプリのクライアントIDが必要です。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
client_id Required Max Length : [50]	アプリクライアントID
partner_id Max Length : [50]	決済代行会社が発行した加盟店ID
additional_information Array Max : [5]	追加情報
key 追加項目のキー value 追加項目の値
membership_fee_type Max Length : [4]	料金タイプ PRE : 前払い PAD : 後払い FREE : 無料
service_limit_type Max Length : [1]	サービスの制限 A:会員登録の有無(会員/非会員)による制限なし B:会員にのみ提供 DEFAULT A

Request Copy

Response Copy

Delete a Payment Gateway cafe24

DELETE /api/v2/admin/paymentgateway/{client_id}

DELETE

ショップに登録されているPGを削除することができます。
削除のためには、PGアプリのクライアントIDが必要です。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

client_id
Required

Max Length : [50]

アプリクライアントID

Request Copy

Response Copy

Paymentgateway paymentmethods

Endpoints

GET /api/v2/admin/paymentgateway/{client_id}/paymentmethods
POST /api/v2/admin/paymentgateway/{client_id}/paymentmethods
PUT /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}
DELETE /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

Paymentgateway paymentmethods properties

Attribute	Description
client_id	アプリクライアントID
payment_method_code	決済方法コード
payment_method	決済方法 card：クレジットカード tcash：口座振込 icash：バーチャル口座 cell：キャリア決済 cvs：コンビニ deferpay：後払い etc：その他
payment_method_name	決済方法名
payment_method_url	決済方法画像パス
available_shop_no	利用可能な越境ECショップ番号

Retrieve a list of Payment Gateway methods cafe24

GET /api/v2/admin/paymentgateway/{client_id}/paymentmethods

GET

アプリでインストールしたショッピングモールのPGに対して支援する決済手段を照会することができます。
決済手段コード、決済手段、決済手段名などを照会することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter	Description
client_id Required Max Length : [50]	アプリクライアントID

Request Copy

Response Copy

Create a Payment Gateway method cafe24

POST /api/v2/admin/paymentgateway/{client_id}/paymentmethods

POST

アプリでインストールしたショップのPGに対して決済手段を登録することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
client_id Required Max Length : [50]	アプリクライアントID
payment_method_code Required Max Length : [50]	決済方法コード
payment_method Required	決済方法 card：クレジットカード tcash：口座振込 icash：バーチャル口座 cell：キャリア決済 cvs：コンビニ deferpay：後払い etc：その他
payment_method_name Required Max Length : [50]	決済方法名
payment_method_url Required Max Length : [200]	決済方法画像パスサポート拡張子: 'png'、 'jpg'、 'jpeg'
available_shop_no	利用可能な越境ECショップ番号

Request Copy

Response Copy

Update a payment method of a Payment Gateway cafe24

PUT /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

PUT

アプリでインストールしたショップのPGに対して、特定の決済手段を修正することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
client_id Required Max Length : [50]	アプリクライアントID
payment_method_code Required Max Length : [50]	決済方法コード
payment_method	決済方法 card：クレジットカード tcash：口座振込 icash：バーチャル口座 cell：キャリア決済 cvs：コンビニ deferpay：後払い etc：その他
payment_method_name Max Length : [50]	決済方法名
payment_method_url Max Length : [200]	決済方法画像パスサポート拡張子: 'png'、 'jpg'、 'jpeg'
available_shop_no	利用可能な越境ECショップ番号

Request Copy

Response Copy

Delete a payment method of a Payment Gateway cafe24

DELETE /api/v2/admin/paymentgateway/{client_id}/paymentmethods/{payment_method_code}

DELETE

アプリでインストールしたショッピングモールのPGに対して特定の決済手段を削除することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40

要求スペック

Parameter	Description
client_id Required Max Length : [50]	アプリクライアントID
payment_method_code Required Max Length : [50]	決済方法コード

Request Copy

Response Copy

Paymentmethods

ショップの決済手段を照会することができます。

Endpoints

GET /api/v2/admin/paymentmethods

Paymentmethods properties

Attribute	Description
shop_no	ショップ番号
code	決済方法コード

Retrieve a list of payment methods cafe24

GET /api/v2/admin/paymentmethods

GET

ショップの決済手段を照会します。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Paymentmethods paymentproviders

Endpoints

GET /api/v2/admin/paymentmethods/{code}/paymentproviders
PUT /api/v2/admin/paymentmethods/{code}/paymentproviders/{name}

Paymentmethods paymentproviders properties

Attribute

Description

shop_no

ショップ番号

name

決済代行サービス名

display

決済方法を表示するかどうか

T：表示する
F：表示しない

Retrieve a list of providers by payment method cafe24

GET /api/v2/admin/paymentmethods/{code}/paymentproviders

GET

ショップの決済手段の情報を照会します。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
code Required	決済方法コード
name	決済代行サービス名
display	決済方法を表示するかどうか T：表示する F：表示しない

Request Copy

Response Copy

Update the display status of a payment method cafe24

PUT /api/v2/admin/paymentmethods/{code}/paymentproviders/{name}

PUT

ショップの決済手段を表示するかどうかを設定します。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
code Required	決済方法コード
name Required	決済代行サービス名
display Required	決済方法を表示するかどうか T：表示する F：表示しない

Request Copy

Response Copy

Points setting

ポイント設定(Points setting)は、ポイントの使用に必要な設定値を管理するための機能です。

Endpoints

GET /api/v2/admin/points/setting
PUT /api/v2/admin/points/setting

Points setting properties

Attribute	Description
shop_no	ショップ番号
point_issuance_standard	ポイントの付与基準(ステータス) C：配送完了 P：購入確定
payment_period	ポイント付与タイミングポイントの付与基準(ステータス)が「C：配送完了」の場合は「1/3/7/14/20」を入力できます。ポイントの付与基準(ステータス)が「P：購入確定」の場合は「0/1/3/7/14/20」を入力できます。
name	ポイントの名称
format	ポイントの表示タイプ
round_unit	ポイントの切り捨ての位 F：切り捨てしない 0.01：0.01の位 0.1：0.1の位 1：1の位 10：10の位 100：100の位 1000：1000の位
round_type	ポイントの切り捨て方法 A：切り捨て B：四捨五入 C：切り上げ
display_type	ポイントの表示形式 P：パーセント W：金額 WP：金額・パーセント PW：パーセント・金額
unusable_points_change_type	仮付与ポイントの切り替え基準の設定 M：注文した商品のうち1件の配送完了・購入確定時に付与 T：注文したすべての商品の配送完了・購入確定時に付与

Retrieve points settings cafe24

GET /api/v2/admin/points/setting

GET

ポイントの名称、ポイント付与タイミング、ポイントの切り捨ての位などのポイントの設定値を紹介することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update points settings cafe24

PUT /api/v2/admin/points/setting

PUT

ポイントの設定値を修正できます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
point_issuance_standard	ポイントの付与基準(ステータス) C：配送完了 P：購入確定
payment_period	ポイント付与タイミングポイントの付与基準(ステータス)が「C：配送完了」の場合は「1/3/7/14/20」を入力できます。ポイントの付与基準(ステータス)が「P：購入確定」の場合は「0/1/3/7/14/20」を入力できます。
name	ポイントの名称
format	ポイントの表示タイプ
round_unit	ポイントの切り捨ての位通貨単位が「KRW JPY TWD VND」である場合は「ポイントの端数処理」に「F 1 10 100 1000」を入力することができます。通貨単位が「KRW JPY TWD VND」以外である場合は「ポイントの端数処理」に「F 0.01 0.1 1 10」を入力することができます。
round_type	ポイントの切り捨て方法 A：切り捨て B：四捨五入 C：切り上げ
display_type	ポイントの表示形式 P：パーセント W：金額 WP：金額・パーセント PW：パーセント・金額
unusable_points_change_type	仮付与ポイントの切り替え基準の設定 M：注文した商品のうち1件の配送完了・購入確定時に付与 T：注文したすべての商品の配送完了・購入確定時に付与

Request Copy

Response Copy

Products setting

商品の設定(Products setting)は、商品の販売価格などの設定値に対する機能です。

Endpoints

GET /api/v2/admin/products/setting

Products setting properties

Attribute	Description
shop_no	ショップ番号
calculate_price_based_on	販売価格の計算基準 S：仕入れ価格に対する売上総利益率 A：販売価格に対する売上総利益率 P：基本ショップの販売価格 B：商品価格
price_rounding_unit	販売価格計算の切り捨ての位 F : 切り捨てしない -2 : 0.01の位 -1 : 0.1の位 0 : 1の位 1 : 10の位 2 : 100の位 3 : 1000の位
price_rounding_rule	販売価格計算の切り捨て方法 L : 切り捨て U : 四捨五入 C : 切り上げ

Retrieve product settings cafe24

GET /api/v2/admin/products/setting

GET

商品の販売価格の設定値を照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Redirects

特定URLで接続したとき、設定したURLにリダイレクトできるリソースです。

Endpoints

GET /api/v2/admin/redirects
POST /api/v2/admin/redirects
PUT /api/v2/admin/redirects/{id}
DELETE /api/v2/admin/redirects/{id}

Redirects properties

Attribute	Description
shop_no Min : [1] Max : [2147483647]	ショップ番号
id Max : [2147483647]	リダイレクトID
path	リダイレクトパス
target	対象位置

Retrieve a list of redirects cafe24

GET /api/v2/admin/redirects

GET

登録されたRedirect URLを照会することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	10

要求スペック

Parameter	Description
shop_no Min : [1] Max : [2147483647]	ショップ番号 DEFAULT 1
id Min : [1] Max : [2147483647]	リダイレクトID
path	リダイレクトパス
target	対象位置

Request Copy

Response Copy

Create a redirect cafe24

POST /api/v2/admin/redirects

POST

Redirect URLを登録することができます。
ショップ別に最大1000個の登録が可能です。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	10
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]
Max : [2147483647]

ショップ番号

DEFAULT 1

path
Required

リダイレクトパス

target
Required

対象位置

Request Copy

Response Copy

Update a redirect cafe24

PUT /api/v2/admin/redirects/{id}

PUT

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	10
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1] Max : [2147483647]	ショップ番号 DEFAULT 1
id Required Min : [1] Max : [2147483647]	リダイレクトID
path	リダイレクトパス
target	対象位置

Request Copy

Response Copy

Delete a redirect cafe24

DELETE /api/v2/admin/redirects/{id}

DELETE

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	10

要求スペック

Parameter

Description

shop_no

Min : [1]
Max : [2147483647]

ショップ番号

DEFAULT 1

id
Required

Min : [1]
Max : [2147483647]

リダイレクトID

Request Copy

Response Copy

Seo setting

SEO設定(Seo setting)は検索結果上位にショッピングモールが露出し訪問者が増加するようにする検索エンジン最適化(SEO)作業です。

Endpoints

GET /api/v2/admin/seo/setting
PUT /api/v2/admin/seo/setting

Seo setting properties

Attribute	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
common_page_title	共通ページのtitleタグ
common_page_meta_description	共通ページのdescriptionタグ
favicon URL	ファビコン
use_google_search_console	Googleサーチコンソールを使用するかどうか T：使用する F：使用しない
google_search_console	Googleサーチコンソール
use_naver_search_advisor	NAVER Search Advisorを使用するかどうか T：使用する F：使用しない
naver_search_advisor	NAVER Search Advisor
sns_share_image URL	SNSシェア画像
use_twitter_card	Twitterカードの使用 T：使用する F：使用しない
robots_text	検索ロボットのアクセス制限(PC)
mobile_robots_text	検索ロボットのアクセス制限(モバイル)
use_missing_page_redirect	存在しないページへのリンクに対してリダイレクションを行うかどうか(PC) T：使用する F：使用しない
missing_page_redirect_url	存在しないページへのリンクに対してリダイレクションを行う際のリダイレクト先(PC)
mobile_use_missing_page_redirect	存在しないページへのリンクに対してリダイレクションを行うかどうか(モバイル) T：使用する F：使用しない
mobile_missing_page_redirect_url	存在しないページへのリンクに対してリダイレクションを行う際のリダイレクト先(モバイル)
use_sitemap_auto_update	サイトマップを使用するかどうか T：使用する F：使用しない
use_rss	RSSフィードの使用 T：使用する F：使用しない
display_group	メインカテゴリ名
header_tag	Head HTML(PC)
footer_tag	Body HTML(PC)
mobile_header_tag	Head HTML(モバイル)
mobile_footer_tag	Body HTML(モバイル)

Retrieve SEO settings cafe24

GET /api/v2/admin/seo/setting

GET

ショッピングモールの検索エンジン最適化(SEO)設定を照会します。
メタタグ、ファビコン、検索ロボットへのアクセス制御などを照会できます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update store SEO settings cafe24

PUT /api/v2/admin/seo/setting

PUT

ショッピングモールの検索エンジン最適化(SEO)設定を修正します。
メタタグ、ファビコン、検索ロボットアクセス制御などを設定できます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
common_page_title	共通ページのtitleタグ
common_page_meta_description	共通ページのdescriptionタグ
favicon URL	ファビコン
use_google_search_console	Googleサーチコンソールを使用するかどうか T：使用する F：使用しない
google_search_console	Googleサーチコンソール
use_naver_search_advisor	NAVER Search Advisorを使用するかどうか T：使用する F：使用しない
naver_search_advisor	NAVER Search Advisor
sns_share_image URL	SNSシェア画像
use_twitter_card	Twitterカードの使用 T：使用する F：使用しない
robots_text	検索ロボットのアクセス制限(PC)
mobile_robots_text	検索ロボットのアクセス制限(モバイル)
use_missing_page_redirect	存在しないページへのリンクに対してリダイレクションを行うかどうか(PC) T：使用する F：使用しない
missing_page_redirect_url	存在しないページへのリンクに対してリダイレクションを行う際のリダイレクト先(PC)
mobile_use_missing_page_redirect	存在しないページへのリンクに対してリダイレクションを行うかどうか(モバイル) T：使用する F：使用しない
mobile_missing_page_redirect_url	存在しないページへのリンクに対してリダイレクションを行う際のリダイレクト先(モバイル)
use_sitemap_auto_update	サイトマップを使用するかどうか T：使用する F：使用しない
use_rss	RSSフィードの使用 T：使用する F：使用しない
display_group	メインカテゴリ名
header_tag	Head HTML(PC)
footer_tag	Body HTML(PC)
mobile_header_tag	Head HTML(モバイル)
mobile_footer_tag	Body HTML(モバイル)

Request Copy

Response Copy

Shippingmanager

配送管理者(Shippingmanager)は配送管理者活性化情報関連機能です。
配送管理者の使用情報を照会することができます。

Endpoints

GET /api/v2/admin/shippingmanager

Shippingmanager properties

Attribute	Description
use	配送マネージャー有効化情報

Retrieve activation information for Shipping Manager cafe24

GET /api/v2/admin/shippingmanager

GET

配送管理者の使用情報を照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

Request Copy

Response Copy

Shops

マルチショップ(Shops)は二つ以上のショップを運営している場合、生成したマルチショップの情報です。マルチショップは最大15個まで生成可能で、それぞれ異なる言語と通貨で生成できるため、多国語ショップの運営時に使えます。

Endpoints

GET /api/v2/admin/shops
GET /api/v2/admin/shops/{shop_no}

Shops properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
default	基本ショップの有無基本ショップの区分 T:基本ショップ F:基本ショップではない
shop_name Max Length : [255]	ショップ名当該マルチショッピングモールのショッピングモール名
business_country_code	事業者の拠点国・地域の国名コード business_country_code
language_code	言語コードマルチショップの基本言語コード ko_KR:韓国語 en_US:英語 zh_CN:中国語(簡体字) zh_TW:中国語(繁体字) ja_JP:日本語 vi_VN:ベトナム語
language_name Max Length : [20]	基本言語名マルチショップの基本言語名
currency_code Type : [A-Z]	決済通貨コードマルチショップの決済通貨コード South Korean Won (KRW) United States Dollar (USD) Japanese Yen (JPY) Chinese Yuan (CNY) Taiwan Dollar (TWD) Euro (EUR) Brazilian Real (BRL) Vietnamese Dong (VND)
currency_name	決済通貨名マルチショップの決済通貨名
reference_currency_code Type : [A-Z]	参照通貨コードマルチショップの参照通貨コード South Korean Won (KRW) United States Dollar (USD) Japanese Yen (JPY) Chinese Yuan (CNY)
reference_currency_name	参照通貨名マルチショップの参照通貨名
pc_skin_no	PCショップのメインデザイン番号マルチショップのPCショップの代表デザイン番号。現在ショップで使っているデザイン番号を示す。
mobile_skin_no	モバイルショップのメインデザイン番号モバイルショップの代表デザイン番号。現在ショップで使っているデザイン番号を示す。
base_domain Max Length : [63]	デフォルトドメイン基本的に提供されるドメイン
primary_domain Max Length : [63]	メインドメインマルチショップの代表ドメイン
slave_domain	接続ドメインショップにつながっているドメイン
active	有効/無効マルチショップを有効にするか無効にするかを設定 T:有効 F:無効
timezone	時間帯(タイムゾーン)
timezone_name	時間帯情報
date_format	日付の表示形式年/月/日 : YYYY-MM-DD 月/日/年 : MM-DD-YYYY 日/月/年 : DD-MM-YYYY
time_format	時刻の表示形式時/分/秒 : hh:mm:ss 時/分 : hh:mm
use_reference_currency	参照通貨を使用するかどうか
is_https_active	HTTPSの使用が有効かどうか T:有効 F:無効
site_connect	サイトへのアクセス設定
channel	チャネル

Retrieve a list of shops cafe24

GET /api/v2/admin/shops

GET

ショッピングモールに登録されたマルチショッピングモールの情報を一覧で照会することができます。
ショッピングモール名、基本ショップの有無、基本言語名などを照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

Request Copy

Response Copy

Retrieve a shop cafe24 youtube

GET /api/v2/admin/shops/{shop_no}

GET

ショッピングモールに登録されているマルチショッピングモールの情報を照会することができます。
ショッピングモール名、言語、決済貨幣情報などを照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no
Required

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

Request Copy

Response Copy

Sms setting

「Sms setting」はショップのSMS設定に関するリソースです。

Endpoints

GET /api/v2/admin/sms/setting

Sms setting properties

Attribute	Description
shop_no	ショップ番号
use_sms	SMS使用の有無 T: 使用する F: 使用しない
exclude_unsubscriber	受信拒否した人の送信除外設定 T : 除く F : 含む
default_sender	デフォルト送信番号
unsubscribe_phone	受信拒否番号(無料)
send_method	SMS送信方法 S: 短文分割送信 L: 長文送信(3件分差し引き)

Retrieve SMS settings cafe24 youtube

GET /api/v2/admin/sms/setting

GET

ショッピングモールのSMS設定を照会することができます。
**このAPIは韓国語ショッピングモールでのみ使用できます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Socials apple

アップルIDログイン(Socials apple)はショッピングモール利用顧客のアップルIDログインに関する機能です。
AppleIDログイン設定を使用するためには、まずAppleの開発者アカウントでSign in with Appleアプリ設定を完了する必要があります。

Endpoints

GET /api/v2/admin/socials/apple
PUT /api/v2/admin/socials/apple

Socials apple properties

Attribute	Description
shop_no	ショップ番号
use_apple_login	Appleログインの使用 T：使用する F：使用しない
client_id	client id
team_id	Team ID
key_id	Key ID
auth_key_file_name	Auth Key ファイル名
use_certification	Appleログイン本人認証の使用 T：使用する F：使用しない

GET /api/v2/admin/socials/apple

GET

ショッピングモール利用顧客のアップルログイン連動情報を照会します。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

PUT /api/v2/admin/socials/apple

PUT

ショッピングモール利用顧客のアップルログイン連動情報を修正します。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
use_apple_login	Appleログインの使用 T：使用する F：使用しない
client_id Max Length : [300]	Client ID アップル開発者センターのサービスID生成時に設定したIdentifier
team_id Max Length : [300]	Team ID アップル開発者センターのApp ID Prefix
key_id Max Length : [300]	Key ID アップル開発者センターのKey ID
auth_key_file_name Max Length : [30]	Auth Key ファイル名 App IDのKeyファイルで.p8ファイルのみ可能
auth_key_file_contents Max Length : [300]	Auth Key ファイル内容 .p8ファイルをテキストファイルに開いて改行せずに値を作成
use_certification	Appleログイン本人認証の使用 T：使用する F：使用しない

Request Copy

Response Copy

Socials kakaosync

カカオシンクSNS(Socials kakaosync)はショッピングモールのカカオシンクに対する設定を照会したり設定できる機能です。

Endpoints

GET /api/v2/admin/socials/kakaosync
PUT /api/v2/admin/socials/kakaosync

Socials kakaosync properties

Attribute	Description
shop_no	ショップ番号
use_kakaosync	Kakao Syncを使用するかどうか T : 使用する F : 使用しない
rest_api_key	REST API キー
javascript_key	JavaScript キー
auto_login	自動ログインの使用設定カカオウェブブラウザでショッピングモールを利用する際、カカオIDでログイン機能を使用するかどうか T : 使用する F : 使用しない
thirdparty_agree	個人情報の第三者提供に関する同意 T：同意する F：同意しない
thirdparty_agree_date	個人情報の第三者提供に同意した日付
use_signup_result_page	ショップ会員登録後の移動先 T：会員登録完了ページへ移動する F：会員登録を即時に完了する(会員登録完了ページなし)

Kakao Sync details cafe24

GET /api/v2/admin/socials/kakaosync

GET

ショッピングモールのカカオシンクの設定を照会することができます。
カカオシンクの使用有無、自動ログインの使用有無などを照会することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Kakao Sync updates cafe24

PUT /api/v2/admin/socials/kakaosync

PUT

カカオウェブブラウザに対する自動ログイン機能の使用可否を修正することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
rest_api_key Required Type : [a-zA-Z0-9] Max Length : [255]	REST API キー
javascript_key Required Type : [a-zA-Z0-9] Max Length : [255]	JavaScript キー
auto_login	自動ログインの使用設定カカオウェブブラウザでショッピングモールを利用する際、カカオIDでログイン機能を使用するかどうか T : 使用する F : 使用しない DEFAULT F
use_signup_result_page	ショップ会員登録後の移動先 T：会員登録完了ページへ移動する F：会員登録を即時に完了する(会員登録完了ページなし) DEFAULT F

Request Copy

Response Copy

Socials naverlogin

NAVERログイン設定情報を照会して設定情報を変更するリソースです。

Endpoints

GET /api/v2/admin/socials/naverlogin
PUT /api/v2/admin/socials/naverlogin

Socials naverlogin properties

Attribute	Description
shop_no	ショップ番号
use_naverlogin	Naverログインを使用するかどうか
client_id	クライアントID
client_secret	クライアントシークレットキー

GET /api/v2/admin/socials/naverlogin

GET

ショッピングモールにNAVERログイン設定可否を照会することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

PUT /api/v2/admin/socials/naverlogin

PUT

ショッピングモールに設定されたNAVERログイン情報を修正することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
use_naverlogin Required	Naverログインを使用するかどうか T：使用する F：使用しない
client_id Type : [a-zA-Z0-9_-] Max Length : [255]	クライアントID
client_secret Type : [a-zA-Z0-9_-] Max Length : [255]	クライアントシークレットキー

Request Copy

Response Copy

Store

商店(Store)はショップの名前、管理者情報、事業者登録番号、お客様サポートの電話番号など、ショップの基本的な情報を確認することができます。

Endpoints

GET /api/v2/admin/store

Store properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
shop_name	ショップ名当該店舗のショッピングモール名([ショッピングモール設定>基本設定>「ショッピングモール情報>マイショッピングモール情報」])
mall_id	ショップID ショップID。代表運営者のIDであると同時に、ショップのデフォルトドメイン(mallid.cafe24.com)に使う。
base_domain	デフォルトドメインショップの生成時に自動生成されるデフォルトドメインの情報。そのドメインでショップにアクセスできる。
primary_domain	メインドメインショップにつながっている代表ドメイン。代表ドメインがつながっている場合のみ表示される。
company_registration_no	事業者登録番号事業所が位置する国で発行されるショップの事業者登録番号
company_name	商号事業者登録時に登録した商号または法人名
president_name	代表者名事業者登録時に登録した代表者名
company_condition	業態事業者登録時に登録した業態
company_line	種目事業者登録時に登録した業種
country	事業所の国家情報事業所のある国名
country_code	国コード
zipcode	郵便番号事業所の郵便番号
address1	基本住所事業所住所(市区町村)
address2	詳細住所事業所住所(詳細住所)
phone	電話番号
fax	ファックス番号
email	メールアドレスオペレータが自動メールを受信した場合、受信するメールアドレス
notification_only_email	送信専用メールアドレス顧客と運営者に自動メールを送信する際に送信する人のメールアドレス
mall_url	ショップのアドレス
mail_order_sales_registration	通信販売業申告通信販売業として登録されているかどうかの表示 T:報告する F:報告しない
mail_order_sales_registration_number	通信販売申告番号
missing_report_reason_type	通信販売業未申告事由通信販売業登録をしていない場合、その事由
missing_report_reason	通信販売業未申告事由の詳細内容通信販売業の不登録事由が「その他」の場合、詳細内容
about_us_contents	会社紹介ショップに対する簡単な紹介。ショップの会社概要画面に表示される。
company_map_url	アクセスマップショップの簡単なマップ。ショップの会社概要画面に表示される。
customer_service_phone	お客様サポートの電話番号(相談/注文）ショップの画面に表示されるお客様サポートの相談電話番号
customer_service_email	お客様サポートのメールアドレス(相談/注文）ショップの画面に表示されるお客様サポートの相談メールアドレス
customer_service_fax	お客様サポートのファックス番号ショップの画面に表示されるお客様サポートのファックス番号
customer_service_sms	お客様サポートのSMS受信番号ショップの画面に表示されるお客様サポートのSMS受信番号
customer_service_hours	お客様サポートの運営時間ショップの画面に表示されるお客様サポートの運営時間
privacy_officer_name	個人情報保護責任者名ショップの画面に表示される個人情報保護責任者の名前
privacy_officer_position	個人情報保護責任者の地位
privacy_officer_department	個人情報保護責任者の部署
privacy_officer_phone	個人情報保護責任者の連絡先ショップの画面に表示される個人情報保護責任者の電話番号
privacy_officer_email	個人情報保護責任者のメールアドレスショップの画面に表示される個人情報保護責任者のメールアドレス
contact_us_mobile	サービスに関するお問い合わせのモバイル表示設定サービスに関するお問合せの内容をMobileに表示するかどうかを設定 T:表示する F:表示しない
contact_us_contents	サービスに関するお問い合わせの内容商品詳細ページに表示されるサービスに関するお問合わせの内容
sales_product_categories	販売商品カテゴリ会員登録・ショップ開設の直後に入力することになる「販売商品カテゴリ」の情報を照会できます。 (2023年4月以降に会員登録・開設されたショップのみ照会が可能です。) Undecided : まだ決まっていません Apparel : ファッション FashionAccessories : ファッション雑貨 LuxuryGoods : ハイブランド品 BrandApparel : ブランド衣類 BrandAccessories : ブランド雑貨 Food_Beverage : 食品/フード Lifestyle_HealthCare : 日用品/ヘルスケア Furniture_HomeDecor : 家具/インテリア Beauty_PersonalCare : 化粧品/コスメ/美容 Maternity_BabyProducts : マタニティ/ベビー/キッズ Digital_HomeAppliances : デジタル/家電 CarAccessories : 車 Rentals : レンタル Sports_Leisure : スポーツ/アウトドア CD_DVD : 音楽/DVD Books : ブックス Travels_Services : レジャー/トラベル Used_Refurbished_Exhibition : 中古品/メーカー再生品/展示品 Others : その他/サービス

Retrieve store details cafe24 youtube

GET /api/v2/admin/store

GET

ショッピングモールの情報を照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

Request Copy

Response Copy

Store accounts

商店口座(Store accounts)はショッピングモールの振込情報に対する機能です。

Endpoints

GET /api/v2/admin/store/accounts

Store accounts properties

Attribute	Description
shop_no	ショップ番号
bank_account_id	振込銀行のID
bank_name	銀行名
bank_code Max Length : [50]	銀行コード bank_code
bank_account_no	口座番号
bank_account_holder	口座名義
use_account	使用設定 T:使用する F:使用しない

Retrieve a list of store bank accounts cafe24

GET /api/v2/admin/store/accounts

GET

お店の振込口座情報をリストで照会することができます。
銀行名、銀行コード、口座番号などを照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Subscription shipments setting

定期配送設定(Subscription shipments setting)は、定期決済によって行われる定期配送に関する機能です。
定期配送設定を通じてショッピングモールの定期配送商品を設定したり定期配送商品を照会することができます。
定期配送機能を使用するには、まず定期配送サービスが申請されている必要があります。
定期配送サービスのお申し込みはアドミンで承ります。

Endpoints

GET /api/v2/admin/subscription/shipments/setting
POST /api/v2/admin/subscription/shipments/setting
PUT /api/v2/admin/subscription/shipments/setting/{subscription_no}
DELETE /api/v2/admin/subscription/shipments/setting/{subscription_no}

Subscription shipments setting properties

Attribute	Description
shop_no	ショップ番号
subscription_no	定期購入対象商品設定番号
subscription_shipments_name	定期購入対象商品設定名
product_binding_type	定期購入対象商品設定 A : 全商品 P : 特定の商品 C : 商品カテゴリ
one_time_purchase	一般購入オプション提供の有無 T : 提供する F : 提供しない
product_list	適用商品
category_list	適用カテゴリ
use_discount	定期購入割引使用の有無 T:使用する F:使用しない
discount_value_unit	割引基準 P : 割引率 W : 割引金額
discount_values	割引値
related_purchase_quantity	購入数と関係するかどうか T : 購入数による F : 購入数関係なし
subscription_shipments_cycle_type	定期購入周期オプション提供の有無 T:使用する F:使用しない
subscription_shipments_cycle	定期購入周期 1W : 1週 2W : 2週 3W : 3週 4W : 4週 1M : 1ヶ月 2M : 2ヶ月 3M : 3ヶ月 4M : 4ヶ月 5M : 5ヶ月 6M : 6ヶ月 1Y : 1年
subscription_shipments_count_type	定期購入(配送)回数の設定 T：使用する F：使用しない
subscription_shipments_count	定期購入(配送)の実施希望回数 2：2回 3：3回 4：4回 6：6回 8：8回 10：10回 12：12回
use_order_price_condition	割引詳細設定を割引金額に設定したかどうか T:使用する F:使用しない
order_price_greater_than	金額割引の基準として設定した金額
include_regional_shipping_rate	地域別送料の設定状況 T:含む F:含まない
shipments_start_date Min : [1] Max : [30]	定期購入開始日の設定
change_option	オプションの変更が可能かどうか T:使用する F:使用しない

Retrieve a list of subscription products cafe24

GET /api/v2/admin/subscription/shipments/setting

GET

設定された定期配送商品に関する情報をリストで照会することが、
定期配送商品設定番号、設定名、設定値などを照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

subscription_no

定期購入対象商品設定番号

Request Copy

Response Copy

Create a subscription payment rule cafe24

POST /api/v2/admin/subscription/shipments/setting

POST

定期配送商品の設定ができます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
subscription_shipments_name Required Max Length : [255]	定期購入対象商品設定名
product_binding_type Required	定期購入対象商品設定 A : 全商品 P : 特定の商品 C : 商品カテゴリ
one_time_purchase	一般購入オプション提供の有無 T : 提供する F : 提供しない DEFAULT T
product_list Array Max : [10000]	適用商品
category_list Array Max : [1000]	適用カテゴリ
use_discount Required	定期購入割引使用の有無 T:使用する F:使用しない
discount_value_unit	割引基準 P : 割引率 W : 割引金額
discount_values Array Max : [40]	割引値 discount_value_unitがPの場合、最大値:100 discount_value_unitがWの場合、最大値:9999999999999999
delivery_cycle Required 適用タイミング discount_amount Required 割引値
related_purchase_quantity	購入数と関係するかどうか T : 購入数による F : 購入数関係なし
subscription_shipments_cycle_type Required	定期購入周期オプション提供の有無 T:使用する F:使用しない
subscription_shipments_cycle Required	定期購入周期 1W : 1週 2W : 2週 3W : 3週 4W : 4週 1M : 1ヶ月 2M : 2ヶ月 3M : 3ヶ月 4M : 4ヶ月 5M : 5ヶ月 6M : 6ヶ月 1Y : 1年
subscription_shipments_count_type	定期購入(配送)回数の設定 T：使用する F：使用しない
subscription_shipments_count Array Max : [7]	定期購入(配送)の実施希望回数 2：2回 3：3回 4：4回 6：6回 8：8回 10：10回 12：12回
use_order_price_condition Required	割引詳細設定を割引金額に設定したかどうか T:使用する F:使用しない
order_price_greater_than Max : [99999999999999]	金額割引の基準として設定した金額
include_regional_shipping_rate	地域別送料の設定状況 T:含む F:含まない
shipments_start_date Min : [1] Max : [30]	定期購入開始日の設定 DEFAULT 3
change_option	オプションの変更が可能かどうか T:使用する F:使用しない DEFAULT F

Request Copy

Response Copy

Update subscription products cafe24

PUT /api/v2/admin/subscription/shipments/setting/{subscription_no}

PUT

設定された定期配送商品の定期配送設定を修正できます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
subscription_no Required	定期購入対象商品設定番号
subscription_shipments_name Max Length : [255]	定期購入対象商品設定名
product_binding_type	定期購入対象商品設定 A : 全商品 P : 特定の商品 C : 商品カテゴリ
one_time_purchase	一般購入オプション提供の有無 T : 提供する F : 提供しない
product_list Array Max : [10000]	適用商品
category_list Array Max : [1000]	適用カテゴリ
use_discount	定期購入割引使用の有無 T:使用する F:使用しない
discount_value_unit	割引基準 P : 割引率 W : 割引金額
discount_values Array Max : [40]	割引値
delivery_cycle Required 適用タイミング discount_amount Required 割引値
related_purchase_quantity	購入数と関係するかどうか T : 購入数による F : 購入数関係なし
subscription_shipments_cycle_type	定期購入周期オプション提供の有無 T:使用する F:使用しない
subscription_shipments_cycle	定期購入周期 1W : 1週 2W : 2週 3W : 3週 4W : 4週 1M : 1ヶ月 2M : 2ヶ月 3M : 3ヶ月 4M : 4ヶ月 5M : 5ヶ月 6M : 6ヶ月 1Y : 1年
subscription_shipments_count_type	定期購入(配送)回数の設定 T：使用する F：使用しない
subscription_shipments_count Array Max : [7]	定期購入(配送)の実施希望回数 2：2回 3：3回 4：4回 6：6回 8：8回 10：10回 12：12回
use_order_price_condition	割引詳細設定を割引金額に設定したかどうか T:使用する F:使用しない
order_price_greater_than Max : [99999999999999]	金額割引の基準として設定した金額
include_regional_shipping_rate	地域別送料の設定状況 T:含む F:含まない
shipments_start_date Min : [1] Max : [30]	定期購入開始日の設定
change_option	オプションの変更が可能かどうか T:使用する F:使用しない

Request Copy

Response Copy

Delete subscription products cafe24

DELETE /api/v2/admin/subscription/shipments/setting/{subscription_no}

DELETE

設定された定期配送商品の定期配送設定を解除できます。

基本スペック

Property	Description
SCOPE	ショップの投稿権限 (mall.write_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

subscription_no
Required

定期購入対象商品設定番号

Request Copy

Response Copy

Taxmanager

税金管理者(MSA)の有効化情報関連の機能です。

Endpoints

GET /api/v2/admin/taxmanager

Taxmanager properties

Attribute	Description
use	税金マネージャー有効化情報

Retrieve activation information for Tax Manager cafe24

GET /api/v2/admin/taxmanager

GET

税金管理者の使用情報を照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

Request Copy

Response Copy

Users

運営者(Users)はショップの代表管理者と共にショップの運営ができる運営者です。
副運営者は代表管理者が付与した権限を持ってショップを運営することができます。
ショップに登録されている運営者のリストを閲覧したり、特定の運営者を照会することができます。

Endpoints

GET /api/v2/admin/users
GET /api/v2/admin/users/{user_id}

Users properties

Attribute	Description
user_id	運営者ID 運営者のID
user_name	運営者名運営者の名前
phone Phone Number	電話番号運営者の電話番号
email Email	メールアドレス運営者のメールアドレス
ip_restriction_type	IPアクセス制限 IPアクセス制限使用の設定 A:使用する F:使用しない
admin_type	運営者区分代表運営者か副運営者かの区分 P:代表運営者 A:副運営者
last_login_date	直近のアクセス日時
shop_no Min : [1]	ショップ番号
nick_name	運営者ニックネーム運営者のニックネーム
nick_name_icon_type	ニックネームアイコンのタイプニックネームアイコンの登録。直接登録またはサンプル登録ができる。 D:直接アイコン登録 S:サンプルアイコン登録
nick_name_icon_url	ニックネームアイコンのURL
board_exposure_setting	掲示板の表示設定
memo	メモ
available	使用設定 T:使用する F:使用しない
multishop_access_authority	ショップのアクセス権限 T:許容する F:許容しない
menu_access_authority	メニューのアクセス権限
detail_authority_setting	詳細の閲覧設定
ip_access_restriction	IPアクセス制限
access_permission	アクセス許可の権限 T:アクセス許容時間の設定と関係なくいつでも管理画面へのアクセスを許容する F:使用しない

Retrieve a list of admin users cafe24 youtube

GET /api/v2/admin/users

GET

ショップに登録された運営者のリストを閲覧できます。
運営者のID、運営者名、メールアドレス、電話番号などを照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

search_type

検索タイプ

member_id:会員ID
name:お名前

keyword

検索キーワード

admin_type

運営者区分

P:代表運営者
A:副運営者

Request Copy

Response Copy

Retrieve admin user details cafe24 youtube

GET /api/v2/admin/users/{user_id}

GET

ショップに登録されている特定の運営者を照会することができます。
運営者名、電話番号、メールアドレスなどを照会することができます。

基本スペック

Property	Description
SCOPE	ショップの閲覧権限 (mall.read_store)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

user_id

運営者ID

運営者または副運営者のID

Request Copy

Response Copy

Bundleproducts

セット商品(Bunldeproducts)は、複数の商品をまとめて販売する商品を意味します。
セット商品は、商品をそれぞれ注文するよりも安く購入できるように、追加割引を設定できます。
セット商品のご注文時は、1商品のようにご注文を管理できます。
セット商品リソースでは、セット商品のみを照会したり、セット商品の登録/修正/削除を行うことができます。

Endpoints

GET /api/v2/admin/bundleproducts
GET /api/v2/admin/bundleproducts/{product_no}
POST /api/v2/admin/bundleproducts
PUT /api/v2/admin/bundleproducts/{product_no}
DELETE /api/v2/admin/bundleproducts/{product_no}

Bundleproducts properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
product_no	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
product_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	商品コードシステムにより商品に付与されたコード。ショップ内で商品コードは重複しない。
bundle_product_components	セット商品の構成商品情報
custom_product_code Max Length : [40]	独自商品コードユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。
product_name Max Length : [250]	商品名商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。HTMLを使って入力できる。
eng_product_name Max Length : [250]	商品名(英語) 商品の英語名。海外配送などに使用可能
supply_product_name Max Length : [250]	供給会社の商品名供給会社が登録した商品の名前。供給会社が商品を区分するために任意で入力することができる。商品名には影響しない。
internal_product_name Max Length : [50]	管理用商品名
model_name Max Length : [100]	モデル名商品のモデル名
display	表示ステータス商品をショップに表示するかどうかを設定。商品をショップに表示すると設定した商品カテゴリとトップページに表示される。商品がショップに表示されないとショップの画面に表示されないためアクセスができず、商品を購入することもできない。 T:表示する F:表示しない
selling	販売ステータス商品をショップで販売するかどうかを設定。商品が表示されている状況で販売を中止する場合、ショップに商品は表示されるが「在庫切れ」と表示されるため、商品を購入することができない。商品のステータスが「表示しない」の場合、ステータスが「販売」であっても商品にアクセスできないため、購入できない。 T:販売する F:販売しない
product_condition	商品ステータス販売する商品のステータス表示 N：新品 B：返品品 R：在庫品 U：中古品 E：展示品 F：メーカー再生品 S：キズあり品
product_used_month Max : [2147483647]	中古品の使用月数
summary_description Max Length : [255]	商品要約説明商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で表示されるように設定可能
product_tag	商品検索キーワード検索または分類のために商品に入力する検索キーワード情報(ハッシュタグ)
price_content Max Length : [20]	販売価格の代替メッセージ商品の価格の代わりに表示されるメッセージ。在庫切れや商品が一時的に販売できない場合に使用
buy_limit_by_product	購入制限の個別設定の有無 T: 使用する F: 使用しない
buy_limit_type	購入制限商品を購入することができる会員情報の表示 N : 会員のみ購入可能 + 購入ボタン非表示 M : 会員のみ購入可能 + 購入ボタン表示 F : 購入制限なし O : 指定された会員のみ購入可能 + 購入ボタン非表示 D : 指定された会員のみ購入可能 + 購入ボタン表示
buy_group_list	購入できる会員ランク
buy_member_id_list	購入可能な会員ID
repurchase_restriction	再購入制限 T : 再購入不可 F : 制限しない
single_purchase_restriction	単独購入制限 T : 単独購入不可 F : 制限しない
points_by_product	ポイントの個別設定を使用するかどうか F : 基本設定使用 T : 個別設定
points_setting_by_payment	決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 C : 決済方法によるポイント
points_amount	ポイント設定情報
except_member_points	会員ランク別の追加ポイントを付与しない T：会員ランク追加付与除外を設定する F：会員ランク追加付与除外を設定しない
adult_certification	年齢認証年齢認証（確認）が必要な商品かどうかの有無。年齢認証が必要な商品を購入するためには本人認証（確認）をしなければならない。 T:使用する F:使用しない
detail_image	詳細画像商品詳細画面に表示される商品画像
list_image	一覧画像商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像
tiny_image	縮小一覧画像最近チェックした商品領域に表示される商品の一覧画像
small_image	縮小画像商品詳細画面の下部に表示される商品の一覧画像
use_naverpay	Naver Payの使用有無 T:使用する F:使用しない
naverpay_type	Naver Pay販売タイプ C : Naver Pay + ショップ同時販売商品 O : Naver Pay 専用商品
icon_show_period	アイコンの表示期間商品に設定したアイコンが表示される期間
icon Array Max : [5]	アイコン商品に表示されるアイコン。商品販売をアピールするための目的で使用可能
hscode	HSコード海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。 ※ HSコード : 世界貿易機関(WTO)及び世界関税機構(WCO)が貿易統計及び関税分類の目的で輸出入商品を数字コードでカテゴリ化したもので、輸入時の税金賦課と輸出品の統制及び統計のための分類法
product_weight	商品重量商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。
product_material	商品素材商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。
created_date	作成日商品が生成された日時
updated_date	修正日商品が修正された日時
english_product_material	英語商品素材商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。
cloth_fabric	生地商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) knit:編物(knit)
list_icon	おすすめ / 在庫切れ / 新着商品アイコン表示の設定おすすめ、在庫切れ、新着商品アイコンをリストに表示するかどうかを設定 ※ 在庫切れアイコン ● 商品が在庫切れ状態であることを知らせるアイコン ● 在庫管理及び在庫切れ機能を使う商品を対象に在庫がない場合に表示 ※ おすすめ、新着商品アイコン ● 商品カテゴリやトップページのおすすめ商品、新着商品エリアに表示されている商品の場合、設定によって関連アイコンを表示する。 ※ アイコン表示の設定位置 : [ショップ設定 > 商品設定 > '商品基本設定 > 商品管理の設定 > 商品アイコンの設定']
sold_out	在庫切れ状況 T:在庫切れ F:在庫切れではない
discountprice	商品の割引価格リソース
decorationimages	デコ画像リソース
benefits	特典リソース
additionalimages Array Max : [20]	追加の画像リソース
exposure_limit_type	商品表示制限の範囲 A：すべての顧客に表示 M：会員にのみ表示
exposure_group_list	商品表示対象の会員ランク
bundle_product_sales	セット割引情報
category	カテゴリ番号商品が表示されている商品カテゴリ
project_no	キャンペーン番号
description	商品詳細説明商品に対するより詳細な情報が含まれている説明。HTMLを使って入力できる。
mobile_description	モバイル商品詳細説明入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。
separated_mobile_description	モバイル用登録 T : 直接登録 F : 商品説明と同一
additional_image Array Max : [20]	追加画像商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。特定商品詳細検索APIでしか確認できない。
payment_info	商品決済ガイド商品の決済方法に対する案内文。HTMLを使って入力できる。
shipping_info	商品配送ガイド商品の配送方法に対するガイド。HTMLを使って入力できる。
exchange_info	交換・返品ガイド商品の交換・返品方法に対する説明。HTMLを使って入力できる。
service_info	サービスに関するお問い合わせ/ガイド製品の事後顧客サービス方法に関するガイド。HTMLを使って入力できる。
country_hscode	国別HSコード海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。国別にHSコードの標準が異なるため、各国に合ったコードを入力しなければならない。
simple_description	商品簡略説明商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で表示されるように設定可能
shipping_calculation	配送の計算タイプ A：自動計算 M：手動計算
shipping_fee_by_product	個別配送の設定送料を商品別に払わせるか共通送料を払わせるかを設定個別送料を使わない場合は共通送料を使う。 T:使用する F:使用しない
shipping_method	配送方法 (個別送料を使う場合)配送手段及び方法 01:宅配 02:速達郵便 03:一般郵便 04:直接配送 05:クイック配送 06:その他 07:貨物配送 08:店舗受取 09:配送不要
prepaid_shipping_fee	送料前払いの設定 shipping_calculationがA（自動計算）の場合はnullに返却。 C:着払い P:前払い B:前払い/着払い
shipping_period	配送期間 (個別送料を使う場合)商品の配送時に平均的にかかる配送期間
shipping_scope	配送情報国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ設定 > 配送設定 > '配送基本設定 > 送料の設定 > 個別送料設定']で商品別の個別送料設定が「使用しない」の場合は設定できない。 A:国内配送 C:海外配送 B:国内/海外配送
shipping_area Max Length : [255]	配送地域 (個別送料を使う場合)商品の配送ができる地域
shipping_fee_type	送料タイプ (個別送料を利用する場合)商品の送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
shipping_rates	範囲別送料個別送料を使う場合、商品の個別送料 shipping_fee_typeがR、Nの場合、配列内でshipping_feeを定義して送料を設定することができる。 shipping_fee_typeがM、D、W、Cの場合、配列内で次のように定義して送料区間を設定することができる。 shipping_rates_min:送料区間の開始基準 shipping_rates_max:送料区間の終了基準 shipping_fee:送料
clearance_category_eng	海外通関用商品区分(英語名) 海外通関時に通関用商品区分情報として使う情報。日本語名の入力時に入力した区分名が自動翻訳された項目翻訳された英語名が海外送状の商品名に含まれて送られる。
clearance_category_kor	海外通関用商品区分(日本語名) 海外通関時に通関用商品区分情報として使う情報。英語に自動翻訳されて海外送状の商品名情報に含まれて送られる。
clearance_category_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	海外通関コード
additional_information	追加項目 [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で追加した追加項目基本的な商品情報以外に追加で表示する項目がある場合に追加して使う。
image_upload_type	画像アップロードタイプ画像をアップロードする時、画像のアップロードタイプ「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード ※ EC Globalは、FTPをサポートしていないため、Cは使用できません A:メイン画像登録 B:個別画像登録 C:ウェブFTP登録
main	メイン表示商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。
relational_product Array Max : [200]	関連商品似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。
memos	メモリソース
hits	商品閲覧数リソース
seo	商品Seo リソース
tags	商品タグリソース

Retrieve a list of bundles cafe24 youtube

GET /api/v2/admin/bundleproducts

GET

セット商品をリストで照会することができます。
商品コード、自社商品コード、商品名などを照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter	Description
discountprice embed	商品の割引価格リソース
decorationimages embed	デコ画像リソース
benefits embed	特典リソース
additionalimages embed	追加の画像リソース
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no	商品番号検索したい商品の番号 ,(コンマ)で複数の件を検索することができる。
display	表示ステータス T:表示する F:表示しない
selling	販売ステータス T:販売する F:販売しない
product_code	商品コード ,(コンマ)で複数の件を検索することができる。
product_tag	商品検索キーワード ,(コンマ)で複数の件を検索することができる。
custom_product_code	独自商品コード ,(コンマ)で複数の件を検索することができる。
product_name	商品名 ,(コンマ)で複数の件を検索することができる。
eng_product_name	商品名(英語) ,(コンマ)で複数の件を検索することができる。
supply_product_name	供給会社の商品名 ,(コンマ)で複数の件を検索することができる。
internal_product_name	管理用商品名 ,(コンマ)で複数の件を検索することができる。
model_name	モデル名 ,(コンマ)で複数の件を検索することができる。
price_min	商品販売価格の検索最小値
price_max	商品販売価格の検索最大値
created_start_date	商品登録日の検索開始日
created_end_date	商品登録日の検索終了日
updated_start_date	商品修正日の検索開始日
updated_end_date	商品修正日の検索終了日
category	カテゴリ番号
category_unapplied	未適用カテゴリを検索 T:未適用カテゴリを検索
include_sub_category	下位カテゴリを含めて検索 T:含む
product_weight	商品重量
additional_information_key	追加項目の検索条件キー
additional_information_value	追加項目の検索条件値
sort	並べ替え順序の値 created_date:登録日 updated_date:修正日 product_name:商品名
order	並べ替え順序 asc:並べ替え(昇順) desc:並べ替え(降順)
offset Max : [8000]	検索結果の開始位置検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Request Copy

Response Copy

Retrieve a bundle cafe24 youtube

GET /api/v2/admin/bundleproducts/{product_no}

GET

特定のセット商品を詳細に照会することができます。
セット割引情報などの詳細情報を追加でご確認いただけます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号検索したい商品の番号
discountprice embed	商品の割引価格リソース
decorationimages embed	デコ画像リソース
benefits embed	特典リソース
memos embed	メモリソース
hits embed	商品閲覧数リソース
seo embed	商品Seo リソース
tags embed	商品タグリソース
additionalimages embed	追加の画像リソース

Request Copy

Response Copy

Create a bundle cafe24 youtube

POST /api/v2/admin/bundleproducts

POST

セット商品を作成できます。
構成商品を束ねた価格に対して追加でセット商品割引を適用することができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
product_name Required Max Length : [250]	商品名
bundle_product_components Required	セット商品の構成商品情報
product_no Required セット商品の構成商品番号 purchase_quantity Required セット商品の購入数
bundle_product_sales Required	セット割引情報
discount_value Required セット商品の割引価格 discount_type Required セット商品の割引タイプ P : パーセント、 V : 定額 discount_round_unit セット商品割引の切り捨ての位 F : 切り捨てしない、 -2 : 0.01の位、 -1 : 0.1の位、 0 : 1の位、 1 : 10の位、 2 : 100の位、 3 : 1000の位 discount_round_type セット商品の切り捨て方法 F : 切り捨て、 R : 四捨五入、 C : 切り上げ
display	表示ステータス * Youtube shopping をご利用の場合は提供されません T:表示する F:表示しない DEFAULT F
add_category_no	追加カテゴリ番号 * Youtube shopping をご利用の場合は提供されませんカテゴリ番号を使って表示したいカテゴリに商品登録
category_no Required カテゴリ番号 recommend おすすめ商品カテゴリ登録 T：おすすめ商品を登録する、F：おすすめ商品を登録しない DEFAULT F new 新着商品カテゴリ登録 T：新着商品を登録する、F：新着商品を登録しない DEFAULT F
custom_product_code Max Length : [40]	独自商品コードユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。
eng_product_name Max Length : [250]	商品名(英語) * Youtube shopping をご利用の場合は提供されません
supply_product_name Max Length : [250]	供給会社の商品名
internal_product_name Max Length : [50]	管理用商品名 * Youtube shopping をご利用の場合は提供されません
model_name Max Length : [100]	モデル名 * Youtube shopping をご利用の場合は提供されません
use_naverpay	Naver Payの使用有無 * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない
naverpay_type	Naver Pay販売タイプ * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : Naver Pay + ショップ同時販売商品 O : Naver Pay 専用商品
product_weight Min : [0]~Max : [999999.99]	商品重量
description	商品詳細説明
mobile_description	モバイル商品詳細説明入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。
summary_description Max Length : [255]	商品要約説明
simple_description	商品簡略説明 * Youtube shopping をご利用の場合は提供されません
product_tag Array Max : [100]	商品検索キーワード * Youtube shopping をご利用の場合は提供されませんショッピングキュレーション使用時 - 配列の最大サイズ: [100]
payment_info	商品決済ガイド
shipping_info	商品配送ガイド
exchange_info	交換・返品ガイド
service_info	サービスに関するお問い合わせ/ガイド
icon Array Max : [5]	アイコン * Youtube shopping をご利用の場合は提供されません
hscode Max Length : [20]	HSコード配送情報(shipping_scope)がC(海外配送)の場合、必須入力。 shipping_calculationがA（自動計算）の場合、必須入力ではありません。
shipping_scope	配送情報国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ設定 > 配送設定 > '配送基本設定 > 送料の設定 > 個別送料設定']で商品別の個別送料設定が「使用しない」の場合は設定できない。 ※ショッピングモールがEC Globalモールの場合は必須で入力する必要がある。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A:国内配送 C:海外配送 B:国内/海外配送 DEFAULT A
shipping_method	配送方法 01:宅配 02:速達郵便 03:一般郵便 04:直接配送 05:クイック配送 06:その他 07:貨物配送 08:店舗受取 09:配送不要 DEFAULT 01
shipping_fee_by_product	個別配送の設定 T:個別配送 F:基本配送 DEFAULT F
shipping_area Max Length : [255]	配送地域
shipping_period Array Max : [2]	配送期間
minimum 期間設定の最小値 DEFAULT 1 maximum 期間設定の最大値 DEFAULT 7
shipping_fee_type	送料タイプ個別送料を使う場合、商品の送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金 DEFAULT T
shipping_rates Array Max : [200]	送料金額個別送料を使う場合、商品の個別送料 shipping_fee_typeがR、Nの場合、配列内でshipping_feeを定義して送料を設定することができる。 shipping_fee_typeがM、D、W、Cの場合、配列内で次のように定義して送料区間を設定することができる。 shipping_rates_min:送料区間の開始基準 shipping_rates_max:送料区間の終了基準 shipping_fee:送料
prepaid_shipping_fee	送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C:着払い P:前払い B:前払い/着払い DEFAULT B
clearance_category_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	海外通関コード配送情報(shipping_scope)がC(海外配送)の場合、必須入力。 shipping_calculationがA（自動計算）の場合、必須入力ではありません。 clearance_category_code
detail_image	詳細画像
list_image	一覧画像 * Youtube shopping をご利用の場合は提供されません
tiny_image	縮小一覧画像 * Youtube shopping をご利用の場合は提供されません
small_image	縮小画像 * Youtube shopping をご利用の場合は提供されません
image_upload_type	画像アップロードタイプ * Youtube shopping をご利用の場合は提供されません画像をアップロードする時、画像のアップロードタイプ「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード ※ EC Globalは、FTPをサポートしていないため、Cは使用できません A:メイン画像登録 B:個別画像登録 C:ウェブFTP登録 DEFAULT A
additional_information	追加項目 * Youtube shopping をご利用の場合は提供されません
key Required 追加項目のキー value 追加項目の値
price_content Max Length : [20]	販売価格の代替メッセージ * Youtube shopping をご利用の場合は提供されません
buy_limit_by_product	購入制限の個別設定の有無 * Youtube shopping をご利用の場合は提供されません T: 使用する F: 使用しない DEFAULT F
buy_limit_type	購入制限 * Youtube shopping をご利用の場合は提供されません N : 会員のみ購入可能 + 購入ボタン非表示 M : 会員のみ購入可能 + 購入ボタン表示 F : 購入制限なし O : 指定された会員のみ購入可能 + 購入ボタン非表示 D : 指定された会員のみ購入可能 + 購入ボタン表示 DEFAULT F
buy_group_list	購入できる会員ランク * Youtube shopping をご利用の場合は提供されません
buy_member_id_list	購入可能な会員ID * Youtube shopping をご利用の場合は提供されません
repurchase_restriction	再購入制限 * Youtube shopping をご利用の場合は提供されません T : 再購入不可 F : 制限しない DEFAULT F
single_purchase_restriction	単独購入制限 * Youtube shopping をご利用の場合は提供されません T : 単独購入不可 F : 制限しない DEFAULT F
points_by_product	ポイントの個別設定を使用するかどうか * Youtube shopping をご利用の場合は提供されません F : 基本設定使用 T : 個別設定 DEFAULT F
points_setting_by_payment	決済方法別にポイントを設定するかどうか * Youtube shopping をご利用の場合は提供されません B : 基本ポイント設定を使用 C : 決済方法によるポイント
points_amount	ポイント設定情報 * Youtube shopping をご利用の場合は提供されません
except_member_points	会員ランク別の追加ポイントを付与しない * Youtube shopping をご利用の場合は提供されません T：会員ランク追加付与除外を設定する F：会員ランク追加付与除外を設定しない DEFAULT F
main	メイン表示 * Youtube shopping をご利用の場合は提供されません商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。
relational_product Array Max : [200]	関連商品 * Youtube shopping をご利用の場合は提供されません似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。
product_no Required 商品番号 interrelated Required 関連商品の相互登録 T：相互登録、F：単独登録
product_material	商品素材 * Youtube shopping をご利用の場合は提供されません商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。
english_product_material	英語商品素材 * Youtube shopping をご利用の場合は提供されません商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。
cloth_fabric	生地 * Youtube shopping をご利用の場合は提供されません商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) knit:編物(knit)
additional_image	追加画像商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。追加画像は、最大20個まで登録可能できる。
adult_certification	年齢認証成人認証が必要な商品かどうか。成人認証が必要な商品である購買のためには本人認証を経なければならない。 [ショッピングモール設定>顧客設定>「会員ポリシー設定>会員関連設定>会員登録および本人認証設定」]で成人認証使用時に購買遮断設定が使用されることにより成人認証が適用される。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない DEFAULT F
exposure_limit_type	商品表示制限の範囲 * Youtube shopping をご利用の場合は提供されません A：すべての顧客に表示 M：会員にのみ表示 DEFAULT A
exposure_group_list	商品表示対象の会員ランク * Youtube shopping をご利用の場合は提供されません

Request Copy

Response Copy

Update a bundle cafe24 youtube

PUT /api/v2/admin/bundleproducts/{product_no}

PUT

特定のセット商品の情報を修正できます。
商品名、セット商品の構成商品情報、セット割引情報などを修正できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
product_name Max Length : [250]	商品名
bundle_product_components	セット商品の構成商品情報
product_no Required セット商品の構成商品番号 purchase_quantity Required セット商品の購入数
bundle_product_sales	セット割引情報
discount_value Required セット商品の割引価格 discount_type Required セット商品の割引タイプ P : パーセント、 V : 定額 discount_round_unit セット商品割引の切り捨ての位 F : 切り捨てしない、 -2 : 0.01の位、 -1 : 0.1の位、 0 : 1の位、 1 : 10の位、 2 : 100の位、 3 : 1000の位 discount_round_type セット商品の切り捨て方法 F : 切り捨て、 R : 四捨五入、 C : 切り上げ
display	表示ステータス * Youtube shopping をご利用の場合は提供されません商品をショップに表示するかどうかを変更 T:表示する F:表示しない
product_condition	商品ステータス N：新品 B：返品品 R：在庫品 U：中古品 E：展示品 F：メーカー再生品 S：キズあり品
product_used_month Max : [2147483647]	中古品の使用月数商品状態（product_condition）が中古である場合、該当商品の使用月数
add_category_no	追加カテゴリ番号 * Youtube shopping をご利用の場合は提供されません商品カテゴリ番号を入力してその商品に特定の商品カテゴリを追加登録
category_no Required カテゴリ番号 recommend おすすめ商品カテゴリ登録 T：おすすめ商品を登録する、F：おすすめ商品を登録しない DEFAULT F new 新着商品カテゴリ登録 T：新着商品を登録する、F：新着商品を登録しない DEFAULT F
delete_category_no	削除されたカテゴリ番号 * Youtube shopping をご利用の場合は提供されません商品カテゴリ番号を入力してその商品から特定の商品カテゴリを削除
custom_product_code Max Length : [40]	独自商品コードユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。
eng_product_name Max Length : [250]	商品名(英語) * Youtube shopping をご利用の場合は提供されません
supply_product_name Max Length : [250]	供給会社の商品名
internal_product_name Max Length : [50]	管理用商品名 * Youtube shopping をご利用の場合は提供されません
model_name Max Length : [100]	モデル名 * Youtube shopping をご利用の場合は提供されません
use_naverpay	Naver Payの使用有無 * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない
naverpay_type	Naver Pay販売タイプ * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : Naver Pay + ショップ同時販売商品 O : Naver Pay 専用商品
product_weight Min : [0]~Max : [999999.99]	商品重量
description	商品詳細説明
mobile_description	モバイル商品詳細説明入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。
summary_description Max Length : [255]	商品要約説明
simple_description	商品簡略説明 * Youtube shopping をご利用の場合は提供されません
product_tag Array Max : [100]	商品検索キーワード * Youtube shopping をご利用の場合は提供されませんショッピングキュレーション使用時 - 配列の最大サイズ: [100]
payment_info	商品決済ガイド
shipping_info	商品配送ガイド
exchange_info	交換・返品ガイド
service_info	サービスに関するお問い合わせ/ガイド
icon Array Max : [5]	アイコン * Youtube shopping をご利用の場合は提供されません
use_icon_exposure_term	表示期間の使用の有無 * Youtube shopping をご利用の場合は提供されません T:使用する F:使用しない
icon_exposure_begin_datetime	表示期間の開始日 * Youtube shopping をご利用の場合は提供されません
icon_exposure_end_datetime	表示期間の終了日 * Youtube shopping をご利用の場合は提供されません
hscode Max Length : [20]	HSコード配送情報(shipping_scope)がC(海外配送)の場合、必須入力。 shipping_calculationがA（自動計算）の場合、必須入力ではありません。
shipping_scope	配送情報国内のみ配送が可能な商品なのか、海外にも配送が可能な商品なのかを表示。 [ショッピングモール設定 > 配送設定 > 「配送ポリシー設定 > 送料設定 > 個別配送料設定」] で商品別個別配送料設定が使用されていない場合は設定不可。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A:国内配送 C:海外配送 B:国内/海外配送
prepaid_shipping_fee	送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C:着払い P:前払い B:前払い/着払い
shipping_method	配送方法 01:宅配 02:速達郵便 03:一般郵便 04:直接配送 05:クイック配送 06:その他 07:貨物配送 08:店舗受取 09:配送不要
shipping_fee_by_product	個別配送の設定 T:個別配送 F:基本配送
shipping_area Max Length : [255]	配送地域
shipping_period Array Max : [2]	配送期間
minimum 期間設定の最小値 DEFAULT 1 maximum 期間設定の最大値 DEFAULT 7
shipping_fee_type	送料タイプ個別送料を使う場合、商品の送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
shipping_rates	送料金額個別送料を使う場合、商品の個別送料 shipping_fee_typeがR、Nの場合、配列内でshipping_feeを定義して送料を設定することができる。 shipping_fee_typeがM、D、W、Cの場合、配列内で次のように定義して送料区間を設定することができる。 shipping_rates_min:送料区間の開始基準 shipping_rates_max:送料区間の終了基準 shipping_fee:送料
clearance_category_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	海外通関コード配送情報(shipping_scope)がC(海外配送)の場合、必須入力。 shipping_calculationがA（自動計算）の場合、必須入力ではありません。 clearance_category_code
detail_image	詳細画像
list_image	一覧画像 * Youtube shopping をご利用の場合は提供されません
tiny_image	縮小一覧画像 * Youtube shopping をご利用の場合は提供されません
small_image	縮小画像 * Youtube shopping をご利用の場合は提供されません
image_upload_type	画像アップロードタイプ * Youtube shopping をご利用の場合は提供されません画像をアップロードする時、画像のアップロードタイプ「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード ※ EC Globalは、FTPをサポートしていないため、Cは使用できません A:メイン画像登録 B:個別画像登録 C:ウェブFTP登録
additional_information	追加項目 * Youtube shopping をご利用の場合は提供されません
key Required 追加項目のキー value 追加項目の値
price_content Max Length : [20]	販売価格の代替メッセージ * Youtube shopping をご利用の場合は提供されません
buy_limit_by_product	購入制限の個別設定の有無 * Youtube shopping をご利用の場合は提供されません T: 使用する F: 使用しない
buy_limit_type	購入制限 * Youtube shopping をご利用の場合は提供されません N : 会員のみ購入可能 + 購入ボタン非表示 M : 会員のみ購入可能 + 購入ボタン表示 F : 購入制限なし O : 指定された会員のみ購入可能 + 購入ボタン非表示 D : 指定された会員のみ購入可能 + 購入ボタン表示
buy_group_list	購入できる会員ランク * Youtube shopping をご利用の場合は提供されません
buy_member_id_list	購入可能な会員ID * Youtube shopping をご利用の場合は提供されません
repurchase_restriction	再購入制限 * Youtube shopping をご利用の場合は提供されません T : 再購入不可 F : 制限しない
single_purchase_restriction	単独購入制限 * Youtube shopping をご利用の場合は提供されません T : 単独購入不可 F : 制限しない
points_by_product	ポイントの個別設定を使用するかどうか * Youtube shopping をご利用の場合は提供されません F : 基本設定使用 T : 個別設定
points_setting_by_payment	決済方法別にポイントを設定するかどうか * Youtube shopping をご利用の場合は提供されません B : 基本ポイント設定を使用 C : 決済方法によるポイント
points_amount	ポイント設定情報 * Youtube shopping をご利用の場合は提供されません
except_member_points	会員ランク別の追加ポイントを付与しない * Youtube shopping をご利用の場合は提供されません T：会員ランク追加付与除外を設定する F：会員ランク追加付与除外を設定しない
main	メイン表示 * Youtube shopping をご利用の場合は提供されません商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。
relational_product Array Max : [200]	関連商品 * Youtube shopping をご利用の場合は提供されません似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。
product_no 商品番号 interrelated Required 関連商品の相互登録 T：相互登録、F：単独登録
product_material	商品素材 * Youtube shopping をご利用の場合は提供されません商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。
english_product_material	英語商品素材 * Youtube shopping をご利用の場合は提供されません商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。
cloth_fabric	生地 * Youtube shopping をご利用の場合は提供されません商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) knit:編物(knit)
additional_image	追加画像商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。追加画像は、最大20個まで登録可能できる。
adult_certification	年齢認証成人認証が必要な商品かどうか。成人認証が必要な商品である購買のためには本人認証を経なければならない。 [ショッピングモール設定>顧客設定>「会員ポリシー設定>会員関連設定>会員登録および本人認証設定」]で成人認証使用時に購買遮断設定が使用されることにより成人認証が適用される。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない
exposure_limit_type	商品表示制限の範囲 * Youtube shopping をご利用の場合は提供されません A：すべての顧客に表示 M：会員にのみ表示
exposure_group_list	商品表示対象の会員ランク * Youtube shopping をご利用の場合は提供されません

Request Copy

Response Copy

Delete a bundle cafe24 youtube

DELETE /api/v2/admin/bundleproducts/{product_no}

DELETE

特定のセット商品を削除できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

Request Copy

Response Copy

Categories products

Endpoints

GET /api/v2/admin/categories/{category_no}/products
GET /api/v2/admin/categories/{category_no}/products/count
POST /api/v2/admin/categories/{category_no}/products
PUT /api/v2/admin/categories/{category_no}/products
DELETE /api/v2/admin/categories/{category_no}/products/{product_no}

Categories products properties

Attribute	Description
shop_no	ショップ番号
product_no	商品番号
sequence_no	表示順序
auto_sort	「自動並べ替え」設定の有無
sold_out	在庫切れ状況
fixed_sort	「固定」設定の有無
not_for_sale	「販売しない」設定の有無
display_group Min : [1]~Max : [3]	商品カテゴリの詳細 1: 一般商品 2: おすすめ商品 3: 新着商品 DEFAULT 1
sequence Min : [1]~Max : [999998]	表示順序

Retrieve a list of products by category cafe24 youtube

GET /api/v2/admin/categories/{category_no}/products

GET

特定のカテゴリーに割り当てられた商品をリストで照会することができます。
商品は同時に複数のカテゴリーに割り当てることができます。
商品番号、表示順、販売可否などを照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
category_no Required	カテゴリ番号
display_group Required Min : [1]~Max : [3]	商品カテゴリの詳細 1: 一般商品 2: おすすめ商品 3: 新着商品
limit Min : [1]~Max : [50000]	検索結果の最大件数 DEFAULT 50000

Request Copy

Response Copy

Retrieve a count of products by category cafe24 youtube

GET /api/v2/admin/categories/{category_no}/products/count

GET

特定のカテゴリに割り当てられた商品の数を照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

category_no
Required

カテゴリ番号

display_group
Required

Min : [1]~Max : [3]

商品カテゴリの詳細

1: 一般商品
2: おすすめ商品
3: 新着商品

Request Copy

Response Copy

Add products to a category cafe24 youtube

POST /api/v2/admin/categories/{category_no}/products

POST

特定のカテゴリに商品を割り当てることができます。
商品は同時に複数のカテゴリーに割り当てることができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

category_no
Required

カテゴリ番号

display_group

Min : [1]~Max : [3]

商品カテゴリの詳細

1: 一般商品
2: おすすめ商品
3: 新着商品

DEFAULT 1

product_no
Required

商品番号

Request Copy

Response Copy

Update a product in product category cafe24 youtube

PUT /api/v2/admin/categories/{category_no}/products

PUT

特定のカテゴリに割り当てられた商品を修正できます。
商品自体を修正するわけではなく、整列や固定などに対する設定値を修正することができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
category_no Required	カテゴリ番号
display_group Required Min : [1]~Max : [3]	商品カテゴリの詳細 1: 一般商品 2: おすすめ商品 3: 新着商品
product_no Required	商品番号
sequence Min : [1]~Max : [999999]	表示順序
auto_sort	「自動並べ替え」設定の有無 T：自動並べ替えを使用する F：自動並べ替えを使用しない
fixed_sort	「固定」設定の有無 T：表示順位固定を使用する F：表示順位固定を使用しない

Request Copy

Response Copy

Delete a product by category cafe24 youtube

DELETE /api/v2/admin/categories/{category_no}/products/{product_no}

DELETE

特定のカテゴリに割り当てられた商品を削除できます。
該当商品はカテゴリーでのみ削除されるだけで、実際に商品自体が削除されるわけではありません。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

category_no
Required

カテゴリ番号

product_no
Required

商品番号

display_group

Min : [1]~Max : [3]

商品カテゴリの詳細

一般商品エリアで「表示しない」に処理する場合、おすすめ商品/新着商品エリアでも同時に非表示処理されます。

1: 一般商品
2: おすすめ商品
3: 新着商品

DEFAULT 1

Request Copy

Response Copy

Mains products

Endpoints

GET /api/v2/admin/mains/{display_group}/products
GET /api/v2/admin/mains/{display_group}/products/count
POST /api/v2/admin/mains/{display_group}/products
PUT /api/v2/admin/mains/{display_group}/products
DELETE /api/v2/admin/mains/{display_group}/products/{product_no}

Mains products properties

Attribute	Description
shop_no	ショップ番号
product_no	商品番号
product_name	商品名
fixed_sort	「固定」設定の有無

Retrieve a list of products in main category cafe24 youtube

GET /api/v2/admin/mains/{display_group}/products

GET

特定のメイン分類に割り当てられた商品をリストで照会することができます。
商品番号、商品名、固定可否などを照会することができます。
商品は同時に複数のメイン分類に割り当てられます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

display_group
Required

メインカテゴリ番号

Request Copy

Response Copy

Retrieve a count of products in main category cafe24 youtube

GET /api/v2/admin/mains/{display_group}/products/count

GET

特定のメイン分類に割り当てられた商品の数を照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

display_group
Required

メインカテゴリ番号

Request Copy

Response Copy

Set main category products cafe24 youtube

POST /api/v2/admin/mains/{display_group}/products

POST

特定のメイン分類に商品を割り当てることができます。
商品は同時に複数のカテゴリーに割り当てることができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
shop_no	ショップ番号 DEFAULT 1
display_group Required	メインカテゴリ番号
product_no Required	商品番号

Request Copy

Response Copy

Update fixed sorting of products in main category cafe24 youtube

PUT /api/v2/admin/mains/{display_group}/products

PUT

特定のメイン分類に割り当てられた商品を修正できます。
商品自体を修正するのではなく、陳列順位の固定などに対する設定値を修正することができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
shop_no	ショップ番号 DEFAULT 1
display_group Required	メインカテゴリ番号
product_no Required	商品番号要求した商品番号の順序で表示順位が指定される。
fix_product_no	表示順位固定商品の番号表示順位を固定したい商品番号を指定

Request Copy

Response Copy

Delete a product in main category cafe24 youtube

DELETE /api/v2/admin/mains/{display_group}/products/{product_no}

DELETE

特定のメイン分類に割り当てられた商品を削除できます。
該当商品はメイン分類でのみ削除されるだけで、実際に商品自体が削除されるわけではありません。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

display_group
Required

メインカテゴリ番号

product_no
Required

商品番号

Request Copy

Response Copy

Products

商品(Products)はショップで販売されるものやサービスを意味します。商品は多様な色やサイズのオプションによって品目に分けられます。

商品は下記のようなResourceを下位Resourceとして持っています。
● 品目(Variants)
● 商品メモ(Memos)
● SEO(SEO)
● 商品照会数(Hits)

Endpoints

GET /api/v2/admin/products
GET /api/v2/admin/products/count
GET /api/v2/admin/products/{product_no}
POST /api/v2/admin/products
PUT /api/v2/admin/products/{product_no}
DELETE /api/v2/admin/products/{product_no}

Products properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
product_no	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
product_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	商品コードシステムにより商品に付与されたコード。ショップ内で商品コードは重複しない。
custom_product_code Max Length : [40]	独自商品コードユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。
product_name Max Length : [250]	商品名商品の名前。商品名は商品を区分する一番基礎的な情報で、検索情報になる。HTMLを使って入力できる。
eng_product_name Max Length : [250]	商品名(英語) 商品の英語名。海外配送などに使用可能
supply_product_name Max Length : [250]	供給会社の商品名供給会社が登録した商品の名前。供給会社が商品を区分するために任意で入力することができる。商品名には影響しない。
internal_product_name Max Length : [50]	管理用商品名
model_name Max Length : [100]	モデル名商品のモデル名
price_excluding_tax	商品価格(税別)
price	商品販売価格商品の販売価格。クーポン及び特典を適用する前の価格商品登録時にはマルチショップに同じ価格で登録するが、ショップ別に異なる価格を入力したい場合は商品修正を通じて異なる価格を入力することができる。 ※ 販売価格 = [ 原価 + (原価 * 売上総利益率) + 追加金額 ]
retail_price	商品の定価市場で販売される消費者価格。ショップの価格をアピールする比較の目的で使う。
supply_price	商品仕入れ価格商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。
display	表示ステータス商品をショップに表示するかどうかを設定。商品をショップに表示すると設定した商品カテゴリとトップページに表示される。商品がショップに表示されないとショップの画面に表示されないためアクセスができず、商品を購入することもできない。 T:表示する F:表示しない
selling	販売ステータス商品をショップで販売するかどうかを設定。商品が表示されている状況で販売を中止する場合、ショップに商品は表示されるが「在庫切れ」と表示されるため、商品を購入することができない。商品のステータスが「表示しない」の場合、ステータスが「販売」であっても商品にアクセスできないため、購入できない。 T:販売する F:販売しない
product_condition	商品ステータス販売する商品のステータス表示 N：新品 B：返品品 R：在庫品 U：中古品 E：展示品 F：メーカー再生品 S：キズあり品
product_used_month Max : [2147483647]	中古品の使用月数
summary_description Max Length : [255]	商品要約説明商品に対する要約情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で表示されるように設定可能
product_tag Array Max : [50]	商品検索キーワードショッピングキュレーション使用時 - 配列の最大サイズ: [100]
margin_rate Min : [-999.99]~Max : [999.99]	売上総利益率商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。
tax_calculation	税金の計算タイプ A：自動計算 M：手動計算
tax_type	課税区分商品の課税情報消費税込みのタイプ課税商品 = 税金が賦課される商品免税商品 = 税金が免除される商品。加工されていない農/水/畜産物、練炭、図書類、保険、女性専用などの商品で、課税事業者として登録しなければならない。零細商品 = 付加価値税が0%適用される輸出向け外貨稼ぎ商品 A:課税商品 B:免税商品 C:ゼロ税率商品
tax_rate Min : [0]~Max : [100]	税率
price_content Max Length : [20]	販売価格の代替メッセージ商品の価格の代わりに表示されるメッセージ。在庫切れや商品が一時的に販売できない場合に使用
buy_limit_by_product	購入制限の個別設定の有無 T: 使用する F: 使用しない
buy_limit_type	購入制限商品を購入することができる会員情報の表示 N : 会員のみ購入可能 + 購入ボタン非表示 M : 会員のみ購入可能 + 購入ボタン表示 F : 購入制限なし O : 指定された会員のみ購入可能 + 購入ボタン非表示 D : 指定された会員のみ購入可能 + 購入ボタン表示
buy_group_list	購入できる会員ランク
buy_member_id_list	購入可能な会員ID
repurchase_restriction	再購入制限 T : 再購入不可 F : 制限しない
single_purchase_restriction	単独購入制限 T : 単独購入不可 F : 制限しない
buy_unit_type	購入単位のタイプ商品の購入単位を1個以上に設定した場合、その購入単位を品目単位にするか、商品単位にするかの設定 P:商品基準 O:品目基準
buy_unit	購入単位購入できる最小限の単位表示例)購入注文単位が3個の場合、3個、6個、9個単位で購入可能
order_quantity_limit_type	注文数量の制限基準商品の注文数量を制限する場合、制限基準を品目単位にするか、商品単位にするかの設定 P:商品基準 O:品目基準
minimum_quantity Max : [2147483647]	最小注文数量注文可能な最小限の注文数量。注文数量未満は購入できない。
maximum_quantity Max : [2147483647]	最大注文数量注文可能な最大限の注文数量。注文数量を超過して購入することはできない。最大受注数量が「制限なし」の場合は「0」と表示されます。
points_by_product	ポイントの個別設定を使用するかどうか F : 基本設定使用 T : 個別設定
points_setting_by_payment	決済方法別にポイントを設定するかどうか B : 基本ポイント設定を使用 C : 決済方法によるポイント
points_amount	ポイント設定情報
except_member_points	会員ランク別の追加ポイントを付与しない T：会員ランク追加付与除外を設定する F：会員ランク追加付与除外を設定しない
product_volume	商品体積情報
adult_certification	年齢認証年齢認証（確認）が必要な商品かどうかの有無。年齢認証が必要な商品を購入するためには本人認証（確認）をしなければならない。 T:使用する F:使用しない
detail_image	詳細画像商品詳細画面に表示される商品画像
list_image	一覧画像商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像
tiny_image	縮小一覧画像最近チェックした商品領域に表示される商品の一覧画像
small_image	縮小画像商品詳細画面の下部に表示される商品の一覧画像
use_naverpay	Naver Payの使用有無 T:使用する F:使用しない
naverpay_type	Naver Pay販売タイプ C : Naver Pay + ショップ同時販売商品 O : Naver Pay 専用商品
manufacturer_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	メーカーコードメーカーを登録すると自動生成されるコードで、商品に特定メーカーを指定する時に使用入力しない場合は独自製作(M0000000)使用
trend_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	トレンドコードトレンドを登録すると自動生成されるコードで、商品に特定トレンドを指定する時に使う。入力しない場合は基本トレンド(T0000000)使用
brand_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	ブランドコードブランドを登録すると自動生成されるコードで、商品に特定ブランドを指定する場合に使う。入力しない場合は独自ブランド(B0000000)使用
supplier_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	供給会社のコード供給会社を登録すると自動生成されるコードで、商品に特定供給会社を指定する時に使う。
made_date	製造日商品を製造した製造日
release_date	発売開始日商品が市場で発売開始された日
expiration_date Array Max : [2]	有効期間商品を正常に使える期間。商品券やチケットのような無形商品、食品や化粧品のような有形商品の有効期間を表示主に商品券やチケットのような無形商品に使われ、その無形商品の有効期間を表示。
origin_classification	原産国国内/国外/その他 F:国内 T:海外 E:その他
origin_place_no	原産国番号 List all Origin APIで原産国を検索して原産国番号を入力 origin_classificationがF(国内)の場合、海外の有無(foreign)が「F」の原産国のみ入力可能 origin_classificationがT(海外)の場合、海外の有無(foreign)が「T」の原産国のみ入力可能
origin_place_value Max Length : [30]	原産国のその他の情報原産国が「その他(1800)」の場合、原産国として入力可能な情報
made_in_code	国名(原産国)コード
icon_show_period	アイコンの表示期間商品に設定したアイコンが表示される期間
icon Array Max : [5]	アイコン商品に表示されるアイコン。商品販売をアピールするための目的で使用可能
hscode	HSコード海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。 ※ HSコード : 世界貿易機関(WTO)及び世界関税機構(WCO)が貿易統計及び関税分類の目的で輸出入商品を数字コードでカテゴリ化したもので、輸入時の税金賦課と輸出品の統制及び統計のための分類法
product_weight	商品重量商品の全体重量(kg)。配送のために商品の重量だけでなく、ボックスと包装の重量も含めた重量を記載する必要がある。
product_material	商品素材商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。
created_date	作成日商品が生成された日時
updated_date	修正日商品が修正された日時
english_product_material	英語商品素材商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。
cloth_fabric	生地商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) knit:編物(knit)
list_icon	おすすめ / 在庫切れ / 新着商品アイコン表示の設定おすすめ、在庫切れ、新着商品アイコンをリストに表示するかどうかを設定 ※ 在庫切れアイコン ● 商品が在庫切れ状態であることを知らせるアイコン ● 在庫管理及び在庫切れ機能を使う商品を対象に在庫がない場合に表示 ※ おすすめ、新着商品アイコン ● 商品カテゴリやトップページのおすすめ商品、新着商品エリアに表示されている商品の場合、設定によって関連アイコンを表示する。 ※ アイコン表示の設定位置 : [ショップ設定 > 商品設定 > '商品基本設定 > 商品管理の設定 > 商品アイコンの設定']
approve_status	承認申込結果 N:承認申込(新規商品) E:承認申込(商品修正) C:承認完了 R:承認拒否 I:検収進行中 Empty Value:申込履歴がない
classification_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	独自カテゴリコード独自カテゴリを登録すると自動生成されるコードで、商品に特定の独自カテゴリを指定する場合に使う。入力しない場合は基本の独自カテゴリ(C000000A)使用
sold_out	在庫切れ状況 T:在庫切れ F:在庫切れではない
additional_price	販売価格の追加金額
discountprice	商品の割引価格リソース
decorationimages	デコ画像リソース
benefits	特典リソース
options	商品オプションリソース Embedパラメーターを使って照会することができる。
variants	品目リソース Embedパラメーターを使って照会することができる。
clearance_category_eng	海外通関用商品区分(英語名) 海外通関時に通関用商品区分情報として使う情報。日本語名の入力時に入力した区分名が自動翻訳された項目翻訳された英語名が海外送状の商品名に含まれて送られる。
clearance_category_kor	海外通関用商品区分(日本語名) 海外通関時に通関用商品区分情報として使う情報。英語に自動翻訳されて海外送状の商品名情報に含まれて送られる。
clearance_category_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	海外通関コード clearance_category_code
additionalimages	追加の画像リソース
exposure_limit_type	商品表示制限の範囲 A：すべての顧客に表示 M：会員にのみ表示
exposure_group_list	商品表示対象の会員ランク
set_product_type	セット商品のタイプ C:一般セット S:分離型セット
use_kakaopay	カカオページを使用するかどうか T:使用する F:使用しない
shipping_fee_by_product	個別配送の設定送料を商品別に払わせるか共通送料を払わせるかを設定個別送料を使わない場合は共通送料を使う。 T:使用する F:使用しない
shipping_fee_type	送料タイプ (個別送料を利用する場合)商品の送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
main	メイン表示商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。
channeldiscountprices	商品の割引価格リソース
market_sync	ECモール連携を使用するかどうか T:使用する F:使用しない
memos	メモリソース Embedパラメーターを使って照会することができる。
hits	商品閲覧数リソース Embedパラメーターを使って照会することができる。
seo	商品Seo リソース Embedパラメーターを使って照会することができる。
category	カテゴリ番号商品が表示されている商品カテゴリ
project_no	キャンペーン番号
description	商品詳細説明商品に対するより詳細な情報が含まれている説明。HTMLを使って入力できる。
mobile_description	モバイル商品詳細説明入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。
separated_mobile_description	モバイル用登録 T : 直接登録 F : 商品説明と同一
translated_description	商品詳細説明の翻訳情報
payment_info	商品決済ガイド商品の決済方法に対する案内文。HTMLを使って入力できる。
shipping_info	商品配送ガイド商品の配送方法に対するガイド。HTMLを使って入力できる。
exchange_info	交換・返品ガイド商品の交換・返品方法に対する説明。HTMLを使って入力できる。
service_info	サービスに関するお問い合わせ/ガイド製品の事後顧客サービス方法に関するガイド。HTMLを使って入力できる。
product_tax_type_text	消費税表示メッセージ [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定 > 追加設定'] の販売価格の消費税表示メッセージで設定したメッセージ表示
country_hscode	国別HSコード海外配送時に関税を賦課するために使うHSコード。国際配送時に通関のために必ず正確な番号を入力しなければならない。国別にHSコードの標準が異なるため、各国に合ったコードを入力しなければならない。
simple_description	商品簡略説明商品に対する簡単な情報。商品表示画面に表示できる説明。HTMLを使って入力できる。 [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で表示されるように設定可能
tags	商品タグリソース Embedパラメーターを使って照会することができる。
has_option	オプション使用の設定商品にオプションが付いているかの有無。オプションのある商品はサイズや色など多様な選択肢を提供する。 T:オプションを使用する F:オプションを使用しない
soldout_message Max Length : [250]	在庫切れ表示メッセージ
option_type	オプション構成方式オプションを使う場合、オプションのタイプを表示 ● 組合型 : オプション名を基準にオプション値を組み合わせることができる。 ● 商品連動型 : オプション表示方式は組合型と似ているが、必須オプションと選択オプションを選択することができる。オプションの組合せを制限なく生成することができる。 ● 独立選択型 : 独立的な複数の条件をそれぞれ選択できるオプションで、オプション値が組み合わせられずそれぞれの品目として生成される。 C:組み合わせ一体選択型 S:組み合わせ分離選択型 E:商品連携型 F:独立選択型
shipping_calculation	配送の計算タイプ A：自動計算 M：手動計算
shipping_method	配送方法 (個別送料を使う場合)配送手段及び方法 01:宅配 02:速達郵便 03:一般郵便 04:直接配送 05:クイック配送 06:その他 07:貨物配送 08:店舗受取 09:配送不要
prepaid_shipping_fee	送料前払いの設定 shipping_calculationがA（自動計算）の場合はnullに返却。 C:着払い P:前払い B:前払い/着払い
shipping_period	配送期間 (個別送料を使う場合)商品の配送時に平均的にかかる配送期間
shipping_scope	配送情報国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ設定 > 配送設定 > '配送基本設定 > 送料の設定 > 個別送料設定']で商品別の個別送料設定が「使用しない」の場合は設定できない。 A:国内配送 C:海外配送 B:国内/海外配送
shipping_area Max Length : [255]	配送地域 (個別送料を使う場合)商品の配送ができる地域
shipping_rates	範囲別送料個別送料を使う場合、商品の個別送料 shipping_fee_typeがR、Nの場合、配列内でshipping_feeを定義して送料を設定することができる。 shipping_fee_typeがM、D、W、Cの場合、配列内で次のように定義して送料区間を設定することができる。 shipping_rates_min:送料区間の開始基準 shipping_rates_max:送料区間の終了基準 shipping_fee:送料
product_shipping_type	商品配送タイプ D：仕入れ商品の配送 C：直接配送 E：その他(倉庫/委託)
origin_place_code	原産国コード商品の原産国コード
additional_information	追加項目 [ショップ設定 > 商品設定 > '商品表示関連設定 > 商品情報項目設定']で追加した追加項目基本的な商品情報以外に追加で表示する項目がある場合に追加して使う。
image_upload_type	画像アップロードタイプ画像をアップロードする時、画像のアップロードタイプ「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード ※ EC Globalは、FTPをサポートしていないため、Cは使用できません A:メイン画像登録 B:個別画像登録 C:ウェブFTP登録
relational_product Array Max : [200]	関連商品似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。
select_one_by_option	オプション別に１個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する F:使用しない
translated_additional_description	商品追加説明の翻訳情報
custom_properties	商品Seo リソース
additional_image Array Max : [20]	追加画像商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。特定商品詳細検索APIでしか確認できない。

Retrieve a list of products cafe24 youtube

GET /api/v2/admin/products

GET

ショッピングモールに作成されている商品を一覧で照会することができます。
商品コード、商品名、販売価格などを照会することができます。
商品が5,000個を超える場合はoffsetでは照会できませんので、since_product_noパラメータを活用していただければ照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter	Description
channeldiscountprices embed	商品の割引価格リソース
discountprice embed	商品の割引価格リソース
decorationimages embed	デコ画像リソース
benefits embed	特典リソース
options embed	商品オプションリソース
variants embed	品目リソース商品1点あたりの品目情報を100件まで照会可能 Embedパラメーターを使って照会することができる。
additionalimages embed	追加の画像リソース
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no	商品番号検索したい商品の番号 ,(コンマ)で複数の件を検索することができる。
display	表示ステータス表示または非表示商品の検索
selling	販売ステータス「販売中」または「販売しない」状態の商品検索
product_name	商品名検索キーワードが商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
product_code	商品コード検索キーワードが商品コードに含まれている商品検索(大文字・小文字を区別する) ,(コンマ)で複数の件を検索することができる。
brand_code	ブランドコードブランドコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
manufacturer_code	メーカーコードメーカーコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
supplier_code	供給会社のコード供給会社コードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
trend_code	トレンドコードトレンドコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
product_tag	商品検索キーワード検索キーワードが商品検索キーワードまたはタグに含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
custom_product_code	独自商品コード検索キーワードが独自商品コードに含まれている商品検索(大文字・小文字を区別する) ,(コンマ)で複数の件を検索することができる。
custom_variant_code	独自品目コード ,(コンマ)で複数の件を検索することができる。
price_min	商品販売価格の検索最小値販売価格が最小値以上の商品検索
price_max	商品販売価格の検索最大値販売価格が最大値以下の商品検索
retail_price_min Min : [0] Max : [2147483647]	商品の定価の検索最小値消費者価格が最小値以上の商品検索
retail_price_max Min : [0] Max : [2147483647]	商品の定価の検索最大値消費者価格が最大値以下の商品検索
supply_price_min	商品仕入れ価格の検索最小値原価が最小値以下の商品検索
supply_price_max	商品仕入れ価格の検索最大値原価が最大値以上の商品検索
created_start_date	商品登録日の検索開始日商品登録日が該当日以後である商品検索登録日検索の終了日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。
created_end_date	商品登録日の検索終了日商品登録日が該当日以前である商品検索登録日検索の開始日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。
updated_start_date	商品修正日の検索開始日商品修正日が該当日以後である商品検索修正日検索の終了日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。
updated_end_date	商品修正日の検索終了日商品修正日が該当日以前である商品検索修正日検索の開始日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。
category	カテゴリ番号特定のカテゴリに表示されている商品検索
eng_product_name	商品名(英語) 検索キーワードが英語商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
supply_product_name	供給会社の商品名検索キーワードが供給会社の商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
internal_product_name	管理用商品名 ,(コンマ)で複数の件を検索することができる。
model_name	モデル名検索キーワードがモデル名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
product_condition	商品ステータス特定商品のステータスを検索 ,(コンマ)で複数の件を検索することができる。
origin_place_value	原産国情報原産国が「その他(1800)」の場合、原産国として入力可能な情報 ,(コンマ)で複数の件を検索することができる。
stock_quantity_max	在庫数量の検索最大値在庫が最大値以下の商品検索品目が複数の商品はその条件に当たる品目が一つでもあれば検索する。
stock_quantity_min	在庫数量の検索最小値在庫が最小値以上の商品検索品目が複数の商品はその条件に当たる品目が一つでもあれば検索する。
stock_safety_max	安全在庫数量の検索最大値
stock_safety_min	安全在庫数量の検索最小値
product_weight	商品重量該当する重量の商品検索 ,(コンマ)で複数の件を検索することができる。
classification_code	独自カテゴリ ,(コンマ)で複数の件を検索することができる。
use_inventory	在庫使用の設定該当する商品品目の在庫使用の有無 T:使用する F:使用しない
category_unapplied	未適用カテゴリを検索カテゴリが登録されていない商品を検索する。 T:未適用カテゴリを検索
include_sub_category	下位カテゴリを含めて検索下位カテゴリに登録されている商品を含めて検索する。 T:含む
additional_information_key	追加項目の検索条件キー追加項目を検索するためのキー。検索のためにはkeyとvalue両方とも必要
additional_information_value	追加項目の検索条件値追加項目を検索するためのキーの値。検索のためにはkeyとvalue両方とも必要
approve_status	承認ステータスの検索 N:承認申込(新規商品)のステータス値 E:承認申込(商品修正)のステータス値 C:承認完了のステータス値 R:承認拒否のステータス値 I:検収進行中のステータス値
since_product_no Min : [0] Max : [2147483647]	該当する商品番号以降の番号から検索特定の商品番号より数字が大きい商品番号を検索この検索条件を使用するとoffsetと関係なく、すべての商品を検索することができる。 ※この検索条件を使用すると、以下ののパラメータは使用できない。 product_no sort order offset
product_bundle	セット商品の有無 T:使用する F:使用しない
option_type	オプション構成方式 ,(コンマ)で複数の件を検索することができる。 C:組み合わせ一体選択型 S:組み合わせ分離選択型 E:商品連携型 F:独立選択型
market_sync	ECモール連携を使用するかどうか T:使用する F:使用しない
sort	並べ替え順序の値 created_date:登録日 updated_date:修正日 product_name:商品名
order	並べ替え順序 asc:並べ替え(昇順) desc:並べ替え(降順)
offset Max : [5000]	検索結果の開始位置検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of products cafe24 youtube

GET /api/v2/admin/products/count

GET

ショッピングモールに登録されている商品の総数を照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no	商品番号検索したい商品の番号 ,(コンマ)で複数の件を検索することができる。
display	表示ステータス表示または非表示商品の検索
selling	販売ステータス「販売中」または「販売しない」状態の商品検索
product_name	商品名検索キーワードが商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
product_code	商品コード商品コード ,(コンマ)で複数の件を検索することができる。
brand_code	ブランドコードブランドコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
manufacturer_code	メーカーコードメーカーコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
supplier_code	供給会社のコード供給会社コードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
trend_code	トレンドコードトレンドコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
product_tag	商品検索キーワード検索キーワードが商品検索キーワードまたはタグに含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
custom_product_code	独自商品コード検索キーワードが独自商品コードに含まれている商品検索(大文字・小文字を区別する) ,(コンマ)で複数の件を検索することができる。
custom_variant_code	独自品目コード ,(コンマ)で複数の件を検索することができる。
price_min	商品販売価格の検索最小値販売価格が最小値以上の商品検索
price_max	商品販売価格の検索最大値販売価格が最大値以下の商品検索
retail_price_min Min : [0] Max : [2147483647]	商品の定価の検索最小値消費者価格が最小値以上の商品検索
retail_price_max Min : [0] Max : [2147483647]	商品の定価の検索最大値消費者価格が最大値以下の商品検索
supply_price_min	商品仕入れ価格の検索最小値原価が最小値以下の商品検索
supply_price_max	商品仕入れ価格の検索最大値原価が最大値以上の商品検索
created_start_date	商品登録日の検索開始日商品登録日が該当日以後である商品検索登録日検索の終了日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。
created_end_date	商品登録日の検索終了日商品登録日が該当日以前である商品検索登録日検索の開始日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。
updated_start_date	商品修正日の検索開始日商品修正日が該当日以後である商品検索修正日検索の終了日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。
updated_end_date	商品修正日の検索終了日商品修正日が該当日以前である商品検索修正日検索の開始日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。
category	カテゴリ番号特定のカテゴリに表示されている商品検索
eng_product_name	商品名(英語) 検索キーワードが英語商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
supply_product_name	供給会社の商品名検索キーワードが供給会社の商品名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
internal_product_name	管理用商品名 ,(コンマ)で複数の件を検索することができる。
model_name	モデル名検索キーワードがモデル名に含まれている商品検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
product_condition	商品ステータス特定商品のステータスを検索 ,(コンマ)で複数の件を検索することができる。
origin_place_value	原産国情報原産国が「その他(1800)」の場合、原産国として入力可能な情報 ,(コンマ)で複数の件を検索することができる。
stock_quantity_max	在庫数量の検索最大値在庫が最大値以下の商品検索品目が複数の商品はその条件に当たる品目が一つでもあれば検索する。
stock_quantity_min	在庫数量の検索最小値在庫が最小値以上の商品検索品目が複数の商品はその条件に当たる品目が一つでもあれば検索する。
stock_safety_max	安全在庫数量の検索最大値
stock_safety_min	安全在庫数量の検索最小値
product_weight	商品重量該当する重量の商品検索 ,(コンマ)で複数の件を検索することができる。
classification_code	独自カテゴリ独自カテゴリコードが一致する商品検索 ,(コンマ)で複数の件を検索することができる。
use_inventory	在庫使用の設定該当する商品品目の在庫使用の有無 T:使用する F:使用しない
category_unapplied	未適用カテゴリを検索カテゴリが登録されていない商品を検索する。 T:未適用カテゴリを検索
include_sub_category	下位カテゴリを含めて検索下位カテゴリに登録されている商品を含めて検索する。 T:含む
additional_information_key	追加項目の検索条件キー追加項目を検索するためのキー。検索のためにはkeyとvalue両方とも必要
additional_information_value	追加項目の検索条件値追加項目を検索するためのキーの値。検索のためにはkeyとvalue両方とも必要
approve_status	承認ステータスの検索 N:承認申込(新規商品)のステータス値 E:承認申込(商品修正)のステータス値 C:承認完了のステータス値 R:承認拒否のステータス値 I:検収進行中のステータス値
since_product_no Min : [0] Max : [2147483647]	該当する商品番号以降の番号から検索特定の商品番号より数字が大きい商品番号を検索。この検索条件を使用するとoffsetと関係なく、すべての商品を検索することができる。 ※この検索条件を使用すると、以下ののパラメータは使用できない。 product_no sort order offset
product_bundle	セット商品の有無 T:使用する F:使用しない
option_type	オプション構成方式 ,(コンマ)で複数の件を検索することができる。 C:組み合わせ一体選択型 S:組み合わせ分離選択型 E:商品連携型 F:独立選択型
market_sync	ECモール連携を使用するかどうか T:使用する F:使用しない

Request Copy

Response Copy

Retrieve a product resource cafe24 youtube

GET /api/v2/admin/products/{product_no}

GET

ショッピングモールに作成されている商品を照会することができます。
商品コード、自社商品コード、商品名、商品販売価格などを照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号検索したい商品の番号
variants embed	品目リソース Embedパラメーターを使って照会することができる。
memos embed	メモリソース Embedパラメーターを使って照会することができる。
hits embed	商品閲覧数リソース Embedパラメーターを使って照会することができる。
seo embed	商品Seo リソース Embedパラメーターを使って照会することができる。
tags embed	商品タグリソース Embedパラメーターを使って照会することができる。
options embed	商品オプションリソース Embedパラメーターを使って照会することができる。
discountprice embed	商品の割引価格リソース
decorationimages embed	デコ画像リソース
benefits embed	特典リソース
additionalimages embed	追加の画像リソース
custom_properties embed	사용자 정의 속성

Request Copy

Response Copy

Create a product cafe24 youtube

POST /api/v2/admin/products

POST

ショッピングモールに商品を登録できます。
商品を登録しながらオプションも一緒に登録できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
display	表示ステータス * Youtube shopping をご利用の場合は提供されません T:表示する F:表示しない DEFAULT F
selling	販売ステータス T:販売する F:販売しない DEFAULT F
product_condition	商品ステータス N：新品 B：返品品 R：在庫品 U：中古品 E：展示品 F：メーカー再生品 S：キズあり品 DEFAULT N
product_used_month Max : [2147483647]	中古品の使用月数商品状態（product_condition）が中古である場合、該当商品の使用月数
add_category_no	追加カテゴリ番号 * Youtube shopping をご利用の場合は提供されませんカテゴリ番号を使って表示したいカテゴリに商品登録
category_no Required カテゴリ番号 recommend おすすめ商品カテゴリ登録 T：おすすめ商品を登録する、F：おすすめ商品を登録しない DEFAULT F new 新着商品カテゴリ登録 T：新着商品を登録する、F：新着商品を登録しない DEFAULT F
custom_product_code Max Length : [40]	独自商品コードユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。
product_name Required Max Length : [250]	商品名
eng_product_name Max Length : [250]	商品名(英語) * Youtube shopping をご利用の場合は提供されません
supply_product_name Max Length : [250]	供給会社の商品名
internal_product_name Max Length : [50]	管理用商品名 * Youtube shopping をご利用の場合は提供されません
model_name Max Length : [100]	モデル名 * Youtube shopping をご利用の場合は提供されません
price_excluding_tax Min : [0]~Max : [2147483647]	商品価格(税別) 商品設定照会商品設定照会Docsに移動で "販売価格の計算基準(calculate_price_based_on)"の値が "B(商品価格)"の場合、"price"の代わりに必須入力する必要があります。
price Min : [0]~Max : [2147483647]	商品販売価格必須入力ただし、商品設定照会商品設定照会Docsに移動で "販売価格の計算基準(calculate_price_based_on)"の値が "B(商品価格)"の場合、"price"の代わりに"price_excludig_tax"を使用する。
retail_price Min : [0]~Max : [2147483647]	商品の定価
supply_price Required Min : [0]~Max : [2147483647]	商品仕入れ価格商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。
has_option	オプション使用の設定 T:オプションを使用する F:オプションを使用しない DEFAULT F
soldout_message Max Length : [250]	在庫切れ表示メッセージ
options	オプション
name Required オプション名 value Required オプション値
use_naverpay	Naver Payの使用有無 * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない
naverpay_type	Naver Pay販売タイプ * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : Naver Pay + ショップ同時販売商品 O : Naver Pay 専用商品
manufacturer_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	メーカーコード DEFAULT M0000000
trend_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	トレンドコード DEFAULT T0000000
brand_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	ブランドコード DEFAULT B0000000
supplier_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	供給会社のコード DEFAULT S0000000
product_weight Min : [0]~Max : [999999.99]	商品重量
made_date	製造日
release_date	発売開始日
expiration_date Array Max : [2]	有効期間
start_date 有効期間の開始日 end_date 有効期間の終了日
description	商品詳細説明
mobile_description	モバイル商品詳細説明入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。
summary_description Max Length : [255]	商品要約説明
simple_description	商品簡略説明 * Youtube shopping をご利用の場合は提供されません
translated_description	商品詳細説明の翻訳情報
product_tag Array Max : [100]	商品検索キーワード * Youtube shopping をご利用の場合は提供されませんショッピングキュレーション使用時 - 配列の最大サイズ: [100]
payment_info	商品決済ガイド
shipping_info	商品配送ガイド
exchange_info	交換・返品ガイド
service_info	サービスに関するお問い合わせ/ガイド
icon Array Max : [5]	アイコン * Youtube shopping をご利用の場合は提供されません
hscode Max Length : [20]	HSコード配送情報(shipping_scope)がC(海外配送)の場合、必須入力。 shipping_calculationがA（自動計算）の場合、必須入力ではありません。
country_hscode Array Max : [29]	国別HSコード
shipping_scope	配送情報国内配送しかできない商品か海外配送も可能な商品かを表示。[ショップ設定 > 配送設定 > '配送基本設定 > 送料の設定 > 個別送料設定']で商品別の個別送料設定が「使用しない」の場合は設定できない。 ※ショッピングモールがEC Globalモールの場合は必須で入力する必要がある。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A:国内配送 C:海外配送 B:国内/海外配送
shipping_method	配送方法 01:宅配 02:速達郵便 03:一般郵便 04:直接配送 05:クイック配送 06:その他 07:貨物配送 08:店舗受取 09:配送不要
shipping_fee_by_product	個別配送の設定 T:個別配送 F:基本配送 DEFAULT F
shipping_area Max Length : [255]	配送地域
shipping_period Array Max : [2]	配送期間
minimum 期間設定の最小値 DEFAULT 1 maximum 期間設定の最大値 DEFAULT 7
shipping_fee_type	送料タイプ個別送料を使う場合、商品の送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
shipping_rates Array Max : [200]	送料金額個別送料を使う場合、商品の個別送料 shipping_fee_typeがR、Nの場合、配列内でshipping_feeを定義して送料を設定することができる。 shipping_fee_typeがM、D、W、Cの場合、配列内で次のように定義して送料区間を設定することができる。 shipping_rates_min:送料区間の開始基準 shipping_rates_max:送料区間の終了基準 shipping_fee:送料
shipping_rates_min 送料を適用する範囲の開始値 shipping_rates_max 送料を適用する範囲の終了値 shipping_fee 送料
prepaid_shipping_fee	送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C:着払い P:前払い B:前払い/着払い
clearance_category_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	海外通関コード配送情報(shipping_scope)がC(海外配送)の場合、必須入力。 shipping_calculationがA（自動計算）の場合、必須入力ではありません。 clearance_category_code
product_shipping_type	商品配送タイプ D：仕入れ商品の配送 C：直接配送 E：その他(倉庫/委託)
detail_image	詳細画像
list_image	一覧画像 * Youtube shopping をご利用の場合は提供されません
tiny_image	縮小一覧画像 * Youtube shopping をご利用の場合は提供されません
small_image	縮小画像 * Youtube shopping をご利用の場合は提供されません
image_upload_type	画像アップロードタイプ * Youtube shopping をご利用の場合は提供されません画像をアップロードする時、画像のアップロードタイプ「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード ※ EC Globalは、FTPをサポートしていないため、Cは使用できません A:メイン画像登録 B:個別画像登録 C:ウェブFTP登録 DEFAULT A
additional_information	追加項目 * Youtube shopping をご利用の場合は提供されません
key Required 追加項目のキー value 追加項目の値
price_content Max Length : [20]	販売価格の代替メッセージ * Youtube shopping をご利用の場合は提供されません
buy_limit_by_product	購入制限の個別設定の有無 * Youtube shopping をご利用の場合は提供されません T: 使用する F: 使用しない DEFAULT F
buy_limit_type	購入制限 * Youtube shopping をご利用の場合は提供されません N : 会員のみ購入可能 + 購入ボタン非表示 M : 会員のみ購入可能 + 購入ボタン表示 F : 購入制限なし O : 指定された会員のみ購入可能 + 購入ボタン非表示 D : 指定された会員のみ購入可能 + 購入ボタン表示 DEFAULT F
buy_group_list	購入できる会員ランク * Youtube shopping をご利用の場合は提供されません
buy_member_id_list	購入可能な会員ID * Youtube shopping をご利用の場合は提供されません
repurchase_restriction	再購入制限 * Youtube shopping をご利用の場合は提供されません T : 再購入不可 F : 制限しない DEFAULT F
single_purchase_restriction	単独購入制限 * Youtube shopping をご利用の場合は提供されません T : 単独購入不可 F : 制限しない DEFAULT F
buy_unit_type	購入単位のタイプ商品の購入単位を1個以上に設定した場合、その購入単位を品目単位にするか、商品単位にするかの設定 P:商品基準 O:品目基準 DEFAULT O
buy_unit Max : [2147483647]	購入単位 DEFAULT 1
order_quantity_limit_type	注文数量の制限基準商品の注文数量を制限する場合、制限基準を品目単位にするか、商品単位にするかの設定 P:商品基準 O:品目基準 DEFAULT O
minimum_quantity Max : [2147483647]	最小注文数量注文可能な最小限の注文数量。注文数量未満は購入できない。 DEFAULT 1
maximum_quantity Max : [2147483647]	最大注文数量注文可能な最大限の注文数量。注文数量を超過して購入することはできない。最大注文数を「制限なし」と入力するには「0」と入力します。 DEFAULT 0
points_by_product	ポイントの個別設定を使用するかどうか * Youtube shopping をご利用の場合は提供されません F : 基本設定使用 T : 個別設定 DEFAULT F
points_setting_by_payment	決済方法別にポイントを設定するかどうか * Youtube shopping をご利用の場合は提供されません B : 基本ポイント設定を使用 C : 決済方法によるポイント
points_amount	ポイント設定情報 * Youtube shopping をご利用の場合は提供されません
payment_method ポイント決済方法 naverpay : Naver Pay、smilepay：SmilePay、kakaopay：Kakaopay、payco : PAYCO、paynow：Paynow、kpay：KPAY、icash：バーチャル口座、deposit：預り金、tcash：リアルタイム口座振替、cell：キャリア決済、 card：クレジットカード、mileage：ポイント、cash：銀行振込 points_rate 付与率 points_unit_by_payment 決済方法別のポイント付与単位 P：百分率基準、W：ウォン基準
except_member_points	会員ランク別の追加ポイントを付与しない * Youtube shopping をご利用の場合は提供されません T：会員ランク追加付与除外を設定する F：会員ランク追加付与除外を設定しない DEFAULT F
product_volume	商品体積情報
use_product_volume 商品体積の使用有無 product_width 幅(W) product_height 奥行(D) product_length 高さ(H)
origin_classification	原産国国内/国外/その他 F:国内 T:海外 E:その他
origin_place_no	原産国番号 Retrieve a list of origins APIで原産国を検索して原産国番号を入力 origin_classificationがF(国内)の場合、海外の有無(foreign)が「F」の原産国のみ入力可能 origin_classificationがT(海外)の場合、海外の有無(foreign)が「T」の原産国のみ入力可能
origin_place_value Max Length : [30]	原産国のその他の情報原産国が「その他(1800)」の場合、原産国として入力可能な情報
made_in_code	国名(原産国)コード原産国を二桁の国コードで入力原産地を国家単位だけで入力する場合、原産地番号（origin_place_no）と原産地区分（origin_classification）の代わりに使用できる。
main	メイン表示 * Youtube shopping をご利用の場合は提供されません商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。
relational_product Array Max : [200]	関連商品 * Youtube shopping をご利用の場合は提供されません似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。
product_no Required 商品番号 interrelated Required 関連商品の相互登録 T：相互登録、F：単独登録
product_material	商品素材 * Youtube shopping をご利用の場合は提供されません商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。
translate_product_material	商品素材の翻訳 T:使用する F:使用しない
english_product_material	英語商品素材 * Youtube shopping をご利用の場合は提供されません商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。
cloth_fabric	生地 * Youtube shopping をご利用の場合は提供されません商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) knit:編物(knit)
classification_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	独自カテゴリ
additional_price Max : [2147483647]	販売価格の追加金額販売価格の計算時に商品の原価と売上総利益率に加えて追加計算される金額。APIでその金額は参照の目的でしか使われない。
margin_rate Min : [-999.99]~Max : [999.99]	売上総利益率商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。
tax_type	課税区分商品の課税情報消費税込みのタイプ課税商品 = 税金が賦課される商品免税商品 = 税金が免除される商品。加工されていない農/水/畜産物、練炭、図書類、保険、女性専用などの商品で、課税事業者として登録しなければならない。零細商品 = 付加価値税が0%適用される輸出向け外貨稼ぎ商品 A:課税商品 B:免税商品 C:ゼロ税率商品
tax_rate Min : [0]~Max : [100]	税率
additional_image	追加画像商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。追加画像は、最大20個まで登録可能できる。
adult_certification	年齢認証成人認証が必要な商品かどうか。成人認証が必要な商品である購買のためには本人認証を経なければならない。 [ショッピングモール設定>顧客設定>「会員ポリシー設定>会員関連設定>会員登録および本人認証設定」]で成人認証使用時に購買遮断設定が使用されることにより成人認証が適用される。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない DEFAULT F
exposure_limit_type	商品表示制限の範囲 * Youtube shopping をご利用の場合は提供されません A：すべての顧客に表示 M：会員にのみ表示 DEFAULT A
exposure_group_list	商品表示対象の会員ランク * Youtube shopping をご利用の場合は提供されません
use_kakaopay	カカオページを使用するかどうか Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない

Request Copy

Response Copy

Update a product cafe24 youtube

PUT /api/v2/admin/products/{product_no}

PUT

ショッピングモールに作成されている商品を修正できます。
陳列状態、販売状態、商品名などを修正できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
display	表示ステータス * Youtube shopping をご利用の場合は提供されません商品をショップに表示するかどうかを変更 T:表示する F:表示しない
selling	販売ステータス T:販売する F:販売しない
product_condition	商品ステータス N：新品 B：返品品 R：在庫品 U：中古品 E：展示品 F：メーカー再生品 S：キズあり品
product_used_month Max : [2147483647]	中古品の使用月数商品状態（product_condition）が中古である場合、該当商品の使用月数
add_category_no	追加カテゴリ番号 * Youtube shopping をご利用の場合は提供されません商品カテゴリ番号を入力してその商品に特定の商品カテゴリを追加登録
category_no Required カテゴリ番号 recommend おすすめ商品カテゴリ登録 T：おすすめ商品を登録する、F：おすすめ商品を登録しない DEFAULT F new 新着商品カテゴリ登録 T：新着商品を登録する、F：新着商品を登録しない DEFAULT F
delete_category_no	削除されたカテゴリ番号 * Youtube shopping をご利用の場合は提供されません商品カテゴリ番号を入力してその商品から特定の商品カテゴリを削除
custom_product_code Max Length : [40]	独自商品コードユーザーが商品に付与できるコード。在庫管理などの理由で独自に商品を管理している場合に使う。
product_name Max Length : [250]	商品名
eng_product_name Max Length : [250]	商品名(英語) * Youtube shopping をご利用の場合は提供されません
supply_product_name Max Length : [250]	供給会社の商品名
internal_product_name Max Length : [50]	管理用商品名 * Youtube shopping をご利用の場合は提供されません
model_name Max Length : [100]	モデル名 * Youtube shopping をご利用の場合は提供されません
price_excluding_tax Min : [0]~Max : [2147483647]	商品価格(税別) 商品設定照会(GET:/products/setting)で"販売価格計算基準(calculate_price_based_on)"が"B(商品価格)"の場合、Priceではなくprice_excluding_taxを入力しなければならない。
price Min : [0]~Max : [2147483647]	商品販売価格 tax_calculationがA(自動計算)の場合、商品設定照会(GET:/products/setting)の"販売価格計算基準(calculate_price_based_on)"の値に関係なく、 priceでのみ入力しなければならない。
retail_price Min : [0]~Max : [2147483647]	商品の定価
supply_price Min : [0]~Max : [2147483647]	商品仕入れ価格商品の原価。原価に売上総利益率を加えて販売価格を計算することができる。APIで原価は参照の目的でしか使われない。
soldout_message Max Length : [250]	在庫切れ表示メッセージ
use_naverpay	Naver Payの使用有無 * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない
naverpay_type	Naver Pay販売タイプ * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : Naver Pay + ショップ同時販売商品 O : Naver Pay 専用商品
manufacturer_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	メーカーコード
trend_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	トレンドコード
brand_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	ブランドコード
supplier_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	供給会社のコード
product_weight Min : [0]~Max : [999999.99]	商品重量
made_date	製造日
release_date	発売開始日
expiration_date Array Max : [2]	有効期間
start_date 有効期間の開始日 end_date 有効期間の終了日
description	商品詳細説明
mobile_description	モバイル商品詳細説明入力するとモバイルショップで商品詳細説明の代わりにモバイルショップ商品詳細説明が表示される。
translated_description	商品詳細説明の翻訳情報
translated_additional_description	商品追加説明の翻訳情報
summary_description Max Length : [255]	商品要約説明
simple_description	商品簡略説明 * Youtube shopping をご利用の場合は提供されません
product_tag Array Max : [100]	商品検索キーワード * Youtube shopping をご利用の場合は提供されませんショッピングキュレーション使用時 - 配列の最大サイズ: [100]
payment_info	商品決済ガイド
shipping_info	商品配送ガイド
exchange_info	交換・返品ガイド
service_info	サービスに関するお問い合わせ/ガイド
icon Array Max : [5]	アイコン * Youtube shopping をご利用の場合は提供されません
use_icon_exposure_term	表示期間の使用の有無 * Youtube shopping をご利用の場合は提供されません T:使用する F:使用しない
icon_exposure_begin_datetime	表示期間の開始日 * Youtube shopping をご利用の場合は提供されません
icon_exposure_end_datetime	表示期間の終了日 * Youtube shopping をご利用の場合は提供されません
hscode Max Length : [20]	HSコード配送情報(shipping_scope)がC(海外配送)の場合、必須入力。 shipping_calculationがA（自動計算）の場合、必須入力ではありません。
country_hscode Array Max : [29]	国別HSコード
shipping_scope	配送情報国内のみ配送が可能な商品なのか、海外にも配送が可能な商品なのかを表示。 [ショッピングモール設定 > 配送設定 > 「配送ポリシー設定 > 送料設定 > 個別配送料設定」] で商品別個別配送料設定が使用されていない場合は設定不可。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A:国内配送 C:海外配送 B:国内/海外配送
shipping_method	配送方法 01:宅配 02:速達郵便 03:一般郵便 04:直接配送 05:クイック配送 06:その他 07:貨物配送 08:店舗受取 09:配送不要
shipping_fee_by_product	個別配送の設定 T:個別配送 F:基本配送
shipping_area Max Length : [255]	配送地域
shipping_period	配送期間
minimum 期間設定の最小値 DEFAULT 1 maximum 期間設定の最大値 DEFAULT 7
shipping_fee_type	送料タイプ個別送料を使う場合、商品の送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
shipping_rates Array Max : [200]	送料金額個別送料を使う場合、商品の個別送料 shipping_fee_typeがR、Nの場合、配列内でshipping_feeを定義して送料を設定することができる。 shipping_fee_typeがM、D、W、Cの場合、配列内で次のように定義して送料区間を設定することができる。 shipping_rates_min:送料区間の開始基準 shipping_rates_max:送料区間の終了基準 shipping_fee:送料
shipping_rates_min 送料を適用する範囲の開始値 shipping_rates_max 送料を適用する範囲の終了値 shipping_fee 送料
prepaid_shipping_fee	送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C:着払い P:前払い B:前払い/着払い
clearance_category_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	海外通関コード配送情報(shipping_scope)がC(海外配送)の場合、必須入力。 shipping_calculationがA（自動計算）の場合、必須入力ではありません。 clearance_category_code
product_shipping_type	商品配送タイプ D：仕入れ商品の配送 C：直接配送 E：その他(倉庫/委託)
detail_image	詳細画像
list_image	一覧画像 * Youtube shopping をご利用の場合は提供されません
tiny_image	縮小一覧画像 * Youtube shopping をご利用の場合は提供されません
small_image	縮小画像 * Youtube shopping をご利用の場合は提供されません
image_upload_type	画像アップロードタイプ * Youtube shopping をご利用の場合は提供されません画像をアップロードする時、画像のアップロードタイプ「代表画像登録」時に詳細画像をリサイズして一覧画像、縮小一覧画像、縮小画像にアップロード「個別画像登録」時に詳細画像、一覧画像、縮小一覧画像、縮小画像をそれぞれアップロード ※ EC Globalは、FTPをサポートしていないため、Cは使用できません A:メイン画像登録 B:個別画像登録 C:ウェブFTP登録
additional_information	追加項目 * Youtube shopping をご利用の場合は提供されません
key Required 追加項目のキー value 追加項目の値
price_content Max Length : [20]	販売価格の代替メッセージ * Youtube shopping をご利用の場合は提供されません
buy_limit_by_product	購入制限の個別設定の有無 * Youtube shopping をご利用の場合は提供されません T: 使用する F: 使用しない
buy_limit_type	購入制限 * Youtube shopping をご利用の場合は提供されません N : 会員のみ購入可能 + 購入ボタン非表示 M : 会員のみ購入可能 + 購入ボタン表示 F : 購入制限なし O : 指定された会員のみ購入可能 + 購入ボタン非表示 D : 指定された会員のみ購入可能 + 購入ボタン表示
buy_group_list	購入できる会員ランク * Youtube shopping をご利用の場合は提供されません
buy_member_id_list	購入可能な会員ID * Youtube shopping をご利用の場合は提供されません
repurchase_restriction	再購入制限 * Youtube shopping をご利用の場合は提供されません T : 再購入不可 F : 制限しない
single_purchase_restriction	単独購入制限 * Youtube shopping をご利用の場合は提供されません T : 単独購入不可 F : 制限しない
buy_unit_type	購入単位のタイプ商品の購入単位を1個以上に設定した場合、その購入単位を品目単位にするか、商品単位にするかの設定 P:商品基準 O:品目基準
buy_unit Max : [2147483647]	購入単位
order_quantity_limit_type	注文数量の制限基準商品の注文数量を制限する場合、制限基準を品目単位にするか、商品単位にするかの設定 P:商品基準 O:品目基準
minimum_quantity Max : [2147483647]	最小注文数量
maximum_quantity Max : [2147483647]	最大注文数量注文可能な最大限の注文数量。注文数量を超過して購入することはできない。購入あたりの最小数量を変更する場合は、最大受注数量を一緒に変更する必要があります。最大注文数を「制限なし」と入力するには「0」と入力します。
points_by_product	ポイントの個別設定を使用するかどうか * Youtube shopping をご利用の場合は提供されません F : 基本設定使用 T : 個別設定
points_setting_by_payment	決済方法別にポイントを設定するかどうか * Youtube shopping をご利用の場合は提供されません B : 基本ポイント設定を使用 C : 決済方法によるポイント
points_amount	ポイント設定情報 * Youtube shopping をご利用の場合は提供されません
payment_method ポイント決済方法 naverpay : Naver Pay、smilepay：SmilePay、kakaopay：Kakaopay、payco : PAYCO、paynow：Paynow、kpay：KPAY、icash：バーチャル口座、deposit：預り金、tcash：リアルタイム口座振替、cell：キャリア決済、 card：クレジットカード、mileage：ポイント、cash：銀行振込 points_rate 付与率 points_unit_by_payment 決済方法別のポイント付与単位 P：百分率基準、W：ウォン基準
except_member_points	会員ランク別の追加ポイントを付与しない * Youtube shopping をご利用の場合は提供されません T：会員ランク追加付与除外を設定する F：会員ランク追加付与除外を設定しない
product_volume	商品体積情報
use_product_volume 商品体積の使用有無 product_width 幅(W) product_height 奥行(D) product_length 高さ(H)
origin_classification	原産国国内/国外/その他 F:国内 T:海外 E:その他
origin_place_no	原産国番号 List all Origin APIで原産国を検索して原産国番号を入力 origin_classificationがF(国内)の場合、海外の有無(foreign)が「F」の原産国のみ入力可能 origin_classificationがT(海外)の場合、海外の有無(foreign)が「T」の原産国のみ入力可能
origin_place_value Max Length : [30]	原産国のその他の情報原産国が「その他(1800)」の場合、原産国として入力可能な情報
made_in_code	国名(原産国)コード原産国を二桁の国コードで入力原産地を国家単位だけで入力する場合、原産地番号（origin_place_no）と原産地区分（origin_classification）の代わりに使用できる。
main	メイン表示 * Youtube shopping をご利用の場合は提供されません商品を「おすすめ商品」、「新着商品」のようなメイン表示に表示する場合、メイン表示番号を表示する。
relational_product Array Max : [200]	関連商品 * Youtube shopping をご利用の場合は提供されません似ている商品または代替可能な商品。関連商品を登録するとその商品の詳細ページの下部に表示される。
product_no 商品番号 interrelated Required 関連商品の相互登録 T：相互登録、F：単独登録
product_material	商品素材 * Youtube shopping をご利用の場合は提供されません商品の素材。複合素材の場合は商品の素材と含有量を一緒に入力しなければならない(例: 綿80%、レーヨン20%)。
translate_product_material	商品素材の翻訳 T:使用する F:使用しない
english_product_material	英語商品素材 * Youtube shopping をご利用の場合は提供されません商品の素材の英語表記。海外の配送会社を利用する場合、通関時に衣類の素材情報を要求される場合がある。
cloth_fabric	生地 * Youtube shopping をご利用の場合は提供されません商品が衣類の場合の生地。日本の配送会社を利用する場合、会社によっては衣類の通関時に生地情報の入力を要求される場合がある。 woven:織物(woven) knit:編物(knit)
classification_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	独自カテゴリ
additional_price Max : [2147483647]	販売価格の追加金額販売価格の計算時に商品の原価と売上総利益率に加えて追加計算される金額。APIでその金額は参照の目的でしか使われない。
margin_rate Min : [-999.99]~Max : [999.99]	売上総利益率商品の原価に加えて販売価格を計算するための売上総利益率。APIでその値は参照の目的でしか使われない。
tax_type	課税区分商品の課税情報消費税込みのタイプ課税商品 = 税金が賦課される商品免税商品 = 税金が免除される商品。加工されていない農/水/畜産物、練炭、図書類、保険、女性専用などの商品で、課税事業者として登録しなければならない。零細商品 = 付加価値税が0%適用される輸出向け外貨稼ぎ商品 A:課税商品 B:免税商品 C:ゼロ税率商品
tax_rate Min : [0]~Max : [100]	税率
additional_image	追加画像商品詳細画面の下部に表示される商品の追加画像。縮小画像に似ている位置に表示される。PCショップではマウスオーバー時に、モバイルショップでは画像スワイプ(Swipe)時に追加画像の確認ができる。追加画像は、最大20個まで登録可能できる。
adult_certification	年齢認証成人認証が必要な商品かどうか。成人認証が必要な商品である購買のためには本人認証を経なければならない。 [ショッピングモール設定>顧客設定>「会員ポリシー設定>会員関連設定>会員登録および本人認証設定」]で成人認証使用時に購買遮断設定が使用されることにより成人認証が適用される。 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない
exposure_limit_type	商品表示制限の範囲 * Youtube shopping をご利用の場合は提供されません A：すべての顧客に表示 M：会員にのみ表示
exposure_group_list	商品表示対象の会員ランク * Youtube shopping をご利用の場合は提供されません
use_kakaopay	カカオページを使用するかどうか Cafe24管理画面(ベトナム, フィリピン) では使用できません。 T:使用する F:使用しない

Request Copy

Response Copy

Delete a product cafe24 youtube

DELETE /api/v2/admin/products/{product_no}

DELETE

ショッピングモールに作成されている商品を削除できます。
商品を削除する際には、商品下位のオプション(品目)も一緒に削除されます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

Request Copy

Response Copy

Products additionalimages

Endpoints

POST /api/v2/admin/products/{product_no}/additionalimages
PUT /api/v2/admin/products/{product_no}/additionalimages
DELETE /api/v2/admin/products/{product_no}/additionalimages

Products additionalimages properties

Attribute	Description
shop_no	ショップ番号
additional_image	追加画像
product_no	商品番号

Create an additional product image cafe24 youtube

POST /api/v2/admin/products/{product_no}/additionalimages

POST

その商品の追加画像を登録できます。
追加画像をアップロードする際、Base64にインコードしてアップロードすることができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

product_no
Required

商品番号

additional_image
Required

追加画像

● 最大リクエスト件数:20個
● 画像ファイル容量制限:5MB
● 1呼出あたりの画像全体容量制限:30MB

Request Copy

Response Copy

Update an additional product image cafe24 youtube

PUT /api/v2/admin/products/{product_no}/additionalimages

PUT

その商品の追加画像を修正できます。
追加画像をアップロードする際、Base64にインコードしてアップロードすることができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

product_no
Required

商品番号

additional_image
Required

追加画像

● 最大リクエスト件数:20個
● 画像ファイル容量制限:5MB
● 1呼出あたりの画像全体容量制限:30MB

Request Copy

Response Copy

Delete an additional product image cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/additionalimages

DELETE

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

product_no
Required

商品番号

Request Copy

Response Copy

Products approve

Endpoints

GET /api/v2/admin/products/{product_no}/approve
POST /api/v2/admin/products/{product_no}/approve
PUT /api/v2/admin/products/{product_no}/approve

Products approve properties

Attribute

Description

shop_no

ショップ番号

status
Required

ステータス

N:承認申込(新規商品)ステータス値
E:承認申込(商品修正)ステータス値
C:承認完了ステータス値
R:承認拒否ステータス値
I:検収進行中ステータス値
Empty Value:申込履歴がない

product_no
Required

商品番号

Retrieve a product approval status cafe24

GET /api/v2/admin/products/{product_no}/approve

GET

その商品の承認状態を確認することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

Request Copy

Response Copy

Create a product approval request cafe24

POST /api/v2/admin/products/{product_no}/approve

POST

該当商品の承認申請をすることができます。
承認申請した商品は承認要請(新規商品)状態で承認要請されます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

user_id
Required

供給会社の運営者ID

承認を要求した供給会社のID

Request Copy

Response Copy

Update a product approval status cafe24

PUT /api/v2/admin/products/{product_no}/approve

PUT

その商品の承認状態を変更することができます。
代表管理者が商品を承認した場合、承認完了にアップデートすることができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号システムにより付与された商品の番号。商品番号はショップ内で重複しない。
user_id Required	供給会社の運営者ID 承認を要求した供給会社のID
status Required	ステータス供給会社が承認要求した商品の承認ステータス C:承認完了ステータス値 R:承認拒否ステータス値 I:検収進行中ステータス値

Request Copy

Response Copy

Products customproperties

Endpoints

GET /api/v2/admin/products/{product_no}/customproperties
PUT /api/v2/admin/products/{product_no}/customproperties/{property_no}
DELETE /api/v2/admin/products/{product_no}/customproperties/{property_no}

Products customproperties properties

Attribute	Description
shop_no Min : [1]	ショップ番号
custom_properties	ユーザー定義属性

Retrieve user-defined properties by product cafe24 youtube

GET /api/v2/admin/products/{product_no}/customproperties

GET

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

product_no
Required

商品番号

Request Copy

Response Copy

Update user-defined properties by product cafe24 youtube

PUT /api/v2/admin/products/{product_no}/customproperties/{property_no}

PUT

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
product_no Required	商品番号
property_no Required	ユーザー定義属性の属性番号
shop_no Min : [1]	ショップ番号
property_value	ユーザー定義属性の値

Request Copy

Response Copy

Delete user-defined properties by product cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/customproperties/{property_no}

DELETE

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

product_no
Required

商品番号

property_no
Required

ユーザー定義属性の属性番号

Request Copy

Response Copy

Products decorationimages

Endpoints

GET /api/v2/admin/products/{product_no}/decorationimages
POST /api/v2/admin/products/{product_no}/decorationimages
PUT /api/v2/admin/products/{product_no}/decorationimages
DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}

Products decorationimages properties

Attribute	Description
shop_no	ショップ番号
use_show_date	表示期間の使用の有無 T:使用する F:使用しない
show_start_date	表示期間の開始日
show_end_date	表示期間の終了日
image_list	デコ画像一覧
code	デコ画像コード

Retrieve a list of product decoration images cafe24 youtube

GET /api/v2/admin/products/{product_no}/decorationimages

GET

特定の商品に登録されている装飾画像をリストで照会します。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

Request Copy

Response Copy

Set decoration images for a product cafe24 youtube

POST /api/v2/admin/products/{product_no}/decorationimages

POST

デコレーションイメージを商品に追加できます。
飾り画像を追加すると、表示期間と飾り画像の位置などを設定できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号
use_show_date	表示期間の使用の有無 T:使用する F:使用しない
show_start_date Date	表示期間の開始日
show_end_date Date	表示期間の終了日
image_list Required	デコ画像一覧水平位置(image_horizontal_position) L : 左 C : 真ん中 R : 右垂直位置(image_vertical_position) T : 上段 C : 中断 B : 下段
code デコ画像コード path デコ画像URL image_horizontal_position デコ画像の表示位置(水平値) image_vertical_position デコ画像の表示位置(垂直値)

Request Copy

Response Copy

Update product decoration images cafe24 youtube

PUT /api/v2/admin/products/{product_no}/decorationimages

PUT

商品番号を利用して、その商品の飾り画像を修正することができます。
表示期間を使用するかどうか、表示期間開始日、終了日などを変更することができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
use_show_date	表示期間の使用の有無 T:使用する F:使用しない
show_start_date Date	表示期間の開始日
show_end_date Date	表示期間の終了日
image_list Required	デコ画像一覧水平位置(image_horizontal_position) L : 左 C : 真ん中 R : 右垂直位置(image_vertical_position) T : 上段 C : 中断 B : 下段
code デコ画像コード path デコ画像URL image_horizontal_position デコ画像の表示位置(水平値) image_vertical_position デコ画像の表示位置(垂直値)

Request Copy

Response Copy

Remove a product decoration image cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/decorationimages/{code}

DELETE

商品に登録されている飾り画像を削除します。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

code
Required

デコ画像コード

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

Request Copy

Response Copy

Products discountprice

Endpoints

GET /api/v2/admin/products/{product_no}/discountprice

Products discountprice properties

Attribute	Description
pc_discount_price	PC割引価格
mobile_discount_price	モバイル割引価格
app_discount_price	アプリ割引価格

Retrieve a product discounted price cafe24 youtube

GET /api/v2/admin/products/{product_no}/discountprice

GET

商品番号を利用して該当商品の割引価格を照会します。
PC割引販売価格、モバイル割引販売価格を確認できます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

product_no
Required

商品番号

Request Copy

Response Copy

Products hits

Endpoints

GET /api/v2/admin/products/{product_no}/hits/count

Retrieve a count of product views cafe24 youtube

GET /api/v2/admin/products/{product_no}/hits/count

GET

商品番号を利用して該当商品の照会数を照会します。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

Request Copy

Response Copy

Products icons

Endpoints

GET /api/v2/admin/products/{product_no}/icons
POST /api/v2/admin/products/{product_no}/icons
PUT /api/v2/admin/products/{product_no}/icons
DELETE /api/v2/admin/products/{product_no}/icons/{code}

Products icons properties

Attribute	Description
shop_no	ショップ番号
use_show_date	表示期間の使用の有無 T:使用する F:使用しない
show_start_date	表示期間の開始日
show_end_date	表示期間の終了日
image_list	商品アイコン一覧
code	商品アイコンコード

Retrieve a list of product icons cafe24 youtube

GET /api/v2/admin/products/{product_no}/icons

GET

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

product_no
Required

商品番号

Request Copy

Response Copy

Set icons for a product cafe24 youtube

POST /api/v2/admin/products/{product_no}/icons

POST

商品アイコンを商品に登録できます。
アイコンを商品に登録する前に、まずListalliconsを通じてアイコンのコードを確認してください。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
product_no Required	商品番号
image_list Required Array Max : [5]	商品アイコン一覧
code Required 商品アイコンコード

Request Copy

Response Copy

Update product icons cafe24 youtube

PUT /api/v2/admin/products/{product_no}/icons

PUT

商品に登録した商品アイコンを修正できます。
アイコンの表示可否、表示期間などを変更することができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
product_no Required	商品番号
use_show_date	表示期間の使用の有無 T:使用する F:使用しない
show_start_date Date	表示期間の開始日
show_end_date Date	表示期間の終了日
image_list Array Max : [5]	商品アイコン一覧
code Required 商品アイコンコード

Request Copy

Response Copy

Remove a product icon cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/icons/{code}

DELETE

商品に登録されている商品アイコンを削除（登録解除）することができます。
アイコン自体は削除されず、商品に登録された状態のみが解除されます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

product_no
Required

商品番号

code
Required

商品アイコンコード

Request Copy

Response Copy

Products images

Endpoints

POST /api/v2/admin/products/{product_no}/images
DELETE /api/v2/admin/products/{product_no}/images

Products images properties

Attribute	Description
shop_no	ショップ番号
product_no	商品番号
detail_image	詳細画像
list_image	一覧画像
tiny_image	縮小一覧画像
small_image	縮小画像

Upload product images cafe24 youtube

POST /api/v2/admin/products/{product_no}/images

POST

画像を商品に登録できます。
商品の詳細、リスト、小規模リスト、縮小画像を登録できます。
画像を登録する前に、画像がアップロードされていることをまず確認してください。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
detail_image	詳細画像商品詳細画面に表示される商品画像
list_image	一覧画像 * Youtube shopping をご利用の場合は提供されません商品カテゴリ画面、トップページ、商品検索画面に表示される商品の一覧画像
tiny_image	縮小一覧画像 * Youtube shopping をご利用の場合は提供されません商品詳細画面の下部に表示される商品の一覧画像
small_image	縮小画像 * Youtube shopping をご利用の場合は提供されません最近チェックした商品領域に表示される商品の一覧画像
image_upload_type Required	画像アップロードタイプ * Youtube shopping をご利用の場合は提供されません画像のタイプが代表画像か個別画像か、アップロードタイプを指定することができる。代表画像(A)としてアップロードする場合、詳細画像(detail_image)に画像をアップロードすると残りの画像にもすべて反映される。 A:メイン画像登録 B:個別画像登録

Request Copy

Response Copy

Delete product images cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/images

DELETE

商品に登録されている画像を削除できます。
詳細画像やリスト画像などの区別なく、商品に登録されているすべての画像が削除されます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

Request Copy

Response Copy

Products memos

Endpoints

GET /api/v2/admin/products/{product_no}/memos
GET /api/v2/admin/products/{product_no}/memos/{memo_no}
POST /api/v2/admin/products/{product_no}/memos
PUT /api/v2/admin/products/{product_no}/memos/{memo_no}
DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}

Products memos properties

Attribute	Description
memo_no	メモ番号
author_id Max Length : [20]	作成者ID
created_date	作成日
memo	メモ

Retrieve a list of product memos cafe24 youtube

GET /api/v2/admin/products/{product_no}/memos

GET

特定の商品に登録されているメモをリストで照会することができます。
作成者ID、作成日、メモ内容などを照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

offset

Max : [8000]

検索結果の開始位置

DEFAULT 0

limit

Min : [1]~Max : [100]

検索結果の最大件数

検索したい最大件数を指定することができる。
例)10を入力すると10件まで表示

DEFAULT 10

Request Copy

Response Copy

Retrieve a product memo cafe24 youtube

GET /api/v2/admin/products/{product_no}/memos/{memo_no}

GET

特定の商品に登録されているメモの 1 つを照会することができます。
作成者ID、作成日、メモ内容などを照会することができます。
メモを照会するにはメモ番号が必要です。メモ番号は、リストallproductsmemosで確認できます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

memo_no
Required

メモ番号

システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。

Request Copy

Response Copy

Create a product memo cafe24 youtube

POST /api/v2/admin/products/{product_no}/memos

POST

特定の商品に関するメモを登録できます。
メモを登録するときは、メモ作成者のIDを入力する必要があります。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

author_id
Required

Max Length : [20]

作成者ID

メモを作成した管理者のID情報

memo
Required

メモ

メモの内容。HTMLを使って登録できる。

Request Copy

Response Copy

Update a product memo cafe24 youtube

PUT /api/v2/admin/products/{product_no}/memos/{memo_no}

PUT

特定の商品に登録されているメモを修正できます。
メモを修正するときは、メモ作成者のIDとメモ番号を入力する必要があります。
メモ番号は、リストallproductsmemosで確認できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
product_no Required	商品番号システムにより付与された商品の番号。商品番号はショップ内で重複しない。
memo_no Required	メモ番号システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。
author_id Required Max Length : [20]	作成者ID メモを作成した管理者のID情報
memo Required	メモメモの内容。HTMLを使って登録できる。

Request Copy

Response Copy

Delete a product memo cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/memos/{memo_no}

DELETE

特定の商品に登録されているメモを削除できます。
メモを削除するにはメモ番号が必要です。メモ番号は、リストallproductsmemosで確認できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

memo_no
Required

メモ番号

システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。

Request Copy

Response Copy

Products options

Endpoints

GET /api/v2/admin/products/{product_no}/options
POST /api/v2/admin/products/{product_no}/options
PUT /api/v2/admin/products/{product_no}/options
DELETE /api/v2/admin/products/{product_no}/options

Products options properties

Attribute	Description
shop_no	ショップ番号
product_no Required	商品番号
has_option	オプション使用の設定 T:使用する F:使用しない
option_type	オプション構成方式 T:組み合わせ型 E:連携型 F:独立型
option_list_type	オプション表示方式 C:一体型 S:分離型
option_preset_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	バリエーションコード
options	オプション
select_one_by_option	オプション別に１個ずつ選択(独立型オプション) T:使用する F:使用しない
option_preset_name	連動型バリエーション名
use_additional_option	追加入力オプション使用の設定 T:使用する F:使用しない
additional_options	追加入力オプション
use_attached_file_option	ファイル添付オプション使用の設定 T:使用する F:使用しない
attached_file_option	ファイル添付オプション

Retrieve a list of product options cafe24 youtube

GET /api/v2/admin/products/{product_no}/options

GET

商品のオプションをリストで照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

Request Copy

Response Copy

Create product options cafe24 youtube

POST /api/v2/admin/products/{product_no}/options

POST

商品のオプションを作成して登録することができます。
オプションを登録すると、アイテムは自動的に生成されます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
has_option	オプション使用の設定 T:使用する F:使用しない
option_type	オプション構成方式オプションを使う場合、オプションのタイプを入力 ● 組合型 : オプション名を基準にオプション値を組み合わせることができる。 ● 商品連動型 : オプション表示方式は組合型と似ているが、必須オプションと選択オプションを選択することができる。オプションの組合せを制限なく生成することができる。 ● 独立選択型 : 独立的な複数の条件をそれぞれ選択できるオプションで、オプション値が組み合わせられずそれぞれの品目として生成される。 T:組み合わせ型 E:連携型 F:独立型
option_list_type	オプション表示方式組合型オプションを使う場合、組合型オプションのタイプを入力 * 組合一体選択型 : 一つのセレクトボックス(ボタンまたはラジオボタン)にすべてのオプションが組み合わせられて表示される。 * 組合分離選択型 : オプションをそれぞれのセレクトボックス(ボタンまたはラジオボタン)で選択でき、オプション名を基準にオプション値を組み合わせることができる。独立型や商品連動型オプションを使っている場合、S(分離型)と入力される。 S:組み合わせ分離選択型 C:組み合わせ一体選択型
options	オプション
option_name Required オプション名 option_value Array option_text オプション値 Required option_image_file オプションボタンの画像 option_color カラーチップの色 option_display_type オプション表示方式 S：セレクトボックス、P：プレビュー、B：テキストボタン、R：ラジオボタン DEFAULT S
select_one_by_option	オプション別に１個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する F:使用しない　「独立型だけに存在」をチェックするとオプション別に一つずつ選択値を処理
option_preset_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	バリエーションコード
option_preset_name	連動型バリエーション名商品連動型オプションを使う場合、オプションセットの名前を入力
use_additional_option	追加入力オプション使用の設定 T:使用する F:使用しない
additional_options	追加入力オプション
additional_option_name Required 追加入力オプション名 additional_option_text_length Required 追加入力オプションの文字数制限 1~30 50 100 200 required_additional_option Required 追加入力オプションの必須設定 T：必須、F：任意 DEFAULT T
use_attached_file_option	ファイル添付オプション使用の設定 T:使用する F:使用しない
attached_file_option	ファイル添付オプション

Request Copy

Response Copy

Update product options cafe24 youtube

PUT /api/v2/admin/products/{product_no}/options

PUT

商品のオプションを修正できます。
オプション名とオプション値、追加入力オプションとファイル添付オプションの修正のみ可能で、オプション項目を追加または削除することはできません。
また、生成されているアイテムは初期化しません。
オプションを追加または削除したい場合は、オプション削除API(Deleteaproductsoption)で削除した後、再度登録してください。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
option_list_type	オプション表示方式組合型オプションを使う場合、組合型オプションのタイプを入力 * 組合一体選択型 : 一つのセレクトボックス(ボタンまたはラジオボタン)にすべてのオプションが組み合わせられて表示される。 * 組合分離選択型 : オプションをそれぞれのセレクトボックス(ボタンまたはラジオボタン)で選択でき、オプション名を基準にオプション値を組み合わせることができる。独立型や商品連動型オプションを使っている場合、S(分離型)と入力される。 S:組み合わせ分離選択型 C:組み合わせ一体選択型
option_preset_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	バリエーションコード商品連動型オプションを使う場合、オプションセットコード入力
options	オプション
option_name Required オプション名 option_value Array option_text オプション値 Required option_image_file オプションボタンの画像 option_link_image オプション連動画像 option_color カラーチップの色 option_display_type オプション表示方式 S：セレクトボックス、P：プレビュー、B：テキストボタン、R：ラジオボタン DEFAULT S
original_options	修正前のオプション値
option_name Required オプション名 option_value Array option_text オプション値 Required
select_one_by_option	オプション別に１個ずつ選択(独立型オプション) 独立型オプションを使う場合、一つのオプションを重複して選択することができず、一つずつしか選択できない。 T:使用する F:使用しない　「独立型だけに存在」をチェックするとオプション別に一つずつ選択値を処理
option_preset_name	連動型バリエーション名商品連動型オプションを使う場合、オプションセットの名前を入力
use_additional_option	追加入力オプション使用の設定 T:使用する F:使用しない
additional_options	追加入力オプション
additional_option_name Required 追加入力オプション名 additional_option_text_length Required 追加入力オプションの文字数制限 1~30 50 100 200 required_additional_option Required 追加入力オプションの必須設定 T：必須、F：任意 DEFAULT T
use_attached_file_option	ファイル添付オプション使用の設定 T:使用する F:使用しない
attached_file_option	ファイル添付オプション

Request Copy

Response Copy

Delete a product option cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/options

DELETE

商品のオプションを削除できます。
オプションを削除すると、オプション機能が「未使用」状態になるため、既に生成されていた品目も一緒に削除されるので注意が必要です。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

Request Copy

Response Copy

Products seo

Endpoints

GET /api/v2/admin/products/{product_no}/seo
PUT /api/v2/admin/products/{product_no}/seo

Products seo properties

Attribute	Description
shop_no	ショップ番号
meta_title	ブラウザでのタイトル
meta_author	メタタグ1:Author
meta_description	メタタグ2:Description
meta_keywords	メタタグ3:Keywords
meta_alt	商品画像のalt属性
search_engine_exposure	検索エンジンでの表示設定 T:使用する F:使用しない

Retrieve a product's SEO settings cafe24 youtube

GET /api/v2/admin/products/{product_no}/seo

GET

特定商品のSEO設定を照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

Request Copy

Response Copy

Update product SEO settings cafe24 youtube

PUT /api/v2/admin/products/{product_no}/seo

PUT

特定商品のSEO設定を修正することができます。
ブラウザのタイトル、メタタグ、検索エンジンの露出設定などを修正できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号システムにより付与された商品の番号。商品番号はショップ内で重複しない。
meta_title	ブラウザでのタイトル商品詳細ページのTitleタグに表示される情報。Titleタグはブラウザーに表示される情報で、検索エンジンで検索時に一番基本的な情報である。
meta_author	メタタグ1:Author 商品詳細ページのタグに表示される情報。authorメタタグにはその商品を製造した人または登録した人を記入する。
meta_description	メタタグ2:Description 商品詳細ページのタグに表示される情報。descriptionタグに検索結果ページで検索結果の下に表示される簡単な情報を入力することができる。
meta_keywords	メタタグ3:Keywords 商品詳細ページのタグに表示される情報。keywordタグにその商品が検索されてほしいと思う検索キーワードを入力することができる。
meta_alt	商品画像のalt属性商品画像に表示されるAltテキスト情報。Altテキストを入力しておくと検索エンジンで画像検索時に検索される可能性が高くなり、ブラウザーで画像の代わりに関連テキストを出力することができるため、ウェブのアクセス性にも有利である。
search_engine_exposure	検索エンジンでの表示設定商品を検索エンジンに表示するかどうかを設定。「表示しない」に設定する場合、その商品が検索エンジンに表示されない。

Request Copy

Response Copy

Products tags

Endpoints

GET /api/v2/admin/products/{product_no}/tags/count
GET /api/v2/admin/products/{product_no}/tags
POST /api/v2/admin/products/{product_no}/tags
DELETE /api/v2/admin/products/{product_no}/tags/{tag}

Products tags properties

Attribute	Description
shop_no	ショップ番号
tags Required	商品タグ
product_no	商品番号
tag	商品タグ

Retrieve a count of a product's product tags cafe24 youtube

GET /api/v2/admin/products/{product_no}/tags/count

GET

特定の商品に登録されている商品タグの数を照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

Request Copy

Response Copy

Retrieve a list of a product's product tags cafe24 youtube

GET /api/v2/admin/products/{product_no}/tags

GET

商品に登録されているタグをリストで照会することができます。
商品タグ、商品番号などを照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

Request Copy

Response Copy

Create product tags cafe24 youtube

POST /api/v2/admin/products/{product_no}/tags

POST

特定の商品に検索または分類のための商品タグを登録できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号システムにより付与された商品の番号。商品番号はショップ内で重複しない。
tags Required Array Max : [100]	商品タグショッピングキュレーション使用時 - 配列の最大サイズ: [100]

Request Copy

Response Copy

Delete a product tag cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/tags/{tag}

DELETE

特定の商品に登録されている特定のタグを削除できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

tag

商品タグ

検索または分類のために商品に入力する検索キーワード情報(ハッシュタグ)

Request Copy

Response Copy

Products variants

Endpoints

GET /api/v2/admin/products/{product_no}/variants
GET /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}
PUT /api/v2/admin/products/{product_no}/variants
DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

Products variants properties

Attribute	Description
shop_no	ショップ番号
variant_code Type : [A-Z0-9] Length Min : [12]~Max : [12]	商品品目コード
options	オプション
custom_variant_code Max Length : [40]	独自品目コード
display	表示ステータス T:販売する F:販売しない
selling	販売ステータス T:表示する F:表示しない
additional_amount	追加金額
use_inventory	在庫使用の設定 T:使用する F:使用しない
important_inventory	重要在庫の有無 A:一般在庫 B:重要在庫
inventory_control_type	在庫数量チェックの基準 A:注文基準 B:決済基準
display_soldout	在庫切れ表示の設定 T:在庫切れ表示を使用する F:在庫切れ表示を使用しない
quantity	数量
safety_inventory	安全在庫数量
image	品目画像
inventories	在庫リソース
duplicated_custom_variant_code	独自品目コードの重複有無 T:重複する F:重複しない
product_no	商品番号

Retrieve a list of product variants cafe24 youtube

GET /api/v2/admin/products/{product_no}/variants

GET

商品の品目を一覧で照会することができます。
商品の品目コード、陳列状態、販売状態などを照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

inventories
embed

在庫リソース

品目の在庫Resource
Embedパラメーターを使って照会することができる。

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Retrieve a product variant cafe24 youtube

GET /api/v2/admin/products/{product_no}/variants/{variant_code}

GET

商品の特定の品目を照会することができます。
オプション情報、独自品目コード、陳列·販売状態などを照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
variant_code Required Type : [A-Z0-9] Length Min : [12]~Max : [12]	品目コード
inventories embed	在庫リソース Embedパラメーターを使って照会することができる。

Request Copy

Response Copy

Update a product variant cafe24 youtube

PUT /api/v2/admin/products/{product_no}/variants/{variant_code}

PUT

商品の特定の品目を修正できます。
独自の品目コード、陳列状態、販売状態、追加金額などを修正できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号システムにより付与された商品の番号。商品番号はショップ内で重複しない。
variant_code Required Type : [A-Z0-9] Length Min : [12]~Max : [12]	商品品目コードシステムにより品目に付与されたコード。ショップ内で品目コードは重複しない。
custom_variant_code Max Length : [40]	独自品目コード * Youtube shopping をご利用の場合は提供されませんユーザーが品目に付与可能なコード。在庫管理などの理由で独自に商品を管理している場合に使う。
display	表示ステータス * Youtube shopping をご利用の場合は提供されません品目を表示するかどうかを設定。品目を表示する場合、商品詳細または商品リストでその品目を選択することができる。品目が設定されていない場合、その品目が表示されないため、その品目を購入することができない。 T:表示する F:表示しない
selling	販売ステータス品目を販売するかどうかを設定。表示されているが販売はしない場合、その品目は「在庫切れ」と表示され、その品目を購入することができない。品目のステータスが「販売」であっても「表示しない」になっているとその品目は購入できない。 T:販売する F:販売しない
additional_amount	追加金額品目を購入する時、商品の販売価格に加えて支払わなければならない追加価格
quantity	数量
use_inventory	在庫使用の設定 T:使用する F:使用しない
important_inventory	重要在庫の有無 * Youtube shopping をご利用の場合は提供されません A:一般在庫 B:重要在庫
inventory_control_type	在庫数量チェックの基準 A:注文基準 B:決済基準
display_soldout	在庫切れ表示の設定 T:在庫切れ表示を使用する F:在庫切れ表示を使用しない
safety_inventory	安全在庫数量 * Youtube shopping をご利用の場合は提供されません

Request Copy

Response Copy

Update multiple product variants cafe24 youtube

PUT /api/v2/admin/products/{product_no}/variants

PUT

一つの商品に対する複数の品目を同時に修正できる品目修正(マルチ)APIです。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
product_no Required	商品番号
variant_code Required Type : [A-Z0-9] Length Min : [12]~Max : [12]	商品品目コード
custom_variant_code Max Length : [40]	独自品目コード
display	表示ステータス T:表示する F:表示しない
selling	販売ステータス T:販売する F:販売しない
additional_amount	追加金額
quantity	数量
use_inventory	在庫使用の設定 T:使用する F:使用しない
important_inventory	重要在庫の有無 A:一般在庫 B:重要在庫
inventory_control_type	在庫数量チェックの基準 A:注文基準 B:決済基準
display_soldout	在庫切れ表示の設定 T:在庫切れ表示を使用する F:在庫切れ表示を使用しない
safety_inventory	安全在庫数量

Request Copy

Response Copy

Delete a product variant cafe24 youtube

DELETE /api/v2/admin/products/{product_no}/variants/{variant_code}

DELETE

商品の特定の品目を削除できます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

variant_code
Required

Type : [A-Z0-9]
Length Min : [12]~Max : [12]

商品品目コード

システムにより品目に付与されたコード。ショップ内で品目コードは重複しない。

Request Copy

Response Copy

Products variants inventories

Endpoints

GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories
PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

Products variants inventories properties

Attribute	Description
shop_no	ショップ番号
variant_code Type : [A-Z0-9] Length Min : [12]~Max : [12]	品目コード
use_inventory	在庫使用の設定 T:使用する F:使用しない
important_inventory	重要在庫の有無 A:一般在庫 B:重要在庫
inventory_control_type	在庫数量チェックの基準 A:注文基準 B:決済基準
display_soldout	在庫切れ表示の設定 T:在庫切れ表示を使用する F:在庫切れ表示を使用しない
quantity	数量
safety_inventory	安全在庫数量
origin_code	出荷元コード

Retrieve inventory details of a product variant cafe24 youtube

GET /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

GET

商品の在庫を照会することができます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

variant_code
Required

Type : [A-Z0-9]
Length Min : [12]~Max : [12]

品目コード

販売数量を検索する品目コード

Request Copy

Response Copy

Update a product variant inventory cafe24 youtube

PUT /api/v2/admin/products/{product_no}/variants/{variant_code}/inventories

PUT

商品の品目の在庫に関する情報を修正できます。
在庫管理の使用有無、重要在庫の有無、安全在庫の設定、在庫数量の修正などができます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no Required	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。
variant_code Required Type : [A-Z0-9] Length Min : [12]~Max : [12]	品目コードシステムにより品目に付与されたコード。ショップ内で品目コードは重複しない。
use_inventory	在庫使用の設定品目に対して在庫管理を使うかどうかを設定。在庫管理を使う場合、在庫数を入力することができる。在庫管理を使わない場合、その商品は在庫と関係なく販売可能で、在庫数、在庫数チェック基準、在庫切れ表示の設定を使うことができない。 T:使用する F:使用しない
important_inventory	重要在庫の有無在庫を重要管理するかどうかを設定。ショップでは検索するための区分データとして使う。 A:一般在庫 B:重要在庫
inventory_control_type	在庫数量チェックの基準在庫数量をどの時点で差し引くかという基準。銀行振込のように決済時点と注文時点が異なる場合は在庫を差し引く基準をそれぞれ設定することができる。注文基準: 注文した時点で在庫を差し引く。銀行振込の場合は入金が完了しなくても在庫を差し引く。決済基準: 決済した時点で在庫を差し引く。銀行振込の場合は入金が完了した後、在庫を差し引く。 A:注文基準 B:決済基準
display_soldout	在庫切れ表示の設定在庫がすべて販売された場合、その品目を在庫切れと表示するかどうかの設定。在庫切れと表示されると注文ができない。すべての品目が在庫切れになる場合はその商品に在庫切れアイコンが表示される。「表示しない」を選択すると在庫がすべて販売されても注文が可能で、在庫がマイナス(-)と表記される。 T:在庫切れ表示を使用する F:在庫切れ表示を使用しない
quantity	数量販売可能な在庫数。在庫数は注文または決済時に差し引かれ、在庫切れの表示のためにチェックされる。
safety_inventory	安全在庫数量
origin_code	出荷元コード

Request Copy

Response Copy

Products customproperties

Endpoints

GET /api/v2/admin/products/customproperties
POST /api/v2/admin/products/customproperties
PUT /api/v2/admin/products/customproperties/{property_no}
DELETE /api/v2/admin/products/customproperties/{property_no}

Products customproperties properties

Attribute	Description
custom_properties	ユーザー定義属性

Retrieve user-defined properties cafe24 youtube

GET /api/v2/admin/products/customproperties

GET

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

Request Copy

Response Copy

Create user-defined properties cafe24 youtube

POST /api/v2/admin/products/customproperties

POST

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
custom_properties	ユーザー定義属性
property_name Required ユーザー定義属性の属性名

Request Copy

Response Copy

Update user-defined properties cafe24 youtube

PUT /api/v2/admin/products/customproperties/{property_no}

PUT

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
property_no Required	ユーザー定義属性の属性番号
property_name Required Max Length : [250]	ユーザー定義属性の属性名

Request Copy

Response Copy

Delete user-defined properties cafe24 youtube

DELETE /api/v2/admin/products/customproperties/{property_no}

DELETE

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40

要求スペック

Parameter	Description
property_no Required	ユーザー定義属性の属性番号

Request Copy

Response Copy

Products decorationimages

「Decorationimages」は、ショップに表示中の商品画像の上に追加して商品をより目立たせる機能です。ショップに登録されているデコ画像を照会して商品ごとにデコ画像を指定したり、商品に登録されているデコ画像を照会することができます。

デコ画像はサブリソースであるため、「Products」の以下で使用可能です。

Endpoints

GET /api/v2/admin/products/decorationimages

Products decorationimages properties

Attribute	Description
code	デコ画像コード
path	デコ画像URL

Retrieve a list of decoration images cafe24 youtube

GET /api/v2/admin/products/decorationimages

GET

ショッピングモールに登録されている飾り画像をリストで照会します。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

Request Copy

Response Copy

Products icons

商品アイコンは商品をアピールするために商品の横に追加する小さい画像です。表示されている商品に割引情報、「在庫わずか」などのメッセージを追加して商品をアピールすることができます。
商品アイコンは下位Resourceで、商品(Products)の下位でしか使えません。

Endpoints

GET /api/v2/admin/products/icons

Products icons properties

Attribute	Description
code	アイコンコード
path	アイコンURL

Retrieve a list of icons cafe24 youtube

GET /api/v2/admin/products/icons

GET

商品に登録されているすべてのアイコンを照会できます。
現在、特定の商品にどのアイコンが登録されているかを確認できます。

基本スペック

Property	Description
SCOPE	商品の閲覧権限 (mall.read_product)
呼び出し件数制限	40

Request Copy

Response Copy

Products images

商品画像(Products Images)は商品を販売するためにアップロードした商品の写真や絵を意味します。商品画像APIを使って商品詳細説明に使う画像や商品の画像をアップロードすることができます。
商品の画像はBase64コードでエンコードしてアップロードできます。

Endpoints

POST /api/v2/admin/products/images

Products images properties

Attribute	Description
path	詳細画像

Upload images cafe24

POST /api/v2/admin/products/images

POST

画像をアップロードできます。
商品に画像を登録するには、画像を最初にアップロードする必要があります。
商品の画像はBase64コードでエンコードしてアップロードできます。

基本スペック

Property	Description
SCOPE	商品の投稿権限 (mall.write_product)
呼び出し件数制限	40
1回当たり申込件数の制限	20

要求スペック

Parameter

Description

image
Required

詳細画像

● 画像ファイル容量制限:10MB
● 1呼出あたりの画像全体容量制限:30MB

Request Copy

Response Copy

Cancellation

キャンセル(Cancellation)は、特定の注文を配送前にキャンセルする機能です。
販売者が受付した後から作成され、キャンセル処理中の段階を経てキャンセル完了まで行われます。
キャンセルリソースでは、複数の注文を一度にキャンセルしたり、キャンセルステータスを修正したり、照会したりできます。
特定の注文をキャンセルする場合と違って、PGのキャンセルまで進めるようにキャンセルすることはできません。

Endpoints

GET /api/v2/admin/cancellation/{claim_code}
POST /api/v2/admin/cancellation
PUT /api/v2/admin/cancellation

Cancellation properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
claim_code	キャンセル番号
claim_reason_type	区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
claim_reason	理由
refund_methods	返金方式
refund_reason	備考
order_price_amount	商品購入金額
refund_amounts	返金額
shipping_fee	送料
return_ship_type	返品送料の適用区分
defer_commission	後払い手数料
partner_discount_amount	提携割引のキャンセル金額
add_discount_amount	商品別追加割引のキャンセル金額
member_grade_discount_amount	会員ランク割引のキャンセル金額
shipping_discount_amount	送料割引のキャンセル金額
coupon_discount_amount	クーポン割引のキャンセル金額
point_used	使用済みポイントの返還額
credit_used	使用済み預り金の返還額
undone	取消しの有無 T：取り消す F：取り消さない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason	注文詳細に表示される取消しの理由
items	品目別注文コード
include_tax	価格に税金が含まれているかどうか T：税込み F：税抜き
tax	税金情報税管理者アプリを使用しない場合はnullで返却
status	注文ステータス canceled：キャンセル完了 canceling：キャンセル処理中
recover_inventory	在庫の回復 T : 復元する F : 復元しない
add_memo_too	運営者メモに追加する T：使用する F：使用しない

Retrieve an order cancellation cafe24 youtube

GET /api/v2/admin/cancellation/{claim_code}

GET

キャンセルが完了したか、キャンセル処理中の内訳を照会することができます。
払い戻し方法、払い戻し金額、撤回理由の区分などが確認できます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

claim_code
Required

キャンセル番号

Request Copy

Response Copy

Create multiple order cancellations cafe24 youtube

POST /api/v2/admin/cancellation

POST

配送前の複数の注文をキャンセルできます。
該当APIを使用してキャンセルする場合、払い戻し完了処理まではなりますが、PGキャンセルまでは進まず、別途PGキャンセル処理をしなければなりません。
一部キャンセルする場合、各払い戻し金額は自動的に計算され、払い戻し処理されます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
status Required	注文ステータス canceled：キャンセル完了 canceling：キャンセル処理中
recover_inventory	在庫の回復 T : 復元する F : 復元しない DEFAULT F
recover_coupon	クーポン復元オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可 T : 復元する F : 復元しない DEFAULT F
recover_coupon_no	復元対象のクーポンID
add_memo_too	運営者メモに追加するオープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可 T：使用する F：使用しない DEFAULT F
reason Max Length : [2000]	キャンセル理由
claim_reason_type	キャンセル理由の区分オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
naverpay_cancel_reason_type	Naver Payで注文した件のキャンセル理由の区分ショッピングモール/オープンマーケット/カカオペイの注文をキャンセルする場合は使用不可 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 51 : 心変わり 52 : カラーまたはサイズ変更 53 : 誤注文 54 : サービス・商品への不満 55 : 配送遅延 56 : 在庫切れ 60 : 商品情報との不一致
kakaopay_cancel_reason_type	Kakaopayで注文した件のキャンセル理由の区分オープンマーケット/ネイバーペイ注文をキャンセルする場合は使用不可 K1：顧客の都合によるキャンセル K2：誤注文(オプション・商品の選択ミス) K3：配送遅延 K4：商品破損・商品不良 K5：配送ミス・配送漏れ K6：商品情報との不一致 K7：在庫切れによる配送不可
refund_method_code	返金方式 (オープンマーケット/ネイバーペイ/カカオペイの注文をキャンセルした場合、使用不可) T : 現金 F : クレジットカード M : ポイント G : 口座振込 C : キャリア決済 D : 預り金 V：コンビニ決済 J：提携商品券 K：提携ポイント I：その他
refund_bank_code	返金先の銀行コード払い戻し方式(refund_method)が現金(T)の場合必須 refund_bank_code 当該ショッピングモールがEC Korea ショッピングモールの場合、必須払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可
refund_bank_name Max Length : [250]	返金先の銀行名払い戻し方式(refund_method)が現金(T)の場合必須 ※ 当該ショッピングモールがEC Global ショッピングモールの場合、必須払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可
refund_bank_account_no	返金の口座番号払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可
refund_bank_account_holder Max Length : [15]	返金先の口座名義
items	品目別注文コード
order_item_code Required 品目別注文コード quantity Required 数量

Request Copy

Response Copy

Change cancellation details in bulk cafe24 youtube

PUT /api/v2/admin/cancellation

PUT

注文のキャンセルステータスを修正できます。
キャンセルが受け付けられた注文の注文状態をキャンセル受付前の状態に撤回することが、
注文のキャンセル状態を修正してキャンセル受付を撤回し、在庫を復旧したり、撤回理由を入力することができます。
宅配業者にすでに回収します。要請が伝達されたが回収が必要なくなる場合、宅配業者に直接連絡して回収します。申し込みをキャンセルしていただく必要があります。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
claim_code Required	キャンセル番号
recover_inventory Required	在庫の回復 T : 復元する F : 復元しない
undone Required	取消しの有無 T : 철회함
add_memo_too Required	運営者メモに追加する T：使用する F：使用しない
undone_reason_type Required	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason Max Length : [2000]	取消しの理由
expose_order_detail Required	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason Max Length : [2000]	注文詳細に表示される取消しの理由

Request Copy

Response Copy

Cancellationrequests

キャンセル要請(Cancellationrequests)は注文に対するキャンセル要請に関する機能です。
キャンセルを要請したり、キャンセル要請中の注文を受付拒否することができます。

Endpoints

POST /api/v2/admin/cancellationrequests
PUT /api/v2/admin/cancellationrequests

Cancellationrequests properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
items	品目別注文一覧
undone	受付を拒否するかどうか
order_item_code	品目別注文コード

Create a cancellation request for multiple items cafe24 youtube

POST /api/v2/admin/cancellationrequests

POST

キャンセルを要請することができます。
キャンセル理由と口座払い戻しの場合は、払い戻しする口座番号を入力できます。
, (コンマ)で複数件同時にキャンセル要請することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
reason_type Required	キャンセル理由の区分 A : お客様都合 B : 配送遅延 G : サービスへの不満 I : その他
reason Required Max Length : [2000]	キャンセル理由
refund_bank_code	返金先の銀行コード払い戻し方式(refund_method)が現金(T)の場合必須 refund_bank_code 当該ショッピングモールがEC Korea ショッピングモールの場合、必須払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能オープンマーケット/ネイバーペイ注文をキャンセルする場合は使用不可
refund_bank_name Max Length : [250]	返金先の銀行名
refund_bank_account_no	返金の口座番号
refund_bank_account_holder Max Length : [15]	返金先の口座名義
items	品目別注文一覧
order_item_code Required 品目別注文コード quantity Required 数量

Request Copy

Response Copy

Reject a cancellation request for multiple items cafe24 youtube

PUT /api/v2/admin/cancellationrequests

PUT

キャンセル要請された注文の特定品主に対してキャンセル要請中の状態を変更することができます。
受付拒否ができ、理由を入力できます。
, (コンマ)で複数件同時にキャンセル要請することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
order_item_code Required	品目別注文コード
undone Required	受付を拒否するかどうか T：受付を拒否する
reason_type	理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
reason Max Length : [2000]	理由
display_reject_reason	注文詳細の表示設定 T：表示する F：表示しない DEFAULT F
reject_reason Max Length : [2000]	拒否の理由

Request Copy

Response Copy

Cashreceipt

現金領収書(Cashreceipts)は現金で購入した後、購入者が発行することができる決済証明です。
現金領収書リソースを通じて現金領収書を発行または修正することができ、現在まで発行された現金領収書を照会することができます。
現金領収書は大韓民国にしかない制度で、韓国のショッピングモールでのみ使用できます。

Endpoints

GET /api/v2/admin/cashreceipt
POST /api/v2/admin/cashreceipt
PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

Cashreceipt properties

Attribute	Description
cashreceipt_no	現金領収証番号
approval_no	承認番号
request_date	申込日
order_id	注文番号
member_id	会員ID
name	要請者名
order_price_amount	商品購入金額
vat	消費税
subtotal	申込み金額合計
order_status	注文ステータス入金前：unpaid 未配送：unshipped 配送中：shipping 出荷待ち：standby 配送完了：shipped 一部キャンセル：partially_canceled すべてキャンセル： canceled
status	処理ステータス申込み：request 発行待ち：await_issuance 発行：issued 発行拒否：issuance_rejected 申込み取消し：canceled_request 発行取消し：canceled_issuance 発行失敗：failed_issuance
pg_name	申込の決済代行会社
cash_bill_no	現金領収証の一連番号
partner_id	決済代行会社が発行した加盟店ID
type	発行タイプ個人：personal 事業者： business
company_registration_no	事業者登録番号
cellphone	電話番号(携帯)
tax_amount	課税金額
tax_free_amount	免税金額
supply_price	仕入れ価格

Retrieve a list of cash receipts cafe24

GET /api/v2/admin/cashreceipt

GET

現在までに発行された現金領収書を照会することができます。
該当APIは韓国語ショッピングモールでのみ使用可能です。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
start_date Required Date	検索開始日
end_date Required Date	検索終了日
order_id Order ID	注文番号 ,(コンマ)で複数の件を検索することができる。
approval_no Max Length : [9]	承認番号
name Max Length : [20]	要請者名
member_id Max Length : [20]	会員ID
status	処理ステータスすべて：all 申込み：request 発行：issued 申込み取消し：canceled_request 発行取消し：canceled_issuance 発行失敗： failed_issuance DEFAULT all
limit Min : [1]~Max : [500]	検索結果の最大件数 DEFAULT 10
offset Max : [8000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Create a cash receipt cafe24

POST /api/v2/admin/cashreceipt

POST

特定の注文番号に対して現金領収書を発行することができます。
該当APIは韓国語ショッピングモールでのみ使用可能です。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
order_id Required Order ID	注文番号
type Required	発行タイプ個人：personal 事業者： business
company_registration_no Business Number Max Length : [10]	事業者登録番号
cellphone Mobile Max Length : [11]	電話番号(携帯)

Request Copy

Response Copy

Update a cash receipt cafe24

PUT /api/v2/admin/cashreceipt/{cashreceipt_no}

PUT

発行された現金領収書情報を修正できます。
該当APIは韓国語ショッピングモールでのみ使用可能です。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
cashreceipt_no Required Min : [1]	現金領収証番号
order_id Required Order ID	注文番号
type	発行タイプ個人：personal 事業者： business
company_registration_no Business Number Max Length : [10]	事業者登録番号
cellphone Mobile Max Length : [11]	電話番号(携帯)

Request Copy

Response Copy

Cashreceipt cancellation

Endpoints

PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

Cashreceipt cancellation properties

Attribute

Description

cashreceipt_no

現金領収証番号

order_id

注文番号

status

処理ステータス

申込み取消し：canceled_request
発行取消し：canceled_issuance

Update a cash receipt cancellation cafe24

PUT /api/v2/admin/cashreceipt/{cashreceipt_no}/cancellation

PUT

発行された現金領収書に対して申請取り消しまたは発行取り消しができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

cashreceipt_no
Required

Min : [1]

現金領収証番号

order_id
Required

Order ID

注文番号

type
Required

取消しタイプ

申込み取消し：request
発行取消し： issue

Request Copy

Response Copy

Collectrequests

収集申請情報(Collectrequests)は返品、交換処理で収集要請時に収集申請情報を修正できるリソースです。

Endpoints

PUT /api/v2/admin/collectrequests/{request_no}

Collectrequests properties

Attribute	Description
shop_no	ショップ番号
request_no	LIBSPECDATAREQUEST.NUMBER
order_id	注文番号
order_item_code	品目別注文コード
shipping_company_name	LIBSPECDATACOLLECT.SHIPPING.COMPANY.NAME
collect_tracking_no	LIBSPECDATACOLLECTION.TRACKING.NUMBER

Update a collection request cafe24

PUT /api/v2/admin/collectrequests/{request_no}

PUT

採番される送り状番号を利用して回収申請情報を修正します。
要求番号と回収送り状番号を必須入力します。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	30
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

request_no
Required

LIBSPECDATAREQUEST.NUMBER

collect_tracking_no
Required

Max Length : [40]

LIBSPECDATACOLLECTION.TRACKING.NUMBER

Request Copy

Response Copy

Control

Endpoints

PUT /api/v2/admin/control

Control properties

Attribute	Description
payments_control	注文の入金確認制限を使用するかどうか
direct_url	接続URL

Order control cafe24

PUT /api/v2/admin/control

PUT

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

payments_control
Required

注文の入金確認制限を使用するかどうか

T：使用する
F：使用しない

direct_url
Required

URL

接続URL

Request Copy

Response Copy

Draftorders

仮注文(Draftorders)は注文予約処理ができる機能です。
仮注文を通じて決済前に注文番号、決済金額などの注文情報を事前に確認することができます。

Endpoints

POST /api/v2/admin/draftorders

Draftorders properties

Attribute	Description
shop_no	ショップ番号
order_id	주문 번호
payment_amount	가주문 가격 정보
order_from_mobile	モバイル区分 T:モバイル注文 F:モバイル注文ではない DEFAULT F
payment_method Max Length : [10]	決済方法コード cash : 銀行振込 card : クレジットカード cell : キャリア決済 tcash : 口座振込 icash : バーチャル口座 prepaid : 前払い credit : 預り金 point : ポイント pointfy : 総合ポイント cvs : コンビニ cod : 後払い coupon : クーポン market_discount : モール型ECサイト割引 etc : その他
items	注文商品リスト

Create a draft order cafe24

POST /api/v2/admin/draftorders

POST

注文の予約処理をします。
注文予約処理を通じて決済前に注文番号、決済金額などの注文情報を事前に確認することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
member_id Max Length : [20]	会員ID
order_from_mobile	モバイル区分 T : モバイル注文 F : PC注文 DEFAULT F
payment_method Max Length : [10]	決済方法コード cash：銀行振込 card：クレジットカード icash：バーチャル口座 tcash：口座振込 cell：キャリア決済 deferpay：後払い point：ポイント
order_place_id Type : [a-zA-Z0-9_-] Max Length : [40]	注文ルート self : PCショップ(Cafe24注文のみ使用可能) mobile : Mobileショップ(Web)(Cafe24注文のみ使用可能) mobile_d : Mobileショップ(App)(Cafe24注文のみ使用可能)
country_code	国コード
payment_gateway_name Max Length : [20]	決済代行会社名
receiver_name Required Max Length : [100]	受取人名
receiver_name_en Max Length : [100]	受取人名(ローマ字)
receiver_name_furigana Max Length : [100]	受取人名(フリガナ)
receiver_phone Required	受取人の電話番号(固定)
receiver_cellphone Required	受取人の電話番号(携帯)
receiver_zipcode Length Min : [2]~Max : [14]	受取人の郵便番号
receiver_address1	受取人の住所(基本)
receiver_address2	受取人の住所(詳細)
receiver_city	受取人住所(市)
receiver_state	受取人住所(都道府県)
shipping_message	配送メッセージ
buyer_name Required Max Length : [100]	注文者名
buyer_email Email	注文者のメールアドレス
buyer_phone	注文者の固定電話番号
buyer_cellphone	注文者の電話番号(携帯)
buyer_zipcode Required Length Min : [2]~Max : [14]	注文者の郵便番号
buyer_address1 Required Max Length : [250]	注文者の住所(基本)
buyer_address2 Required	注文者の住所(詳細)
no_shipping_required	配送先の住所無し T：配送先の住所無し F：配送先の住所有り DEFAULT F
buyer_ip IP	注文者ip
transaction_id Max Length : [100]	クレジットカード取引ID
bank_code Type : [a-z0-9_-]	銀行コード
bank_account_no Max Length : [30]	口座番号
bank_account_owner_name Max Length : [100]	口座名義
shipping_type	配送タイプ A:国内 B:海外
send_order_message	新規注文案内メッセージの送信設定 T:発送する F:発送しない DEFAULT F
send_payment_guide_message	入金案内メッセージの送信設定 T:発送する F:発送しない DEFAULT F
send_order_email	新規注文案内メールの送信設定 T:発送する F:発送しない DEFAULT F
clearance_information_type	通関情報タイプ I：身分証明書(ID)番号 P：パスポート番号 C：個人通関固有符号
clearance_information	通関情報
self_payment_cancel	PayPal決済のみキャンセルが可能かどうか T：キャンセル可能 F：キャンセル不可 DEFAULT F
self_payment_cancel_url	「PayPal決済のみキャンセル」APIのURL
items	注文商品リスト
product_no Required 商品番号 product_code Required 商品コード option_id Required 商品オプションID quantity Required 注文数量 product_bundle セット商品の有無 T:使用する、F:使用しない prepaid_shipping_fee 送料前払いの設定 P:前払い、C:着払い product_bundle_no セット商品番号

Request Copy

Response Copy

Exchange

交換(Exchange)は、注文の交換受付の状態を変更するリソースです。
交換の受付をすることができます。また、交換を受付した注文のステータスを修正することもできます。

Endpoints

GET /api/v2/admin/exchange/{claim_code}
POST /api/v2/admin/exchange
PUT /api/v2/admin/exchange

Exchange properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
claim_code	返品番号
claim_reason_type	区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
claim_reason	理由
claim_due_date	交換処理の予定日
receiver	受取人
reshipping_detail	交換による再発送の情報
pickup	受取人の住所
additional_payment	追加決済
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name	返品に使用する配送会社名
refund_methods	返金方式
refund_reason	備考
order_price_amount	商品購入金額
refund_amounts	返金額
shipping_fee	送料
return_ship_type	返品送料の適用区分
defer_commission	後払い手数料
partner_discount_amount	提携割引のキャンセル金額
add_discount_amount	商品別追加割引のキャンセル金額
member_grade_discount_amount	会員ランク割引のキャンセル金額
shipping_discount_amount	送料割引のキャンセル金額
coupon_discount_amount	クーポン割引のキャンセル金額
point_used	使用済みポイントの返還額
credit_used	使用済み預り金の返還額
undone	取消しの有無 T：取り消す F：取り消さない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason	注文詳細に表示される取消しの理由
items	品目別注文コード
exchanged_items	交換商品
include_tax	価格に税金が含まれているかどうか T：税込み F：税抜き
tax	税金情報税管理者アプリを使用しない場合はnullで返却
carrier_id	配送会社ID
return_invoice_success	返品用送り状の処理完了/失敗 T：成功 F：失敗 N：未集荷
return_invoice_fail_reason Max Length : [100]	返品用送り状の処理失敗の原因
status	注文ステータス accept : 受付 collected : 回収完了 exchanged:交換完了
recover_inventory	在庫の回復 T : 復元する F : 復元しない
exchanged_after_collected	回収完了時の交換完了設定 T:使用する F:使用しない
add_memo_too	運営者メモに追加する T：使用する F：使用しない
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前

Retrieve an exchange cafe24 youtube

GET /api/v2/admin/exchange/{claim_code}

GET

交換番号を入力して、交換が受け付けられた注文件を照会します。
注文番号、返品番号、理由、交換処理予定日などをご確認いただけます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

claim_code
Required

交換番号

Request Copy

Response Copy

Create multiple exchanges cafe24 youtube

POST /api/v2/admin/exchange

POST

交換申し込み状態の注文のステータスを、交換受付または交換完了に登録することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
status Required	注文ステータス accepted：交換受付 exchanged：交換完了
recover_inventory	在庫の回復 T : 復元する F : 復元しない DEFAULT F
add_memo_too	運営者メモに追加する T：使用する F：使用しない DEFAULT F
items	品目別注文コード
order_item_code Required 品目別注文コード quantity Required 数量 exchange_variant_code (同一商品の別のオプションに交換する場合)交換商品の品目コード
same_product Required	同一商品への交換有無 T：同じ商品に交換 F：別の商品に交換

Request Copy

Response Copy

Update multiple order exchanges cafe24 youtube

PUT /api/v2/admin/exchange

PUT

交換を受け付けした注文の状態を修正することができます。
多数の注文に対しての交換受付の取り消し、在庫の復元、取り消し理由の入力などができます。
配送会社にすでに回収の要請が済んでいるが、回収が必要なくなった場合は、配送会社に直接連絡して回収の要請を取り消してください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
claim_code Required	交換番号
status	注文ステータス exchanged：交換完了
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前
recover_inventory	在庫の回復 T : 復元する F : 復元しない
exchanged_after_collected	回収完了時の交換完了設定 T:使用する F:使用しない
items	品目別注文コード
order_item_code 品目別注文コード
undone	取消しの有無 T : 철회함
add_memo_too	運営者メモに追加する T：使用する F：使用しない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason Max Length : [2000]	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason Max Length : [2000]	注文詳細に表示される取消しの理由
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
carrier_id	配送会社ID
return_invoice_success	返品用送り状の処理完了/失敗 T：成功 F：失敗 N：未集荷
return_invoice_fail_reason Max Length : [100]	返品用送り状の処理失敗の原因

Request Copy

Response Copy

Exchangerequests

交換要請(Exchangerequests)は注文に対して交換を要請できる機能です。

Endpoints

POST /api/v2/admin/exchangerequests
PUT /api/v2/admin/exchangerequests

Exchangerequests properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
items	品目別注文一覧
exchange_request_no	交換申込番号
undone	受付を拒否するかどうか
order_item_code	品目別注文コード
additional_payment_gateway_cancel	추가 PG 취소

Bulk exchange request API cafe24 youtube

POST /api/v2/admin/exchangerequests

POST

特定の注文に対して交換リクエストの処理を行うことができます。
，(コンマ)で複数件同時に交換要請することができます。
交換事由と回収申請可否を一緒に登録できます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
reason_type Required	理由の区分 A：お客様都合 E：商品への不満 K：不良品 J：配送ミス I：その他
reason Required Max Length : [2000]	交換申込みの理由
request_pickup	回収申込の設定 T：回収申込み F：直接発送
pickup	回収地域の詳細
name Required お名前 phone 電話番号 cellphone Required 電話番号(携帯) zipcode Required 郵便番号 address1 Required 基本住所 address2 Required 詳細住所
tracking_no Max Length : [40]	返品用送り状の送り状番号
shipping_company_name Max Length : [30]	返品に使用する配送会社名
refund_bank_code	返金先の銀行コード
refund_bank_name Max Length : [250]	返金先の銀行名
refund_bank_account_no	返金の口座番号
refund_bank_account_holder Max Length : [15]	返金先の口座名義
items	品目別注文一覧
order_item_code Required 品目別注文コード quantity Required 数量
exchange_items	交換商品の情報
product_no Required 商品番号 variant_code Required 商品品目コード quantity Required 数量

Request Copy

Response Copy

Reject an exchange request for multiple items cafe24 youtube

PUT /api/v2/admin/exchangerequests

PUT

交換要請された注文の特定品主に対して交換要請中の状態を変更することができます。
受付拒否ができ、理由を入力できます。
、（コンマ）で複数件の交換要請件に対して同時に状態変更することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
order_item_code Required	品目別注文コード
undone Required	受付を拒否するかどうか T：受付を拒否する
reason_type	理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
reason Max Length : [2000]	理由
display_reject_reason	注文詳細の表示設定 T：表示する F：表示しない DEFAULT F
reject_reason Max Length : [2000]	拒否の理由

Request Copy

Response Copy

Fulfillments

配送アプリでN個の配送会社と連携し、配送情報を登録する機能です。

Endpoints

POST /api/v2/admin/fulfillments

Fulfillments properties

Attribute	Description
shop_no	ショップ番号 DEFAULT 1
tracking_no	送り状番号
shipping_company_code	配送会社コード
status	注文ステータス standby : 配送待ち shipping : 配送中
order_id	注文番号
shipping_code	配送番号
order_item_code	品目別注文コード
carrier_id	配送会社ID
post_express_flag	ゆうパック連動

Create shipping information for multiple orders via Fulfillment cafe24

POST /api/v2/admin/fulfillments

POST

配送アプリでは、複数の注文に対して配送情報を登録することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
tracking_no Required Max Length : [30]	送り状番号
shipping_company_code Required	配送会社コード
status Required	注文ステータス standby : 配送待ち shipping : 配送中
order_id	注文番号
shipping_code	配送番号
order_item_code	品目別注文コード
carrier_id	配送会社ID
post_express_flag	ゆうパック連動 S：送り状送信完了

Request Copy

Response Copy

Labels

Labels（注文ラベル）とは、各注文を簡単に識別し、区別するための機能です。

Endpoints

GET /api/v2/admin/labels
POST /api/v2/admin/labels

Labels properties

Attribute	Description
shop_no	ショップ番号
names	注文ラベル名
name	注文ラベル名
order_item_code	品目別注文コード

Retrieve order labels cafe24

GET /api/v2/admin/labels

GET

特定の注文のラベルを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

limit

Min : [1]~Max : [1000]

検索結果の最大件数

DEFAULT 100

offset

Max : [15000]

検索結果の開始位置

DEFAULT 0

Request Copy

Response Copy

Create multiple order labels cafe24

POST /api/v2/admin/labels

POST

特定の注文にラベルを登録することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

name
Required

注文ラベル名

order_item_code
Required

品目別注文コード

Request Copy

Response Copy

Orders

Orders Resource関係図

注文(order)はショップでショップの顧客が商品を購入するためにショップに要求した内訳です。ショップの運営者は決済済みの注文情報を見てショップの顧客に商品を配送します。注文情報には注文と決済を行った注文者の情報と商品を受け取る受取人の情報が含まれています。

注文は下記のようなResourceを下位Resourceとして持っています。
● 品目別注文(Items)
● 受取人情報(Receivers)

Endpoints

GET /api/v2/admin/orders
GET /api/v2/admin/orders/{order_id}
GET /api/v2/admin/orders/count
PUT /api/v2/admin/orders
PUT /api/v2/admin/orders/{order_id}

Orders properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
currency	通貨単位マルチショップの通貨単位
order_id	注文番号
market_id	モール型ECサイトの区分値価格比較サイトを経由してモール型ECサイトなどで商品を購入する場合、そのサイトを区分するためのID
market_order_no	モール型ECサイトの注文番号
member_id	会員ID
member_email	会員メールアドレス
member_authentication	会員認証の有無会員認証の設定。設定によって会員は3つのタイプに分けられる。 T:承認 B:特別管理会員 J:14歳未満の会員
billing_name	決済者名入金者の名前。注文者または受取人の名前と違う場合がある。
bank_code	銀行コード bank_code
bank_code_name	入金銀行名
payment_method	決済方法コード注文者が利用した決済方法のコード cash：銀行振込 card：クレジットカード cell：キャリア決済 tcash：口座振込 icash：バーチャル口座 prepaid：前払い credit：預り金 point：ポイント pointfy：総合ポイント cvs：コンビニ cod：後払い coupon：クーポン market_discount：モール型ECサイト割引 giftcard：提携商品券 pointcard：提携ポイント etc：その他
payment_method_name	決済方法名注文者が利用した決済方法の名前
payment_gateway_names	決済代行サービス名
sub_payment_method_name	海外決済方法名
sub_payment_method_code	海外決済方法のコード sub_payment_method_code
transaction_ids	クレジットカード取引ID
paid	決済の有無決済が完了したかどうかの表示 T：決済 F：未決済 M：一部決済
canceled	キャンセルされたかどうか T：キャンセル済み F：未キャンセル M：一部キャンセル済み
order_date	注文日
first_order	初注文の有無初めての注文であるかどうかの表示 T:初注文 F:初注文ではない
payment_date	決済日
order_from_mobile	モバイル区分注文をモバイルで行ったかどうかの区分 T:モバイル注文 F:モバイル注文ではない
use_escrow	エスクロー使用設定エスクローを使ったかどうかを設定 T：エスクローを使用する F：エスクローを使用しない
group_no_when_ordering	注文時の会員ランク
initial_order_amount	最初の注文金額
actual_order_amount	現在の注文金額実決済金額のうち、coupon_shipping_fee_amountは割引金額の自動計算を使用する場合のみ品目別に配送費配分が可能であるため、割引金額の自動計算機能を使用する場合のみ露出される。
bank_account_no	口座番号注文件に対するショップの口座番号
bank_account_owner_name	口座名義
market_seller_id	ECサイト販売者ID
payment_amount	最終決済金額
cancel_date	注文キャンセル日
order_place_name	注文ルートテキスト
order_place_id	注文ルート
payment_confirmation	後払いの入金確認可能の設定 T:入金確認 F:入金未確認
commission	決済手数料
postpay	後払い決済かどうか T:後払い決済 F:後払い決済ではない
admin_additional_amount	運営者入力金額
additional_shipping_fee	追加送料
international_shipping_insurance	海外配送保険料
additional_handling_fee	海外配送付加金額
shipping_type	配送タイプ配送タイプ。国内配送か海外配送も可能かを設定 A:国内 B:海外
shipping_type_text	配送タイプ名配送タイプの説明。国内配送か海外配送かも可能かを説明
shipping_status	配送ステータス F：配送前 M：配送中 T：配送完了 W：配送保留 X：発注前
wished_delivery_date	配送希望日
wished_delivery_time	配達希望時間
wished_carrier_id	希望配送会社コード
wished_carrier_name	希望配送会社名
return_confirmed_date	返品承認日時
total_supply_price	仕入れ価格合計
naver_point	Naverポイント
additional_order_info_list	注文書の追加項目
store_pickup	店舗受取の設定 T:店舗にて受取り F:店舗にて受取りではない
easypay_name	簡単決済の決済代行会社名
loan_status	与信状態 OK : GOOD NG : NOT GOOD ER : ERROR
subscription	定期購入の利用状況 T : 利用中 F : 非利用
items	品目別注文エンティティ Embedパラメーターを使って照会することができる。
receivers	受取人情報エンティティ Embedパラメーターを使って照会することができる。
buyer	注文者情報のリソース
shipping_fee_detail	送料情報
regional_surcharge_detail	地域別送料情報
return	返品詳細リソース
cancellation	キャンセル詳細リソース
exchange	交換詳細リソース
multiple_addresses	複数配送注文かどうか T : 複数配送注文 F : 複数配送注文ではない
exchange_rate	決済通貨の為替レート情報
first_payment_methods	最初に使用した決済方法のコード cash：銀行振込 card：クレジットカード cell：キャリア決済 tcash：口座振込 icash：バーチャル口座 prepaid：前払い credit：預り金 point：ポイント pointfy：総合ポイント cvs：コンビニ決済 cod：後払い giftcard：提携商品券 pointcard：提携ポイント etc：その他
naverpay_payment_information	Naver Pay決済代行サービス(PG)の決済情報 P：決済代行サービス(PG)決済 N：Naver Pay決済
include_tax	価格に税金が含まれているかどうか T：税込み F：税抜き
tax_detail	税金の詳細
service_type	注文サービスの種類 rental : レンタル注文
service_data	注文サービスデータ
show_shipping_address	配送先情報を表示するかどうか T：配送先情報を表示する F：配送先情報を表示しない
social_member_code	連携したSNSの提供コード
social_name	連携したSNS名
customer_group_no_when_ordering	注文時の会員ランク注文当時の会員ランク
benefits	特典リソース
coupons	クーポンリソース
refunds	返金詳細リソース
process_status	注文ステータス prepare：発送準備中 prepareproduct：商品準備中 hold：配送保留 unhold：配送保留解除
order_item_code	品目別注文コード
purchase_confirmation	購入を確定するかどうか
collect_points	ポイント回収

Retrieve a list of orders cafe24 youtube

GET /api/v2/admin/orders

GET

注文をリストで照会できます。
注文番号、貨幣単位、会員IDなどを照会することができます。
下位リソースをembedとして活用すると、一度の呼び出しに必要な情報をより多く照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
items embed	品目別注文エンティティ Embedパラメーターを使って照会することができる。
receivers embed	受取人情報エンティティ Embedパラメーターを使って照会することができる。
buyer embed	注文者情報のリソース
return embed	返品詳細リソース
cancellation embed	キャンセル詳細リソース
exchange embed	交換詳細リソース
multiple_addresses	複数配送注文かどうか T : 複数配送注文
shop_no Min : [1]	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
start_date Date	検索開始日検索を開始する基準日
end_date Date	検索終了日検索を終了する基準日検索開始日と一緒に使用しなければならない。検索期間は1回の呼び出しで3ヶ月以上検索できません。
order_id Order ID	注文番号 ,(コンマ)で複数の件を検索することができる。
order_status	注文ステータス注文ステータス。注文ステータス別にそれぞれのコードがある。 ,(コンマ)で複数の件を検索することができる。 N00：未入金 N10：商品準備中 N20：発送準備中 N21：出荷待ち N22：配送保留 N30：配送中 N40：配送完了 N50 : 購入確定 C00：キャンセル申込み C10：キャンセル受付 - 運営者 C34：キャンセル処理中 - 返金前 C35：キャンセル処理中 - 返金完了 C36：キャンセル処理中 - 返金保留 C40：キャンセル完了 C41：キャンセル完了 - 返金前 C42：キャンセル完了 - 返金申込中 C43：キャンセル完了 - 返金保留 C47：入金前キャンセル - 購入者 C48：入金前キャンセル - 自動キャンセル C49：入金前キャンセル - 運営者 R00：返品申込み R10：返品受付 R11：返品受付拒否 R12：返品保留 R13：返品受付 - 回収完了(自動) R20：返品回収完了 R30：返品処理中 - 回収前 R31：返品処理中 - 回収完了 R34：返品処理中 - 返金前 R36：返品処理中 - 返金保留 R40：返品完了 - 返金完了 R41：返品完了 - 返金前 R42：返品完了 - 返金申込中 R43：返品完了 - 返金保留 E00：交換申込み E10：交換受付 N01：交換受付 - 交換商品 E11：交換受付拒否 E12：交換保留 E13：交換受付 - 回収完了(自動) E20：交換準備 E30：交換処理中 - 回収前 E31：交換処理中 - 回収完了 E32：交換処理中 - 入金前 E33：交換処理中 - 入金完了 E34：交換処理中 - 返金前 E35：交換処理中 - 返金完了 E36：交換処理中 - 返金保留 E40：交換完了
payment_status	決済ステータス F：入金前 M：追加入金待ち T：入金完了(手動) A：入金完了(自動) P：決済完了
member_type	会員/非会員会員の有無。会員と非会員、それぞれのコードがある。 2:会員 3:非会員
group_no	会員ランク番号
buyer_name	注文者名注文者の名前。入金者または受取人の名前と異なる場合がある。
receiver_name	受取人名受取人の名前。注文者または入金者の名前と違う場合がある。
name_furigana	受取人名(フリガナ)
receiver_address	受取人の住所受取人の住所。注文者または入金者の住所と違う場合がある。
member_id	会員ID 会員ID
member_email	会員メールアドレス
product_no	商品番号商品番号 ,(コンマ)で複数の件を検索することができる。
product_code	商品コード商品コード
date_type	検索日付のタイプ検索するための日付タイプ基準。基本値は注文日に設定されている。 order_date：注文日 pay_date：決済日 shipbegin_date：配送開始日 shipend_date：配送完了日 cancel_date：注文キャンセル日 place_date：発注日 cancel_request_date：キャンセル申込日 cancel_accept_date：キャンセル受付日 cancel_complete_date：キャンセル完了日 exchange_request_date：交換申込日 exchange_accept_date：交換受付日 exchange_complete_date：交換完了日 return_request_date：返品申込日 return_accept_date：返品受付日 return_complete_date：返品完了日 purchaseconfirmation_date：購入確定日 DEFAULT order_date
supplier_id	供給会社のID ,(コンマ)で複数の件を検索することができる。
order_place_id	注文ルート ,(コンマ)で複数の件を検索することができる。 cafe24：Cafe24 mobile：モバイルウェブ mobile_d：モバイルアプリ NCHECKOUT：Naver Pay inpark：Interpark auction：Auction sk11st：11STREET gmarket：Gmarket coupang：coupang shopn：スマートストア
buyer_cellphone	注文者の電話番号(携帯)
buyer_phone	注文者の固定電話番号
buyer_email	注文者のメールアドレス
inflow_path	流入経路
subscription	定期購入の利用状況 T : 利用中 F : 非利用
market_order_no Type : [a-zA-Z0-9_-] Max Length : [40]	モール型ECサイトの注文番号 ,(コンマ)で複数の件を検索することができる。
market_cancel_request	ECサイトキャンセル申込み有無 T : キャンセル申込みされたECサイトからの注文
payment_method	決済方法コード ,(コンマ)で複数の件を検索することができる。 cash：銀行振込 card：クレジットカード tcash：口座振込 icash：バーチャル口座 cell：キャリア決済 deferpay：後払い cvs：コンビニ point：前払い mileage：ポイント deposit：預り金 giftcard：提携商品券 pointcard：提携ポイント etc：その他
payment_gateway_name	決済代行サービス名 ,(コンマ)で複数の件を検索することができる。
market_seller_id	ECサイト販売者ID
discount_method	割引タイプ ,(コンマ)で複数の件を検索することができる。 point：ポイント credit：預り金 coupon：クーポン market_discount：モール型ECサイト割引 discount_code：割引コード
discount_code	割引コード
carrier_id Min : [1]	配送会社ID
wished_carrier_id Min : [1]	LIBSPECDATAHOPE.SHIP.ID ,(コンマ)で複数の件を検索することができる。
labels	注文ラベル ,(コンマ)で複数の件を検索することができる。
refund_status	CS(返品)ステータス ,(コンマ)で複数の件を検索することができる。 F：返金前 T：返金完了 M：返金保留
limit Min : [1]~Max : [1000]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10
offset Max : [15000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Retrieve an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}

GET

注文1件を照会することができます。
注文番号、会員ID、決済手段などを照会することができます。
下位リソースをembedとして活用すると、一度の呼び出しに必要な情報をより多く照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
items embed	品目別注文エンティティ
receivers embed	受取人情報エンティティ
buyer embed	注文者情報のリソース
benefits embed	特典リソース
coupons embed	クーポンリソース * Youtube shopping をご利用の場合は提供されません
return embed	返品詳細リソース
cancellation embed	キャンセル詳細リソース
exchange embed	交換詳細リソース
refunds embed	返金詳細リソース

Request Copy

Response Copy

Retrieve a count of orders cafe24 youtube

GET /api/v2/admin/orders/count

GET

注文の数を照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
multiple_addresses	複数配送注文かどうか T : 複数配送注文
shop_no Min : [1]	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
start_date Date	検索開始日検索を始める基準日
end_date Date	検索終了日検索を終了する基準日検索開始日と一緒に使用しなければならない。検索期間は1回の呼び出しで3ヶ月以上検索できません。
order_id Order ID	注文番号 ,(コンマ)で複数の件を検索することができる。
order_status	注文ステータス注文ステータス。注文ステータス別にそれぞれのコードがある。 ,(コンマ)で複数の件を検索することができる。 N00：未入金 N10：商品準備中 N20：発送準備中 N21：出荷待ち N22：配送保留 N30：配送中 N40：配送完了 N50 : 購入確定 C00：キャンセル申込み C10：キャンセル受付 - 運営者 C34：キャンセル処理中 - 返金前 C35：キャンセル処理中 - 返金完了 C36：キャンセル処理中 - 返金保留 C40：キャンセル完了 C41：キャンセル完了 - 返金前 C42：キャンセル完了 - 返金申込中 C43：キャンセル完了 - 返金保留 C47：入金前キャンセル - 購入者 C48：入金前キャンセル - 自動キャンセル C49：入金前キャンセル - 運営者 R00：返品申込み R10：返品受付 R11：返品受付拒否 R12：返品保留 R13：返品受付 - 回収完了(自動) R20：返品回収完了 R30：返品処理中 - 回収前 R31：返品処理中 - 回収完了 R34：返品処理中 - 返金前 R36：返品処理中 - 返金保留 R40：返品完了 - 返金完了 R41：返品完了 - 返金前 R42：返品完了 - 返金申込中 R43：返品完了 - 返金保留 E00：交換申込み E10：交換受付 N01：交換受付 - 交換商品 E11：交換受付拒否 E12：交換保留 E13：交換受付 - 回収完了(自動) E20：交換準備 E30：交換処理中 - 回収前 E31：交換処理中 - 回収完了 E32：交換処理中 - 入金前 E33：交換処理中 - 入金完了 E34：交換処理中 - 返金前 E35：交換処理中 - 返金完了 E36：交換処理中 - 返金保留 E40：交換完了
payment_status	決済ステータス F：入金前 M：追加入金待ち T：入金完了(手動) A：入金完了(自動) P：決済完了
member_type	会員/非会員会員の有無。会員と非会員、それぞれのコードがある。 2:会員 3:非会員
group_no	会員ランク番号
buyer_name	注文者名注文者の名前。入金者または受取人の名前と異なる場合がある。
receiver_name	受取人名受取人の名前。注文者または入金者の名前と違う場合がある。
name_furigana	受取人名(フリガナ)
receiver_address	受取人の住所受取人の住所。注文者または入金者の住所と違う場合がある。
member_id	会員ID 会員ID
member_email	会員メールアドレス
product_no	商品番号商品番号 ,(コンマ)で複数の件を検索することができる。
product_code	商品コード検索キーワードが商品コードに含まれている商品検索(大文字・小文字を区別する)
date_type	検索日付のタイプ検索するための日付タイプ基準。基本値は注文日に設定されている。 order_date：注文日 pay_date：決済日 shipbegin_date：配送開始日 shipend_date：配送完了日 cancel_date：注文キャンセル日 place_date：発注日 cancel_request_date：キャンセル申込日 cancel_accept_date：キャンセル受付日 cancel_complete_date：キャンセル完了日 exchange_request_date：交換申込日 exchange_accept_date：交換受付日 exchange_complete_date：交換完了日 return_request_date：返品申込日 return_accept_date：返品受付日 return_complete_date：返品完了日 purchaseconfirmation_date：購入確定日 DEFAULT order_date
supplier_id	供給会社のID ,(コンマ)で複数の件を検索することができる。
order_place_id	注文ルート ,(コンマ)で複数の件を検索することができる。 cafe24：Cafe24 mobile：モバイルウェブ mobile_d：モバイルアプリ NCHECKOUT：Naver Pay inpark：Interpark auction：Auction sk11st：11STREET gmarket：Gmarket coupang：coupang shopn：スマートストア
buyer_cellphone	注文者の電話番号(携帯)
buyer_phone	注文者の固定電話番号
buyer_email	注文者のメールアドレス
inflow_path	流入経路
subscription	定期購入の利用状況 T : 利用中 F : 非利用
market_order_no Type : [a-zA-Z0-9_-] Max Length : [40]	モール型ECサイトの注文番号 ,(コンマ)で複数の件を検索することができる。
market_cancel_request	ECサイトキャンセル申込み有無 T : キャンセル申込みされたECサイトからの注文
payment_method	決済方法コード ,(コンマ)で複数の件を検索することができる。 cash：銀行振込 card：クレジットカード tcash：口座振込 icash：バーチャル口座 cell：キャリア決済 deferpay：後払い cvs：コンビニ point：前払い mileage：ポイント deposit：預り金 giftcard：提携商品券 pointcard：提携ポイント etc：その他
payment_gateway_name	決済代行サービス名 ,(コンマ)で複数の件を検索することができる。
market_seller_id	ECサイト販売者ID
discount_method	割引タイプ ,(コンマ)で複数の件を検索することができる。 point：ポイント credit：預り金 coupon：クーポン market_discount：モール型ECサイト割引 discount_code：割引コード
discount_code	割引コード
carrier_id Min : [1]	配送会社ID
wished_carrier_id Min : [1]	LIBSPECDATAHOPE.SHIP.ID ,(コンマ)で複数の件を検索することができる。
labels	注文ラベル ,(コンマ)で複数の件を検索することができる。
refund_status	CS(返品)ステータス ,(コンマ)で複数の件を検索することができる。 F：返金前 T：返金完了 M：返金保留

Request Copy

Response Copy

Update status for multiple orders cafe24 youtube

PUT /api/v2/admin/orders

PUT

複数の注文の注文ステータスを修正できます。
購入者や受取人の情報を修正するためには、Orders buyer、Orders receivers を確認してください。
注文の配送処理はOrders shipments をご確認ください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
process_status	注文ステータス prepare：発送準備中 prepareproduct：商品準備中 hold：配送保留 unhold：配送保留解除
order_item_code	品目別注文コード
purchase_confirmation	購入を確定するかどうか T：購入確定 F：購入確定の取り消し
collect_points	ポイント回収 * Youtube shopping をご利用の場合は提供されません T：回収する F：回収しない DEFAULT F
show_shipping_address	配送先情報を表示するかどうか T：配送先情報を表示する F：配送先情報を表示しない

Request Copy

Response Copy

Update an order status cafe24 youtube

PUT /api/v2/admin/orders/{order_id}

PUT

注文 1 件の注文ステータスを修正できます。
購入者や受取人の情報を修正するためには、Orders buyer、Orders receivers を確認してください。
注文の配送処理はOrders shipments をご確認ください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
process_status	注文ステータス prepare：発送準備中 prepareproduct：商品準備中 hold：配送保留 unhold：配送保留解除
order_item_code	品目別注文コード
purchase_confirmation	購入を確定するかどうか T：購入確定 F：購入確定の取り消し
collect_points	ポイント回収 * Youtube shopping をご利用の場合は提供されません T：回収する F：回収しない DEFAULT F
show_shipping_address	配送先情報を表示するかどうか T：配送先情報を表示する F：配送先情報を表示しない

Request Copy

Response Copy

Orders autocalculation

Endpoints

DELETE /api/v2/admin/orders/{order_id}/autocalculation

Orders autocalculation properties

Attribute

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id

注文番号

Remove auto calculation setting of an order cafe24

DELETE /api/v2/admin/orders/{order_id}/autocalculation

DELETE

特定の注文に自動金額の計算を解除し、キャンセル/交換/返品が可能になります。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

Request Copy

Response Copy

Orders buyer

Endpoints

GET /api/v2/admin/orders/{order_id}/buyer
PUT /api/v2/admin/orders/{order_id}/buyer

Orders buyer properties

Attribute	Description
shop_no	ショップ番号
member_id	会員ID
member_group_no	注文当時の注文者の会員ランク番号
name	注文者名
names_furigana	注文者名のふりがな
email	注文者のメールアドレス
phone	注文者の固定電話番号
cellphone	注文者の電話番号(携帯)
customer_notification	お客様へのお知らせ
updated_date	修正日
user_id	注文者を変更した人のID
user_name	注文者を変更した人の名前
company_name	商号
company_registration_no	事業者登録番号
buyer_zipcode	注文者の郵便番号
buyer_address1	注文者の基本住所(住所1)
buyer_address2	注文者の詳細住所(住所2)
order_id Order ID	注文番号

Retrieve customer details of an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}/buyer

GET

特定の注文の注文者情報を照会できます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

Request Copy

Response Copy

Update customer information of an order cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/buyer

PUT

特定の注文の注文者情報を修正できます。
注文者名、注文者の携帯電話などを修正できます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
name	注文者名
email Email	注文者のメールアドレス会員のメールアドレス
phone	注文者の固定電話番号
cellphone	注文者の電話番号(携帯)
customer_notification	お客様へのお知らせお客様へのお知らせ

Request Copy

Response Copy

Orders buyer history

Endpoints

GET /api/v2/admin/orders/{order_id}/buyer/history

Orders buyer history properties

Attribute	Description
shop_no Min : [1]	ショップ番号
name	注文者名
email Email	注文者のメールアドレス
phone	注文者の固定電話番号
cellphone	注文者の電話番号(携帯)
customer_notification	お客様へのお知らせ
updated_date	修正日
user_id	注文者を変更した人のID
user_name	注文者を変更した人の名前

Retrieve a list of customer history of an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}/buyer/history

GET

特定の注文の注文者修正履歴を照会できます。
注文者名、注文者のメール、携帯電話情報などを確認できます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

Request Copy

Response Copy

Orders cancellation

Endpoints

POST /api/v2/admin/orders/{order_id}/cancellation
PUT /api/v2/admin/orders/{order_id}/cancellation/{claim_code}

Orders cancellation properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
status	注文ステータス canceled：キャンセル完了 canceling：キャンセル処理中
claim_code	キャンセル番号
items	品目別注文コード
recover_inventory	在庫の回復 T : 復元する F : 復元しない
undone	取消しの有無 T：取り消す F：取り消さない
add_memo_too	運営者メモに追加する T：使用する F：使用しない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason	注文詳細に表示される取消しの理由

Create an order cancellation cafe24 youtube

POST /api/v2/admin/orders/{order_id}/cancellation

POST

配送前の特定の注文をキャンセルできます。
該当APIを使用してキャンセルする場合、払い戻し完了処理とともにPGキャンセルも同時に行うことができます。
一部キャンセルする場合、各払い戻し金額は自動的に計算され、払い戻し処理されます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
payment_gateway_cancel	決済代行会社の注文キャンセルを申込むかどうか注文を取り消すと同時にPGキャンセルも同時に処理できる。 PG取り消しが可能な決済手段(クレジットカード、リアルタイム口座振替)だけで使用可能だ。決済手段が複数の注文(カードなどで決済した注文を決済後に品目を追加した場合)の場合は、PG決済を取り消すことができず、管理者画面でキャンセルしなければならない。オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可 T : キャンセルする F : キャンセルしない DEFAULT F
status Required	注文ステータス canceled：キャンセル完了 canceling：キャンセル処理中
recover_inventory	在庫の回復 T : 復元する F : 復元しない DEFAULT F
recover_coupon	クーポン復元オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可 T : 復元する F : 復元しない DEFAULT F
recover_coupon_no	復元対象のクーポンID
add_memo_too	運営者メモに追加するオープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可 T：使用する F：使用しない DEFAULT F
reason Max Length : [2000]	キャンセル理由
claim_reason_type	キャンセル理由の区分オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
naverpay_cancel_reason_type	Naver Payで注文した件のキャンセル理由の区分ショッピングモール/オープンマーケット/カカオペイの注文をキャンセルする場合は使用不可 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 51 : 心変わり 52 : カラーまたはサイズ変更 53 : 誤注文 54 : サービス・商品への不満 55 : 配送遅延 56 : 在庫切れ 60 : 商品情報との不一致
kakaopay_cancel_reason_type	Kakaopayで注文した件のキャンセル理由の区分オープンマーケット/ネイバーペイ注文をキャンセルする場合は使用不可 K1：顧客の都合によるキャンセル K2：誤注文(オプション・商品の選択ミス) K3：配送遅延 K4：商品破損・商品不良 K5：配送ミス・配送漏れ K6：商品情報との不一致 K7：在庫切れによる配送不可
refund_method_code	返金方式 (オープンマーケット/ネイバーペイ/カカオペイの注文をキャンセルした場合、使用不可) T : 現金 F : クレジットカード M : ポイント G : 口座振込 C : キャリア決済 D : 預り金 V：コンビニ決済 J：提携商品券 K：提携ポイント I：その他
refund_bank_code	返金先の銀行コード払い戻し方式(refund_method)が現金(T)の場合必須 refund_bank_code 当該ショッピングモールがEC Korea ショッピングモールの場合、必須払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可
refund_bank_name Max Length : [250]	返金先の銀行名払い戻し方式(refund_method)が現金(T)の場合必須 ※ 当該ショッピングモールがEC Global ショッピングモールの場合、必須払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可
refund_bank_account_no	返金の口座番号払い戻し方式(refund_method)が現金(T)の場合必須オープンマーケット/ネイバーペイ/カカオペイ注文をキャンセルする場合は使用不可
refund_bank_account_holder Max Length : [15]	返金先の口座名義
items	品目別注文コード
order_item_code Required 品目別注文コード quantity Required 数量

Request Copy

Response Copy

Change cancellation details cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/cancellation/{claim_code}

PUT

注文のキャンセル受付を撤回できます。
キャンセルが受け付けられた注文の注文状態をキャンセル受付前の状態に修正することができます。
注文のキャンセル受付を撤回することでキャンセル受付を撤回し、在庫を復旧したり撤回理由を入力することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
claim_code Required	キャンセル番号
recover_inventory Required	在庫の回復 T : 復元する F : 復元しない
undone Required	取消しの有無 T : 철회함
add_memo_too Required	運営者メモに追加する T：使用する F：使用しない
undone_reason_type Required	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason Max Length : [2000]	取消しの理由
expose_order_detail Required	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason Max Length : [2000]	注文詳細に表示される取消しの理由

Request Copy

Response Copy

Orders exchange

Endpoints

POST /api/v2/admin/orders/{order_id}/exchange
PUT /api/v2/admin/orders/{order_id}/exchange/{claim_code}

Orders exchange properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
status	注文ステータス
claim_code	交換番号
items	品目別注文コード
exchanged_items	交換商品
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name Max Length : [30]	返品に使用する配送会社名
recover_inventory	在庫の回復 T : 復元する F : 復元しない
exchanged_after_collected	回収完了時の交換完了設定 T:使用する F:使用しない
request_pickup	回収申込の設定 T:使用する F:使用しない
pickup	回収地域の詳細
undone	取消しの有無 T：取り消す F：取り消さない
add_memo_too	運営者メモに追加する T：使用する F：使用しない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason	注文詳細に表示される取消しの理由
carrier_id	配送会社ID
return_invoice_success	返品用送り状の処理完了/失敗 T：成功 F：失敗 N：未集荷
return_invoice_fail_reason Max Length : [100]	返品用送り状の処理失敗の原因

Create an order exchange cafe24 youtube

POST /api/v2/admin/orders/{order_id}/exchange

POST

交換受付の処理します。
同一商品への交換有無と在庫の回復について入力することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
status Required	注文ステータス accepted：交換受付 exchanged：交換完了
recover_inventory	在庫の回復 T : 復元する F : 復元しない DEFAULT F
add_memo_too	運営者メモに追加する T：使用する F：使用しない DEFAULT F
items	品目別注文コード
order_item_code Required 品目別注文コード quantity Required 数量 exchange_variant_code (同一商品の別のオプションに交換する場合)交換商品の品目コード
same_product Required	同一商品への交換有無 T：同じ商品に交換 F：別の商品に交換

Request Copy

Response Copy

Update an order exchange cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/exchange/{claim_code}

PUT

交換を受け付けした注文の状態を修正することができます。
１件の注文に対しての交換受付の取り消し、在庫の復元、取り消し理由の入力などができます。
配送会社にすでに回収の要請が済んでいるが、回収が必要なくなった場合は、配送会社に直接連絡して回収の要請を取り消してください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
claim_code Required	交換番号
status	注文ステータス exchanged：交換完了
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name Max Length : [30]	返品に使用する配送会社名
recover_inventory	在庫の回復 T : 復元する F : 復元しない
exchanged_after_collected	回収完了時の交換完了設定 T:使用する F:使用しない
items	品目別注文コード
order_item_code 品目別注文コード
request_pickup	回収申込の設定 T:使用する F:使用しない
pickup	回収地域の詳細
name お名前 phone 電話番号 cellphone 電話番号(携帯) zipcode 郵便番号 address1 基本住所 address2 詳細住所
undone	取消しの有無 T : 철회함
add_memo_too	運営者メモに追加する T：使用する F：使用しない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason Max Length : [2000]	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason Max Length : [2000]	注文詳細に表示される取消しの理由
carrier_id	配送会社ID
return_invoice_success	返品用送り状の処理完了/失敗 T：成功 F：失敗 N：未集荷
return_invoice_fail_reason Max Length : [100]	返品用送り状の処理失敗の原因

Request Copy

Response Copy

Orders exchangerequests

Endpoints

PUT /api/v2/admin/orders/{order_id}/exchangerequests

Orders exchangerequests properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
undone	受付を拒否するかどうか
order_item_code	品目別注文コード
additional_payment_gateway_cancel	추가 PG 취소

Reject an exchange request cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/exchangerequests

PUT

交換申し込み注文の交換受付を拒否します。
注文番号、品目別注文コード、拒否の理由などを必須で入力します。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
order_item_code Required	品目別注文コード
undone Required	受付を拒否するかどうか T：受付を拒否する
reason_type	理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
reason Max Length : [2000]	理由
display_reject_reason	注文詳細の表示設定 T：表示する F：表示しない DEFAULT F
reject_reason Max Length : [2000]	拒否の理由顧客に露出される受付拒否事由

Request Copy

Response Copy

Orders items

Endpoints

GET /api/v2/admin/orders/{order_id}/items
POST /api/v2/admin/orders/{order_id}/items
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

Orders items properties

Attribute	Description
shop_no	ショップ番号
item_no	品目別注文ID
order_item_code	品目別注文コード
variant_code	品目コード
product_no	商品番号
product_code	商品コード
internal_product_name	商品名(管理用)
custom_product_code Max Length : [40]	独自商品コード
custom_variant_code	独自品目コード
eng_product_name	商品名(英語)
option_id	商品オプションID
option_value	オプション値
option_value_default	基本オプション値
additional_option_value	追加入力オプション値
additional_option_values	追加入力オプション一覧
product_name	商品名
product_name_default	基本商品名
product_price	商品販売価格
option_price	オプション追加価格
additional_discount_price	商品追加割引金額
coupon_discount_price	商品別のクーポンによる割引金額
app_item_discount_amount	アプリによる商品割引金額
payment_amount	決済金額(品目別)
quantity	数量
product_tax_type	商品の税金区分 A : 課税 B : 免税 C : 非課税
tax_rate	税率
supplier_product_name	供給会社の商品名
supplier_transaction_type	供給会社の取引タイプ D：直接登録型 P：手数料基準
supplier_id	供給会社のID
supplier_name	供給会社名
tracking_no	送り状番号
shipping_code	配送番号
claim_code	キャンセル/交換/返品番号
claim_reason_type	キャンセル/交換/返品の申込理由のタイプ購入者によるキャンセル申込み A：お客様都合 G：サービスへの不満 B：配送遅延 I：その他購入者による交換・返品申込み O：お客様都合 P：商品への不満 V：不良品 W：配送ミス販売者によるキャンセル・交換・返品申込み A：お客様都合 B：配送遅延 J：配送ミス C：配送不可地域 L：輸出/通関不可能 D：梱包不良 E：商品への不満 F：商品情報と異なる K：不良品 G：サービスへの不満 H：在庫切れ I：その他
claim_reason	キャンセル/交換/返品の理由
refund_bank_name	返金先の銀行名
refund_bank_account_no	返金の口座番号
refund_bank_account_holder	返金先の口座名義
post_express_flag	ゆうパック連動
order_status	注文ステータス
request_undone	取消ステータス Cancellation：キャンセル取消し Exchange：交換取消し Return：返品取消し
order_status_additional_info	注文ステータスの追加情報
claim_quantity	キャンセル/交換/返品の申込数量
status_code	現在の処理ステータスコード N1:正常 N2:交換商品 C1:入金前のキャンセル C2:配送前のキャンセル C3:返品 E1:交換
status_text	現在の処理ステータス
open_market_status	モール型ECサイト連動ステータス値
bundled_shipping_type	まとめて配送のタイプ N:単一注文の一般配送(Normal) C :複合注文のまとめて配送(Combination)
shipping_company_id	配送会社ID
shipping_company_name	配送会社名
shipping_company_code	配送会社コード
product_bundle	セット商品の有無 T:セット商品 F:セット商品ではない
product_bundle_no	セット商品番号
product_bundle_name	セット商品名
product_bundle_name_default	セット商品名(基本)
product_bundle_type	セット商品のタイプ C:一体型 S:分離型
was_product_bundle	セット品目別注文の分離設定 T:分離履歴ある
original_bundle_item_no	分離したセット商品の既存の品目別注文番号
naver_pay_order_id	Naver Pay商品別注文番号
naver_pay_claim_status	Naver Payクレームタイプ PAYMENT_WAITING:入金待ち PAYED:決済完了 DELIVERING:配送中 DELIVERED:配送完了 PURCHASE_DECIDED:購入確定 EXCHANGED:交換 CANCELED:キャンセル RETURNED:返品 CANCELED_BY_NOPAYMENT:未入金キャンセル NOT_YET:発注未確認 OK:発注確認 CANCEL:発注確認の解除 CANCEL_REQUEST:キャンセル申込み CANCELING:キャンセル処理中 CANCEL_DONE:キャンセル処理完了 CANCEL_REJECT:キャンセル取消し RETURN_REQUEST:返品申込み COLLECTING:回収処理中 COLLECT_DONE:回収完了 RETURN_DONE:返品完了 RETURN_REJECT:返品取消し EXCHANGE_REQUEST:交換申込み COLLECTING:回収処理中 COLLECT_DONE:回収完了 EXCHANGE_REDELIVERING:交換後に再配送中 EXCHANGE_DONE:交換完了 EXCHANGE_REJECT:交換拒否 PURCHASE_DECISION_HOLDBACK:購入確定保留 PURCHASE_DECISION_HOLDBACK_REDELIVERING:購入確定保留後に再配送中 PURCHASE_DECISION_REQUEST:購入確定要請 PURCHASE_DECISION_HOLDBACK_RELEASE:購入確定保留の解除 ADMIN_CANCELING:購入確定後キャンセル中 ADMIN_CANCEL_DONE:購入確定後キャンセル完了
individual_shipping_fee	個別送料
shipping_fee_type	送料タイプ T:無料 F:着払い D:等差(金額) M:条件(金額) I:固定 N:比例(数量) W:等差(重さ) C:等差(数量) X:基本配送
shipping_fee_type_text	送料タイプ
shipping_payment_option	前払い/着払いの区分 C：着払い P：前払い F：無料
payment_info_id	決済情報ID
original_item_no	既存の品目別注文ID
store_pickup	店舗受取の設定 T:店舗にて受取り F:店舗にて受取りではない
ordered_date	注文日
shipped_date	定期購入開始日
delivered_date	配送完了日
purchaseconfirmation_date	購入確定日
cancel_date	注文キャンセル日
return_confirmed_date	返品承認日時
return_request_date	返品申込日
return_collected_date	返品集荷日
cancel_request_date	キャンセル申込日
refund_date	返金完了日
exchange_request_date	交換申込日
exchange_date	交換完了日
product_material	商品素材
product_material_eng	英語商品素材
cloth_fabric	生地
product_weight	商品重量
volume_size	商品体積
volume_size_weight	商品の体積・重量
clearance_category	海外通関用商品区分
clearance_category_info	海外通関用商品情報
clearance_category_code	海外通関コード
hs_code	HSコード
one_plus_n_event	1+Nイベントの有無
origin_place	原産国情報
origin_place_no	原産国コード
made_in_code	国名(原産国)コード
origin_place_value	原産国のその他の情報
gift	ノベルティであるかどうか T：ノベルティ F：ノベルティではない
item_granting_gift	ノベルティ贈呈条件となる品目の一覧
subscription	定期購入の利用状況 T : 利用中 F : 非利用
product_bundle_list	セット商品一覧
market_cancel_request	ECサイトキャンセル申込み有無 T : キャンセル申込みしたECサイト注文 F : キャンセル申込みしていないECサイト注文
market_cancel_request_quantity	モール型ECサイトからのキャンセル申込数量
market_fail_reason	モール型ECサイトでの処理失敗の原因
market_fail_reason_guide	モール型ECサイトでの処理失敗の原因に対する説明
market_item_no	外部品目別番号
market_custom_variant_code	モール型ECサイト独自品目コード
option_type	オプション構成方式 T:組み合わせ型 E:連携型 F:独立型
options	オプション
market_discount_amount	商品別モール型ECサイト割引
labels	주문 라벨
order_status_before_cs	キャンセル/交換/返品(CS)処理前の注文ステータス
supply_price	商品仕入れ価格
multi_invoice	マルチ送り状
order_id	注文番号
claim_type	キャンセル/交換/返品のタイプ
claim_status	キャンセル/交換/返品の申込み状態

Retrieve a list of order items cafe24 youtube

GET /api/v2/admin/orders/{order_id}/items

GET

注文のすべての品注を照会できます。
品主コード、商品番号、独自品目コードなどを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

supplier_id

供給会社のID

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Create an order item cafe24 youtube

POST /api/v2/admin/orders/{order_id}/items

POST

特定の注文のセット品目を分割処理することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
was_product_bundle	セット品目別注文の分離設定 T：セット商品を分離する F：セット商品を分離しない DEFAULT F
original_bundle_item_no	分離したセット商品の既存の品目別注文番号
variant_code Required Type : [A-Z0-9] Length Min : [12]~Max : [12]	品目コード

Request Copy

Response Copy

Update an order item cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}

PUT

注文の品注 1 つに対する注文ステータスを修正できます。
品主をキャンセル/交換/返品に状態を変更し、理由を入力することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
order_item_code Required	品目別注文コード
claim_type	キャンセル/交換/返品のタイプ ※ 使用する場合、「claim_type」「claim_status」「claim_reason_type」は必須です。 C : キャンセル R : 返品
claim_status	キャンセル/交換/返品の申込み状態 ※ 使用する場合、「claim_type」「claim_status」「claim_reason_type」は必須です。 T : 申し込む F : 申し込まない
claim_reason_type	キャンセル/交換/返品の申込理由のタイプ ※ 使用する場合、「claim_type」「claim_status」「claim_reason_type」は必須です。 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
claim_reason	キャンセル/交換/返品の理由 ※ 使用する場合、「claim_type」「claim_status」「claim_reason_type」は必須です。
claim_quantity	キャンセル/交換/返品の申込数量 ※ 使用する場合、「claim_type」「claim_status」「claim_reason_type」は必須です。
multi_invoice	マルチ送り状 * Youtube shopping をご利用の場合は提供されません ※ マルチ請求書の変更時に、「claim_type」「claim_status」「claim_reason_type」、「claim_quantity」、「claim_quantity」は使用できません。 ※ メイン請求書の請求書番号と配送業者コードは、shipmentsでのみ修正が可能で、配送処理以降は修正のみ可能で、追加/削除はできません。 ※ マルチ請求書には連動配送業者を入力することはできません。 ※該当属性に対するアドミンUIは24年7月8日から確認可能です。
tracking_no 送り状番号 shipping_company_id 配送会社ID quantity 数量

Request Copy

Response Copy

Orders items labels

Endpoints

GET /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels
POST /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels
DELETE /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels/{name}

Orders items labels properties

Attribute	Description
shop_no	ショップ番号 DEFAULT 1
names	注文ラベル名
order_id	注文番号
order_item_code	品目別注文コード
name	注文ラベル名

Retrieve an order label cafe24

GET /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels

GET

特定の注文品目のラベルリストを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

order_item_code
Required

品目別注文コード

Request Copy

Response Copy

Create an order label cafe24

POST /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels

POST

特定の注文品目にラベルを登録することができます

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
order_item_code Required	品目別注文コード
names Required	注文ラベル名

Request Copy

Response Copy

Update an order label cafe24

PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels

PUT

特定の注文品目に登録されたラベルを編集することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
order_item_code Required	品目別注文コード
names Required	注文ラベル名

Request Copy

Response Copy

Delete an order label cafe24

DELETE /api/v2/admin/orders/{order_id}/items/{order_item_code}/labels/{name}

DELETE

特定の注文品目に登録されたラベルを削除することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
order_item_code Required	品目別注文コード
name Required	注文ラベル名

Request Copy

Response Copy

Orders items options

Endpoints

POST /api/v2/admin/orders/{order_id}/items/{order_item_code}/options
PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}/options

Orders items options properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
order_item_code	品目別注文コード
product_bundle	セット商品の有無
additional_options	追加入力オプション
bundle_additional_options	セット商品の追加入力オプション

Create order item options cafe24

POST /api/v2/admin/orders/{order_id}/items/{order_item_code}/options

POST

特定の注文品目に追加入力オプションを登録することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
order_item_code Required	品目別注文コード
product_bundle Required	セット商品の有無
additional_options	追加入力オプション
additional_option_name Required 追加入力オプション名 additional_option_value Required 追加入力オプション値
bundle_additional_options	セット商品の追加入力オプション
variant_code Required 品目コード additional_options Array additional_option_name 追加入力オプション名 Required additional_option_value 追加入力オプション値 Required

Request Copy

Response Copy

Edit order item options cafe24

PUT /api/v2/admin/orders/{order_id}/items/{order_item_code}/options

PUT

特定の注文品目に追加入力オプションを編集することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
order_item_code Required	品目別注文コード
additional_options	追加入力オプション
additional_option_name Required 追加入力オプション名 additional_option_value Required 追加入力オプション値

Request Copy

Response Copy

Orders memos

Endpoints

GET /api/v2/admin/orders/{order_id}/memos
POST /api/v2/admin/orders/{order_id}/memos
PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}
DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

Orders memos properties

Attribute	Description
shop_no	ショップ番号
memo_no	メモ番号
created_date	メモ登録日
author_id	作成者ID
ip	作成者IP
use_customer_inquiry	お問い合わせに対する回答の同時登録の使用状態 T:使用する F:使用しない
attach_type	登録基準 O：注文別 P：品目別
content	メモ内容
starred_memo	重要メモの有無 T:重要メモ F:一般メモ
fixed	上部に固定する機能の使用状態 T:使用する F:使用しない
product_list	商品リスト
topic_type	お問い合わせカテゴリ cs_01 : 配送に関するお問い合わせ cs_02 : 商品に関するお問い合わせ cs_03 : 決済に関するお問い合わせ cs_04 : 注文キャンセル cs_05 : 商品変更
status	お問い合わせ対応の結果 F：処理中 T：処理完了

Retrieve a list of order memos cafe24 youtube

GET /api/v2/admin/orders/{order_id}/memos

GET

特定の注文に対するメモをリストで照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

Request Copy

Response Copy

Create an order memo cafe24 youtube

POST /api/v2/admin/orders/{order_id}/memos

POST

特定の注文にメモを登録できます。
メモを登録しながら重要メモとして表示したり、注文書の上部に固定したりできます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
content Required Max Length : [1000]	メモ内容
use_customer_inquiry	お問い合わせに対する回答の同時登録の使用状態 T:使用する F:使用しない DEFAULT F
topic_type	お問い合わせカテゴリ cs_01 : 配送に関するお問い合わせ cs_02 : 商品に関するお問い合わせ cs_03 : 決済に関するお問い合わせ cs_04 : 注文キャンセル cs_05 : 商品変更
status	お問い合わせ対応の結果 F：処理中 T：処理完了
attach_type	登録基準 O：注文別 P：品目別 DEFAULT O
starred_memo	重要メモの有無 T:重要メモ F:一般メモ DEFAULT F
fixed	上部に固定する機能の使用状態 T:使用する F:使用しない DEFAULT F
product_list	商品リスト

Request Copy

Response Copy

Update an order memo cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/memos/{memo_no}

PUT

特定の注文に関するメモを修正できます。
メモ内容、相談分類、重要メモの有無、上段固定可否などを変更できます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
memo_no Required	メモ番号
content Max Length : [1000]	メモ内容
use_customer_inquiry	お問い合わせに対する回答の同時登録の使用状態 T:使用する F:使用しない DEFAULT F
topic_type	お問い合わせカテゴリ cs_01 : 配送に関するお問い合わせ cs_02 : 商品に関するお問い合わせ cs_03 : 決済に関するお問い合わせ cs_04 : 注文キャンセル cs_05 : 商品変更
status	お問い合わせ対応の結果 F：処理中 T：処理完了
attach_type	登録基準 O：注文別 P：品目別 DEFAULT O
starred_memo	重要メモの有無 T:重要メモ F:一般メモ DEFAULT F
fixed	上部に固定する機能の使用状態 T:使用する F:使用しない DEFAULT F
product_list	商品リスト

Request Copy

Response Copy

Delete an order memo cafe24 youtube

DELETE /api/v2/admin/orders/{order_id}/memos/{memo_no}

DELETE

特定の注文に関するメモを削除できます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

memo_no
Required

メモ番号

Request Copy

Response Copy

Orders payments

Endpoints

PUT /api/v2/admin/orders/{order_id}/payments

Orders payments properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
change_payment_amount	決済金額変更の有無 T:使用する F:使用しない
change_payment_method	決済方法変更の有無 T:使用する F:使用しない
payment_method	決済方法
payment_gateway_failure_message	決済代行会社の決済キャンセルエラーメッセージ
admin_additional_amount	運営者入力金額
commission	決済手数料
initial_estimated_payment_amount	初期決済予定金額
change_payment_amount_reason	決済金額変更の理由

Update an order payment status cafe24

PUT /api/v2/admin/orders/{order_id}/payments

PUT

特定の注文の決済ステータスを修正できます。
決済キャンセル状態に変更したい場合は、アプリを通じて登録されたPG社で決済をキャンセルした場合にのみ使用できます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
change_payment_amount Required	決済金額変更の有無入金前の状態でのみ決済金額変更可能ただし、CS注文状態またはCS処理履歴が存在する場合は、決済金額の変更はできません。 ※ 決済手段別入金前注文状態 - 振込:振込前 - ダイビキ:商品準備中~配送完了[ダイビキ入金前] T:使用する F:使用しない
change_payment_method Required	決済方法変更の有無 T:使用する F:使用しない
payment_method	決済方法 cash：銀行振込 daibiki：代金引換
billing_name Max Length : [40]	入金者名決済手段を振込に変更する場合("change_payment_method:"T"で"payment_method":"cash"の場合)使用可能
bank_account_id	振込銀行のID 決済手段を振込に変更する場合("change_payment_method:"T"で"payment_method":"cash"の場合)使用可能
admin_additional_amount Min : [0] Max : [10000000]	運営者入力金額決済金額を変更する場合("change_payment_amount":"T"の場合)使用可能
commission Min : [0] Max : [10000000]	決済手数料決済手段をダイビキに変更する場合("change_payment_amount:"T"で"payment_method":"daibiki"の場合)使用可能
change_payment_amount_reason Max Length : [255]	決済金額変更の理由決済金額を変更する場合("change_payment_amount":"T"の場合)使用可能

Request Copy

Response Copy

Orders paymenttimeline

Endpoints

GET /api/v2/admin/orders/{order_id}/paymenttimeline
GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

Orders paymenttimeline properties

Attribute	Description
shop_no	ショップ番号
payment_no	決済番号
payment_settle_type	決済タイプ O：最初決済 R：追加決済 P：返金
order_amount	注文金額
additional_payment_amount	併用決済金額
paid_amount	決済金額
payment_methods	決済方法
payment_datetime	決済日
created_datetime	入力日
claim_code	キャンセル・交換・返品番号
payment_method_detail	決済方法別の決済金額
order_amount_detail	注文金額の詳細

Retrieve payment history of an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}/paymenttimeline

GET

特定の注文の完全な支払いタイムラインを照会できます。
決済タイプ、注文金額、決済日などを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
start_date Date	検索開始日
end_date Date	検索終了日
date_type	検索日付のタイプ開始日と終了日を基準に期間検索時、date_type未入力時、created_datetimeを基準に検索進行 created_datetime：入力日 payment_datetime：決済日

Request Copy

Response Copy

Retrieve payment details of an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}/paymenttimeline/{payment_no}

GET

特定の注文の決済番号 1 件に対する決済タイムラインを照会することができます。
決済タイプ、注文金額、決済金額などを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id
Required

注文番号

payment_no
Required

Min : [1]

決済番号

Request Copy

Response Copy

Orders receivers

Endpoints

GET /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers
PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

Orders receivers properties

Attribute	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
name	受取人名
name_furigana	受取人名(フリガナ)
phone	電話番号
cellphone	受取人の電話番号(携帯)
virtual_phone_no	受取人の安心番号
zipcode	郵便番号
address1	基本住所
address2	詳細住所
address_state	都道府県
address_city	市区町村
address_street	道路名
address_full	アドレス
name_en	受取人名(ローマ字)
city_en	受取人の都市(ローマ字)
state_en	受取人の住所(ローマ字)
street_en	受取人の住所 (ローマ字)
country_code	国コード
country_name	国名
country_name_en	国名(ローマ字)
shipping_message	配送メッセージ
clearance_information_type	通関情報タイプ I：身分証明書(ID)番号 P：パスポート番号 C：個人通関固有符号
clearance_information	通関情報
wished_delivery_date	配送希望日
wished_delivery_time	配達希望時間
shipping_code	配送番号
change_default_shipping_address	基本お届け先の変更有無 T：変更する F：変更しない
use_fast_delivery_date	「配送希望日指定なし」設定を使用するかどうか T: 使用 F: 未使用
use_fast_delivery_time	「配送希望時間指定なし」設定を使用するかどうか T: 使用 F: 未使用

Retrieve a list of recipients of an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}/receivers

GET

特定の注文の受取人情報をリストで照会できます。
受取人名、携帯電話番号、住所などを照会することができます。
一部配送や分割配送などの場合、1つの注文で受取人は複数いる場合があります。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

shipping_code

配送番号

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Update order recipients cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/receivers

PUT

特定の注文の受取人情報を修正できます。
複数お届け先のご注文の場合は、受取人安心番号の修正はできません。
受取人名、受取人携帯電話などを修正することが。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
name Max Length : [20]	受取人名
phone Max Length : [20]	受取人の電話番号(固定) 韓国モールの場合、02-0000-0000形式で入力その他海外モールの場合は国番号-000-0000形式で入力
cellphone Max Length : [20]	受取人の電話番号(携帯) 韓国モールの場合は010-0000-0000形式で入力その他海外モールの場合は国番号-000-0000形式で入力
shipping_message	配送メッセージ
name_furigana	受取人名(フリガナ) * Youtube shopping をご利用の場合は提供されません海外モールのうち日本モールの場合のみ必須入力
zipcode Min Length : [2] Max Length : [14]	郵便番号
address1 Max Length : [255]	基本住所
address2 Max Length : [255]	詳細住所
address_state	都道府県海外モールの場合は必須入力
address_city	市区町村海外モールの場合は必須入力
name_en	受取人名(ローマ字)
city_en	受取人の都市(ローマ字)
state_en	受取人の住所(ローマ字)
street_en	受取人の住所 (ローマ字)
country_code	国コード海外モールの場合は必須入力韓国:KR / 中国:CN / 日本:JP / フィリピン:PH / 米国:US / 台湾:TW / ベトナム:VN
clearance_information_type	通関情報タイプ I：身分証明書(ID)番号 P：パスポート番号 C：個人通関固有符号
clearance_information	通関情報
shipping_code	配送番号
change_default_shipping_address	基本お届け先の変更有無 T：変更する F：変更しない DEFAULT F
virtual_phone_no	受取人の安心番号 * Youtube shopping をご利用の場合は提供されません複数お届け先の注文の場合、受取人安心番号の修正不可
wished_delivery_date Date	配送希望日 * Youtube shopping をご利用の場合は提供されません
use_fast_delivery_date	「配送希望日指定なし」設定を使用するかどうか * Youtube shopping をご利用の場合は提供されません「できるだけ早い配送時間設定可否」が「T」の場合はnullで応答する。 T: 使用 F: 未使用
wished_delivery_time	配達希望時間 * Youtube shopping をご利用の場合は提供されません希望配送開始時間(start_hour) 00~23まで入力可能希望配送終了時間(end_hour) 00~23まで入力可能
start_hour 配送希望時間の開始時間 end_hour 配送希望時間の終了時間
use_fast_delivery_time	「配送希望時間指定なし」設定を使用するかどうか「できるだけ早い配送日の設定可否」が「T」の場合はnullで回答する。 T: 使用 F: 未使用

Request Copy

Response Copy

Change shipping information cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/receivers/{shipping_code}

PUT

特定の注文の特定の配送番号に関する受取人情報を修正できます。
配送番号に関係なく受取人情報を修正するためにはUpdate orders receiversをご利用ください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号
shipping_code Required	配送番号
name Max Length : [20]	受取人名
phone Max Length : [20]	受取人の電話番号(固定)
cellphone Max Length : [20]	受取人の電話番号(携帯)
shipping_message	配送メッセージ
name_furigana	受取人名(フリガナ)
zipcode Min Length : [2] Max Length : [14]	郵便番号
address1 Max Length : [255]	基本住所
address2 Max Length : [255]	詳細住所
address_state	都道府県
address_city	市区町村
name_en	受取人名(ローマ字)
city_en	受取人の都市(ローマ字)
state_en	受取人の住所(ローマ字)
street_en	受取人の住所 (ローマ字)
country_code	国コード
clearance_information_type	通関情報タイプ I：身分証明書(ID)番号 P：パスポート番号 C：個人通関固有符号
clearance_information	通関情報
change_default_shipping_address	基本お届け先の変更有無 T：変更する F：変更しない DEFAULT F
virtual_phone_no	受取人の安心番号複数お届け先の注文の場合、受取人安心番号の修正不可
wished_delivery_date Date	配送希望日
use_fast_delivery_date	「配送希望日指定なし」設定を使用するかどうか「できるだけ早い配送時間設定可否」が「T」の場合はnullで応答する。 T: 使用 F: 未使用
wished_delivery_time	配達希望時間希望配送開始時間(start_hour) 00~23まで入力可能希望配送終了時間(end_hour) 00~23まで入力可能
start_hour 配送希望時間の開始時間 end_hour 配送希望時間の終了時間
use_fast_delivery_time	「配送希望時間指定なし」設定を使用するかどうか「できるだけ早い配送日の設定可否」が「T」の場合はnullで回答する。 T: 使用 F: 未使用
receiver_direct_input_check	주소 직접입력

Request Copy

Response Copy

Orders receivers history

Endpoints

GET /api/v2/admin/orders/{order_id}/receivers/history

Orders receivers history properties

Attribute	Description
shop_no Min : [1]	ショップ番号
name	受取人名
phone	電話番号
cellphone	受取人の電話番号(携帯)
zipcode	郵便番号
address1	基本住所
address2	詳細住所
address_state	都道府県
address_city	市区町村
address_street	道路名
address_full	アドレス
name_en	受取人名(ローマ字)
city_en	受取人の都市(ローマ字)
state_en	受取人の住所(ローマ字)
street_en	受取人の住所 (ローマ字)
country_code	国コード
country_name	国名
country_name_en	国名(ローマ字)
shipping_message	配送メッセージ
updated_date	修正日
user_id	注文者を変更した人のID
user_name	注文者を変更した人の名前
shipping_code	配送番号

Retrieve a list of recipient history of an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}/receivers/history

GET

注文受取人が変更された履歴とその内容を照会することができます。
受取人名、電話番号、住所などを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

Request Copy

Response Copy

Orders refunds

Endpoints

PUT /api/v2/admin/orders/{order_id}/refunds/{refund_code}

Orders refunds properties

Attribute	Description
shop_no	ショップ番号
refund_code	返金番号
status	返金ステータス
reason	処理事由

Update an order refund cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/refunds/{refund_code}

PUT

特定の注文の返金状態を修正することができます。
処理についてのコメントを入力することができ、返金の処理後にSMSやメールなどでも配信するように修正することもできます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
refund_code Required	返金番号
status Required	返金ステータス complete : 返金完了
reason Max Length : [2000]	処理事由
send_sms	返金処理後SMS送信の設定 T : 送信する F : 送信しない DEFAULT T
send_mail	返金処理後メール送信の設定 T : 送信する F : 送信しない DEFAULT T
payment_gateway_cancel	決済代行会社の注文キャンセルを申込むかどうか T : キャンセルする F : キャンセルしない DEFAULT F

Request Copy

Response Copy

Orders return

Endpoints

POST /api/v2/admin/orders/{order_id}/return
PUT /api/v2/admin/orders/{order_id}/return/{claim_code}

Orders return properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
status	注文ステータス accepted：返品受付 processing：返品処理中 returned：返品完了
claim_code	返品番号
items	品目別注文コード
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前
carrier_id	配送会社ID
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name Max Length : [30]	返品に使用する配送会社名
return_invoice_success	返品用送り状の処理完了/失敗 T：成功 F：失敗 N：未集荷
return_invoice_fail_reason Max Length : [100]	返品用送り状の処理失敗の原因
recover_inventory	在庫の回復 T : 復元する F : 復元しない
request_pickup	回収申込の設定 T:使用する F:使用しない
pickup	回収地域の詳細
undone	取消しの有無 T：取り消す F：取り消さない
add_memo_too	運営者メモに追加する T：使用する F：使用しない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason	注文詳細に表示される取消しの理由

Create an order return cafe24

POST /api/v2/admin/orders/{order_id}/return

POST

特定配送後、注文1つを返品処理できる機能です。
該当APIを使用して返品完了処理を行う場合、払い戻し完了処理とともにPGキャンセルも同時に行うことができます。(payment_gateway_cancel:"T"に要請時)
一部返品する場合、各払い戻し金額は自動計算され、払い戻し処理されます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
payment_gateway_cancel	決済代行会社の注文キャンセルを申込むかどうか注文を返品処理すると同時にPGキャンセルも同時に処理できる。 PG取り消しが可能な決済手段(クレジットカード、リアルタイム口座振替)だけで使用可能だ。決済手段が複数の注文(カードなどで決済した注文を決済後に品目を追加した場合)の場合は、PG決済を取り消すことができず、管理者画面でキャンセルしなければならない。オープンマーケット/ネイバーペイ注文をキャンセルする場合は使用不可 T : キャンセルする F : キャンセルしない DEFAULT F
status Required	注文ステータス accepted：返品受付 processing：返品処理中 returned：返品完了
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前 DEFAULT F
recover_inventory	在庫の回復 T : 復元する F : 復元しない DEFAULT F
recover_coupon	クーポン復元 * Youtube shopping をご利用の場合は提供されません T : 復元する F : 復元しない DEFAULT F
recover_coupon_no	復元対象のクーポンID * Youtube shopping をご利用の場合は提供されません
add_memo_too	運営者メモに追加する T：使用する F：使用しない DEFAULT F
reason Max Length : [2000]	返品理由
claim_reason_type	返品理由区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
naverpay_return_reason_type	LIBSPECDATAPAY.ORDER.RETURN * Youtube shopping をご利用の場合は提供されませんカカオペイ注文を返品する場合は使用不可 Cafe24管理画面(ベトナム, フィリピン, 日本) では使用できません。 51：心変わり 52：カラーまたはサイズ変更 53：誤注文 54：サービス・商品への不満 55：配送遅延 56：在庫切れ 57：配送漏れ 58：未配送 59：商品破損 60：商品情報との不一致 61：配送ミス 62：カラーなどのオプションが間違った商品が届く誤配送
refund_method_code	返金方式 T : 現金 F : クレジットカード M : ポイント G : 口座振込 C : キャリア決済 D : 預り金 V：コンビニ決済 J：提携商品券 K：提携ポイント I：その他
refund_bank_code	返金先の銀行コード払い戻し方式(refund_method)が現金(T)の場合必須 refund_bank_code ※ 当該ショッピングモールがEC Korea ショッピングモールの場合、必須
refund_bank_name Max Length : [250]	返金先の銀行名払い戻し方式(refund_method)が現金(T)の場合必須 ※ 当該ショッピングモールがEC Global ショッピングモールの場合、必須払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能
refund_bank_account_no	返金の口座番号払い戻し方式(refund_method)が現金(T)の場合必須
refund_bank_account_holder Max Length : [15]	返金先の口座名義
items	品目別注文コード
order_item_code Required 品目別注文コード quantity Required 数量
request_pickup	回収申込の設定 T:使用する F:使用しない
pickup	回収地域の詳細
name お名前 phone 電話番号 cellphone 電話番号(携帯) zipcode 郵便番号 address1 基本住所 address2 詳細住所
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name Max Length : [30]	返品に使用する配送会社名

Request Copy

Response Copy

Update an order return cafe24

PUT /api/v2/admin/orders/{order_id}/return/{claim_code}

PUT

注文の特定返品番号の返品受付状態を修正する機能です。
返品を受け付けした注文を修正することができます。
Update an orders return を利用して、返品受付の取り消しや、在庫の復元、取り消し理由の入力などができます。
配送会社にすでに回収の要請が済んでいるが、回収が必要なくなった場合は、配送会社に直接連絡して回収の要請を取り消してください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
claim_code Required	返品番号
status	注文ステータス processing：返品処理中 returned：返品完了
carrier_id	配送会社ID 配送業者が返送先番号をアップデートする際、carrier_id必須
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name Max Length : [30]	返品に使用する配送会社名
return_invoice_success	返品用送り状の処理完了/失敗 T：成功 F：失敗 N：未集荷
return_invoice_fail_reason Max Length : [100]	返品用送り状の処理失敗の原因
refund_method_code	返金方式 T : 現金 F : クレジットカード M : ポイント G : 口座振込 C : キャリア決済 D : 預り金 V：コンビニ決済 J：提携商品券 K：提携ポイント I：その他
refund_bank_account_holder Max Length : [15]	返金先の口座名義
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前
items	品目別注文コード
order_item_code 品目別注文コード
recover_coupon	クーポン復元 * Youtube shopping をご利用の場合は提供されません T : 復元する F : 復元しない
recover_coupon_no	復元対象のクーポンID * Youtube shopping をご利用の場合は提供されません
recover_inventory	在庫の回復 T : 復元する F : 復元しない
request_pickup	回収申込の設定返送先の保存時のデフォルト値は"回収申請箱(T)"。 T:使用する F:使用しない
pickup	回収地域の詳細
name お名前 phone 電話番号 cellphone 電話番号(携帯) zipcode 郵便番号 address1 基本住所 address2 詳細住所
undone	取消しの有無 T : 철회함
add_memo_too	運営者メモに追加する T：使用する F：使用しない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason Max Length : [2000]	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason Max Length : [2000]	注文詳細に表示される取消しの理由
refund_bank_code	返金先の銀行コード
refund_bank_name Max Length : [250]	返金先の銀行名
refund_bank_account_no	返金の口座番号

Request Copy

Response Copy

Orders shipments

Endpoints

GET /api/v2/admin/orders/{order_id}/shipments
POST /api/v2/admin/orders/{order_id}/shipments
PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}
DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

Orders shipments properties

Attribute	Description
shop_no	ショップ番号 DEFAULT 1
shipping_code	配送番号
order_id	注文番号
tracking_no	送り状番号
tracking_no_updated_date	送り状情報の入力日
shipping_company_code	配送会社コード
items	品目別注文一覧
status	注文ステータス standby : 配送待ち shipping : 配送中 shipped : 配送完了
order_item_code	品目別注文コード
carrier_id	配送会社ID
status_additional_info	注文ステータスの追加情報

Retrieve a list of shipping information of an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}/shipments

GET

注文に登録されている配送番号をリストで照会することができます。
配送番号、注文番号、送り状番号などを照会することができます。
部分配送で行った場合、注文1件につき配送番号は複数ある場合があります。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id
Required

Order ID

注文番号

Request Copy

Response Copy

Create an order shipping information cafe24 youtube

POST /api/v2/admin/orders/{order_id}/shipments

POST

注文に配送情報を登録して注文を出荷待ち状態にしたり、配送中処理をすることができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
tracking_no Required Max Length : [40]	送り状番号
shipping_company_code Required	配送会社コード shipping_company_code
order_item_code	品目別注文コード
status Required	注文ステータス standby : 配送待ち shipping : 配送中
shipping_code	配送番号
carrier_id	配送会社ID

Request Copy

Response Copy

Update an order shipping cafe24 youtube

PUT /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

PUT

注文の配送情報(配送ステータスなど)を変更することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
shipping_code Required	配送番号
status	注文ステータス statusを使用して配送状態を修正する場合、tracking_no、shipping_company_codeは使用不可 standby : 配送待ち shipping : 配送中 shipped : 配送完了
status_additional_info Max Length : [30]	注文ステータスの追加情報
tracking_no Max Length : [40]	送り状番号 tracking_noを使用する場合、shipping_company_codeを一緒に使用しなければならず、送り状番号を修正する場合はstatusは使用不可
shipping_company_code	配送会社コード shipping_company_code tracking_noを使用する場合、shipping_company_codeを一緒に使用しなければならず、送り状番号を修正する場合はstatusは使用不可

Request Copy

Response Copy

Delete an order shipping cafe24 youtube

DELETE /api/v2/admin/orders/{order_id}/shipments/{shipping_code}

DELETE

注文に登録されている配送番号を削除できます。
部分配送で行った場合、注文1件につき配送番号は複数ある場合があります。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id
Required

注文番号

shipping_code
Required

配送番号

Request Copy

Response Copy

Orders shippingfeecancellation

Endpoints

GET /api/v2/admin/orders/{order_id}/shippingfeecancellation
POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

Orders shippingfeecancellation properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
default_shipping_fee	基本送料
supplier_shipping_fee	供給会社送料
individual_shipping_fee	個別送料
international_shipping_fee	海外送料
international_shipping_insurance_fee	海外配送保険料
additional_shipping_fee	追加送料
additional_handling_fee	海外配送付加金額
regional_surcharge_amount	地域別送料
claim_code	キャンセル番号
claim_reason_type	区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
claim_reason	理由
refund_method	返金方式
shipping_discount_amount	送料割引のキャンセル金額
coupon_discount_amount	クーポン割引のキャンセル金額
refund_amount	返金額
point_used	使用済みポイントの返還額
credit_used	使用済み預り金の返還額
mixed_refund_amount	複合返金金額
mixed_refund_methods	複合返金方式
status	注文ステータス canceled：キャンセル完了 canceling：キャンセル処理中
include_tax	価格に税金が含まれているかどうか T：税込み F：税抜き
tax	税金情報

Retrieve shipping fee cancellation details of an order cafe24 youtube

GET /api/v2/admin/orders/{order_id}/shippingfeecancellation

GET

注文のキャンセル処理状況をリストで照会することができます。
基本送料、サプライヤーの送料、地域別送料などを照会できます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_id
Required

注文番号

Request Copy

Response Copy

Create an order shipping fee cancellation cafe24 youtube

POST /api/v2/admin/orders/{order_id}/shippingfeecancellation

POST

注文のキャンセル処理を要請することができます。
本APIはキャンセルを要請するものであり、キャンセルを処理するものではないことをご参考ください。
PGキャンセルまで自動的に行われるわけではなく、payment_gateway_cancelパラメータをTにして一緒に要請しないとPGも同時にキャンセル要請されません。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
reason Max Length : [2000]	キャンセル理由
claim_reason_type	キャンセル理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
recover_coupon	クーポン復元 * Youtube shopping をご利用の場合は提供されません T : 復元する F : 復元しない DEFAULT F
refund_method_code	返金方式 T : 現金 F : クレジットカード M : ポイント G : 口座振込 C : キャリア決済 D : 預り金 V：コンビニ決済 J：提携商品券 K：提携ポイント I：その他
refund_bank_code	返金先の銀行コード
refund_bank_name Max Length : [250]	返金先の銀行名
refund_bank_account_no	返金の口座番号
refund_bank_account_holder Max Length : [30]	返金先の口座名義
payment_gateway_cancel	決済代行会社の注文キャンセルを申込むかどうか T : キャンセルする F : キャンセルしない DEFAULT F

Request Copy

Response Copy

Orders shortagecancellation

Endpoints

POST /api/v2/admin/orders/{order_id}/shortagecancellation

Orders shortagecancellation properties

Attribute	Description
shop_no Min : [1]	ショップ番号
order_id	注文番号
status	注文ステータス canceled：キャンセル完了 canceling：キャンセル処理中
claim_code	キャンセル番号
items	品目別注文コード

Create an order cancellation on stock shortage cafe24

POST /api/v2/admin/orders/{order_id}/shortagecancellation

POST

特定の注文をキャンセル処理および返金まで処理できます。
在庫やクーポンを復元するかどうかも選択できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号
order_id Required	注文番号
payment_gateway_cancel	決済代行会社の注文キャンセルを申込むかどうか T : キャンセルする F : キャンセルしない DEFAULT F
keep_auto_calculation	LIBSPECDATAWHETHER.PRESERVE.FLAG LIBSPECDATAPRESERVED.REMOVED DEFAULT F
collect_gift	ノベルティを自動回収するかどうかの有無 T：使用する F：使用しない DEFAULT F
status Required	注文ステータス canceled：キャンセル完了 canceling：キャンセル処理中
recover_inventory	在庫の回復 T : 復元する F : 復元しない DEFAULT F
recover_coupon	クーポン復元 T : 復元する F : 復元しない DEFAULT F
recover_coupon_no	復元対象のクーポンID
add_memo_too	運営者メモに追加する T：使用する F：使用しない DEFAULT F
reason Max Length : [2000]	キャンセル理由
claim_reason_type	キャンセル理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
naverpay_cancel_reason_type	Naver Payで注文した件のキャンセル理由の区分 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 51 : 心変わり 52 : カラーまたはサイズ変更 53 : 誤注文 54 : サービス・商品への不満 55 : 配送遅延 56 : 在庫切れ 60 : 商品情報との不一致
kakaopay_cancel_reason_type	Kakaopayで注文した件のキャンセル理由の区分 K1：顧客の都合によるキャンセル K2：誤注文(オプション・商品の選択ミス) K3：配送遅延 K4：商品破損・商品不良 K5：配送ミス・配送漏れ K6：商品情報との不一致 K7：在庫切れによる配送不可
refund_method_code	返金方式 T : 現金 F : クレジットカード M : ポイント G : 口座振込 C : キャリア決済 D : 預り金 V：コンビニ決済 J：提携商品券 K：提携ポイント I：その他
refund_bank_code	返金先の銀行コード
refund_bank_name Max Length : [250]	返金先の銀行名
refund_bank_account_no	返金の口座番号
refund_bank_account_holder Max Length : [15]	返金先の口座名義
items	品目別注文コード
order_item_code Required 品目別注文コード quantity Required 数量

Request Copy

Response Copy

Orders benefits

注文特典(Orders benefits)は、特定の注文に適用された特典に関する機能です。

Endpoints

GET /api/v2/admin/orders/benefits

Orders benefits properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
order_item_code	品目別注文コード
benefit_no	特典番号
benefit_title	特典タイプ
benefit_name	特典名
benefit_code	特典コード
benefit_percent	特典割合
benefit_value	特典金額
benefit_app_key	アプリクライアントID

Retrieve a list of order benefits applied to an order cafe24 youtube

GET /api/v2/admin/orders/benefits

GET

特定の注文に適用された特典をリストで照会できます。
特典コード、特典比率、特典金額などを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号 ,(コンマ)で複数の件を検索することができる。
limit Min : [1]~Max : [500]	検索結果の最大件数 DEFAULT 10
offset Max : [8000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Orders calculation

注文の決済予定金額計算(Orderscalculation)は注文の配送国などをチェックして決済予定金額を計算する機能です。

Endpoints

POST /api/v2/admin/orders/calculation

Orders calculation properties

Attribute	Description
shop_no	ショップ番号
mobile	モバイル/PC
member_id	会員ID
shipping_type	配送タイプ A:国内 B:海外
payment_method	決済方法コード cash：銀行振込 card：クレジットカード icash：バーチャル口座 tcash：口座振込 cell：キャリア決済 deferpay：後払い point：ポイント
country_code	国コード
carrier_id	配送会社ID
zipcode	郵便番号
address_full	アドレス
address_state	都道府県
items	注文商品リスト
membership_discount_amount	会員ランク割引金額
shipping_fee_discount_amount	送料割引金額
product_discount_amount	商品別の割引金額
order_price_amount	商品購入金額
total_discount_amount	割引金額合計
shipping_fee	送料
total_amount_due	決済予定金額
shipping_fee_information	배송비 상세정보

Calculate total due cafe24

POST /api/v2/admin/orders/calculation

POST

注文の決済予定金額の計算処理ができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
mobile	モバイル/PC T:使用する F:使用しない DEFAULT F
member_id Max Length : [20]	会員ID
shipping_type	配送タイプ A:国内 B:海外 DEFAULT A
payment_method	決済方法コード cash：銀行振込 card：クレジットカード icash：バーチャル口座 tcash：口座振込 cell：キャリア決済 deferpay：後払い point：ポイント
country_code	国コード
carrier_id	配送会社ID
zipcode	郵便番号
address_full Max Length : [1000]	アドレス
address_state Max Length : [255]	都道府県
items	注文商品リスト
product_no Required 商品番号 variant_code Required 商品品目コード quantity Required 数量 product_price Required 商品販売価格 option_price オプション追加価格 product_bundle セット商品の有無 T:セット商品、F:セット商品ではない DEFAULT F product_bundle_no セット商品番号 prepaid_shipping_fee 送料前払いの設定 P:前払い、C:着払い DEFAULT P

Request Copy

Response Copy

Orders coupons

注文クーポン(Orders coupons)は注文に適用されたクーポンに関する機能です。
特定の注文に対して適用されたクーポンの情報を照会することができます。

Endpoints

GET /api/v2/admin/orders/coupons

Orders coupons properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
order_item_code	品目別注文コード
coupon_name	クーポン名
coupon_code	クーポンID
coupon_percent	クーポン割合
coupon_value	クーポン金額
coupon_value_final	最終クーポン金額

Retrieve a list of coupons applied to an order cafe24

GET /api/v2/admin/orders/coupons

GET

特定の注文に対して適用されたクーポンの情報をリストで照会することができます。
クーポン番号、クーポン比率、クーポン金額などを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号 ,(コンマ)で複数の件を検索することができる。
limit Min : [1]~Max : [500]	検索結果の最大件数 DEFAULT 10
offset Max : [8000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Orders inflowgroups

流入経路グループ(Inflowgroups)は、注文が流入した経路のグループを意味します。
流入経路グループは下位リソースで、注文(Orders)下位でのみ使用できます。
流入経路グループの照会、生成、修正、削除が可能です。

Endpoints

GET /api/v2/admin/orders/inflowgroups
POST /api/v2/admin/orders/inflowgroups
PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}
DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

Orders inflowgroups properties

Attribute	Description
inflow_group_id	流入経路グループID
inflow_group_name	流入経路グループ名

Retrieve a list of traffic source groups cafe24

GET /api/v2/admin/orders/inflowgroups

GET

流入経路グループのリストを照会することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

Request Copy

Response Copy

Create a traffic source group cafe24

POST /api/v2/admin/orders/inflowgroups

POST

流入経路グループを作成できます。
流入経路名と流入経路IDは必須値です。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
inflow_group_id Required Max Length : [40] Type : [a-zA-Z0-9]	流入経路グループID
inflow_group_name Required Max Length : [100]	流入経路グループ名

Request Copy

Response Copy

Update a traffic source group cafe24

PUT /api/v2/admin/orders/inflowgroups/{inflow_group_id}

PUT

流入経路グループを修正できます。
流入経路グループID、グループメンバー名などを必須入力します。
流入経路グループを登録すると、同じ流入経路についてグループ化して簡単に調べることができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
inflow_group_id Required Type : [a-zA-Z0-9] Max Length : [40]	流入経路グループID
inflow_group_name Required Max Length : [100]	流入経路グループ名

Request Copy

Response Copy

Delete a traffic source group cafe24

DELETE /api/v2/admin/orders/inflowgroups/{inflow_group_id}

DELETE

流入経路グループを削除できます。
削除する際には、流入経路グループのIDメンバーIDをすべて入力してください。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
inflow_group_id Required Max Length : [40] Type : [a-zA-Z0-9]	流入経路グループID

Request Copy

Response Copy

Orders inflowgroups inflows

Endpoints

GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows
POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows
PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}
DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

Orders inflowgroups inflows properties

Attribute	Description
inflow_id	流入経路グループのサービスID
inflow_name	流入経路グループのサービス名
inflow_icon	流入経路のアイコン
group_id	流入経路グループID

Retrieve a list of group traffic sources cafe24

GET /api/v2/admin/orders/inflowgroups/{group_id}/inflows

GET

特定の流入経路グループ内に属する流入経路のリストを照会することができます。
流入経路グループのメンバー名、流入経路アイコン、流入経路グループIDを確認できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
group_id Required Max Length : [40]	流入経路グループID

Request Copy

Response Copy

Create a group traffic source cafe24

POST /api/v2/admin/orders/inflowgroups/{group_id}/inflows

POST

特定の流入経路グループ内に属する流入経路を作成できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
group_id Required Max Length : [40]	流入経路グループID
inflow_id Required Max Length : [40]	流入経路グループのサービスID
inflow_name Required Max Length : [100]	流入経路グループのサービス名
inflow_icon Required URL Max Length : [500]	流入経路のアイコン

Request Copy

Response Copy

Update a group traffic source cafe24

PUT /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

PUT

特定の流入経路グループ内に属する流入経路を修正できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
group_id Required Max Length : [40]	流入経路グループID
inflow_id Required Max Length : [40]	流入経路グループのサービスID
inflow_name Required Max Length : [100]	流入経路グループのサービス名
inflow_icon Required URL Max Length : [500]	流入経路のアイコン

Request Copy

Response Copy

Delete a group traffic source cafe24

DELETE /api/v2/admin/orders/inflowgroups/{group_id}/inflows/{inflow_id}

DELETE

特定の流入経路グループ内に属する流入経路を削除できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
group_id Required Max Length : [40]	流入経路グループID
inflow_id Required Max Length : [40]	流入経路グループのサービスID

Request Copy

Response Copy

Orders memos

注文メモ(Orders memos)は、特定の注文のメモに対する注文のサブリソースです。
注文に対して管理者メモの照会、登録、修正、削除を行うことができます。

Endpoints

GET /api/v2/admin/orders/memos

Orders memos properties

Attribute	Description
shop_no	ショップ番号
memo_no	メモ番号
order_id	注文番号
created_date	メモ登録日
author_id	作成者ID
ip	作成者IP
use_customer_inquiry	お問い合わせに対する回答の同時登録の使用状態 T:使用する F:使用しない
attach_type	登録基準 O：注文別 P：品目別
content	メモ内容
starred_memo	重要メモの有無 T:重要メモ F:一般メモ
fixed	上部に固定する機能の使用状態 T:使用する F:使用しない
product_list	商品リスト

Retrieve a list of admin memos for an order cafe24 youtube

GET /api/v2/admin/orders/memos

GET

複数の注文に関するメモをリストで照会できます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required Order ID	注文番号 ,(コンマ)で複数の件を検索することができる。
limit Min : [1]~Max : [500]	検索結果の最大件数 DEFAULT 10
offset Max : [8000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Orders paymentamount

注文の実決済金額(Orders paymentamount)は、特定注文の実際の決済金額に対する機能です。
1つまたは複数の品主に対する実際の決済金額に関する情報を照会することができます。

Endpoints

GET /api/v2/admin/orders/paymentamount

Orders paymentamount properties

Attribute	Description
shop_no	ショップ番号
order_item_code	品目別注文コード
items	品目情報
order_price_amount	商品購入金額
order_discount_amount	注文割引金額
item_discount_amount	商品割引金額
additional_payment_amount	併用決済金額
payment_amount	決済金額(品目別)

Retrieve a payment amount cafe24 youtube

GET /api/v2/admin/orders/paymentamount

GET

特定の注文に含まれている1つまたは複数の品主に対する実際の決済金額に関する情報をリストで照会することができます。
商品購入金額、商品割引金額などの値を照会することができます。
**割引金額自動計算を使用しない品主は照会できません。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

order_item_code
Required

品目別注文コード

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Orders saleschannels

注文販売チャンネル(Orders saleschannels)は、注文の販売先の照会、登録、修正、削除を行うことができます。
注文販売チャネルはサブリソースで、注文（Orders）サブでのみ使用できます。

Endpoints

GET /api/v2/admin/orders/saleschannels
POST /api/v2/admin/orders/saleschannels
PUT /api/v2/admin/orders/saleschannels/{sales_channel_id}
DELETE /api/v2/admin/orders/saleschannels/{sales_channel_id}

Orders saleschannels properties

Attribute	Description
sales_channel_id	販売先ID
sales_channel_name	販売先名
sales_channel_icon	販売先のアイコン

Retrieve a list of sales channels cafe24

GET /api/v2/admin/orders/saleschannels

GET

ショッピングモールに登録されている販売チャンネルを一覧で照会することができます。
販売先のID、名前、アイコンなどを照会することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

limit

Min : [1]~Max : [500]

検索結果の最大件数

DEFAULT 10

offset

Max : [10000]

検索結果の開始位置

DEFAULT 0

Request Copy

Response Copy

Create a sales channel cafe24

POST /api/v2/admin/orders/saleschannels

POST

ショッピングモールに販売チャネルを登録できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
sales_channel_id Required Max Length : [40] Type : [a-zA-Z0-9]	販売先ID
sales_channel_name Required Max Length : [100]	販売先名
sales_channel_icon Required URL Max Length : [500]	販売先のアイコン

Request Copy

Response Copy

Update a sales channel cafe24

PUT /api/v2/admin/orders/saleschannels/{sales_channel_id}

PUT

ショッピングモールに登録されている販売チャネルを修正できます。
販売元の名前、アイコンなどを修正できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
sales_channel_id Required Max Length : [40] Type : [a-zA-Z0-9]	販売先ID
sales_channel_name Max Length : [100]	販売先名
sales_channel_icon URL Max Length : [500]	販売先のアイコン

Request Copy

Response Copy

Delete a sales channel cafe24

DELETE /api/v2/admin/orders/saleschannels/{sales_channel_id}

DELETE

ショッピングモールに販売チャネルを削除できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
sales_channel_id Required Max Length : [40] Type : [a-zA-Z0-9]	販売先ID

Request Copy

Response Copy

Payments

決済状態(Payments)は特定注文の決済状態に対する機能です。

Endpoints

PUT /api/v2/admin/payments

Payments properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
status	注文ステータス paid：入金確認 unpaid：入金前 canceled：決済キャンセル
auto_paid	自動入金であるかどうか T：自動入金 F：手動入金
cancel_request	決済キャンセル申込み情報

Update payment status for multiple orders cafe24

PUT /api/v2/admin/payments

PUT

特定の注文の決済ステータスを修正できます。
決済キャンセル状態に変更したい場合は、アプリを通じて登録されたPG社で決済をキャンセルした場合にのみ使用できます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
status Required	決済ステータス canceledの場合、アプリを通じて追加されたPG社で決済を取り消す場合のみ使用可能 paid：入金確認 unpaid：入金前 canceled：決済キャンセル
auto_paid	自動入金であるかどうか T：自動入金 F：手動入金
recover_inventory	在庫の回復 T : 復元する F : 復元しない
cancel_request	決済キャンセル申込み情報
refund_status 返金処理ステータス P：返金完了、F：返金失敗 DEFAULT F partial_cancel 一部キャンセルであるかどうか T：一部キャンセル、F：すべてキャンセル DEFAULT F payment_gateway_name 決済代行会社名 payment_method 決済方法コード card：クレジットカード、tcash：口座振込、icash：バーチャル口座、cell：キャリア決済、deferpay：後払い、cvs：コンビニ、easypay：簡単決済、fpayment：海外決済 response_code 決済代行会社のレスポンスコード response_message 決済代行会社のレスポンスメッセージ

Request Copy

Response Copy

Refunds

払い戻し(Refunds)は注文の状態が払い戻しと関連した状態に対して照会できる機能です。
払い戻し前、払い戻し保留、払い戻し完了段階ではない注文については照会できませんので、注文状態をよく確認してからご使用ください。

Endpoints

GET /api/v2/admin/refunds
GET /api/v2/admin/refunds/{refund_code}

Refunds properties

Attribute	Description
shop_no	ショップ番号
member_id	会員ID
member_email	会員メールアドレス
buyer_email	注文者のメールアドレス
order_date	注文日
accepted_refund_date	返金受付日
refund_date	返金完了日
order_id	注文番号
refund_code	返金番号
order_item_code	品目別注文コード一覧
quantity	数量
actual_refund_amount	実際の返金額
used_points	使用済みポイントの返還額
used_credits	使用済み預り金の返還額
currency	通貨単位
payment_methods	決済方法 cash：銀行振込 card：クレジットカード cell：キャリア決済 tcash：口座振込 icash：バーチャル口座 prepaid：前払い credit：預り金 point：ポイント pointfy：総合ポイント cvs：コンビニ cod：後払い coupon：クーポン market_discount：モール型ECサイト割引 giftcard：提携商品券 pointcard：提携ポイント etc：その他
refund_payment_methods	返金方法 cash：銀行振込 card：クレジットカード cell：キャリア決済 tcash：口座振込 prepaid：前払い credit：預り金 point：ポイント pointfy：総合ポイント cvs：コンビニ cod：後払い giftcard：提携商品券 pointcard：提携ポイント etc：その他
payment_gateway_cancel_statuses	決済代行会社でのキャンセル状態 F：キャンセル前 M：一部キャンセル完了 T：すべてキャンセル完了
payment_gateway_cancel_dates	決済代行会社でのキャンセル日付
status	返金ステータス T：返金完了 F：返金前
refund_methods	返金方法
refund_bank_name	返金先の銀行名
refund_bank_account_no	返金の口座番号
refund_bank_account_holder	返金先の口座名義
include_tax	価格に税金が含まれているかどうか T：税込み F：税抜き
tax	税金情報税管理者アプリを使用しない場合はnullで返却
refund_point	ポイント返還額
refund_credit	預り金の返還額
refund_naver_point	Naverポイント返還額
refund_naver_cash	Naverキャッシュ返還額
refund_amount	返金額
product_price	商品販売価格
shipping_fee	送料 DEFAULT 0.00
refund_shipping_fee	返金送料 DEFAULT 0.00
refund_regional_surcharge	地域別返金送料 DEFAULT 0.00
return_shipping_fee	返品送料 DEFAULT 0.00
return_regional_surcharge	地域別返品送料 DEFAULT 0.00
additional_shipping_fee	追加送料 DEFAULT 0.00
international_shipping_insurance	海外配送保険料 DEFAULT 0.00
international_shipping_additional_fee	海外配送付加金額 DEFAULT 0.00
shipping_fee_discount_amount	送料割引
cod_fees	後払い手数料
product_discount_amount	商品別の割引金額
member_group_discount_amount	会員ランク割引金額
app_item_discount_amount	アプリによる商品割引金額
app_discount_amount	アプリによる注文割引金額
coupon_discount_amount	クーポン割引金額
product_bundle_discount_amount	セット商品割引金額
points_spent_amount	ポイント使用金額
credits_spent_amount	預り金の使用金額
naver_point	Naverポイント
naver_cash	Naverキャッシュ
additional_product_amount	商品追加決済金額
manually_input_amount	運営者入力金額
changed_refund_amount	変更された返金額
refund_manager	返金担当者
refund_reason	返金理由
send_sms	返金処理後SMS送信の設定 T : 送信する F : 送信しない
send_mail	返金処理後メール送信の設定 T : 送信する F : 送信しない
items	品目別注文エンティティ

Retrieve a list of refunds cafe24 youtube

GET /api/v2/admin/refunds

GET

払い戻しに関する状態の注文をリストで照会することができます。
会員のEメール、注文日、払い戻し受付日などを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
start_date Required Date	検索開始日
end_date Required Date	検索終了日
date_type	検索日付のタイプ accepted_refund_date : 返金受付日 refund_date : 返金完了日 DEFAULT refund_date
member_email	会員メールアドレス
buyer_email	注文者のメールアドレス
order_id Order ID	注文番号 ,(コンマ)で複数の件を検索することができる。
member_id Max Length : [20]	会員ID
refund_status	CS(返品)ステータス ,(コンマ)で複数の件を検索することができる。 F：返金前 T：返金完了 M：返金保留
limit Min : [1]~Max : [500]	検索結果の最大件数 DEFAULT 10
offset Max : [15000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Retrieve a refund cafe24 youtube

GET /api/v2/admin/refunds/{refund_code}

GET

特定の払い戻し番号に関する情報を照会することができます。
払い戻しの理由、払い戻しの決済手当などを照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

refund_code
Required

返金番号

items
embed

品目別注文エンティティ

Request Copy

Response Copy

Reservations

Endpoints

GET /api/v2/admin/reservations

Reservations properties

Attribute	Description
shop_no	ショップ番号 DEFAULT 1
order_id	注文番号
order_item_code	品目別注文コード
order_date	注文日
payment_date	決済日
member_id	会員ID
order_status	注文ステータス
shipping_code	配送番号
payment_method	決済方法コード cash：銀行振込 card：クレジットカード cell：キャリア決済 tcash：口座振込 icash：バーチャル口座 prepaid：前払い credit：預り金 point：ポイント pointfy：総合ポイント cvs：コンビニ cod：後払い coupon：クーポン market_discount：モール型ECサイト割引 giftcard：提携商品券 pointcard：提携ポイント etc：その他
payment_method_name	決済方法名
product_no	商品番号
product_name	商品名
product_name_default	基本商品名
product_price	商品販売価格
option_price	オプション追加価格
quantity	数量
option_value	オプション値
option_value_default	基本オプション値
additional_option_values	追加入力オプション一覧
payment_amount	決済金額(品目別)
paid	決済の有無 T：決済 F：未決済 M：一部決済
service_use_date	サービス利用日
service_available_start_date	サービス利用可能期間の開始日
service_available_end_date	サービス利用可能期間の終了日
service_completion_date	サービス利用完了日

Retrieve pre-order item cafe24

GET /api/v2/admin/reservations

GET

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
date_type	検索日付のタイプ order_date：注文日 pay_date：決済日 service_use_date：サービス利用日 DEFAULT order_date
start_date Date	検索開始日
end_date Date	検索終了日
order_id Order ID	注文番号 ,(コンマ)で複数の件を検索することができる。
order_item_code	品目別注文コード ,(コンマ)で複数の件を検索することができる。
buyer_name	注文者名
member_id	会員ID
member_email	会員メールアドレス
buyer_email	注文者のメールアドレス
buyer_cellphone	注文者の電話番号(携帯)
product_no	商品番号 ,(コンマ)で複数の件を検索することができる。
order_status	注文ステータス ,(コンマ)で複数の件を検索することができる。 N00：未入金 N10：商品準備中 N20：発送準備中 N21：出荷待ち N22：配送保留 N30：配送中 N40：配送完了 N50 : 購入確定 C00：キャンセル申込み C10：キャンセル受付 - 運営者 C34：キャンセル処理中 - 返金前 C35：キャンセル処理中 - 返金完了 C36：キャンセル処理中 - 返金保留 C40：キャンセル完了 C41：キャンセル完了 - 返金前 C42：キャンセル完了 - 返金申込中 C43：キャンセル完了 - 返金保留 C47：入金前キャンセル - 購入者 C48：入金前キャンセル - 自動キャンセル C49：入金前キャンセル - 運営者 R00：返品申込み R10：返品受付 R11：返品受付拒否 R12：返品保留 R13：返品受付 - 回収完了(自動) R20：返品回収完了 R30：返品処理中 - 回収前 R31：返品処理中 - 回収完了 R34：返品処理中 - 返金前 R36：返品処理中 - 返金保留 R40：返品完了 - 返金完了 R41：返品完了 - 返金前 R42：返品完了 - 返金申込中 R43：返品完了 - 返金保留 E00：交換申込み E10：交換受付 N01：交換受付 - 交換商品 E11：交換受付拒否 E12：交換保留 E13：交換受付 - 回収完了(自動) E20：交換準備 E30：交換処理中 - 回収前 E31：交換処理中 - 回収完了 E32：交換処理中 - 入金前 E33：交換処理中 - 入金完了 E34：交換処理中 - 返金前 E35：交換処理中 - 返金完了 E36：交換処理中 - 返金保留 E40：交換完了 E41：交換完了 - 交換取消し E50：交換取消し - 販売者 E51：交換取消し - 購入者
payment_status	決済ステータス F：未入金 M：追加入金待ち P：決済完了
receiver_name	受取人名
receiver_cellphone	受取人の電話番号(携帯)
supplier_id	供給会社のID ,(コンマ)で複数の件を検索することができる。
supplier_name Max Length : [100]	供給会社名
sort	並べ替え順序の値 order_date：注文日 service_use_date：サービス利用日 DEFAULT order_date
order	並べ替え順序 asc:並べ替え(昇順) desc:並べ替え(降順) DEFAULT desc
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Return

「Return」は、配送後に顧客が注文をキャンセルことを意味します。返品リソースは返品情報を照会したり、または返品を処理できます。

返品リソースは返品の受付以降から完了までのステータスを照会できます。

Endpoints

GET /api/v2/admin/return/{claim_code}
POST /api/v2/admin/return
PUT /api/v2/admin/return

Return properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
claim_code	返品番号
claim_reason_type	区分販売者の返品受付理由の区分購入者の返品申込み理由は、[items(品目・注文) > claim_reason_type]で照会できます。 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
claim_reason	理由販売者の返品受付理由の詳細購入者の返品申込み理由の詳細は、[items(品目・注文) > claim_reason]で照会できます。
claim_due_date	返品処理予定日
return_address	返品先の住所
pickup	回収地域の詳細
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name Max Length : [30]	返品に使用する配送会社名
pickup_request_state	回収申込みのステータス E：回収申込み前 W：回収受付前 S：回収受付待ち(送り状発行前) F：回収受付失敗 T：回収受付完了(送り状発行完了) N：未集荷
refund_methods	返金方式
refund_reason	備考
order_price_amount	商品購入金額
refund_amounts	返金額
shipping_fee	送料 DEFAULT 0.00
refund_shipping_fee	返金送料 DEFAULT 0.00
refund_regional_surcharge	地域別返金送料 DEFAULT 0.00
return_ship_type	返品送料の適用区分
return_shipping_fee	返品送料 DEFAULT 0.00
return_shipping_fee_detail	返品送料詳細
return_regional_surcharge	地域別返品送料 DEFAULT 0.00
return_regional_surcharge_detail	地域別返品送料の詳細
additional_shipping_fee	追加送料 DEFAULT 0.00
international_shipping_insurance	海外配送保険料 DEFAULT 0.00
international_shipping_additional_fee	海外配送付加金額 DEFAULT 0.00
defer_commission	後払い手数料
partner_discount_amount	提携割引のキャンセル金額
add_discount_amount	商品別追加割引のキャンセル金額
member_grade_discount_amount	会員ランク割引のキャンセル金額
shipping_discount_amount	送料割引のキャンセル金額
coupon_discount_amount	クーポン割引のキャンセル金額
point_used	使用済みポイントの返還額
credit_used	使用済み預り金の返還額
undone	取消しの有無 T：取り消す F：取り消さない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason	注文詳細に表示される取消しの理由
items	品目別注文コード
include_tax	価格に税金が含まれているかどうか T：税込み F：税抜き
tax	税金情報税管理者アプリを使用しない場合はnullで返却
carrier_id	配送会社ID
return_invoice_success	返品用送り状の処理完了/失敗 T：成功 F：失敗 N：未集荷
return_invoice_fail_reason	返品用送り状の処理失敗の原因
status	注文ステータス accepted：返品受付 processing：返品処理中 returned：返品完了
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前
recover_inventory	在庫の回復 T : 復元する F : 復元しない
request_pickup	回収申込の設定 T:使用する F:使用しない
add_memo_too	運営者メモに追加する T：使用する F：使用しない

Retrieve a return cafe24 youtube

GET /api/v2/admin/return/{claim_code}

GET

注文の返品情報を照会することができます。
返品番号は必須入力値です。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

claim_code
Required

返品番号

Request Copy

Response Copy

Create multiple order returns cafe24 youtube

POST /api/v2/admin/return

POST

複数配送後に注文を返品処理できる機能です。
該当APIを使用して返品処理する場合、払い戻し完了まで処理されますが、PGキャンセルまでは進めませんので、ソリューションで別途PGキャンセル処理をしなければなりません。
一部返品する場合、各払い戻し金額は自動計算され、払い戻し処理されます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
status Required	注文ステータス accepted：返品受付 processing：返品処理中 returned：返品完了
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前 DEFAULT F
recover_inventory	在庫の回復 T : 復元する F : 復元しない DEFAULT F
recover_coupon	クーポン復元 * Youtube shopping をご利用の場合は提供されません T : 復元する F : 復元しない DEFAULT F
recover_coupon_no	復元対象のクーポンID * Youtube shopping をご利用の場合は提供されません
add_memo_too	運営者メモに追加する T：使用する F：使用しない DEFAULT F
reason Max Length : [2000]	返品理由
claim_reason_type	返品理由区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
naverpay_return_reason_type	LIBSPECDATAPAY.ORDER.RETURN * Youtube shopping をご利用の場合は提供されませんカカオペイ注文を返品する場合は使用不可 Cafe24管理画面(ベトナム, フィリピン, 日本) では使用できません。 51：心変わり 52：カラーまたはサイズ変更 53：誤注文 54：サービス・商品への不満 55：配送遅延 56：在庫切れ 57：配送漏れ 58：未配送 59：商品破損 60：商品情報との不一致 61：配送ミス 62：カラーなどのオプションが間違った商品が届く誤配送
refund_method_code	返金方式 T : 現金 F : クレジットカード M : ポイント G : 口座振込 C : キャリア決済 D : 預り金 V：コンビニ決済 J：提携商品券 K：提携ポイント I：その他
refund_bank_code	返金先の銀行コード払い戻し方式(refund_method)が現金(T)の場合必須 refund_bank_code ※ 当該ショッピングモールがEC Korea ショッピングモールの場合、必須
refund_bank_name Max Length : [250]	返金先の銀行名払い戻し方式(refund_method)が現金(T)の場合必須 ※ 当該ショッピングモールがEC Global ショッピングモールの場合、必須払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能
refund_bank_account_no	返金の口座番号払い戻し手段(refund_method)が"現金(T)"の場合のみ使用可能
refund_bank_account_holder Max Length : [15]	返金先の口座名義
items	品目別注文コード
order_item_code Required 品目別注文コード quantity Required 数量
request_pickup	回収申込の設定 T:使用する F:使用しない
pickup	回収地域の詳細
name お名前 phone 電話番号 cellphone 電話番号(携帯) zipcode 郵便番号 address1 基本住所 address2 詳細住所
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name Max Length : [30]	返品に使用する配送会社名

Request Copy

Response Copy

Update a return cafe24 youtube

PUT /api/v2/admin/return

PUT

注文の返品受付状態を修正する機能です。
返品を受け付けした注文を修正することができます。
Update return を利用して、返品受付の取り消しや、在庫の復元、取り消し理由の入力などができます。
配送会社にすでに回収の要請が済んでいるが、回収が必要なくなった場合は、配送会社に直接連絡して回収の要請を取り消してください。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
order_id Required	注文番号
claim_code Required	返品番号
status	注文ステータス processing：返品処理中 returned：返品完了
pickup_completed	回収が完了しているかどうか T：回収完了 F：回収前
carrier_id	配送会社ID 配送業者が返送先番号をアップデートする際、carrier_id必須
refund_method_code	返金方式 T : 現金 F : クレジットカード M : ポイント G : 口座振込 C : キャリア決済 D : 預り金 V：コンビニ決済 J：提携商品券 K：提携ポイント I：その他
refund_bank_account_holder Max Length : [15]	返金先の口座名義
return_invoice_no Max Length : [40]	返品用送り状の送り状番号
return_shipping_company_name Max Length : [30]	返品に使用する配送会社名
return_invoice_success	返品用送り状の処理完了/失敗 T：成功 F：失敗 N：未集荷
return_invoice_fail_reason Max Length : [100]	返品用送り状の処理失敗の原因
items	品目別注文コード
order_item_code 品目別注文コード
recover_coupon	クーポン復元 * Youtube shopping をご利用の場合は提供されません T : 復元する F : 復元しない
recover_coupon_no	復元対象のクーポンID * Youtube shopping をご利用の場合は提供されません
recover_inventory	在庫の回復 T : 復元する F : 復元しない
request_pickup	回収申込の設定返送先の保存時のデフォルト値は"回収申請箱(T)"。 T:使用する F:使用しない
pickup	回収地域の詳細
name お名前 phone 電話番号 cellphone 電話番号(携帯) zipcode 郵便番号 address1 基本住所 address2 詳細住所
undone	取消しの有無 T : 철회함
add_memo_too	運営者メモに追加する T：使用する F：使用しない
undone_reason_type	取消し理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
undone_reason Max Length : [2000]	取消しの理由
expose_order_detail	注文詳細の表示設定 T：表示する F：表示しない
exposed_undone_reason Max Length : [2000]	注文詳細に表示される取消しの理由
refund_bank_code	返金先の銀行コード
refund_bank_name Max Length : [250]	返金先の銀行名
refund_bank_account_no	返金の口座番号

Request Copy

Response Copy

Returnrequests

返品要請(Returnrequests)を通じて特定注文の返品に対する要請を受付または拒否することができます。

Endpoints

POST /api/v2/admin/returnrequests
PUT /api/v2/admin/returnrequests

Returnrequests properties

Attribute	Description
shop_no	ショップ番号
order_id	注文番号
items	品目別注文一覧
undone	受付を拒否するかどうか
order_item_code	品目別注文コード
additional_payment_gateway_cancel	추가 PG 취소

Create a return request for multiple items cafe24 youtube

POST /api/v2/admin/returnrequests

POST

返品を要請することができます。
返品事由と口座払い戻しの場合、払い戻しする口座番号を入力することができます。
，(コンマ)で複数件同時に返品要請することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
reason_type Required	理由の区分 A：お客様都合 E：商品への不満 K：不良品 J：配送ミス I：その他
reason Required Max Length : [2000]	理由
request_pickup Required	回収申込の設定 T：回収申込み F：直接発送
pickup	回収地域の詳細
name Required お名前 phone 電話番号 cellphone Required 電話番号(携帯) zipcode Required 郵便番号 address1 Required 基本住所 address2 Required 詳細住所
tracking_no Max Length : [40]	返品用送り状の送り状番号
shipping_company_name Max Length : [30]	返品に使用する配送会社名
refund_bank_code	返金先の銀行コード
refund_bank_name Max Length : [250]	返金先の銀行名
refund_bank_account_no	返金の口座番号
refund_bank_account_holder Max Length : [15]	返金先の口座名義
items	品目別注文一覧
order_item_code Required 品目別注文コード quantity Required 数量

Request Copy

Response Copy

Reject a return request for multiple items cafe24 youtube

PUT /api/v2/admin/returnrequests

PUT

返品要請された注文の特定品主に対して返品要請中の状態を変更することができます。
受付拒否ができ、理由を入力できます。
，(コンマ)で複数件の返品要請を同時に受付拒否することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
order_id Required	注文番号
order_item_code Required	品目別注文コード
undone Required	受付を拒否するかどうか T：受付を拒否する
reason_type	理由の区分 A : お客様都合 B : 配送遅延 J : 配送ミス C : 配送不可地域 L : 輸出/通関不可能 D : 梱包不良 E : 商品への不満 F : 商品情報と異なる K : 不良品 G : サービスへの不満 H : 在庫切れ I : その他
reason Max Length : [2000]	理由
display_reject_reason	注文詳細の表示設定 T：表示する F：表示しない DEFAULT F
reject_reason Max Length : [2000]	拒否の理由

Request Copy

Response Copy

Shipments

配送(Shipments)は注文の下位リソースである注文の配送(Orders shipments)とは異なり、複数の注文の配送情報を一度に登録または修正することができます。
配送情報には送り状番号や配送業者情報、配送状態などがあります。

Endpoints

POST /api/v2/admin/shipments
PUT /api/v2/admin/shipments

Shipments properties

Attribute	Description
shop_no	ショップ番号
tracking_no	送り状番号
shipping_company_code	配送会社コード shipping_company_code
status	注文ステータス standby : 配送待ち shipping : 配送中 shipped : 配送完了
order_id	注文番号
shipping_code	配送番号
order_item_code	品目別注文コード
carrier_id	配送会社ID
status_additional_info	注文ステータスの追加情報

Create shipping information for multiple orders cafe24 youtube

POST /api/v2/admin/shipments

POST

複数の注文に対して送り状番号を登録し、配送待ちや配送中の状態に変更することができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
tracking_no Required Max Length : [40]	送り状番号
shipping_company_code Required	配送会社コード shipping_company_code
status Required	注文ステータス standby : 配送待ち shipping : 配送中
order_id	注文番号
shipping_code	配送番号
order_item_code	品目別注文コード
carrier_id	配送会社ID

Request Copy

Response Copy

Update multiple order shippings cafe24 youtube

PUT /api/v2/admin/shipments

PUT

複数の配送番号について注文状態を変更したり、送り状番号などを修正することができます。
配送番号はCreate shipmentsを通じて送り状番号を登録しなければ発行できません。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
shipping_code Required	配送番号
order_id	注文番号
status	注文ステータス statusを使用して配送状態を修正する場合、tracking_no、shipping_company_codeは使用不可 standby : 配送待ち shipping : 配送中 shipped : 配送完了
status_additional_info Max Length : [30]	注文ステータスの追加情報
tracking_no Max Length : [40]	送り状番号 tracking_noを使用する場合、shipping_company_codeを一緒に使用しなければならず、送り状番号を修正する場合はstatusは使用不可
shipping_company_code	配送会社コード該当注文の送り状番号とともに配送会社を変更することができる。 shipping_company_code tracking_noを使用する場合、shipping_company_codeを一緒に使用しなければならず、送り状番号を修正する場合はstatusは使用不可

Request Copy

Response Copy

Subscription shipments

定期配送(Subscriptionshipments)は、定期配送に関する照会、登録、修正、削除ができる機能です。

Endpoints

GET /api/v2/admin/subscription/shipments
POST /api/v2/admin/subscription/shipments
PUT /api/v2/admin/subscription/shipments/{subscription_id}

Subscription shipments properties

Attribute	Description
subscription_id	定期購入の申込番号
member_id	会員ID
buyer_name	注文者名
buyer_zipcode	注文者の郵便番号
buyer_address1	注文者の住所(基本)
buyer_address2	注文者の住所(詳細)
buyer_phone	注文者の固定電話番号
buyer_cellphone	注文者の電話番号(携帯)
buyer_email	注文者のメールアドレス
receiver_name Max Length : [100]	受取人名
receiver_zipcode	受取人の郵便番号
receiver_address1	受取人の住所(基本)
receiver_address2	受取人の住所(詳細)
receiver_phone	受取人の電話番号(固定)
receiver_cellphone	受取人の電話番号(携帯)
shipping_message	配送メッセージ
delivery_type	配送タイプ A:国内 B:海外
wished_delivery	配送希望日使用の設定 T:使用する F:使用しない
wished_delivery_start_hour	配達希望開始時間
wished_delivery_end_hour	配達希望終了時間
wished_delivery_hour_asap	可能な限り早い時間 T:使用する F:使用しない
store_pickup	店舗受取 T:使用する F:使用しない
use_virtual_phone_no	あんしんナンバー T:使用する F:使用しない
created_date	申込日
subscription_state	定期購入のステータス U：利用中 P: 一時停止 C：解除済み
items	注文商品リスト

Retrieve a subscription cafe24

GET /api/v2/admin/subscription/shipments

GET

定期配送を照会することができます。

基本スペック

Property	Description
SCOPE	注文の閲覧権限 (mall.read_order)
呼び出し件数制限	40

要求スペック

Parameter	Description
date_type	検索日付のタイプ created_date：申込日 expected_pay_date：決済予定日 terminated_date：解除日 DEFAULT created_date
start_date Required Date	検索開始日
end_date Required Date	検索終了日
subscription_id	定期購入の申込番号
member_id Max Length : [20]	会員ID
buyer_name Max Length : [100]	注文者名
buyer_phone	注文者の固定電話番号
buyer_cellphone	注文者の電話番号(携帯)
product_no	商品番号 ,(コンマ)で複数の件を検索することができる。
product_name Max Length : [250]	商品名
product_code	商品コード
variant_code	品目コード
subscription_shipments_cycle	定期購入周期 ,(コンマ)で複数の件を検索することができる。 1W : 1週 2W : 2週 3W : 3週 4W : 4週 1M : 1ヶ月 2M : 2ヶ月 3M : 3ヶ月 4M : 4ヶ月 5M : 5ヶ月 6M : 6ヶ月 1Y : 1年
subscription_state	定期購入のステータス U：利用中 P: 一時停止 C：解除済み
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 20
offset Max : [5000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Create a subscription cafe24

POST /api/v2/admin/subscription/shipments

POST

定期配送を登録できます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter	Description
member_id Required Max Length : [20]	会員ID
buyer_name Required Max Length : [100]	注文者名
buyer_zipcode Required Length Min : [2]~Max : [14]	注文者の郵便番号
buyer_address1 Required Max Length : [250]	注文者の住所(基本)
buyer_address2 Required	注文者の住所(詳細)
buyer_phone Max Length : [20]	注文者の固定電話番号
buyer_cellphone Required Max Length : [20]	注文者の電話番号(携帯)
buyer_email Required Email	注文者のメールアドレス
receiver_name Required Max Length : [100]	受取人名
receiver_zipcode Required Length Min : [2]~Max : [13]	受取人の郵便番号
receiver_address1 Required	受取人の住所(基本)
receiver_address2 Required	受取人の住所(詳細)
receiver_phone Required Max Length : [20]	受取人の電話番号(固定)
receiver_cellphone Required Max Length : [20]	受取人の電話番号(携帯)
shipping_message	配送メッセージ
delivery_type	配送タイプ A:国内 B:海外 DEFAULT A
expected_delivery_date Required Date	定期購入開始日
subscription_shipments_cycle Required	定期購入周期 1W : 1週 2W : 2週 3W : 3週 4W : 4週 1M : 1ヶ月 2M : 2ヶ月 3M : 3ヶ月 4M : 4ヶ月 5M : 5ヶ月 6M : 6ヶ月 1Y : 1年
wished_delivery	配送希望日使用の設定 T:使用する F:使用しない DEFAULT F
wished_delivery_start_hour Min : [0]~Max : [23]	配達希望開始時間
wished_delivery_end_hour Min : [0]~Max : [23]	配達希望終了時間
wished_delivery_hour_asap	可能な限り早い時間 T:使用する F:使用しない
store_pickup	店舗受取 T:使用する F:使用しない DEFAULT F
use_virtual_phone_no	あんしんナンバー T:使用する F:使用しない DEFAULT F
max_delivery_limit Min : [0] Max : [12]	定期購入(配送)の実施希望回数 0：制限なし 2：2回 3：3回 4：4回 6：6回 10：10回 12：12回 DEFAULT 0
items	注文商品リスト
product_code Required 商品コード product_no Required 商品番号 product_name Required 商品名 options Array name オプション名 value オプション値 option_code 商品連携型オプションのオプションコード value_no 商品連携型オプションのオプション値 option_id Required 商品オプションID DEFAULT 000A quantity Required 注文数量 product_price Required 商品販売価格 option_price オプション追加価格 shipping_payment_option 前払い/着払いの区分 C：着払い、P：前払い、F：無料 category_no カテゴリ番号 product_bundle セット商品の有無 T:セット商品、F:セット商品ではない DEFAULT F bundle_product_components Array product_code 商品コード product_no 商品番号 option_id 商品オプションID quantity 注文数量

Request Copy

Response Copy

Update a subscription cafe24

PUT /api/v2/admin/subscription/shipments/{subscription_id}

PUT

定期配送情報を修正できます。
定期配送申込番号は必須入力値です。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
subscription_id Required	定期購入の申込番号
receiver_name Max Length : [100]	受取人名
receiver_zipcode Length Min : [2]~Max : [14]	受取人の郵便番号
receiver_address1	受取人の住所(基本)
receiver_address2	受取人の住所(詳細)
receiver_phone Max Length : [20]	受取人の電話番号(固定)
receiver_cellphone Max Length : [20]	受取人の電話番号(携帯)
shipping_message	配送メッセージ
subscription_state	定期購入のステータス U：使用 P: 一時停止 C：解除済み

Request Copy

Response Copy

Subscription shipments items

Endpoints

PUT /api/v2/admin/subscription/shipments/{subscription_id}/items

Subscription shipments items properties

Attribute	Description
subscription_item_id	定期購入アイテム番号
subscription_state	定期購入のステータス U：利用中 B：顧客による一時停止 Q：運営者による一時停止 M：顧客による解除 A：自動解除 O：運営者による解除
quantity	注文数量
expected_delivery_date	配送予定日
subscription_shipments_cycle	定期購入周期 1W : 1週 2W : 2週 3W : 3週 4W : 4週 1M : 1ヶ月 2M : 2ヶ月 3M : 3ヶ月 4M : 4ヶ月 5M : 5ヶ月 6M : 6ヶ月 1Y : 1年
changed_variant_code Type : [A-Z0-9] Length Min : [12]~Max : [12]	変更されたオプション品目コード
max_delivery_limit Min : [0] Max : [12]	定期購入(配送)の実施希望回数 0：制限なし 2：2回 3：3回 4：4回 6：6回 10：10回 12：12回

Update product variants in subscription cafe24

PUT /api/v2/admin/subscription/shipments/{subscription_id}/items

PUT

定期配送品目別の修正ができます。

基本スペック

Property	Description
SCOPE	注文の投稿権限 (mall.write_order)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter	Description
subscription_id Required	定期購入の申込番号
subscription_item_id Required Min : [1]	定期購入アイテム番号
subscription_state	定期購入のステータス U：利用中 Q：運営者による一時停止 O：運営者による解除
quantity Min : [1]	注文数量
expected_delivery_date Date	配送予定日
subscription_shipments_cycle	定期購入周期 1W : 1週 2W : 2週 3W : 3週 4W : 4週 1M : 1ヶ月 2M : 2ヶ月 3M : 3ヶ月 4M : 4ヶ月 5M : 5ヶ月 6M : 6ヶ月 1Y : 1年
changed_variant_code Type : [A-Z0-9] Length Min : [12]~Max : [12]	変更されたオプション品目コード
max_delivery_limit Min : [0] Max : [12]	定期購入(配送)の実施希望回数 0：制限なし 2：2回 3：3回 4：4回 6：6回 10：10回 12：12回

Request Copy

Response Copy

Customergroups

会員等級(Customer Groups)はショッピングモール会員を等級別に検索して管理することができます。
各会員レベル全体にメール、積立金の支給、選択した会員の等級解除及び変更を行うことができます。

Endpoints

GET /api/v2/admin/customergroups
GET /api/v2/admin/customergroups/count
GET /api/v2/admin/customergroups/{group_no}

Customergroups properties

Attribute	Description
shop_no	ショップ番号
group_no	会員ランク番号
group_name	会員ランク名
group_description	会員ランクに関する説明
group_icon	会員ランクのアイコン
benefits_paymethod	特典付与のための決済条件 A：すべての決済 B：現金決済(銀行振込) C：現金決済以外すべての決済
buy_benefits	特典設定 F:特典なし D:購入金額割引 M:ポイント付与 P:割引適用/ポイント付与
ship_benefits	送料特典 T:送料無料設定 F:送料無料設定しない
product_availability	商品別割引の重複設定 P:商品別価格割引のみ適用 M:会員ランク別価格割引のみ適用 A:両方適用
discount_information	購入金額の割引設定
points_information	ポイント付与設定
mobile_discount_information	モバイル購入の追加割引設定
mobile_points_information	モバイル購入の追加ポイント設定
discount_limit_information	割引制限設定マルチショッピングモールで、グレードごとの割引特典制限を使用する場合、グレードごとに適用される割引特典制限設定および最大割引上限情報が設定されます。割引特典制限を使用しない場合、またはbuy_benefits（購入時の割引/ポイント還元特典）がF（特典なし）またはM（ポイント還元）の場合、nullが返されます。 discount_limit_type（割引特典制限設定） - A（制限なし） - B（割引金額制限） - C（割引回数制限） discount_amount_limit（最大割引額の制限） : discount_limit_typeがBでない場合、nullになります。 number_of_discount_limit（最大割引回数の制限） : discount_limit_typeがCでない場合、nullになります。

Retrieve a list of customer tiers cafe24

GET /api/v2/admin/customergroups

GET

ショッピングモールに追加した会員レベルのプロパティをリストで照会します。
会員等級番号、会員等級名、主売時の割引/積立特典などをご確認いただけます。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

group_no

会員ランク番号

,(コンマ)で複数の件を検索することができる。

group_name

Max Length : [20]

会員ランク名

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Retrieve a count of customer tiers cafe24

GET /api/v2/admin/customergroups/count

GET

ショッピングモールに追加した会員レベルの数を照会します。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

group_no

会員ランク番号

システムにより会員ランクに付与された番号

,(コンマ)で複数の件を検索することができる。

group_name

Max Length : [20]

会員ランク名

会員ランクの作成時に指定した会員ランクの名前

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Retrieve a customer tier cafe24

GET /api/v2/admin/customergroups/{group_no}

GET

会員レベル番号を使用して、当該会員レベルのプロパティを照会します。
会員等級名、等級説明、特典などを照会することができます。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

group_no
Required

会員ランク番号

システムにより会員ランクに付与された番号

Request Copy

Response Copy

Customergroups customers

Endpoints

POST /api/v2/admin/customergroups/{group_no}/customers

Customergroups customers properties

Attribute	Description
shop_no	ショップ番号
group_no	会員ランク番号
member_id	会員ID
fixed_group	会員ランクの固定設定 T：固定する F：固定しない

Update a customer's customer tier cafe24

POST /api/v2/admin/customergroups/{group_no}/customers

POST

特定のクラスに会員を追加できます。
会員等級を固定するかどうかは、会員自動等級変更機能を使用するモールでのみ使用できます。

基本スペック

Property	Description
SCOPE	会員の投稿権限 (mall.write_customer)
呼び出し件数制限	40
1回当たり申込件数の制限	200

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
group_no Required	会員ランク番号
member_id Required Max Length : [20]	会員ID
fixed_group	会員ランクの固定設定特定会員が会員自動等級変更に適用されないための等級固定可否会員自動等級変更機能を使用するモールでのみ使用できる。 T：固定する F：固定しない DEFAULT F

Request Copy

Response Copy

Customergroups setting

Endpoints

GET /api/v2/admin/customergroups/setting

Customergroups setting properties

Attribute	Description
shop_no	ショップ番号
auto_update	会員ランク自動変更の使用設定 T：使用する F：使用しない
use_auto_update	会員ランク自動変更の適用設定 T：適用する(適用済み) F：適用しない(適用待ち)
customer_tier_criteria	会員ランクの設定基準 purchase_amount：購入金額 purchase_count：購入件数 purchase_amount_and_count：購入金額および購入件数 purchase_amount_or_count：購入金額または購入件数 shopping_index：ショッピングスコア
standard_purchase_amount	購入金額の条件 total_order_amount：注文金額合計 total_paid_amount：決済金額合計 credit_price：実際の総決済金額 + 預り金
offline_purchase_amount	オフライン購入金額を含むかどうか T：含む F：含まない
standard_purchase_count	購入件数の条件 order_count：注文回数 product_count：商品(品目)数
offline_purchase_count	オフライン購入件数を含むかどうか T：含む F：含まない
auto_update_criteria	自動変更を適用する際における注文の集計基準 delivery_complete：配送完了 payment_complete：決済完了
deduct_cancellation_refund	キャンセル/返金額(件)を差し引くかどうか T：キャンセル/返金額(件)を除く(差し引く) F：キャンセル/返金額(件)を含む(差し引かない)
interval_auto_update	自動変更の周期 1d：1日 3d：3日 1w：1週間 1m：1ヶ月 3m：3ヶ月 6m：6ヶ月 12m：12ヶ月
total_period	算定データの集計期間 now：現在(変更日直前)まで 1m：過去1ヶ月 3m：過去3ヶ月 6m：過去6ヶ月 12m：過去12ヶ月 24m：過去24ヶ月 36m：過去36ヶ月
interval_week	自動変更日(毎週) 0：日曜日 1：月曜日 2：火曜日 3：水曜日 4：木曜日 5：金曜日 6：土曜日
interval_month	自動変更日(毎月) 1：1日 5：5日 10：10日 15：15日 20：20日 25：25日
auto_update_set_date	会員ランクの変更日
use_discount_limit	会員ランクによる割引制限機能を使用するかどうか T：使用する F：使用しない
discount_limit_reset_period	割引制限のリセット周期 1d：毎日 3d：3日 1w：1週間 1m：1ヶ月
discount_limit_reset_week	割引制限のリセット日(毎週) 0：日曜日 1：月曜日 2：火曜日 3：水曜日 4：木曜日 5：金曜日 6：土曜日
discount_limit_reset_date	割引制限のリセット日(毎月) 1：1日 5：5日 10：10日 15：15日 20：20日 25：25日
discount_limit_begin_date	割引制限の開始日
discount_limit_end_date	割引制限の終了日

Retrieve customer tier settings cafe24

GET /api/v2/admin/customergroups/setting

GET

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Customers

Customers Resource構造

会員(Customers)はショップの商品を購入する顧客の中でショップのクーポン、ポイント、割引などの特典をもらうために登録した顧客です。会員を管理するためにショップの運営者は会員を特定会員ランクに分類したり特別会員に指定することができます。

Endpoints

GET /api/v2/admin/customers
DELETE /api/v2/admin/customers/{member_id}

Customers properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
member_id Required Max Length : [20]	会員ID
group_no	会員ランク番号会員ランクの番号
member_authentication	会員認証の有無会員認証の設定。認証によって会員は4種類に区分される。認証会員を特別管理会員に設定する場合、その会員は一番最後に設定した特別管理会員として表示される。 T:認証 F:未認証 B:特別管理会員 J:14歳未満の会員
use_blacklist	要注意会員の設定要注意会員に設定。要注意会員の場合はそのタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。 T:設定する F:設定しない
blacklist_type	要注意会員のブロック設定要注意会員のタイプ。要注意会員のタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。 P:商品購入ブロック L:ログインブロック A:商品購入&ログインブロック
authentication_method	認証方法 null：未認証 i：I-PIN認証 m：電話番号(携帯)認証 e：メール認証 d：電話番号(携帯)認証(重複確認) a：アプリ認証(その他の認証方法)
sms	SMS SMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。 T:受信する F:受信しない
news_mail	メールマガジン受信の有無Ｅメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。 T:受信する F:受信しない
solar_calendar	新暦/旧暦 T:新暦 F:旧暦
total_points	ポイント合計
available_points	使用可能ポイント
used_points	ポイント利用額
last_login_date	直近のアクセス日時会員が最終ログインした日時
gender	性別会員の性別 M:男性 F:女性
use_mobile_app	スマホアプリ使用の設定 T:使用する F:使用しない
available_credits	使用可能預り金
created_date	登録日
fixed_group	会員ランクの固定設定特定会員が会員自動等級変更に適用されないための等級固定可否会員自動等級変更機能を使用するモールでのみ使用できる。 T：固定する F：固定しない

Retrieve a list of customers cafe24 youtube

GET /api/v2/admin/customers

GET

ショッピングモールに登録している特定のメンバーを検索します。
検索する会員の携帯電話または会員IDが検索条件として指定される必要があります。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

cellphone

電話番号(携帯)

照会する会員の携帯電話番号。個人情報保護のために携帯電話番号の全体を入力する必要があります。「cellphone」または「member_id」のうち1つは必ず検索条件として指定してください。

,(コンマ)で複数の件を検索することができる。

member_id

Max Length : [20]

会員ID

検索するショップ会員のID個人情報保護のためにIDは入力漏れがないようにしてください。「cellphone」と「member_id」のうち1つは必ず検索条件として指定してください。

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Delete an account cafe24 youtube

DELETE /api/v2/admin/customers/{member_id}

DELETE

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	会員の投稿権限 (mall.write_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

member_id
Required

Max Length : [20]

会員ID

is_point_check

ポイントを保有している会員を退会処理するかどうか

F：退会処理を行う
T：退会処理を行わない

Request Copy

Response Copy

Customers autoupdate

Endpoints

GET /api/v2/admin/customers/{member_id}/autoupdate

Customers autoupdate properties

Attribute	Description
shop_no	ショップ番号
member_id	会員ID
next_grade	次のランク(予想)
total_purchase_amount	会員ランク算定期間内の使用金額(累計)
total_purchase_count	会員ランク算定期間内の使用件数(累計)
required_purchase_amount	次のランクまでの必要金額
required_purchase_count	次のランクまでの必要件数

Retrieve customer tier auto-update details cafe24

GET /api/v2/admin/customers/{member_id}/autoupdate

GET

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

member_id
Required

Max Length : [20]

会員ID

Request Copy

Response Copy

Customers memos

Endpoints

GET /api/v2/admin/customers/{member_id}/memos/count
GET /api/v2/admin/customers/{member_id}/memos
GET /api/v2/admin/customers/{member_id}/memos/{memo_no}
POST /api/v2/admin/customers/{member_id}/memos
PUT /api/v2/admin/customers/{member_id}/memos/{memo_no}
DELETE /api/v2/admin/customers/{member_id}/memos/{memo_no}

Customers memos properties

Attribute	Description
shop_no	ショップ番号
memo_no	メモ番号
author_id	作成者ID
memo	メモ内容
important_flag	重要メモの有無 T:重要メモ F:一般メモ
created_date	作成日

Retrieve a count of customer memos cafe24

GET /api/v2/admin/customers/{member_id}/memos/count

GET

特定のメンバーのメモの数を照会することができます。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

member_id
Required

会員ID

Request Copy

Response Copy

Retrieve a list of customer memos cafe24

GET /api/v2/admin/customers/{member_id}/memos

GET

特定のメンバーに関するメモのリストを照会することができます。
作成者ID、メモ内容、重要メモの有無などを照会することができます。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
member_id Required	会員ID
start_date Date	検索開始日
end_date Date	検索終了日
important_flag	重要メモの有無 T:重要メモ F:一般メモ
memo	メモ
offset Max : [10000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Retrieve a customer memo cafe24

GET /api/v2/admin/customers/{member_id}/memos/{memo_no}

GET

特定のメンバーのメモの 1 つを照会できます。
メモの作成者ID、メモ内容などを照会することができます。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

memo_no
Required

メモ番号

システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。

member_id
Required

会員ID

Request Copy

Response Copy

Create a customer memo cafe24

POST /api/v2/admin/customers/{member_id}/memos

POST

特定の会員にメモを登録できます。

基本スペック

Property	Description
SCOPE	会員の投稿権限 (mall.write_customer)
呼び出し件数制限	30
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
member_id Required	会員ID
author_id Required Max Length : [20]	作成者ID メモを作成した管理者のID情報
memo Required	メモメモの内容。HTMLを使って登録できる。
important_flag	重要メモの有無重要メモを区分するかどうかを設定 T:重要メモ F:一般メモ DEFAULT F

Request Copy

Response Copy

Update a customer memo cafe24

PUT /api/v2/admin/customers/{member_id}/memos/{memo_no}

PUT

特定のメンバーに登録されているメモを修正できます。

基本スペック

Property	Description
SCOPE	会員の投稿権限 (mall.write_customer)
呼び出し件数制限	30
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
shop_no	ショップ番号 DEFAULT 1
memo_no Required	メモ番号システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。
member_id Required	会員ID
author_id Required Max Length : [20]	作成者ID メモを作成した管理者のID情報
memo	メモメモの内容。HTMLを使って登録できる。
important_flag	重要メモの有無重要メモを区分するかどうかを設定 T:重要メモ F:一般メモ

Request Copy

Response Copy

Delete a customer memo cafe24

DELETE /api/v2/admin/customers/{member_id}/memos/{memo_no}

DELETE

特定のメンバーに登録されているメモを削除できます。

基本スペック

Property	Description
SCOPE	会員の投稿権限 (mall.write_customer)
呼び出し件数制限	30

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

memo_no
Required

メモ番号

システムにより付与された商品メモの固有番号。商品メモ番号はショップ内で重複しない。

member_id
Required

会員ID

Request Copy

Response Copy

Customers paymentinformation

Endpoints

GET /api/v2/admin/customers/{member_id}/paymentinformation
DELETE /api/v2/admin/customers/{member_id}/paymentinformation
DELETE /api/v2/admin/customers/{member_id}/paymentinformation/{payment_method_id}

Customers paymentinformation properties

Attribute	Description
shop_no	ショップ番号
member_id Max Length : [20]	会員ID
payment_method	決済方法名
payment_gateway	決済代行サービス名
created_date	生成日
payment_proiority	決済の優先順位
payment_method_id	定期購入決済方法の番号(ID)

Retrieve a customer's list of payment methods cafe24

GET /api/v2/admin/customers/{member_id}/paymentinformation

GET

特定の会員が使用した決済手段の内訳をリストで照会することができます。
決済手段名、PG名などを照会することができます。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

member_id
Required

Max Length : [20]

会員ID

Request Copy

Response Copy

Delete customer's payment information cafe24

DELETE /api/v2/admin/customers/{member_id}/paymentinformation

DELETE

特定の会員が使用した決済手段の内訳を削除することができます。

基本スペック

Property	Description
SCOPE	会員の投稿権限 (mall.write_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

member_id
Required

Max Length : [20]

会員ID

Request Copy

Response Copy

Delete customer's payment information by payment method ID cafe24

DELETE /api/v2/admin/customers/{member_id}/paymentinformation/{payment_method_id}

DELETE

基本スペック

Property	Description
SCOPE	会員の投稿権限 (mall.write_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

member_id
Required

Max Length : [20]

会員ID

payment_method_id
Required

Order ID

定期購入決済方法の番号(ID)

Request Copy

Response Copy

Customers plusapp

Endpoints

GET /api/v2/admin/customers/{member_id}/plusapp

Customers plusapp properties

Attribute	Description
shop_no Min : [1]	ショップ番号
os_type	OSタイプ
install_date	インストール日
auto_login_flag	自動ログイン設定を使用するかどうか
use_push_flag	通知を受信するかどうか

Retrieve app installation information cafe24

GET /api/v2/admin/customers/{member_id}/plusapp

GET

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

member_id
Required

会員ID

Request Copy

Response Copy

Customers social

Endpoints

GET /api/v2/admin/customers/{member_id}/social

Customers social properties

Attribute	Description
shop_no	ショップ番号
member_id	会員ID
social_name	連携したSNS名
social_member_code	連携したSNSの提供コード
linked_date	連携した日付

GET /api/v2/admin/customers/{member_id}/social

GET

特定会員に連動されたSNSアカウントの情報をリストで照会することができます。
連動されたSNS名と連動日付などを照会することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	会員の閲覧権限 (mall.read_customer)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

member_id
Required

会員ID

Request Copy

Response Copy

Boards

掲示板(Boards)は商品レビューや商品お問い合わせなどお客様の反応が文章で掲示される空間です。
掲示板リソースでは、現在ショッピングモールにある掲示板のリストを確認できます。

Endpoints

GET /api/v2/admin/boards

Boards properties

Attribute	Description
shop_no	ショップ番号
board_no	掲示板番号
board_type	掲示板のカテゴリ 1：運営 2：一般 3：資料室 4：その他 5：商品 6：アルバム 7：My質問 11：ひとこと投稿
board_name	掲示板タイトル
use_additional_board	掲示板の追加有無 T：追加掲示板 F：基本掲示板
use_board	掲示板の使用有無 T:使用する F:使用しない
use_display	表示有無 T:表示する F:表示しない
display_order	並べ替え順序
attached_file	ファイル添付 T:使用する F:使用しない
attached_file_size_limit	添付ファイル容量の上限(Byte)
article_display_type	投稿の表示 A：すべての投稿を表示 T：添付ファイルがある投稿のみ表示 F：添付ファイルがない投稿のみ表示
image_display	画像の表示 T:使用する F:使用しない
image_resize	画像リサイズ時の希望サイズ(幅)(px)

Retrieve a list of boards cafe24 youtube

GET /api/v2/admin/boards

GET

現在ショッピングモールにある掲示板を一覧で照会することができます。
掲示板番号を照会し、掲示物の照会やコメントの照会時に使用することができます。
該当APIは韓国語、日本語ショッピングモールでのみ使用できます。

基本スペック

Property	Description
SCOPE	掲示板の閲覧権限 (mall.read_community)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Boards articles

Endpoints

GET /api/v2/admin/boards/{board_no}/articles
POST /api/v2/admin/boards/{board_no}/articles
PUT /api/v2/admin/boards/{board_no}/articles/{article_no}
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

Boards articles properties

Attribute	Description
shop_no	ショップ番号
article_no Max : [2147483647]	投稿番号
parent_article_no	親投稿の番号
board_no Required	掲示板番号
product_no	商品番号
category_no	カテゴリ番号
board_category_no	掲示板カテゴリ番号
reply_sequence	回答投稿の順序
reply_depth	回答順序
created_date Date	生成日
writer	作成者名
writer_email Email	作成者Eメール
member_id	会員ID
title	タイトル
content	内容
supplier_id Type : [a-z0-9] Length Min : [4]~Max : [16]	供給会社のID
client_ip IP	作成者IP
nick_name	ニックネーム
rating Min : [1]~Max : [5]	評価
sales_channel Max Length : [20]	媒体社
reply_mail	My質問への回答メールの有無 Y：使用する N:使用しない
display	掲示設定 T : 掲示する F : 掲示しない
secret	非公開の有無 T:使用する F:使用しない
notice	告知の有無 T:使用する F:使用しない
fixed	固定投稿の有無 T:使用する F:使用しない
deleted	削除区分 T : 削除 F : 未削除
input_channel	投稿作成のルート P:PC M：モバイル
order_id	注文番号
attach_file_urls	添付ファイルの詳細
hit	観覧数
reply	My質問への回答の有無 T:使用する F:使用しない
reply_user_id	処理中または回答完了した運営者ID
reply_status	回答処理状態 N:回答前 P:処理中 C:対応完了
naverpay_review_id	Naver PayのレビューID
display_time	表示時間使用の有無
display_time_start_hour	表示時間の開始時刻
display_time_end_hour	表示時間の終了時刻
attached_file_detail	添付ファイルの詳細
attached_file_urls	添付ファイルの詳細

Retrieve a list of posts for a board cafe24

GET /api/v2/admin/boards/{board_no}/articles

GET

特定の掲示板の掲示物リストを照会することができます。
該当APIは韓国語、日本語ショッピングモールでのみ使用できます。

基本スペック

Property	Description
SCOPE	掲示板の閲覧権限 (mall.read_community)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
board_no Required	掲示板番号
board_category_no	掲示板カテゴリ番号
start_date Date	検索開始日(作成日) 検索を開始する日付または作成日
end_date Date	検索終了日検索の終了日検索開始日と共に使用する必要があります。検索期間は1回の呼び出しで1年を超えることはできません。
input_channel	ショップ区分 P : PC M : モバイル
search	検索エリア subject : タイトル content : 内容 writer_name : 作成者 product : 商品名 member_id : 会員ID
keyword	検索キーワード
reply_status	回答状態 N : 回答前 P : 処理中 C : 回答完了
comment	コメントの有無 T : 有り F : 無し
attached_file	添付ファイルの有無 T : 有り F : 無し
article_type	投稿タイプ ,(コンマ)で複数の件を検索することができる。 all : すべて normal : 一般投稿 notice : お知らせ投稿 fixed : 固定投稿
product_no	商品番号
has_product	商品情報を含むかどうか T : 有り F : 無し
is_notice	告知の有無 T : 有り F : 無し
is_display	掲示設定 T : 有り F : 無し
supplier_id Type : [a-z0-9] Length Min : [4]~Max : [16]	供給会社のID
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Create a board post cafe24 youtube

POST /api/v2/admin/boards/{board_no}/articles

POST

特定の掲示板に掲示物を登録できます。
該当掲示板が商品掲示板の場合、評点などの情報も登録できます。

基本スペック

Property	Description
SCOPE	掲示板の投稿権限 (mall.write_community)
呼び出し件数制限	40
1回当たり申込件数の制限	10

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
board_no Required	掲示板番号
writer Required Max Length : [100]	作成者名
title Required Max Length : [256]	タイトル
content Required	内容
client_ip Required IP	作成者IP
reply_article_no	回答の投稿番号投稿に回答する場合、投稿番号を入力する。
created_date Date	生成日
writer_email Email	作成者Eメール
member_id Max Length : [20]	会員ID 未入力の場合、代表運営者アカウントで作成される。
notice	告知の有無 T:使用する F:使用しない DEFAULT F
fixed	固定投稿の有無 T:使用する F:使用しない DEFAULT F
deleted	削除区分 T : 削除 F : 未削除 DEFAULT F
reply	My質問への回答の有無 T:使用する F:使用しない DEFAULT F
rating Min : [1]~Max : [5]	評価
sales_channel Max Length : [20]	媒体社
secret	非公開の有無 T:使用する F:使用しない DEFAULT F
password	投稿パスワード
reply_mail	My質問への回答メールの有無 Y：使用する N:使用しない DEFAULT N
board_category_no	掲示板カテゴリ番号
nick_name Max Length : [50]	ニックネーム
input_channel	投稿作成のルート P:PC M：モバイル DEFAULT P
reply_user_id	処理中または回答完了した運営者ID
reply_status	回答処理状態 N:回答前 P:処理中 C:対応完了
product_no Max : [2147483647]	商品番号
category_no	カテゴリ番号
order_id Order ID	注文番号
naverpay_review_id	Naver PayのレビューID
attach_file_urls	添付ファイルの詳細
name ファイル名 url ファイルURL

Request Copy

Response Copy

Update a board post cafe24

PUT /api/v2/admin/boards/{board_no}/articles/{article_no}

PUT

特定の掲示板の掲示物を修正できます。
掲示物のタイトル、内容と評点、露出時間などの情報を修正することができます。
該当APIは韓国語、日本語ショッピングモールでのみ使用できます。

基本スペック

Property	Description
SCOPE	掲示板の投稿権限 (mall.write_community)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
board_no Required	掲示板番号
article_no Required	投稿番号
title Max Length : [256]	タイトル
content	内容
rating Min : [1]~Max : [5]	評価
sales_channel Max Length : [20]	媒体社
board_category_no	掲示板カテゴリ番号
display	掲示設定 T : 掲示する F : 掲示しない
notice	告知の有無 T:使用する F:使用しない
fixed	固定投稿の有無 T:使用する F:使用しない
display_time_start_hour	表示時間の開始時刻
display_time_end_hour	表示時間の終了時刻
attach_file_url1 URL	ファイルURL
attach_file_url2 URL	ファイルURL
attach_file_url3 URL	ファイルURL
attach_file_url4 URL	ファイルURL
attach_file_url5 URL	ファイルURL

Request Copy

Response Copy

Delete a board post cafe24

DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}

DELETE

特定の掲示板にある掲示物の 1 つを削除できます。
該当APIは韓国語、日本語ショッピングモールでのみ使用できます。

基本スペック

Property	Description
SCOPE	掲示板の投稿権限 (mall.write_community)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

board_no
Required

掲示板番号

article_no
Required

Max : [2147483647]

投稿番号

Request Copy

Response Copy

Boards articles comments

Endpoints

GET /api/v2/admin/boards/{board_no}/articles/{article_no}/comments
POST /api/v2/admin/boards/{board_no}/articles/{article_no}/comments
DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}/comments/{comment_no}

Boards articles comments properties

Attribute	Description
shop_no	ショップ番号
board_no	掲示板番号
article_no	投稿番号
comment_no	コメント番号
content	コメント内容
writer Max Length : [100]	作成者名
member_id Max Length : [20]	会員ID
created_date Date	生成日
client_ip IP	作成者IP
rating Min : [1]~Max : [5]	コメント評価
secret	非公開の有無 T:使用する F:使用しない
parent_comment_no	親コメント番号
input_channel	ショップ区分 P : PC M : モバイル
attach_file_urls	添付ファイルの詳細

Retrieve a list of comments for a board post cafe24 youtube

GET /api/v2/admin/boards/{board_no}/articles/{article_no}/comments

GET

特定の投稿についてのコメントを照会することができます。
コメント内容、作成者名、会員IDなどを確認できます。

基本スペック

Property	Description
SCOPE	掲示板の閲覧権限 (mall.read_community)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
board_no Required	掲示板番号
article_no Required	投稿番号
comment_no	コメント番号
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Create a comment for a board post cafe24 youtube

POST /api/v2/admin/boards/{board_no}/articles/{article_no}/comments

POST

特定の投稿にコメントを追加したり、コメントにコメントを追加したりすることもできます。
投稿番号、コメント内容などを必須入力します。

基本スペック

Property	Description
SCOPE	掲示板の投稿権限 (mall.write_community)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
board_no Required	掲示板番号
article_no Required	投稿番号
content Required	コメント内容
writer Required Max Length : [100]	作成者名
password Required Length Min : [1]~Max : [20]	コメントのパスワード
member_id Max Length : [20]	会員ID
rating Min : [1]~Max : [5]	コメント評価 DEFAULT 0
secret	非公開の有無 T:使用する F:使用しない DEFAULT F
parent_comment_no Min : [1]	親コメント番号
input_channel	ショップ区分 P : PC M : モバイル DEFAULT P
created_date Date	生成日
attach_file_urls	添付ファイルの詳細
name ファイル名 url ファイルURL

Request Copy

Response Copy

Delete a comment for a board post cafe24

DELETE /api/v2/admin/boards/{board_no}/articles/{article_no}/comments/{comment_no}

DELETE

特定の投稿についてのコメントを削除できます。

基本スペック

Property	Description
SCOPE	掲示板の投稿権限 (mall.write_community)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
board_no Required	掲示板番号
article_no Required	投稿番号
comment_no Required	コメント番号

Request Copy

Response Copy

Boards comments

Endpoints

GET /api/v2/admin/boards/{board_no}/comments

Boards comments properties

Attribute	Description
shop_no	ショップ番号
board_no	掲示板番号
article_no	投稿番号
comment_no	コメント番号
content	コメント内容
writer Max Length : [100]	作成者名
member_id Max Length : [20]	会員ID
created_date Date	生成日
client_ip IP	作成者IP
rating Min : [1]~Max : [5]	コメント評価
secret	非公開の有無 T:使用する F:使用しない
parent_comment_no	親コメント番号
input_channel	ショップ区分 P : PC M : モバイル
attach_file_urls	添付ファイルの詳細
links	link

Retrieve comments in bulk cafe24 youtube

GET /api/v2/admin/boards/{board_no}/comments

GET

基本スペック

Property	Description
SCOPE	掲示板の閲覧権限 (mall.read_community)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
board_no Required	掲示板番号
since_comment_no Min : [1] Max : [2147483647]	指定のコメント番号以降のコメントを検索
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Financials monthlyreviews

月別レビュー統計(Financials monthlyreviews)は、月別レビュー情報を提供します。
検索期間内の月別レビュー数の合計、月別レビュー評点の平均を確認できます。

Endpoints

GET /api/v2/admin/financials/monthlyreviews

Financials monthlyreviews properties

Attribute	Description
shop_no	ショップ番号
month	年月
count	レビュー件数の合計
rating_average	評価の平均

Retrieve the total count for monthly reviews and ratings cafe24 youtube

GET /api/v2/admin/financials/monthlyreviews

GET

検索期間内の月別レビュー情報を照会します。
月別レビュー数の合計、月別レビュー評点の平均を確認できます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	掲示板の閲覧権限 (mall.read_community)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

start_month
Required

検索期間の開始月

end_month
Required

検索期間の終了月

Request Copy

Response Copy

Urgentinquiry

緊急お問い合わせの照会ができます。

Endpoints

GET /api/v2/admin/urgentinquiry

Urgentinquiry properties

Attribute	Description
shop_no	ショップ番号
article_no	投稿番号
article_type	投稿タイプ
title	タイトル
writer	作成者名
member_id	会員ID
start_date Date	作成日の開始日
reply_status	回答処理状態 F：未処理 I：処理中 T：処理完了
hit	観覧数
content	内容
writer_email Email	作成者Eメール
phone Phone Number	電話番号
search_type	検索タイプ P：商品 O：注文
keyword	検索キーワード
attached_file_detail	添付ファイルの詳細

Retrieve an urgent inquiry post cafe24 youtube

GET /api/v2/admin/urgentinquiry

GET

緊急お問い合わせを照会します。
投稿タイプ、回答処理状態、観覧数などの情報を確認することができます。

基本スペック

Property	Description
SCOPE	掲示板の閲覧権限 (mall.read_community)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
start_date Date	作成日の開始日
end_date Date	作成日の終了日
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Urgentinquiry reply

Endpoints

GET /api/v2/admin/urgentinquiry/{article_no}/reply
POST /api/v2/admin/urgentinquiry/{article_no}/reply
PUT /api/v2/admin/urgentinquiry/{article_no}/reply

Urgentinquiry reply properties

Attribute	Description
shop_no	ショップ番号
article_no	投稿番号
created_date Date	回答登録日
status	回答処理状態 F：未処理 I：処理中 T：処理完了
content	回答内容
method	回答方法 E：メール S：SMS A：すべて
count	回答の処理回数
user_id	処理中または回答完了した運営者ID
attached_file_detail	添付ファイルの詳細

Retrieve a reply for urgent inquiry post cafe24 youtube

GET /api/v2/admin/urgentinquiry/{article_no}/reply

GET

緊急お問い合わせの回答を照会します。
回答登録日、回答処理状態、回答の処理回数などの情報を確認することができます。

基本スペック

Property	Description
SCOPE	掲示板の閲覧権限 (mall.read_community)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

article_no
Required

投稿番号

Request Copy

Response Copy

Create a reply for urgent inquiry post cafe24 youtube

POST /api/v2/admin/urgentinquiry/{article_no}/reply

POST

緊急お問い合わせに回答を登録します。

基本スペック

Property	Description
SCOPE	掲示板の投稿権限 (mall.write_community)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
article_no Required	投稿番号
content Required	回答内容
status	回答処理状態 F：未処理 I：処理中 T：処理完了 DEFAULT F
user_id Required Max Length : [20]	処理中または回答完了した運営者ID
attach_file_urls	添付ファイルの詳細
name Required ファイル名 url Required ファイルURL

Request Copy

Response Copy

Update a reply for urgent inquiry post cafe24 youtube

PUT /api/v2/admin/urgentinquiry/{article_no}/reply

PUT

緊急お問い合わせの回答を修正します。

基本スペック

Property	Description
SCOPE	掲示板の投稿権限 (mall.write_community)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
article_no Required	投稿番号
content Required	回答内容
status	回答処理状態 F：未処理 I：処理中 T：処理完了
user_id Max Length : [20]	処理中または回答完了した運営者ID
attach_file_urls	添付ファイルの詳細
name Required ファイル名 url Required ファイルURL

Request Copy

Response Copy

Icons

デザインアイコンとは、商品、掲示板、イベント、カード、決済手段のロゴとして使用中の小さいイメージのことです。
PCショップとモバイルショップのアイコンをすべて確認することができます。

Endpoints

GET /api/v2/admin/icons

Icons properties

Attribute	Description
shop_no	ショップ番号
id	アイコンID
type	デザインタイプ pc:PC mobile:モバイル
group_code	グループコード A：商品アイコン B：掲示板アイコン C：クレジットカードアイコン E：キャンペーンアイコン
path	アイコンURL
display	アイコンを表示するかどうか T：表示する F：表示しない
description	アイコン説明

Retrieve a list of desgin icons cafe24

GET /api/v2/admin/icons

GET

PCとモバイルショップで使用中のアイコンを照会します。

基本スペック

Property	Description
SCOPE	デザインの閲覧権限 (mall.read_design)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

type

デザインタイプ

pc:PC
mobile:モバイル

DEFAULT pc

Request Copy

Response Copy

Themes

デザイン(Themes)はショップに使うために購入または直接制作したデザイン情報です。デザインは PCショップとモバイルショップのデザインを両方とも確認することができます。デザインリストにあるデザインの中で代表デザインを指定するとショップのデザインがそのデザインに変更されます。

Endpoints

GET /api/v2/admin/themes
GET /api/v2/admin/themes/count
GET /api/v2/admin/themes/{skin_no}

Themes properties

Attribute	Description
skin_no Min : [1]	デザイン番号
skin_code	デザインコード
skin_name Max Length : [100]	デザイン名
skin_thumbnail_url Max Length : [255]	デザインサムネイル画像のURL
usage_type	デザイン用途の区分 S:PCの基本デザイン C:PCのコピーされたデザイン I:PCの連動されたデザイン M:モバイルの基本デザイン/連動されたデザイン N:モバイルのコピーされたデザイン
editor_type	エディタータイプ H : スマートデザイン(HTML) D : Edibotデザイン(Drag & Drop) W : シンプルデザイン(WYSIWYG) E：スマートデザインEasy
parent_skin_no	親デザイン番号
seller_id	販売者のデザインセンターID
seller_skin_code	販売者のデザインコード
design_purchase_no Min : [0]	デザイン購入番号
design_product_code	デザインセンターの商品コード
language_code Min Length : [5] Max Length : [5]	言語コード ko_KR:韓国語 en_US:英語 zh_CN:中国語(簡体字) zh_TW:中国語(繁体字) ja_JP:日本語 pt_PT:ポルトガル語 es_ES:スペイン語 vi_VN:ベトナム語
published_in	メインデザインを設定した越境ECショップの番号
created_date Date	作成日
updated_date Date	修正日
preview_domain	ドメインの照会

Retrieve a list of themes cafe24

GET /api/v2/admin/themes

GET

PCショッピングモールまたはモバイルショッピングモールの全体デザインの情報をリストで照会することができます。
デザインコード、デザイン名、言語コードなどを照会することができます。

基本スペック

Property	Description
SCOPE	デザインの閲覧権限 (mall.read_design)
呼び出し件数制限	40

要求スペック

Parameter	Description
type	デザインタイプ pc:PC mobile:モバイル DEFAULT pc

Request Copy

Response Copy

Retrieve a count of themes cafe24

GET /api/v2/admin/themes/count

GET

ショッピングモールのデザインの数を照会することができます。

基本スペック

Property	Description
SCOPE	デザインの閲覧権限 (mall.read_design)
呼び出し件数制限	40

要求スペック

Parameter	Description
type	デザインタイプ pc:PC mobile:モバイル DEFAULT pc

Request Copy

Response Copy

Retrieve a theme cafe24

GET /api/v2/admin/themes/{skin_no}

GET

ショッピングモールの特定スキン番号（デザイン番号）の情報を照会することができます。
デザインコード、デザイン名などを照会することができます。

基本スペック

Property	Description
SCOPE	デザインの閲覧権限 (mall.read_design)
呼び出し件数制限	40

要求スペック

Parameter	Description
skin_no Min : [1]	デザイン番号

Request Copy

Response Copy

Themes pages

Endpoints

GET /api/v2/admin/themes/{skin_no}/pages
POST /api/v2/admin/themes/{skin_no}/pages

Themes pages properties

Attribute	Description
skin_no	デザイン番号
skin_code	デザインコード
path	ファイル経路
source	ソースコード
display_location	画面の分類

Retrieve a theme page cafe24

GET /api/v2/admin/themes/{skin_no}/pages

GET

スキンを指定したテーマページを照会することができます。

基本スペック

Property	Description
SCOPE	デザインの閲覧権限 (mall.read_design)
呼び出し件数制限	40

要求スペック

Parameter	Description
skin_no Required	デザイン番号
path Required	ファイル経路

Request Copy

Response Copy

Create a theme page cafe24

POST /api/v2/admin/themes/{skin_no}/pages

POST

テーマページを設定します。
デザインテーマの特定の経路に設定することができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	デザインの投稿権限 (mall.write_design)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
skin_no Required	デザイン番号
path Required	ファイル・ディレクトリ経路
source	ソースコード
display_location	画面の分類

Request Copy

Response Copy

Benefits

「Benefits」では、[プロモーション > 特典管理]のイベント、割引、クーポンなどを照会することができます。

Endpoints

GET /api/v2/admin/benefits
GET /api/v2/admin/benefits/count
GET /api/v2/admin/benefits/{benefit_no}
POST /api/v2/admin/benefits
PUT /api/v2/admin/benefits/{benefit_no}
DELETE /api/v2/admin/benefits/{benefit_no}

Benefits properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
benefit_no	特典番号特典が生成された場合に付与される固有番号
use_benefit	提供の有無
benefit_name Max Length : [255]	特典名
benefit_division	特典タイプ該当特典のタイプで、割引と贈呈に区分される。
benefit_type	特典タイプ詳細該当特典の詳細タイプ割引:期間割引、再購入割引、大量購入割引、会員割引、新規商品割引、送料割引贈呈: ギフト贈呈、1Nイベント
use_benefit_period	特典期間設定当該特典が適用される期間を設定したかどうか、
benefit_start_date Date	開始日特典が適用される期間を設定した場合、当該特典が開始される日時
benefit_end_date Date	終了日特典が適用される期間を設定した場合、当該特典が終了する日時
platform_types	特典使用の範囲該当特典が適用される範囲(PC、モバイル、プラスアプリ)
use_group_binding	提供対象設定該当特典が適用される対象を設定(会員非会員、非会員、会員)
customer_group_list	会員ランク参加対象を会員に設定した場合、参加可能な会員等級を設定
product_binding_type	特典対象商品当該特典が適用される商品の範囲全商品 : 全商品に特典適用特定商品:選択した特定商品に対してのみ特典適用除外商品:選択した特定商品に対してのみ特典適用除外商品分類 : 選択した商品分類に属する商品に対してのみ特典適用
use_except_category	カテゴリ適用除外特定商品分類に対して特典適用を除く (各タイプ別に設定可能可否が異なる) 期間割引:全商品、特定商品の場合は設定可能新規商品割引:全商品の場合、設定可能その他、割引·贈呈タイプでは設定不可
available_coupon	クーポン使用範囲クーポンがある場合、クーポンが重複して使用できるかどうか
icon_url	アイコンURL 特典が適用される商品名にアイコンが露出されるようアイコン登録
created_date	特典登録日当該特典が登録された日時
period_sale	期間割引設定特典の詳細タイプが期間割引の場合、それに関連する詳細設定下位要素が入力されないと正常な登録ができない。
repurchase_sale	再購入割引設定特典の詳細タイプが再購入割引の場合、それに関する詳細設定
bulk_purchase_sale	大量購入数量設定特典の詳細タイプが大量購入割引の場合、それに関する詳細設定
member_sale	会員割引設定特典の詳細タイプが会員割引の場合、それに関する詳細設定
new_product_sale	新着商品割引設定特典の詳細タイプが新規商品割引の場合、それに関する詳細設定下位要素が入力されないと正常な登録ができない。
shipping_fee_sale	送料割引設定特典の詳細タイプが送料割引の場合、それに関する詳細設定下位要素が入力されないと正常な登録ができない。
gift	ノベルティ設定特典の詳細タイプがギフト贈呈の場合、それに関する詳細設定下位要素が入力されないと正常な登録ができない。
gift_product_bundle	1+Nイベント設定特典の詳細タイプが1Nイベントの場合、それに関連する詳細設定下位要素が入力されないと正常な登録ができない。

Retrieve a list of customer benefits cafe24

GET /api/v2/admin/benefits

GET

特典をリストで照会することができます。
特典の進行状況、特典名、特典タイプなどを照会することができます。
現在進行中の特典だけを照会したり、特定期間を通じて特典を照会することができます。

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
use_benefit	提供の有無 T:提供する F:提供しない
benefit_name	特典名
benefit_type	特典タイプ詳細クーポンによる特典の種類の区分 DP：期間限定割引 DR：再購入割引 DQ：大量購入割引 DM：会員限定割引 DN：新着商品割引 DV：送料割引 PG：ノベルティ PB ：1+Nイベント
period_type	特典期間タイプ R: 特典登録日 S: 特典開始日 E: 特典終了日
benefit_start_date Date	検索開始日
benefit_end_date Date	検索終了日
platform_types	特典使用の範囲 ,(コンマ)で複数の件を検索することができる。 P:PCショップ M:Mobileショップ A:プラスアプリ
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of customer benefits cafe24

GET /api/v2/admin/benefits/count

GET

特典の数を照会することができます。
現在進行中の特典だけを照会したり、特定期間を通じて特典を照会することができます。

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
use_benefit	提供の有無 T:提供する F:提供しない
benefit_name	特典名
benefit_type	特典タイプ詳細クーポンによる特典の種類の区分 DP：期間限定割引 DR：再購入割引 DQ：大量購入割引 DM：会員限定割引 DN：新着商品割引 DV：送料割引 PG：ノベルティ PB ：1+Nイベント
period_type	特典期間タイプ R: 特典登録日 S: 特典開始日 E: 特典終了日
benefit_start_date Date	検索開始日
benefit_end_date Date	検索終了日
platform_types	特典使用の範囲 ,(コンマ)で複数の件を検索することができる。 P:PCショップ M:Mobileショップ A:プラスアプリ

Request Copy

Response Copy

Retrieve a customer benefit cafe24

GET /api/v2/admin/benefits/{benefit_no}

GET

特定の特典を詳細に照会することができます。
リスト照会では、提供されない期間割引、会員割引などの詳細設定を確認できます。

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

benefit_no
Required

特典番号

特典が生成された場合に付与される固有番号

Request Copy

Response Copy

Create a customer benefit cafe24

POST /api/v2/admin/benefits

POST

特典を新たに作成できます。
割引または贈呈の中から選択でき、特典対象と割引期間などを選択できます。

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショッピングモール区分のために使用するマルチショッピングモール番号 DEFAULT 1
shop_no	ショップ番号マルチショッピングモール区分のために使用するマルチショッピングモール番号 DEFAULT 1
shop_no	ショップ番号マルチショッピングモール区分のために使用するマルチショッピングモール番号
use_benefit Required	提供の有無 T:提供する F:提供しない
benefit_name Required Max Length : [255]	特典名
benefit_division Required	特典タイプ該当特典のタイプで、割引と贈呈に区分される。 D：割引 P：贈呈
benefit_type Required	特典タイプ詳細該当特典の詳細タイプ DP：期間限定割引 DN：新着商品割引 DV：送料割引 PG：ノベルティ PB：1+Nイベント
use_benefit_period	特典期間設定当該特典が適用される期間を設定するかどうか使用することに設定する場合は、特典開始日と終了日を入力する必要があります。 T:使用する F:使用しない
benefit_start_date Date	開始日特典が適用される期間を設定した場合、当該特典が開始される日時
benefit_end_date Date	終了日特典が適用される期間を設定した場合、当該特典が終了する日時
platform_types Required	特典使用の範囲該当特典が適用される範囲 P:PCショップ M:Mobileショップ A:プラスアプリ
use_group_binding	提供対象設定当該特典が適用される対象を設定 A : 会員 + 非会員 N : 非会員 M : 会員
customer_group_list	会員ランク参加対象を会員に設定した場合、参加可能な会員等級を設定
product_binding_type	特典対象商品当該特典が適用される商品の範囲 A : 全商品 P : 特定商品 E : 除外送品 C : 商品カテゴリ
use_except_category	カテゴリ適用除外特定商品分類に対して特典適用を除く (各タイプ別に設定可能可否が異なる) 期間割引:全商品、特定商品の場合は設定可能新規商品割引:全商品の場合、設定可能その他、割引·贈呈タイプでは設定不可 T:使用する F:使用しない
available_coupon	クーポン使用範囲クーポンがある場合、クーポンが重複して使用できるかどうか T:すべてのクーポンを使用できる F:すべてのクーポンが使用できない
period_sale	期間割引設定特典の詳細タイプが期間割引の場合、それに関連する詳細設定下位要素が入力されないと正常な登録ができない。割引金額(discount_value_unit)が比率(P)の場合、割引四捨五入単位(discount_truncation_unit)、割引単位処理(discount_truncation_method)必須入力割引金額(discount_value_unit)が金額(W)の場合、discount_purchasing_quantity必須入力
product_list 商品リスト add_category_list 商品カテゴリ except_category_list 除外カテゴリ discount_purchasing_quantity 割引適用数量 T : 購入数による、 F : 購入数関係なし discount_value 割引値 discount_value_unit 割引基準 P : 比率、 W : 金額 discount_truncation_unit 割引切り上げ単位 F : 切り捨てしない、 C : 0.01、 B : 0.1、 O : 1、 T : 10、 M : 100、 H : 1000 discount_truncation_method 割引単位で処理 L : 切り捨て、 U : 四捨五入、 C : 切り上げ
gift	ノベルティ設定特典の詳細タイプがギフト贈呈の場合、それに関する詳細設定下位要素が入力されないと正常な登録ができない。
product_list 商品リスト add_category_list 商品カテゴリ offer_only_first 初回購入かどうか T:使用する、F:使用しない first_purchase_type 初回購入基準 O : 注文基準、 D : 配送完了基準 use_unlimited_price 価格最大値制限 T:使用する、F:使用しない purchase_start_price 購入価格制限(n 以上) purchase_limit_price 購入価格制限(n 未満) gift_product_list Array product_no 商品番号 Required gift_point 差引点数 Required max_count 最大選択数量
new_product_sale	新着商品割引設定特典の詳細タイプが新規商品割引の場合、それに関する詳細設定下位要素が入力されないと正常な登録ができない。割引金額(discount_value_unit)が比率(P)の場合、割引四捨五入単位(discount_truncation_unit)、割引単位処理(discount_truncation_method)必須入力割引金額(discount_value_unit)が金額(W)の場合、discount_purchasing_quantity必須入力
product_list 商品リスト add_category_list 商品カテゴリ except_category_list 除外カテゴリ new_product_date_type Required 新商品設定基準日 I : 商品登録日､ U : 商品の最終修正日、 V : 商品の最終表示日 new_product_day Required 新商品設定値(数字入力) new_product_term_type Required 新商品設定単位(日/時間) D : 日、 H : 時間 discount_purchasing_quantity 割引適用数量 T : 購入数による、 F : 購入数関係なし discount_value Required 割引値 discount_value_unit 割引基準 P : 比率、 W : 金額 discount_truncation_unit 割引切り上げ単位 F : 切り捨てしない、 C : 0.01、 B : 0.1、 O : 1、 T : 10、 M : 100、 H : 1000 discount_truncation_method 割引単位で処理 L : 切り捨て、 U : 四捨五入、 C : 切り上げ
shipping_fee_sale	送料割引設定特典の詳細タイプが送料割引の場合、それに関する詳細設定下位要素が入力されないと正常な登録ができない。
product_list 商品リスト use_purchase_price_condition 金額基準使用の有無 T:使用する、F:使用しない total_purchase_price 金額制限 include_regional_shipping_rate 地域別送料を含むかどうかの値 T:含む、F:含まない
gift_product_bundle	1+Nイベント設定特典の詳細タイプが1Nイベントの場合、それに関連する詳細設定下位要素が入力されないと正常な登録ができない。
product_list 商品リスト product_bundle_type Required 特典設定 P : 商品、 I : 品目 product_bundle_count Required 追加商品数量
icon_url	アイコンURL 特典が適用される商品名にアイコンが露出されるようアイコン登録

Request Copy

Response Copy

Update a customer benefit cafe24

PUT /api/v2/admin/benefits/{benefit_no}

PUT

特定の特典を修正できます。
割引タイプを除き、特典期間や進行状況、特典名などの詳細を修正できます。

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショッピングモール区分のために使用するマルチショッピングモール番号 DEFAULT 1
benefit_no Required	特典番号特典が生成された場合に付与される固有番号
use_benefit	提供の有無 T:提供する F:提供しない
benefit_name Max Length : [255]	特典名
use_benefit_period	特典期間設定当該特典が適用される期間を設定するかどうか T:使用する F:使用しない
benefit_start_date Date	開始日特典が適用される期間を設定した場合、当該特典が開始される日時特典開始日を修正したい場合は、use_benefit_periodパラメータを必ず宣言する必要があります。
benefit_end_date Date	終了日特典が適用される期間を設定した場合、当該特典が終了する日時特典終了日を修正したい場合は、use_benefit_periodパラメータを必ず宣言しなければならない。
platform_types	特典使用の範囲該当特典が適用される範囲 P:PCショップ M:Mobileショップ A:プラスアプリ
use_group_binding	提供対象設定当該特典が適用される対象を設定 A : 会員 + 非会員 N : 非会員 M : 会員
customer_group_list	会員ランク参加対象を会員に設定した場合、参加可能な会員等級を設定会員レベルを修正したい場合は、use_group_bindingパラメータを必ず宣言しなければならない。
product_binding_type	特典対象商品当該特典が適用される商品の範囲商品範囲がP,E,Cの場合、既に設定された商品または分類を修正したい場合は、product_binding_typeパラメータを必ず宣言しなければならない。 A : 全商品 P : 特定商品 E : 除外送品 C : 商品カテゴリ
use_except_category	カテゴリ適用除外特定商品分類に対して特典適用を除く (各タイプ別に設定可能可否が異なる) 期間割引:全商品、特定商品の場合は設定可能新規商品割引:全商品の場合、設定可能その他、割引·贈呈タイプでは設定不可既に設定された除外分類を修正したい場合は、use_except_categoryパラメータを必ず宣言しなければならない。 T:使用する F:使用しない
available_coupon	クーポン使用範囲クーポンがある場合、クーポンが重複して使用できるかどうか T:すべてのクーポンを使用できる F:すべてのクーポンが使用できない
period_sale	期間割引設定特典の詳細タイプが期間割引の場合、それに関連する詳細設定下位要素が入力されてこそ正常な修正が可能。割引金額(discount_value_unit)が比率(P)の場合、割引四捨五入単位(discount_truncation_unit)、割引単位処理(discount_truncation_method)必須入力割引金額(discount_value_unit)が金額(W)の場合、discount_purchasing_quantity必須入力
product_list 商品リスト add_category_list 商品カテゴリ except_category_list 除外カテゴリ discount_purchasing_quantity 割引適用数量 T : 購入数による、 F : 購入数関係なし discount_value 割引値 discount_value_unit 割引基準 P : 比率、 W : 金額 discount_truncation_unit 割引切り上げ単位 F : 切り捨てしない、 C : 0.01、 B : 0.1、 O : 1、 T : 10、 M : 100、 H : 1000 discount_truncation_method 割引単位で処理 L : 切り捨て、 U : 四捨五入、 C : 切り上げ
gift	ノベルティ設定特典の詳細タイプがギフト贈呈の場合、それに関する詳細設定下位要素が入力されてこそ正常な修正が可能。
product_list 商品リスト add_category_list 商品カテゴリ offer_only_first 初回購入かどうか T:使用する、F:使用しない first_purchase_type 初回購入基準 O : 注文基準、 D : 配送完了基準 use_unlimited_price 価格最大値制限 T:使用する、F:使用しない purchase_start_price 購入価格制限(n 以上) purchase_limit_price 購入価格制限(n 未満) gift_product_list Array product_no 商品番号 gift_point 差引点数 max_count 最大選択数量
gift_product_bundle	1+Nイベント設定特典の詳細タイプが1Nイベントの場合、それに関連する詳細設定下位要素が入力されてこそ正常な修正が可能。
product_list 商品リスト product_bundle_count 追加商品数量
new_product_sale	新着商品割引設定特典の詳細タイプが新規商品割引の場合、それに関する詳細設定下位要素が入力されてこそ正常な修正が可能。割引金額(discount_value_unit)が比率(P)の場合、割引四捨五入単位(discount_truncation_unit)、割引単位処理(discount_truncation_method)必須入力割引金額(discount_value_unit)が金額(W)の場合、discount_purchasing_quantity必須入力
product_list 商品リスト add_category_list 商品カテゴリ except_category_list 除外カテゴリ new_product_date_type 新商品設定基準日 I : 商品登録日､ U : 商品の最終修正日、 V : 商品の最終表示日 new_product_day 新商品設定値(数字入力) new_product_term_type 新商品設定単位(日/時間) D : 日、 H : 時間 discount_purchasing_quantity 割引適用数量 T : 購入数による、 F : 購入数関係なし discount_value 割引値 discount_value_unit 割引基準 P : 比率、 W : 金額 discount_truncation_unit 割引切り上げ単位 F : 切り捨てしない、 C : 0.01、 B : 0.1、 O : 1、 T : 10、 M : 100、 H : 1000 discount_truncation_method 割引単位で処理 L : 切り捨て、 U : 四捨五入、 C : 切り上げ
shipping_fee_sale	送料割引設定特典の詳細タイプが送料割引の場合、それに関する詳細設定下位要素が入力されてこそ正常な修正が可能。
product_list 商品リスト use_purchase_price_condition 金額基準使用の有無 T:使用する、F:使用しない total_purchase_price 金額制限 include_regional_shipping_rate 地域別送料を含むかどうかの値 T:含む、F:含まない
icon_url	アイコンURL 特典が適用される商品名にアイコンが露出されるようアイコン登録（空の値でリクエストすると、既存に登録されたアイコンが削除されます）

Request Copy

Response Copy

Delete a customer benefit cafe24

DELETE /api/v2/admin/benefits/{benefit_no}

DELETE

生成された特典を削除できます。

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショッピングモール区分のために使用するマルチショッピングモール番号

DEFAULT 1

benefit_no
Required

特典番号

特典が生成された場合に付与される固有番号

Request Copy

Response Copy

Coupons

Coupons Resource関係図
クーポン(Coupons)は商品の価格や送料を割引してもえるようにショップの会員に発行する特典です。クーポンはショップの販売促進(プロモーション)のために使うことができ、多様な形で会員に発行することができます。

Endpoints

GET /api/v2/admin/coupons/count
GET /api/v2/admin/coupons
POST /api/v2/admin/coupons

Coupons properties

Attribute	Description
shop_no	ショップ番号 DEFAULT 1
coupon_no	クーポンID
coupon_type	クーポンタイプクーポンのタイプ。オンラインクーポンとオフラインクローズドクーポンがある。 O:オンラインクーポン S:オフラインクローズドクーポン
coupon_name	クーポン名クーポンの名前
coupon_description	クーポン内容クーポンに対する説明
created_date	作成日クーポンの生成日
deleted	クーポンの削除有無クーポンが削除されたかどうかの区分 T:削除 F:削除されていない
is_stopped_issued_coupon	クーポンの完全削除(発行済みクーポンの使用停止)可否クーポンが完全に削除されたかどうかの有無。クーポンが完全に削除されるとすでに発行されたクーポンも使用できなくなる。 T:完全削除 F:完全削除ではない
pause_begin_datetime	クーポン発行一時停止の開始時間クーポンを条件付き自動発行に設定した場合、条件に合っても発行を一時停止する期間の開始時間
pause_end_datetime	クーポン発行一時停止の終了時間クーポンを条件付き自動発行に設定した場合、条件に合っても発行を一時停止する期間の終了時間
benefit_text	クーポン特典詳細の出力クーポンによる特典の詳細内訳が出力される。
benefit_type	特典区分特典のタイプ。タイプ別に付与する特典が異なる。
benefit_price	特典金額特典として割引される金額
benefit_percentage	特典割合特典として割引される割合
benefit_percentage_round_unit	特典割合の切り捨ての位特典として割引される金額の切り捨て単位
benefit_percentage_max_price	特典割合の最大金額特典として割引される最大金額
include_regional_shipping_rate	送料割引時に地域別区分を含むか否かの設定送料を割引する場合に地域別送料を含めるかどうかを設定 T:地域別区分を含む F:地域別区分を含まない DEFAULT F
include_foreign_delivery	海外配送を含むかの有無クーポンによる特典に海外配送を含めるかどうかを設定 T:海外配送を含む F:海外配送を含まない DEFAULT F
coupon_direct_url	クーポンの直接アクセス経路クーポンに直接アクセスできる経路
issue_type	発行方式クーポンの発行形態のタイプ
issue_sub_type	発行下位タイプクーポン発行の詳細下位タイプ M：会員対象 C：リアルタイムアクセス者対象 J：会員登録 D：配送完了時 A：記念日(誕生日) I：モジュール(プログラム)設置 P：商品レビュー投稿 O：注文完了時 Q：購入数量充足時 F：初注文の顧客 N：一定期間購入していない会員対象 U：会員ランクのランクアップ時
issue_member_join	会員登録時のクーポン発行の有無会員登録時に発行するクーポンであるかどうかを設定 T:発行対象 F:発行対象ではない DEFAULT F
issue_member_join_recommend	会員登録時の紹介者に対するクーポン発行の有無会員登録時に紹介者に発行するクーポンであるかどうかを設定 T:発行対象 F:発行対象ではない DEFAULT F
issue_member_join_type	会員登録時のクーポン発行対象会員登録時にクーポンを発行する対象の区分 A:SMS受信同意ANDメール受信同意 O:SMS受信同意ORメール受信同意 S:SMS受信同意 E:メール受信同意
issue_order_amount_type	発行可能な購入金額のタイプクーポンによる割引の対象になる金額の基準 O:購入金額基準 S:実際の決済金額基準
issue_order_start_date	クーポン発行可能な注文開始日時
issue_order_end_date	クーポン発行可能な注文終了日時
issue_order_amount_limit	発行可能購入金額の制限タイプクーポンの発行可能な購入金額を制限することができる。 U:制限なし L:最小金額 S:金額範囲
issue_order_amount_min	発行可能な最小購入金額クーポンの発行可能な最小購入金額
issue_order_amount_max	発行可能な最大購入金額クーポンの発行可能な最大購入金額
issue_order_path	注文ルート発行したクーポンの使用可能な注文経路 W:PCショップ専用 M:モバイルショップ専用 P:プラスアプリ専用
issue_order_type	発行単位クーポンの発行単位 O:注文書単位発行クーポン P:商品単位発行クーポン
issue_order_available_product	発行対象商品クーポンの発行対象になる商品 U:制限なし I:選択商品適用 E:選択商品を除く
issue_order_available_category	発行対象カテゴリクーポンの発行対象になるカテゴリ U:制限なし I:選択商品適用 E:選択商品を除く
issue_anniversary_type	発行条件記念日のタイプクーポンの発行条件になる記念日のタイプ B:誕生日 W:結婚記念日
issue_anniversary_pre_issue_day	発行条件記念日の事前発行日数記念日クーポンの事前発行可能な日数
issue_module_type	発行条件設置モジュールのタイプモジュール設置発行クーポンの設置モジュールタイプ S:ショートカット B:お気に入り L:ライブリンクオン
issue_review_count	発行条件商品レビューの個数クーポンの発行に必要な商品レビューの個数
issue_review_has_image	発行条件商品レビューに画像が含まれるか否かの設定クーポンの発行に必要な商品レビューに画像が含まれるかどうかを設定 T:含む F:含まない DEFAULT F
issue_quantity_min	クーポン発行可能な最小購入数量クーポンの発行可能な最小購入数量
issue_quntity_type	クーポン発行可能数量の判断基準クーポンの発行可能な数量を判断する基準 P:商品数量基準 O:注文数量基準
issue_max_count	最大発行数クーポンの最大発行数量
issue_max_count_by_user	同一人物への再発行が可能かどうか一人の顧客(同一人物)に対して再発行できるクーポン数の上限
issue_count_per_once	クーポン発行数量(1回当たり発行数量) 1回発行時のクーポン発行数量
issued_count	発行された数量クーポンが発行された数量
issue_member_group_no	発行会員ランク番号クーポンの発行対象になる会員ランクの番号
issue_member_group_name	発行会員ランク名クーポンの発行対象になる会員ランクの名前
issue_no_purchase_period	一定期間購入していない対象会員の未購入期間一定期間未購入会員を対象に発行する時、発行条件として設定した購入履歴がない期間
issue_reserved	自動発行予約使用の設定クーポンの発行日を予約する機能を使うかどうかの有無。予約した日時にクーポンが自動発行される。 T:自動発行予約を使用する F:自動発行予約を使用しない DEFAULT F
issue_reserved_date	自動発行予約の発行日時設定されたクーポン自動発行予約日時
available_date	クーポンの使用期間クーポンの使用可能な期間
available_period_type	使用期間のタイプクーポンの使用可能な期間のタイプ
available_begin_datetime	使用期間の開始日時クーポンの使用可能な期間の開始日時
available_end_datetime	使用期間の終了日時クーポンの使用可能な期間の終了日時
available_site Required	使用対象のタイプクーポンの使用可能なアクセス経路のタイプ
available_scope	適用範囲クーポンの適用可能な範囲。商品クーポンとして適用する場合は商品一つに対してクーポンが適用され、注文書クーポンとして適用する場合は注文書全体に適用される。
available_day_from_issued	使用可能日数クーポンの使用可能な日数
available_price_type	使用可能な購入金額のタイプクーポンの使用可能な金額の基準。商品の金額が基準である場合は価格に数量を掛けた金額を基準とし、注文金額が基準である場合はその金額にその他の割引、送料が適用された金額を基準に計算する。 U:制限なし O:注文金額基準 P:商品金額基準
available_order_price_type	使用できる購入金額タイプの詳細 U : 全商品の注文金額 I : クーポン適用商品の注文金額
available_min_price	使用可能な購入金額クーポンの使用可能な購入金額
available_amount_type	適用計算の基準クーポンを適用する基準になる決済金額。クーポン割引を各種割引(会員ランク割引、商品割引など)前の注文金額に適用するか各種割引後の金額に適用するかを設定
available_payment_method	使用可能な決済方法クーポンの使用可能な決済方法 all：制限なし R：銀行振込 E：バーチャル口座 C：クレジットカード A：口座振込 H：キャリア決済 M：ポイント K：KPAY P：Paynow N：PAYCO O：Kakaopay S：SmilePay V：Naver Pay B：コンビニ D：Toss
available_product	クーポン適用商品の選択クーポンの適用可能な商品の選択。特定の商品を除いたり適用したり、またはすべての商品に対してクーポンを適用するかどうか選択できる。
available_product_list	クーポン適用商品リスト
available_category	クーポン適用カテゴリの選択クーポンの適用可能なカテゴリの選択。特定のカテゴリを除いたり適用したり、またはすべてのカテゴリに対してクーポンを適用するかどうか選択できる。
available_category_list	クーポン適用カテゴリリスト
available_coupon_count_by_order	注文書当たり同一クーポンの最大使用数注文書当たり同じクーポンの最大使用可能数
serial_generate_method	クローズドクーポンの作成方法クローズドクーポンを生成する方法 A:自動生成 M:直接登録 E:Excelアップロード
coupon_image_type	クーポン画像タイプクーポン画像のタイプ B:基本画像の使用 C:直接アップロード
coupon_image_path	クーポン画像経路クーポン画像のURL経路
show_product_detail	商品詳細ページの表示設定商品詳細ページに表示するかどうかを設定 T:商品詳細ページを表示 F:商品詳細ページを表示しない DEFAULT F
use_notification_when_login	ログイン時クーポン発行通知の使用設定会員ログイン時にクーポン発行通知を使うかどうかを設定 T:通知を使用する F:通知を使用しない DEFAULT F
send_sms_for_issue	クーポン発行SMSの送信設定クーポンの発行情報をSMSで送信するかどうかを設定 T:SMS送信 F:SMS未送信 DEFAULT F
send_email_for_issue	クーポン発行情報メールの送信設定クーポンの発行情報をＥメールで送信するかどうかを設定 T:メールを送信する F:メールを送信しない DEFAULT F
discount_amount	割引金額
discount_rate	割引率

Retrieve a count of coupons cafe24

GET /api/v2/admin/coupons/count

GET

ショッピングモールに作成されたクーポンの数を照会します。

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
coupon_no	クーポンID
coupon_type	クーポンタイプ検索したいクーポンのタイプ O:オンラインクーポン S:オフラインクローズドクーポン
coupon_name	クーポン名
benefit_type	特典区分クーポンによる特典の種類の区分 ,(コンマ)で複数の件を検索することができる。 A：割引金額 B：割引率 C：ポイント金額 D：付与率 E：基本送料割引(全額割引) I：基本送料割引(割引率) H：基本送料割引(割引金額) J：全送料タイプの割引(全額割引) F：即時付与 G：預り金
issue_type	発行方式クーポンの発行形態のタイプ ,(コンマ)で複数の件を検索することができる。 M：対象者指定発行 A：条件付き自動発行 D：顧客のダウンロードで発行 R：定期自動発行
issue_sub_type	発行下位タイプクーポン発行の詳細下位タイプ M：会員対象 C：リアルタイムアクセス者対象 J：会員登録 D：配送完了時 A：記念日(誕生日) I：モジュール(プログラム)設置 P：商品レビュー投稿 O：注文完了時 Q：購入数量充足時 F：初注文の顧客 N：一定期間購入していない会員対象 U：会員ランクのランクアップ時
issued_flag	発行されたクーポンの有無クーポンの発行履歴の有無 T:発行履歴のあるクーポン F:発行履歴のないクーポン
created_start_date Date	検索開始日クーポン生成日基準検索の検索開始日検索終了日と必ずペアで使用すること。
created_end_date Date	検索終了日クーポン生成日基準検索の検索終了日検索開始日と必ずペアで使用すること。
deleted	クーポンの削除有無クーポンが削除されたかどうかの区分 ,(コンマ)で複数の件を検索することができる。 T:削除されたクーポン F:削除されていないクーポン DEFAULT F
pause_begin_date Date	クーポン発行一時停止の開始時間クーポンの発行が一時停止され始めた時間
pause_end_date Date	クーポン発行一時停止の終了時間クーポン発行の一時停止が終了した時間
issue_order_path	注文ルート発行したクーポンの使用可能な注文経路 W:PC M:モバイル P:プラスアプリ
issue_order_type	発行単位 P:商品クーポン O:注文書クーポン
issue_reserved	自動発行予約使用の設定 T:使用する F:使用しない
available_period_type	使用期間のタイプクーポンの使用期間のタイプ ,(コンマ)で複数の件を検索することができる。 F:一般期間 R:クーポン発行日基準 M:当月末まで使用
available_datetime Date	該当する日付に発行できるクーポン検索該当日に発行可能なクーポン検索 available_period_typeがFの場合のみ有効
available_site	使用対象のタイプ発行したクーポンの使用可能な注文経路 W:PCショップ専用 M:モバイルショップ専用 P:プラスアプリ専用
available_scope	適用範囲クーポンの適用可能な範囲が商品か注文書単位クーポンかを設定 P:商品クーポン O:注文書クーポン
available_price_type	使用可能な購入金額のタイプクーポンの使用可能な金額の基準が注文金額か商品金額か制限がないかを設定 U:制限なし O:注文金額基準 P:商品金額基準
available_order_price_type	使用できる購入金額タイプの詳細 U : 全商品の注文金額 I : クーポン適用商品の注文金額

Request Copy

Response Copy

Retrieve a list of coupons cafe24

GET /api/v2/admin/coupons

GET

ショッピングモールに作成されたクーポンをリストで照会します。
クーポン番号、特典区分、適用範囲などを確認できます。

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
coupon_no	クーポンID
coupon_type	クーポンタイプ O:オンラインクーポン S:オフラインクローズドクーポン
coupon_name	クーポン名
benefit_type	特典区分クーポンによる特典の種類の区分 ,(コンマ)で複数の件を検索することができる。 A：割引金額 B：割引率 C：ポイント金額 D：付与率 E：基本送料割引(全額割引) I：基本送料割引(割引率) H：基本送料割引(割引金額) J：全送料タイプの割引(全額割引) F：即時付与 G：預り金
issue_type	発行方式クーポンの発行形態のタイプ ,(コンマ)で複数の件を検索することができる。 M：対象者指定発行 A：条件付き自動発行 D：顧客のダウンロードで発行 R：定期自動発行
issue_sub_type	発行下位タイプクーポン発行の詳細下位タイプ M：会員対象 C：リアルタイムアクセス者対象 J：会員登録 D：配送完了時 A：記念日(誕生日) I：モジュール(プログラム)設置 P：商品レビュー投稿 O：注文完了時 Q：購入数量充足時 F：初注文の顧客 N：一定期間購入していない会員対象 U：会員ランクのランクアップ時
issued_flag	発行されたクーポンの有無クーポンの発行履歴の有無 T:発行履歴のあるクーポン F:発行履歴のないクーポン
created_start_date Date	検索開始日クーポン生成日基準検索の検索開始日検索終了日と必ずペアで使用すること。
created_end_date Date	検索終了日クーポン生成日基準検索の検索終了日検索開始日と必ずペアで使用すること。
deleted	クーポンの削除有無クーポンが削除されたかどうかの区分 ,(コンマ)で複数の件を検索することができる。 T:削除されたクーポン F:削除されていないクーポン DEFAULT F
pause_begin_date Date	クーポン発行一時停止の開始時間クーポン一時停止日基準検索の検索開始日
pause_end_date Date	クーポン発行一時停止の終了時間クーポン一時停止日基準検索の検索終了日
issue_order_path	注文ルート発行したクーポンの使用可能な注文経路 W:PC M:モバイル P:プラスアプリ
issue_order_type	発行単位クーポンの発行単位が商品か注文書単位クーポンかを設定 P:商品クーポン O:注文書クーポン
issue_reserved	自動発行予約使用の設定クーポンの自動発行予約使用の設定 T:使用する F:使用しない
available_period_type	使用期間のタイプクーポンの使用期間のタイプ ,(コンマ)で複数の件を検索することができる。 F:一般期間 R:クーポン発行日基準 M:当月末まで使用
available_datetime Date	該当する日付に発行できるクーポン検索該当日に発行可能なクーポン検索 available_period_typeがFの場合のみ有効
available_site	使用対象のタイプ発行したクーポンの使用可能な注文経路 W:PCショップ専用 M:モバイルショップ専用 P:プラスアプリ専用
available_scope	適用範囲クーポンの適用可能な範囲が商品か注文書単位クーポンかを設定 P:商品クーポン O:注文書クーポン
available_price_type	使用可能な購入金額のタイプクーポンの使用可能な金額の基準が注文金額か商品金額か制限がないかを設定 U:制限なし O:注文金額基準 P:商品金額基準
available_order_price_type	使用できる購入金額タイプの詳細 U : 全商品の注文金額 I : クーポン適用商品の注文金額
limit Min : [1]~Max : [500]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 100
offset Max : [8000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Create a coupon cafe24

POST /api/v2/admin/coupons

POST

ショッピングモールで使用するクーポンを発行できます。
クーポン名、特典区分、適用範囲などを指定して発行できます。

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
coupon_name Required Length Min : [1]~Max : [50]	クーポン名
benefit_type Required	特典区分 A：割引金額 B：割引率
issue_type Required	発行方式 M：対象者指定発行
available_period_type Required	使用期間のタイプ F:一般期間 R:クーポン発行日基準 M:当月末まで使用
available_begin_datetime Date	使用期間の開始日時
available_end_datetime Date	使用期間の終了日時
available_day_from_issued Min : [1] Max : [999]	使用可能日数
available_site Required	使用対象のタイプ W：PCショップ専用 M：モバイルショップ専用
available_scope Required	適用範囲 P:商品クーポン O:注文書クーポン
available_product Required	クーポン適用商品の選択 U:制限なし I:選択商品適用 E:選択商品を除く
available_product_list	クーポン適用商品リスト
available_category Required	クーポン適用カテゴリの選択 U:制限なし I:選択カテゴリ適用 E:選択カテゴリを除く
available_category_list	クーポン適用カテゴリリスト
available_amount_type Required	適用計算の基準 E:割引(クーポンを除く)適用前の決済金額 I:割引(クーポンを除く)適用後の決済金額
available_coupon_count_by_order Required Min : [1] Max : [999]	注文書当たり同一クーポンの最大使用数
available_price_type	使用可能な購入金額のタイプ U:制限なし O:注文金額基準 P:商品金額基準 DEFAULT U
available_order_price_type	使用できる購入金額タイプの詳細 U : 全商品の注文金額 I : クーポン適用商品の注文金額
available_min_price Min : [0.01]~Max : [999999999]	使用可能な購入金額
discount_amount	割引金額
benefit_price Required 特典金額
discount_rate	割引率
benefit_percentage Required 特典割合 benefit_percentage_round_unit Required 特典割合の切り捨ての位 benefit_percentage_max_price Required 特典割合の最大金額

Request Copy

Response Copy

Coupons issues

Endpoints

GET /api/v2/admin/coupons/{coupon_no}/issues
POST /api/v2/admin/coupons/{coupon_no}/issues

Coupons issues properties

Attribute	Description
shop_no	ショップ番号
coupon_no	クーポンID
issue_no	クーポン発行番号
member_id	会員ID
group_no	発行会員ランク番号
issued_date	クーポン発行日
expiration_date	満了日
used_coupon	クーポン使用可否
used_date	クーポン使用日
related_order_id	関連注文
count	カウント

Retrieve a list of issued coupons cafe24

GET /api/v2/admin/coupons/{coupon_no}/issues

GET

生成されたクーポンに対する発行内訳の照会が可能です。
会員ID、会員等級番号、クーポン使用有無などを確認できます。
offsetの最大値である8000個以上が発行されたクーポンの内訳を照会するには、since_issue_noパラメータをご利用ください。

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
coupon_no Required	クーポンID
member_id Max Length : [20]	会員ID
group_no	会員ランク番号
issued_date Date	クーポン発行日
issued_start_date Date	検索開始日
issued_end_date Date	検索終了日
used_coupon	クーポン使用可否 T:使用する F:使用しない
since_issue_no	該当のクーポンID以降の発行履歴を検索
limit Min : [1]~Max : [500]	検索結果の最大件数 DEFAULT 10
offset Max : [8000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Create coupon issuance history cafe24

POST /api/v2/admin/coupons/{coupon_no}/issues

POST

生成されたクーポンの発行が可能です。
クーポンを発行するには、まずクーポンを作成する必要があります。

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
coupon_no Required	クーポンID
issued_member_scope Required	会員/条件選択クーポン発行対象会員の範囲を特定してクーポンを発行することができる。特定会員グループ(G)を入力する場合、group_noを必ず入力しなければならない。特定会員(M)を入力する場合、member_idを必ず入力しなければならない。 A:全会員 G:特定会員グループ M:特定会員
group_no	会員ランク番号
member_id	会員ID
send_sms_for_issue	クーポン発行SMSの送信設定クーポンの発行情報をSMSで送信するかどうかを設定 Cafe24管理画面(日本, ベトナム, フィリピン) では使用できません。 T:発送する F:発送しない DEFAULT F
allow_duplication	重複発行設定クーポンの重複発行設定 T:発行する F:発行しない S:発行しない(使用の有無使用期間に対する追加検証をしない) DEFAULT F
single_issue_per_once	1回発行時に1枚のみ発行するか否かの設定クーポンを1回に1枚のみ発行するかどうかを設定 T:1枚ずつ発行 F:同時発行設定数量だけ発行 DEFAULT T
issue_count_per_once Min : [2] Max : [10]	多数発行時の発行数量クーポンを1回に複数を発行する場合、その数量 DEFAULT 2
issued_place_type	発行先区分クーポンが発行された発行先の区分 W:PC M:モバイル P:プラスアプリ
issued_by_action_type	アプリのインストール時にクーポン発行アプリをインストールする場合、クーポンが発行される時点 INSTALLATION:アプリをインストールするとクーポン発行 ACCEPTING_PUSH:アプリのプッシュ通知をOnにするとクーポン発行
issued_by_event_type	発行理由のタイプ特典によるクーポンの発行時に該当する特典 C:出席チェックイベント U:会員情報修正イベント B:バナー収益シェアプログラム R:ルーレットゲーム(CMC)チーム Z:プラスアプリのインストール(プラスアプリ) Y:プッシュ通知ON(プラスアプリ) X:プラスアプリ注文(プラスアプリ) M:リマインドMe注文 W:リマインドMeリワード V:統合メンバーシップ L:永久会員切替イベント
request_admin_id	発行者ID

Request Copy

Response Copy

Customers coupons

Endpoints

GET /api/v2/admin/customers/{member_id}/coupons
GET /api/v2/admin/customers/{member_id}/coupons/count
DELETE /api/v2/admin/customers/{member_id}/coupons/{coupon_no}

Customers coupons properties

Attribute	Description
shop_no	ショップ番号
coupon_no	クーポンID
issue_no	クーポン発行番号
coupon_name	クーポン名
available_price_type	使用可能な購入金額のタイプ U:制限なし O:注文金額基準 P:商品金額基準
available_price_type_detail	使用できる購入金額タイプの詳細 U : 全商品の注文金額 I : クーポン適用商品の注文金額
available_min_price	使用可能な購入金額
available_payment_methods	使用可能な決済方法 all：制限なし R：銀行振込 E：バーチャル口座 C：クレジットカード A：口座振込 H：キャリア決済 M：ポイント K：KPAY P：Paynow N：PAYCO O：Kakaopay S：SmilePay V：Naver Pay B：コンビニ D：Toss
benefit_type	特典区分 G : 預り金(既存のexample項目に「G : 預り金」を追加)
benefit_price	特典金額
benefit_percentage	特典割合
benefit_percentage_round_unit	特典割合の切り捨ての位
benefit_percentage_max_price	特典割合の最大金額
credit_amount	預り金の付与金額
issued_date	発行日
available_begin_datetime	使用期間の開始日時
available_end_datetime	使用期間の終了日時

Retrieve a list of customer coupons cafe24

GET /api/v2/admin/customers/{member_id}/coupons

GET

会員に発行されたクーポンをリストで照会します。
クーポン番号、特典区分、適用範囲などを確認できます。

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
member_id Required	会員ID
offset Max : [10000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of customer coupons cafe24

GET /api/v2/admin/customers/{member_id}/coupons/count

GET

会員に発行されたクーポンの数を照会します。

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

member_id
Required

会員ID

Request Copy

Response Copy

Delete a customer coupon cafe24

DELETE /api/v2/admin/customers/{member_id}/coupons/{coupon_no}

DELETE

会員に発行されたクーポンを削除します。

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
member_id Required	会員ID
coupon_no Required	クーポンID
issue_no	クーポン発行番号

Request Copy

Response Copy

Discountcodes

Endpoints

GET /api/v2/admin/discountcodes
GET /api/v2/admin/discountcodes/{discount_code_no}
POST /api/v2/admin/discountcodes
PUT /api/v2/admin/discountcodes/{discount_code_no}
DELETE /api/v2/admin/discountcodes/{discount_code_no}

Discountcodes properties

Attribute	Description
shop_no	ショップ番号
discount_code_no	割引コード番号
discount_code_name	割引コード名
discount_code	割引コード
available_start_date	開始日
available_end_date	終了日
available_product_type	割引コードの適用範囲割引コードの適用範囲が「A(全商品)」の場合は「割引コードの適用商品(available_product)」および「割引コードの適用カテゴリ(available_category)」の入力不必要割引コードの適用範囲が「P(特定商品)」の場合は「割引コードの適用商品(available_product)」の入力必要割引コードの適用範囲が「C(特定カテゴリ)」の場合は「割引コードの適用カテゴリ(available_category)」の入力必要 A：全商品 P : 特定商品 C : 特定カテゴリ
created_date	特典登録日
available_issue_count	発行可能回数の上限
issued_count	発行された数量
discount_value	割引値
discount_truncation_unit	切り捨て単位 C：0.01の位 B：0.1の位 F：切り捨てしない O：1の位 T：10の位 M：100の位 H：1000の位
discount_max_price	使用可能な特典金額の上限
available_product	特定商品のリスト割引コードの適用範囲(available_product_type)が「P(特定商品)」の場合は商品番号を配列(array)で入力します。
available_category	特定カテゴリのリスト割引コードの適用範囲(available_product_type)が「C(特定カテゴリ)」の場合はカテゴリ番号を配列(array)で入力します。
available_min_price	割引コードの使用が可能な最小注文金額
available_user	使用可能な対象
max_usage_per_user	会員1名当たりの使用可能回数

Retrieve a list of discount codes cafe24

GET /api/v2/admin/discountcodes

GET

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
discount_code_name	割引コード名
discount_code	割引コード
search_date_type	available_start_date：開始日 available_end_date：終了日 created_date：登録日 available_start_date：開始日 available_end_date：終了日 created_date：登録日
start_date Date	検索開始日
end_date Date	検索終了日
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10
sort	並べ替え順序の値 discount_code_name：特典名 discount_code：割引コード created_date：登録日 available_start_date：開始日 available_end_date：終了日 DEFAULT created_date
order	並べ替え順序 asc:並べ替え(昇順) desc:並べ替え(降順) DEFAULT desc

Request Copy

Response Copy

Retrieve a discount code cafe24

GET /api/v2/admin/discountcodes/{discount_code_no}

GET

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

discount_code_no
Required

Min : [1]

割引コード番号

Request Copy

Response Copy

Create a discount code cafe24

POST /api/v2/admin/discountcodes

POST

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
discount_code Required Min Length : [1] Max Length : [35]	割引コード
discount_code_name Required Length Min : [1]~Max : [50]	割引コード名
discount_value Required Min : [1] Max : [99]	割引値
discount_truncation_unit Required	切り捨て単位 C：0.01の位 B：0.1の位 F：切り捨てしない O：1の位 T：10の位 M：100の位 H：1000の位
discount_max_price Required Min : [1] Max : [999999999]	使用可能な特典金額の上限
available_start_date Required Date	開始日
available_end_date Required Date	終了日
available_product_type	割引コードの適用範囲割引コードの適用範囲が「A(全商品)」の場合は「割引コードの適用商品(available_product)」および「割引コードの適用カテゴリ(available_category)」の入力不必要割引コードの適用範囲が「P(特定商品)」の場合は「割引コードの適用商品(available_product)」の入力必要割引コードの適用範囲が「C(特定カテゴリ)」の場合は「割引コードの適用カテゴリ(available_category)」の入力必要 A：全商品 P : 特定商品 C : 特定カテゴリ DEFAULT A
available_product	特定商品のリスト割引コードの適用範囲(available_product_type)が「P(特定商品)」の場合は商品番号を配列(array)で入力します。
available_category	特定カテゴリのリスト割引コードの適用範囲(available_product_type)が「C(特定カテゴリ)」の場合はカテゴリ番号を配列(array)で入力します。
available_min_price Max : [999999999]	割引コードの使用が可能な最小注文金額 DEFAULT 0
available_issue_count Max : [10000]	発行可能回数の上限 DEFAULT 0
available_user	使用可能な対象 M：会員 A：すべて DEFAULT A
max_usage_per_user Max : [999]	会員1名当たりの使用可能回数 DEFAULT 0

Request Copy

Response Copy

Update a discount code cafe24

PUT /api/v2/admin/discountcodes/{discount_code_no}

PUT

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
discount_code_no Required Min : [1]	割引コード番号
discount_code Min Length : [1] Max Length : [35]	割引コード
discount_code_name Required Length Min : [1]~Max : [50]	割引コード名
discount_value Min : [1] Max : [99]	割引値
discount_truncation_unit	切り捨て単位 C：0.01の位 B：0.1の位 F：切り捨てしない O：1の位 T：10の位 M：100の位 H：1000の位
discount_max_price Min : [1] Max : [999999999]	使用可能な特典金額の上限
available_start_date Date	開始日
available_end_date Date	終了日
available_product_type	割引コードの適用範囲割引コードの適用範囲が「A(全商品)」の場合は「割引コードの適用商品(available_product)」および「割引コードの適用カテゴリ(available_category)」の入力不必要割引コードの適用範囲が「P(特定商品)」の場合は「割引コードの適用商品(available_product)」の入力必要割引コードの適用範囲が「C(特定カテゴリ)」の場合は「割引コードの適用カテゴリ(available_category)」の入力必要 A：全商品 P : 特定商品 C : 特定カテゴリ
available_product	特定商品のリスト割引コードの適用範囲(available_product_type)が「P(特定商品)」の場合は商品番号を配列(array)で入力します。
available_category	特定カテゴリのリスト割引コードの適用範囲(available_product_type)が「C(特定カテゴリ)」の場合はカテゴリ番号を配列(array)で入力します。
available_min_price Max : [999999999]	割引コードの使用が可能な最小注文金額
available_issue_count Max : [10000]	発行可能回数の上限
available_user	使用可能な対象 M：会員 A：すべて
max_usage_per_user Max : [999]	会員1名当たりの使用可能回数

Request Copy

Response Copy

Delete a discount code cafe24

DELETE /api/v2/admin/discountcodes/{discount_code_no}

DELETE

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
discount_code_no Required Min : [1]	割引コード番号

Request Copy

Response Copy

Serialcoupons

Endpoints

GET /api/v2/admin/serialcoupons
POST /api/v2/admin/serialcoupons
DELETE /api/v2/admin/serialcoupons/{coupon_no}

Serialcoupons properties

Attribute	Description
shop_no	ショップ番号
coupon_no	クーポンID
coupon_name	クーポン名
coupon_description	クーポン内容
created_date	作成日
deleted	クーポンの削除有無 T:削除 F:削除されていない
benefit_text	クーポン特典詳細の出力
benefit_type	特典区分 A：割引金額 B：割引率
benefit_price	特典金額
benefit_percentage	特典割合
benefit_percentage_round_unit	特典割合の切り捨ての位
benefit_percentage_max_price	特典割合の最大金額
include_regional_shipping_rate	送料割引時に地域別区分を含むか否かの設定 T:地域別区分を含む F:地域別区分を含まない
include_foreign_delivery	海外配送を含むかの有無 T:海外配送を含む F:海外配送を含まない
issue_order_amount_type	発行可能な購入金額のタイプ O:購入金額基準 S:実際の決済金額基準
issue_order_start_date	クーポン発行可能な注文開始日時
issue_order_end_date	クーポン発行可能な注文終了日時
issue_order_amount_limit	発行可能購入金額の制限タイプ U:制限なし L:最小金額 S:金額範囲
issue_order_amount_min	発行可能な最小購入金額
issue_order_amount_max	発行可能な最大購入金額
issue_order_path	注文ルート W:PCショップ専用 M:モバイルショップ専用 P:プラスアプリ専用
issue_order_type	発行単位 O:注文書単位発行クーポン P:商品単位発行クーポン
issue_order_available_product	発行対象商品 U:制限なし I:選択商品適用 E:選択商品を除く
issue_order_available_category	発行対象カテゴリ U:制限なし I:選択商品適用 E:選択商品を除く
issue_max_count	最大発行数
issue_max_count_by_user	同一人物への再発行が可能かどうか
issue_count_per_once	クーポン発行数量(1回当たり発行数量)
issued_count	発行された数量
available_date	クーポンの使用期間
available_period_type	使用期間のタイプ F:一般期間 R:クーポン発行日基準 M:当月末まで使用
available_begin_datetime	使用期間の開始日時
available_end_datetime	使用期間の終了日時
available_site	使用対象のタイプ W：PCショップ専用 M：モバイルショップ専用
available_scope	適用範囲 P:商品クーポン O:注文書クーポン
available_day_from_issued	使用可能日数
available_price_type	使用可能な購入金額のタイプ U:制限なし O:注文金額基準 P:商品金額基準
available_order_price_type	使用できる購入金額タイプの詳細 U : 全商品の注文金額 I : クーポン適用商品の注文金額
available_min_price Min : [0.01]~Max : [999999999]	使用可能な購入金額
available_amount_type	適用計算の基準 E:割引(クーポンを除く)適用前の決済金額 I:割引(クーポンを除く)適用後の決済金額
available_payment_method	使用可能な決済方法 all：制限なし R：銀行振込 E：バーチャル口座 C：クレジットカード A：口座振込 H：キャリア決済 M：ポイント K：KPAY P：Paynow N：PAYCO O：Kakaopay S：SmilePay V：Naver Pay B：コンビニ D：Toss
available_product	クーポン適用商品の選択 U:制限なし I:選択商品適用 E:選択商品を除く
available_product_list	クーポン適用商品リスト
available_category	クーポン適用カテゴリの選択 U:制限なし I:選択カテゴリ適用 E:選択カテゴリを除く
available_category_list	クーポン適用カテゴリリスト
available_coupon_count_by_order	注文書当たり同一クーポンの最大使用数
serial_generate_method	クローズドクーポンの作成方法 A: 自動作成 M: 手動作成
show_product_detail	商品詳細ページの表示設定 T:商品詳細ページを表示 F:商品詳細ページを表示しない
discount_amount	割引金額
discount_rate	割引率
serial_code_type	クーポンコードの生成方法 R: 異なるクーポンコードで発行 S: 同じクーポンコードで発行
serial_generate_auto	クローズドクーポンの自動作成における追加情報

Retrieve coupon codes cafe24

GET /api/v2/admin/serialcoupons

GET

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
coupon_no	クーポンID
coupon_name	クーポン名
benefit_type	特典区分 ,(コンマ)で複数の件を検索することができる。 A：割引金額 B：割引率 C：ポイント金額 D：付与率 E：基本送料割引(全額割引) I：基本送料割引(割引率) H：基本送料割引(割引金額) J：全送料タイプの割引(全額割引) F：即時付与 G：預り金
issued_flag	発行されたクーポンの有無 T:発行履歴のあるクーポン F:発行履歴のないクーポン
created_start_date Date	検索開始日
created_end_date Date	検索終了日
deleted	クーポンの削除有無 ,(コンマ)で複数の件を検索することができる。 T:削除されたクーポン F:削除されていないクーポン DEFAULT F
issue_order_path	注文ルート W:PC M:モバイル P:プラスアプリ
issue_order_type	発行単位 P:商品クーポン O:注文書クーポン
issue_reserved	自動発行予約使用の設定 T:使用する F:使用しない
available_period_type	使用期間のタイプ ,(コンマ)で複数の件を検索することができる。 F:一般期間 R:クーポン発行日基準 M:当月末まで使用
available_datetime Date	該当する日付に発行できるクーポン検索 available_period_typeがFの場合のみ有効
available_site	使用対象のタイプ W:PCショップ専用 M:モバイルショップ専用 P:プラスアプリ専用
available_scope	適用範囲 P:商品クーポン O:注文書クーポン
available_price_type	使用可能な購入金額のタイプ U:制限なし O:注文金額基準 P:商品金額基準
available_order_price_type	使用できる購入金額タイプの詳細 U : 全商品の注文金額 I : クーポン適用商品の注文金額
limit Min : [1]~Max : [500]	検索結果の最大件数 DEFAULT 100
offset Max : [8000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Generate coupon code cafe24

POST /api/v2/admin/serialcoupons

POST

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
coupon_name Required Length Min : [1]~Max : [50]	クーポン名
benefit_type Required	特典区分 A：割引金額 B：割引率
available_period_type Required	使用期間のタイプ F:一般期間 R:クーポン発行日基準 M:当月末まで使用
available_begin_datetime Date	使用期間の開始日時
available_end_datetime Date	使用期間の終了日時
available_day_from_issued Min : [1] Max : [999]	使用可能日数
available_site Required	使用対象のタイプ W：PCショップ専用 M：モバイルショップ専用
available_scope Required	適用範囲 P:商品クーポン O:注文書クーポン
available_product Required	クーポン適用商品の選択 U:制限なし I:選択商品適用 E:選択商品を除く
available_product_list	クーポン適用商品リスト
available_category Required	クーポン適用カテゴリの選択 U:制限なし I:選択カテゴリ適用 E:選択カテゴリを除く
available_category_list	クーポン適用カテゴリリスト
available_amount_type Required	適用計算の基準 E:割引(クーポンを除く)適用前の決済金額 I:割引(クーポンを除く)適用後の決済金額
available_coupon_count_by_order Required Min : [1] Max : [999]	注文書当たり同一クーポンの最大使用数
available_price_type	使用可能な購入金額のタイプ U:制限なし O:注文金額基準 P:商品金額基準 DEFAULT U
available_order_price_type	使用できる購入金額タイプの詳細 U : 全商品の注文金額 I : クーポン適用商品の注文金額
available_min_price Min : [0.01]~Max : [999999999]	使用可能な購入金額
discount_amount	割引金額
benefit_price Required 特典金額
discount_rate	割引率
benefit_percentage Required 特典割合 benefit_percentage_round_unit Required 特典割合の切り捨ての位 benefit_percentage_max_price Required 特典割合の最大金額
serial_generate_method Required	クローズドクーポンの作成方法 A: 自動作成 M: 手動作成
serial_code_type Required	クーポンコードの生成方法 R: 異なるクーポンコードで発行 S: 同じクーポンコードで発行
serial_generate_auto	クローズドクーポンの自動作成における追加情報
issue_max_count Required 自動作成数 serial_code_length Required 自動生成されるクーポンコードの文字数

Request Copy

Response Copy

Delete coupon code cafe24

DELETE /api/v2/admin/serialcoupons/{coupon_no}

DELETE

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
coupon_no	クーポンID

Request Copy

Response Copy

Serialcoupons issues

Endpoints

GET /api/v2/admin/serialcoupons/{coupon_no}/issues
POST /api/v2/admin/serialcoupons/{coupon_no}/issues

Serialcoupons issues properties

Attribute	Description
shop_no	ショップ番号 DEFAULT 1
coupon_no	クーポンID
serial_code	クーポンコード
member_id	会員ID
verify	認証状況 Y: 認証済み N: 未認証
verify_datetime	認証日時
used_datetime	使用日時
deleted	クーポンの削除有無 T:削除 F:削除されていない

Retrieve a code of coupon codes cafe24

GET /api/v2/admin/serialcoupons/{coupon_no}/issues

GET

基本スペック

Property	Description
SCOPE	プロモーションの閲覧権限 (mall.read_promotion)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
coupon_no	クーポンID
offset Max : [10000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [500]	検索結果の最大件数 DEFAULT 100

Request Copy

Response Copy

Register a code of coupon codes cafe24

POST /api/v2/admin/serialcoupons/{coupon_no}/issues

POST

基本スペック

Property	Description
SCOPE	プロモーションの投稿権限 (mall.write_promotion)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

coupon_no

クーポンID

serial_code_list
Required

Array Max : [10000]

クーポンコードのリスト

Request Copy

Response Copy

Apps

アプリ(Apps)はアプリの情報を照会して修正できるリソースです。
その情報はアプリの情報なので、異なるショッピングモールで呼び出しても同じ情報が照会されるのが特徴です。
アプリのバージョン情報を照会したり、アプリのバージョンをAPIを通じて修正することができます。

Endpoints

GET /api/v2/admin/apps
PUT /api/v2/admin/apps

Apps properties

Attribute	Description
version	バージョン
version_expiration_date	バージョンの満了日
initial_version	初回バージョン
previous_version	以前のバージョン
extension_type	拡張タイプ section：section(ショップのフロントにhtmlを埋め込む必要があるアプリタイプ) embedded：embedded(ショップのフロントに組み込まれ自動的に駆動されるアプリタイプ)

Retrieve an app information cafe24

GET /api/v2/admin/apps

GET

そのアプリのバージョンを照会することができます。
現在使用中のバージョン情報とバージョン満了日、以前使用していたバージョン情報を確認できます。
その情報はアプリの情報なので、どのショッピングモールで照会しても同じ結果が出ます。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	40

Request Copy

Response Copy

Update an app information cafe24

PUT /api/v2/admin/apps

PUT

そのアプリのバージョンを変更できます。
アプリのバージョン変更時、最初のバージョン(initial_version)より前のバージョンへの変更はできません。
その情報はアプリの情報なので、どのショッピングモールで呼び出してもすべてのショッピングモールのAPIバージョン情報が変更されます。

基本スペック

Property	Description
SCOPE	アプリの投稿権限 (mall.write_application)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

version

バージョン

extension_type

拡張タイプ

section：section(ショップのフロントにhtmlを埋め込む必要があるアプリタイプ)
embedded：embedded(ショップのフロントに組み込まれ
自動的に駆動されるアプリタイプ)

Request Copy

Response Copy

Appstore orders

cafe24 App Storeの注文生成APIでショップの運営者に決済時必要な金額を払わせるためにcafe24 App Storeの注文を生成することができます。

Endpoints

GET /api/v2/admin/appstore/orders/{order_id}
POST /api/v2/admin/appstore/orders

Appstore orders properties

Attribute	Description
order_id	注文ID cafe24 App Store注文の注文ID
order_name	注文名 cafe24 App Store注文の注文名。注文生成時に指定可能で、ユーザーが決済時にその決済の内容が分かるようなものでなければならない。
order_amount	注文金額 cafe24 App Store注文生成時に決済を要求した注文金額
currency	通貨単位 KRW：￦ (韓国ウォン) USD：$ (米ドル) JPY：¥ (日本円) PHP：₱ (フィリピンペソ)
return_url	Return Url ユーザーが決済後に移動するページ
automatic_payment Max Length : [1]	定期課金の有無 T:使用する F:使用しない
created_date	注文生成日
confirmation_url	決済URL ユーザーが決済するために自動的に移動するページのアドレス

Retreive a Cafe24 Store order cafe24

GET /api/v2/admin/appstore/orders/{order_id}

GET

作成されたApp Storeの注文を照会することができます。
注文名、注文金額、定期課金可否などを照会することができます。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	10

要求スペック

Parameter

Description

order_id

注文番号

検索したいcafe24 App Store注文番号

Request Copy

Response Copy

Create a Cafe24 Store order cafe24

POST /api/v2/admin/appstore/orders

POST

App Storeの注文を作成できます。
App Store注文を作成すると、Appユーザー(ショッピングモール運営者)に使用料金を請求することができます。
また、定期課金で請求するかどうかを選択することも可能です。

基本スペック

Property	Description
SCOPE	アプリの投稿権限 (mall.write_application)
呼び出し件数制限	10
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
order_name Required Max Length : [100]	注文名 cafe24 App Store注文の注文名。注文生成時に指定可能で、ユーザーが決済時にその決済の内容が分かるようなものでなければならない。
order_amount Required	注文金額ユーザーに決済してもらう注文金額を入力
return_url Required Max Length : [250]	Return URL ユーザーが決済後に移動するページ。決済完了ページのアドレスを入力する。
automatic_payment Max Length : [1]	定期課金の有無 T:使用する F:使用しない DEFAULT F

Request Copy

Response Copy

Appstore payments

cafe24 App Storeでの注文の決済を完了した場合、cafe24 App Storeの決済検索機能を使って決済の内訳を確認することができます。

Endpoints

GET /api/v2/admin/appstore/payments
GET /api/v2/admin/appstore/payments/count

Appstore payments properties

Attribute	Description
order_id	決済番号 cafe24 App Store注文の注文ID
payment_status	決済ステータス paid : 決済完了 refund : 返金
title	注文名 cafe24 App Store注文の注文名。注文生成時に指定可能で、ユーザーが決済時にその決済の内容が分かるようなものでなければならない。
approval_no	承認番号決済承認番号
payment_gateway_name	決済代行会社名
payment_method	決済方法
payment_amount	決済金額
refund_amount	返金額
currency	通貨単位 KRW：￦ (韓国ウォン) USD：$ (米ドル) JPY：¥ (日本円) PHP：₱ (フィリピンペソ)
locale_code	決済先の国
automatic_payment	定期課金の有無 T:使用する F:使用しない
pay_date	決済承認日
refund_date	返金承認日
expiration_date	満了日

Retrieve a list of Cafe24 Store payments cafe24

GET /api/v2/admin/appstore/payments

GET

ショッピングモール運営者が決済したApp Store利用決済内訳のカウントを確認することができます。
決済状態、決済名、承認番号などを照会することができます。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	10

要求スペック

Parameter	Description
order_id	注文番号検索したいcafe24 App Store注文番号 ,(コンマ)で複数の件を検索することができる。
start_date Required Date	検索開始日該当日以後に決済完了した注文検索
end_date Required Date	検索終了日該当日以前に決済完了した注文検索
currency	通貨単位 KRW：￦ (韓国ウォン) USD：$ (米ドル) JPY：¥ (日本円) PHP：₱ (フィリピンペソ)
limit Min : [1]~Max : [50]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 20
offset Max : [10000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Retrieve a count of Cafe24 Store payments cafe24

GET /api/v2/admin/appstore/payments/count

GET

ショッピングモール運営者が決済したApp Store利用決済内訳を確認することができます。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	10

要求スペック

Parameter	Description
order_id	注文番号検索したいcafe24 App Store注文番号 ,(コンマ)で複数の件を検索することができる。
start_date Required Date	検索開始日該当日以後に決済完了した注文検索
end_date Required Date	検索終了日該当日以前に決済完了した注文検索
currency	通貨単位 KRW：￦ (韓国ウォン) USD：$ (米ドル) JPY：¥ (日本円) PHP：₱ (フィリピンペソ)

Request Copy

Response Copy

Databridge logs

Endpoints

GET /api/v2/admin/databridge/logs

Databridge logs properties

Attribute	Description
log_id	ログID
mall_id	ショップID
trace_id	Trace ID
requested_time	送信日時
request_endpoint	リクエストURL
request_body	リクエスト内容
success	Webhookの送信に成功したかどうか T：成功 F：失敗
response_http_code	レスポンス HTTP code
response_body	レスポンス内容

Retrieve a list of Databridge webhook logs cafe24

GET /api/v2/admin/databridge/logs

GET

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	40

要求スペック

Parameter	Description
requested_start_date Date	送信開始日時
requested_end_date Date	送信終了日時
success	Webhookの送信に成功したかどうか T：成功 F：失敗
since_log_id	このログID以降のログを検索
limit Min : [1]~Max : [10000]	照会結果の最大件数

Request Copy

Response Copy

Recipes

Recipes関連の機能です。
ショップにRecipeを登録したり、登録されたRecipeのリストを閲覧することができます。
また、登録されたRecipeを削除することもできます。

Endpoints

GET /api/v2/admin/recipes
POST /api/v2/admin/recipes
DELETE /api/v2/admin/recipes/{recipe_code}

Recipes properties

Attribute

Description

recipe_code

Recipeコード

recipe_name

Max Length : [200]

Recipeタイトル

active

有効化の有無

T:有効
F:無効

Retrieve a list of recipes cafe24

GET /api/v2/admin/recipes

GET

ショップに登録されたRecipeのリストが閲覧できます。
Recipeのコード、Recipeのタイトル、有効化の有無を照会することができます。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	40

Request Copy

Response Copy

Create a recipe cafe24

POST /api/v2/admin/recipes

POST

ショップにRecipeを登録することができます。
Recipeの登録のためにはRecipeのコードが必要となるため、Recipeをあらかじめ生成しておく必要があります。

基本スペック

Property	Description
SCOPE	アプリの投稿権限 (mall.write_application)
呼び出し件数制限	40
1回当たり申込件数の制限	100

要求スペック

Parameter	Description
recipe_code Required	Recipeコード
trigger_settings	トリガー設定
required_filters Array name 条件名 value 条件値 operator 条件演算子 optional_filters Array condition Array name 条件名 value 条件値 operator 条件演算子

Request Copy

Response Copy

Delete a recipe cafe24

DELETE /api/v2/admin/recipes/{recipe_code}

DELETE

ショップに登録されたRecipeを登録解除することができます。

基本スペック

Property	Description
SCOPE	アプリの投稿権限 (mall.write_application)
呼び出し件数制限	40

要求スペック

Parameter	Description
recipe_code Required	Recipeコード

Request Copy

Response Copy

Scripttags

スクリプト(Scripttags)はアプリでショップの特定画面(Page)に遠隔でスクリプトを設置するために使うAPIです。スクリプトAPIを使ってショップのデザインを変更せずにショップの画面に機能を簡単に追加することができます。

Endpoints

GET /api/v2/admin/scripttags
GET /api/v2/admin/scripttags/count
GET /api/v2/admin/scripttags/{script_no}
POST /api/v2/admin/scripttags
PUT /api/v2/admin/scripttags/{script_no}
DELETE /api/v2/admin/scripttags/{script_no}

Scripttags properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
script_no	scriptの固有番号スクリプトの固有番号
client_id	Client ID スクリプトを設置したClientのID
src URL	原本script経路設置するスクリプトの原本経路(絶対経路)
display_location	画面経路スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。 (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される) 画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「ショップ設定 > サイト設定 > '環境設定 > 環境設定 > (タブ)ページパス > ページパスの設定'」で各ページに付与された画面の役割を検索・設定することができる。「all」の場合、すべてのページにスクリプトが適用される。 display_location_code
exclude_path	除外経路
skin_no	スキン番号スクリプトを適用するデザイン番号
integrity	サブリソース完全性スクリプトの偽造·変造を防止するための完全性検証用ハッシュ。 (sha384、sha512ハッシュアルゴリズム対応) Integrity 해시 생성방법 참고
created_date	作成日スクリプトの設置日
updated_date	修正日スクリプトの修正日

Retrieve a list of script tags cafe24

GET /api/v2/admin/scripttags

GET

ショッピングモールにインストールされているスクリプトをリストで照会できます。
スクリプト固有番号、画面パス、作成日などを照会することができます。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	10

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
script_no	scriptの固有番号スクリプトの固有番号の検索
src URL	原本script経路原本スクリプトの経路検索
display_location	画面経路スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。 (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される) 画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「ショップ設定 > サイト設定 > '環境設定 > 環境設定 > (タブ)ページパス > ページパスの設定'」で各ページに付与された画面の役割を検索・設定することができる。「all」の場合、すべてのページにスクリプトが適用される。 display_location_code ,(コンマ)で複数の件を検索することができる。
exclude_path	除外経路 ,(コンマ)で複数の件を検索することができる。
skin_no	スキン番号スクリプトを適用するデザイン番号 ,(コンマ)で複数の件を検索することができる。
integrity	サブリソース完全性
created_start_date Date	スクリプト設置日の検索開始日スクリプトを設置した日が該当日以後であるスクリプト検索検索終了日と必ずペアで使用すること。
created_end_date Date	スクリプト設置日の検索終了日スクリプトを設置した日が該当日以後であるスクリプト検索検索終了日と必ずペアで使用すること。
updated_start_date Date	スクリプト修正日の検索開始日スクリプトの修正日が該当日以後であるスクリプト検索検索終了日と必ずペアで使用すること。
updated_end_date Date	スクリプト修正日の検索終了日スクリプトの修正日が該当日以前であるスクリプト検索検索開始日と必ずペアで使用すること。

Request Copy

Response Copy

Retrieve a count of script tags cafe24

GET /api/v2/admin/scripttags/count

GET

ショッピングモールにインストールされているスクリプトの数を照会できます。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	10

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
script_no	scriptの固有番号スクリプトの固有番号の検索
src URL	原本script経路原本スクリプトの経路検索
display_location	画面経路スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。 (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される) 画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「ショップ設定 > サイト設定 > '環境設定 > 環境設定 > (タブ)ページパス > ページパスの設定'」で各ページに付与された画面の役割を検索・設定することができる。「all」の場合、すべてのページにスクリプトが適用される。 display_location_code
skin_no	スキン番号スクリプトを適用するデザイン番号 ,(コンマ)で複数の件を検索することができる。
created_start_date Date	スクリプト設置日の検索開始日スクリプトを設置した日が該当日以後であるスクリプト検索検索終了日と必ずペアで使用すること。
created_end_date Date	スクリプト設置日の検索終了日スクリプトを設置した日が該当日以前であるスクリプト検索検索終了日と必ずペアで使用すること。
updated_start_date Date	スクリプト修正日の検索開始日スクリプトの修正日が該当日以後であるスクリプト検索検索終了日と必ずペアで使用すること。
updated_end_date Date	スクリプト修正日の検索終了日スクリプトの修正日が該当日以前であるスクリプト検索検索開始日と必ずペアで使用すること。

Request Copy

Response Copy

Retrieve a script tag cafe24

GET /api/v2/admin/scripttags/{script_no}

GET

ショッピングモールにインストールされている特定のスクリプトを照会できます。
画面経路、スキン番号、生成日、修正日などを照会することができます。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	10

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

script_no

scriptの固有番号

スクリプトの固有番号の検索

Request Copy

Response Copy

Create a script tag cafe24

POST /api/v2/admin/scripttags

POST

スクリプトタグをショッピングモールの特定の画面にインストールできます。

基本スペック

Property	Description
SCOPE	アプリの投稿権限 (mall.write_application)
呼び出し件数制限	10
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
src URL	原本script経路設置するスクリプトの原本経路(絶対経路)
display_location Required	画面経路スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。 (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される) 画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「ショップ設定 > サイト設定 > '環境設定 > 環境設定 > (タブ)ページパス > ページパスの設定'」で各ページに付与された画面の役割を検索・設定することができる。「all」の場合、すべてのページにスクリプトが適用される。 display_location_code
exclude_path	除外経路
skin_no	スキン番号スクリプトを適用するデザイン番号
integrity	サブリソース完全性スクリプトの偽造·変造を防止するための完全性検証用ハッシュ。 (sha384、sha512ハッシュアルゴリズム対応) Integrity ハッシュ生成方法を参考

Request Copy

Response Copy

Update a script tag cafe24

PUT /api/v2/admin/scripttags/{script_no}

PUT

ショッピングモールにインストールされているスクリプトを更新できます。
アプリを再インストールする必要はなく、スクリプトのみを更新できます。

基本スペック

Property	Description
SCOPE	アプリの投稿権限 (mall.write_application)
呼び出し件数制限	10
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
script_no Required	scriptの固有番号スクリプトの固有番号
src URL	原本script経路設置するスクリプトの原本経路(絶対経路)
display_location	画面経路スクリプトを表示する「画面経路」。画面経路は画面のページ経路ではなく、ショップの各ページに付与された特定の役割を意味する。 (例: 商品カテゴリ(product_list)にスクリプトを挿入する場合、ショップで商品カテゴリとして使われるすべてのページにスクリプトが表示される) 画面の役割はそのページに使われたモジュールによって自動付与される。任意のページに商品カテゴリモジュールを追加すると、そのページは「商品カテゴリ」の役割として認識される。ショップ管理者画面の「ショップ設定 > サイト設定 > '環境設定 > 環境設定 > (タブ)ページパス > ページパスの設定'」で各ページに付与された画面の役割を検索・設定することができる。 display_location_code
exclude_path	除外経路
skin_no	スキン番号スクリプトを適用するデザイン番号
integrity	サブリソース完全性スクリプトの偽造·変造を防止するための完全性検証用ハッシュ。 (sha384、sha512ハッシュアルゴリズム対応) Integrity 해시 생성방법 참고

Request Copy

Response Copy

Delete a script tag cafe24

DELETE /api/v2/admin/scripttags/{script_no}

DELETE

ショッピングモールにインストールされているスクリプトを削除できます。
マルチショッピングモール別に削除するにはエンドポイントの後に"？shop_no=N"を追加すればいいです。

基本スペック

Property	Description
SCOPE	アプリの投稿権限 (mall.write_application)
呼び出し件数制限	10

要求スペック

Parameter

Description

script_no
Required

scriptの固有番号

スクリプトの固有番号

Request Copy

Response Copy

Webhooks logs

ウェブフックログ(Webhooks logs)を通じてアプリで発生したウェブフックのログを照会することができます。

Endpoints

GET /api/v2/admin/webhooks/logs

Webhooks logs properties

Attribute	Description
log_id	ログID
log_type	ログタイプ G：一般送信 R：再送信 T：テスト送信
event_no	イベント番号
mall_id	ショップID
trace_id	Trace ID
requested_time	送信日時
request_endpoint	リクエストURL
request_body	リクエスト内容
success	Webhookの送信に成功したかどうか T：成功 F：失敗
response_http_code	レスポンス HTTP code
response_body	レスポンス内容

Retrieve a list of webhook logs cafe24

GET /api/v2/admin/webhooks/logs

GET

アプリで発生したウェブフックログのリストを照会します。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	40

要求スペック

Parameter	Description
event_no	イベント番号
requested_start_date Date	送信開始日時
requested_end_date Date	送信終了日時
success	Webhookの送信に成功したかどうか T：成功 F：失敗
log_type	ログタイプ G：一般送信 R：再送信 T：テスト送信
since_log_id	このログID以降のログを検索
limit Min : [1]~Max : [10000]	照会結果の最大件数

Request Copy

Response Copy

Webhooks setting

ショップがWebhookの使用の同意（リアルタイム情報提供に関する権限）した内容について照会することができます。

Endpoints

GET /api/v2/admin/webhooks/setting
PUT /api/v2/admin/webhooks/setting

Webhooks setting properties

Attribute

Description

scopes

リアルタイム情報提供に関する権限

reception_status

Webhook受信ステータス

T：有効
F：無効

Retrieve webhook settings cafe24

GET /api/v2/admin/webhooks/setting

GET

ショップがWebhookの使用の同意（リアルタイム情報提供に関する権限）した内容について照会します。

基本スペック

Property	Description
SCOPE	アプリの閲覧権限 (mall.read_application)
呼び出し件数制限	40

Request Copy

Response Copy

Change Webhook settings cafe24

PUT /api/v2/admin/webhooks/setting

PUT

基本スペック

Property	Description
SCOPE	アプリの投稿権限 (mall.write_application)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

reception_status

Webhook受信ステータス

T：有効
F：無効

Request Copy

Response Copy

Autodisplay

自動陳列(Autodisplay)は、商品分類に特定の条件に従って商品を自動的に陳列してくれる機能です。
たとえば、最も販売量の高い順に商品を陳列したり、いいですね。数が高い数などで並ぶように設定できます。
このリソースでは、自動陳列条件を作成するか、修正、削除して自動陳列条件を照会できます。

Endpoints

GET /api/v2/admin/autodisplay
POST /api/v2/admin/autodisplay
PUT /api/v2/admin/autodisplay/{display_no}
DELETE /api/v2/admin/autodisplay/{display_no}

Autodisplay properties

Attribute	Description
shop_no	ショップ番号
display_no	自動入替番号
use_main	メインカテゴリかどうか T: メインカテゴリ F: 商品カテゴリ
category_no	カテゴリ番号
display_group	商品カテゴリの詳細
display_count Min : [1]~Max : [200]	自動入替え可能な最大商品数
use_reservation	入替予約機能の使用有無 T: 使用 F: 未使用
start_date	予約開始日
use_hashtag	ハッシュタグ使用有無 T: 使用 F: 未使用
hash_tags	ハッシュタグ
display_sort	ソート順 AOD: 現在の注文数(降順) AOA: 現在の注文数(昇順) AVD: 現在の閲覧数(降順) AVA: 現在の閲覧数(昇順) ARD: 現在の注文率(降順) ARA: 現在の注文率(昇順) ACD: クリック単価(降順) AND: 新着商品順 APD: 販売価格(降順) APA: 販売価格(昇順)→AOD: 注文数(降順) AOA: 注文数(昇順) AVD: 閲覧数(降順) AVA: 閲覧数(昇順) ARD: 注文率(降順) ARA: 注文率(昇順) ACD: クリック単価(降順) AND: 新着商品順 APD: 販売価格(降順) APA: 販売価格(昇順) RD : 最近の登録商品を上に RA : 最近の登録商品を下に UD : 最近の修正商品を上に UA : 最近の修正商品を下に NA : 商品名五十音昇順 ND : 商品名五十音降順 PD : 販売価格が高い商品を上に PA :販売価格が高い商品を下に SD : 販売数の多い商品を上に SA : 販売数の多い商品を下に CD : 閲覧数の多い商品を上に CA : 閲覧数の多い商品を下に LD : いいね数が多い商品を上に LA : いいね数が多い商品を下に
timetable Array Max : [24]	アップデート時間
period	データの集計期間 1.1日 3: 3日 7: 1週間(7日) 30: 30日
except_categories_scope	除外カテゴリ設定 A: すべてのカテゴリに適用 C :このカテゴリのみ適用
except_categories	除外カテゴリ

Retrieve a list of auto layouts cafe24

GET /api/v2/admin/autodisplay

GET

生成されたすべての自動陳列をリストを通じて照会することができます。
自動陳列番号、予約陳列の使用有無、自動陳列の最大商品数などを確認できます。

基本スペック

Property	Description
SCOPE	商品カテゴリの閲覧権限 (mall.read_category)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

display_no

自動入替番号

Request Copy

Response Copy

Create auto layout for selected product category cafe24

POST /api/v2/admin/autodisplay

POST

特定の条件に従って自動陳列を作成します。

基本スペック

Property	Description
SCOPE	商品カテゴリの投稿権限 (mall.write_category)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
use_main Required	メインカテゴリかどうか T: メインカテゴリ F: 商品カテゴリ
category_no Required	カテゴリ番号
display_group Required	商品カテゴリの詳細
display_count Required Min : [1]~Max : [200]	自動入替え可能な最大商品数
use_reservation Required	入替予約機能の使用有無 T: 使用 F: 未使用
start_date	予約開始日
use_hashtag Required	ハッシュタグ使用有無 T: 使用 F: 未使用
hash_tags	ハッシュタグ
display_sort	ソート順整列条件(RD、RA、UD、UA、NA、ND、PD、PA、SD、SA、AD、AA、LD、LA)はuse_hashtagが"T"の場合にのみ使用可能 AOD: 現在の注文数(降順) AOA: 現在の注文数(昇順) AVD: 現在の閲覧数(降順) AVA: 現在の閲覧数(昇順) ARD: 現在の注文率(降順) ARA: 現在の注文率(昇順) ACD: クリック単価(降順) AND: 新着商品順 APD: 販売価格(降順) APA: 販売価格(昇順)→AOD: 注文数(降順) AOA: 注文数(昇順) AVD: 閲覧数(降順) AVA: 閲覧数(昇順) ARD: 注文率(降順) ARA: 注文率(昇順) ACD: クリック単価(降順) AND: 新着商品順 APD: 販売価格(降順) APA: 販売価格(昇順) RD : 最近の登録商品を上に RA : 最近の登録商品を下に UD : 最近の修正商品を上に UA : 最近の修正商品を下に NA : 商品名五十音昇順 ND : 商品名五十音降順 PD : 販売価格が高い商品を上に PA :販売価格が高い商品を下に SD : 販売数の多い商品を上に SA : 販売数の多い商品を下に CD : 閲覧数の多い商品を上に CA : 閲覧数の多い商品を下に LD : いいね数が多い商品を上に LA : いいね数が多い商品を下に
timetable Array Max : [24]	アップデート時間
period	データの集計期間 1.1日 3: 3日 7: 1週間(7日) 30: 30日
except_categories_scope	除外カテゴリ設定 A: すべてのカテゴリに適用 C :このカテゴリのみ適用 DEFAULT A
except_categories	除外カテゴリ

Request Copy

Response Copy

Update auto layout for selected product category cafe24

PUT /api/v2/admin/autodisplay/{display_no}

PUT

既存の自動陳列を修正します。
自動陳列の最大商品数、予約陳列の使用可否などを修正できます。

基本スペック

Property	Description
SCOPE	商品カテゴリの投稿権限 (mall.write_category)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
display_no Required	自動入替番号
display_count Min : [1]~Max : [200]	自動入替え可能な最大商品数
use_reservation	入替予約機能の使用有無 T: 使用 F: 未使用
start_date	予約開始日
use_hashtag	ハッシュタグ使用有無 T: 使用 F: 未使用
hash_tags	ハッシュタグ
display_sort	ソート順整列条件(RD、RA、UD、UA、NA、ND、PD、PA、SD、SA、AD、AA、LD、LA)はuse_hashtagが"T"の場合にのみ使用可能 AOD: 現在の注文数(降順) AOA: 現在の注文数(昇順) AVD: 現在の閲覧数(降順) AVA: 現在の閲覧数(昇順) ARD: 現在の注文率(降順) ARA: 現在の注文率(昇順) ACD: クリック単価(降順) AND: 新着商品順 APD: 販売価格(降順) APA: 販売価格(昇順)→AOD: 注文数(降順) AOA: 注文数(昇順) AVD: 閲覧数(降順) AVA: 閲覧数(昇順) ARD: 注文率(降順) ARA: 注文率(昇順) ACD: クリック単価(降順) AND: 新着商品順 APD: 販売価格(降順) APA: 販売価格(昇順) RD : 最近の登録商品を上に RA : 最近の登録商品を下に UD : 最近の修正商品を上に UA : 最近の修正商品を下に NA : 商品名五十音昇順 ND : 商品名五十音降順 PD : 販売価格が高い商品を上に PA :販売価格が高い商品を下に SD : 販売数の多い商品を上に SA : 販売数の多い商品を下に CD : 閲覧数の多い商品を上に CA : 閲覧数の多い商品を下に LD : いいね数が多い商品を上に LA : いいね数が多い商品を下に
timetable Array Max : [24]	アップデート時間
period	データの集計期間 1.1日 3: 3日 7: 1週間(7日) 30: 30日
except_categories_scope	除外カテゴリ設定 A: すべてのカテゴリに適用 C :このカテゴリのみ適用
except_categories	除外カテゴリ

Request Copy

Response Copy

Delete auto layout for selected product category cafe24

DELETE /api/v2/admin/autodisplay/{display_no}

DELETE

生成された自動陳列を削除します。

基本スペック

Property	Description
SCOPE	商品カテゴリの投稿権限 (mall.write_category)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

display_no
Required

自動入替番号

Request Copy

Response Copy

Categories decorationimages

Endpoints

GET /api/v2/admin/categories/{category_no}/decorationimages
PUT /api/v2/admin/categories/{category_no}/decorationimages

Categories decorationimages properties

Attribute	Description
shop_no	ショップ番号
category_no	カテゴリ番号
use_menu_image_pc	カテゴリメニュー画像の使用設定(PC) T:使用する F:使用しない
menu_image_pc	カテゴリメニューのデフォルト画像(PC)
menu_over_image_pc	カテゴリメニューのマウスオーバー画像(PC)
use_top_image_pc	カテゴリ上部画像の使用設定(PC) T:使用する F:使用しない
top_images_pc	カテゴリの上部画像(PC)
use_title_image_pc	カテゴリタイトル画像の使用設定(PC) T:使用する F:使用しない
title_image_pc	カテゴリのタイトル画像(PC)
use_menu_image_mobile	カテゴリメニュー画像の使用設定(モバイル) T:使用する F:使用しない
menu_image_mobile	カテゴリメニューのデフォルト画像(モバイル)
use_top_image_mobile	カテゴリ上部画像の使用設定(モバイル) T:使用する F:使用しない
top_images_mobile Array Max : [3]	カテゴリの上部画像(モバイル)
use_title_image_mobile	カテゴリタイトル画像の使用設定(モバイル) T:使用する F:使用しない
title_image_mobile	カテゴリのタイトル画像(モバイル)

Retrieve decoration image settings by category cafe24

GET /api/v2/admin/categories/{category_no}/decorationimages

GET

分類番号を使用して、その分類の装飾情報を照会します。

基本スペック

Property	Description
SCOPE	商品カテゴリの閲覧権限 (mall.read_category)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

category_no
Required

カテゴリ番号

Request Copy

Response Copy

Update decoration images of a product category cafe24

PUT /api/v2/admin/categories/{category_no}/decorationimages

PUT

分類番号を使用して、その分類の装飾情報を修正します。
分類 PC メニュー画像を使用するかどうか、基本画像などを変更できます。

基本スペック

Property	Description
SCOPE	商品カテゴリの投稿権限 (mall.write_category)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
category_no Required	カテゴリ番号
use_menu_image_pc	カテゴリメニュー画像の使用設定(PC) T:使用する F:使用しない
menu_image_pc	カテゴリメニューのデフォルト画像(PC)
menu_over_image_pc	カテゴリメニューのマウスオーバー画像(PC)
use_top_image_pc	カテゴリ上部画像の使用設定(PC) T:使用する F:使用しない
top_images_pc Array Max : [3]	カテゴリの上部画像(PC)
use_title_image_pc	カテゴリタイトル画像の使用設定(PC) T:使用する F:使用しない
title_image_pc	カテゴリのタイトル画像(PC)
use_menu_image_mobile	カテゴリメニュー画像の使用設定(モバイル) T:使用する F:使用しない
menu_image_mobile	カテゴリメニューのデフォルト画像(モバイル)
use_top_image_mobile	カテゴリ上部画像の使用設定(モバイル) T:使用する F:使用しない
top_images_mobile Array Max : [3]	カテゴリの上部画像(モバイル)
use_title_image_mobile	カテゴリタイトル画像の使用設定(モバイル) T:使用する F:使用しない
title_image_mobile	カテゴリのタイトル画像(モバイル)

Request Copy

Response Copy

Categories seo

Endpoints

GET /api/v2/admin/categories/{category_no}/seo
PUT /api/v2/admin/categories/{category_no}/seo

Categories seo properties

Attribute	Description
shop_no	ショップ番号
category_no	カテゴリ番号
search_engine_exposure	検索エンジンでの表示設定 T:使用する F:使用しない
meta_title	ブラウザでのタイトル
meta_author	メタタグ1:Author
meta_description	メタタグ2:Description
meta_keywords	メタタグ3:Keywords

Retrieve SEO settings by category cafe24

GET /api/v2/admin/categories/{category_no}/seo

GET

特定カテゴリーのSEO設定を照会することができます。
検索エンジン露出設定、ブラウザタイトルなどを照会することができます。

基本スペック

Property	Description
SCOPE	商品カテゴリの閲覧権限 (mall.read_category)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

category_no
Required

カテゴリ番号

Request Copy

Response Copy

Update a product category SEO cafe24

PUT /api/v2/admin/categories/{category_no}/seo

PUT

特定のカテゴリーのSEO設定を修正することができます。
検索エンジン露出設定、ブラウザタイトルなどを設定できます。

基本スペック

Property	Description
SCOPE	商品カテゴリの投稿権限 (mall.write_category)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
shop_no	ショップ番号 DEFAULT 1
category_no Required	カテゴリ番号
search_engine_exposure	検索エンジンでの表示設定 T:使用する F:使用しない
meta_title	ブラウザでのタイトル
meta_author	メタタグ1:Author
meta_description	メタタグ2:Description
meta_keywords	メタタグ3:Keywords

Request Copy

Response Copy

Mains

メインカテゴリ(Mains)はショップの商品をトップページに表示できる商品カテゴリです。

Endpoints

GET /api/v2/admin/mains

Mains properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
module_code	モジュールコード各メインカテゴリに指定されたモジュールコード
display_group	メインカテゴリ番号
group_name	メインカテゴリ名メインカテゴリの生成時に指定したカテゴリ名
soldout_sort_type	在庫切れ商品の表示在庫切れ商品が表示される位置 B:在庫切れ商品を一番後ろに N:在庫切れ商品関係なし

Retrieve a list of main categories cafe24

GET /api/v2/admin/mains

GET

ショッピングモールに陳列されているメイン分類の情報を照会することができます。
メイン分類番号、メイン分類名、品切れ商品陳列設定をご確認いただけます。

基本スペック

Property	Description
SCOPE	商品カテゴリの閲覧権限 (mall.read_category)
呼び出し件数制限	40

Request Copy

Response Copy

Brands

ブランド(Brands)は商品の「製作情報」の中でブランドに入力する情報を意味します。ブランドはショップの商品を区分する販売カテゴリの一つで、商品は必ず一つのブランドを持っています(指定しない場合は「独自ブランド」を使う)。

Endpoints

GET /api/v2/admin/brands
GET /api/v2/admin/brands/count
POST /api/v2/admin/brands
PUT /api/v2/admin/brands/{brand_code}
DELETE /api/v2/admin/brands/{brand_code}

Brands properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
brand_code	ブランドコード
brand_name Max Length : [50]	ブランド名
use_brand	ブランドの使用有無 T:使用する F:使用しない
search_keyword Max Length : [200]	検索キーワード設定
product_count	商品数
created_date	作成日

Retrieve a list of brands cafe24 youtube

GET /api/v2/admin/brands

GET

現在ショッピングモールにあるブランドを照会することができます。
ブランド名、ブランド使用有無、商品数などを照会することができます。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
brand_code	ブランドコード ,(コンマ)で複数の件を検索することができる。
brand_name	ブランド名 ,(コンマ)で複数の件を検索することができる。
use_brand	ブランドの使用有無 T:使用する F:使用しない
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of brands cafe24 youtube

GET /api/v2/admin/brands/count

GET

現在ショッピングモールにあるブランドの数字をカウントします。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
brand_code	ブランドコード ,(コンマ)で複数の件を検索することができる。
brand_name	ブランド名 ,(コンマ)で複数の件を検索することができる。
use_brand	ブランドの使用有無 T:使用する F:使用しない

Request Copy

Response Copy

Create a brand cafe24 youtube

POST /api/v2/admin/brands

POST

ブランドを作成します。
ブランド名やブランド使用可否などを設定することができ、商品検索時にそのブランド商品が検索できるように検索語を指定することができます。

基本スペック

Property	Description
SCOPE	販売カテゴリの投稿権限 (mall.write_collection)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
brand_name Required	ブランド名
use_brand	ブランドの使用有無 T:使用する F:使用しない DEFAULT T
search_keyword Max Length : [200]	検索キーワード設定

Request Copy

Response Copy

Update a brand cafe24 youtube

PUT /api/v2/admin/brands/{brand_code}

PUT

特定のブランドの情報を修正できます。
ブランド名、ブランド使用可否などを修正できます。

基本スペック

Property	Description
SCOPE	販売カテゴリの投稿権限 (mall.write_collection)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
shop_no	ショップ番号 DEFAULT 1
brand_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	ブランドコード
brand_name	ブランド名
use_brand	ブランドの使用有無 T:使用する F:使用しない DEFAULT T
search_keyword Max Length : [200]	検索キーワード設定

Request Copy

Response Copy

Delete a brand cafe24 youtube

DELETE /api/v2/admin/brands/{brand_code}

DELETE

特定のブランドを削除できます。

基本スペック

Property	Description
SCOPE	販売カテゴリの投稿権限 (mall.write_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
brand_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	ブランドコード

Request Copy

Response Copy

Classifications

独自カテゴリ(Classifications)は商品の「製作情報」の中で独自カテゴリに入力する情報を意味します。商品を区分する販売カテゴリの一つで、商品は必ず一つの独自カテゴリを持っています(指定しない場合は「基本の独自カテゴリ」を使う)。

Endpoints

GET /api/v2/admin/classifications
GET /api/v2/admin/classifications/count

Classifications properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
classification_code Type : [A-Z0-9] Min Length : [8] Max Length : [8]	独自カテゴリコード
classification_name Max Length : [200]	独自カテゴリ名
classification_description Max Length : [300]	独自カテゴリの説明
use_classification	使用設定
created_date	作成日
product_count	商品数

Retrieve a list of custom categories cafe24

GET /api/v2/admin/classifications

GET

ショッピングモールに登録されている自己分類をリストで照会します。
独自分類の分類コードや分類名などを確認できます。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
classification_code	独自カテゴリコード ,(コンマ)で複数の件を検索することができる。
classification_name	独自カテゴリ名 ,(コンマ)で複数の件を検索することができる。
use_classification	使用設定
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of custom categories cafe24

GET /api/v2/admin/classifications/count

GET

ショッピングモールに登録されている自己分類の数を照会します。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
classification_code	独自カテゴリコード ,(コンマ)で複数の件を検索することができる。
classification_name	独自カテゴリ名 ,(コンマ)で複数の件を検索することができる。
use_classification	使用設定

Request Copy

Response Copy

Manufacturers

メーカー(Manufacturers)は商品の「製作情報」の中でメーカーに入力する情報を意味します。メーカーは商品を製作、生産する主体を示し、商品を区分する販売カテゴリの一つです。商品は必ず一つのメーカーを持っています(指定しない場合は「独自メーカー」を使う)。

Endpoints

GET /api/v2/admin/manufacturers
GET /api/v2/admin/manufacturers/{manufacturer_code}
GET /api/v2/admin/manufacturers/count
POST /api/v2/admin/manufacturers
PUT /api/v2/admin/manufacturers/{manufacturer_code}

Manufacturers properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
manufacturer_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	メーカーコードシステムにより付与されたメーカーのコード。ショップ内でメーカーコードは重複しない。
manufacturer_name Max Length : [50]	メーカー名メーカーの名前。メーカー名はショップ管理者画面でメーカーを区分する基本的な情報である。
president_name Max Length : [30]	代表者名メーカーの代表者の名前
use_manufacturer	使用設定そのメーカーを使うかどうかを表示 T:使用する F:使用しない
email Max Length : [255]	メールアドレスメーカーのお問い合わせメールアドレス
phone Max Length : [20]	電話番号メーカーの電話番号
homepage Max Length : [255]	ホームページメーカーのホームページアドレス
zipcode	郵便番号メーカーの事業所の郵便番号
country_code	国コード
address1 Max Length : [255]	基本住所メーカーの住所(市区町村単位で表記)
address2 Max Length : [255]	詳細住所メーカーの住所(詳細住所表記)
created_date	作成日

Retrieve a list of manufacturers cafe24 youtube

GET /api/v2/admin/manufacturers

GET

ショッピングモールに登録されているメーカーの情報をリストで照会します。
メーカー名、代表者名、電話番号などを照会することができます。
リスト照会の応答値は、詳細照会よりも簡素です。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
manufacturer_code	メーカーコード検索したいメーカーのコード ,(コンマ)で複数の件を検索することができる。
manufacturer_name	メーカー名 ,(コンマ)で複数の件を検索することができる。
use_manufacturer	メーカー使用の設定 T:使用する F:使用しない
offset Max : [8000]	検索結果の開始位置検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Request Copy

Response Copy

Retrieve a manufacturer cafe24 youtube

GET /api/v2/admin/manufacturers/{manufacturer_code}

GET

ショッピングモールに登録されているメーカーの詳細を照会します。
メーカー名、代表者名、メーカーの使用状況などを照会することができます。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

manufacturer_code
Required

Type : [A-Z0-9]
Length Min : [8]~Max : [8]

メーカーコード

Request Copy

Response Copy

Retrieve a count of manufacturers cafe24 youtube

GET /api/v2/admin/manufacturers/count

GET

ショッピングモールに登録されているメーカーの数を照会します。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
manufacturer_code	メーカーコード検索したいメーカーのコード ,(コンマ)で複数の件を検索することができる。
manufacturer_name	メーカー名検索キーワードがメーカー名に含まれている供給会社検索(大文字・小文字を区別しない) ,(コンマ)で複数の件を検索することができる。
use_manufacturer	メーカー使用の設定 T:使用する F:使用しない

Request Copy

Response Copy

Create a manufacturer cafe24 youtube

POST /api/v2/admin/manufacturers

POST

ショッピングモールにメーカーを新たに登録します。

基本スペック

Property	Description
SCOPE	販売カテゴリの投稿権限 (mall.write_collection)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
manufacturer_name Required	メーカー名
president_name Required Max Length : [30]	代表者名
email Max Length : [255] Email	メールアドレス
phone Max Length : [20] Phone Number	電話番号
homepage Max Length : [255]	ホームページ
zipcode	郵便番号
address1 Max Length : [255]	基本住所
address2 Max Length : [255]	詳細住所
country_code	国コード
use_manufacturer	使用設定 T:使用する F:使用しない

Request Copy

Response Copy

Update a manufacturer cafe24 youtube

PUT /api/v2/admin/manufacturers/{manufacturer_code}

PUT

ショッピングモールに登録されているメーカーの情報を修正します。
メーカー名、代表者名、電話番号などを修正できます。

基本スペック

Property	Description
SCOPE	販売カテゴリの投稿権限 (mall.write_collection)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
manufacturer_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	メーカーコード
manufacturer_name	メーカー名
president_name	代表者名
email Max Length : [255] Email	メールアドレス
phone Max Length : [20] Phone Number	電話番号
homepage Max Length : [255]	ホームページ
zipcode	郵便番号
address1 Max Length : [255]	基本住所
address2 Max Length : [255]	詳細住所
country_code	国コード
use_manufacturer	使用設定 T:使用する F:使用しない

Request Copy

Response Copy

Origin

原産国(Origin)は商品が生産された地域を意味します。原産国は国外配送などに重要なデータです。カフェ24は多数の原産国をコード化しているため、原産国検索APIで原産国コード情報を確認することができます。

Endpoints

GET /api/v2/admin/origin

Origin properties

Attribute	Description
origin_place_no	原産国番号
origin_place_name	原産国名
foreign	海外
made_in_code	国名(原産国)コード

Retrieve a list of origins cafe24

GET /api/v2/admin/origin

GET

ショッピングモールが提供する原産地を一覧で照会することができます。
原産地名、原産地の国コードなどを照会することができます。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
origin_place_no	原産国番号
origin_place_name Max Length : [50]	原産国名
foreign	海外
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Request Copy

Response Copy

Trends

トレンド(Trends)は商品の「製作情報」の中でトレンドに入力する情報を意味します。トレンドは商品を区分する販売カテゴリの一つで、商品は必ず一つのトレンドを持っています(指定しない場合は「基本トレンド」を使う)。

Endpoints

GET /api/v2/admin/trends
GET /api/v2/admin/trends/count

Trends properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
trend_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	トレンドコード
trend_name Max Length : [50]	トレンド名
use_trend	トレンド使用の設定 T:使用する F:使用しない
created_date	作成日
product_count	商品数

Retrieve a list of trends cafe24

GET /api/v2/admin/trends

GET

ショッピングモールに登録されているトレンドを一覧で照会することができます。
トレンドコード、トレンド名、使用状況などを照会することができます。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
trend_code	トレンドコード ,(コンマ)で複数の件を検索することができる。
trend_name	トレンド名 ,(コンマ)で複数の件を検索することができる。
use_trend	トレンド使用の設定 T:使用する F:使用しない
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of trends cafe24

GET /api/v2/admin/trends/count

GET

ショッピングモールに登録されているトレンドの数を照会することができます。

基本スペック

Property	Description
SCOPE	販売カテゴリの閲覧権限 (mall.read_collection)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
trend_code	トレンドコード ,(コンマ)で複数の件を検索することができる。
trend_name	トレンド名 ,(コンマ)で複数の件を検索することができる。
use_trend	トレンド使用の設定 T:使用する F:使用しない

Request Copy

Response Copy

Shipping suppliers

供給会社の配送(Supplier Shipping)は、ショップの各供給会社に登録された配送方法に関する機能です。各供給会社に登録された配送方法に関する情報を照会、修正することができます。

Endpoints

GET /api/v2/admin/shipping/suppliers/{supplier_id}
PUT /api/v2/admin/shipping/suppliers/{supplier_id}

Shipping suppliers properties

Attribute	Description
shop_no	ショップ番号
supplier_id	供給会社のID
supplier_code	供給会社のコード
shipping_method	配送方法 shipping_01 : 配送 shipping_02 : 速達郵便 shipping_04 : 直接配送 shipping_05 : クイック配送 shipping_06 : その他 shipping_07 : 貨物配送 shipping_08 : 店舗受取 shipping_09 : 配送不要
shipping_etc Max Length : [25]	その他配送「shipping_method」が「shipping_06(その他)」である場合のその他の配送情報
shipping_type	国内/海外配送設定 A : 国内配送 C : 海外配送 B : 国内/海外配送
shipping_place Max Length : [127]	配送地域
shipping_start_date Min : [1] Max : [100]	配送期間の開始日
shipping_end_date Min : [1] Max : [100]	配送期間の終了日
shipping_fee_type	送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
free_shipping_price Min : [0] Max : [999999999]	送料無料の基準金額「shipping_fee_type」が「M(購入金額によって課金)」である場合、送料を無料にするための基準金額
shipping_fee Min : [0] Max : [999999999]	送料「shipping_fee_type」が「R(固定送料を使用)」または「M(購入金額によって課金)」である場合の送料
shipping_fee_by_quantity Min : [0] Max : [999999999]	商品数別送料「shipping_fee_type」が「N(商品の数量に比例して送料を課金)」である場合の数量別の送料
shipping_rates Array Max : [50]	送料詳細設定
prepaid_shipping_fee	送料前払いの設定 C : 着払い P : 前払い B : 着払い/前払い
shipping_fee_by_product	商品別の個別送料設定 T:使用する F:使用しない
product_weight Min : [0] Max : [30]	商品の重量
hscode Max Length : [20]	HSコード
country_hscode Array Max : [50]	国別HSコード

Retrieve a supplier's shipping settings cafe24 youtube

GET /api/v2/admin/shipping/suppliers/{supplier_id}

GET

供給会社に登録された配送方法に関する情報を照会することができます。
供給会社コード、配送方法、配送地域などの照会ができます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	30

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

supplier_id
Required

供給会社のID

Request Copy

Response Copy

Update a supplier's shipping settings cafe24 youtube

PUT /api/v2/admin/shipping/suppliers/{supplier_id}

PUT

供給会社に登録された配送方法に関する情報を修正することができます。
配送方法、配送地域、送料タイプなどの修正ができます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	30
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
supplier_id Required	供給会社のID
shipping_method	配送方法 shipping_01 : 配送 shipping_02 : 速達郵便 shipping_04 : 直接配送 shipping_05 : クイック配送 shipping_06 : その他 shipping_07 : 貨物配送 shipping_08 : 店舗受取 shipping_09 : 配送不要
shipping_etc Max Length : [25]	その他配送「shipping_method」が「shipping_06(その他)」である場合のその他の配送情報
shipping_type	国内/海外配送設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 A : 国内配送 C : 海外配送 B : 国内/海外配送
shipping_place Max Length : [127]	配送地域
shipping_start_date Min : [1] Max : [100]	配送期間の開始日
shipping_end_date Min : [1] Max : [100]	配送期間の終了日
shipping_fee_type	送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
free_shipping_price Min : [0] Max : [999999999]	送料無料の基準金額「shipping_fee_type」が「M(購入金額によって課金)」である場合、送料を無料にするための基準金額
shipping_fee Min : [0] Max : [999999999]	送料「shipping_fee_type」が「R(固定送料を使用)」または「M(購入金額によって課金)」である場合の送料
shipping_fee_by_quantity Min : [0] Max : [999999999]	商品数別送料「shipping_fee_type」が「N(商品の数量に比例して送料を課金)」である場合の数量別の送料
shipping_rates Array Max : [50]	送料詳細設定
shipping_rates_min 送料 - 送料設定基準の下限値 shipping_rates_max 送料 - 送料設定基準の上限値 shipping_fee 送料
prepaid_shipping_fee	送料前払いの設定 Cafe24管理画面(ベトナム, フィリピン) では使用できません。 C : 着払い P : 前払い B : 着払い/前払い
shipping_fee_by_product	商品別の個別送料設定 T:使用する F:使用しない
product_weight Min : [0] Max : [30]	商品の重量
hscode Max Length : [20]	HSコード
country_hscode Array Max : [24]	国別HSコード
country_code 国コード hscode HSコード

Request Copy

Response Copy

Suppliers

供給会社(Suppliers)は商品の「製作情報」の中で供給会社に入力する情報を意味します。供給会社はショップに商品を供給して販売できるようにする会社または個人を意味します。供給会社は商品を区分する販売カテゴリの一つで、商品は必ず一つの供給会社を持っています(指定しない場合は「独自供給」を使う)。

Endpoints

GET /api/v2/admin/suppliers
GET /api/v2/admin/suppliers/count
GET /api/v2/admin/suppliers/{supplier_code}
POST /api/v2/admin/suppliers
PUT /api/v2/admin/suppliers/{supplier_code}
DELETE /api/v2/admin/suppliers/{supplier_code}

Suppliers properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
supplier_code	供給会社のコードシステムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
supplier_name Max Length : [100]	供給会社名供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
status	ステータス供給会社との取引現況情報 A:取引中 P:取引中止 N:取引解除
commission	手数料精算タイプが手数料型(P)の場合に使う手数料情報
payment_period	精算周期供給会社に対する精算周期を設定することができる。 0：選択しない C：日次精算 B：週次精算 A：月次精算
business_item Max Length : [255]	取引商品タイプ供給会社と取り引きする商品のタイプ情報
payment_type	精算タイプ供給会社に払う金額をどのようなタイプで精算するかを設定することができる。手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。買入型 : 商品登録時に入力した供給価格を基準に精算する。 P：手数料基準 D：仕入れ価格基準
supplier_type	供給会社のタイプ供給会社の営業形態卸売業者 : 最終消費者には販売せず、小売業者に販売する業者仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者出品業者 : ショップに入店して販売している会社 WS:卸売業者 SF:仕入れ業者 BS:出品業者 ET:その他
use_supplier	使用設定その供給会社を使うかどうかを表示 T:使用する F:使用しない
created_date	登録日供給会社の情報が登録された日付
updated_date	修正日供給会社情報が変更された日付
country_code	事業所住所の国コード
zipcode Max Length : [10]	郵便番号供給会社の住所の郵便番号
address1 Max Length : [255]	基本住所供給会社の住所(市区町村単位で表記)
address2 Max Length : [255]	詳細住所供給会社の住所(詳細住所表記)
manager_information	担当者供給会社の担当者の連絡先情報
payment_start_day Min : [0]~Max : [6]	精算開始曜日精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 毎週日曜日に精算 1 : 毎週月曜日に精算 2 : 毎週火曜日に精算 3 : 毎週水曜日に精算 4 : 毎週木曜日に精算 5 : 毎週金曜日に精算 6 : 毎週土曜日に精算 0 : 日曜日 1 : 月曜日 2 : 火曜日 3 : 水曜日 4 : 木曜日 5 : 金曜日 6 : 土曜日
payment_end_day Min : [0]~Max : [6]	精算終了曜日精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 毎週日曜日に精算 1 : 毎週月曜日に精算 2 : 毎週火曜日に精算 3 : 毎週水曜日に精算 4 : 毎週木曜日に精算 5 : 毎週金曜日に精算 6 : 毎週土曜日に精算 0 : 日曜日 1 : 月曜日 2 : 火曜日 3 : 水曜日 4 : 木曜日 5 : 金曜日 6 : 土曜日
payment_start_date Min : [1]~Max : [31]	精算開始日精算周期が月間精算(A)である場合、該当日付を精算開始日とする。
payment_end_date Min : [1]~Max : [31]	精算終了日精算周期が月間精算(A)である場合、該当日付を精算終了日とする。
trading_type	供給会社の仕入れ方法商品が供給会社から配送される形態仕入れ: 商品を販売者が購入して購入者に配送する。直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。 D:仕入れ C:直接配送
bank_code Max Length : [50]	銀行コード供給会社精算時に使う口座の入金銀行コード bank_code
bank_account_no	口座番号供給会社精算時に使う口座の番号
bank_account_name	口座名義供給会社精算時に使う口座の名義
president_name	代表者名事業者登録時に供給会社が登録した代表者名
company_registration_no Max Length : [12]	事業者登録番号供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。
company_name	商号事業者登録時に供給会社が登録した商号
company_condition	業態事業者登録時に供給会社が登録した業態
company_line	種目事業者登録時に供給会社が登録した業種
phone Max Length : [20]	電話番号供給会社の事業所の電話番号
fax Max Length : [20]	ファックス番号供給会社のファックス番号
payment_method	精算時期精算基準時期 10：決済完了 30：配送開始 40：配送完了 10 : 決済完了 30 : 配送開始 40 : 配送完了
market_country_code	市場の住所の国コード
market_zipcode Max Length : [10]	市場の郵便番号
market_address1	市場の住所(基本)
market_address2	市場の住所(詳細)
exchange_country_code	事業所住所の国コード
exchange_zipcode Max Length : [10]	返品先の郵便番号
exchange_address1 Max Length : [255]	返品先の住所(基本)
exchange_address2 Max Length : [255]	返品先の住所(詳細)
homepage_url Max Length : [100]	ホームページアドレス
mall_url Max Length : [100]	ショップのアドレス
account_start_date Max Length : [10]	取引開始日
account_stop_date Max Length : [10]	取引中止日
show_supplier_info Max Length : [100]	供給会社情報の表示 SP:電話番号 SM:事業場の住所 MA:市場の住所 EA:返品先の住所 MN:担当者名 MI:担当者の連絡先
memo Max Length : [255]	メモ供給会社に対する管理用メモ
company_introduction	会社紹介供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

Retrieve a list of suppliers cafe24 youtube

GET /api/v2/admin/suppliers

GET

ショッピングモールに登録されているサプライヤーをリストで照会することができます。
サプライヤーコード、サプライヤー名、手数料などを照会できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
supplier_code	供給会社のコードシステムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。 ,(コンマ)で複数の件を検索することができる。
supplier_name	供給会社名供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。 ,(コンマ)で複数の件を検索することができる。
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Request Copy

Response Copy

Retrieve a count of suppliers cafe24 youtube

GET /api/v2/admin/suppliers/count

GET

ショッピングモールに登録されているサプライヤー全体の数を照会できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

supplier_code

供給会社のコード

システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

,(コンマ)で複数の件を検索することができる。

supplier_name

供給会社名

供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Retrieve a supplier cafe24 youtube

GET /api/v2/admin/suppliers/{supplier_code}

GET

特定のサプライヤーの情報を照会できます。
サプライヤー名、手数料、精算周期などを照会することができます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

supplier_code
Required

供給会社のコード

システムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。

Request Copy

Response Copy

Create a supplier cafe24 youtube

POST /api/v2/admin/suppliers

POST

ショッピングモールにサプライヤーを新規に作成できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
supplier_name Required Max Length : [50]	供給会社名供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
manager_information Array Max : [3]	担当者担当者は最大3人まで入力できる。
no Required 担当者の一連番号 name Required 担当者の氏名 phone 担当者の連絡先 email 担当者のメールアドレス
use_supplier	使用設定その供給会社を使うかどうかを表示 T:使用する F:使用しない DEFAULT T
trading_type	供給会社の仕入れ方法商品が供給会社から配送される形態仕入れ: 商品を販売者が購入して購入者に配送する。直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。 D:仕入れ C:直接配送 DEFAULT D
supplier_type	供給会社のタイプ供給会社の営業形態卸売業者 : 最終消費者には販売せず、小売業者に販売する業者仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者出品業者 : ショップに入店して販売している会社 WS:卸売業者 SF:仕入れ業者 BS:出品業者 ET:その他 DEFAULT WS
status	ステータス供給会社との取引現況情報 A:取引中 P:取引中止 N:取引解除 DEFAULT A
business_item Max Length : [255]	取引商品タイプ供給会社と取り引きする商品のタイプ情報
payment_type	精算タイプ供給会社に払う金額をどのようなタイプで精算するかを設定することができる。手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。買入型 : 商品登録時に入力した供給価格を基準に精算する。 P：手数料基準 D：仕入れ価格基準 DEFAULT P
payment_period	精算周期供給会社に対する精算周期を設定することができる。 0：選択しない C：日次精算 B：週次精算 A：月次精算 DEFAULT 0
payment_method	精算時期精算基準時期 10：決済完了 30：配送開始 40：配送完了 10 : 決済完了 30 : 配送開始 40 : 配送完了
payment_start_day Min : [0]~Max : [6]	精算開始曜日精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 毎週日曜日に精算 1 : 毎週月曜日に精算 2 : 毎週火曜日に精算 3 : 毎週水曜日に精算 4 : 毎週木曜日に精算 5 : 毎週金曜日に精算 6 : 毎週土曜日に精算 0 : 日曜日 1 : 月曜日 2 : 火曜日 3 : 水曜日 4 : 木曜日 5 : 金曜日 6 : 土曜日
payment_end_day Min : [0]~Max : [6]	精算終了曜日精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 毎週日曜日に精算 1 : 毎週月曜日に精算 2 : 毎週火曜日に精算 3 : 毎週水曜日に精算 4 : 毎週木曜日に精算 5 : 毎週金曜日に精算 6 : 毎週土曜日に精算 0 : 日曜日 1 : 月曜日 2 : 火曜日 3 : 水曜日 4 : 木曜日 5 : 金曜日 6 : 土曜日
payment_start_date Min : [1]~Max : [31]	精算開始日精算周期が月間精算(A)である場合、該当日付を精算開始日とする。
payment_end_date Min : [1]~Max : [31]	精算終了日精算周期が月間精算(A)である場合、該当日付を精算終了日とする。
commission	手数料率精算タイプが手数料型(P)の場合に使う手数料情報 DEFAULT 10
phone Max Length : [20] Phone Number	電話番号供給会社の事業所の電話番号
fax Max Length : [20] Phone Number	ファックス番号供給会社のファックス番号
country_code	事業所住所の国コード
zipcode Max Length : [10]	郵便番号供給会社の住所の郵便番号
address1 Max Length : [255]	基本住所供給会社の住所(市区町村単位で表記)
address2 Max Length : [255]	詳細住所供給会社の住所(詳細住所表記)
market_country_code	市場の住所の国コード
market_zipcode Max Length : [10]	市場の郵便番号
market_address1	市場の住所(基本)
market_address2	市場の住所(詳細)
exchange_country_code	事業所住所の国コード
exchange_zipcode Max Length : [10]	返品先の郵便番号
exchange_address1 Max Length : [255]	返品先の住所(基本)
exchange_address2 Max Length : [255]	返品先の住所(詳細)
homepage_url Max Length : [100]	ホームページアドレス
mall_url Max Length : [100]	ショップのアドレス
account_start_date Max Length : [10] Date	取引開始日
account_stop_date Max Length : [10] Date	取引中止日
memo Max Length : [255]	メモ供給会社に対する管理用メモ
company_registration_no Max Length : [12] Business Number	事業者登録番号供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。
company_name Max Length : [30]	商号事業者登録時に供給会社が登録した商号
president_name Max Length : [20]	代表者名事業者登録時に供給会社が登録した代表者名
company_condition Max Length : [20]	業態事業者登録時に供給会社が登録した業態
company_line Max Length : [20]	種目事業者登録時に供給会社が登録した業種
company_introduction	会社紹介供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

Request Copy

Response Copy

Update a supplier cafe24 youtube

PUT /api/v2/admin/suppliers/{supplier_code}

PUT

特定のサプライヤーからの情報を修正できます。
サプライヤー名、サプライヤー名などを修正できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
supplier_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	供給会社のコードシステムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
supplier_name Max Length : [50]	供給会社名供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
use_supplier	使用設定その供給会社を使うかどうかを表示 T:使用する F:使用しない
trading_type	供給会社の仕入れ方法商品が供給会社から配送される形態仕入れ: 商品を販売者が購入して購入者に配送する。直接配送: 商品の注文が入ると供給会社が購入者に直接配送する。 D:仕入れ C:直接配送
supplier_type	供給会社のタイプ供給会社の営業形態卸売業者 : 最終消費者には販売せず、小売業者に販売する業者仕入れ業者 : 卸売業者から商品を購入して小売業者に販売する業者出品業者 : ショップに入店して販売している会社 WS:卸売業者 SF:仕入れ業者 BS:出品業者 ET:その他
status	ステータス供給会社との取引現況情報 A:取引中 P:取引中止 N:取引解除
payment_type	精算タイプ供給会社に払う金額をどのようなタイプで精算するかを設定することができる。手数料型 : 商品の販売価格に対する手数料を策定し、手数料金額を反映して精算する。買入型 : 商品登録時に入力した供給価格を基準に精算する。 P：手数料基準 D：仕入れ価格基準
payment_period	精算周期供給会社に対する精算周期を設定することができる。 0：選択しない C：日次精算 B：週次精算 A：月次精算
commission	手数料率精算タイプが手数料型(P)の場合に使う手数料情報
manager_information Array Max : [3]	担当者担当者は3人まで指定でき、「no」を通じて特定の担当者を指定して情報を修正することができる。
no Required 担当者の一連番号 name Required 担当者の氏名 phone 担当者の連絡先 email 担当者のメールアドレス use_sms SMS T:受信する、F:受信しない
business_item Max Length : [255]	取引商品タイプ供給会社と取り引きする商品のタイプ情報
payment_method	精算時期精算基準時期 10：決済完了 30：配送開始 40：配送完了 10 : 決済完了 30 : 配送開始 40 : 配送完了
payment_start_day Min : [0]~Max : [6]	精算開始曜日精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 毎週日曜日に精算 1 : 毎週月曜日に精算 2 : 毎週火曜日に精算 3 : 毎週水曜日に精算 4 : 毎週木曜日に精算 5 : 毎週金曜日に精算 6 : 毎週土曜日に精算 0 : 日曜日 1 : 月曜日 2 : 火曜日 3 : 水曜日 4 : 木曜日 5 : 金曜日 6 : 土曜日
payment_end_day Min : [0]~Max : [6]	精算終了曜日精算周期が週間精算(B)である場合、下記の日程通り精算が行われる。 0 : 毎週日曜日に精算 1 : 毎週月曜日に精算 2 : 毎週火曜日に精算 3 : 毎週水曜日に精算 4 : 毎週木曜日に精算 5 : 毎週金曜日に精算 6 : 毎週土曜日に精算 0 : 日曜日 1 : 月曜日 2 : 火曜日 3 : 水曜日 4 : 木曜日 5 : 金曜日 6 : 土曜日
payment_start_date Min : [1]~Max : [31]	精算開始日精算周期が月間精算(A)である場合、該当日付を精算開始日とする。
payment_end_date Min : [1]~Max : [31]	精算終了日精算周期が月間精算(A)である場合、該当日付を精算終了日とする。
phone Max Length : [20] Phone Number	電話番号供給会社の事業所の電話番号
fax Max Length : [20] Phone Number	ファックス番号供給会社のファックス番号
country_code	事業所住所の国コード
zipcode Max Length : [10]	郵便番号供給会社の住所の郵便番号
address1 Max Length : [255]	基本住所供給会社の住所(市区町村単位で表記)
address2 Max Length : [255]	詳細住所供給会社の住所(詳細住所表記)
market_country_code	市場の住所の国コード
market_zipcode Max Length : [10]	市場の郵便番号
market_address1	市場の住所(基本)
market_address2	市場の住所(詳細)
exchange_country_code	事業所住所の国コード
exchange_zipcode Max Length : [10]	返品先の郵便番号
exchange_address1 Max Length : [255]	返品先の住所(基本)
exchange_address2 Max Length : [255]	返品先の住所(詳細)
homepage_url Max Length : [100]	ホームページアドレス
mall_url Max Length : [100]	ショップのアドレス
account_start_date Max Length : [10] Date	取引開始日
account_stop_date Max Length : [10] Date	取引中止日
memo Max Length : [255]	メモ供給会社に対する管理用メモ
company_registration_no Max Length : [12] Business Number	事業者登録番号供給会社の事業者登録番号。国別に事業者に固有の登録番号が発行される場合に表示する。
company_name Max Length : [30]	商号事業者登録時に供給会社が登録した商号
president_name Max Length : [20]	代表者名事業者登録時に供給会社が登録した代表者名
company_condition Max Length : [20]	業態事業者登録時に供給会社が登録した業態
company_line Max Length : [20]	種目事業者登録時に供給会社が登録した業種
company_introduction	会社紹介供給会社について簡単に紹介。ネットショップの会社概要画面に表示される。

Request Copy

Response Copy

Delete a supplier cafe24 youtube

DELETE /api/v2/admin/suppliers/{supplier_code}

DELETE

ショッピングモールに作成されたサプライヤーを削除できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40

要求スペック

Parameter	Description
supplier_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	供給会社のコード

Request Copy

Response Copy

Suppliers users

供給会社の運営者(Supplier Users)は供給会社がショップにログインして商品を直接登録する場合に使います。供給会社の運営者に商品のアップロード、カテゴリ管理、掲示板管理など制限的な権限を付与することができます。

Endpoints

GET /api/v2/admin/suppliers/users
GET /api/v2/admin/suppliers/users/count
GET /api/v2/admin/suppliers/users/{user_id}
POST /api/v2/admin/suppliers/users
PUT /api/v2/admin/suppliers/users/{user_id}
DELETE /api/v2/admin/suppliers/users/{user_id}

Suppliers users properties

Attribute	Description
user_id Type : [a-z0-9] Length Min : [4]~Max : [16]	供給会社の運営者ID 供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。
supplier_code Type : [A-Z0-9] Length Min : [8]~Max : [8]	供給会社のコードシステムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
supplier_name Max Length : [100]	供給会社名供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。
permission_category_select	商品登録時のカテゴリ選択権限供給会社の運営者が商品登録時に商品カテゴリを選択して登録できる権限を設定
permission_product_modify	商品修正の権限供給会社の運営者が商品を登録した後、商品情報を修正できる権限を設定
permission_product_display	商品表示の権限供給会社の運営者が商品を登録した後、ショップの画面に表示できる権限を設定
permission_product_selling	商品販売の権限供給会社の運営者が商品を登録した後、その商品の販売有無を設定できる権限を設定
permission_product_delete	登録商品の削除権限供給会社の運営者が自分で登録した商品を削除できる権限を設定
permission_amount_inquiry	注文金額の照会権限
permission_board_manage	掲示板の権限設定供給会社の運営者がショップの掲示板にアクセスできる権限を設定 T:許容する F:許容しない
permission_order_menu	注文メニューへのアクセス権限
user_name	供給会社の運営者供給会社の運営者の名前。供給会社の運営者名は供給会社の運営者がショップ管理者画面で作業をする場合、「作業を実行した人(処理者)」の部分に表示される名前を意味する。供給会社運営者の詳細検索APIでしか確認できない。
nick_name	ニックネーム供給会社の運営者のニックネーム。供給会社の運営者のニックネームは供給会社の運営者が掲示板に投稿する際に「投稿者」に表示されるニックネームを意味する(ただ、その掲示板が作成者名の代わりに「ニックネーム」を表示するように設定されている場合に限る)。供給会社の運営者の詳細検索APIでしか確認できない。
nick_name_icon_type	ニックネームアイコンのタイプ供給会社の運営者のニックネームの横に表示されるアイコンを設定することができる。直接アイコン登録 : ニックネームアイコンを直接アップロードして設定することができる。サンプルアイコン登録 : 事前に提供されているアイコンを選択して設定することができる。供給会社運営者の詳細検索APIでしか確認できない。 D:直接 S:サンプル
nick_name_icon_url Max Length : [255]	ニックネームアイコンのURL 供給会社の運営者のニックネームアイコンの画像経路供給会社運営者の詳細検索APIでしか確認できない。
use_nick_name_icon	掲示板へのニックネームアイコン表示設定供給会社の運営者が掲示板に投稿する際、ニックネームアイコンを表示するかどうかを設定供給会社運営者の詳細検索APIでしか確認できない。
use_writer_name_icon	掲示板への作成者表示設定供給会社の運営者が掲示板に投稿する際、作成者名を表示するかどうかを設定供給会社運営者の詳細検索APIでしか確認できない。
email Email	メールアドレス供給会社の運営者のメールアドレス。供給会社の運営者の連絡先を保存する目的で使う。供給会社の運営者の詳細検索APIでしか確認できない。
phone	電話番号供給会社の運営者の電話番号。供給会社の運営者の連絡先を保存する目的で使う。供給会社の運営者の詳細検索APIでのみ確認が可能。
permission_shop_no	アクセス可能ショップマルチショップを区分するために使うショップ番号
permitted_category_list	商品登録時の選択が許可されている商品カテゴリ供給会社の運営者が商品登録時に選択可能な商品カテゴリ。供給会社の運営者は商品登録時にその商品カテゴリにしか商品をアップロードすることができない。供給会社運営者の詳細検索APIでしか確認できない。

Retrieve a list of supplier users cafe24 youtube

GET /api/v2/admin/suppliers/users

GET

ショッピングモールに登録されているサプライヤーのオペレーターをリストで照会できます。
サプライヤーコード、サプライヤー名、サプライヤーの運営者名などを照会できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	10

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
user_id Type : [a-zA-Z0-9] Length Min : [4]~Max : [16]	供給会社の運営者ID 供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。
supplier_code Max Length : [8]	供給会社のコードシステムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
supplier_name Max Length : [100]	供給会社名供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

Request Copy

Response Copy

Retrieve a count of supplier users cafe24 youtube

GET /api/v2/admin/suppliers/users/count

GET

ショッピングモールに登録されているサプライヤーのオペレーターの数を照会できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	10

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
user_id Type : [a-zA-Z0-9] Length Min : [4]~Max : [16]	供給会社の運営者ID 供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。
supplier_code Max Length : [8]	供給会社のコードシステムにより付与された供給会社のコード。ショップ内で供給会社コードは重複しない。
supplier_name Max Length : [100]	供給会社名供給会社の名前。供給会社名はショップ管理者画面で供給会社を区分する基本的な情報である。

Request Copy

Response Copy

Retrieve supplier user details cafe24 youtube

GET /api/v2/admin/suppliers/users/{user_id}

GET

ショッピングモールに登録されている特定のサプライヤーのオペレーターを照会できます。
サプライヤー名、サプライヤーの権限、ニックネームなどを照会できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	10

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

user_id

Type : [a-zA-Z0-9]
Length Min : [4]~Max : [16]

供給会社の運営者ID

供給会社の運営者がログインする際に使うログインID。副運営者と同じくショップ管理者画面にログインすると供給会社管理者画面にアクセスできる。

Request Copy

Response Copy

Create a supplier user cafe24 youtube

POST /api/v2/admin/suppliers/users

POST

ショップに供給会社の運営者を登録することができます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
user_id Required Type : [a-z0-9] Length Min : [4]~Max : [16]	供給会社の運営者ID
supplier_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	供給会社のコード
user_name	供給会社の運営者必須入力
shop_no Required ショップ番号 user_name Required 供給会社の運営者
nick_name	ニックネーム
shop_no ショップ番号 nick_name ニックネーム
password Required	パスワード
use_nick_name_icon	掲示板へのニックネームアイコン表示設定 T：使用する F：使用しない DEFAULT F
use_writer_name_icon	掲示板への作成者表示設定 T：使用する F：使用しない DEFAULT F
email Email	メールアドレス
phone	電話番号
permission_shop_no Required	アクセス可能ショップ
permission_category_select	商品登録時のカテゴリ選択権限 T：使用する F：使用しない DEFAULT T
permitted_category_list	商品登録時の選択が許可されている商品カテゴリ
permission_product_modify	商品修正の権限 T：使用する F：使用しない DEFAULT T
permission_product_display	商品表示の権限 T：使用する F：使用しない DEFAULT T
permission_product_selling	商品販売の権限 T：使用する F：使用しない DEFAULT T
permission_product_delete	登録商品の削除権限 T：使用する F：使用しない DEFAULT T
permission_order_menu	注文メニューへのアクセス権限 T：使用する F：使用しない DEFAULT T
permission_amount_inquiry	注文金額の照会権限 T：使用する F：使用しない DEFAULT F

Request Copy

Response Copy

Update a supplier user cafe24 youtube

PUT /api/v2/admin/suppliers/users/{user_id}

PUT

ショップに登録されている特定の供給会社の運営者の情報を修正することができます。
供給会社の運営者名、ニックネーム、パスワードなどを修正することができます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
user_id Required Type : [a-z0-9] Length Min : [4]~Max : [16]	供給会社の運営者ID
user_name	供給会社の運営者必須入力
shop_no ショップ番号 user_name 供給会社の運営者
nick_name	ニックネーム
shop_no ショップ番号 nick_name ニックネーム
password	パスワード
use_nick_name_icon	掲示板へのニックネームアイコン表示設定 T：使用する F：使用しない
use_writer_name_icon	掲示板への作成者表示設定 T：使用する F：使用しない
email Email	メールアドレス
phone	電話番号
permission_shop_no	アクセス可能ショップ
permission_category_select	商品登録時のカテゴリ選択権限 T：使用する F：使用しない
permitted_category_list	商品登録時の選択が許可されている商品カテゴリ
permission_product_modify	商品修正の権限 T：使用する F：使用しない
permission_product_display	商品表示の権限 T：使用する F：使用しない
permission_product_selling	商品販売の権限 T：使用する F：使用しない
permission_product_delete	登録商品の削除権限 T：使用する F：使用しない
permission_order_menu	注文メニューへのアクセス権限 T：使用する F：使用しない
permission_amount_inquiry	注文金額の照会権限 T：使用する F：使用しない

Request Copy

Response Copy

Delete a supplier user cafe24 youtube

DELETE /api/v2/admin/suppliers/users/{user_id}

DELETE

ショップに登録されている特定の供給会社の運営者を削除することができます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40

要求スペック

Parameter	Description
user_id Required Type : [a-z0-9] Length Min : [4]~Max : [16]	供給会社の運営者ID

Request Copy

Response Copy

Suppliers users regionalsurcharges

Endpoints

GET /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges
POST /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges
DELETE /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/{regional_surcharge_no}

Suppliers users regionalsurcharges properties

Attribute	Description
shop_no	ショップ番号
regional_surcharge_no	地域別送料登録番号
supplier_id Max Length : [20]	供給会社のID
country_code Max Length : [2]	国コード KR : 韓国 JP : 日本 VN : ベトナム
region_name Max Length : [255]	特殊地域名
surcharge_region_name Max Length : [300]	地域名
start_zipcode Max Length : [8]	開始郵便番号
end_zipcode Max Length : [8]	終了郵便番号
regional_surcharge_amount Min : [1]~Max : [999999999]	地域別追加送料
use_regional_surcharge	地域別送料使用設定 T：使用する F：使用しない

Retrieve a supplier user's list of regional shipping fees cafe24 youtube

GET /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges

GET

特定の供給会社に登録された地域別の送料設定をリストで閲覧することができます。
国コード、地域名、地域別追加送料などの情報を照会できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
supplier_id Required Max Length : [20]	供給会社のID
offset Max : [10000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Create regional shipping fee for a supplier user cafe24 youtube

POST /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges

POST

特定の供給会社に、地域別の送料設定を登録することができます。
供給会社１つごとに、地域別送料を設定できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
supplier_id Required Max Length : [20]	供給会社のID
country_code Max Length : [2]	国コード Cafe24管理画面(韓国, 日本, ベトナム, フィリピン) では使用できません。 KR : 韓国 JP : 日本 VN : ベトナム
region_name Required Max Length : [255]	特殊地域名
use_regional_surcharge Required	地域別送料使用設定 T：使用する F：使用しない
surcharge_region_name Max Length : [300]	地域名
start_zipcode Max Length : [8]	開始郵便番号
end_zipcode Max Length : [8]	終了郵便番号
regional_surcharge_amount Required Min : [1]~Max : [999999999]	地域別追加送料

Request Copy

Response Copy

Delete supplier user's regional shipping fee settings cafe24 youtube

DELETE /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/{regional_surcharge_no}

DELETE

特定の供給会社に登録された地域別の送料設定を削除することができます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

supplier_id
Required

Max Length : [20]

供給会社のID

regional_surcharge_no
Required

地域別送料登録番号

Request Copy

Response Copy

Suppliers users regionalsurcharges setting

Endpoints

GET /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/setting
PUT /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/setting

Suppliers users regionalsurcharges setting properties

Attribute	Description
shop_no	ショップ番号
supplier_id Max Length : [20]	供給会社のID
use_regional_surcharge	地域別送料使用設定 T：使用する F：使用しない
region_setting_type	地域の設定方法 A：簡単設定 N：地名で設定 Z：郵便番号で設定
jeju_surcharge_amount Min : [0]~Max : [999999999]	追加送料(済州)
remote_area_surcharge_amount Min : [0]~Max : [999999999]	追加送料(離島・山間部)

Retrieve a supplier user's regional shipping fee settings cafe24 youtube

GET /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/setting

GET

特定の供給会社の地域別の送料設定を照会することができます。
地域別送料使用設定の有無や地域の設定方法などの情報を照会できます。

基本スペック

Property	Description
SCOPE	供給会社の情報の閲覧権限 (mall.read_supply)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

supplier_id
Required

Max Length : [20]

供給会社のID

Request Copy

Response Copy

Update a supplier user's regional shipping fee settings cafe24 youtube

PUT /api/v2/admin/suppliers/users/{supplier_id}/regionalsurcharges/setting

PUT

特定の供給会社の地域別の送料設定を修正することができます。
地域別送料使用設定の有無と地域の設定方法を修正することができます。

基本スペック

Property	Description
SCOPE	供給会社の情報の投稿権限 (mall.write_supply)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
supplier_id Required Max Length : [20]	供給会社のID
use_regional_surcharge Required	地域別送料使用設定 T：使用する F：使用しない
region_setting_type Required	地域の設定方法 A：簡単設定 N：地名で設定 Z：郵便番号で設定
jeju_surcharge_amount Min : [0]~Max : [999999999]	追加送料(済州)
remote_area_surcharge_amount Min : [0]~Max : [999999999]	追加送料(離島・山間部)

Request Copy

Response Copy

Carriers

配送会社(Carriers)はショッピングモールからショッピングモールの顧客にまで商品を配送する主体です。
配送業者を登録すると、ショッピングモールで配送処理を行う際、その配送業者を選択して配送処理を行うことができます。
配送業者リソースでは、現在登録されている配送業者を照会し、配送業者を作成、修正、削除処理することができます。

Endpoints

GET /api/v2/admin/carriers
GET /api/v2/admin/carriers/{carrier_id}
POST /api/v2/admin/carriers
PUT /api/v2/admin/carriers/{carrier_id}
DELETE /api/v2/admin/carriers/{carrier_id}

Carriers properties

Attribute	Description
shop_no	ショップ番号
carrier_id	配送会社ID
shipping_carrier_code	配送会社コード shipping_company_code
shipping_carrier	配送会社名
track_shipment_url	配送追跡URL
shipping_type	国内/海外配送の設定 A：国内 B：国内/海外 C：海外
contact	代表連絡先
secondary_contact	緊急連絡先
email	メールアドレス
default_shipping_fee	基本送料
homepage_url	ホームページアドレス
default_shipping_carrier	基本配送会社かどうか T:使用する F:使用しない
shipping_fee_setting	送料の設定有無 T:使用する F:使用しない
shipping_fee_setting_detail	送料設定データ
express_exception_setting	連携配送における例外情報設定の使用有無
links	link

Retrieve a list of shipping carriers cafe24 youtube

GET /api/v2/admin/carriers

GET

作成された配送会社をリストで照会できます。
配送会社名、配送会社コード、送料設定データなどを確認できます。

基本スペック

Property	Description
SCOPE	配送の閲覧権限 (mall.read_shipping)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Retrieve a shipping carrier cafe24 youtube

GET /api/v2/admin/carriers/{carrier_id}

GET

特定の配送会社を1つ選択して詳細を照会することができます。
配送会社名、配送会社コード、送料設定データなどを確認できます。

基本スペック

Property	Description
SCOPE	配送の閲覧権限 (mall.read_shipping)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

carrier_id
Required

配送会社ID

Request Copy

Response Copy

Create a shipping carrier cafe24 youtube

POST /api/v2/admin/carriers

POST

配送会社を作成できます。
配送会社を作成しながら、配送会社ごとに送料設定も行うことができます。

基本スペック

Property	Description
SCOPE	配送の投稿権限 (mall.write_shipping)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
shipping_carrier_code Required	配送会社コード shipping_company_code
contact Required Max Length : [16]	代表連絡先
email Required Email Max Length : [255]	メールアドレス
shipping_carrier Max Length : [80]	配送会社名
track_shipment_url Max Length : [255]	配送追跡URL
secondary_contact Max Length : [16]	緊急連絡先 * Youtube shopping をご利用の場合は提供されません
default_shipping_fee	基本送料
homepage_url Max Length : [255]	ホームページアドレス * Youtube shopping をご利用の場合は提供されません
shipping_fee_setting	送料の設定有無 T:使用する F:使用しない DEFAULT F
shipping_fee_setting_detail	送料設定データ ※shipping_fee_setting_detailの下位要素に対する値定義 1)1)shipping_fee_setting_domestic > shipping_fee_type shipping_fee_type(送料設定) T : 送料無料 R : 固定送料使用 M : 購入金額による賦課 D : 購入金額別差等配送料使用 W : 商品重量別差等配送料使用 C : 商品数量別差等配送料使用 N : 商品数量に比例して送料が発生 2)2)shipping_fee_setting_domestic > shipping_fee_criteria shipping_fee_criteria(送料請求基準注文金額条件設定) D:割引前、通常販売価格基準(おすすめ) A:割引適用後の決済料金基準 3)3)shipping_fee_setting_oversea > additional_handling_fee_list > unit unit(海外配送付加金額単位) W : 精液 P : パーセント 4)4)shipping_fee_setting_oversea > additional_handling_fee_list > rounding_unit rounding_unit(海外配送付加金額切り捨て単位) F : 切思案 0:1単位 1 : 10単位 2 : 100単位 3 : 1000単位 5)5)shipping_fee_setting_oversea > additional_handling_fee_list > rounding_rule rounding_rule(海外配送付加金額切り捨て方式) L : 下り U : 四捨五入 C : より
shipping_type 国内/海外配送の設定 A：国内、B：国内/海外、C：海外 DEFAULT B available_shipping_zone 配送可能地域 min_shipping_period 配送にかかる日数(最短日) max_shipping_period 配送にかかる日数(最長日) shipping_information 注文書の配送案内文 shipping_fee_setting_domestic Array shipping_fee_type 送料設定 shipping_fee 送料 min_price 送料が適用される金額(設定金額未満の場合) use_product_category 商品カテゴリ適用 product_category_list Array category_no カテゴリ番号 shipping_fee_criteria 送料を適用する注文金額の条件設定 domestic_shipping_fee_list Array min_value 範囲金額の最小値 max_value 範囲金額の最大値 shipping_fee 送料 available_shipping_zone 配送可能地域設定 available_shipping_zone_list Array region 配送可能地域名 start_zipcode 開始郵便番号 end_zipcode 終了郵便番号 available_order_time 注文可能時間設定 start_time 注文可能開始時間 end_time 注文可能終了時間 shipping_fee_setting_oversea Array shipping_fee_criteria 送料を適用する注文金額の条件設定 shipping_country_list Array country_code 国コード country_shipping_fee_list Array country_code 国コード conditional 範囲条件 min_value 範囲金額の最小値 max_value 範囲金額の最大値 shipping_fee 送料 additional_handling_fee 海外配送付加金額の設定 additional_handling_fee_list Array country_code 国コード text 付加金額名 min_value 範囲金額の最小値 max_value 範囲金額の最大値 additional_handling_fee 海外配送付加金額 unit 海外配送付加金額の単位(定額/定率) rounding_unit 切り捨ての位 rounding_rule 切り捨て方法 maximum_quantity 購入数量の制限 product_category_limit 商品カテゴリ制限設定 product_category_limit_list Array category_no カテゴリ番号 product_maximum_quantity 商品カテゴリ別の購入数量制限

Request Copy

Response Copy

Update a shipping carrier cafe24 youtube

PUT /api/v2/admin/carriers/{carrier_id}

PUT

特定の配送会社を修正できます。
デフォルトの配送業者であるかどうかの設定値を変更できます。

基本スペック

Property	Description
SCOPE	配送の投稿権限 (mall.write_shipping)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

carrier_id
Required

配送会社ID

default_shipping_carrier

基本配送会社かどうか

T:使用する
F:使用しない

DEFAULT T

Request Copy

Response Copy

Delete a shipping carrier cafe24 youtube

DELETE /api/v2/admin/carriers/{carrier_id}

DELETE

特定の配送会社を削除できます。

基本スペック

Property	Description
SCOPE	配送の投稿権限 (mall.write_shipping)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

DEFAULT 1

carrier_id
Required

配送会社ID

delete_default_carrier

LIBSPECDATADELETE.DEFAULT.CARRIER

LIBSPECDATADELETE.DEFAULT.CARRIER.EXAMPLE

DEFAULT F

Request Copy

Response Copy

Shipping

配送(Shipping)はショッピングモールに登録された配送方法に関する機能です。
それぞれの配送方法の詳細を照会することができます。

Endpoints

GET /api/v2/admin/shipping
PUT /api/v2/admin/shipping

Shipping properties

Attribute	Description
shop_no	ショップ番号
shipping_method	配送方法 shipping_01 : 配送 shipping_02 : 速達郵便 shipping_04 : 直接配送 shipping_05 : クイック配送 shipping_06 : その他 shipping_07 : 貨物配送 shipping_08 : 店舗受取 shipping_09 : 配送不要
shipping_etc	その他配送
shipping_type	国内/海外配送設定 A : 国内配送 C : 海外配送 B : 国内/海外配送
international_shipping_fee_criteria	海外送料基準の設定 B：ショップ独自送料 E：自動策定送料(EMS)
shipping_period	配送期間
shipping_fee_type	送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
shipping_fee Max : [999999999]	送料
free_shipping_price Max : [99999999999999]	送料無料の基準金額送料設定 > 購入金額に応じた課金の場合に使用
shipping_fee_by_quantity Max : [999999999]	商品数別送料送料設定 > 商品数量に比例して送料賦課の場合使用
shipping_rates	送料詳細設定
shipping_fee_criteria	送料を適用する注文金額の条件設定 D：割引前の販売価格(推奨) L : 実際の決済金額 A : 割引適用後の決済金額 R : 実際の決済金額の基準
prepaid_shipping_fee	送料の着払い・前払い設定 C：着払い P：前払い B：着払い/前払い
product_weight	商品の重量
oversea_shipping_country	海外配送対象国の制限設定 T：制限する F：制限しない
oversea_shipping_country_list	配送先の国
country_shipping_fee	国別送料設定の使用有無 T：使用する F：使用しない
country_shipping_fee_list	国別送料
international_shipping_insurance	海外配送保険料 T：使用する F：使用しない
return_address	返品先の住所
package_volume	荷物サイズ
wished_delivery_date	配送希望日
wished_delivery_time	配達希望時間
hs_code	HSコード
country_hs_code	国別HSコード
supplier_shipping_fee	供給会社送料を使用するかどうか T：使用する F：使用しない
supplier_selection	공급사 배송비 사용 범위 A : 전체 공급사 P : 특정 공급사
applicable_suppliers	공급사 배송비 사용 공급사
supplier_shipping_calculation	공급사 배송비 계산 기준 A : 전체 상품금액 합계 S : 대표운영자와 공급사 상품 별도 합계
supplier_regional_surcharge	공급사 지역별 배송비 A : 대표 운영자의 지역별 배송료를 부과 S : 공급사 관리자 설정에 따라 부과

Retrieve shipping / return settings cafe24 youtube

GET /api/v2/admin/shipping

GET

ショッピングモールに登録された配送方法に関する情報をリストで照会することができます。
配送方法、配送期間、送料などを照会することができます。

基本スペック

Property	Description
SCOPE	配送の閲覧権限 (mall.read_shipping)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Update store shipping/return settings cafe24 youtube

PUT /api/v2/admin/shipping

PUT

ショッピングモールに登録されている配送方法に関する情報を修正できます。
配送方法、配送期間などを照会することができます。

基本スペック

Property	Description
SCOPE	配送の投稿権限 (mall.write_shipping)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
shipping_method	配送方法 shipping_01 : 配送 shipping_02 : 速達郵便 shipping_04 : 直接配送 shipping_05 : クイック配送 shipping_06 : その他 shipping_07 : 貨物配送 shipping_08 : 店舗受取 shipping_09 : 配送不要
shipping_etc Max Length : [25]	その他配送
shipping_period	配送期間
minimum 期間設定の最小値 maximum 期間設定の最大値
shipping_fee_type	送料タイプ T:送料無料 R:固定送料を使用 M:購入金額によって課金 D:購入金額別送料を使用 W:商品の重量別送料を使用 C:商品の数量別送料を使用 N:商品の数量に比例して送料を課金
shipping_fee Max : [999999999]	送料
free_shipping_price Max : [99999999999999]	送料無料の基準金額
shipping_fee_by_quantity Max : [999999999]	商品数別送料
shipping_rates	送料詳細設定
min_value 基準の最小値 max_value 基準の最大値 shipping_fee 送料
shipping_fee_criteria	送料を適用する注文金額の条件設定 D：割引前の販売価格(推奨) A : 割引適用後の決済金額
prepaid_shipping_fee	送料の着払い・前払い設定 Cafe24管理画面(日本, ベトナム, フィリピン) では使用できません。 C：着払い P：前払い B：着払い/前払い
product_weight Min : [0] Max : [30]	商品の重量
oversea_shipping_country	海外配送対象国の制限設定 T：制限する F：制限しない
oversea_shipping_country_list	配送先の国
country_code 国コード
country_shipping_fee	国別送料設定の使用有無 Cafe24管理画面(日本, ベトナム, フィリピン) では使用できません。 T：使用する F：使用しない
country_shipping_fee_list	国別送料 Cafe24管理画面(日本, ベトナム, フィリピン) では使用できません。
country_code 国コード conditional 送料設定基準 quantity：数量､weight：重量、price：価格 min_value 基準の最小値 max_value 基準の最大値 shipping_fee 送料
international_shipping_insurance	海外配送保険料 Cafe24管理画面(韓国 )でのみ使用できます。 T：使用する F：使用しない
return_address	返品先の住所
zipcode 郵便番号 ziptype 郵便番号を入力する国の設定 address1 基本住所 address2 詳細住所
package_volume	荷物サイズ
width 横 length 縦 height 高さ(H)

Request Copy

Response Copy

Shippingorigins

出庫地管理(Shipping origins)は出庫地に関する情報を管理する機能です。

Endpoints

GET /api/v2/admin/shippingorigins
GET /api/v2/admin/shippingorigins/{origin_code}
POST /api/v2/admin/shippingorigins
PUT /api/v2/admin/shippingorigins/{origin_code}
DELETE /api/v2/admin/shippingorigins/{origin_code}

Shippingorigins properties

Attribute	Description
origin_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	出荷元コード
origin_name Max Length : [50]	出荷元名
default	基本出荷元に設定するかどうか T:使用する F:使用しない
country_code Max Length : [2]	国コード
zipcode Min Length : [2] Max Length : [14]	郵便番号
address1 Max Length : [255]	基本住所
address2 Max Length : [255]	詳細住所
contact	代表連絡先
secondary_contact	緊急連絡先
variants	出荷元の品目情報

Retrieve a list of shipping origins cafe24 youtube

GET /api/v2/admin/shippingorigins

GET

登録された出庫地を一覧で照会することができます。
品目情報は最大100件まで表記されます。

基本スペック

Property	Description
SCOPE	配送の閲覧権限 (mall.read_shipping)
呼び出し件数制限	40

要求スペック

Parameter

Description

offset

Max : [8000]

検索結果の開始位置

DEFAULT 0

limit

Min : [1]~Max : [100]

検索結果の最大件数

DEFAULT 10

Request Copy

Response Copy

Retrieve a shipping origin cafe24 youtube

GET /api/v2/admin/shippingorigins/{origin_code}

GET

登録された出庫地を詳細に照会することができます。
品目情報が100件以降のすべての値が照会されます。

基本スペック

Property	Description
SCOPE	配送の閲覧権限 (mall.read_shipping)
呼び出し件数制限	40

要求スペック

Parameter	Description
origin_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	出荷元コード

Request Copy

Response Copy

Create a shipping origin cafe24 youtube

POST /api/v2/admin/shippingorigins

POST

配送出庫地として活用される出庫地を登録できます。

基本スペック

Property	Description
SCOPE	配送の投稿権限 (mall.write_shipping)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
origin_name Required Max Length : [50]	出荷元名
address1 Required Max Length : [255]	基本住所
address2 Required Max Length : [255]	詳細住所
country_code Required Max Length : [2]	国コード
default	基本出荷元に設定するかどうか T:使用する F:使用しない DEFAULT F
zipcode Min Length : [2] Max Length : [14]	郵便番号
contact Phone Number Max Length : [20]	代表連絡先
secondary_contact Phone Number Max Length : [20]	緊急連絡先

Request Copy

Response Copy

Update a shipping origin cafe24 youtube

PUT /api/v2/admin/shippingorigins/{origin_code}

PUT

配送出庫地として活用される出庫地を登録できます。
配送管理者の活性化時、商品及び品目別の出庫地を設定することができます。

基本スペック

Property	Description
SCOPE	配送の投稿権限 (mall.write_shipping)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
origin_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	出荷元コード
origin_name Max Length : [50]	出荷元名
country_code Max Length : [2]	国コード
default	基本出荷元に設定するかどうか T:使用する F:使用しない
contact Phone Number Max Length : [20]	代表連絡先
secondary_contact Phone Number Max Length : [20]	緊急連絡先
zipcode Min Length : [2] Max Length : [14]	郵便番号
address1 Max Length : [255]	基本住所
address2 Max Length : [255]	詳細住所

Request Copy

Response Copy

Delete a shipping origin cafe24 youtube

DELETE /api/v2/admin/shippingorigins/{origin_code}

DELETE

登録された出庫地を削除できます。
基本出庫地、商品/品目が割り当てられた出庫地は削除できません。

基本スペック

Property	Description
SCOPE	配送の投稿権限 (mall.write_shipping)
呼び出し件数制限	40

要求スペック

Parameter	Description
origin_code Required Type : [A-Z0-9] Length Min : [8]~Max : [8]	出荷元コード

Request Copy

Response Copy

Financials dailysales

日別売上(Financials dailysales)はPG社別、日別売上情報を提供します。
検索条件を満たす売上情報検索が可能です。

Endpoints

GET /api/v2/admin/financials/dailysales

Financials dailysales properties

Attribute	Description
shop_no	ショップ番号
date	日付
payment_amount	決済金額
refund_amount	返金額
sales_count	販売件数

Retrieve a list of daily sales cafe24 youtube

GET /api/v2/admin/financials/dailysales

GET

検索開始日と検索終了日、PG社の情報を利用して、売り上げの情報を照会します。
決済金額、返金金額などの確認ができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	売上統計の閲覧権限 (mall.read_salesreport)
呼び出し件数制限	1

要求スペック

Parameter	Description
start_date Required	検索開始日
end_date Required	検索終了日
payment_gateway_name	決済代行サービス名
partner_id	決済代行会社が発行した加盟店ID
payment_method	決済方法コード card：クレジットカード tcash：口座振込 icash：バーチャル口座 point：前払い cell：キャリア決済

Request Copy

Response Copy

Financials monthlysales

月別売上(Financials monthlysales)はPG社別、月別売上情報を提供します。
検索条件を満たす売上情報検索が可能です。

Endpoints

GET /api/v2/admin/financials/monthlysales

Financials monthlysales properties

Attribute	Description
shop_no	ショップ番号
month	年月
payment_amount	決済金額
refund_amount	返金額
sales_count	販売件数

Retrieve a list of monthly sales cafe24 youtube

GET /api/v2/admin/financials/monthlysales

GET

検索開始月と検索終了月、PG社の情報を利用して、売り上げの情報を照会します。
決済金額、返金金額などの確認ができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	売上統計の閲覧権限 (mall.read_salesreport)
呼び出し件数制限	1

要求スペック

Parameter	Description
start_month Required	検索期間の開始月
end_month Required	検索期間の終了月
payment_gateway_name	決済代行サービス名
partner_id	決済代行会社が発行した加盟店ID
payment_method	決済方法コード card：クレジットカード tcash：口座振込 icash：バーチャル口座 point：前払い cell：キャリア決済

Request Copy

Response Copy

Reports hourlysales

時間単位の精算通計(Reports hourlysales)は、特定の日付と時間を基準として、各種の売り上げについてのデータを照会することができます。

Endpoints

GET /api/v2/admin/reports/hourlysales

Reports hourlysales properties

Attribute	Description
shop_no	ショップ番号
collection_date	精算収集日付
collection_hour	精算収集時間
order_count	注文件数
item_count	品目数
order_price_amount	商品購入金額
order_sale_price	割引金額
shipping_fee	送料
coupon_discount_price	クーポン割引金額
actual_order_amount	実際の決済金額
refund_amount	返金額
sales	純売上高
used_points	ポイント
used_credits	預り金
used_naver_points	Naverポイント
used_naver_cash	Naverキャッシュ
refund_points	返金済みポイント
refund_credits	返金済み預り金
refund_naver_points	返金済みNaverポイント
refund_naver_cash	返金済みNaverキャッシュ

Retrieve hourly sales statistics of a store cafe24 youtube

GET /api/v2/admin/reports/hourlysales

GET

特定の日付と時間を基準として、各種の売り上げに関したデータのリストを閲覧できます。
注文数、品目数、商品購入金額、割引金額などの照会ができます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	売上統計の閲覧権限 (mall.read_salesreport)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
start_date Required Date	検索開始日
end_date Required Date	検索終了日
collection_hour	精算収集時間収集時間を特定して検索 00 ~ 23 までの値を入力できる。
limit Min : [1]~Max : [1000]	検索結果の最大件数 DEFAULT 744
offset Max : [10000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Reports productsales

商品販売通計(Reports productsales)を使用して、商品を基準として販売された通計を照会することができます。

Endpoints

GET /api/v2/admin/reports/productsales

Reports productsales properties

Attribute	Description
shop_no	ショップ番号
collection_date	精算収集日付
collection_hour	精算収集時間
product_no	商品番号
variants_code	品目コード
product_price	商品購入金額
settle_count	決済完了数量
refund_count	返品完了数量
sale_count	販売完了数量
return_product_count	返品完了数量
exchange_product_count	交換完了数量
cancel_product_count	キャンセル完了数量
total_sale_count	累積販売数量
total_cancel_count	累積キャンセル数量

Retrieve hourly product sales statistics of a store cafe24 youtube

GET /api/v2/admin/reports/productsales

GET

商品を基準として、販売の統計を照会することができます。
品目コード、決済完了数量、返金完了数量、累積販売数量などの照会ができます。
特定期間と時間を基準として紹介することもできます。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	売上統計の閲覧権限 (mall.read_salesreport)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
start_date Required Date	検索開始日
end_date Required Date	検索終了日
collection_hour	精算収集時間収集時間を特定して検索 00 ~ 23 までの値を入力できる。
limit Min : [1]~Max : [1000]	検索結果の最大件数 DEFAULT 100
offset Max : [10000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Reports salesvolume

販売数量(SalesVolume)はショップの商品が販売された数量を意味します。販売数量は定期的に集計及びアップデートされるため、リアルタイムで反映されないことがあります。

Endpoints

GET /api/v2/admin/reports/salesvolume

Reports salesvolume properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
collection_date	精算収集日付販売量の統計が収集された収集日
collection_hour	精算収集時間販売量の統計が収集された収集時間
product_price	商品販売価格商品の価格
product_option_price	商品オプション価格品目のオプション追加価格
settle_count	決済完了数量検索期間にその品目の決済が完了した数量
exchane_product_count	交換完了数量検索期間にその品目が交換された数量
cancel_product_count	キャンセル完了数量検索期間にその品目がキャンセルされた数量
return_product_count	返品完了数量検索期間にその品目が返品された数量
updated_date	最終データ更新時間販売数量統計データが更新された時間表示
variants_code	品目コード品目のコード
product_no	商品番号
total_sales	販売件数の合計検索期間にその品目が販売された総数

Retrieve a sales report cafe24 youtube

GET /api/v2/admin/reports/salesvolume

GET

販売数量統計を照会することができます。

基本スペック

Property	Description
SCOPE	売上統計の閲覧権限 (mall.read_salesreport)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
product_no	商品番号商品固有の一連番号。ショップ内で商品番号は重複しない。照会の際、商品番号(product_no)と品目コード(variant_code)のうちいずれか１つは必ず含まなければならない。 ,(コンマ)で複数の件を検索することができる。
variants_code	品目コード販売数量を検索する品目コード照会の際、商品番号(product_no)と品目コード(variant_code)のうちいずれか１つは必ず含まなければならない。
category_no	カテゴリ番号販売数量の中で特定カテゴリで販売された数量の検索
mobile	モバイル/PC 販売数量の中でモバイルウェブで販売された数量の検索 T:モバイル F:その外
delivery_type	配送タイプ販売数量の中で国内または海外配送数量の検索 A:国内 B:海外
group_no	会員ランク番号
supplier_id Max Length : [20]	供給会社のID 販売数量の中で特定の供給会社のIDで登録された数量の検索
start_date Required Date	検索開始日販売数量を検索する検索開始日(決済日) 検索終了日と必ずペアで使用すること。
end_date Required Date	検索終了日販売数量を検索する検索終了日(決済日) 検索開始日と必ずペアで使用すること。

Request Copy

Response Copy

Carts

カート(Carts)は商品を注文する前に一度に注文できるように商品をあらかじめ入れておく機能です。
ショッピングカートリソースでは、Front APIを使用して特定の商品をショッピングカートに入れることができ、Admin APIでは特定の会員のショッピングカートを照会することができます。

Endpoints

GET /api/v2/admin/carts

Carts properties

Attribute	Description
shop_no	ショップ番号
basket_product_no	カート内の商品番号
member_id	会員ID
created_date	追加日
product_no	商品番号
additional_option_values	追加入力オプション
variant_code Type : [A-Z0-9] Length Min : [12]~Max : [12]	商品品目コード
quantity	数量
product_price	商品販売価格
option_price	オプション追加価格
product_bundle	セット商品の有無 T:セット商品 F:セット商品ではない
shipping_type	配送タイプ A:国内 B:海外
category_no	カテゴリ番号

Retrieve a shopping cart cafe24

GET /api/v2/admin/carts

GET

会員カートに入った商品を照会することができます。
一度に複数の会員の買い物かごを照会することができます。
会員ID、入れた日付、商品番号などをご確認いただけます。

基本スペック

Property	Description
SCOPE	個人化情報の閲覧権限 (mall.read_personal)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
member_id Required	会員ID ,(コンマ)で複数の件を検索することができる。
offset Max : [10000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Customers wishlist

Endpoints

GET /api/v2/admin/customers/{member_id}/wishlist/count
GET /api/v2/admin/customers/{member_id}/wishlist

Customers wishlist properties

Attribute	Description
shop_no	ショップ番号
wishlist_no	お気に入り番号
product_no	商品番号
variant_code Type : [A-Z0-9] Length Min : [12]~Max : [12]	品目コード
additional_option	追加入力オプション
attached_file_option	ファイル添付オプション
price	商品販売価格
product_bundle	セット商品の有無
created_date	追加日
price_content Max Length : [20]	販売価格の代替メッセージ

Retrieve a count of products in customer wishlist cafe24

GET /api/v2/admin/customers/{member_id}/wishlist/count

GET

会員のお気に入り商品リストを照会

基本スペック

Property	Description
SCOPE	個人化情報の閲覧権限 (mall.read_personal)
呼び出し件数制限	40

要求スペック

Parameter

Description

member_id
Required

会員ID

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Retrieve a list of products in customer wishlist cafe24

GET /api/v2/admin/customers/{member_id}/wishlist

GET

特定の会員が関心商品として登録した商品をリストで照会することができます。

基本スペック

Property	Description
SCOPE	個人化情報の閲覧権限 (mall.read_personal)
呼び出し件数制限	40

要求スペック

Parameter

Description

member_id
Required

会員ID

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Products carts

Endpoints

GET /api/v2/admin/products/{product_no}/carts/count
GET /api/v2/admin/products/{product_no}/carts

Products carts properties

Attribute	Description
shop_no	ショップ番号
member_id	会員ID
created_date	追加日
product_no	商品番号
variant_code	商品品目コード
quantity	数量
product_bundle	セット商品の有無 T:セット商品 F:セット商品ではない

Retrieve a count of carts containing a product cafe24

GET /api/v2/admin/products/{product_no}/carts/count

GET

特定の商品をカートに入れた会員数を確認できます。

基本スペック

Property	Description
SCOPE	個人化情報の閲覧権限 (mall.read_personal)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

product_no
Required

商品番号

システムにより付与された商品の番号。商品番号はショップ内で重複しない。

Request Copy

Response Copy

Retrieve a list of carts containing a product cafe24

GET /api/v2/admin/products/{product_no}/carts

GET

特定の商品をカートに入れた情報をリストで確認します。
会員ID、収録日などを確認できます。

基本スペック

Property	Description
SCOPE	個人化情報の閲覧権限 (mall.read_personal)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
product_no Required	商品番号
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10
offset Max : [10000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Customersprivacy

「Customersprivacy」は、特定会員の個人情報に対するリソースです。個人情報が流出されないように、使用に注意を払う必要があります。

Endpoints

GET /api/v2/admin/customersprivacy
GET /api/v2/admin/customersprivacy/count
GET /api/v2/admin/customersprivacy/{member_id}
PUT /api/v2/admin/customersprivacy/{member_id}

Customersprivacy properties

Attribute	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号
member_id Max Length : [20]	会員ID
name	お名前会員の名前
name_english	お名前(ローマ字) 会員の名前(ローマ字）
name_phonetic	お名前(フリガナ)(日本語) 会員の名前のフリガナ表記
phone	電話番号会員の固定電話番号
cellphone	電話番号(携帯) 会員の携帯電話番号
email	メールアドレス会員のメールアドレス
sms	SMS SMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。 T:受信する F:受信しない
news_mail	メールマガジン受信の有無Ｅメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。 T:受信する F:受信しない
thirdparty_agree	個人情報の第三者提供に関する同意 T：同意する F：同意しない
wedding_anniversary Date	結婚記念日会員の結婚記念日
birthday Date	誕生日会員の生年月日
solar_calendar	新暦/旧暦誕生日が新暦か旧暦かを表示 T:新暦 F:旧暦
total_points	ポイント合計
available_points	使用可能ポイント
used_points	ポイント利用額
city Max Length : [255]	市区町村
state Max Length : [255]	都道府県
address1 Max Length : [255]	基本住所会員の基本住所(市区町村)
address2 Max Length : [255]	詳細住所会員の詳細住所
group_no	会員ランク番号会員ランクの番号
job_class	職種会員の職種
job	職業会員の職業
zipcode Max Length : [14]	郵便番号
created_date	登録日会員登録した日
member_authentication	会員認証の有無会員認証の設定。認証によって会員は4種類に区分される。認証会員を特別管理会員に設定する場合、その会員は一番最後に設定した特別管理会員として表示される。 T:認証 F:未認証 B:特別管理会員 J:14歳未満の会員
use_blacklist	要注意会員の設定要注意会員に設定。要注意会員の場合はそのタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。 T:設定する F:設定しない
blacklist_type	要注意会員のブロック設定要注意会員のタイプ。要注意会員のタイプによって商品購入ブロックやログインブロック、または商品購入とログインを両方ブロックすることができる。 P:商品購入ブロック L:ログインブロック A:商品購入&ログインブロック
last_login_date	直近のアクセス日時会員が最終ログインした日時
member_authority	会員権限区分会員権限の区分。会員権限は一般会員、代表運営者、副運営者、供給会社に区分される。 C:一般会員 P:代表運営者 A:副運営者 S:供給会社
nick_name Max Length : [50]	運営者ニックネーム会員のニックネーム
recommend_id	紹介者ID 会員登録時に入力した紹介者のID
residence	地域コード会員の居住地域
interest	関心分野会員の関心事
gender	会員の性別
member_type	会員タイプ会員のタイプ p:個人 c:事業者 f:外国人
company_type	事業者区分会員タイプが事業者の場合 p:個人事業者 c:法人事業者
foreigner_type	外国人の認証方法外国人会員の認証方法 f:外国人登録番号 p:パスポート番号 d:国際運転免許証
authentication_method	認証方法 null：未認証 i：I-PIN認証 m：電話番号(携帯)認証 e：メール認証 d：電話番号(携帯)認証(重複確認) a：アプリ認証(その他の認証方法)
lifetime_member	永久会員への切り替えに関する同意の有無 T：同意する F：同意しない
corporate_name	法人名会員の法人名
nationality	国籍会員が「外国人」の場合、その会員の国籍
shop_name	ショップ名会員の商号
country_code	国コード会員登録時に入力した国家
use_mobile_app	スマホアプリ使用の設定会員のモバイルアプリ使用の設定 T:使用する F:使用しない
join_path	会員登録ルート P:PC M：モバイル
fixed_group	会員ランクの固定設定特定会員が会員自動等級変更に適用されないための等級固定可否会員自動等級変更機能を使用するモールでのみ使用できる。 T：固定する F：固定しない
refund_bank_code Max Length : [20]	返金先の銀行コード
refund_bank_account_no Max Length : [40]	返金の口座番号
refund_bank_account_holder	返金先の口座名義
company_condition Max Length : [50]	業態
company_line Max Length : [50]	業種
sns_list	連携中のSNS
account_reactivation_date	休眠会員の解除日
available_credits	使用可能預り金
additional_information	追加項目会員の追加項目会員詳細検索APIでしか確認できない。

Retrieve a list of customer information cafe24 youtube

GET /api/v2/admin/customersprivacy

GET

ショッピングモールに加入した会員をリストで照会します。
会員ID、名前、携帯電話などを照会することができます。

基本スペック

Property	Description
SCOPE	個人情報の閲覧権限 (mall.read_privacy)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
search_type	検索タイプ * Youtube shopping をご利用の場合は提供されません会員検索の際に、会員情報もしくは登録日のうち、どちらかを検索基準に設定して検索することができる。登録日で検索する場合、offsetと関係なくすべての会員を検索することができる。 ※登録日を基準にすると、created_start_dateを除くすべての検索条件は、使用できない。 customer_info : 会員情報に基づいて検索 created_date : 登録日を基準に検索 DEFAULT customer_info
created_start_date Date	登録日を基準に検索する場合の検索開始日 * Youtube shopping をご利用の場合は提供されません search_typeがcreated_dateである場合、登録日基準の検索開始日を意味する。該当登録日以降に登録した会員を検索することができる。
member_id Max Length : [20]	会員ID
news_mail	メールマガジン受信の有無 * Youtube shopping をご利用の場合は提供されませんＥメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。 T:受信する F:受信しない
sms	SMS SMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。 T:受信する F:受信しない
thirdparty_agree	個人情報の第三者提供に関する同意 * Youtube shopping をご利用の場合は提供されません T：同意する F：同意しない
group_no	会員ランク番号 * Youtube shopping をご利用の場合は提供されません会員ランクの番号
search_field	検索フィールド * Youtube shopping をご利用の場合は提供されません検索したい会員の検索フィールド id：会員ID name：氏名 hp：電話番号(携帯) tel：電話番号(固定) mail：メールアドレス shop_name：商号
keyword	検索キーワード * Youtube shopping をご利用の場合は提供されません検索したい会員の検索フィールドに対する検索キーワードを入力する。 ex) search_field : mail keyword : cafe24@cafe24.com ,(コンマ)で複数の件を検索することができる。
date_type	検索日付のタイプ * Youtube shopping をご利用の場合は提供されません検索の基準となる検索フィールド。「会員登録日」基準で検索する場合は検索開始日と検索終了日の期間は会員登録日基準になる。 join：会員登録日 login：最終アクセス日 age：生年月日 account_reactivation：休眠解除日
start_date Date	検索開始日 * Youtube shopping をご利用の場合は提供されません特定の検索基準に対する検索開始日検索終了日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。 ex) 2018-12-31 00:00:00
end_date Date	検索終了日 * Youtube shopping をご利用の場合は提供されません特定の検索基準に対する検索終了日検索開始日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。 ex) 2018-12-31 23:59:59
member_type	会員タイプ * Youtube shopping をご利用の場合は提供されません会員のタイプ vip:特別管理会員 poor:ブラックリスト pointfy:統合メンバーシップ利用者
member_class	会員区分 * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(日本, ベトナム) では使用できません。 p:個人 c:事業者 f:外国人
residence	地域コード * Youtube shopping をご利用の場合は提供されません会員の居住地域 ,(コンマ)で複数の件を検索することができる。
gender	性別 * Youtube shopping をご利用の場合は提供されません会員の性別 M:男性 F:女性
member_authority	会員権限区分 * Youtube shopping をご利用の場合は提供されません会員権限の区分。会員権限は一般会員、代表運営者、副運営者、供給会社に区分される。 C:一般会員 P:代表運営者 A:副運営者 S:供給会社 DEFAULT C
join_path	会員登録ルート * Youtube shopping をご利用の場合は提供されません P:PC M：モバイル
use_mobile_app	スマホアプリ使用の設定 * Youtube shopping をご利用の場合は提供されません T:使用する F:使用しない
fixed_group	会員ランクの固定設定 * Youtube shopping をご利用の場合は提供されません T：固定する F：固定しない
limit Min : [1]~Max : [1000]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 30
offset Max : [8000]	検索結果の開始位置 search_typeがcreated_dateの場合、creted_start_dateを増加させながら全会員を検索できるのでoffsetは使用できない。 DEFAULT 0

Request Copy

Response Copy

Retrieve a count of customer information cafe24 youtube

GET /api/v2/admin/customersprivacy/count

GET

ショッピングモールに加入した会員の数を照会します。

基本スペック

Property	Description
SCOPE	個人情報の閲覧権限 (mall.read_privacy)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
search_type	検索タイプ * Youtube shopping をご利用の場合は提供されません会員検索の際に、会員情報もしくは登録日のうち、どちらかを検索基準に設定して検索することができる。登録日で検索する場合、offsetと関係なくすべての会員を検索することができる。 ※登録日を基準にすると、created_start_dateを除くすべての検索条件は、使用できない。 customer_info : 会員情報に基づいて検索 created_date : 登録日を基準に検索 DEFAULT customer_info
created_start_date Date	登録日を基準に検索する場合の検索開始日 * Youtube shopping をご利用の場合は提供されません search_typeがcreated_dateである場合、登録日基準の検索開始日を意味する。該当登録日以降に登録した会員を検索することができる。
member_id Max Length : [20]	会員ID
news_mail	メールマガジン受信の有無 * Youtube shopping をご利用の場合は提供されませんＥメールを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。 T:受信する F:受信しない
sms	SMS イベントSMSを受信するかどうかを設定。「受信しない」の場合は広告、営利目的以外にサービスに必要な主要メールは正常に受信する。 T:受信する F:受信しない
thirdparty_agree	個人情報の第三者提供に関する同意 * Youtube shopping をご利用の場合は提供されません T：同意する F：同意しない
group_no	会員ランク番号 * Youtube shopping をご利用の場合は提供されません会員ランクの番号
search_field	検索フィールド * Youtube shopping をご利用の場合は提供されません検索したい会員の検索フィールド id：会員ID name：氏名 hp：電話番号(携帯) tel：電話番号(固定) mail：メールアドレス shop_name：商号
keyword	検索キーワード * Youtube shopping をご利用の場合は提供されません ,(コンマ)で複数の件を検索することができる。
date_type	検索日付のタイプ * Youtube shopping をご利用の場合は提供されません join：会員登録日 login：最終アクセス日 age：生年月日 account_reactivation：休眠解除日
start_date Date	検索開始日 * Youtube shopping をご利用の場合は提供されません特定の検索基準に対する検索開始日検索終了日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。 ex) 2018-12-31 00:00:00
end_date Date	検索終了日 * Youtube shopping をご利用の場合は提供されません特定の検索基準に対する検索終了日検索開始日と必ずペアで使用すること。検索開始日と終了日が同じ場合は該当日でのみ検索する。 ex) 2018-12-31 23:59:59
member_type	会員タイプ * Youtube shopping をご利用の場合は提供されません会員のタイプ vip:特別管理会員 poor:ブラックリスト pointfy:統合メンバーシップ利用者
member_class	会員区分 * Youtube shopping をご利用の場合は提供されません Cafe24管理画面(日本, ベトナム) では使用できません。 p:個人 c:事業者 f:外国人
residence	地域コード * Youtube shopping をご利用の場合は提供されません会員の居住地域 ,(コンマ)で複数の件を検索することができる。
gender	性別 * Youtube shopping をご利用の場合は提供されません会員の性別 M:男性 F:女性
member_authority	会員権限区分 * Youtube shopping をご利用の場合は提供されません会員権限の区分。会員権限は一般会員、代表運営者、副運営者、供給会社に区分される。 C:一般会員 P:代表運営者 A:副運営者 S:供給会社 DEFAULT C
join_path	会員登録ルート * Youtube shopping をご利用の場合は提供されません P:PC M：モバイル
use_mobile_app	スマホアプリ使用の設定 * Youtube shopping をご利用の場合は提供されません T:使用する F:使用しない
fixed_group	会員ランクの固定設定 * Youtube shopping をご利用の場合は提供されません T：固定する F：固定しない

Request Copy

Response Copy

Retrieve a customer information cafe24 youtube

GET /api/v2/admin/customersprivacy/{member_id}

GET

会員IDを利用して会員を照会します。
名前、英語名、携帯電話番号、Eメールなどを照会することができます。

基本スペック

Property	Description
SCOPE	個人情報の閲覧権限 (mall.read_privacy)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

ショップ番号

マルチショップを区分するために使うショップ番号

DEFAULT 1

member_id
Required

Max Length : [20]

会員ID

Request Copy

Response Copy

Update a customer information cafe24 youtube

PUT /api/v2/admin/customersprivacy/{member_id}

PUT

会員IDを利用して会員情報を修正します。
SMS受信可否、誕生日、住所などを変更します。

基本スペック

Property	Description
SCOPE	個人情報の投稿権限 (mall.write_privacy)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
member_id Required Max Length : [20]	会員ID
cellphone	電話番号(携帯)
email Email	メールアドレス
sms	SMS T:受信する F:受信しない
news_mail	メールマガジン受信の有無 * Youtube shopping をご利用の場合は提供されません T:受信する F:受信しない
thirdparty_agree	個人情報の第三者提供に関する同意 * Youtube shopping をご利用の場合は提供されません T：同意する F：同意しない
birthday	誕生日 * Youtube shopping をご利用の場合は提供されません
solar_calendar	新暦/旧暦 * Youtube shopping をご利用の場合は提供されません T:新暦 F:旧暦
address1 Max Length : [255]	基本住所 * Youtube shopping をご利用の場合は提供されません
address2 Max Length : [255]	詳細住所 * Youtube shopping をご利用の場合は提供されません
zipcode Max Length : [14]	郵便番号 * Youtube shopping をご利用の場合は提供されません
gender	性別 * Youtube shopping をご利用の場合は提供されません M:男性 F:女性
country_code	国コード * Youtube shopping をご利用の場合は提供されません
additional_information	追加項目 * Youtube shopping をご利用の場合は提供されません
key 追加項目のキー value 追加項目の値
city Max Length : [255]	市区町村 * Youtube shopping をご利用の場合は提供されません
state Max Length : [255]	都道府県 * Youtube shopping をご利用の場合は提供されません
refund_bank_code Max Length : [20]	返金先の銀行コード * Youtube shopping をご利用の場合は提供されません
refund_bank_account_no Max Length : [40]	返金の口座番号 * Youtube shopping をご利用の場合は提供されません
refund_bank_account_holder	返金先の口座名義 * Youtube shopping をご利用の場合は提供されません
fixed_group	会員ランクの固定設定 * Youtube shopping をご利用の場合は提供されません T：固定する F：固定しない

Request Copy

Response Copy

Products wishlist customers

Endpoints

GET /api/v2/admin/products/{product_no}/wishlist/customers
GET /api/v2/admin/products/{product_no}/wishlist/customers/count

Products wishlist customers properties

Attribute	Description
shop_no	ショップ番号
member_id	会員ID

Retrieve a list of customers with a product in wishlist cafe24 youtube

GET /api/v2/admin/products/{product_no}/wishlist/customers

GET

特定の商品を関心商品に盛り込んだ会員のリストを照会することができます。

基本スペック

Property	Description
SCOPE	個人情報の閲覧権限 (mall.read_privacy)
呼び出し件数制限	40

要求スペック

Parameter

Description

product_no
Required

商品番号

商品固有の一連番号。ショップ内で商品番号は重複しない。

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Retrieve a count of customers with a product in wishlist cafe24 youtube

GET /api/v2/admin/products/{product_no}/wishlist/customers/count

GET

商品をお気に入りに追加した会員数を照会します。

基本スペック

Property	Description
SCOPE	個人情報の閲覧権限 (mall.read_privacy)
呼び出し件数制限	40

要求スペック

Parameter

Description

product_no
Required

商品番号

shop_no

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Credits

預り金(Credits)は注文払い戻しの際に払い戻し手段として受け取ることができる現金性資産です。
別途のスコープを持っており、非常に敏感なAPIなので、利用に注意を払う必要があります。

Endpoints

GET /api/v2/admin/credits

Credits properties

Attribute	Description
shop_no	ショップ番号
issue_date	登録日
member_id Max Length : [20]	会員ID
group_name	会員ランク名
increase_amount	付与金額
decrease_amount	差引金額
balance	残額
admin_id	管理者ID
admin_name	管理者名
reason	処理事由
case	預金タイプ
order_id	注文番号

Retrieve a list of credits by date range cafe24

GET /api/v2/admin/credits

GET

預り金をリストで照会します。
会員ID、今の金額、預置金のタイプなどが確認できます。

基本スペック

Property	Description
SCOPE	ポイントの閲覧権限 (mall.read_mileage)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
start_date Required Date	検索開始日
end_date Required Date	検索終了日
type	預り金の増額・減額設定 I：お支払い履歴 D：差引内訳
case	預金タイプ A：注文キャンセル B：預り金で返金 C：商品購入 D：任意の調整 E：現金で返金 G : 充電
admin_id	管理者ID
order_id Order ID	注文番号
search_field	検索フィールド id：ID reason：処理の理由
keyword	検索キーワード
limit Min : [1]~Max : [200]	検索結果の最大件数 DEFAULT 50
offset Max : [10000]	検索結果の開始位置 DEFAULT 0

Request Copy

Response Copy

Credits report

預り金統計(Credit report)は、指定した期間の預り金統計を照会できるリソースです。

Endpoints

GET /api/v2/admin/credits/report

Credits report properties

Attribute	Description
shop_no	ショップ番号
increase_amount	付与金額
decrease_amount	差引金額
credits_total	預り金合計

Retrieve a credit report by date range cafe24

GET /api/v2/admin/credits/report

GET

預置金の統計を照会します。
支払金額、差し引き金額、預置金の合計が確認できます。

基本スペック

Property	Description
SCOPE	ポイントの閲覧権限 (mall.read_mileage)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
start_date Required Date	検索開始日
end_date Required Date	検索終了日
type	預り金の増額・減額設定 I：お支払い履歴 D：差引内訳
case	預金タイプ A：注文キャンセル B：預り金で返金 C：商品購入 D：任意の調整 E：現金で返金 G : 充電
admin_id	管理者ID
search_field	検索フィールド id：ID reason：処理の理由
keyword	検索キーワード

Request Copy

Response Copy

Points

「Mileage(ポイント)」は、特定会員のポイントに関するリソースです。別途のScopeを持っており、商品購入の際に現金のように使用できる重要なAPIであるため、利用に注意を払う必要があります。

Endpoints

GET /api/v2/admin/points
POST /api/v2/admin/points

Points properties

Attribute	Description
shop_no	ショップ番号
case	ポイント付与/差引タイプ
member_id	会員ID
email	メールアドレス
group_name	会員ランク名
available_points_increase	ポイント増額
available_points_decrease	ポイント差引
available_points_total	使用可能ポイント
unavailable_points	仮付与ポイント
order_date	注文日
issue_date	ポイント付与日
available_date	気付与ポイントの使用可能日
admin_id	管理者ID
admin_name	管理者名
order_id	注文番号
reason	付与理由ポイントを増額・減額する理由を入力することができる。
amount	ポイント 1回あたり最大%s以下までポイントを付与することができます。有効ポイントより高い金額を差し引くことはできません。
type	ポイント増額・減額の設定ポイントを増額するか減額するかを選択することができる。

Retrieve points cafe24

GET /api/v2/admin/points

GET

会員の積立金を照会することができます。
支給または差し引かれた積立金それぞれに対してタイプと理由などを照会することができます。

基本スペック

Property	Description
SCOPE	ポイントの閲覧権限 (mall.read_mileage)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
member_id Max Length : [20]	会員ID
email Email	メールアドレス
order_id Max Length : [100]	注文ID
group_no	会員ランク番号
start_date Required Date	検索開始日
end_date Required Date	検索終了日
case	ポイント付与/差引タイプポイントのタイプを指定せずにすべてを照会する場合は、「D：ポイント返金」は照会範囲に入らないため、「ポイントの返金」タイプを照会するには、タイプを指定する必要があります。 A：運営者がポイントを直接付与 B：注文キャンセルによる返金の際に返金額をポイントで付与 C：付与予定ポイントのキャンセル D：返品完了後に使用可能 E：csvファイルで登録された会員 F：注文キャンセルによる商品ポイント差引 G：紹介によって登録した新規会員にポイント付与 H：(既存ポイント履歴向けのレガシータイプ)注文時に会員ランクによるポイントを付与(会員ランク別ポイント) I：注文キャンセルによる会員ランク別ポイント返金 J：注文キャンセルによるクーポンポイント返金 K：注文時に会員ランクによるポイントを付与(会員ランク別ポイント) L：注文時に使用したクーポンによるポイント付与(クーポンポイント) M：商品購入時に使用したポイント N：新規登録時にポイント付与 O：ポイント即時付与クーポン(オンライン/クローズド) P：注文時に購入した商品に対してポイントを付与(購入によるポイント) Q：ショップお気に入り追加ポイント R：新規会員を紹介した既存会員にポイント付与 S：注文をキャンセルした場合購入時に使用したポイントを付与(ポイント復元(注文キャンセル)) T：メルマガ受信に同意した場合のポイント U：ショートカット(リンコン)の作成後にログイン V：被紹介者の注文キャンセル時に感謝ポイントを差引 W：被紹介者の注文による感謝ポイント付与 X：ショートカット(リンコン)からアクセスして商品を購入する場合追加ポイントを付与 Y：(既存ポイント履歴向けのレガシータイプ)注文時に購入した商品に対してポイントを付与(購入ポイント) Z：ショートカットアイコンの作成 AA：ショートカット(リンコン)からアクセスして購入する場合の追加ポイント差引 AB：ポイント失効 AD：会員情報イベント参加によるポイント AE：プラスアプリ注文によるポイント AF：注文キャンセルによるプラスアプリ注文ポイント差引 AG：実店舗で購入 - ポイント使用 AH：実店舗購入キャンセル - 購入時に使用したポイントを復元 AI：イベントファクトリーポイント AK：プラスアプリプッシュ通知ONによるポイント AL：プラスアプリインストールによるポイント AM：APIによるポイント AN：プラスアプリプッシュ受信設定後の特典獲得によるポイント AO：購入確定取消しによるプラスアプリポイントの差引 AP：購入確定取消しによるクーポンポイントの差引 AQ：購入確定取消しによる会員ランク別ポイントの差引 AR：購入確定取消しによる商品ポイントの差引 AS：購入確定取消しによるリンコンポイントの差引 1：SMS + Eメール受信同意によるポイント 2：SMS受信同意によるポイント 3：会員情報修正イベント 4：実店舗購入キャンセル - 購入時に付与したポイントを回収 5：実店舗で購入 - ポイント付与 6：[品目追加]運営者直接付与 [商品]ポイント 7：[品目追加]運営者直接付与 [会員]ポイント 8：[品目交換]運営者直接付与 [商品]ポイント 9：[品目交換]運営者直接付与 [会員]ポイント
points_category	ポイント詳細 Available : 使用可能ポイント unavailable : 仮付与ポイント unavailable_coupon : 会員ランク/クーポンポイント(仮付与) DEFAULT available
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Issue and deduct points cafe24

POST /api/v2/admin/points

POST

会員の積立金の増加、差し引き処理ができます。

基本スペック

Property	Description
SCOPE	ポイントの投稿権限 (mall.write_mileage)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
member_id Required Max Length : [20]	会員ID 会員ID
order_id Order ID	注文番号
amount Required Min : [0]	ポイント 1回あたり最大%s以下までポイントを付与することができます。有効ポイントより高い金額を差し引くことはできません。
type Required	ポイント増額・減額の設定ポイントを増額するか減額するかを選択することができる。 increase：増額 decrease：減額
reason	付与理由ポイントを増額・減額する理由を入力することができる。

Request Copy

Response Copy

Points autoexpiration

ポイント自動満了(Points autoexpiration)はポイントを自動的に満了させることに関連した機能です。
自動満了設定を照会したり、登録·削除することができます。

Endpoints

GET /api/v2/admin/points/autoexpiration
POST /api/v2/admin/points/autoexpiration
DELETE /api/v2/admin/points/autoexpiration

Points autoexpiration properties

Attribute	Description
shop_no	ショップ番号
expiration_date	失効開始日
interval_month	失効実施周期 1：1ヶ月 3：3ヶ月 6：6ヶ月 12：1年
target_period_month	失効対象ポイント 6：失効日から6ヶ月前に付与されたポイント 12：失効日から1年前に付与されたポイント 18：失効日から1年6ヶ月前に付与されたポイント 24：失効日から2年前に付与されたポイント 30：失効日から2年6ヶ月前に付与されたポイント 36：失効日から3年前に付与されたポイント
group_no	失効対象会員ランク 0: すべての会員
standard_point	失効対象基準金額
send_email	メール送信 T：設定する F：設定しない
send_sms	SMS送信 T：設定する F：設定しない
notification_time_day	通知の送信タイミング 3：3日前に送信 7：7日前に送信 15：15日前に送信 30：1ヶ月前に送信

Retrieve an automatic points expiration cafe24

GET /api/v2/admin/points/autoexpiration

GET

ショッピングモールの積立金自動満了設定を照会することができます。

基本スペック

Property	Description
SCOPE	ポイントの閲覧権限 (mall.read_mileage)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Create an automatic points expiration cafe24

POST /api/v2/admin/points/autoexpiration

POST

ショッピングモールのポイント自動満了設定を登録できます。
積立金の最初の消滅施行日と消滅実行周期などを設定できます。

基本スペック

Property	Description
SCOPE	ポイントの投稿権限 (mall.write_mileage)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
expiration_date Required Date	失効開始日
interval_month Required	失効実施周期 1：1ヶ月 3：3ヶ月 6：6ヶ月 12：1年
target_period_month Required	失効対象ポイント 6：失効日から6ヶ月前に付与されたポイント 12：失効日から1年前に付与されたポイント 18：失効日から1年6ヶ月前に付与されたポイント 24：失効日から2年前に付与されたポイント 30：失効日から2年6ヶ月前に付与されたポイント 36：失効日から3年前に付与されたポイント
group_no	失効対象会員ランク 0: すべての会員 DEFAULT 0
standard_point Required Min : [1]	失効対象基準金額消滅する積立金の最低基準金額を入力例）100記載時、100ウォン以上の積立金を保有する会員のみ消滅対象
send_email	メール送信 T：設定する F：設定しない DEFAULT F
send_sms	SMS送信 T：設定する F：設定しない DEFAULT F
notification_time_day	通知の送信タイミング 3：3日前に送信 7：7日前に送信 15：15日前に送信 30：1ヶ月前に送信

Request Copy

Response Copy

Delete an automatic points expiration cafe24

DELETE /api/v2/admin/points/autoexpiration

DELETE

ショッピングモールのポイント自動満了設定を削除できます。

基本スペック

Property	Description
SCOPE	ポイントの投稿権限 (mall.write_mileage)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

Request Copy

Response Copy

Points report

「Points report」は指定した期間のポイント統計を照会できるリソースです。

Endpoints

GET /api/v2/admin/points/report

Points report properties

Attribute	Description
shop_no	ショップ番号
available_points_increase	使用可能ポイント増額
available_points_decrease	使用可能ポイント差引
available_points_total	使用可能ポイント(すべて)
unavailable_points	仮付与ポイント
unavailable_coupon_points	会員/クーポンポイント(仮付与)

Retrieve a points report by date range cafe24

GET /api/v2/admin/points/report

GET

特定期間中の積立金の増減に関する統計を照会することができます。
利用可能な積立金の増加、差し引き、全体を照会することができます。

基本スペック

Property	Description
SCOPE	ポイントの閲覧権限 (mall.read_mileage)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
member_id Max Length : [20]	会員ID
email Email	メールアドレス
group_no	会員ランク番号
start_date Required Date	検索開始日
end_date Required Date	検索終了日

Request Copy

Response Copy

Customers invitation

Endpoints

POST /api/v2/admin/customers/{member_id}/invitation

Customers invitation properties

Attribute	Description
shop_no Min : [1]	ショップ番号
member_id Max Length : [16]	会員ID

Send an invitation to activate account cafe24

POST /api/v2/admin/customers/{member_id}/invitation

POST

SMS、電子メールなどで顧客のアカウントを有効にするための招待メッセージを送信します。
会員ID、アカウント活性化招待手段を必須入力します。

基本スペック

Property	Description
SCOPE	通知の投稿権限 (mall.write_notification)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

member_id
Required

Max Length : [16]

会員ID

invitation_type
Required

アカウント有効化案内方法

Request Copy

Response Copy

Recipientgroups

送信グループ（Recipientgroups）は、大量のメール送信グループを管理する機能です。
送信グループの照会、追加、修正、削除が可能です。

Endpoints

GET /api/v2/admin/recipientgroups
GET /api/v2/admin/recipientgroups/{group_no}
POST /api/v2/admin/recipientgroups
PUT /api/v2/admin/recipientgroups/{group_no}
DELETE /api/v2/admin/recipientgroups/{group_no}

Recipientgroups properties

Attribute	Description
shop_no	ショップ番号
group_no	送信グループ番号
group_name Max Length : [40]	送信グループ名
group_description Max Length : [255]	送信グループの説明
created_date	登録日
group_member_count	送信グループの会員数
news_mail	メールマガジン受信の有無 T：受信する F：受信しない D：受信拒否
sms	SMS T:受信する F:受信しない
member_group_no	会員ランク番号
member_class	会員区分 p:個人 c:事業者 f:外国人
member_type	会員タイプ vip：特別管理会員 poor：要注意会員
join_path	会員登録ルート P:PC M：モバイル
inflow_path	流入経路
inflow_path_detail	流入経路の詳細情報
date_type	検索日付のタイプ join：会員登録日 birthday：誕生日 wedding：結婚記念日 partner：配偶者の誕生日
start_date Date	検索開始日
end_date Date	検索終了日
solar_calendar	新暦/旧暦 T:新暦 F:旧暦
age_min	年齢検索の最小値
age_max	年齢検索の最大値
gender	性別 M:男性 F:女性
available_points_min	ポイント検索の最小値
available_points_max	ポイント検索の最大値
use_mobile_app	スマホアプリ使用の設定 T:使用する F:使用しない
plusapp_member_join	プラスアプリ経由で会員登録した会員かどうか T：使用する F：使用しない

Retrieve distribution group list cafe24

GET /api/v2/admin/recipientgroups

GET

大量メール送信グループのリストを照会できます。

基本スペック

Property	Description
SCOPE	通知の閲覧権限 (mall.read_notification)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

limit

Min : [1]~Max : [100]

検索結果の最大件数

DEFAULT 10

offset

Max : [10000]

検索結果の開始位置

DEFAULT 0

Request Copy

Response Copy

Retrieve distribution group details cafe24

GET /api/v2/admin/recipientgroups/{group_no}

GET

特定の大量メール送信グループの詳細を照会できます。

基本スペック

Property	Description
SCOPE	通知の閲覧権限 (mall.read_notification)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

group_no
Required

Min : [1]

送信グループ番号

Request Copy

Response Copy

Create a distribution group cafe24

POST /api/v2/admin/recipientgroups

POST

大量のメール送信グループを作成できます。

基本スペック

Property	Description
SCOPE	通知の投稿権限 (mall.write_notification)
呼び出し件数制限	30
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
group_name Required Max Length : [40]	送信グループ名
group_description Max Length : [255]	送信グループの説明
news_mail	メールマガジン受信の有無 T：受信する F：受信しない D：受信拒否
sms	SMS T:受信する F:受信しない
member_group_no Min : [1]	会員ランク番号
member_class	会員区分 Cafe24管理画面(日本, ベトナム) では使用できません。 p:個人 c:事業者 f:外国人
member_type	会員タイプ vip：特別管理会員 poor：要注意会員
join_path	会員登録ルート P:PC M：モバイル
inflow_path	流入経路
inflow_path_detail	流入経路の詳細情報
date_type	検索日付のタイプ join：会員登録日 birthday：誕生日 wedding：結婚記念日 partner：配偶者の誕生日
start_date	検索開始日
end_date	検索終了日
solar_calendar	新暦/旧暦 T:新暦 F:旧暦
age_min Min : [1]~Max : [99]	年齢検索の最小値
age_max Min : [1]~Max : [99]	年齢検索の最大値
gender	性別 M:男性 F:女性
available_points_min Min : [0]~Max : [999999999]	ポイント検索の最小値
available_points_max Min : [0]~Max : [999999999]	ポイント検索の最大値
use_mobile_app	スマホアプリ使用の設定 T:使用する F:使用しない
plusapp_member_join	プラスアプリ経由で会員登録した会員かどうか T：使用する F：使用しない

Request Copy

Response Copy

Edit distribution group cafe24

PUT /api/v2/admin/recipientgroups/{group_no}

PUT

特定の大量メール送信グループの情報を修正できます。

基本スペック

Property	Description
SCOPE	通知の投稿権限 (mall.write_notification)
呼び出し件数制限	30
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
group_no Required Min : [1]	送信グループ番号
group_name Required Max Length : [40]	送信グループ名
group_description Max Length : [255]	送信グループの説明
news_mail	メールマガジン受信の有無 T：受信する F：受信しない D：受信拒否
sms	SMS T:受信する F:受信しない
member_group_no Min : [1]	会員ランク番号
member_class	会員区分 Cafe24管理画面(日本, ベトナム) では使用できません。 p:個人 c:事業者 f:外国人
member_type	会員タイプ vip：特別管理会員 poor：要注意会員
join_path	会員登録ルート P:PC M：モバイル
inflow_path	流入経路
inflow_path_detail	流入経路の詳細情報
date_type	検索日付のタイプ join：会員登録日 birthday：誕生日 wedding：結婚記念日 partner：配偶者の誕生日
start_date	検索開始日
end_date	検索終了日
solar_calendar	新暦/旧暦 T:新暦 F:旧暦
age_min Min : [1]~Max : [99]	年齢検索の最小値
age_max Min : [1]~Max : [99]	年齢検索の最大値
gender	性別 M:男性 F:女性
available_points_min Min : [0]~Max : [999999999]	ポイント検索の最小値
available_points_max Min : [0]~Max : [999999999]	ポイント検索の最大値
use_mobile_app	スマホアプリ使用の設定 T:使用する F:使用しない
plusapp_member_join	プラスアプリ経由で会員登録した会員かどうか T：使用する F：使用しない

Request Copy

Response Copy

Delete distribution group cafe24

DELETE /api/v2/admin/recipientgroups/{group_no}

DELETE

特定の大量メール送信グループを削除できます。

基本スペック

Property	Description
SCOPE	通知の投稿権限 (mall.write_notification)
呼び出し件数制限	30

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

group_no
Required

Min : [1]

送信グループ番号

Request Copy

Response Copy

Sms

SMSは、注文・配送などのステータスをSMSで自動送信するサービスです。 SMS APIを使用するためには、ショップで「SMS送信サービス」を申込む必要があります。

Endpoints

POST /api/v2/admin/sms

Sms properties

Attribute	Description
queue_code	Queueコード

Send a SMS cafe24 youtube

POST /api/v2/admin/sms

POST

SMSを送信できます。
**このAPIは韓国語ショッピングモールでのみ使用できます。

基本スペック

Property	Description
SCOPE	通知の投稿権限 (mall.write_notification)
呼び出し件数制限	1
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no	ショップ番号 DEFAULT 1
sender_no Required	送信者ID 送信者の固有一連番号
content Required	メッセージ
recipients Array Max : [100]	受信者番号
member_id Array Max : [100]	会員ID
group_no	会員ランク番号 0：すべてのランク
exclude_unsubscriber	受信拒否した人の送信除外設定受信拒否した人を除いて送信するかどうかを設定できる。 T : 除く F : 含む DEFAULT T
type	送信タイプ SMSの送信タイプ SMSは1通あたり最大90byteまで入力でき、90byteを超える場合には複数通に分けて送信する。 LMSは1通あたり最大2000byteまで入力できる。 SMS : 短文　LMS : 長文 DEFAULT SMS
title	タイトル

Request Copy

Response Copy

Sms balance

Endpoints

GET /api/v2/admin/sms/balance

Sms balance properties

Attribute	Description
balance	SMSの残り件数
sms_count	短文メッセージ(SMS)の送信可能件数
lms_count	長文メッセージ(LMS)の送信可能件数

Retrieve the SMS balance cafe24 youtube

GET /api/v2/admin/sms/balance

GET

基本スペック

Property	Description
SCOPE	通知の閲覧権限 (mall.read_notification)
呼び出し件数制限	40

Request Copy

Response Copy

Sms senders

SMS送信者(Senders)は、SMSを送信する発信番号を意味します。 SMS送信者はSMSに属しているサブリソースです。

Endpoints

GET /api/v2/admin/sms/senders

Sms senders properties

Attribute

Description

sender_no

送信者ID

送信者の固有一連番号

sender

送信者番号

送信者の電話番号

auth_status

認証状態

送信者の電話番号の認証状態
認証完了した送信者に対してのみ、SMSを送信することができる。

00 : 削除 10 : 登録 20 : 審査中 30 : 認証完了 40 : 返上

Retrieve a list of SMS senders cafe24 youtube

GET /api/v2/admin/sms/senders

GET

ショッピングモールに登録されたSMS発信者をリストで照会することができます。
該当APIは韓国語ショッピングモールでのみ使用可能です。

基本スペック

Property	Description
SCOPE	通知の閲覧権限 (mall.read_notification)
呼び出し件数制限	40

要求スペック

Parameter

Description

offset

Max : [8000]

検索結果の開始位置

DEFAULT 0

limit

Min : [1]~Max : [100]

検索結果の最大件数

検索したい最大件数を指定することができる。
例)10を入力すると10件まで表示

DEFAULT 10

Request Copy

Response Copy

Translations categories

商品分類翻訳情報（Translations categories）は、商品分類の翻訳情報を照会したり修正することができる機能です。

Endpoints

GET /api/v2/admin/translations/categories
PUT /api/v2/admin/translations/categories/{category_no}

Translations categories properties

Attribute	Description
shop_no	ショップ番号
category_no	カテゴリ番号
translations	번역 정보

Retrieve a list of product category translations cafe24

GET /api/v2/admin/translations/categories

GET

商品分類の翻訳情報を照会することができます。
言語コード、メタタグなどの情報を照会することができます。

基本スペック

Property	Description
SCOPE	翻訳の閲覧権限 (mall.read_translation)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
category_no	カテゴリ番号 ,(コンマ)で複数の件を検索することができる。
language_code	言語コード翻訳情報の言語コードに該当する翻訳情報を検索言語別に翻訳された情報から検索したい言語を選択すると、その言語に対する翻訳内容を確認できます。 ,(コンマ)で複数の件を検索することができる。
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Update product category translation cafe24

PUT /api/v2/admin/translations/categories/{category_no}

PUT

商品分類の翻訳情報を修正できます。
翻訳情報の修正時、言語コードは必須入力項目です。

基本スペック

Property	Description
SCOPE	翻訳の投稿権限 (mall.write_translation)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
category_no Required	カテゴリ番号
translations	번역 정보
language_code Required 言語コード category_name カテゴリ名 seo Array meta_title ブラウザでのタイトル meta_author メタタグ1:Author meta_description メタタグ2:Description meta_keywords メタタグ3:Keywords

Request Copy

Response Copy

Translations products

商品翻訳情報（Translations products）は、商品の翻訳情報を照会したり修正したりできる機能です。

Endpoints

GET /api/v2/admin/translations/products
PUT /api/v2/admin/translations/products/{product_no}

Translations products properties

Attribute	Description
shop_no	ショップ番号
product_no	商品番号
product_name Max Length : [250]	商品名
translations	번역 정보

Retrieve a list of product translations cafe24 youtube

GET /api/v2/admin/translations/products

GET

商品の翻訳情報を照会することができます。

基本スペック

Property	Description
SCOPE	翻訳の閲覧権限 (mall.read_translation)
呼び出し件数制限	40

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
product_no	商品番号 ,(コンマ)で複数の件を検索することができる。
product_name	商品名商品名に該当する翻訳情報を検索 ,(コンマ)で複数の件を検索することができる。
language_code	言語コード翻訳情報の言語コードに該当する翻訳情報を検索言語別に翻訳された情報から検索したい言語を選択すると、その言語に対する翻訳内容を確認できます。 ,(コンマ)で複数の件を検索することができる。
offset Max : [8000]	検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数 DEFAULT 10

Request Copy

Response Copy

Update product translation cafe24 youtube

PUT /api/v2/admin/translations/products/{product_no}

PUT

商品の翻訳情報を修正できます。
翻訳情報の修正時、言語コードは必須入力項目です。

基本スペック

Property	Description
SCOPE	翻訳の投稿権限 (mall.write_translation)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
shop_no Min : [1]	ショップ番号 DEFAULT 1
product_no Required	商品番号
translations	번역 정보
language_code Required 言語コード product_name 商品名 product_tag 商品検索キーワード payment_info 商品決済ガイド shipping_info 商品配送ガイド exchange_info 交換・返品ガイド service_info サービスに関するお問い合わせ/ガイド summary_description 商品要約説明 simple_description 商品簡略説明 description 商品詳細説明 mobile_description モバイル商品詳細説明 product_material 商品素材 seo Array meta_title ブラウザでのタイトル meta_author メタタグ1:Author meta_description メタタグ2:Description meta_keywords メタタグ3:Keywords meta_alt 商品画像のalt属性 options Array name オプション名 value オプション値

Request Copy

Response Copy

Translations store

ショップ翻訳情報(Translations store)は、ショップの翻訳情報を照会したり修正したりできる機能です。

Endpoints

GET /api/v2/admin/translations/store
PUT /api/v2/admin/translations/store

Translations store properties

Attribute	Description
shop_no	ショップ番号
translations	翻訳データ

Retrieve a list of store translations cafe24

GET /api/v2/admin/translations/store

GET

ショップの翻訳情報を照会することができます。

基本スペック

Property	Description
SCOPE	翻訳の閲覧権限 (mall.read_translation)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

language_code

言語コード

言語別に翻訳された情報から検索したい言語を選択すると、その言語に対する翻訳内容を確認できます。

,(コンマ)で複数の件を検索することができる。

Request Copy

Response Copy

Update the translations of a store cafe24

PUT /api/v2/admin/translations/store

PUT

ショップの翻訳情報を修正できます。
翻訳情報の修正時、言語コードは必須入力項目です。

基本スペック

Property	Description
SCOPE	翻訳の投稿権限 (mall.write_translation)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

translations

翻訳データ

language_code
Required
言語コード

shop_name
ショップ名

company_name
商号

company_registration_no
事業者登録番号

president_name
代表者名

phone
電話番号

email
メールアドレス

fax
ファックス番号

zipcode
郵便番号

address1
基本住所

address2
詳細住所

customer_service_phone
お客様サポートの電話番号(相談/注文）

customer_service_hours
お客様サポートの運営時間

privacy_officer_name
個人情報保護責任者名

privacy_officer_email
個人情報保護責任者のメールアドレス

Request Copy

Response Copy

Translations themes

テーマ翻訳情報(Translations themes)は、多言語コード化されたデザインスキンに搭載された翻訳情報を照会したり修正することができる機能です。

Endpoints

GET /api/v2/admin/translations/themes
GET /api/v2/admin/translations/themes/{skin_no}
PUT /api/v2/admin/translations/themes/{skin_no}

Translations themes properties

Attribute	Description
skin_no	デザイン番号
translations	翻訳情報
skin_code	デザインコード
skin_translation	デザイン翻訳情報

Retrieve a list of theme translations cafe24

GET /api/v2/admin/translations/themes

GET

デザインのデザイン翻訳情報を照会することができます。

基本スペック

Property	Description
SCOPE	翻訳の閲覧権限 (mall.read_translation)
呼び出し件数制限	40

Request Copy

Response Copy

Retrieve a theme translation cafe24

GET /api/v2/admin/translations/themes/{skin_no}

GET

特定のデザインのデザイン翻訳情報を照会することができます。

基本スペック

Property	Description
SCOPE	翻訳の閲覧権限 (mall.read_translation)
呼び出し件数制限	40

要求スペック

Parameter	Description
skin_no Required	デザイン番号
language_code Required	言語コード

Request Copy

Response Copy

Update a theme translation cafe24

PUT /api/v2/admin/translations/themes/{skin_no}

PUT

特定のデザインのデザイン翻訳情報を修正できます。
デザイン翻訳情報の修正時、言語コードとソースコードは必須入力項目です。

基本スペック

Property	Description
SCOPE	翻訳の投稿権限 (mall.write_translation)
呼び出し件数制限	40
1回当たり申込件数の制限	1

要求スペック

Parameter	Description
skin_no Required	デザイン番号
skin_translation	デザイン翻訳情報
language_code Required 言語コード source Required ソースコード

Request Copy

Response Copy

Financials dailyvisits

日別訪問数(Financials dailyvisits)は検索期間内の日別訪問数を提供します。

Endpoints

GET /api/v2/admin/financials/dailyvisits

Financials dailyvisits properties

Attribute	Description
shop_no	ショップ番号
date	日付
visitors_count	アクセス数

Retrieve a count of dailyvisits cafe24

GET /api/v2/admin/financials/dailyvisits

GET

検索期間内の日替わり訪問数を照会します。

本APIは特定のクライアントでのみ使用が可能です。本APIの使用をご希望の場合、Cafe24 Developersまでお問い合わせください。

基本スペック

Property	Description
SCOPE	アクセス分析の閲覧権限 (mall.read_analytics)
呼び出し件数制限	40

要求スペック

Parameter

Description

shop_no

Min : [1]

ショップ番号

DEFAULT 1

start_date
Required

Date

検索開始日

end_date
Required

Date

検索終了日

Request Copy

Response Copy

Parameter	Description
shop_no	ショップ番号マルチショップを区分するために使うショップ番号 DEFAULT 1
category_depth Min : [1]~Max : [4]	カテゴリdepth 検索したい商品カテゴリの次数検索
category_no	カテゴリ番号検索したい商品カテゴリの番号
parent_category_no	親カテゴリ番号検索したい商品カテゴリの親商品カテゴリ番号検索大カテゴリのみ検索したい場合はparent_category_no =1で検索する。
category_name	カテゴリ名検索キーワードがカテゴリ名に含まれている商品カテゴリ検索(大文字・小文字を区別しない)
offset Max : [8000]	検索結果の開始位置検索結果の開始位置 DEFAULT 0
limit Min : [1]~Max : [100]	検索結果の最大件数検索したい最大件数を指定することができる。例)10を入力すると10件まで表示 DEFAULT 10

Store

Product

Order

Customer

Community

Design

Promotion

Application

Category

Collection

Supply

Shipping

Salesreport

Personal

Privacy

Mileage

Notification

Translation

Analytics

non-print

API Index

Introduction

Cafe24 API

API Diagram

Request/Response Format

Method

Admin API Intro

API Status Code

How to use GET API

1. 検索条件の追加

2. カンマ(，)を使用した複数の値の検索

3. 越境ECショップ情報の検索

4. 詳細検索と単独(1件)検索

5. Pagination

6. 特定項目の検索

7. サブリソースの検索

API Limit

Versioning

Authentication

Get Authentication Code

Get Access Token

Get Access Token using refresh token

Revoke Access Token

Store

Activitylogs

Activitylogs properties

Retrieve a list of action logs cafe24

GET

基本スペック

要求スペック

Retrieve an action log cafe24

GET

基本スペック

要求スペック

Automessages arguments

Automessages arguments properties

Retrieve the list of available variables for automated messages cafe24 youtube

GET

基本スペック

要求スペック

Automessages setting

Automessages setting properties

Retrieve the automated message settings cafe24 youtube

GET

基本スペック

要求スペック

Update an automated message cafe24 youtube

PUT

基本スペック

要求スペック

Coupons setting

Coupons setting properties

Retrieve coupon settings cafe24

GET

基本スペック

要求スペック

Update coupon settings cafe24

PUT

基本スペック

要求スペック