商品API

  商品API

制限事項

商品情報取得APIを利用する際は下記制限事項が適用されます。

  1. APIの実行処理結果を待たずに連続して呼び出さないでください(複数回呼び出す場合、必ず直列呼び出しとする)。

前提条件

商品情報取得APIを利用するためには以下の条件を満たす必要があります。

  1. 商品データ連携機能の利用制限が解除されている必要があります。
  2. 商品データ連携設定画面で認証コードを発行、設定を保存している必要があります。
  3. HTTPSプロトコル(SSL)を使用して通信を行います。SNIにご対応ください。

ご利用前の準備

商品データ連携設定画面で商品情報取得APIを利用するための設定を行います。

設定画面


設定画面

No 項目名 説明
1 商品データ連携設定メニュー 商品データ連携設定画面に遷移します。
2 認証コード 発行ボタン押下でアクセスURL発行時に利用する新しい認証コードを発行し、入力不可のテキスト領域に認証コードを表示します。
発行ボタン押下で認証コードを発行し、入力不可のテキスト領域に認証コードを表示します。  

保存ボタンが押下されるまでは発行した認証コードを保存しません。
一度も保存を行っていない場合は認証を行えないため、商品情報取得APIの各機能を利用できません。

認証コードの登録の有無により発行ボタンの文言が切り替わります。
認証コードが保存されていない場合は「発行」を表示、認証コードが保存されている場合は「再発行」を表示。

3 保存ボタン 上記で設定された商品データ連携の設定を保存します。
認証コードが発行されていない状態では設定を保存することができません。
認証コードが未発行の状態では商品情報取得APIの各機能を利用できません。

商品情報取得API利用時の処理フロー

以下が商品情報取得API利用時の概略図です。

概略図

API動作

商品情報取得APIでは以下の共通の仕様があります。

  • レスポンスの応答形式はXML形式とJSON形式から選択できます。
  • レスポンスの応答形式が未指定の場合はXML形式を適用します。
  • パラメータ送信時の文字コードはUTF-8を利用してください。
  • 商品情報取得APIを利用するための前提条件を満たしていない場合はHEADERレスポンスのみを返却します。
  • 商品情報取得APIに送信するパラメータ値にはURLエンコードを行ってください。
  • レスポンスの応答形式がXMLの場合、商品情報取得APIからURLエンコードを行った値を返却するため、レスポンス取得時にURLデコードを行ってください。

アクセスURL発行APIの仕様

商品データ連携機能設定画面で発行した認証コードと呼び出す機能を指定し、各商品情報取得APIにアクセスするためのURLを発行する機能です。

アクセスURL発行APIには下記URLに対して、POSTメソッドでパラメータを送信してください。

リクエストURL

https://www.makeshop.jp/api/product/auth/

返却されたアクセスURLの例

https://www.makeshop.jp/API/product/search/?shop_id=flowershop2015&access_token=7efc686ff0e9d79eff72cefc4bc1f563
  • 新規発行するアクセスURLの有効期限は5分です。

送信パラメータ

No 項目名 パラメータ名 必須 属性 文字数 説明
1 ショップID shop_id 半角英数字 4~12 makeshopの管理画面ログイン時に利用するショップID
例)shoptest
2 認証コード auth_code 半角英数字 32 makeshop管理画面で発行、登録した認証コード
例)85fabea79e90eb2b8cf51c326899252c
3 実行API process 半角英数字 6 search:商品情報取得API実行時に指定
例)search
  • ○:必須項目

戻りパラメータ

No 項目名 パラメータ名 必須 属性 文字数 説明
1 アクセスURL access_url △※1 半角英数字 初回発行時より5分間有効となるURL
※アクセストークンが付与されています。
2 有効期限 expire_date △※1 半角数値 14 アクセスURLの有効期限
YYYYMMDDHHMMSS形式
  • ○:機能を利用できる場合、必ず返却する。
  • △:項目パラメータのキー値は必ず返却するが、条件により値が空になる。
  • ※1 送信パラメータを利用した認証に成功した場合、返却する。(認証エラーが発生した場合は空の値を返却)

エラーメッセージ

