Shopify developers（RESTAPI接口整理）

Shopify developers

作用：

• 解決了許多最困難的商業問題，但每個企業都有其獨特的需求。

REST reference（REST參數）

Shopify Payments

Balance（餘額）：

• 帳戶的當期餘額。這個數額包括任何交易尚未包括在支出.

• 檢查賬戶的餘額

Dispute（糾紛）：

• 當買方對其金融機構的一項指控的合法性提出質疑

• 爭議財產屬性（id,order_id(訂單id),type(類型：多種類型),currency(貨幣),amount(金額),reason(原因：多種原因),network_reason_code(網絡原因碼),status(狀態：多種狀態),evidence_due_by(提供證據截至時間),evidence_sent_on(發送證據時間),finalized_on(定安的結果)）

Payouts(支出)

• 貨幣在Shopify國際賬戶餘額和相關銀行賬戶之間的流動。
• 支出屬性（id(唯一標識符),status(狀態：多種狀態),date(日期),currency(貨幣),amount(金額)）

Transactions(交易)

• 餘額交易構成規範的“帳戶報表”，或一個Shopify支付帳戶的分類賬。資金進出賬戶的每一次流動都記錄在這裏。
• 交易屬性(id,type(類型：多種類型),test(試驗),payout_id(支出id),payout_status(支付狀態),currency(貨幣),amount(金額),fee(收費),net(淨額),source_id(來源id),source_type(來源類型：多種類型),source_order_transaction_id(源訂單交易id),source_order_id(源順序id),processed_at(處理事務的時間))

Access API（訪問API）

AccessScope特性（存儲範圍）

"access_scopes": [
  {
    "handle": "write_product_listings"
  },
  {
    "handle": "read_shipping"
  }
]

AccessScope（訪問範圍）

• 查看應用程序安裝過程中商家批准的訪問範圍。

StorefrontAccessToken（店面訪問令牌）

• 生成一個訪問店面API的店面訪問令牌。

• StoreFrontAccessToken屬性(id,access_token,access_scope,created_at,title)屬性都是隻讀，但是不受唯一約束

Analytics API（分析報告）

• Shopify Query Language 編寫從可用的Shopify架構獲取數據的查詢。ShopifyQL查詢可用於使用ReportAPI發佈報表。
• Report 創建、更新和刪除顯示在Shopify admin的Reports頁面上的報表。每個報表都是由使用Shopify查詢語言(ShopifyQL)編寫的查詢生成的。

Shopify查詢語言

Analytics API被稱爲ShopifyQL。有效的ShopifyQL查詢由類似於有效SQL請求的部分組成。讓我們看一個例子。

SHOW sum(pageview_count) FROM visits SINCE -7d UNTIL -1d

獲取數據(顯示)

使用ShopifyQL選擇、篩選和聚合數據有多種方法。

• 柱：每個模式都由許多列組成。

SHOW utm_campaign_name, utm_campaign_term, utm_campaign_source

• 聚合函數
  • 有一些功能可以幫助收集或彙總數據。
  • sum（總和）
  • min（最小值）
  • max（最大值）
  • count（計數）
  • DISTINCT（行的唯一計數）
  • avg（平均值）

別名

常用的聚合表達式作爲命名別名提供。

SHOW total_pageviews VS SHOW sum(pageview_count)

上的命名別名visits模式類型都是number：

• avg_duration avg(持續時間)

• total_pageviews 和(頁面瀏覽計數)

• total_purchases 總金額(購貨計數)

• total_sessions 計數(頁面瀏覽計數)

• total_visitors 計數(不同的用戶令牌)

SHOW sum(pageview_count) AS pageviews

Aggregate Conditions

類中的條件提供支持。SHOW聲明。這些可以用來過濾從包含到聚合函數中的行。聚合條件使在通常需要兩個或兩個以上的單個查詢中返回結果成爲可能。

sum(IF page_path == '' THEN pageview_count) AS home_pageviews, sum(IF page_path != '' THEN pageview_count) AS other_pageviews

Selecting schemas (FROM)

模式由關鍵字選擇。FROM。這與SQL的工作方式類似。下面的查詢使用visits模式：

SHOW sum(pageview_count) FROM visits

Shopify提供了幾個模式，您可以從中獲取數據：

