makeshop APIドキュメント

はじめに

このサイトは、高機能オンラインショップ構築SaaS/ASPサービスmakeshopのAPI仕様を解説した、GMOメイクショップ株式会社による公式ドキュメントです。

APIはユーザーサポートの対象外となります。
APIを利用したシステム開発のご相談についても、助言等は行っておりません。
APIのご利用にはmakeshopの基本機能への深い理解に加えて、WEB開発の高度な技術力が必要になりますので、事前にそのような開発体制をご準備ください。

現在のAPIのバージョン

Version. 20.8.11
2020/8/11 更新 APIで障害が発生している場合は、下記メンテナンス情報でアナウンスを行っています。
MakeShop メンテナンス情報

お知らせ

2024-9-25　リリース予定

新規受注登録APIに関する仕様変更

日本郵便株式会社より配達希望時間帯の変更が発表されたことを受け、 makeshop管理画面で設定可能な時間指定タイプ「ゆうパック用（時間帯指定タイプC）」にて「20時-21時」の時間帯を廃止いたします。
上記に伴い、新規受注登録APIによってmakeshopに注文データを連携する際にも「20時-21時」の時間帯ではエラーを返すようになります。
外部で作成された受注フォームでも「20時-21時」の時間帯は使用しないようお願いします。

2024-8-22　リリース予定

商品登録APIに関する仕様変更

No.81「会員グループ別設定」に指定する会員グループ情報が会員グループIDに変更になります。

2024-8-5　リリース予定

商品登録API、商品APIに関する仕様変更

・No.58「年齢層」にて “3：幼児”、”4：乳児”、”5：新生児” が指定可能になります。

※商品APIでは戻りパラメータ No.153「年齢層」になります。

2024-6-27　リリース

会員APIに関する仕様変更

・会員情報取得APIのレスポンスに「LINE ID」が追加されます。

※2024/6/25追記　LINE ID連携が「連携する」の場合のみ出力　されます。

2024-6-6　リリース

注文情報取得APIに関する仕様変更

リクエストパラメータに「ordernum_list」が追加されました。

注文番号指定の取得で複数の注文を一度に取得いただけるようになりました。
※カンマ区切りで指定することで最大100件までの注文データの取得が可能です。
追加パラメータ：ordernum_list

2024-6-13　リリース予定

会員APIに関する仕様変更

・会員情報取得API
・会員情報登録API
・会員情報更新API

「性別」のデータに「2:無回答」が追加されます。

■変更前：
0：男性 1：女性
■変更後：
0：男性 1：女性 2:無回答

2024-4-18　リリース予定

外部注文データ登録APIに関する仕様変更

最新フォーマット項目一覧に以下の変更があります。（変更後）

列番号	Excel上の列番号	項目名	1行目	2行目	備考
8	H	消費税フラグ	○	–	0：税抜（内税）、1：税込、2：税抜（外税） ※外税時のみ

最新フォーマット項目一覧に以下の変更があります。（以下追加）

列番号	Excel上の列番号	項目名	1行目	2行目	備考
51	AZ	消費税8%	–	–	消費税フラグが2（外税）の場合、必須です。消費税10%との合計が消費税額合計と一致するようにしてください。
52	BA	消費税10%	–	–	消費税フラグが2（外税）の場合、必須です。消費税8%との合計が消費税額合計と一致するようにしてください。

2024-3-28　お知らせ更新

「消費税フラグ」の追加について

- 2024-3-28リリースより延期となりました。

調整後の日程：4/10（水）15時以降のリリース予定となります。

2024-3-28　リリース予定

注文APIに関する仕様変更

注文データ取得の際の項目に以下が追加されます。

No	項目名	使用回数	説明	備考
10	tax_type	1	消費税フラグ	0：税抜（内税）、1：税込、2：税抜（外税） ※外税時のみ

2024-2-29　リリース予定

注文APIに関する仕様変更

名入れ商品を複数配送で注文できるようになります。
リリース後、名入れ商品が含まれた複数配送の注文情報を取得をした際、下記項目が取得いただけるようになります。
「注文データ取得API データフォーマットの返り値」
・No24：nameoption（名入れオプション）～No45：amount（数量）
・No101：nameoption（名入れオプション）～No122：amount（数量）