No ステータスコード 種別 区分
1 200 正常
2 E01 異常 認証エラー
3 E02 異常 不正操作
4 E03 異常 入力チェックエラー
5 E99 異常 システムエラー

XML形式のサンプルレスポンス

<?xml version="1.0" encoding="utf-8"?>
<result_data>
    <status_code>200</status_code>
    <access_url>https://www.makeshop.jp/api/product/search/?shop_id=test&access_token=2af8d4ba3457106d012431fc9deb1426</access_url>
    <expire_date>20141014235959</expire_date>
    <error_message/>
</result_data>

JSON形式のサンプルレスポンス

{"result_data":{"status_code":"200","access_url":"https://www.makeshop.jp/api/product/search/?shop_id=test&access_token=2af8d4ba3457106d012431fc9deb1426","expire_date":"20141014235959"}}
  • JSON形式のレスポンスも上記XMLのレスポンスと同等です(result_data配下に各データを格納して返却します)。

商品情報取得APIの仕様

商品情報を検索する機能です。

  • 商品情報取得APIにアクセスする為のURLはアクセスURL発行APIを実行し、取得してください。
  • アクセスURL発行APIの実行結果より取得したURLに対し、POSTメソッドでパラメータを送信してください。
  • ソート順が未指定の場合は商品登録日の昇順でソートした結果を返却します。
  • 商品情報取得API実行で一度に返却可能な商品情報の件数は50件です。50件を超える商品情報の一覧を取得する場合は表示ページを指定してください。
  • 該当する商品によって出力される項目が異なります。
    システム商品コードを指定した場合:すべての商品情報を出力
    上記以外:一部の商品情報を出力

送信パラメータ

No 項目名 パラメータ名 必須 属性 文字数 説明
1 アクセストークン access_token 半角英数字 アクセスURL発行で発行されるURLに付与されているパラメータです。
書き換えないようにしてください。
85fabea79e90eb2b
8cf51c326899252c
2 システム商品コード brand_code   半角数値 12 完全一致した商品情報が検索結果として表示されます。 2000000019
3 独自商品コード ubrand_code   文字列 50(25) 完全一致した商品情報が検索結果として表示されます。 ESAM1500DK
4 カテゴリーコード category_code   文字列 32 完全一致したカテゴリーの商品が検索結果として表示されます。 ct25
5 ※最終更新日(from) last_update_from   半角数字 8 指定した
最終更新日(form) <= 商品の最終更新日
に一致する商品が検索結果として表示されます。
20140501
6 ※最終更新日(to) last_update_to   半角数字 8 指定した
最終更新日(to) >= 商品の最終更新日
に一致する商品が検索結果として表示されます。
20140701
7 表示ページ display_page   半角数値 検索結果が1回のレスポンスで返却出来ない場合にページを指定 30
8 表示件数 limit_per_page   半角数値 2 1ページあたりの件数を指定
1~50まで指定可能
20
9 ソート順 sort_order   半角数値 1 出力内容の表示順序を指定します。
未指定の場合は『7(更新日の新しい順)』として処理します。
0 … 商品名昇順
1 … 商品名降順
2 … 価格が安い順
3 … 価格が高い順
4 … 登録日の古い順
5 … 登録日の新しい順
6 … 更新日が古い順
7 … 更新日が新しい順(初期値)
5
10 レスポンス形式 response_format 半角英数字 xml:XML形式でレスポンスを返却
json:JSON形式でレスポンスを返却
未指定時はXML形式でレスポンスを返却
xml
  • ○:必須項目
  • ※必ず共通パラメータも含めてください
  • ※最終更新日:商品登録日/更新日のいずれかの新しい日付

戻りパラメータ

