商店迁移数据代码库

商店迁移数据代码库包含有关 REST Admin API CustomerOrderProduct 的信息。对于在向 Shopify 迁移商店方面拥有丰富经验的合作伙伴数,据代码库是的一个补充参考。

备注:数据代码库中的信息已针对 Shopify API 版本 2022-01 进行验证。有关最新信息和示例,请参阅 REST Admin API 参考文档

Customer 资源属性

下表列出了一些有关 REST Admin API 属性的有用信息 Customer 资源。

有关与 REST 客户资源相关的重要属性的数据
属性 描述 数据类型 字段长度 字段访问权限 关键必填字段
accepts_marketing 默认值:0 客户是否同意接收营销材料。 布尔 tinyint(1) Y
accepts_marketing_
updated_at
客户同意或反对通过电子邮件接收营销材料时采用 ISO 8601 格式的日期和时间。 Datetime
地址 与客户关联的地址列表。 [{ Address }]
currency 采用 ISO 4217 格式的三个字母代码,表示客户在支付上一个订单时使用的货币。 字符串 商店货币 只读
创建时间 默认值:NULL 将客户添加到商店时采用 ISO 8601 格式的日期和时间。 Datetime Datetime 只读
default_address 客户的默认地址。 { Address }
email 默认值:NULL 客户的唯一电子邮件地址。 字符串 varchar(255)
first_name 默认值:NULL 客户的名字。 字符串 varchar(255)
id 默认值:NULL 全球唯一标识符。(此值自动递增。) 整数 bigint (20) Y
last_name 默认值:NULL 客户的姓氏。 字符串 varchar(255)
last_order_id 默认值:NULL 客户最后一个订单的 ID。 整数 bigint (20) 只读
last_order_name 默认值:NULL 客户最后一个订单的名称。 字符串 只读
元字段 默认值:NULL 按命名空间和属于资源的密钥返回元字段。 { Metafield }
marketing_opt_
in_level
  • null
  • single_opt_in
  • confirmed_opt_in
  • unknown
默认值:NULL
客户同意通过电子邮件接收营销材料时所给予的营销订阅加入等级(如 M3 最佳做法指南所述)。 字符串,enum
multipass_identifier 默认值:NULL 使用 Multipass 登录的客户的唯一标识符。 字符串 varchar(255)
注意 默认值:NULL 有关客户的备注。 字符串 mediumtext
orders_count 默认值:0 客户使用期内在商店中所下的订单数。 整数 int(11) 只读
电话 默认值:NULL 此客户的唯一(跨商店)电话号码(E.164 格式)。 字符串 varchar(255)
sms_marketing_
consent
默认值:NULL 客户电话号码的当前短信营销状态。 字符串
状态
  • disabled
  • invited
  • 已启用
  • 拒绝
默认值:disabled
客户账户在商店中的状态。 字符串,enum varchar(255) 只读
标签 默认值:NULL 已为客户添加最多 250 个标签的逗号分隔列表。 字符串 每个标签 255 字符
tax_exempt 默认值:0 客户的订单是否免税。 布尔 tinyint(1) Y
tax_exemptions 请参阅客户资源 ,了解完整的值列表。 应用于客户的免税列表。 字符串
total_spent 默认值:0 客户一生中在订单上支出的总额。以商店货币列出。如果使用多币种,则显示的金额将采用默认货币,无汇率。 数字 decimal(21,3) 只读
updated_at 上次更新客户的日期和时间。基于 Shop 的时区。 Datetime Datetime 只读
verified_email 默认值:1 客户是否已验证其电子邮件地址。如果客户是通过 Shopify 后台或 API 创建的,则默认为 true。 布尔 tinyint(1) 只读

CustomerAddress 资源属性

下表列出了一些有关 REST Admin API CustomerAddress 资源属性的有用信息资源。此资源没有关键必填字段。

