商店移轉資料字典

商店移轉資料字典內含 REST 管理員 API CustomerOrder,及 Product 資源的資訊。當有經驗的合作夥伴將商店移轉至 Shopify 時,可以使用資料字典作為輔助參考資料。

請注意,資料字典內的資訊通過 Shopify API 2022-01 版驗證。如需最新資訊和範例,請參閱 REST 管理員 API 參考資料文件

Customer 資源屬性

以下表格可以為您提供 REST 管理員 API Customer 資源屬性的實用資訊。

REST 顧客資源相關重要屬性資料
屬性 說明 資料類型 欄位長度 欄位存取權 重要必填欄位
accepts_marketing 預設值:0 顧客是否同意接收行銷素材。 布林值 tinyint(1)
accepts_marketing_
updated_at
顧客同意或拒絕接受以電子郵件傳送行銷素材的日期和時間 (ISO 8601 格式)。 日期時間
地址 和顧客相關的地址清單。 [{ Address }]
貨幣 顧客上次訂單支付的幣別 (ISO 4217 三碼代碼格式)。 String 商店幣別 唯讀
created_at 預設值:NULL 顧客加入商店的四期和時間 (ISO 8601 格式) 日期時間 日期時間 唯讀
default_address 顧客的預設位址。 { Address }
電子郵件 預設值:NULL 顧客專屬的電子郵件地址。 String varchar(255)
名字 預設值:NULL 客戶的名字。 String varchar(255)
id 預設值:NULL 全球唯一識別碼。(此值會自動遞增) Integer bigint(20)
姓氏 預設值:NULL 客戶的姓氏。 String varchar(255)
last_order_id 預設值:NULL 顧客上次訂單 ID。 Integer bigint(20) 唯讀
last_order_name 預設值:NULL 顧客最新訂單名稱。 String 唯讀
中繼欄位 預設值:NULL 按照資源命名空間及金鑰傳回中繼欄位。 { Metafield }
marketing_opt_
in_level
  • null
  • single_opt_in
  • confirmed_opt_in
  • unknown
預設值:NULL
顧客同意接收電子郵件行銷素材時授予的行銷預訂加入等級 (按照 M3AAWG 最佳做法準則的說明)。 字串、列舉
multipass_identifier 預設值:NULL 顧客進行 Multipass 登入時使用的專用識別碼。 String varchar(255)
備註 預設值:NULL 顧客備註。 String mediumtext
orders_count 預設值:0 客戶終生於商店中消費的訂單數量。 Integer int(11) 唯讀
電話 預設值:NULL 顧客的專用 (跨商店) 電話號碼 (E.164 格式)。 String varchar(255)
sms_marketing_
consent
預設值:NULL 顧客電話號碼目前的簡訊行銷狀態。 String
狀態
  • disabled
  • invited
  • 已啟用
  • 拒絕
預設值:disabled
商店顧客帳戶狀態。 字串、列舉 varchar(255) 唯讀
標籤 預設值:NULL 為該顧客加上的標籤,以半形逗號分隔,最多 250 個。 String 每個標籤 255
tax_exempt 預設值:0 客戶的訂單是否可免稅。 布林值 tinyint(1)
tax_exemptions 完整的內容值清單請看顧客資源。 顧客的免稅項目清單。 String
total_spent 預設值:0 顧客終生透過訂單支付的總金額。使用商店幣別。如果使用多種幣別,則系統會顯示預設幣別,不計匯率。 數量 decimal(21,3) 唯讀
updated_at 顧客上次更新的日期和時間,使用商店時區。 日期時間 日期時間 唯讀
verified_email Default: 1 顧客是否已驗證電子郵件地址。如果是透過 Shopify 管理介面或 API 建立的顧客,則預設為「true」。 布林值 tinyint(1) 唯讀

CustomerAddress 資源屬性

以下表格可以為您提供 REST 管理員 API CustomerAddress 資源屬性的實用資訊。本資源並無重要必填欄位。