• Sales schema 銷售模式

  • 使用SINCE和UNTIL將過濾訂單的日期，銷售或退款事件發生。使用SINCE -1m UNTIL today將退還上個月發生的所有銷售和退款。

    • SHOW orders, gross_sales, discounts, refunds, net_sales, shipping, taxes, total_sales
      OVER month(happened_at) AS month
      FROM sales
      SINCE -11m
      UNTIL today ORDER
      BY month ASC
      

  • Sale properties（出售屬性）

  • Order properties（訂單屬性）

  • Product properties（產品屬性）

  • Customer properties（客戶屬性）

  • Referral traffic properties（推薦流量屬性）

  • Marketing campaign properties（營銷活動屬性）

  • Sales channel properties（銷售渠道屬性）

• Payments schema 支付模式

  • 使用SINCE和UNTIL將在交易日期前過濾付款和退款。使用SINCE -1m UNTIL today將退還上個月發生的所有付款和退款。

    • SHOW orders, gross_payments, refunded_payments, gift_card_payments, net_payments, total_payments BY payment_method, digital_wallet
      FROM payments
      SINCE -7d
      UNTIL -0d
      ORDER BY net_payments DESC
      

  • Payments properties（支付屬性）

  • Transaction properties（交易屬性）

  • Order properties（訂單屬性）

  • Customer properties（客戶屬性）

  • Sales channel properties（銷售渠道屬性）

• Taxes schema 稅收模式

  • SHOW taxes
    BY tax_name, tax_rate
    FROM taxes
    SINCE -7d
    UNTIL today
    

  • Tax properties（稅收屬性）

  • Product properties（產品屬性）

  • Customer properties（客戶屬性）

  • Sales channel properties（銷售渠道屬性）

• Visits schema 訪問模式

  • SHOW total_visitors, total_sessions
    OVER day(timestamp) AS day
    FROM visits
    SINCE -7d
    UNTIL today ORDER
    BY day ASC
    

  • Behaviour properties（訪問屬性）

  • Device properties（設備屬性）

  • Landing page（着陸頁）

  • Referral traffic properties（推薦流量屬性）

  • Marketing campaign properties（營銷活動屬性）

  • Location properties（位置屬性）

• Customers schema 客戶模式

  • SHOW count(1) AS new_customer_count, sum(total_order_count) AS orders, sum(total_order_value) AS order_value
    OVER month(happened_at) AS month
    FROM customer_analytics
    SINCE -11m
    UNTIL today ORDER
    BY month ASC
    

  • Order properties（訂單屬性）

  • Customer properties（客戶屬性）

  • billing_company（客戶細分）

Filtering (WHERE)

使用聚合條件

SHOW sum(IF ((cancelled_at == NULL) AND ((deleted_at == NULL) AND (financial_status != ""))) THEN discounted) AS total_discounted,
sum(IF ((cancelled_at == NULL) AND ((deleted_at == NULL) AND (financial_status != ""))) THEN gift_card) AS total_gift_card,
sum(IF ((cancelled_at == NULL) AND ((deleted_at == NULL) AND (financial_status != ""))) THEN (shipping + (subtotal_price + tax_added))) AS total_sales
FROM orders

使用WHERE條款

SHOW sum(discounted) AS total_discounted, sum(gift_card) AS total_gift_card, sum(shipping + subtotal_price + tax_added) AS total_sales
FROM orders
WHERE cancelled_at == NULL AND deleted_at == NULL AND financial_status != ""

有效的運算符是：

• !=
• ==
• IN

---

Grouping data

按日分列的頁面瀏覽總數(最後7天)

SHOW sum(pageview_count) BY day(timestamp) FROM visits SINCE -7d UNTIL -1d

Grouping with backfill (OVER)

每日總瀏覽次數(最後7天)

SHOW sum(pageview_count) OVER day(timestamp) FROM visits SINCE -7d UNTIL -1d

時間函數

存在一些時間函數：day, month, week和year。這些可用於與.BY或OVER將數據分解爲特定時間段。

SHOW sum(pageview_count) OVER month(timestamp) AS month

這將是每個月的水桶瀏覽量。請注意，只有某些類型的屬性(通常只與時間相關的屬性)可以回填。

時間範圍(自/至)

在編寫ShopifyQL查詢時，強烈建議使用時間/日期約束。不包括SINCE和UNTIL子句將導致一個查詢，該查詢會掃描整個數據集，該數據集可能包含多年數據並花費相當長的時間。

支持顯式日期，例如2016-01-28。還支持相對日期。

