帮助
登录

使用 JSON 在 Shopify 后台中访问详细数据

JSON 是 JavaScript Object Notation 的缩写，是一种用于存储和传输数据的格式，通常在数据从服务器发送到网页时使用。在 Shopify 后台的大多数资源页面（例如订单、产品或客户页面）中，您可以使用 JSON 访问更详细的数据。

虽然您无需使用 JSON 执行高级开发任务，但能够访问 Shopify 后台内特定资源的 JSON 文件可帮助您收集更详细的信息，或自行排查或调查问题。例如，您可以查看产品的 JSON 文件以查找其多属性 ID，某些数据迁移任务或模板代码自定义可能需要此 ID。再举一个例子，在 Shopify Flow 中构建自动化工作流时，您可以引用订单的 JSON 文件来确认要使用的数据变量。

JSON 最常由开发人员使用，但即使是编码知识有限的用户，也可以通过学习如何在 Shopify 后台中查找和解读一些常见的 JSON 信息而受益。

本页相关主题

重新格式化 JSON 文件

原始 JSON 数据显示为一长串嵌套的变量和括号，对人类用户来说很难阅读。

为使 JSON 格式更具可读性，请考虑以下任一选项：

  • 在您的浏览器中安装JSON 查看器扩展程序。
  • 使用大多数新式 Web 浏览器默认提供的 pretty-print 特性：

显示产品信息示例的 JSON 产品文件的屏幕截图。“pretty-print”复选框设置处于激活状态，并在页面左上角突出显示。

在 Shopify 后台中访问 JSON 文件

Shopify 后台是管理业务各方面的中心，它在默认情况下旨在仅显示最有用和最相关的信息。每当在后台中执行操作时，系统收集的额外信息会存储在不同资源页面的 .json 文件中。这些额外的详细信息默认不会向您显示，因为海量信息会令人不知所措且毫无帮助，并且还会导致您的后台难以使用。

对于大多数业务任务，您可以使用 Shopify 的现有工具来访问和解读商店的信息。但是，在对某件事发生的原因或时间进行故障排除时，查看有关特定资源（例如产品或订单）的具体信息有时会很有帮助。

示例：访问订单的 JSON 文件

在此示例中，您将在 Shopify 后台中访问订单的 JSON 文件。

步骤：

  1. 在 Shopify 后台中，转至订单。

  2. 点击订单列表中的任一订单。

  3. 在浏览器地址栏中，将 .json 添加到 URL 地址的末尾。它将与此示例类似：

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json
  1. 按 Enter 键以 JSON 格式重新加载页面。
  2. 可选：如果您的浏览器中未安装 JSON 查看器扩展程序，请在浏览器中激活 Pretty-print 设置，以使 JSON 文件更易于使用。详细了解重新格式化 JSON 文件。

您会注意到系统会显示大量关于订单的预期信息，例如与订单关联的 "currency" 和 "line_items"，但其中也包含许多其他详细信息，例如客户下单时其浏览器访问中的 "client_details"。此类信息对于整体访问跟踪和营销平台分析非常有用，但对于您处理订单和为订单发货并非必要信息。

在 JSON 文件中显示特定字段

您可以强制 JSON 文件仅显示特定字段，这样当您知道要包含的特定属性时，信息会更易于解读。在浏览器地址栏中任何 JSON 文件 URL 的末尾，添加 ?fields=，然后按任意顺序添加要显示的属性名称，并用逗号分隔。

例如，若要显示订单的 ID、客户信息、总价和标记，请将 ?fields=id,customer,total_price,tags 添加到 JSON 文件 URL 的末尾，如以下示例所示：

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json?fields=id,customer,total_price,tags

使用其他 JSON 资源

您可以使用以下 JSON 资源在 Shopify 后台中显示特定信息：

  • 产品计数：在产品列表 URL 的末尾添加 /count.json 以显示产品总数。完整的 URL 应为：
https://admin.shopify.com/store/{example-shop-name}/products/count.json
  • 交易：在订单页面 URL 的末尾添加 /transactions.json 以仅显示订单交易信息。详细了解交易资源。
  • 发货：在订单页面 URL 的末尾添加 /fulfillments.json 以仅显示订单发货信息。详细了解发货资源。
  • 弃单：在弃单 URL 的末尾添加 .json 以显示有关该弃单的详细信息。详细了解弃单资源。

用于故障排除的常用 JSON 属性

下表列出了在对不同资源类型进行故障排除时可能需要参考的 JSON 属性。例如，如果您想确认某个特定产品的发布时间，则可以查看该产品的 JSON 文件中的 published_at 属性，该属性以 ISO 8601 格式显示日期和时间。

此表并未包含 Shopify 后台中存储的所有可能的 JSON 资源或属性，因此，对于此处未包含的任何资源或属性的定义，请参阅 Shopify 开发人员文档。

