定期購買公開 API Reference
はじめに
本リファレンスでは、Shopify「定期購買」アプリが提供する【API連携機能】の利用方法やAPI仕様を定義しております。
※API連携機能はENTERPRISEプランのみでご利用いただけます。
定期購買アプリについて
https://apps.shopify.com/huckleberry-subscription?locale=ja
使い方
APIキーの発行
- Shopify「定期購買」アプリの管理画面へアクセスし、「一般設定」メニューを選択し、【API連携】セクションから「APIキーの発行」ボタンを押してください。
- 表示されたモーダルに記載されているAPIキーをコピーしてご利用ください。
GraphQL のエンドポイント
https://subscription.huckleberryapps.com/graphql
リクエスト方法
上記のエンドポイントに対して、以下のヘッダ情報を付与して実行したい Query や Mutation をリクエストしてください
公開API利用時共通設定
| キー | 設定値 | 設定値の例 |
|---|---|---|
| x-shop | <ストアドメイン> | example.myshopify.com |
| x-api-key | <APIキー> | 550e8400-e29b-41d4-a716 |
| Content-Type | <Content-Type> | application/json |
顧客向けQuery/Mutationについて
下記の Query/Mutation をリクエストする際はx-api-typeにcustomerを設定してください。
また、下記のQuery や Mutation については1分間に1000回以上リクエストした場合429エラーを返却します
顧客向けQuery/Mutation利用時設定
| キー | 設定値 | 設定値の例 |
|---|---|---|
| x-api-type | <APIタイプ> | customer |
顧客向けQuery/Mutation一覧
- 顧客向けQuery/Mutationは、customerから始まるエンドポイントが対象になります。
- 以下の表は顧客向けQuery/Mutationの一覧です。
| Query・Mutation名 | GraphQL 操作名 |
|---|---|
| customerSubscriptionContract | 顧客向け契約情報取得 |
| customerSubscriptionContracts | 顧客向け契約一覧情報取得 |
| customerSubscriptionContractUpdateNextDeliveryDate | 顧客向けお届け日変更 |
| customerSubscriptionContractUpdateStatus | 顧客向け契約ステータス更新 |
顧客向けQuery/Mutationのエラーについて
顧客向けQuery/Mutationで発生する可能性のあるエラーについては、エラーコード一覧ページをご参照ください。