REST 顧客地址資源相關重要屬性資料
屬性 說明 資料類型 欄位長度 欄位存取權
address1 預設值:NULL 顧客郵寄地址,每個顧客帳號 100 項。 String varchar(255)
address2 預設值:NULL 顧客郵寄地址的其他欄位。 String varchar(255)
city 預設值:NULL 顧客的城市、鎮或村。 String varchar(255)
company 預設值:NULL 顧客公司。 String varchar(255)
國家/地區 預設值:NULL 客戶的國家/地區。 String varchar(255)
名字 預設值:NULL 客戶的名字。 String varchar(255)
country_code 顧客國家/地區相關二碼國家/地區代碼。 String 唯讀
country_name 顧客的標準國家/地區名稱。 String
姓氏 預設值:NULL 客戶的姓氏。 String varchar(255)
名稱 顧客的名字和姓氏。 String
電話 預設值:NULL 顧客在此地址的電話號碼。 String varchar(255)
province 預設值:NULL 顧客地區名稱,通常為省、州或縣。 String varchar(255)
province_code 顧客地區的二碼代碼。 String 唯讀
郵遞區號 預設值:NULL 顧客郵遞區號,也稱 zip、postcode、Eircode 等。 String varchar(255)

Order 資源屬性

以下表格可以為您提供 REST 管理員 API Order 資源屬性的實用資訊。

REST 訂單資源重要屬性資料
屬性 說明 資料類型 欄位長度 欄位存取權 重要必填欄位
app_id 預設值:NULL 建立訂單的應用程式 ID。 整數 bigint(20) 唯讀
billing_address 預設值:NULL 和付款方式相關的郵寄地址,此地址為選填欄位,若是訂單不須提供付款方式,則無法提供此地址。 整數 bigint(20)
browser_ip 顧客提交訂單時使用的瀏覽器 IP 位址,支援 IPv4 及 IPv6。 字串 varchar(255) 唯讀
buyer_accepts_marketing 預設值:0 顧客是否同意接收商店以電子郵件寄送最新資訊。 布林值 tinyint(1)
cancel_reason
  • 客戶
  • 詐騙
  • 庫存
  • 拒絕
  • other
預設值:NULL
帳單取消的原因 字串 varchar(255)
cancelled_at 預設值:NULL 訂單取消的日期和時間,如果訂單並未取消,則傳回「null」。 date 日期時間 唯讀
cart_token 預設值:NULL 參照訂單相關購物車時使用的專用值。 字串 varchar(255) 唯讀
checkout_token 預設值:NULL 參照訂單結帳程序的專用值。 字串 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 日期時間 唯讀
created_at 預設值:NULL 在 Shopify 建立訂單時自動產生的日期和時間 (ISO 8601 格式),此屬性值無法變更。 date 日期時間(6) 唯讀
貨幣 預設值:NULL 商店幣別三碼代碼 (ISO 4217 格式)。 字串 char(3)
current_subtotal_price 訂單目前的小計價格,使用商店幣別。此欄位值會反映訂單編輯、退貨及退款情形。 字串 varchar(255) 唯讀
current_subtotal_price_set 訂單目前的小計價格,使用商店及出示幣別。和此欄位相關的數值會反映訂單編輯、退貨及退款情形。 物件 唯讀
current_total_discounts 訂單目前的總折扣,使用商店幣別。此欄位值會反映訂單編輯、退貨及退款情形。 字串 varchar(255) 唯讀
current_total_discounts_set 訂單目前的總折扣,使用商店及出示幣別。和此欄位相關的數值會反映訂單編輯、退貨及退款情形。 物件 唯讀
current_total_duties_set 訂單目前收取的總關稅,使用商店及出示幣別。和此欄位相關的數值會反映訂單編輯、退貨及退款情形。 物件 唯讀
current_total_price 訂單目前的總價,使用商店幣別。此欄位值會反映訂單編輯、退貨及退款情形。 字串 varchar(255) 唯讀
current_total_price_set 訂單目前的總價,使用商店及出示幣別。和此欄位相關的數值會反映訂單編輯、退貨及退款情形。 物件 唯讀
current_total_tax 訂單目前收取的總稅金,使用商店幣別。此欄位值會反映訂單編輯、退貨及退款情形。 字串 varchar(255) 唯讀
current_total_tax_set 訂單目前收取的總稅金,使用商店及出示幣別。和此欄位相關的數值會反映訂單編輯、退貨及退款情形。 物件 唯讀
客戶 預設值:NULL 顧客資訊。可能無顧客和應用程式資訊的訂單不應依賴顧客物件。如果是透過 Shopify POS 建立的訂單,則此值可能會是「null」 整數 bigint(20)
customer_locale 預設值:NULL 二碼或三碼語言代碼,後面可能會加註地區修飾詞。 字串 varchar(255) 唯讀
discount_applications 套用的多重折扣的排序清單。