列出了一些示例后台资源及其关联的常用属性，其中包括它们在故障排除时的用途定义。
资源JSON 属性定义
产品
"product": {
  "created_at"
产品最初创建的时间和日期。
"product": {
  "published_at"
产品的状态被设置为在售的时间和日期。
"product": {
  "updated_at"
产品最近一次更新的时间和日期。这可能包括对产品描述、标题或 SEO 信息的更改，以及产品售出后库存发生变化等自动更新。
多属性
"product": {
  "variants": [
    {
    "created_at"
多属性最初创建的时间和日期。这可能与整个产品的创建日期和时间不同。
"product": {
  "variants": [
    {
    "updated_at"
多属性最近一次更新的时间和日期。这可能与整个产品的上次更新日期和时间不同。
"product": {
  "variants": [
    {
    "inventory_quantity"
当前的数据库值，以及客户可购买的数量。如果未跟踪多属性库存或将其设置为超卖，则该值可能为负值。
"product": {
  "variants": [
    {
    "old_inventory_quantity"
多属性的上个 updated_at 日期之前的数据库值。
订单
"order": {
   "line_items": [
    {
    "requires_shipping"
显示为 true 或 false。这表示下单时产品或多属性的发货设置。
"order": {
   "line_items": [
    {
    "taxable"
显示为 true 或 false。这表示下单时产品或多属性收取税款的设置方式。
"order": {
   "line_items": [
    {
    "variant_inventory_management"
显示为 shopify、amazon_marketplace_web、null 或第三方值，具体取决于设置为跟踪产品库存的发货服务。值为 null 表示下单时未跟踪该产品。
"order": {
   "line_items": [
    {
    "fulfillable_quantity"
显示系统为完成订单仍保留的库存量。这不等于当前多属性库存。
"order": {
   "line_items": [
    {
    "quantity"
已购买的产品或多属性的数量。
"order": {
   "line_items": [
    {
    "tax_lines"
在美国，此字段显示州、县和市级的值。如果未显示任何税费行，但订单上收取了税费，则表示税费是针对发货成本收取的。
客户
"customer": {
  "created_at"
客户最初创建的时间和日期。
"customer": {
  "updated_at"
客户资料最近一次更新的时间和日期。

JSON 中的元字段

元字段是一种将其他自定义信息附加到 Shopify 资源（例如产品或产品系列）的灵活方式。使用元字段存储的数据的一些示例包括产品规格、尺寸图表、可下载的文档、发布日期、图片或部件号。详细了解如何使用元字段。

您可以在受支持的资源页面 URL 末尾添加 /metafields.json，以显示与该资源关联的元字段。有关使用 JSON 显示元字段信息的资源和 URL 格式的一些示例，请参阅下表。

列出一些示例后台资源以及示例 JSON 元字段文件 URL。
示例资源类型示例 URL
智能产品系列https://admin.shopify.com/store/{your-store-name}/collections/{collection-id}/metafields.json
客户https://admin.shopify.com/store/{your-store-name}/customers/{customer-id}/metafields.json
订单https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/metafields.json
页面https://admin.shopify.com/store/{your-store-name}/pages/{page-id}/metafields.json
产品https://admin.shopify.com/store/{your-store-name}/products/{product-id}/metafields.json
多属性https://admin.shopify.com/store/{your-store-name}/products/{product-id}/variants/{variant-id}/metafields.json
产品图片https://admin.shopify.com/store/{your-store-name}/metafields.json?metafield[owner_id]={id}&metafield[owner_resource]=product_image

备注：产品图片元字段只能通过 API 添加。请将 URL 中的 {id} 和其他占位符替换为 API 查询中的实际值。

商店https://admin.shopify.com/store/{your-store-name}/metafields.json

有关可拥有元字段的资源的完整列表以及为每种资源类型存储的特定属性类型，请参阅 Shopify 开发人员文档中的元字段 JSON 资源。

JSON 中的事件

在完成某些操作（例如创建博客文章、为订单发货或添加产品）时，一些 Shopify 资源会生成事件。

您可以在受支持的资源页面 URL 的末尾添加 /events.json，以显示与该资源关联的事件。有关使用 JSON 显示事件信息的资源和 URL 格式的一些示例，请参阅下表。

列出一些示例后台资源以及示例 JSON 事件文件 URL。
示例资源类型示例 URL
订单https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/events.json

此文件列出了事件的 author，告知您哪些用户完成了某些操作，例如谁或什么发布了产品。

产品https://admin.shopify.com/store/{your-store-name}/products/{product-id}/events.json

此文件列出了事件的 author，告知您哪些用户完成了某些操作，例如谁或什么将支付标记为已付款。

商店https://admin.shopify.com/store/{your-store-name}/events.json?limit=250

此 URL 格式会显示您商店中发生的最近 250 个事件。事件可以包括但不限于产品创建或更新、页面删除和多属性更新。

有关可创建事件的资源的完整列表以及为每种资源类型创建的特定事件，请参阅 Shopify 开发人员文档中的事件 JSON 资源。