有关与 REST 客户地址资源相关的重要属性的数据
属性 描述 数据类型 字段长度 字段访问权限
address1 默认值:NULL 客户的邮寄地址。每个客户账户为 100。 字符串 varchar(255)
address2 默认值:NULL 客户邮寄地址的其他字段。 字符串 varchar(255)
city 默认值:NULL 客户的城市、城镇或村。 字符串 varchar(255)
company 默认值:NULL 客户的公司。 字符串 varchar(255)
国家/地区 默认值:NULL 客户所在的国家/地区。 字符串 varchar(255)
first_name 默认值:NULL 客户的名字。 字符串 varchar(255)
country_code 与客户的国家/地区对应的两个字母的国家/地区代码。 字符串 只读
country_name 客户的常态化国家/地区名称。 字符串
last_name 默认值:NULL 客户的姓氏。 字符串 varchar(255)
姓名 客户的名字和姓氏。 字符串
电话 默认值:NULL 客户在此地址的电话号码。 字符串 varchar(255)
province 默认值:NULL 客户的区域名称。通常是省、州或县。 字符串 varchar(255)
province_code 客户区域两个字母的代码。 字符串 只读
邮编 默认值:NULL 客户的邮政编码,也称为邮政编码、电子邮编等。 字符串 varchar(255)

Order 资源属性

下表列出了一些有关 REST Admin API 属性的有用信息 Order 资源。

有关 REST 订单资源的重要属性的数据
属性 描述 数据类型 字段长度 字段访问权限 关键必填字段
app_id 默认值:NULL 创建订单的应用的 ID。 整数 bigint (20) 只读
billing_address 默认值:NULL 与付款方式关联的邮寄地址。此地址是一个可选字段,对于不需要付款方式的订单,此字段不可用。 整数 bigint (20)
browser_ip 客户下单时使用的浏览器的 IP 地址。支持 IPv4 和 IPv6 。 string varchar(255) 只读
buyer_accepts_marketing 默认值:0 客户是否同意接收来自商店的电子邮件更新。 布尔值 tinyint(1)
cancel_reason
  • customer
  • 欺诈
  • 库存
  • 拒绝
  • other
默认值:NULL
取消订单的原因。 string varchar(255)
cancelled_at 默认值:NULL 取消订单的日期和时间。如果未取消订单,则返回 null。 date Datetime 只读
cart_token 默认值:NULL 引用与订单关联的购物车时的唯一值。 string varchar(255) 只读
checkout_token 默认值:NULL 引用与订单关联的结账时的唯一值。 string varchar(64) 只读
client_details
  • accept_language
  • browser_height
  • browser_ip
  • browser_width
  • session_hash
  • user_agent
客户下单时使用的浏览器的相关信息:

accept_language:浏览器理解的语言和区域设置。
browser_height:浏览器屏幕高度,以像素为单位(如果可用)。
browser_ip:浏览器 IP 地址。
browser_width:浏览器屏幕宽度,以像素为单位。(如果可用)
session_hash:会话的哈希值。
user_agent:浏览客户端的详细信息,包括软件和操作版本。
对象 只读
closed_at 默认值:NULL 订单关闭的日期和时间(ISO 8601 格式)。如果订单未关闭,则返回 null。 date Datetime 只读
创建时间 默认值:NULL 在 Shopify 中创建订单时自动更新的日期和时间(ISO 8601 格式)。无法更改此属性的值。 date datetime(6) 只读
currency 默认值:NULL 商店货币的三个字母代码(ISO 4217 格式)。 string char(3)
current_subtotal_price 以商店货币表示的订单的当前小计价格。此字段的值反映订单编辑、退货和退款。 string varchar(255) 只读
current_subtotal_price_set 订单的当前小计价格(以商店和展示的货币计算)。与此字段关联的金额反映了订单编辑、退货和退款。 对象 只读
current_total_discounts 当前以商店货币计算的订单总折扣。此字段的值反映订单编辑、退货和退款。 string varchar(255) 只读
current_total_discounts_set 以商店和展示货币计算的当前订单总折扣。与此字段关联的金额值反映订单编辑、退货和退款。 对象 只读
current_total_duties_set 以商店和展示货币计算的对订单收取的当前总关税。与此字段关联的金额值反映订单编辑、退货和退款。 对象 只读
current_total_price 订单的当前总价格(以商店货币表示)。此字段的值反映了订单编辑、退货和退款。 string varchar(255) 只读
current_total_price_set 以商店和展示货币计算的当前订单总价格。与此字段关联的金额值反映订单编辑、退货和退款。 对象 只读
current_total_tax 以商店货币表示的对订单收取的当前总税费。此字段的值反映订单编辑、退货和退款。 string varchar(255) 只读
current_total_tax_set 以商店和展示货币计算的对订单收取的当前总税费。与此字段关联的金额值反映订单编辑、退货和退款。 对象 只读
customer 默认值:NULL 关于客户的信息。订单中可能没有客户,应用不应取决于客户对象的成立。如果订单是通过 Shopify POS 创建的,此值可能为空 整数 bigint (20)
customer_locale 默认值:NULL 两个字母或三个字母的语言代码,后跟区域修饰符。 string varchar(255) 只读
discount_applications 叠加折扣申请的排序列表。