鑰匙	單位
d	第七天：從-7d開始
w	周Eg：自-3w
m	月EG：自-200萬
y	Eg年：自-1Y

請注意SINCE將從一天開始拍攝，同時UNTIL會一直持續到今天。

例如。假設今天是2016-02-04

SINCE -7d UNTIL -1d`相當於`SINCE 2016-01-28 UNTIL 2016-02-03

Billing APIs(計費API)

• RecurringApplicationCharge（循環應用程序收費） 向商店收取使用程序的訂閱費，30天收費一次
  • RecurringApplicationCharge屬性（activated_on(已激活),billing_on(開單),cancelled_on(取消),capped_amount(上限量),confirmation_url(接受或拒絕重複應用程序費用的URL),created_at(創建時間),id(循環應用程序費用的ID),name(名字),price(價格：最高一萬英鎊),return_url(重定向的URL),status(狀態：多狀態),terms(條款),test(測試),trial_days(試用的天數),trial_ends_on(免費試用結束時),updated_at(更新時間)）
• ApplicationCharge（應用費用） 通過創建應用程序收費，向商店收取一次性費用。
  • ApplicationCharge屬性(confirmation_url(接受或拒絕重複應用程序費用的URL),created_at(創建時間),id(申請費用的ID),name(名字),price(價格：最高一萬英鎊),return_url(重定向的URL),status(狀態：多狀態),test(測試),updated_at(更新時間))
• UsageCharge（使用費） 根據您的應用程序的每個月使用情況收取不同的金額
  • 創建使用費：若要創建使用費用，請發送POST請求，其中{id}表示先前創建的定期應用程序費用的ID。
  • 只收取使用費：一種常見的計費方案是隻收取基於使用的費用，而不收取固定的每月經常性費用。若要僅收取基於使用的費用，而不收取每月經常性費用，請首先創建重複申請費用價格爲0.00美元，然後支付使用費。
  • 設定上限金額：可以使用RecurringApplicationCharge資源指定應用於基於使用的計費的上限金額。這將防止客戶因任何超過上限的使用而被收取費用。若要實現上限金額計費，請使用上限金額創建一個重複的應用程序費用，然後創建相關的使用費用。
• ApplicationCredit（應用信用） 請求爲特定商店創建應用程序信用
  • ApplicationCredit 屬性(description(描述),id(應用程序信用的ID),amount(金額),test(測試))

Customer APIs（客戶API）

幫助商家管理他們的客戶數據。

• Customer Address（客戶地址）：管理商店的客戶地址。客戶可以有多個地址，其中之一是用於計算稅收和運費的默認地址。

• Customer（客戶）：添加或更新有關商店客戶的信息，包括他們的地址，以及他們是否在商店中有活躍的客戶帳戶。

  • 在商店的結賬設置中，客戶帳戶有三個選項：
    • 帳戶被禁用客戶不能創建賬戶，只能作爲客人結賬。
    • 帳戶是可選的：：客戶可以選擇登錄他們的帳戶或作爲客人退房。客戶可以爲自己創建帳戶，店主可以爲客戶創建一個帳戶，然後通過電子郵件邀請他們使用。
    • 需要帳戶：客戶不能結帳，除非他們登錄，店主必須創建他們的帳戶。

• CustomerSavedSearch（客戶保存的搜索）：添加或更新客戶保存的搜索。保存的搜索幫助商人組織他們的客戶成組，他們可以從他們的管理員快速訪問。它們對於指定客戶集也很有用，例如有資格使用特定折扣代碼的客戶。

Discount API（折扣API）

幫助商家提供靈活的折扣。

• PriceRule（價格規則）：創建折扣邏輯，然後使用DisCountCodeAPI將代碼與折扣關聯起來，以便在簽出時應用。
• DiscountCode（折扣代碼）：使用PriceRuleAPI設置折扣邏輯之後，使用DisCountCodeAPI將折扣與代碼關聯起來，代碼可以在結帳時輸入以應用折扣。

Event API（事件API）

獲取事件數據或註冊網頁掛鉤，以保持您的應用程序同步與商家商店。

• Event（事件）：檢索事件列表，這些事件是商店操作中的重要操作。Shopify記錄一系列資源的事件，每個資源都有自己的一組創建事件的操作。

• Webhook：使用WebHooks檢索和存儲事件數據。

Inventory API（庫存API）

