makeshop（次世代API）のデータを取り込みたい
回答
本記事では、b→dashと「makeshop（次世代API）」のAPI連携において、makeshopで管理している会員データや受注データ、商品データの情報をb→dashに取り込む方法について紹介しています。
本記事の構成は下記の通りです。
1. 本記事について
2. b→dashに連携できるデータ(会員情報/注文配送明細/注文明細データの項目一覧)
3. b→dashへ接続情報を登録する
4. 接続の検証を行う
各セクションの詳細は、以下をご参照ください。
1. 本記事について
本記事では、データ連携において「makeshop」のデータをb→dashに取り込む方法について記載します。makeshopで管理している会員データや受注データ、商品データの情報をb→dashに連携したい場合に、本記事をご参照ください。
2. b→dashに連携できるデータ
b→dashと「makeshop」のAPI連携において、b→dashに取り込むことができるデータは下記の3種類です。
・会員情報データ(更新方法: 全件更新)
・注文配送明細データ(更新方法: 全件更新)
・注文明細データ(更新方法: 全件更新)
会員情報データの主なカラム
「会員情報データ」には、会員の基本情報・住所情報・勤務先情報・付加情報などが含まれます。代表的なカラムは下記の通りです。
b→dash連携時の項目名 |
makeshopでの項目名 |
説明 |
| MemberId [KEY] | member_id | 会員を特定するID(主キー) |
| MemberName | member_name | 会員名 |
| MemberNameKana | member_name_kana | 会員名(カナ) |
| JoinDate | join_date | 入会日 |
| メールアドレス | ||
| MemberPassword | 空文字 | 該当するカラムがなく取得できないため、「空文字」が格納されます |
| EmailMagazineReceive | email_magazine_receive | Y: メールマガジン配信を希望 / N: 配信を希望しない |
| Sex | sex | 0: 男性 / 1: 女性 |
| Birthday | birthday | 誕生日 |
| MemberPoint | member_point | 保有ポイント |
| HomePost / HomePrefecture / HomeAddress1 / HomeAddress2 / HomePhone | home_post / home_prefecture / home_address1 / home_address2 / home_phone | 自宅住所・電話番号 |
| MobilePhone / MobileEmail | mobile_phone / mobile_email | 携帯電話番号・メールアドレス |
| OfficeName / OfficePost / OfficePrefecture / OfficeAddress / OfficePhone | office_name / office_post / office_prefecture / office_address / office_phone | 勤務先情報 |
| LoginEmail | login_email | Y: メールアドレスによる会員ログインを許可する / N: 許可しない |
※ 上記は主要なカラム例です。会員情報データには合計40カラムが含まれ、AdditionalOption1〜7(付加情報7カラム)、Memo、RecommendMemberId(紹介会員ID)、MemberPointExpireDate(ポイント有効期限)などが含まれます。全カラム一覧は原記事をご参照ください
注文配送明細データの主なカラム
「注文配送明細データ」には、注文情報・配送ID・商品明細などが含まれます。代表的なカラムは下記の通りです。
b→dash連携時の項目名 |
makeshopでの項目名 |
説明 |
| OrderNumber [KEY] | order.ordernum | 注文番号(主キー) |
| Date | order.date | 注文日時 |
| DeliveryId [KEY] | order.deliveries.delivery[id] | 配送ID(主キー) |
| BrandCode [KEY] | order.deliveries.delivery.commodities.commodity.brandcode | ブランドコード(主キー) |
| OriginalCode | order.deliveries.delivery.commodities.commodity.orgcode | オリジナルコード |
| Name | order.deliveries.delivery.commodities.commodity.name | 商品名 |
| Price | order.deliveries.delivery.commodities.commodity.price | 価格 |
| Amount | order.deliveries.delivery.commodities.commodity.amount | 数量 |
| ConsumptionTaxRate | order.deliveries.delivery.commodities.commodity.consumption_tax_rate | 消費税率 |
| Option / OriginalOptionCode / NameOptions | order.deliveries.delivery.commodities.commodity.option / orgoptioncode / nameoption | オプション情報 |
2025年3月17日深夜と18日深夜のリリースによって、「NameOptions」カラムで取得される値の形式が変更されました。
・リリース前: 値を「タグ」で囲むXML形式
・リリース後: 値が「キー: 値」のJSON形式(例: "label1": "test_表示用", "comment1": "コメント")
※ キーの順番は固定されないため、レコードによって順番が異なる場合があります
注文明細データの主なカラム
「注文明細データ」には、注文情報・商品明細・各種ポイント情報などが含まれます。代表的なカラムは下記の通りです。
b→dash連携時の項目名 |
makeshopでの項目名 |
説明 |
| OrderNumber [KEY] | order.ordernum | 注文番号(主キー) |
| Date | order.date | 注文日時 |
| BrandCode [KEY] | order.orderdetail.commodities.commodity.brandcode | ブランドコード(主キー) |
| OriginalCode | order.orderdetail.commodities.commodity.orgcode | オリジナルコード |
| Name | order.orderdetail.commodities.commodity.name | 商品名 |
| JanCode | order.orderdetail.commodities.commodity.jancode | JANコード |
| DiscountRate | order.orderdetail.commodities.commodity.dcrate | 割引率 |
| Price | order.orderdetail.commodities.commodity.price | 価格 |
| ShopPoints / GMOPoints / YahooPoints | commodity.point[type=shop/gmo/yahoo] | 各種ポイント(ショップ/GMO/Yahoo) |
| Amount | order.orderdetail.commodities.commodity.amount | 数量 |
| ConsumptionTaxRate | commodity.consumption_tax_rate | 消費税率 |
| Option / OriginalOptionCode / NameOptions | commodity.option / orgoptioncode / nameoption | オプション情報 |
※ 注文明細データの「NameOptions」も、注文配送明細データと同様に2025年3月のリリースでJSON形式に変更されています
3. b→dashへ接続情報を登録する
b→dash管理画面でmakeshopとのAPI連携の接続情報を登録します。
1. 「データパレット」 > 「データを連携」 > 「新規追加」をクリックします
2. 「makeshop（次世代API）」を選択し、「適用」をクリックします
3. 「次へ」を2回クリックします
4. 連携に必要な情報(ショップID)を入力し、「次へ」をクリックします
API連携に必要な「ショップID」は、makeshopの管理画面から下記の手順で確認できます。
1. makeshopのアカウントにログインします
2. 「アカウント」 > 「アカウント管理」をクリックします
3. 表示される「ショップID」を確認します
5. 連携頻度と時間を設定して「追加」を選択し、「次へ」をクリックします
6. 「makeshop byGMO Apps」をクリックし、アプリをインストールします
7. 名前を入力し、「保存」をクリックします
8. 「次へ」をクリックし、新規作成した連携設定が画面に表示されることを確認します
※ 連携タイミングは複数設定することもできます。設定した内容に基づいて連携処理が行われます
4. 接続の検証を行う
接続情報の登録が完了したら、連携のステータスを確認して接続の検証を行います。
1. b→dashに入力した連携タイミングの時間になると、「連携処理」が開始されます
2. 連携設定のステータスを確認します(ステータスはアイコンで把握可能)
3. ステータスが「接続完了」になった連携設定をクリックします
4. 連携されているデータを確認し、「取込設定」を行うことができます