2024-1-25　リリース予定

決済第一画面の「郵便番号」を入力すると「都道府県」と「市区町村」に分割して住所が入力され、「それ以降の住所」は空欄となる仕様へ変更となります。
・注文API：「city」、「street」
・会員API：「home_address1」 ※現在の入力フォームにおいても「市区町村」は自由入力となっております。（必ずしも「市区町村」だけの内容が出力されている訳ではないです）

2024-1-11 リリース予定

注文APIに関する仕様変更①

■オプショングループの金額設定商品へのコロン表示の仕様変更に伴い、注文情報取得時、オプションの項目名とアイテム名の間に「：」（コロン）が表示されるようになります。

■対象
・17 option 1 オプション情報
・92 option 1 オプション名

注文APIに関する仕様変更②

現在【注文管理】>【注文管理】>【注文検索/一括処理】】>『詳細注文情報』から元々入力されていた「出荷予定日」をクリアにして保存すると
「scheduled_shipping_date」は「0000-00-00」として返却されてしまっております。
最初から「出荷予定日」の記載がない場合は空で返却する仕様となっており、この度この仕様に合わせ、
後からクリアとした場合にも「scheduled_shipping_date」は空で返却するようにいたします。

■対象
・125 scheduled_shipping_date 1 出荷予定日

2023-11-30 リリース

注文APIに関する仕様変更

■ ドキュメント内：sumpriceの『説明』の文言を変更しました

・変更前
「合計金額」
・変更後
「支払金額」

2023-10-26　リリース予定

注文APIおよび在庫連携システム用注文確認メールに関する仕様変更

注文データ取得の際の項目に以下が追加されます。

No	項目名	使用回数	説明
56	orderprice	1	注文合計額

2023-9-28 リリース予定

注文APIに関する仕様変更

■通常注文
・変更前
ポイント返還⇒「1」（注文内容修正）

・変更後
ポイント返還⇒「2」※注文キャンセルと同様

■複数配送注文
・変更前
注文キャンセル（配送先単位）⇒「2」（注文キャンセル）
ポイント返還⇒「1」（注文内容修正）

・変更後
注文キャンセル（配送先単位）⇒「1」※注文内容修正と同様
ポイント返還⇒「2」※注文全キャンセルと同様

2023-8-23　リリース

注文APIおよび在庫連携システム用注文確認メールに関する仕様変更

注文データ取得の際の項目に以下が追加されました。

No	項目名	使用回数	説明
59	tax_per_tax_rate_list	n	税率毎の消費税額群
60	tax_per_tax_ratetax_rate	1	各税率の合計消費税額値
100	consumption_tax	n	商品毎の消費税額

2023-4-20　リリース確定

以前、お伝えしておりました（下記記載）
オプション選択【ノード】（select_option）の新項目追加につきまして
リリース日が「2023/4/20」と決定いたしました。

2023-4月下旬頃リリース予定

商品APIに関する仕様変更

商品API「戻りパラメータ」

74:オプション選択【ノード】（select_option）の中に、下記の新項目を追加します。
商品の当該オプションに対して、オプション画像が設定されている場合、その画像のURLを返却します。

No	項目名	パラメータ名	必須	有料オプション	属性	文字数	説明
84の後に追加	オプション画像URL	image_url	▲	–	半角文字	–	オプション画像のURL
上記の後に追加	オプション画像サムネイルURL	thumbnail_image_url	▲	–	半角文字	–	オプション画像のサムネイルのURL

返却例

<image_url/>https%3A%2F%2Fmakeshop-multi-images.akamaized.net%2Ftest4351%2Fshopimages%2F73%2F00%2F7_000000000070.jpg<image_url/> 
<thumbnail_image_url/> https%3A%2F%2Fmakeshop-multi-images.akamaized.net%2Ftest4351%2Fshopimages%2F73%2F00%2Fs7_000000000070.jpg<thumbnail_image_url/>

オプション画像が未設定の場合は下記で返却されます。

<image_url/> 
<thumbnail_image_url/>

※リリース日は確定次第、本ドキュメントの「お知らせ」よりご案内いたします。
※オプション画像を設定する機能のリリース予定については、makeshopマガジンにてご案内いたします。