discount_applications 屬性包括 3 種類型:discount_code、manual 和 script,這 3 種類型都使用相同的結構,並有部分該類型特定的屬性。
陣列 唯讀
discount_codes 該訂單套用的折扣清單。 陣列
電子郵件 客戶的電子郵件地址。 varchar(255)
estimated_taxes 訂單是否已經估算稅金。在顧客提交訂單到訂單開始運送之間很多因素都會變更,也可能因此影響稅金計算方式。如果訂單已經決定稅金,且不會因為任何因素變更,則此屬性會回傳「false」。 布林值 tinyint(1)
financial_status
  • 待處理
  • authorized
  • partially_paid
  • 已付款
  • partially_refunded
  • refunded
預設值:NULL
訂單相關付款狀態。訂單建立後才能設定此屬性。 字串 varchar(255) 唯讀
fulfillment_status
  • 已出貨
  • 未出貨
  • null
  • 部分
  • restocked
預設值:unfulfilled
訂單中關於已出貨商品項目的狀態。 字串 varchar(255)
訂單出貨作業 訂單相關出貨作業陣列 陣列
id 預設值:NULL API 用訂單 ID。此屬性和 order_number 屬性不同,後者是商店擁有者和顧客用的 ID。 整數 bigint(20) 唯讀
landing_site 預設值:NULL 買家進入商店的頁面網址。 字串 varchar(4096) 唯讀
line_items 商品項目物件清單,每條項目都有訂單品項的資訊 陣列
location_id 預設值:NULL 訂單處理的實體地點 ID。如果您需要參照訂單的地點,請用 FulfillmentOrder 資源。 整數 bigint(20)
名稱 預設值:NULL 合併 order_number 屬性和商家一般設定的訂單前綴及後綴後,所產生的訂單名稱。此屬性和 ID 屬性不同,後者為 API 使用的訂單 ID。API 也可以將此欄位設為任何字串值。 字串 varchar(255)
備註 預設值:NULL 商店擁有者可選擇為訂單加上的備註。 字串
note_attributes 預設值:NULL 訂單加入的其他資訊,顯示於訂單詳細資訊頁面的「其他詳細資訊」區段。每個陣列項目都必須有名稱和值金鑰的雜湊。 字串
number 預設值:NULL 訂單在商店訂單計數中的位置,為連續數字,從 1 開始。 整數 int(11) 唯讀
order_number 訂單在商店訂單計數中的位置,從 1001 開始。訂單號碼為連續數字。 整數 bigint(20) 唯讀
order_status_url 指向訂單狀態網頁 (如果有的話) 的網址。 字串 varchar(255) 唯讀
original_total_duties_set 訂單原始收取的總關稅,使用商店及出示幣別。 物件 唯讀
payment_gateway_names 預設值:NULL 訂單使用的付款閘道清單。
varchar(255) 唯讀
payment_terms 預設值:NULL 處理付款應遵守的條款及條件。 物件 bigint(20) 唯讀
電話 預設值:NULL 顧客接收簡訊通知用的電話號碼。 字串 varchar(255)
presentment_currency 預設值:NULL 用來向客戶顯示價格的出示幣別。 字串 char(3)
processed_at 預設值:NULL 處理訂單的日期和時間 (ISO 8601 格式)。這個值是訂單上顯示的日期,分析報告也會使用這個值。如果您透過應用程式或其他平台匯入訂單,則可以將 processed_at 設定為過去的日期和時間,以便符合原始訂單建立時間。 date 日期時間(6)
processing_method
  • 結帳
  • 直接
  • 手動
  • offsite
  • express
  • 免費