此 discount_applications 包括 3 种类型:discount_code、manual 和 script。所有这 3 种类型都拥有相同的结构,并且具有一些类型特定的属性。
阵列 只读
discount_codes 应用于订单的折扣列表。 阵列
email 客户的电子邮件地址 varchar(255)
estimated_taxes 订单的税费是否估算。从客户下单到订单发货之间,许多因素可能发生变化,这可能会影响税费的计算。完成订单税费后,此属性返回 false,且不会执行任何更改。 布尔值 tinyint(1)
financial_status
  • 待处理
  • authorized
  • partially_paid
  • 已付款
  • partially_refunded
  • refunded
默认值:NULL
与订单关联的付款状态。只能在创建订单时设置。 string varchar(255) 只读
fulfillment_status
  • 已发货
  • 未发货
  • null
  • 部分
  • restocked
默认值:unfulfilled
有关已发货的订单项的订单状态。 string varchar(255)
发货 与订单关联的一系列订单 阵列
id 默认值:NULL 订单 ID,用于 API 目的。这不同于 order_number 属性(这是店主和客户使用的 ID)。 整数 bigint (20) 只读
landing_site 默认值:NULL 客户进入商店时登陆页面的 URL。 string varchar(4096) 只读
line_items 订单项对象列表,每个对象都包含订单中商品的信息 阵列 Y
location_id 默认值:NULL 处理订单实际位置的 ID。如果您需要针对订单引用位置,请使用 FulfillmentOrder 资源。 整数 bigint (20)
姓名 默认值:NULL 订单名称,通过将 order_number 属性与商家通用设置中设置的订单前缀和后缀组合生成。这不同于 ID 属性,它是 API 使用的订单的 ID。此字段还可以由 API 设置为任何字符串值。 string varchar(255)
注意 默认值:NULL 店主可以附加到订单的可选备注。 string
note_attributes 默认值:NULL 添加到订单中的额外信息。显示在订单详细信息页面的“其他详细信息”部分中。每个数组条目必须包含哈希值及名称和值键。 string
number 默认值:NULL 订单在商店订单计数中的位置。数字是顺序的,从 1 开始。 整数 int(11) 只读
order_number 订单在商店订单计数中的位置(从 1001 开始)。订单号是顺序的。 整数 bigint (20) 只读
order_status_url 指向订单状态网页的 URL(如果适用)。 string varchar(255) 只读
original_total_duties_set 以商店和展示货币计算的对订单收取的原始总关税。 对象 只读
payment_gateway_names 默认值:NULL 用于订单的支付网关列表。
varchar(255) 只读
payment_terms 默认值:NULL 处理付款的条款和条件。 对象 bigint (20) 只读
电话 默认值:NULL 接收短信通知的客户电话号码。 string varchar(255)
presentment_currency 默认值:NULL 用于为客户显示价格的展示货币。 string char(3)
processed_at 默认值:NULL 处理订单的日期和时间(ISO 8601 格式)。此值是显示在您的订单上并且用于分析报告的日期。如果您要从应用或其他平台导入订单,您可以将订单 processed_at 设置为过去的日期和时间,以匹配创建原始订单的时间。 date datetime(6)
processing_method
  • 结账
  • 直接
  • 手动
  • offsite
  • express
  • 免费