2022-08-25 リリース

新規受注登録APIに関する仕様変更

新規受注登録APIが定期購入機能に対応いたします。

今回の仕様変更で下記パラメータが追加されます。
「定期購入商品の初回お届け日」「お届けサイクルタイプ」「お届けサイクルオプション」
「カード登録フラグ」「登録済みカード登録連番」「定期購入商品フラグ」
※今回の仕様変更による追加項目が無い旧フォーマットも、引き続き使用可能です。

新規受注登録APIで定期購入機能を利用するためには以下の条件を満たす必要があります。
エンタープライズプランの契約をしている必要があります。
別途有償サービス「新規受注登録API」オプションの契約をしている必要があります。
別途有償サービス「定期購入」オプションの契約をしている必要があります。

当APIへのお申込み、機能の詳細に関しては下記までお問い合わせください。

GMOメイクショップ株式会社
ECビジネスプランナー
E-Mail：cloudec@makeshop.jp
直通Tel：03-6705-8605

2022-03-31 リリース

新規受注登録APIに関する仕様変更

新規受注登録APIで対応する決済方法に以下2点を追加します。
「GMOイプシロン　クレジットカード決済」「代金引換」
また、「オプショングループ」機能を利用した商品についても登録が可能になります。

今回の仕様変更で下記パラメータが追加されます。
「代金引換配送時決済方法」※代金引換の場合のみ入力が有効な項目です。
「オプショングループノード」「オプションID」「アイテムID」「追加金額」※オプショングループ商品の場合のみ入力が有効な項目です。
※今回の仕様変更による追加項目が無い旧フォーマットも、引き続き使用可能です。

新規受注登録APIを利用するためには以下の条件を満たす必要があります。
エンタープライズプランの契約をしている必要があります。
別途有償サービス「新規受注登録API」オプションの契約をしている必要があります。
新規受注登録設定画面で認証コードを発行し、連携設定を「許可する」の状態で保存している必要があります。

当APIへのお申込み、機能の詳細に関しては下記までお問い合わせください。

GMOメイクショップ株式会社
ECビジネスプランナー
E-Mail：cloudec@makeshop.jp
直通Tel：03-6705-8605

2021-08-26　リリース

外部注文データ登録APIの新規リリース

makeshopシステム外で受けた決済済みの注文データをCSVで、
makeshopシステムに取り込むことが出来るAPIが新たにリリースされます。
従来のAPI連携オプションとは別の有償オプション機能になるので、
利用には申し込みが必要です。
当APIへのお申込み、機能の詳細に関しては下記までお問い合わせください。

GMOメイクショップ株式会社
ECビジネスプランナー
E-Mail：cloudec@makeshop.jp
直通Tel：03-6705-8605

2021-01-14 リリース

商品登録APIに関する仕様変更

商品登録API カテゴリー一括登録で利用するCSVフォーマットに項目が追加されます。
・変更内容
以下２項目を追加します。
「ブラウザータイトル」　※空欄の場合は値を更新しません。
「メタタグ : Description」　※空欄の場合は値を更新しません。
※上記２項目を追加していない旧フォーマットも、引き続き使用可能です。

2020-12-17　リリース

商品登録APIに関する仕様変更

商品登録APIで利用するCSVフォーマットに項目が追加されます。
・変更内容
以下２項目を追加します。
「ブラウザータイトル」　※空欄の場合は値を更新しません。
「メタタグ : Description」　※空欄の場合は値を更新しません。
※上記２項目を追加していない旧フォーマットも、引き続き使用可能です

2020-10-29　リリース確定

以前、お伝えしておりました（下記記載）
商品の「割引期間」における時間指定を可能とする仕様変更につきまして
リリース日が「2020/10/29」と決定いたしました。

2020-10月下旬頃リリース予定

商品APIに関する仕様変更
商品API「戻りパラメータ」
56:割引期間（discount_term）
■現在の仕様
半角文字（17桁）YYYYMMDD-YYYYMMDD
■変更後の仕様
半角文字（25桁）YYYYMMDDhhmm-YYYYMMDDhhmm
開始日と終了日に「時」と「分」が追加され、桁数が変わります。
商品登録API「送信CSVパラメータ」
29：割引期間
■現在の仕様
文字列 17バイト　YYYYMMDD-YYYYMMDD
■変更後の仕様
文字列 25バイト　YYYYMMDDhhmm-YYYYMMDDhhmm
開始日と終了日に「時」と「分」が追加されます。
なお時・分が無い今までの形式でも送信可能です。
※リリース日は確定次第、本ドキュメントの「お知らせ」よりご案内いたします。