付款處理方式 字串 varchar(255) 唯讀
referring_site 預設值:NULL 顧客點擊商店連結的網站。 字串 varchar(4096)
退款 訂單套用的退款清單 陣列 唯讀
shipping_address 預設值:NULL 訂單運送目的地郵寄地址。這是選填內容,如果是不需要運送的訂單,則無法提供此地址 整數 bigint(20)
shipping_lines 物件陣列,每個項目都會詳細說明使用的運送方式。 陣列
source_name 預設值:NULL 訂單產生來源。此屬性只能在建立訂單時設定,之後無法寫入。受到保護且無法透過其他 API 用戶端指派的 Shopify 管道值:web、pos、shopify_draft_order、iphone 及 android。透過 API 建立的訂單可以指派其他任意字串。如果並未指定,則新訂單會指派應用程式 ID 的值。 字串 varchar(255)
subtotal_price 訂單加上折扣,但尚未計算運費、關稅、稅金、小費等費用的價格,使用商店幣別。 整數 bigint(20)
subtotal_price_set 訂單加上折扣,但尚未計算運費、關稅、稅金、小費等費用的小計金額,使用出示幣別。 物件
標籤 訂單附加的標籤,格式為以半形逗號分隔值的字串。標籤就是額外的短描述,通常作為篩選或搜尋條件使用。每個標籤皆有 40 個字元的長度上限。 字串 varchar(4096)
tax_lines 稅金行物件陣列,每個項目都會詳細說明訂單套用的稅金。每個物件都有以下屬性:

透過 API 建立訂單時,稅金行可以透過訂單或商品項目列出,但無法同時使用兩者。訂單列出的稅金行會分散到各個應納稅的商品項目中,並會按照建立順序排行。
陣列
taxes_included
預設值:0
訂單小計是否包括稅金。 布林值 tinyint(1)
測試
預設值:0
是否為測試訂單。 布林值 tinyint(1) 唯讀
token 預設值:NULL 參照訂單時使用的專用值。 字串 varchar(32) 唯讀
total_discounts 預設值:0 訂單價格目前套用的總折扣,使用商店幣別。 字串 decimal(21,3)
total_discounts_set 訂單價格目前套用的總折扣,使用商店及出示幣別。 物件
total_line_items_price 預設值:0 所有商品項目價格的總和,使用商店幣別。 字串 decimal(21,3)
total_line_items_price_set 所有商品項目的總金額,使用商店及出示幣別。 物件
total_outstanding 預設值:0 訂單所有未付金額,使用商店幣別。 字串 decimal(21,3)
total_price 預設值:0 所有商品項目價格、折扣、運費、稅金、小費的總和,使用商店幣別。必須為正值。 字串 decimal(21,3)
total_price_set 商店訂單總價格,使用商店及出示幣別。 物件
total_shipping_price_set 訂單總運費,不計算折扣和退款,使用商店及出示幣別。如果 taxes_included 設定為「true」,則 total_shipping_price_set 含稅。 物件
total_tax 預設值:0 訂單套用的所有稅金總和,使用商店幣別。必須為正值。 字串 decimal(21,3)
total_tax_set 訂單套用的總稅金,使用商店及出示幣別。 物件
total_tip_received 訂單所有小費總和,使用商店幣別。 整數 bigint(20) 唯讀
total_weight 預設值:0 所有商品項目的重量總和,單位為公克。從訂單中移除品項時,這個值不會變更。 整數 bigint(20) unsigned
updated_at 訂單上次修改的日期和時間 (ISO 8601 格式)。 date 日期時間(6) 唯讀
user_id 預設值:NULL 登入 Shopify POS 並處理訂單的使用者 ID (如果有的話)。 整數 bigint(20)