付款的处理方式 string varchar(255) 只读
referring_site 默认值:NULL 客户在其中点击链接转到您商店的网站。 string varchar(4096)
退款 应用于订单的退款列表 阵列 只读
shipping_address 默认值:NULL 订单收货的邮寄地址。此地址可选,对不需要发货的订单不可用 整数 bigint (20)
shipping_lines 一组对象,每个对象都详细说明了使用的发货方式。 阵列
source_name 默认值:NULL 生成订单的来源。只能在创建订单期间设置,之后不可再写入设置。Shopify 渠道的值受保护,无法由其他 API 客户端分配:Web、pos、shopify_draft_order、iPhone 和 Android。可以为通过 API 创建的订单分配您所选择的任何其他字符串。如果未指定,系统会为新订单分配应用 ID 的值。 string varchar(255)
subtotal_price 应用折扣后但在扣除运费、关税、税费和小费之前以商店货币表示的订单价格。 整数 bigint (20)
subtotal_price_set 应用折扣后(但在扣除运费、关税、税费和小费之前)以商店和展示货币计算的订单小计。 对象
标签 附加到订单的标签,格式为以逗号分隔的值字符串。标签是额外的简短描述符,通常用于筛选和搜索。每个标签的长度限制为 40 个字符。 string varchar(4096)
tax_lines 一组税务订单对象,每个对象都详细说明了适用于订单的税费。每个对象具有以下属性:

通过 API 创建订单时,可以在订单或订单项目上指定税行,但不能同时在两者上指定。订单上指定的税行会拆分为已创建订单中的应纳税订单项目。
阵列
taxes_included
  • true
  • false
默认值:0
税费是否包含在订单小计中。 布尔值 tinyint(1)
test
  • true
  • false
默认值:0
这是不是测试订单。 布尔值 tinyint(1) 只读
token 默认值:NULL 引用订单时的唯一值。 string varchar(32) 只读
total_discounts 默认值:0 应用于以商店货币表示的订单价格的总折扣。 string decimal(21,3)
total_discounts_set 应用于以商店和展示货币计算的订单价格的总折扣。 对象
total_line_items_price 默认值:0 以商店货币计算的所有订单项目价格的总额。 string decimal(21,3)
total_line_items_price_set 以商店和展示货币计算的所有订单项目价格的总额。 对象
total_outstanding 默认值:0 以商店货币计算的订单的未结总额。 string decimal(21,3)
total_price 默认值:0 以商店货币计算的所有订单项目的价格、折扣、运费、税费和小费的总额。必须为正数。 string decimal(21,3)
total_price_set 以商店和展示货币计算的订单总价格。 对象
total_shipping_price_set 以商店和展示货币计算的订单的总运费(不包括折扣和退货)。如果 taxes_included 设置为 true,则 total_shipping_price_set 包含税费。 对象
total_tax 默认值:0 以商店货币计算的应用于订单的所有税费总额。必须为正数。 string decimal(21,3)
total_tax_set 应用于以商店和展示货币计算的订单总税费。 对象
total_tip_received 以商店货币计算的订单中的所有小费总额。 整数 bigint (20) 只读
total_weight 默认值:0 所有订单项目的总重量(以克为单位)。由于已从订单中删除项目,因此不会调整总重量。 整数 bigint(20) 未分配
updated_at 上次修改订单的日期和时间(ISO 8601 格式)。 date datetime(6) 只读
user_id 默认值:NULL 登录 Shopify POS 并处理订单的用户 ID(如果适用)。 整数 bigint (20)