No 項目名 パラメータ名 必須 有料オプション 属性 文字数 説明
1 ルート(ノード) result_data  
2 ステータスコード status_code 半角英数字  
3 エラーメッセージ message 全半角文字  
4 検索結果の商品件数 total_count 半角数字  
5 商品情報の開始行数 dispay_record_from 半角数字  
6 商品情報の終了行数 dispay_record_to 半角数字  
7 商品情報(ノード) product_list  
8 商品情報(ノード) product 複数ノードあり
9 商品登録日時 created_date 半角数字 14 YYYYMMDDhhmmss
10 商品更新日時 modified_date 半角数字 14 YYYYMMDDhhmmss
11 商品ID product_id 半角数字 10  
12 システム商品コード brand_code 半角数字 12  
13 独自商品コード ubrand_code 全半角文字 50  
14 商品表示可否 is_display 半角英字 1 Y/N
Y:表示する
N:表示しない
15 会員専用設定 is_member_only 半角英字 1 オプション機能が有効な場合に出力する。
Y/N
Y:会員専用商品である
N:会員専用商品でない
16 表示可能な会員グループ名 displayable_member_groups 全半角文字 オプション機能が有効な場合に出力する。会員グループ名をパイプ区切りで出力する。
17 基本カテゴリー(ノード) basic_category 基本カテゴリーが設定されている場合に、下階層ノードの情報を出力する。
18 カテゴリー識別コード category_code 半角英数字 32  
19 カテゴリーパス category_path 全半角文字 カテゴリー名を階層で¥(円マーク)区切りで出力する。
20 カテゴリー(ノード) categories カテゴリーが設定されている場合に、下階層ノードの情報を出力する。
21 カテゴリー(ノード) category 複数ノードあり
22 カテゴリー識別コード category_code 半角英数字 32  
23 カテゴリーパス category_path 全半角文字 カテゴリー名を階層で¥(円マーク)区切りで出力する。
24 商品名 product_name 全半角文字 255  
25 重量 weight 半角数字 6  
26 販売価格 price 半角数字 9  
27 消費税率 consumption_tax_rate 半角数字 5  
28 軽減税率対象 is_reduced_tax_rate_brand 半角文字 1 Y/N
Y:軽減税率対象である
N:軽減税率対象でない
29 ポイント point 半角文字 10 半角数字 9文字
「数値+%」で料率
30 会員グループ別価格(ノード) member_group_prices オプション機能が有効な場合に出力する。
また会員グループ別価格が設定されている場合に、下階層ノードの情報を出力する。
31 会員グループ別価格(ノード) member_group_price 複数ノードあり
32 会員グループID group_id 半角数字 10  
33 会員グループ名 group_name 全半角文字 40  
34 会員グループ別価格 price 半角数字 9  
35 会員グループ別ポイント point 半角数字 9  
36 ポイントの種別 point_type 半角数字 1 0/1
0:ポイントの絶対値
1:価格に対する料率
37 定価 fixed_price 半角数字 9  
38 仕入価格 purchase_price 半角数字 9  
39 JANコード jancode 半角数字 13  
40 製造元 vendor 全半角文字 40  
41 原産地 origin 全半角文字 40  
42 原産地表示フラグ is_display_origin 半角数字 1 0/1
0:原産地を表示する
1:しない
43 数量 stock 半角数字 9  
44 数量表示フラグ is_diplay_stock 半角数字 1 0/1
0:在庫数を表示しない
1:する
45 最小注文限度数 minimum_quantity 半角数字 7  
46 最大注文限度数 maximum_quantity 半角数字 7  
47 陳列位置 collections 半角数字 1 0/1/2/3/4
0:なし
1:新商品
2:スペシャル商品
3:おすすめ
4:カテゴリーおすすめ商品
48 送料個別設定 individual_shipping 半角数字 14 配送業者コードを出力する。
49 掲載開始日指定フラグ is_publish_date_from 半角数字 1 0/1
0:掲載開始日を設定しない
1:掲載開始日を設定する
50 掲載開始日 publish_date_from 半角数字 10 YYYYMMDDHH
51 掲載終了日指定フラグ is_publish_date_to 半角数字 1 0/1
0:掲載終了日を設定しない
1:掲載終了日を設定する
52 掲載終了日 publish_date_to 半角数字 10 YYYYMMDDHH
53 掲載期間外表示可否 is_display_out_of_publish_period 半角数字 1 0/1
0:掲載期間外の商品を表示しない
1:掲載期間外の商品を表示する
54 割引使用フラグ is_discount_rate 半角数字 1 0/1
0:割引を有効にする
1:しない
55 割引率 discount_rate 半角文字 2 半角数字 2文字
1~99
「数値+%」で料率
56 割引期間 discount_term 半角文字 17 YYYYMMDDhhmm-YYYYMMDDhhmm
57 商品グループ item_group 半角英数字 14  
58 商品検索語 search_keyword 全半角文字 100  
59 商品別特殊表示 note 全半角文字 200  
60 オプション(ノード) option 商品オプションが設定されている場合に、下階層ノードの情報を出力する。
61 オプション名1 option_name1 全半角文字 40  
62 オプション名2 option_name2 全半角文字 40  
63 オプションアイテム1(ノード) option_name1_items  
64 オプションアイテム1(ノード) item 複数ノードあり
65 選択肢ID item_id 半角数字 11  
66 選択項目名 item_name 全半角文字 64  
67 初期選択 default 半角英字 1 Y/N
Y:初期表示で選択する
N:初期表示で選択しない
68 オプションアイテム2(ノード) option_name2_items  
69 オプションアイテム2(ノード) item 複数ノードあり
70 選択肢ID item_id 半角数字 11  
71 選択項目名 item_name 全半角文字 64  
72 初期選択 default 半角英字 1 Y/N
Y:初期表示で選択する
N:初期表示で選択しない
73 オプション選択(ノード) select_options  
74 オプション選択(ノード) select_option 複数ノードあり
75 ID option_id 半角文字 23 [オプション1ノードの選択肢ID]_[オプション2ノードの選択肢ID]
76 オプション独自コード option_ubrand_code 全半角文字 100  
77 販売価格 price 半角数字 9  
78 在庫数 stock 半角数字 9  
79 JANコード jancode 半角数字 13  
80 会員グループ別価格(ノード) member_group_prices オプション機能が有効な場合に出力する。
また会員グループ別価格が設定されている場合に、下階層ノードの情報を出力する。
81 会員グループ別価格(ノード) member_group_price 複数ノードあり
82 会員グループID group_id 半角数字 10  
83 会員グループ名 group_name 全半角文字 40  
84 販売価格 price 半角数字 9  
85 オプション画像URL image_url 半角文字 オプション画像のURL
86 オプション画像サムネイルURL thumbnail_image_url 半角文字 オプション画像のサムネイルのURL
87 オプショングループ(ノード) option_group オプショングループが設定されている場合に、下階層ノードの情報を出力する。
88 オプショングループコード group_code 半角文字 7 [SP****]
(****は半角数字4桁)
89 オプショングループ名 group_name 全半角文字 200  
90 オプショングループアイテム(ノード) group_item 複数ノードあり
91 オプションID option_id 半角数字 2  
92 オプション名 option_name 全半角文字 100  
93 必須 is_required 半角英字 1 Y/N
Y:必須入力
N:任意入力
94 アイテム(ノード) item 複数ノードあり
95 アイテムID item_id 半角数字 3  
96 アイテム名 item_name 全半角文字 100  
97 固定・料率 price_type 半角数字 1 0/1
0:金額で指定する
1:販売価格に応じた料率で指定する
98 金額 price 半角数字 9  
99 初期表示 default 半角英字 1 Y/N
Y:初期表示で選択する
N:初期表示で選択しない
100 名入れグループ(ノード) name_option_group 名入れグループが設定されている場合に、下階層ノードの情報を出力する。
101 名入れグループID group_id 半角数字 10  
102 名入れグループ名 group_label 全半角文字 40  
103 名入れグループ説明文 group_discription 全半角文字  
104 名入れ項目(ノード) group_item 複数ノードあり
105 アイテムID item_id 半角数字 3  
106 管理者用項目名 admin_item_name 全半角文字 40  
107 表示用項目名 display_item_name 全半角文字 40  
108 選択・必須 is_required 半角英字 1 Y/N
Y:必須入力
N:任意入力
109 入力値制限(ノード) validation  
110 半角アルファベット is_alphabet 半角英字 1 Y/N
Y:入力可
N:入力不可
111 半角数字 is_number 半角英字 1 Y/N
Y:入力可
N:入力不可
112 半角記号 is_symbol 半角英字 1 Y/N
Y:入力可
N:入力不可
113 全角文字 is_double_byte 半角英字 1 Y/N
Y:入力可
N:入力不可
114 入力項目設定(ノード) input_size_setting  
115 一行の文字数 row_maxlength 半角数字 2  
116 行数 maxrow 半角数字 1  
117 最大文字数 maxlength 半角数字 2  
118 商品ページURL product_page_url 半角文字 商品詳細ページのURL
http://ショップURL/~
119 拡大画像URL zoom_image_url 半角文字 拡大画像のURL
http://ショップURL/~
※複数商品画像は表示されません。
120 普通画像URL image_url 半角文字 普通画像のURL
http://ショップURL/~
※複数商品画像は表示されません。
121 縮小画像URL thumbnail_image_url 半角文字 縮小画像のURL
http://ショップURL/~
122 モバイル画像URL mobile_image_url 半角文字 モバイル画像のURL
http://ショップURL/~
123 追加商品画像1 sub_image1_url 半角文字 追加商品画像1のURL
http://ショップURL/~
124 追加商品画像モバイル表示1 is_display_mobile_sub_image1 半角数字 1 0/1
0:追加商品画像1をモバイルに表示する
1:しない
125 画像説明文1 sub_image1_content 全半角文字  
126 追加商品画像2 sub_image2_url 半角文字 追加商品画像2のURL
http://ショップURL/~
127 追加商品画像モバイル表示2 is_display_mobile_sub_image2 半角数字 1 0/1
0:追加商品画像2をモバイルに表示する
1:しない
128 画像説明文2 sub_image2_content 全半角文字  
129 追加商品画像3 sub_image3_url 半角文字 追加商品画像3のURL
http://ショップURL/~
130 追加商品画像モバイル表示3 is_display_mobile_sub_image3 半角数字 1 0/1
0:追加商品画像3をモバイルに表示する
1:しない
131 画像説明文3 sub_image3_content 全半角文字  
132 レイアウト指定 sub_image_layout 半角英字 1 A/B/C/D
133 PC用メイン商品説明文 main_content 全半角文字  
134 PC用追加商品説明文 main_content2 全半角文字  
135 モバイル商品説明 mobile_content 全半角文字  
136 スマホ商品説明1 smartphone_content1 全半角文字  
137 スマホ商品説明2 smartphone_content2 全半角文字  
138 スマホ商品説明1にモバイル表示 is_display_mobile_content 半角英字 1 Y/N
Y:説明文表示する
N:説明文表示しない
139 商品カテゴリー用商品説明文 product_list_content 半角文字  
140 商品カテゴリー用商品説明文表示可否 is_display_product_list_content 半角英字 1 Y/N
Y:説明文表示する
N:説明文表示しない
141 決済画面備考欄 order_page_note 全半角文字  
142 再入荷お知らせ is_restock_notification 半角英字 1 Y/N
Y:再入荷お知らせする
N:再入荷お知らせしない
143 Googleショッピングデータノード(ノード) google_shopping  
144 商品状態フラグ condition 全角文字 新品/中古品/リファビッシュ
145 データ用商品名 title 全半角文字 70  
146 データ用詳細内容 description 全半角文字  
147 オプションの表示形式 option_layout_type 半角数字 1 0/1/2/3/4
0:プルダウン
1:PCは表形式(ラジオボタン)
スマホはプルダウンで表示
2:プルダウンで表示(PC/スマホ)
3:PCはプルダウン
スマホは項目ごとに買い物かごを表示
4:PCは表形式(ラジオボタン)
スマホは項目ごとに買い物かごを表示
148 ISBNコード isbn_code 半角英数字 20  
149 ブランド名 brand 全半角文字 255  
150 MPN(メーカー型番) mnp 全半角文字 255  
151 Googleショッピングカテゴリー google_product_category 全半角文字 255  
152 性別 gender 半角数字 1 1/2/3
1:男性
2:女性
3:ユニセックス
153 年齢層 age_group 半角数字 1 1/2/3/4/5
1:大人
2:子供
3:幼児
4:乳児
5:新生児
154 color 全半角文字 255  
155 サイズ size 全半角文字 255  
156 素材 material 全半角文字 255  
157 pattern 全半角文字 255  
158 商品グループID item_group_id 全半角文字 255  
159 アドワーズ用グループ adwords_grouping 全半角文字 255  
160 アドワーズ用ラベル adwords_labels 全半角文字 255  
161 決済グループ名 settlement_group_name 全半角文字 100 BtoB(会員グループ別決済制御機能)オプションご契約で「決済グループ設定」で登録済みの「決済グループ」を出力する。
162 カタログ注文番号 catalog_order_code 半角英数字 50 オプション機能が有効な場合に出力する。
163 予約商品(ノード) reservation_sale オプション機能が有効な場合に出力する。
164 予約商品 is_reservation_sale 半角英字 1 Y/N
Y:予約商品である
N:予約商品ではない
165 発売日 release_date 半角数字 8 YYYYMMDD
166 発売日備考 release_date_note 全半角文字 200  
167 発売後通常商品化 is_onsale_after_released 半角英字 1 Y/N
Y:発売後に通常商品にする
N:発売後に通常商品にしない
168 出荷予定日 shipping_due_date 半角数字 8 YYYYMMDD
169 予約商品備考 reservation_sale_note 全半角文字 200  
170 価格.com掲載商品(ノード) kakakucom オプション機能が有効な場合に出力する。
171 [価格.com]価格.com掲載登録 is_publish 半角数字 1 0/1
0:価格.com掲載中である
1:価格.com掲載していない
172 [価格.com]ProductID product_id 半角英数字  
173 [価格.com]価格.comの製品名・型番 product_name 全半角文字 255  
174 [価格.com]JANコード自動紐付け is_set_jancode 半角数字 1 JANコードを元に価格.comと紐付けるかどうかを指定
0/1
0:商品情報のJANコードをもとに紐付けない
1:商品情報のJANコードをもとに紐付ける
175 [価格.com]在庫・発送 prompt_delivery 半角数字 3 在庫ステータス
参照:http://kakaku.com/help/shopreg/csv_regi.html
176 [価格.com]店頭 is_econly 半角数字 1 0/1
0:通販価格限定
1:店頭価格と同じで店頭在庫有り
177 [価格.com]画像URL is_set_image_url 半角文字 1 0/1
0:価格.comに提供しない
1:価格.comに提供する
178 [価格.com]一言コメント comment 全半角文字 60  
179 [価格.com]延長保証 is_warranty 半角数字 1 0/1
0:延長保証サービス未対応
1:延長保証サービス対応
180 [価格.com]送料区分名 carriage_name 半角英数字 22 送料(最大9桁)|送料固定(1桁 0/1)|送料区分名(最大10文字)
送料固定の値
0 :変動
1 :固定
  • ※項目名のノード 下階層ノードが存在している親ノードを示す。
  • ※必須 ○:常に出力、▲:該当する商品が1件の場合のみ、出力
  • ※有料オプション ○:有料オプションが有効の場合に出力

商品の並び順について

商品の並び順のうち、更新日でのソートについては以下の仕様となります。

元々のmakeshopの仕様として、新規登録時には更新日が空欄となります。
更新日の古い順でソートした場合、更新日が空のものが最初に並び、その後が更新日の昇順で出力されます。

  • 更新日が古い順
    新規登録商品1 登録日:20141016 更新日:なし
    新規登録商品2 登録日:20141015 更新日:なし
    更新した商品2 登録日:20140801 更新日:20140815
    更新した商品1 登録日:20140801 更新日:20140831

更新日の新しい順でソートした場合、更新日が降順で並び、その下に更新日が空の商品が出力されます。

  • 更新日が新しい順
    更新した商品1 登録日:20140801 更新日:20140831
    更新した商品2 登録日:20140801 更新日:20140815
    新規登録商品1 登録日:20141016 更新日:なし
    新規登録商品2 登録日:20141015 更新日:なし

※指定期間に新規登録/更新した商品を取得した場合、ソートではなく検索条件の『登録/更新日』を指定する事で取得できます。


配布用商品情報取得API企画書.pdf
商品API_別紙パラメータ一覧.xlsx