Product 資源屬性

以下表格可以為您提供 REST 管理員 API Product 資源屬性的實用資訊。

REST 商品資源重要屬性資料
屬性 說明 資料類型 欄位長度 欄位存取權 重要必填欄位
body_html 預設值:NULL 產品說明,支援 HTML 格式。 字串 mediumtext
created_at 預設值:NULL 商品建立的日期和時間 (ISO 8601 格式)。 date 日期時間 唯讀
handle 預設值:NULL 字串 varchar(255)
id 預設值:NULL 當作產品專用識別碼使用的未簽署 64 位元整數。在 Shopify 系統中,每項 ID 都是專用的,不會有兩項商品使用同一組 ID,即使商品來自不同商店也一樣。 整數 bigint(20) 唯讀
圖片 產品圖片物件清單,每個項目都代表和商品相關的圖片。 [{ product_image }]
選項 自訂商品屬性,如:尺寸、顏色、材料。每項商品最多可設定 3 個選項,每個選項值最多可使用 255 個字元。產品子類選項即為選項值組合後的結果,若無值則無法建立選項。若要建立新選項,則您也需要建立設有相關選項值的子類。 陣列
product_type 預設值:NULL 商品分類,供篩選和搜尋商品時使用。 字串 varchar(255)
published_at 預設值:NULL 商品發佈的日期和時間 (ISO 8601 格式)。若設為「null」,即可從網路商店管道中取消發佈該商品。 date 日期時間
published_scope
  • Web
  • global
商品是否已經發佈到 Shopify Point of Sale (POS) 管道。 字串
狀態
  • 啟用中
  • 已封存
  • 草稿
預設值:active
商品狀態。 字串 varchar(32)
標籤 篩選和搜尋時使用的標籤字串,以半形逗號分隔。商品最多可設定 250 個標籤,每個標籤最多可使用 255 個字元。 字串
template_suffix 預設值:NULL 產品頁面使用的 Liquid 範本尾碼。如果有指定此屬性,那麼產品頁面會使用名為「product.suffix.liquid」的範本,「suffix」部分為此屬性值。如果此屬性設為「」或「null」,則產品頁面會使用預設範本「product.liquid」。 字串 varchar(255)
標題 預設值:NULL 商品名稱 字串 varchar(255)
updated_at 預設值:NULL 商品上次修改的日期和時間 (ISO 8601 格式)。商品的 updated_at 值變動的原因有很多,舉例來說,如果提交的訂單內有設定庫存追蹤的商品,那麼系統會將庫存調整視為更新。 date 日期時間 唯讀
變體 產品子類選項陣列,每個項目都代表了商品的不同版本。這個位置屬性是唯讀狀態。列出的訂單會顯示子類的位置。 陣列
vendor 預設值:NULL 商品的廠商名稱。 字串 varchar(255)

ProductImage 資源屬性

以下表格可以為您提供 REST 管理員 API ProductImage 資源屬性的實用資訊。本資源並無唯讀或重要必填欄位。

