LoginSignup
10
11

More than 3 years have passed since last update.

[Shopify] のAPIアクセス権限一覧

Last updated at Posted at 2020-04-13

Shopifyアプリを開発している方用。権限(scope)の一覧をまとめました。これで必要最小限な権限をリクエストしてください。正しい権限をもっていないと・
image.png
という返しを喰らいます。

:cop_tone1: 
OAuthの時にscopeを正しく設定する必要があります。 また、アプリを利用する際にどのような権限を付与しているのか理解するためにも一読を。

Scopeの一覧

read_content, write_content

ブログ、ページ、コメント、リダイレクトデータを読み書きできる権限

read_themes, write_themes

テーマデータを読み書きできる権限

read_products, write_products

商品データ(商品、バリアント、イメージ、コレクション)を読み書きできる権限

read_product_listings

商品リスト、コレクションリストを読むことができる権限

read_customers, write_customers

顧客データ(顧客検索項目データ)の読み書きできる権限

read_orders, write_orders

オーダーデータの読み書き権限

read_all_orders

60日より前のデータ(全オーダーデータ)を読むことができる権限。この権限を必要とする場合は取得する必要性とともに別途申請する必要があります。

read_draft_orders, write_draft_orders

ドラフトオーダーデータの読み書きできる権限

read_inventory, write_inventory

在庫データの読み書きできる権限

read_locations

ロケーションデータを読むことができる権限

read_script_tags, write_script_tags

スクリプトタグデータの読み書きできる権限

read_fulfillments, write_fulfillments

フルフィルメントデータの読みことができる権限

read_assigned_fulfillment_orders, write_assigned_fulfillment_orders

自身のフルフィルメントオーダーデータの読み書きできる権限

read_merchant_managed_fulfillment_orders, write_merchant_managed_fulfillment_orders

マーチャント管理フルフィルメントオーダーデータの読み書きできる権限

read_third_party_fulfillment_orders, write_third_party_fulfillment_orders

サードパーティーフルフィルメントオーダーデータの読み書きできる権限

read_shipping, write_shipping

配送会社、国、地域の読み書きできる権限

read_analytics

分析データを読むことができる権限

read_users, write_users

Shopifyユーザーデータの読み書きできる権限

read_checkouts, write_checkouts

チェックアウトデータの読み書きできる権限

read_reports, write_reports

レポートデータの読み書きできる権限

read_price_rules, write_price_rules

プライスルールデータの読み書きできる権限

read_discounts, write_discounts

ディスカウントデータの読み書きできる権限(GraphQLに限定のようです、後で確認します。)

read_marketing_events, write_marketing_events

マーケティングイベントデータの読み書きできる権限

read_resource_feedbacks, write_resource_feedbacks

アプリに関するリソースを通知するデータの読み書きできる権限
https://shopify.dev/docs/admin-api/rest/reference/sales-channels/resourcefeedback

read_shopify_payments_payouts

Shopify Payments の支払い、バランス、トランザクションデータを読むことができる権限

read_shopify_payments_disputes

Shopify PaymentAccessへのクレームデータを読むことができる権限

read_translations, write_translations

翻訳データの読み書き権限

read_locales, write_locales

ショップの地域言語設定データの読み書きできる権限

例 - App Bridge

注) .cshtml (ASP.NET)です。


<script src="https://unpkg.com/@@shopify/app-bridge"></script>
<script>

  // Handle parameters
  var url_string = window.location.href
  var url = new URL(url_string);
  var shopOrigin = url.searchParams.get("shop");
  setCookie("shopify_domain", shopOrigin, 90);

  // Create app
  var AppBridge = window['app-bridge'];
  var createApp = AppBridge.createApp;
  var actions = AppBridge.actions;
  var Redirect = actions.Redirect;

  const apiKey = '@ViewData["ApiKey"]';
  const redirectUri = '@ViewData["RedirectUrl"]';
  const permissionUrl = '/oauth/authorize?client_id=' + apiKey + '&scope=read_products,read_content,read_orders &redirect_uri=' + redirectUri;

  // If the current window is the 'parent', change the URL by setting location.href
  if (window.top == window.self) {
    window.location.assign('https://' + shopOrigin + '/admin' + permissionUrl);

  // If the current window is the 'child', change the parent's URL with Shopify App Bridge's Redirect action
  } 
  else {
    const app = createApp({
      apiKey: apiKey,
      shopOrigin: shopOrigin,
    });

  Redirect.create(app).dispatch(Redirect.Action.ADMIN_PATH, permissionUrl);
}
</script>

参照

下記を参照しました。
https://shopify.dev/docs/admin-api/access-scopes

10
11
1

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
10
11