• InventoryLevel（庫存級別）： 在某個位置獲取或更新庫存項目的庫存級別。每個庫存級別都與單個庫存項目和地點相關聯。

• Location（位置）：從他們的Shopify管理中檢索商家設置的位置。每個地點都是指企業總部、零售店和彈出式商店的地址。商店的位置用於跟蹤銷售和配置在結帳時應用的稅率。

• InventoryItem（庫存項目）：列出或更新一個變體的清單項目。每個變體可以有一個清單項目，每個清單項目可以有多個位置。每個位置可以有許多變體的許多庫存項目。

MarketingEvent（營銷活動）

• 營銷活動代表您的應用程序，代表商家採取的行動，以市場產品，收藏，折扣，網頁，博客帖子，和其他功能。營銷活動代表的是針對多個潛在客戶的行動，而不是針對特定個人的行動。例如，你應該在電子郵件活動層面上對你的營銷活動進行建模，而不是在每封郵件的基礎上。
• 包括event_type和marketing_channel屬性，幫助Shopify對您的應用程序進行排序，並在Shopify管理中以對商家有用的方式顯示它。您的應用程序的流量和訂單屬性是通過提供UTM參數和您的營銷活動來處理的。在營銷活動中提供的鏈接中也使用相同的UTM參數。訂婚還可以添加到營銷活動中，讓商家更深入地瞭解潛在客戶如何與您的營銷活動互動。例如，廣告活動的參與可以包括點擊、分享和評論。

Metafield

• Metafield資源允許您向其他AdminAPI資源添加其他信息。Metafield可以以多種方式使用，例如將摘要添加到博客文章中。您還可以使用元字段與其他Shopify應用程序共享信息。

Online store API（網上商店API）

• Comment（評語）管理讀者對文章的評論(博客文章)。每一篇文章都有很多評論。一些可用的操作包括創建評論、更新評論、刪除評論、將評論標記爲垃圾郵件和批准註釋。

• Page（頁）爲在線商店創建和更新靜態頁面。

• ScriptTag：將遠程JavaScript加載到在線商店的店面和訂單狀態頁中，以添加功能，而無需修改商店的主題文件。

• Redirect（重定向）：爲商家的在線商店管理301重定向。

• Blog（博客）：創建、編輯和刪除商店的博客。每個商店可以有多個博客，每個博客可以有很多文章(博客帖子)。使用文章API來管理每個博客的文章。

• Asset（資產）：管理構成商店主題的文件，以更改在線商店的外觀。

• Theme（主題）：管理商店的主題，控制在線商店的外觀和感覺。使用AssetAPI更新主題中的特定文件。

• Sections（章節）：用於章節主題架構的RESTAPI。

• Article（文章）：管理商店的物品。每一篇文章都屬於一個博客，可以有很多評論。

Order API（訂單API）

• Abandoned checkouts（不完整賬單）：檢索不完整簽出的列表。每個Checkout對象都包含一個指向在線結帳的URL，客戶可以在那裏完成他們的購買。
• Order Risk（訂單風險）：在訂單的詳細信息頁上顯示欺詐分析和建議。
• DraftOrder：允許商家代表客戶手工創建訂單。訂單在Shopify管理中保存爲草稿，直到它被標記爲已完成爲止。
• Order（訂單）：爲訂單創建和檢索事務。事務是爲每一個導致貨幣交換的訂單創建的。
• Refund（退款）：爲訂單創建並檢索退款。每一次退款都是退貨給客戶的記錄。使用計算端點確保您創建的任何退款都是準確的。

Plus（額外內容）

使用專用於Shopify Plus的API爲高GMV商家創建自定義功能。

• Gift Card（禮品卡）創建和管理禮品卡代碼，這些代碼可以在結帳時輸入，以便使用禮品卡支付。
• User（用戶）檢索員工帳戶的權限。從Shopify管理，商人可以給予每個職員帳戶的全部權限或個人權限，以控制對Shopify一部分的訪問。
• Multipass（多通）：管理跨多個應用程序的客戶身份驗證，爲這些網站提供單一的登錄體驗。

Product API（產品API）