2020-8-11 「最終更新日時の戻りパラメータ」の修正対応つきまして（8/6掲載）

「最終更新日時の戻りパラメータ」の誤りにつきまして、8/11（火）15:00頃に修正対応をおこなうこととなりました。
・リリース前（誤）：user_last_modified
・リリース後（正）：last_update_date
何卒よろしくお願い申し上げます。

2020-7-30 リリースにつきまして（8/5掲載）

7/30（木）にリリースした「最終更新日時の戻りパラメータ」に誤りがございました。 ■最終更新日時正：last_update_date 誤：user_last_modified こちらは、正のパラメータ（last_update_date）へ修正を行う予定でございます。リリースの詳細な日時は確定次第、本ドキュメントの「お知らせ」よりご案内いたします。この度は、ご迷惑をおかけし誠に申し訳ございませんでした。何卒よろしくお願い申し上げます。

2020-7-30 リリース

会員APIに関する仕様変更

会員情報取得APIの送信パラメータに下記が追加されます。
・項目名：最終更新日時（FROM）　パラメータ名：last_update_date_from
・項目名：最終更新日時（TO）　　パラメータ名：last_update_date_to
※両パラメータとも設定せずに送信いただいても問題ありません。会員情報取得APIの戻りパラメータに下記が追加されます。
・項目名：最終更新日時　　パラメータ名：last_update_date
・項目名：削除会員フラグ　パラメータ名：delete_shop_member

【重要】「TLS1.0」「TLS1.1」の無効化につきまして

この度、セキュリティ強化のため、弊社サービスでは「TLS1.0」「TLS1.1」を無効化いたします。これにより、「TLS1.0」「TLS1.1」を利用したソフトウェア（Webブラウザ等）から、
弊社で提供する各種サービスをご利用いただくことができなくなります。詳しくは下記のお知らせをご確認ください。
【重要】「TLS1.0」「TLS1.1」の無効化につきましてまた、APIにおきましても「TLS1.0」「TLS1.1」の無効化以降、
「TLS1.2」に対応していない環境からは、接続いただけなくなります。 APIご利用者様につきましては、「TLS1.0」「TLS1.1」
無効化対応日（10月頃を予定）までに、現在の接続環境をご確認いただくようお願いいたします。
また検証用環境をご用意いたしましたので
併せてご確認いただきますようお願い申し上げます。
▼TLS検証環境

2020-6-25 リリース

商品APIに関する仕様変更

商品情報取得APIの戻りパラメータに下記が追加されます。
・項目名：掲載期間外表示可否
・パラメータ名：is_display_out_of_publish_period 商品登録APIで利用するCSVフォーマットに項目が追加されます。
※「～2020年6月25日」のフォーマットをご利用の場合、「掲載期間外表示可否」項目はご利用いただけません。
値：Y/N
Y：表示する（商品の購入はできない）
N：表示しない

2020-5-28 リリース

会員APIに関する仕様変更

会員情報更新APIの送信パラメータに下記が追加されます。
・項目名：ショップポイント満了日
・パラメータ名：point_expire_date
※当項目は任意項目ですので、「ショップポイント満了日」のパラメータを設定せずに送信いただいても問題ありません。

2020-1-16 リリース

商品APIに関する仕様変更

商品情報取得APIの戻りパラメータに下記が追加されます。
・項目名：商品ID
・パラメータ名：product_id

2019-11-14 リリース

注文APIに関する仕様変更

注文データ取得の際のパラメーターpaymethodの決済方法に以下が追加されます。変更後の仕様
・paymethodにP1 クロネコペイを追加。

2019-10-1 リリース

注文APIおよび在庫連携システム用注文確認メールに関する仕様変更

注文データ取得の際の項目に以下が追加されます。

No	項目名	使用回数	説明
57	price_per_tax_rate_list	1	税率毎の合計金額
58	price_per_tax_rate tax_rate	n	各税率の合計金額値