Product 资源属性

下表列出了一些有关 REST Admin API 属性的有用信息 Product 资源。

关于 REST 产品资源的重要属性的数据
属性 描述 数据类型 字段长度 字段访问权限 关键必填字段
body_html 默认值:NULL 产品描述。支持 HTML 格式设置。 string mediumtext
创建时间 默认值:NULL 订单创建的日期和时间(ISO 8601 格式)。 date Datetime 只读
handle 默认值:NULL string varchar(255)
id 默认值:NULL 一个未签名的 64 位整数,用作产品的唯一标识符。每个 ID 在 Shopify 系统内都是唯一的。没有两种产品具有相同的 ID,即使它们来自不同的商店。 整数 bigint (20) 只读 Y
图片 产品图片对象的列表,每个对象代表与产品关联的图片。 [{ product_image }]
选项 自定义产品属性。例如,尺寸、颜色和材质。每个产品最多有 3 个选项,每个选项值最多为 255 个字符。产品多属性由选项值组合构成。在没有值的情况下无法创建选项。若要创建新选项,还需要创建具有相关选项值的多属性。 阵列
product_type 默认值:NULL 用于筛选和搜索产品的产品的分类。 string varchar(255)
published_at 默认值:NULL 产品发布日期和时间(ISO 8601 格式)。可以设置为 null 以从在线商店渠道取消发布产品。 date Datetime
published_scope
  • web
  • global
产品是否已发布到 POS 渠道。 string
状态
  • 活跃
  • 已存档
  • 草稿
默认值:active
产品的状态。 string varchar(32)
标签 一串以逗号分隔的标签,用于筛选和搜索。产品最多可以有 250 个标签。每个标签最多包含 255 个字符。 string
template_suffix 默认值:NULL 用于产品页面的 Liquid 模板的后缀。如果指定了此属性,则产品页面将使用名为“product.suffix.liquid”的模板,其中“suffix”是此属性的值。如果此属性为“”或 null,则产品页面使用默认模板“product.liquid”。 string varchar(255)
title 默认值:NULL 产品名称 string varchar(255)
updated_at 默认值:NULL 上次修改产品的时间(ISO 8601 格式)。产品 updated_at 的值可能出于不同原因而发生变化。例如,如果为已设置库存跟踪的产品下单,则库存调整计数为更新。 date Datetime 只读
多属性 一组产品多属性,每个代表了不同版本的产品。位置属性为只读。多属性的位置以列出的顺序表示。 阵列
供应商 默认值:NULL 产品供应商的名称。 string varchar(255)

ProductImage 资源属性

下表列出了一些有关 REST Admin API ProductImage 资源属性的有用信息资源。此资源没有只读或关键必填字段。

有关与 REST ProductImage 资源相关的重要属性的数据
属性 描述 数据类型 字段长度
创建时间 默认值:NULL 创建产品图片的日期和时间。API 返回此值(ISO 8601 格式)。 date Datetime
height 默认值:NULL 上传时确定的图片高度尺寸。 smallint(4) 未签名
id 默认值:NULL 产品图片的唯一数字标识符。(auto_increment) 整数 bigint (20)
position 默认值:0 产品图片在列表中的顺序。第一张产品图片位于位置 1,是产品的“主”图片。 smallint(5) 未签名
product_id 默认值:NULL 与图片关联的产品的 ID。 bigint (20)
src 指定产品图片的位置。此参数支持可用于检索图片的修改副本的 URL 筛选器。例如,将 _small 添加到文件名中,以检索分辨率为 100 x 100 像素的图片的缩放副本(例如,ipod-nano_small.png),或添加 _2048x2048 以检索分辨率为 2048 x 2048 像素的图片副本(例如,ipod-nano_2048x2048.png)。
updated_at 默认值:NULL 上次修改产品图片的日期和时间。API 以 ISO 8601 格式返回此值。 date Datetime
variant_ids 与图片关联的多种 ID 数组。
width 默认值:NULL 上传时确定的图片宽度尺寸。 smallint(4) 未签名