REST ProductImage 資源相關重要屬性資料
屬性 說明 資料類型 欄位長度
created_at 預設值:NULL 產品圖片建立的日期與時間。API 會用 ISO 8601 格式傳回此值。 date 日期時間
height 預設值:NULL 上傳時決定的圖片高度尺寸。 smallint(4) unsigned
id 預設值:NULL 產品圖片唯一數字識別碼。(auto_increment) 整數 bigint(20)
position 預設值:0 產品圖片在清單內的順序。第一張產品圖片為位置 1,並且是該商品的「主要」圖片。 smallint(5) unsigned
product_id 預設值:NULL 該圖片相關商品的 ID。 bigint(20)
src 說明產品圖片位置。此參數支援網址篩選條件,您可以用這些篩選條件擷取修改後的圖片複本。舉例來說,在檔案名稱加上 _small (例:ipod-nano_small.png) 即可擷取縮放為 100 x 100 像素的圖片複本,或是加上 _2048x2048 (例:ipod-nano_2048x2048.png) 即可擷取解析度限制為 2048 x 2048 像素的圖片複本。
updated_at 預設值:NULL 產品圖片上次修改的日期與時間。API 會用 ISO 8601 格式傳回此值。 date 日期時間
variant_ids 圖片相關子類 ID 陣列。
寬度 預設值:NULL 上傳時決定的圖片寬度尺寸。 smallint(4) unsigned

ProductVariant 資源屬性

以下表格可以為您提供 REST 管理員 API ProductVariant 資源屬性的實用資訊。本資源並無重要必填欄位。

REST ProductVariant 資源相關重要屬性資料
屬性 說明 資料類型 欄位長度 欄位存取權
條碼 預設值:NULL 產品的條碼 UPC 或 ISBN 號碼。 varchar(255)
compare_at_price 預設值:NULL 品項調整或套用特賣活動之前的原始價格。 decimal(20,2)
created_at 預設值:NULL 產品子類選項建立的日期和時間 (ISO 8601 格式)。 date 日期時間
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 Default: 1 所有地點的庫存彙總。若想調整特定地點的庫存,請用 InventoryLevel 資源。 int(11) 唯讀
    option 商店擁有者用來定義產品子類選項的自訂屬性。您可以為產品子類選項定義三種選項:option1、option2、option3。預設值:預設標題。標題欄位由 option1、option2、option3 欄位組合而成。更新選項欄位便會更新標題欄位。
    position 預設值:0 該產品子類選項在產品子類選項清單內的順序。清單內的第一順位是 1。列出的訂單會顯示子類的位置。 smallint(5) unsigned 唯讀
    presentment_prices 子類的出示價格及比較售價清單,各項目都會使用該商店啟用的出示幣別。每項價格物件皆有以下屬性:
    -currency_code:商店啟用的出示幣別之一的三碼代碼 (ISO 4217 格式)。
    -amount:子類的價格或比較售價,使用出示幣別。
    須使用「X-Shopify-Api-Features」頁首:「include-presentment-prices」。
    唯讀
    價格 預設值:0 產品子類的價格。 decimal(20,2)
    product_id 預設值:NULL 產品的唯一數值識別碼。 bigint(20)
    requires_shipping Default: 1 此屬性已遭淘汰。請改用 InventoryItem 資源的「requires_shipping」屬性。 布林值 tinyint(1)
    存貨單位 (SKU) 該產品子類選項在商店中的專用識別碼。需有此屬性才能連接 FulfillmentService。 varchar(255)
    tax_code 只有安裝 Avalara AvaTax 應用程式的商店才會套用此參數。說明該產品子類選項的 Avalara 課稅碼。
    taxable Default: 1 產品子類售出時是否應課稅。 布林值 tinyint(1)
    標題 產品子類選項標題。標題欄位由 option1、option2、option3 欄位組合而成。您只能透過選項欄位間接更新標題。 varchar(255) 唯讀
    updated_at 預設值:NULL 產品子類選項上次修改的日期和時間。系統會以 ISO 8601 格式回傳。 date 日期時間
    weight 產品子類選項重量,使用 weight_unit 指定的單位。
    weight_unit
    • g
    • kg
    • oz
    • lb
    預設值:NULL
    產品子類選項重量使用的單位。如果您未指定 weight_unit 的值,則會套用商店預設單位。 varchar(2)