出力例
・各税率ごとの合計金額を出力する項目を追加(【56】sumprice と【57】buyer の間に追加)

<price_per_tax_rate_list>
 　<price_per_tax_rate tax_rate=“8”>ｘｘｘｘｘ</price_per_tax_rate> 
　<price_per_tax_rate tax_rate="10">ｘｘｘｘｘ</price_per_tax_rate> 
</price_per_tax_rate_list>

2019-9-19 リリース

注文APIに関する仕様変更

注文データ取得の際のパラメーターpaymethodの決済方法に以下が追加されます。変更後の仕様
・paymethodにN1 LINE Payを追加。

2019-7-25 リリース

注文データ取得API データフォーマットの返り値に以下が追加されます。
・Ｎｏ.7 paymethod
支払方法にY2が追加されます

・Ｎｏ.130 combined_paymethod 併用の支払方法
・Ｎｏ.131 combined_price　併用の支払方法での金額

在庫連携システム用注文確認メール書式
・Ｎｏ.4 paymethod
支払方法にY2が追加されます

・Ｎｏ.130 combined_paymethod 併用の支払方法
・Ｎｏ.131 combined_price　併用の支払方法での金額

決済別ステータス一覧に下記の支払方法が追加されます
Y2　PayPay残高払い

最新のデータフォーマットは以下をご確認ください。
http://apidoc.makeshop.jp/orderinfo/

2019-6-6 リリース

商品APIに関する仕様変更

商品APIで取得できる項目が追加されます。

変更内容
以下項目を追加します。

No：27
項目名：軽減税率対象
パラメータ名：is_reduced_tax_rate_brand
値：Y/N
Y：軽減税率対象である
N：軽減税率対象でない商品登録APIで利用するCSVフォーマットに項目が追加されます。
※「～2018年4月19日」のフォーマットをご利用の場合、「軽減税率対象」項目はご利用いただけません。

変更内容
以下項目を追加します。

「軽減税率対象」
値：Y/N
Y：軽減税率対象である
N：軽減税率対象でない
※空欄の場合は値を更新しません。「軽減税率対象」を含む最新のフォーマットは以下をご確認ください。
https://www.makeshop.jp/manual/brand_csv_new.html

2019-6-10 リリース

注文APIに関する仕様変更

注文APIの返却パラメータの下記の項目にエスケープ処理（エンティティ変換処理）が追加されます。独自商品コード
注文者情報の電話番号
注文者情報の電話番号２
注文者情報のメールアドレス
配送先の電話番号
配送先の郵便番号
配送先の都道府県
名入れオプション

はじめに

目次

現在のAPIのバージョン

お知らせ

2024-9-25 リリース予定

新規受注登録APIに関する仕様変更

2024-8-22 リリース予定

商品登録APIに関する仕様変更

2024-8-5 リリース予定

商品登録API、商品APIに関する仕様変更

・No.58「年齢層」にて “3：幼児”、”4：乳児”、”5：新生児” が指定可能になります。

2024-6-27 リリース

会員APIに関する仕様変更

・会員情報取得APIのレスポンスに「LINE ID」が追加されます。

2024-6-6 リリース

注文情報取得APIに関する仕様変更

リクエストパラメータに「ordernum_list」が追加されました。

2024-6-13 リリース予定

会員APIに関する仕様変更

「性別」のデータに「2:無回答」が追加されます。

2024-4-18 リリース予定

外部注文データ登録APIに関する仕様変更

2024-3-28 お知らせ更新

「消費税フラグ」の追加について

2024-3-28 リリース予定

注文APIに関する仕様変更

2024-2-29 リリース予定

注文APIに関する仕様変更

2024-1-25 リリース予定

2024-1-11 リリース予定

注文APIに関する仕様変更①

■対象・17 option 1 オプション情報・92 option 1 オプション名

注文APIに関する仕様変更②

■対象・125 scheduled_shipping_date 1 出荷予定日

2023-11-30 リリース

注文APIに関する仕様変更

■ ドキュメント内：sumpriceの『説明』の文言を変更しました

2023-10-26 リリース予定

注文APIおよび在庫連携システム用注文確認メールに関する仕様変更

