API libralies

お問い合わせやアプリ開発、API利用には利用登録が必要です。

API認証方法はこちらをご確認ください。

shop admin APIshop admin API

永続トークンを利用してショップ管理画面の情報を取得・登録・更新・削除するためのAPIです。

Queries

  • 注文情報取得

    「注文番号」「注文金額」「配送情報」などの注文情報を取得することができます。

  • 定期注文情報取得

    「決済方法」や「継続状況」などの定期注文情報を取得することができます。

  • 商品情報取得

    「システム商品コード」「販売価格」「画像URL」などの商品情報を取得することができます。

  • 商品在庫情報取得

    「商品在庫」「バリエーション在庫情報」を取得することができます。

  • 定期商品情報取得

    「商品名」「販売価格」「お届けサイクル」などの定期商品情報を取得することができます。

  • カテゴリ取得

    ショップに登録されているカテゴリの「カテゴリ名」「カテゴリURL」「カテゴリに紐づく子カテゴリ一覧」などの情報を取得することができます。

  • 会員情報取得

    「会員ID」「会員名」「住所」などの会員情報を取得することができます。

  • ショップ情報取得

    「ショップ担当者名」や「デザインモード」「決済方法」などのショップの基本情報を取得することができます。

  • ショップ配送設定情報取得

    「地域別の配送料金」などのショップの配送設定情報を取得することができます。

  • ショップ納品明細書情報取得

    ショップの「適格請求書発行事業者登録番号」を取得することができます。

  • ショップ社印画像取得

    ショップの「社印画像URL」を取得することができます。

  • アクセス解析タグ(headタグ)取得

    「アクセス解析タグ(headタグ)登録」で登録されたheadタグをkeyを指定して取得することができます。

  • アクセス解析タグ(bodyタグ)取得

    「アクセス解析タグ(bodyタグ)登録」で登録されたbodyタグをkeyを指定して取得することができます。

  • アクセス解析タグ(headタグ)全取得

    「アクセス解析タグ(headタグ)登録」で登録されたheadタグを全取得することができます。

  • アクセス解析タグ(bodyタグ)全取得

    「アクセス解析タグ(bodyタグ)登録」で登録されたbodyタグを全取得することができます。

  • クーポン情報取得

    「クーポンコード」や「クーポン名」、「割引額」等を取得することができます。

  • クーポン対象商品一覧取得

    クーポン対象商品のシステム商品コードを取得することができます。

  • 商品レビュー取得

    「会員ID」「内容」「評価」等の商品レビューを取得することができます。

Mutations

  • 注文情報登録

    カード決済処理を含めた注文情報登録や、決済せずデータとして注文情報登録をすることができます。

  • 注文キャンセル

    「注文番号」をキーに注文情報のキャンセルや、「配送先ID」をキーに複数配送注文の一部の注文をキャンセルすることができます。

  • 注文属性情報変更

    「注文情報の伝票番号」「注文者情報」や「送付先情報」などを変更することができます。

  • 配送ステータス変更

    注文情報の配送ステータスを「未配送」「配送指示」「配送完了」「返送」に変更することができます。

  • 商品情報登録

    「通常商品」「予約商品」「定期商品」を新規登録することができます。

  • 商品情報更新

    「通常商品」「予約商品」「定期商品」の情報を更新することができます。

  • 商品情報削除

    複数の商品情報を削除することができます。

  • 商品在庫更新

    商品の在庫情報を更新することができます。

  • バリエーション在庫更新

    商品に紐づくバリエーション在庫情報を更新することができます。

  • カテゴリ登録

    「親カテゴリの指定」「会員限定」「公開・非公開」などを指定してカテゴリを登録することができます。

  • カテゴリ更新

    「カテゴリ名」「会員限定」「公開・非公開」などを指定してカテゴリを更新することができます。

  • 会員情報登録

    「会員ID」「会員名」「住所」などの会員情報を登録することができます。

  • 会員情報更新

    「会員名」「住所」などの会員情報を更新することができます。

  • 会員パスワード更新

    「会員パスワード」を更新することができます。

  • 会員ポイント更新

    「ショップポイント」「ポイント有効期限延長」「更新理由」などを更新することができます。

  • 会員情報削除

    会員情報を1件づつ削除することができます。

  • アクセス解析タグ(headタグ)登録

    ショップの全ページを横断してheadタグを挿入することができます。

  • アクセス解析タグ(bodyタグ)登録

    ショップの全ページを横断してbodyタグを挿入することができます。

  • アクセス解析タグ(headタグ)更新

    「アクセス解析タグ(headタグ)登録」で登録されたheadタグを更新することができます。

  • アクセス解析タグ(bodyタグ)更新

    「アクセス解析タグ(bodyタグ)登録」で登録されたbodyタグを更新することができます。

  • アクセス解析タグ(headタグ)削除

    「アクセス解析タグ(headタグ)登録」で登録されたheadタグを削除することができます。

  • アクセス解析タグ(bodyタグ)削除

    「アクセス解析タグ(bodyタグ)登録」で登録されたbodyタグを削除することができます。

  • クリエイターモードタグ登録

    クリエイターモードで適用されているデザインテンプレートの「トップページ」「商品詳細ページ」等に対して、「head」や「body」にタグを挿入することができます。

  • クリエイターモードタグ更新

    「クリエイターモードタグ登録」で登録されたタグを更新することができます。

  • クリエイターモードタグ削除

    「クリエイターモードタグ登録」で登録されたタグを削除することができます。

  • クーポン情報登録

    クーポンを新規作成することができます。

  • クーポン対象商品登録

    特定のクーポンに割引対象となる商品を指定することができます。

  • クーポン情報更新

    「クーポンコード」や「クーポン名」、「割引額」等を更新することができます。

  • クーポン情報削除

    指定したクーポンを削除することができます。

  • クーポン対象商品削除

    クーポンに紐づく割引対象商品を削除することができます。
    ※商品自体の削除ではなく、クーポンとの紐づき解除となります。

  • 商品レビュー更新

    レビューされた会員へ「ポイント追加」や、レビュー掲載を「承認」することができます。

  • 商品レビュー削除

    「システム商品コード」「登録日時」を指定し特定の商品レビューを削除することができます。

shop front APIshop front API

memberSSOで取得した一時トークンを利用して、ショップフロントから情報を取得・登録・更新するためのAPIです。

Queries

Mutations

platform APIplatform API

永続トークンを利用して有料アプリの決済情報を取得・登録・更新・削除するためのAPIです。

Queries

Mutations

アプリ開発方法について

APIを利用したアプリ開発方法については開発ガイドにて解説しております。