目次

• 概要

  • はじめに
  • 開発に必要な技術
  • 開発手順
  • よくある質問

• APIリファレンス

  • 共通仕様
  • API利用可能条件一覧
  • トークン情報取得
  • 商品追加
  • 商品変更
  • 商品一括変更
  • 商品削除
  • 商品数量変更
  • 変更可能周期の取得
  • 契約周期（プラン）変更
  • 契約周期（プラン）変更（deprecated）
  • 商品販売可能確認
  • 変更可能商品取得
  • 解約理由取得（deprecated）
  • 調査アンケート取得
  • 決済情報取得
  • プラングループ取得
  • プラングループ取得（商品別）
  • レコメンド商品取得
  • 定期購買契約一覧取得
  • 定期購買契約詳細取得
  • 定期購買契約内の契約商品に紐づくプラン取得
  • 今すぐ注文
  • 今すぐ注文 (ギフト)
  • 決済方法の更新
  • 次回決済のスキップ
  • 次回決済のスキップ取消
  • 配送先住所変更
  • お届け日変更
  • お届け日変更（deprecated）
  • 契約ステータス変更
  • マイページクーポン適用
  • マイページクーポン削除
  • 定期契約備考更新
  • BOX情報の取得
  • BOX定期購買の商品の追加・更新・削除
  • 契約商品カスタム属性取得API
  • 顧客メタデータ追加・更新
  • 新BOX商品変更
  • ポイントディスカウント適用API
  • 一度だけ購入商品一覧取得

<aside> ⚠️

Notionの移行にともないURLが変更になります。

↓ https://tough-saturn-45a.notion.site/API-c7b86a44e6a283bb811801336d443808

</aside>

<aside> 💡

はじめに

• 本機能はENTERPRISEプラン向けの機能となります。 ご利用にあたってはアプリ画面の料金プランよりENTERPRISEプランへ切り替え後、 こちらよりご連絡ください。
• カスタマイズには、「Shopifyの仕様変更」や「アプリの機能アップデート」に伴う保守対応が必要になります。 その際には、都度お知らせいたしますので、ご理解の程お願いいたします。 </aside>

開発に必要な技術

定期購買アプリのマイページはReactフレームワークによるSPA（シングルページアプリケーション）構成で提供されています。

そのため、開発いただくには下記をご理解いただく必要があります。

• TypeScript
• Reactフレームワーク
• Ajax通信の仕組みの理解
• Nodejsのバージョンは18以上となります。
• GCPバケットへのファイルアップロード操作
• Gsuiteツール（必要に応じて）
• yarn（パッケージ管理）

ご対応できる方がいない場合は弊社の構築チームでも対応可能ですので、別途ご相談ください。

開発手順

①GCP環境の作成依頼

下記リンクよりお申し込みいただいた後、5営業日を目安に環境手配させていただきます。

https://huckleberry-inc.channel.io/support-bots/107495

※GCP内のルートディレクトリには、下記のようにマイページのコードのBuild結果をアップロードいただく形となります。（下記はアップロード後のファイル構成となります）

②開発ソースコードをダウンロード

共通仕様

トークン情報取得

商品追加

商品変更

商品一括変更

商品削除

商品数量変更

変更可能周期の取得

契約周期（プラン）変更