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批发等)、设计 、支付、订单、仓储、物流、 客户信息、广告营销、第三方工具等。