2023-9-28 リリース予定

注文APIに関する仕様変更

■通常注文・変更前ポイント返還⇒「1」（注文内容修正）

・変更後ポイント返還⇒「2」※注文キャンセルと同様

■複数配送注文・変更前注文キャンセル（配送先単位）⇒「2」（注文キャンセル）ポイント返還⇒「1」（注文内容修正）

・変更後注文キャンセル（配送先単位）⇒「1」※注文内容修正と同様ポイント返還⇒「2」※注文全キャンセルと同様

2023-8-23 リリース

注文APIおよび在庫連携システム用注文確認メールに関する仕様変更

2023-4-20 リリース確定

2023-4月下旬頃 リリース予定

商品APIに関する仕様変更

商品API「戻りパラメータ」

返却例

オプション画像が未設定の場合は下記で返却されます。

2022-08-25 リリース

新規受注登録APIに関する仕様変更

新規受注登録APIが定期購入機能に対応いたします。

GMOメイクショップ株式会社ECビジネスプランナーE-Mail：cloudec@makeshop.jp直通Tel：03-6705-8605

2022-03-31 リリース

新規受注登録APIに関する仕様変更

新規受注登録APIで対応する決済方法に以下2点を追加します。「GMOイプシロン クレジットカード決済」「代金引換」また、「オプショングループ」機能を利用した商品についても登録が可能になります。

GMOメイクショップ株式会社ECビジネスプランナーE-Mail：cloudec@makeshop.jp直通Tel：03-6705-8605

2021-08-26 リリース

外部注文データ登録APIの新規リリース

GMOメイクショップ株式会社ECビジネスプランナーE-Mail：cloudec@makeshop.jp直通Tel：03-6705-8605

2021-01-14 リリース

商品登録APIに関する仕様変更

2020-12-17 リリース

商品登録APIに関する仕様変更

2020-10-29 リリース確定

2020-10月下旬頃 リリース予定

2020-8-11 「最終更新日時の戻りパラメータ」の修正対応つきまして（8/6掲載）

2020-7-30 リリースにつきまして（8/5掲載）

2020-7-30 リリース

会員APIに関する仕様変更

【重要】「TLS1.0」「TLS1.1」の無効化につきまして

2020-6-25 リリース

商品APIに関する仕様変更

2020-5-28 リリース

会員APIに関する仕様変更

2020-1-16 リリース

2024-9-25　リリース予定

2024-8-22　リリース予定

2024-8-5　リリース予定

2024-6-27　リリース

2024-6-6　リリース

2024-6-13　リリース予定

2024-4-18　リリース予定

2024-3-28　お知らせ更新

2024-3-28　リリース予定

2024-2-29　リリース予定

2024-1-25　リリース予定

■対象
・17 option 1 オプション情報
・92 option 1 オプション名

■対象
・125 scheduled_shipping_date 1 出荷予定日

2023-10-26　リリース予定

■通常注文
・変更前
ポイント返還⇒「1」（注文内容修正）

・変更後
ポイント返還⇒「2」※注文キャンセルと同様

■複数配送注文
・変更前
注文キャンセル（配送先単位）⇒「2」（注文キャンセル）
ポイント返還⇒「1」（注文内容修正）

・変更後
注文キャンセル（配送先単位）⇒「1」※注文内容修正と同様
ポイント返還⇒「2」※注文全キャンセルと同様

2023-8-23　リリース

2023-4-20　リリース確定

2023-4月下旬頃リリース予定

GMOメイクショップ株式会社
ECビジネスプランナー
E-Mail：cloudec@makeshop.jp
直通Tel：03-6705-8605

新規受注登録APIで対応する決済方法に以下2点を追加します。
「GMOイプシロン　クレジットカード決済」「代金引換」
また、「オプショングループ」機能を利用した商品についても登録が可能になります。

GMOメイクショップ株式会社
ECビジネスプランナー
E-Mail：cloudec@makeshop.jp
直通Tel：03-6705-8605

2021-08-26　リリース

GMOメイクショップ株式会社
ECビジネスプランナー
E-Mail：cloudec@makeshop.jp
直通Tel：03-6705-8605

2020-12-17　リリース

2020-10-29　リリース確定

2020-10月下旬頃リリース予定