ProductVariant 资源属性

下表列出了一些有关 REST Admin API ProductVariant 资源属性的有用信息资源。此资源没有关键必填字段。

有关与 REST ProductVariant 资源相关的重要属性的数据
属性 描述 数据类型 字段长度 字段访问权限
条码 默认值:NULL 产品的条码、UPC 或 ISBN 编号。 varchar(255)
compare_at_price 默认值:NULL 调整或促销前产品的原始价格。 decimal(20,2)
创建时间 默认值:NULL 创建产品多属性时采用 ISO 8601 格式的日期和时间。 date Datetime
fulfillment_service
  • 手动
  • { handle of fulfillment service }
默认:manual
与产品多属性关联的发货服务。 varchar(255)
grams 产品多属性的重量,以克为单位。
id 默认值:NULL 产品多属性的唯一数字识别码。此值自动递增。 bigint (20)
image_id 默认值:NULL 产品图片的唯一数字识别码。图片必须与多属性与同一产品关联。 bigint (20)
inventory_item_id 库存商品的唯一标识符,在库存 API 中用于查询库存信息。
inventory_management
  • Shopify
  • null
  • { handle of fulfillment service }
  • 默认值:NULL
    用于跟踪产品多属性的库存商品数量的发货服务。 varchar(255)
    inventory_policy
    • deny
    • continue
    默认值:deny
    客户是否可以在缺货时订购产品多属性。 varchar(40)
    inventory_quantity 默认值:1 所有位置的库存总量。若要调整特定位置的库存,请使用 InventoryLevel 资源。 int(11) 只读
    option 店主用于定义产品多属性的自定义属性。您可以为产品多属性定义三个选项:选项1、选项2、选项3。默认值:默认标题。标题字段是选项1、选项2 和选项3 字段的串联。更新选项字段会更新标题字段。
    position 默认值:0 产品多属性列表中产品多属性的顺序。列表中的第一个位置为 1。多属性的位置以列出的顺序表示。 smallint(5) 未签名 只读
    presentment_prices 以商店各种已启用的展示货币来计算的多属性的展示价格和原价的列表。每个价格对象具有以下属性:
    -currency_code:商店中一种已启用的展示货币的三个字母代码(ISO 4217 格式)。
    -amount:以展示价格计算的多属性的价格或原价。
    需要标头 'X-Shopify-Api-Features':“include-presentment-prices”。
    只读
    price 默认值:0 产品多属性的价格。 decimal(20,2)
    product_id 默认值:NULL 产品的唯一数字标识符。 bigint (20)
    requires_shipping 默认值:1 此属性已弃用。请改用 InventoryItem 资源上的 “requires_shipping”属性。 布尔值 tinyint(1)
    sku 商店中产品多属性的唯一标识符。必须满足要求才能连接到 FulfillmentService。 varchar(255)
    tax_code 此参数仅适用于安装了 Avalara AvaTax 应用的商店。为产品多属性指定 Avalara 税务代码。
    taxable 默认值:1 在销售产品多属性时是否收税。 布尔值 tinyint(1)
    title 产品多属性的标题。标题字段是选项1、选项2 和选项3 字段的串联。您只能使用选项字段更新标题。 varchar(255) 只读
    updated_at 默认值:NULL 上次修改产品多属性的日期和时间。以 ISO 8601 格式返回。 date Datetime
    weight 使用 weight_unit 指定的单位系统表示的产品多属性的重量。
    weight_unit
    • g
    • 千克
    • oz
    • lb
    默认值:NULL
    适用于产品多属性重量的计量单位。如果您未指定商店 weight_unit 的值,则采用商店的默认计量单位。 varchar(2)