• Product Image（產品圖片）：添加或更新商店的產品圖像，銷售渠道用於向購物者顯示產品。
• CustomCollection（產品集合）：管理商店的自定義集合。自定義集合是手動包含產品的集合，而不是因爲滿足選擇條件而自動包含。
• Product Variant（產品尺寸）：添加或更新產品的變體。變體是產品選項的不同組合。例如，帶有大小和顏色選項的t恤產品可能有一個小尺寸和藍色的變體。
• Product（產品）：管理商店的產品，這些產品是商店銷售的個別商品和服務。
• Collection（收藏）：創建自定義集合後，通過爲每個產品創建一個集合來向其添加產品。每個集合將一個產品與一個自定義集合關聯起來。
• SmartCollection（智能收藏）：通過定義選擇條件創建或更新智能集合。符合條件的產品將自動包含在集合中。

Sales channel API（銷售渠道API）

• CollectionListing（集裝）：管理髮布到銷售渠道的集合並檢索其信息。
• Payment（付款）：創建和更新支付，爲您的銷售渠道提供自定義結帳體驗。
• Checkout（結賬）：創建和更新結帳，爲您的銷售渠道提供自定義的結帳體驗。
• ResourceFeedback（資源反饋）：通知商家需要採取的行動，以解決您的應用程序錯誤。
• ProductListing（產品提升）：管理銷售渠道可用的產品並檢索其信息。

Shipping and fulfillment API（運輸和履行API）

• CarrierService（載波業務）：在您的自定義託運服務結帳前提供實時發貨計算。
• Fulfillment（履行）：管理訂單行項目的完成。爲每一批貨物創建一個實現，提供跟蹤信息，並通知客戶他們的產品已經發貨。
• AssignedFulfillmentOrder（指定履行訂單）：查看分配給應用程序的商店的完成訂單。
• FulfillmentService（履行服務）：在商店註冊一項履行服務。然後，商家可以將其設置爲其產品的履行服務，您的服務可以使用履行和充實事件API管理這些產品的實現。
• FulfillmentOrder（履行訂單）：按照要從同一位置執行的順序管理一項或一組項目。檢索和取消完成訂單，將完成訂單標記爲不完整，或將完成訂單移動到新位置。
• FulfillmentRequest（履行要求）：管理分配給履行服務的履行訂單的實現請求流程。
• FulfillmentEvent（履行事件）：爲訂單的完成創建完成事件。實現事件將顯示在“訂單狀態”頁面上，以便客戶能夠跟蹤其交付過程。
• LocationsForMove（移動位置）：查看履行訂單可能移動到的位置。
• CancellationRequest（取消請求）：管理分配給履行服務的履行訂單的取消請求流程。

Store property API（管理商店的配置）

• Country（國家）：在結帳時管理適用於適用項目的國家和省級稅率。
• Province（省）：管理應用於來自特定省或州的訂單的稅率。
• Shop（商店）：訪問由商家在Shopify管理中配置的商店的一般設置和信息。
• Currency（貨幣）：檢索啓用的貨幣列表及其上一次更新匯率的時間。
• Policy（政策）：檢索商店的策略列表，如退款政策、隱私政策或服務條款。

TenderTransaction（投標交易）

​ 每一次招標交易都代表商人與客戶之間的資金轉移。一筆金額爲正數的招標交易是指客戶向商家支付款項的交易。負金額是指商家將資金退還給客戶的交易。投標交易是指修改商店餘額的交易。

ionsForMove（移動位置）：查看履行訂單可能移動到的位置。

• CancellationRequest（取消請求）：管理分配給履行服務的履行訂單的取消請求流程。

Store property API（管理商店的配置）

• Country（國家）：在結帳時管理適用於適用項目的國家和省級稅率。
• Province（省）：管理應用於來自特定省或州的訂單的稅率。
• Shop（商店）：訪問由商家在Shopify管理中配置的商店的一般設置和信息。
• Currency（貨幣）：檢索啓用的貨幣列表及其上一次更新匯率的時間。
• Policy（政策）：檢索商店的策略列表，如退款政策、隱私政策或服務條款。

TenderTransaction（投標交易）

​ 每一次招標交易都代表商人與客戶之間的資金轉移。一筆金額爲正數的招標交易是指客戶向商家支付款項的交易。負金額是指商家將資金退還給客戶的交易。投標交易是指修改商店餘額的交易。

總結

Shopify developers擁有着自己的店鋪框架，一站式開發、並管理其所有電商業務：銷售渠道 (如電商網站、社交媒體、第三方平臺、B2B批發等)、設計 、支付、訂單、倉儲、物流、 客戶信息、廣告營銷、第三方工具等。