存储迁移数据字典gydF4y2Ba
本页于2022年10月7日打印。当前版本请访问https://help.shopify.com/en/partners/building-stores-for-merchants/data-dictionary。gydF4y2Ba
存储迁移数据字典包含关于REST Admin API的信息gydF4y2Ba客户gydF4y2Ba
,gydF4y2Ba订单gydF4y2Ba
,gydF4y2Ba产品gydF4y2Ba
资源。数据字典是将商店迁移到Shopify的有经验的合作伙伴的补充参考。gydF4y2Ba
客户gydF4y2Ba
资源属性gydF4y2Ba
下表列出了关于REST Admin API属性的一些有用信息gydF4y2Ba客户gydF4y2Ba
资源。gydF4y2Ba
财产gydF4y2Ba | 值gydF4y2Ba | 描述gydF4y2Ba | 数据类型gydF4y2Ba | 字段长度gydF4y2Ba | 字段访问gydF4y2Ba | 重要的必需字段gydF4y2Ba |
---|---|---|---|---|---|---|
accepts_ob欧宝娱乐app下载地址marketinggydF4y2Ba | 默认值:0gydF4y2Ba | 客户是否同意接受营销材料。ob欧宝娱乐app下载地址gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | YgydF4y2Ba | |
accepts_ob欧宝娱乐app下载地址marketing_gydF4y2Ba updated_atgydF4y2Ba |
ISO 8601格式中客户同意或反对通过电子邮件接收营销材料的日期和时间。ob欧宝娱乐app下载地址gydF4y2Ba | DateTimegydF4y2Ba | ||||
地址gydF4y2Ba | 与客户相关的地址列表。gydF4y2Ba | ({地址})gydF4y2Ba | ||||
货币gydF4y2Ba | ISO 4217格式中三个字母的代码,表示客户为最后一个订单付款时使用的货币。gydF4y2Ba | 字符串gydF4y2Ba | 商店的货币gydF4y2Ba | 只读gydF4y2Ba | ||
created_atgydF4y2Ba | 默认值:空gydF4y2Ba | 当客户被添加到存储中时,ISO 8601格式的日期和时间。gydF4y2Ba | DateTimegydF4y2Ba | datetimegydF4y2Ba | 只读gydF4y2Ba | |
default_addressgydF4y2Ba | 客户的默认地址。gydF4y2Ba | {地址}gydF4y2Ba | ||||
电子邮件gydF4y2Ba | 默认值:空gydF4y2Ba | 客户的唯一电子邮件地址。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
first_namegydF4y2Ba | 默认值:空gydF4y2Ba | 顾客的名字。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
idgydF4y2Ba | 默认值:空gydF4y2Ba | 一个全局惟一的标识符。(该值会自动递增。)gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | YgydF4y2Ba | |
last_namegydF4y2Ba | 默认值:空gydF4y2Ba | 顾客的姓。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
last_order_idgydF4y2Ba | 默认值:空gydF4y2Ba | 客户上一次订单的ID。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | 只读gydF4y2Ba | |
last_order_namegydF4y2Ba | 默认值:空gydF4y2Ba | 客户上一次订单的名称。gydF4y2Ba | 字符串gydF4y2Ba | 只读gydF4y2Ba | ||
metafieldgydF4y2Ba | 默认值:空gydF4y2Ba | 按属于资源的名称空间和键返回元字段。gydF4y2Ba | {Metafield}gydF4y2Ba | |||
ob欧宝娱乐app下载地址marketing_opt_gydF4y2Ba in_levelgydF4y2Ba |
|
营销订阅ob欧宝娱乐app下载地址选择加入级别(如M3AAWG最佳实践指南所述),即客户在同意通过电子邮件接收营销材料时给出的级别。gydF4y2Ba | 字符串,枚举gydF4y2Ba | |||
multipass_identifiergydF4y2Ba | 默认值:空gydF4y2Ba | 用于多通道登录的客户的唯一标识符。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
请注意gydF4y2Ba | 默认值:空gydF4y2Ba | 关于顾客的说明。gydF4y2Ba | 字符串gydF4y2Ba | 简单gydF4y2Ba | ||
orders_countgydF4y2Ba | 默认值:0gydF4y2Ba | 客户一生中在商店下的订单数量。gydF4y2Ba | 整数gydF4y2Ba | int (11)gydF4y2Ba | 只读gydF4y2Ba | |
电话gydF4y2Ba | 默认值:空gydF4y2Ba | 此客户的惟一(跨商店)电话号码(E.164格式)。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
sms_ob欧宝娱乐app下载地址marketing_gydF4y2Ba 同意gydF4y2Ba |
默认值:空gydF4y2Ba | 客户电话号码的当前短信营销状态。ob欧宝娱乐app下载地址gydF4y2Ba | 字符串gydF4y2Ba | |||
状态gydF4y2Ba |
|
顾客与商店的帐户状态。gydF4y2Ba | 字符串,枚举gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | |
标签gydF4y2Ba | 默认值:空gydF4y2Ba | 用逗号分隔的列表,最多包含250个已添加到客户的标记。gydF4y2Ba | 字符串gydF4y2Ba | 255 /标签gydF4y2Ba | ||
tax_exemptgydF4y2Ba | 默认值:0gydF4y2Ba | 客户是否被免除对其订单的税收。gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | YgydF4y2Ba | |
tax_exemptionsgydF4y2Ba | 指的是gydF4y2Ba客户gydF4y2Ba资源获取值的完整列表。gydF4y2Ba | 适用于客户的免税清单。gydF4y2Ba | 字符串gydF4y2Ba | |||
total_spentgydF4y2Ba | 默认值:0gydF4y2Ba | 客户一生中在订单上花费的总金额。在商店货币中列出。如果使用多种货币,则显示的金额为默认货币,不含汇率。gydF4y2Ba | 数量gydF4y2Ba | 3)小数(21日gydF4y2Ba | 只读gydF4y2Ba | |
updated_atgydF4y2Ba | 上一次更新客户的日期和时间。根据商店的时区。gydF4y2Ba | DateTimegydF4y2Ba | datetimegydF4y2Ba | 只读gydF4y2Ba | ||
verified_emailgydF4y2Ba | 默认值:1gydF4y2Ba | 客户是否验证了他们的电子邮件地址。如果客户是通过Shopify管理或API创建的,则默认为true。gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | 只读gydF4y2Ba |
CustomerAddressgydF4y2Ba
资源属性gydF4y2Ba
下表列出了关于REST Admin API属性的一些有用信息gydF4y2BaCustomerAddressgydF4y2Ba
资源。此资源没有关键的必需字段。gydF4y2Ba
财产gydF4y2Ba | 值gydF4y2Ba | 描述gydF4y2Ba | 数据类型gydF4y2Ba | 字段长度gydF4y2Ba | 字段访问gydF4y2Ba |
---|---|---|---|---|---|
address1gydF4y2Ba | 默认值:空gydF4y2Ba | 客户的邮寄地址。每个客户账户100元。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
address2gydF4y2Ba | 默认值:空gydF4y2Ba | 客户的邮寄地址的附加字段。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
城市gydF4y2Ba | 默认值:空gydF4y2Ba | 客户所在的城市、城镇或村庄。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
公司gydF4y2Ba | 默认值:空gydF4y2Ba | 客户的公司。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
国家gydF4y2Ba | 默认值:空gydF4y2Ba | 客户的国家。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
first_namegydF4y2Ba | 默认值:空gydF4y2Ba | 顾客的名字。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
country_codegydF4y2Ba | 两个字母的国家代码对应于客户的国家。gydF4y2Ba | 字符串gydF4y2Ba | 只读gydF4y2Ba | ||
country_namegydF4y2Ba | 客户的规范化国家名称。gydF4y2Ba | 字符串gydF4y2Ba | |||
last_namegydF4y2Ba | 默认值:空gydF4y2Ba | 顾客的姓。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
的名字gydF4y2Ba | 客户的姓和名。gydF4y2Ba | 字符串gydF4y2Ba | |||
电话gydF4y2Ba | 默认值:空gydF4y2Ba | 客户的电话号码在这个地址。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
省gydF4y2Ba | 默认值:空gydF4y2Ba | 客户的地区名称。通常指省、州或州。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |
province_codegydF4y2Ba | 客户所在地区的两个字母代码。gydF4y2Ba | 字符串gydF4y2Ba | 只读gydF4y2Ba | ||
邮政编码gydF4y2Ba | 默认值:空gydF4y2Ba | 客户的邮政编码,也称为zip、postcode、Eircode等。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba |
订单gydF4y2Ba
资源属性gydF4y2Ba
下表列出了关于REST Admin API属性的一些有用信息gydF4y2Ba订单gydF4y2Ba
资源。gydF4y2Ba
财产gydF4y2Ba | 值gydF4y2Ba | 描述gydF4y2Ba | 数据类型gydF4y2Ba | 字段长度gydF4y2Ba | 字段访问gydF4y2Ba | 重要的必需字段gydF4y2Ba |
---|---|---|---|---|---|---|
app_idgydF4y2Ba | 默认值:空gydF4y2Ba | 创建订单的应用程序的ID。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | 只读gydF4y2Ba | |
billing_addressgydF4y2Ba | 默认值:空gydF4y2Ba | 与付款方式相关联的邮寄地址。此地址是一个可选字段,在不需要支付方式的订单中不可用。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | ||
browser_ipgydF4y2Ba | 客户在下单时使用的浏览器的IP地址。支持IPv4和IPv6。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | ||
buyer_accepts_ob欧宝娱乐app下载地址marketinggydF4y2Ba | 默认值:0gydF4y2Ba | 客户是否同意从商店接收电子邮件更新。gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | ||
cancel_reasongydF4y2Ba |
|
订单取消的原因gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
cancelled_atgydF4y2Ba | 默认值:空gydF4y2Ba | 订单被取消的日期和时间。如果未取消订单,则返回null。gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba | 只读gydF4y2Ba | |
cart_tokengydF4y2Ba | 默认值:空gydF4y2Ba | 引用与订单关联的购物车时的惟一值。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | |
checkout_tokengydF4y2Ba | 默认值:空gydF4y2Ba | 引用与订单相关联的结帐时的惟一值。gydF4y2Ba | 字符串gydF4y2Ba | varchar (64)gydF4y2Ba | 只读gydF4y2Ba | |
client_detailsgydF4y2Ba |
|
客户下单时使用的浏览器信息:gydF4y2Ba accept_language:浏览器能够理解的语言和地区。gydF4y2Ba browser_height:以像素为单位的浏览器屏幕高度(如果可用的话)。gydF4y2Ba browser_ip:浏览器IP地址。gydF4y2Ba browser_width:以像素为单位的浏览器屏幕宽度(如果可用的话)。gydF4y2Ba session_hash:会话的哈希值。gydF4y2Ba user_agent:浏览客户端的详细信息,包括软件和操作版本。gydF4y2Ba |
对象gydF4y2Ba | 只读gydF4y2Ba | ||
closed_atgydF4y2Ba | 默认值:空gydF4y2Ba | 订单关闭的日期和时间(ISO 8601格式)。如果订单未关闭,则返回null。gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba | 只读gydF4y2Ba | |
created_atgydF4y2Ba | 默认值:空gydF4y2Ba | 在Shopify中创建订单时自动生成的日期和时间(ISO 8601格式)。此属性的值不能更改。gydF4y2Ba | 日期gydF4y2Ba | datetime (6)gydF4y2Ba | 只读gydF4y2Ba | |
货币gydF4y2Ba | 默认值:空gydF4y2Ba | 商店货币的三字母代码(ISO 4217格式)。gydF4y2Ba | 字符串gydF4y2Ba | char (3)gydF4y2Ba | ||
current_subtotal_pricegydF4y2Ba | 以商店货币表示的订单当前小计价格。此字段的值反映订单编辑、返回和退款。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | ||
current_subtotal_price_setgydF4y2Ba | 当前订单在商店的小计价格和显示货币。与此字段关联的金额值反映订单编辑、退货和退款。gydF4y2Ba | 对象gydF4y2Ba | 只读gydF4y2Ba | |||
current_total_discountsgydF4y2Ba | 当前订单的总折扣以商店货币计算。此字段的值反映订单编辑、返回和退款。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | ||
current_total_discounts_setgydF4y2Ba | 目前订单的总折扣在商店和提示货币。与此字段关联的金额值反映订单编辑、退货和退款。gydF4y2Ba | 对象gydF4y2Ba | 只读gydF4y2Ba | |||
current_total_duties_setgydF4y2Ba | 目前在商店中所收取的关税总额和提示货币。与此字段关联的金额值反映订单编辑、退货和退款。gydF4y2Ba | 对象gydF4y2Ba | 只读gydF4y2Ba | |||
current_total_pricegydF4y2Ba | 以商店货币表示的订单当前总价。此字段的值反映订单编辑、返回和退款。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | ||
current_total_price_setgydF4y2Ba | 当前订单在商店的总价和显示货币。与此字段关联的金额值反映订单编辑、退货和退款。gydF4y2Ba | 对象gydF4y2Ba | 只读gydF4y2Ba | |||
current_total_taxgydF4y2Ba | 以商店货币计算的订单当前所收取的税金总额。此字段的值反映订单编辑、返回或退款。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | ||
current_total_tax_setgydF4y2Ba | 目前所收取的税金总额在商店的订单和提示货币。与此字段关联的金额值反映订单编辑、退货和退款。gydF4y2Ba | 对象gydF4y2Ba | 只读gydF4y2Ba | |||
客户gydF4y2Ba | 默认值:空gydF4y2Ba | 关于客户的信息。订单可能没有客户,应用程序不应该依赖于客户对象的存在。如果订单是通过Shopify POS创建的,则此值可能为空gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | ||
customer_localegydF4y2Ba | 默认值:空gydF4y2Ba | 两个或三个字母的语言代码,后面可选地跟着一个区域修饰符。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | |
discount_applicationsgydF4y2Ba | 堆叠折扣应用程序的有序列表。gydF4y2Ba discount_applications属性包括3种类型:discount_code、manual和script。这3种类型共享一个公共结构,并具有一些特定于类型的属性。gydF4y2Ba |
数组gydF4y2Ba | 只读gydF4y2Ba | |||
discount_codesgydF4y2Ba | 应用于订单的折扣列表。gydF4y2Ba | 数组gydF4y2Ba | ||||
电子邮件gydF4y2Ba | 客户的电子邮件地址。gydF4y2Ba | varchar (255)gydF4y2Ba | ||||
estimated_taxesgydF4y2Ba | 是否估计了订单上的税金。在客户下单和发货之间,许多因素可能会发生变化,这可能会影响税费的计算。当订单上的税金最终确定且不受任何更改影响时,该属性返回false。gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | |||
financial_statusgydF4y2Ba |
|
与订单相关的付款状态。只能在创建订单时设置。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | |
fulfillment_statusgydF4y2Ba |
|
订单在已完成行项目方面的状态。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
完成目标gydF4y2Ba | 与订单相关联的执行数组gydF4y2Ba | 数组gydF4y2Ba | ||||
idgydF4y2Ba | 默认值:空gydF4y2Ba | 订单的ID,用于API目的。这与order_number属性不同,后者是商店老板和客户使用的ID。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | 只读gydF4y2Ba | |
landing_sitegydF4y2Ba | 默认值:空gydF4y2Ba | 买家进入商店时登陆的页面的URL。gydF4y2Ba | 字符串gydF4y2Ba | varchar (4096)gydF4y2Ba | 只读gydF4y2Ba | |
line_itemsgydF4y2Ba | 行项目对象的列表,每个行项目对象包含关于订单中项目的信息gydF4y2Ba | 数组gydF4y2Ba | YgydF4y2Ba | |||
location_idgydF4y2Ba | 默认值:空gydF4y2Ba | 处理订单的物理位置的ID。如果您需要根据订单引用位置,那么使用FulfillmentOrder资源。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | ||
的名字gydF4y2Ba | 默认值:空gydF4y2Ba | 订单名称,通过将order_number属性与在商家的一般设置中设置的订单前缀和后缀组合而生成。这与id属性不同,后者是API使用的顺序的id。该字段还可以由API设置为任何字符串值。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
请注意gydF4y2Ba | 默认值:空gydF4y2Ba | 店主可以附加到订单上的可选注释。gydF4y2Ba | 字符串gydF4y2Ba | |||
note_attributesgydF4y2Ba | 默认值:空gydF4y2Ba | 添加到订单中的额外信息。显示在订单详细信息页的“附加详细信息”部分中。每个数组条目必须包含一个具有名称和值键的散列。gydF4y2Ba | 字符串gydF4y2Ba | |||
数量gydF4y2Ba | 默认值:空gydF4y2Ba | 订单在商店订单计数中的位置。数字是连续的,从1开始。OB欧宝娱乐APPgydF4y2Ba | 整数gydF4y2Ba | int (11)gydF4y2Ba | 只读gydF4y2Ba | |
order_numbergydF4y2Ba | 订单在商店从1001开始的订单计数中的位置。OB欧宝娱乐APP订单号是连续的。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | 只读gydF4y2Ba | ||
order_status_urlgydF4y2Ba | 指向订单状态网页的URL(如果适用)。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | ||
original_total_duties_setgydF4y2Ba | 在商店中对订单所收取的原始关税总额和提示货币。gydF4y2Ba | 对象gydF4y2Ba | 只读gydF4y2Ba | |||
payment_gateway_namesgydF4y2Ba | 默认值:空gydF4y2Ba | 用于订单的支付网关列表。gydF4y2Ba |
varchar (255)gydF4y2Ba | 只读gydF4y2Ba | ||
payment_termsgydF4y2Ba | 默认值:空gydF4y2Ba | 处理付款的条款和条件。gydF4y2Ba | 对象gydF4y2Ba | 长整型数字(20)gydF4y2Ba | 只读gydF4y2Ba | |
电话gydF4y2Ba | 默认值:空gydF4y2Ba | 客户接收短信通知的电话号码。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
presentment_currencygydF4y2Ba | 默认值:空gydF4y2Ba | 用于向客户显示价格的提示货币。gydF4y2Ba | 字符串gydF4y2Ba | char (3)gydF4y2Ba | ||
processed_atgydF4y2Ba | 默认值:空gydF4y2Ba | 处理订单时的日期和时间(ISO 8601格式)。这个值是出现在订单上的日期,并在分析报告中使用。如果您正在从应用程序或其他平台导入订单,那么您可以将processsed_at设置为过去的日期和时间,以匹配创建原始订单的时间。gydF4y2Ba | 日期gydF4y2Ba | datetime (6)gydF4y2Ba | ||
processing_methodgydF4y2Ba |
|
付款是如何处理的gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | |
referring_sitegydF4y2Ba | 默认值:空gydF4y2Ba | 顾客点击商店链接的网站。gydF4y2Ba | 字符串gydF4y2Ba | varchar (4096)gydF4y2Ba | ||
退款gydF4y2Ba | 适用于该订单的退款清单gydF4y2Ba | 数组gydF4y2Ba | 只读gydF4y2Ba | |||
shipping_addressgydF4y2Ba | 默认值:空gydF4y2Ba | 订单将被运送到的邮寄地址。此地址是可选的,不需要发货的订单将不可用gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | ||
shipping_linesgydF4y2Ba | 对象数组,每个对象详细说明所使用的传输方法。gydF4y2Ba | 数组gydF4y2Ba | ||||
source_namegydF4y2Ba | 默认值:空gydF4y2Ba | 订单发出的地方。只能在订单创建期间设置,之后不可写入。Shopify通道的值是受保护的,不能由其他API客户端分配:web, pos, shopify_draft_order, iphone和android。通过API创建的订单可以分配给您选择的任何其他字符串。如果未指定,则新订单将被分配应用程序ID的值。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
subtotal_pricegydF4y2Ba | 按商店货币计算的订单价格,在折扣后,但在运输、关税、税金和小费之前。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | |||
subtotal_price_setgydF4y2Ba | 扣除折扣后,但不包括运输、关税、税金和小费的商店订单和报价货币的小计。gydF4y2Ba | 对象gydF4y2Ba | ||||
标签gydF4y2Ba | 附加到订单的标记,格式化为逗号分隔的值字符串。标签是附加的短描述符,通常用于过滤和搜索。每个单独的标记长度限制在40个字符。gydF4y2Ba | 字符串gydF4y2Ba | varchar (4096)gydF4y2Ba | |||
tax_linesgydF4y2Ba | 税项行对象的数组,每个对象详细说明了适用于该订单的税项。每个对象具有以下属性:gydF4y2Ba 当通过API创建订单时,可以在订单或行项目上指定税项,但不能同时指定税项。订单上指定的税目在创建的订单中的应税行项目之间被分割。gydF4y2Ba |
数组gydF4y2Ba | ||||
taxes_includedgydF4y2Ba |
|
税金是否包含在订单小计中。gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | ||
测验gydF4y2Ba |
|
这是否是一个测试订单。gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | 只读gydF4y2Ba | |
令牌gydF4y2Ba | 默认值:空gydF4y2Ba | 引用订单时的唯一值。gydF4y2Ba | 字符串gydF4y2Ba | varchar (32)gydF4y2Ba | 只读gydF4y2Ba | |
total_discountsgydF4y2Ba | 默认值:0gydF4y2Ba | 总折扣适用于以商店货币计算的订单价格。gydF4y2Ba | 字符串gydF4y2Ba | 3)小数(21日gydF4y2Ba | ||
total_discounts_setgydF4y2Ba | 总折扣适用于订单的价格在商店和提示货币。gydF4y2Ba | 对象gydF4y2Ba | ||||
total_line_items_pricegydF4y2Ba | 默认值:0gydF4y2Ba | 以商店货币表示的所有行项目价格的总和。gydF4y2Ba | 字符串gydF4y2Ba | 3)小数(21日gydF4y2Ba | ||
total_line_items_price_setgydF4y2Ba | 所有商品价格的总价和展示货币。gydF4y2Ba | 对象gydF4y2Ba | ||||
total_outstandinggydF4y2Ba | 默认值:0gydF4y2Ba | 以商店货币计算的订单未清偿总额。gydF4y2Ba | 字符串gydF4y2Ba | 3)小数(21日gydF4y2Ba | ||
total_pricegydF4y2Ba | 默认值:0gydF4y2Ba | 所有商品价格、折扣、运费、税金和小费的总和。必须是积极的。gydF4y2Ba | 字符串gydF4y2Ba | 3)小数(21日gydF4y2Ba | ||
total_price_setgydF4y2Ba | 店内订单总价及提示货币。gydF4y2Ba | 对象gydF4y2Ba | ||||
total_shipping_price_setgydF4y2Ba | 订单的运输总价,不包括折扣和退货,以商店和提示货币计算。如果taxes_included设置为true,则total_shipping_price_set包含税金。gydF4y2Ba | 对象gydF4y2Ba | ||||
total_taxgydF4y2Ba | 默认值:0gydF4y2Ba | 应用于订单的所有税金的总和以商店货币表示。必须是积极的。gydF4y2Ba | 字符串gydF4y2Ba | 3)小数(21日gydF4y2Ba | ||
total_tax_setgydF4y2Ba | 按店内订货及付款币种计算的税金总额。gydF4y2Ba | 对象gydF4y2Ba | ||||
total_tip_receivedgydF4y2Ba | 订单中所有小费的总和以商店货币计算。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | 只读gydF4y2Ba | ||
total_weightgydF4y2Ba | 默认值:0gydF4y2Ba | 所有项目重量的总和,以克为单位。当项目从订单中删除时,金额不会调整。gydF4y2Ba | 整数gydF4y2Ba | 无符号长整型数字(20)gydF4y2Ba | ||
updated_atgydF4y2Ba | 最后修改订单的日期和时间(ISO 8601格式)。gydF4y2Ba | 日期gydF4y2Ba | datetime (6)gydF4y2Ba | 只读gydF4y2Ba | ||
user_idgydF4y2Ba | 默认值:空gydF4y2Ba | 登录到Shopify POS处理订单的用户的ID(如果适用)。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba |
产品gydF4y2Ba
资源属性gydF4y2Ba
下表列出了关于REST Admin API属性的一些有用信息gydF4y2Ba产品gydF4y2Ba
资源。gydF4y2Ba
财产gydF4y2Ba | 值gydF4y2Ba | 描述gydF4y2Ba | 数据类型gydF4y2Ba | 字段长度gydF4y2Ba | 字段访问gydF4y2Ba | 重要的必需字段gydF4y2Ba |
---|---|---|---|---|---|---|
body_htmlgydF4y2Ba | 默认值:空gydF4y2Ba | 产品的描述。支持HTML格式。gydF4y2Ba | 字符串gydF4y2Ba | 简单gydF4y2Ba | ||
created_atgydF4y2Ba | 默认值:空gydF4y2Ba | 创建产品时的日期和时间(ISO 8601格式)。gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba | 只读gydF4y2Ba | |
处理gydF4y2Ba | 默认值:空gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | |||
idgydF4y2Ba | 默认值:空gydF4y2Ba | 无符号64位整数,用作产品的唯一标识符。每个id在Shopify系统中都是唯一的。任何两个产品都不会有相同的id,即使它们来自不同的商店。gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba | 只读gydF4y2Ba | YgydF4y2Ba |
图片gydF4y2Ba | 产品图像对象的列表,每个对象表示与产品相关的一个图像。gydF4y2Ba | ({product_image})gydF4y2Ba | ||||
选项gydF4y2Ba | 自定义产品属性。例如,尺寸、颜色和材质。每个产品最多可以有3个选项,每个选项值最多可以有255个字符。产品变量是由选项值的组合组成的。没有值就不能创建选项。要创建新的选项,还需要创建一个带有关联选项值的变量。gydF4y2Ba | 数组gydF4y2Ba | ||||
product_typegydF4y2Ba | 默认值:空gydF4y2Ba | 用于过滤和搜索产品的产品分类。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
published_atgydF4y2Ba | 默认值:空gydF4y2Ba | 产品发布时的日期和时间(ISO 8601格式)。可以设置为null,以从在线商店通道取消发布产品。欧宝体育官网入口首页gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba | ||
published_scopegydF4y2Ba |
|
产品是否发布到销售点通道。gydF4y2Ba | 字符串gydF4y2Ba | |||
状态gydF4y2Ba |
|
产品的状态。gydF4y2Ba | 字符串gydF4y2Ba | varchar (32)gydF4y2Ba | ||
标签gydF4y2Ba | 一组逗号分隔的标记,用于过滤和搜索。一个产品可以有多达250个标签。每个标记最多可以有255个字符。gydF4y2Ba | 字符串gydF4y2Ba | ||||
template_suffixgydF4y2Ba | 默认值:空gydF4y2Ba | 用于产品页面的Liquid模板的后缀。如果指定了此属性,则产品页面将使用名为“product.suffix”的模板。,其中“suffix”是该属性的值。如果此属性为""或null,则产品页面使用默认模板"product.liquid"。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
标题gydF4y2Ba | 默认值:空gydF4y2Ba | 产品名称gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba | ||
updated_atgydF4y2Ba | 默认值:空gydF4y2Ba | 最后修改产品的日期和时间(ISO 8601格式)。产品的updated_at值可能因不同的原因而改变。例如,如果对一个设置了库存跟踪的产品下了订单,那么库存调整将被计算为更新。gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba | 只读gydF4y2Ba | |
变体gydF4y2Ba | 产品变体的数组,每个变体表示产品的不同版本。position属性是只读的。变量的位置是由它们被列出的顺序指示的。gydF4y2Ba | 数组gydF4y2Ba | ||||
供应商gydF4y2Ba | 默认值:空gydF4y2Ba | 产品供应商的名称。gydF4y2Ba | 字符串gydF4y2Ba | varchar (255)gydF4y2Ba |
ProductImagegydF4y2Ba
资源属性gydF4y2Ba
下表列出了关于REST Admin API属性的一些有用信息gydF4y2BaProductImagegydF4y2Ba
资源。此资源没有只读或关键的必填项。gydF4y2Ba
财产gydF4y2Ba | 值gydF4y2Ba | 描述gydF4y2Ba | 数据类型gydF4y2Ba | 字段长度gydF4y2Ba |
---|---|---|---|---|
created_atgydF4y2Ba | 默认值:空gydF4y2Ba | 创建产品映像的日期和时间。API以ISO 8601格式返回该值。gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba |
高度gydF4y2Ba | 默认值:空gydF4y2Ba | 在上传时确定的图像的高度尺寸。gydF4y2Ba | 无符号短整型(4)gydF4y2Ba | |
idgydF4y2Ba | 默认值:空gydF4y2Ba | 产品图像的唯一数字标识符。(auto_increment)gydF4y2Ba | 整数gydF4y2Ba | 长整型数字(20)gydF4y2Ba |
位置gydF4y2Ba | 默认值:0gydF4y2Ba | 产品图像在列表中的顺序。第一个产品图像位于位置1,是产品的“主”图像。gydF4y2Ba | 无符号短整型(5)gydF4y2Ba | |
product_idgydF4y2Ba | 默认值:空gydF4y2Ba | 与映像相关联的产品的id。gydF4y2Ba | 长整型数字(20)gydF4y2Ba | |
srcgydF4y2Ba | 指定产品映像的位置。此参数支持可用于检索图像修改副本的URL过滤器。例如,在文件名中添加_small,以检索分辨率为100 x 100 px的图像的缩放副本(例如,ipod-nano_small.png),或添加_2048x2048以检索分辨率为2048x2048 px的图像的副本(例如,ipod-nano_2048x2048.png)。gydF4y2Ba | |||
updated_atgydF4y2Ba | 默认值:空gydF4y2Ba | 最后修改产品映像的日期和时间。API以ISO 8601格式返回该值。gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba |
variant_idsgydF4y2Ba | 与图像相关的变量id的数组。gydF4y2Ba | |||
宽度gydF4y2Ba | 默认值:空gydF4y2Ba | 在上传时确定的图像的宽度和尺寸。gydF4y2Ba | 无符号短整型(4)gydF4y2Ba |
ProductVariantgydF4y2Ba
资源属性gydF4y2Ba
下表列出了关于REST Admin API属性的一些有用信息gydF4y2BaProductVariantgydF4y2Ba
资源。此资源没有关键的必需字段。gydF4y2Ba
财产gydF4y2Ba | 值gydF4y2Ba | 描述gydF4y2Ba | 数据类型gydF4y2Ba | 字段长度gydF4y2Ba | 字段访问gydF4y2Ba |
---|---|---|---|---|---|
条形码gydF4y2Ba | 默认值:空gydF4y2Ba | 产品的条形码、UPC或ISBN编号。gydF4y2Ba | varchar (255)gydF4y2Ba | ||
compare_at_pricegydF4y2Ba | 默认值:空gydF4y2Ba | 调整或出售前的原价。gydF4y2Ba | 小数(20,2)gydF4y2Ba | ||
created_atgydF4y2Ba | 默认值:空gydF4y2Ba | ISO 8601格式中创建产品变体的日期和时间。gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba | |
fulfillment_servicegydF4y2Ba |
|
与产品变体相关联的实现服务。gydF4y2Ba | varchar (255)gydF4y2Ba | ||
克gydF4y2Ba | 产品的重量以克为单位。gydF4y2Ba | ||||
idgydF4y2Ba | 默认值:空gydF4y2Ba | 产品变体的唯一数字标识符。这个值会自动递增。gydF4y2Ba | 长整型数字(20)gydF4y2Ba | ||
image_idgydF4y2Ba | 默认值:空gydF4y2Ba | 产品图像的唯一数字标识符。图像必须与与变体相同的产品相关联。gydF4y2Ba | 长整型数字(20)gydF4y2Ba | ||
inventory_item_idgydF4y2Ba | 库存项目的唯一标识符,在inventory API中用于查询库存信息。gydF4y2Ba | ||||
inventory_managementgydF4y2Ba | 跟踪产品变体的库存项目数量的实现服务。gydF4y2Ba | varchar (255)gydF4y2Ba | |||
inventory_policygydF4y2Ba |
|
当产品缺货时,是否允许客户下单购买该产品变体。gydF4y2Ba | varchar (40)gydF4y2Ba | ||
inventory_quantitygydF4y2Ba | 默认值:1gydF4y2Ba | 所有地点的库存总和。要在特定位置调整库存,请使用InventoryLevel资源。gydF4y2Ba | int (11)gydF4y2Ba | 只读gydF4y2Ba | |
选项gydF4y2Ba | 商店老板用来定义产品变体的自定义属性。可以为产品变体定义三个选项:option1、option2、option3。默认值:默认标题。标题字段是option1、option2和option3字段的串联。更新选项字段将更新标题字段。gydF4y2Ba | ||||
位置gydF4y2Ba | 默认值:0gydF4y2Ba | 产品变体在产品变体列表中的顺序。列表中的第一个位置是1。变量的位置是由它们被列出的顺序指示的。gydF4y2Ba | 无符号短整型(5)gydF4y2Ba | 只读gydF4y2Ba | |
presentment_pricesgydF4y2Ba | 变种的展示价格和比较价格在每个商店的启用展示货币的清单。每个价格对象都有以下属性:gydF4y2Ba -currency_code:三个字母的代码(ISO 4217格式),用于商店启用的显示货币之一。gydF4y2Ba -金额:变量的价格或以提示货币计价的比价。gydF4y2Ba 要求标头'X-Shopify-Api-Features': 'include-present -prices'。gydF4y2Ba |
只读gydF4y2Ba | |||
价格gydF4y2Ba | 默认值:0gydF4y2Ba | 产品变种的价格。gydF4y2Ba | 小数(20,2)gydF4y2Ba | ||
product_idgydF4y2Ba | 默认值:空gydF4y2Ba | 产品的唯一数字标识符。gydF4y2Ba | 长整型数字(20)gydF4y2Ba | ||
requires_shippinggydF4y2Ba | 默认值:1gydF4y2Ba | 此属性已弃用。在InventoryItem资源上使用' requires_shipping '属性。gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | |
skugydF4y2Ba | 商店中产品变体的唯一标识符。为了连接到履行服务,必须这样做。gydF4y2Ba | varchar (255)gydF4y2Ba | |||
tax_codegydF4y2Ba | 此参数仅适用于安装了Avalara AvaTax应用程序的商店。指定产品变体的Avalara税号。gydF4y2Ba | ||||
应纳税的gydF4y2Ba | 默认值:1gydF4y2Ba | 当产品变体被出售时是否征税。gydF4y2Ba | 布尔gydF4y2Ba | 非常小的整数(1)gydF4y2Ba | |
标题gydF4y2Ba | 产品变体的名称。标题字段是option1、option2和option3字段的串联。只能使用选项字段间接更新标题。gydF4y2Ba | varchar (255)gydF4y2Ba | 只读gydF4y2Ba | ||
updated_atgydF4y2Ba | 默认值:空gydF4y2Ba | 最后修改产品变体的日期和时间。以ISO 8601格式返回。gydF4y2Ba | 日期gydF4y2Ba | datetimegydF4y2Ba | |
重量gydF4y2Ba | 在用weight_unit指定的单位系统中,产品变量的权重。gydF4y2Ba | ||||
weight_unitgydF4y2Ba |
|
适用于产品变体重量的计量单位。如果没有为weight_unit指定值,则应用商店的默认度量单位。gydF4y2Ba | varchar (2)gydF4y2Ba |