Shopify (獨立發布商) (預覽版)
REST 介面,供 Shopify 商家接收、處理和管理訂單。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | Microsoft動力學 |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| bennettray@microsoft.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 雷·貝內特 (MSFT) |
| 網站 | https://www.shopify.com/ |
| 隱私策略 | https://www.shopify.com/legal/privacy |
| 類別 | 生產力 |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | securestring | 此 API 的存取權杖。 | 對 |
| 商店網址 | 字串 | Shopify 商店網址 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 取消訂單 |
按 ID 取消訂單。 |
| 擷取客戶清單 |
擷取符合指定準則的客戶清單 |
| 擷取訂單清單 |
擷取符合指定條件的訂單清單 |
| 更新訂單 |
使用提供的資訊更新訂單。 |
取消訂單
按 ID 取消訂單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訂單編號
|
order_id | True | string |
將取消的訂單的 ID。 |
|
退款實際金額
|
amount | string |
要退款的金額。 如果設定,Shopify 會嘗試取消付款或退款,視其狀態而定。 如果原始交易不是在 Shopify 中進行的,Shopify 會透過手動閘道進行退款。 透過手動閘道的退款會在 Shopify 上記錄為退款,但不會向顧客退款。 |
|
|
退款貨幣
|
currency | string |
取消訂單時發出的退款貨幣。 每當提供金額屬性時,多幣種訂單都需要。 |
|
|
補貨已退款的商品
|
restock | string |
是否要將退款的商品補貨回您商店的庫存。 |
|
|
訂單取消原因
|
reason | string |
訂單取消的原因。 有效值:customer、inventory、fraud、declined等。 |
|
|
取消電子郵件
|
string |
是否要傳送電子郵件給客戶,通知他們取消。 |
||
|
退款
|
refund | string |
要執行的退款交易。 |
|
|
|
object |
傳回
訂單
- 身體
- order
擷取客戶清單
擷取符合指定準則的客戶清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
客戶 ID
|
ids | string |
將結果限制為以逗號分隔的 ID 清單所指定的客戶。 |
|
|
自 ID 以來
|
since_id | string |
限制指定 ID 之後的結果。 |
|
|
創建時間 min
|
created_at_min | string |
顯示在指定日期之後建立的客戶 (格式:2014-04-25T16:15:47-04:00)。 |
|
|
最多創建
|
created_at_max | string |
顯示在指定日期之前建立的客戶 (格式:2014-04-25T16:15:47-04:00)。 |
|
|
更新時間
|
updated_at_min | string |
顯示客戶上次更新日期後的指定日期 (格式:2014-04-25T16:15:47-04:00)。 |
|
|
最多更新
|
updated_at_max | string |
顯示客戶在指定日期之前的上次更新 (格式:2014-04-25T16:15:47-04:00)。 |
|
|
限制
|
limit | string |
要顯示的結果數目上限。 (預設值:50)(最多:250)。 |
|
|
Fields
|
fields | string |
僅顯示特定欄位,由逗號分隔的欄位清單指定。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
customers
|
customers | array of customer |
擷取訂單清單
擷取符合指定條件的訂單清單
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
訂單 ID
|
ids | string |
僅擷取以逗號分隔的訂單 ID 清單所指定的訂單。 |
|
|
限制
|
limit | string |
要在頁面上顯示的結果數目上限。 |
|
|
自 ID 以來
|
since_id | string |
在指定 ID 之後顯示訂單。 |
|
|
創建時間 min
|
created_at_min | string |
顯示在日期或之後建立的訂單(格式:2014-04-25T16:15:47-04:00)。 |
|
|
最多創建
|
created_at_max | string |
顯示在日期或之前建立的訂單(格式:2014-04-25T16:15:47-04:00)。 |
|
|
更新時間
|
updated_at_min | string |
顯示最後更新日期或之後的訂單(格式:2014-04-25T16:15:47-04:00)。 |
|
|
最多更新
|
updated_at_max | string |
顯示最後更新日期或之前的訂單(格式:2014-04-25T16:15:47-04:00)。 |
|
|
處理時間最小
|
processed_at_min | string |
顯示日期或之後匯入的訂單(格式:2014-04-25T16:15:47-04:00)。 |
|
|
最大處理
|
processed_at_max | string |
顯示日期或之前匯入的訂單(格式:2014-04-25T16:15:47-04:00)。 |
|
|
歸因應用程式ID
|
attribution_app_id | string |
顯示歸因於特定應用程式的訂單,由應用程式 ID 指定。 |
|
|
訂單狀態
|
status | string |
按狀態過濾訂單。 |
|
|
財務狀況
|
financial_status | string |
按財務狀況過濾訂單。 |
|
|
履行狀態
|
fulfillment_status | string |
按訂單的履行狀態過濾訂單。 |
|
|
Fields
|
fields | string |
僅擷取特定欄位,由逗號分隔的欄位清單指定。 |
|
|
記錄的順序順序
|
order | string |
排序訂單的欄位和方向。 若要指定方向,請將 ' asc' 或 ' desc' 新增至查詢參數的結尾。 例如,'order=updated_at asc'。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
orders
|
orders | array of order |
更新訂單
定義
順序
訂單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
建立訂單的應用程式識別碼。 |
|
電子郵件
|
string |
客戶的電子郵件地址。 |
|
|
closed_at
|
closed_at | string |
訂單關閉的日期和時間 (ISO 8601 格式)。 如果訂單未關閉,則傳回 null。 |
|
建立於
|
created_at | string |
商店貨幣的三個字母代碼(ISO 4217 格式)。 |
|
updated_at
|
updated_at | string |
上次修改訂單的日期和時間 (ISO 8601 格式)。 |
|
數字
|
number | integer |
訂單在商店訂單計數中的位置。 數字是連續的,從 1 開始。 |
|
注意
|
note | string |
店主可以附加到訂單上的可選附註。 |
|
Token
|
token | string |
參照訂單時的唯一值。 |
|
閘道
|
gateway | string |
使用的付款閘道。 |
|
測試
|
test | boolean |
這是否是測試令。 |
|
total_price
|
total_price | string |
所有委刊項價格、折扣、運費、稅金和小費的總和,以商店貨幣表示。 必須是正面的。 |
|
subtotal_price
|
subtotal_price | string |
折扣後但出貨、關稅、稅金和小費之前的商店貨幣訂單價格。 |
|
total_weight
|
total_weight | integer |
所有明細項目加權的總和 (以克為單位)。 當項目從訂單中刪除時,總和不會調整。 |
|
total_tax
|
total_tax | string |
以商店貨幣計價的訂單所適用的所有稅金總和。 必須是正面的。 |
|
taxes_included
|
taxes_included | boolean |
稅金是否包含在訂單小計中。 |
|
貨幣
|
currency | string |
商店貨幣的三個字母代碼(ISO 4217 格式)。 |
|
financial_status
|
financial_status | string |
與訂單相關聯的付款狀態。 只能在建立訂單時設定。 |
|
已確認
|
confirmed | boolean |
訂單確認。 |
|
total_discounts
|
total_discounts | string |
以商店貨幣應用於訂單價格的總折扣。 |
|
total_line_items_price
|
total_line_items_price | string |
以商店貨幣表示的所有明細項目價格總和。 |
|
cart_token
|
cart_token | string |
參考與訂單相關聯的購物車時的唯一值。 |
|
buyer_accepts_marketing
|
buyer_accepts_marketing | boolean |
顧客是否同意接收商店的電子郵件更新。 |
|
名稱
|
name | string |
訂單名稱,透過將order_number屬性與商家一般設定中設定的訂單前綴和後綴結合而產生。 |
|
referring_site
|
referring_site | string |
客戶點擊商店連結的網站。 |
|
landing_site
|
landing_site | string |
買家進入商店時登陸的頁面的網址。 |
|
cancelled_at
|
cancelled_at | string |
取消訂單的日期和時間。 如果訂單未取消,則傳回 null。 |
|
cancel_reason
|
cancel_reason | string |
訂單被取消的原因。 |
|
total_price_usd
|
total_price_usd | string |
總價美元。 |
|
checkout_token
|
checkout_token | string |
參考與訂單相關聯的結帳時的唯一值。 |
|
參考
|
reference | string |
訂單參考。 |
|
user_id
|
user_id | integer |
登入 Shopify POS 並處理訂單的使用者 ID (如果適用)。 |
|
location_id
|
location_id | integer |
處理訂單的實體位置的 ID。 如果您需要針對訂單參考位置,請使用 FulfillmentOrder 資源。 |
|
source_identifier
|
source_identifier | string |
來源識別碼。 |
|
source_url
|
source_url | string |
來源網址。 |
|
processed_at
|
processed_at | string |
處理訂單的日期和時間 (ISO 8601 格式)。 |
|
device_id
|
device_id | string |
裝置的識別碼。 |
|
phone
|
phone | string |
客戶用於接收簡訊通知的電話號碼。 |
|
customer_locale
|
customer_locale | string |
兩個或三個字母的語言代碼,後面接著區域修飾符。 |
|
app_id
|
app_id | integer |
建立訂單的應用程式識別碼。 |
|
browser_ip
|
browser_ip | string |
客戶下訂單時使用的瀏覽器的 IP 位址。 |
|
landing_site_ref
|
landing_site_ref | string |
著陸點參考。 |
|
order_number
|
order_number | integer |
訂單在商店訂單計數中的位置,從 1001 開始。 |
|
discount_applications
|
discount_applications | discount_applications |
折扣應用程式的說明,由商家或 Shopify 指令碼定義。 |
|
discount_codes
|
discount_codes | discount_codes |
套用至訂單的折扣清單。 |
|
note_attributes
|
note_attributes | note_attributes |
新增至訂單的額外資訊。 |
|
payment_gateway_names
|
payment_gateway_names | payment_gateway_names |
用於訂單的付款閘道清單。 |
|
processing_method
|
processing_method | string |
付款是如何處理的。 |
|
checkout_id
|
checkout_id | integer |
結帳 ID。 |
|
source_name
|
source_name | string |
訂單的來源。 |
|
fulfillment_status
|
fulfillment_status | string |
訂單的狀態(以已出貨委刊項計)。 |
|
tax_lines
|
tax_lines | tax_lines |
稅金明細物件的清單,每個物件都會詳細說明套用至品項的稅金。 |
|
tags
|
tags | string |
附加至訂單的標籤,格式為逗號分隔值的字串。 標籤是額外的簡短描述符,通常用於過濾和搜尋。 |
|
contact_email
|
contact_email | string |
聯繫電子郵件。 |
|
order_status_url
|
order_status_url | string |
指向訂單狀態網頁的 URL(如果適用)。 |
|
presentment_currency
|
presentment_currency | string |
用來向客戶顯示價格的呈現貨幣。 |
|
total_line_items_price_set
|
total_line_items_price_set | subtotal_tax_discount_price_set | |
|
total_discounts_set
|
total_discounts_set | subtotal_tax_discount_price_set | |
|
total_shipping_price_set
|
total_shipping_price_set | subtotal_tax_discount_price_set | |
|
subtotal_price_set
|
subtotal_price_set | subtotal_tax_discount_price_set | |
|
total_price_set
|
total_price_set | subtotal_tax_discount_price_set | |
|
total_tax_set
|
total_tax_set | subtotal_tax_discount_price_set | |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理員 graphql api id。 |
|
shipping_lines
|
shipping_lines | shipping_lines |
使用哪種運輸方式的詳細信息。 |
|
billing_address
|
billing_address | billing_address |
與付款方式相關聯的郵寄地址。 此地址是可選欄位,不適用於不需要付款方式的訂單。 |
|
shipping_address
|
shipping_address | shipping_address |
訂單將運送到的郵寄地址。 此地址是可選的,不適用於不需要運送的訂單。 |
|
client_details
|
client_details | client_detail |
客戶下訂單時使用的瀏覽器相關資訊。 |
|
payment_details
|
payment_details | payment_detail |
包含付款相關資訊的物件。 |
|
客戶
|
customer | customer |
客戶的相關資訊。 |
|
line_items
|
line_items | line_items | |
|
履行
|
fulfillments | fulfillments |
與訂單相關聯的履行陣列。 |
|
退款
|
refunds | refunds |
退款 |
客戶
客戶的相關資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
客戶的唯一識別碼。 |
|
電子郵件
|
string |
客戶的唯一電子郵件地址。 嘗試將相同的電子郵件地址指派給多個客戶會傳回錯誤。 |
|
|
accepts_marketing
|
accepts_marketing | boolean |
客戶是否同意透過電子郵件接收行銷資料。 |
|
建立於
|
created_at | string |
建立客戶的日期和時間 (ISO 8601 格式)。 |
|
updated_at
|
updated_at | string |
上次更新客戶資訊的日期和時間 (ISO 8601 格式)。 |
|
first_name
|
first_name | string |
客戶的名字。 |
|
last_name
|
last_name | string |
客戶的姓氏。 |
|
orders_count
|
orders_count | integer |
與此客戶相關聯的訂單數。 |
|
狀態
|
state | string |
客戶在商店的帳戶狀態。 預設值:已停用。 |
|
total_spent
|
total_spent | string |
客戶在其訂單歷史記錄中花費的總金額。 |
|
last_order_id
|
last_order_id | integer |
客戶最後訂單的 ID。 |
|
注意
|
note | string |
關於客戶的說明。 |
|
verified_email
|
verified_email | boolean |
客戶是否已驗證其電子郵件地址。 |
|
multipass_identifier
|
multipass_identifier | string |
與多重通行證登入搭配使用的客戶唯一識別碼。 |
|
tax_exempt
|
tax_exempt | boolean |
顧客是否免於為其訂單繳稅。 如果為true,則結帳時不會將稅金套用至訂單。 如果為 false,則將在結帳時徵收稅費。 |
|
phone
|
phone | string |
此客戶的唯一電話號碼(E.164 格式)。 嘗試將相同的電話號碼指派給多個客戶會傳回錯誤。 |
|
tags
|
tags | string |
店主附加給顧客的標籤,格式為逗點分隔值的字串。 客戶最多可以有 250 個標籤。 每個標籤最多可以有 255 個字元。 |
|
last_order_name
|
last_order_name | string |
客戶最後一次訂單的名稱。 這與訂單資源上的名稱欄位直接相關。 |
|
貨幣
|
currency | string |
客戶在支付上一筆訂單時使用的貨幣的三個字母代碼 (ISO 4217 格式)。 |
|
addresses
|
addresses | addresses |
客戶最近更新的十個地址清單。 |
|
accepts_marketing_updated_at
|
accepts_marketing_updated_at | string |
客戶同意或反對透過電子郵件接收行銷資料的日期和時間 (ISO 8601 格式)。 |
|
marketing_opt_in_level
|
marketing_opt_in_level | string |
客戶同意透過電子郵件接收行銷資料時提供的行銷訂閱選擇加入層級。 |
|
tax_exemptions
|
tax_exemptions | array of |
客戶是否免於為其訂單支付特定稅金。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理員 graphql api id。 |
|
default_address
|
default_address | default_address |
default_address
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
地址的唯一識別碼。 |
|
customer_id
|
customer_id | integer |
客戶的唯一識別碼。 |
|
first_name
|
first_name | string |
客戶的名字。 |
|
last_name
|
last_name | string |
客戶的姓氏。 |
|
公司
|
company | string |
客戶的公司。 |
|
位址1
|
address1 | string |
客戶郵寄地址的第一行。 |
|
位址2
|
address2 | string |
客戶郵寄地址的附加欄位。 |
|
city
|
city | string |
客戶所在的城市、城鎮或村莊。 |
|
省
|
province | string |
客戶的區域名稱。 通常是一個省、一個州或一個縣。 |
|
country
|
country | string |
客戶所在的國家/地區。 |
|
壓縮檔
|
zip | string |
客戶的郵遞區號,也稱為郵遞區號、郵遞區號、Eircode等。 |
|
phone
|
phone | string |
客戶在此地址的電話號碼。 |
|
名稱
|
name | string |
客戶的名字和姓氏。 |
|
province_code
|
province_code | string |
客戶所在區域的兩個字母代碼。 |
|
country_code
|
country_code | string |
對應於客戶所在國家/地區的兩個字母國家/地區代碼。 |
|
country_name
|
country_name | string |
客戶的正規化國家/地區名稱。 |
|
預設
|
default | boolean |
針對每個預設位址傳回 true。 |
shipping_address
訂單將運送到的郵寄地址。 此地址是可選的,不適用於不需要運送的訂單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
first_name
|
first_name | string |
與送貨地址相關聯的人員的名字。 |
|
位址1
|
address1 | string |
送貨地址的街道地址。 |
|
phone
|
phone | string |
送貨地址的電話號碼。 |
|
city
|
city | string |
送貨地址所在的城市、城鎮或村莊。 |
|
壓縮檔
|
zip | string |
送貨地址的郵遞區號 (例如,郵遞區號或 Eircode)。 |
|
省
|
province | string |
送貨地址的區域名稱 (例如,省、州或縣)。 |
|
country
|
country | string |
送貨地址所在的國家/地區名稱。 |
|
last_name
|
last_name | string |
與送貨地址相關聯的人員的姓氏。 |
|
位址2
|
address2 | string |
送貨地址街道地址的選用附加欄位。 |
|
公司
|
company | string |
與送貨地址相關聯的人員的公司。 |
|
緯度
|
latitude | float |
送貨地址的緯度。 |
|
經度
|
longitude | float |
送貨地址的經度。 |
|
名稱
|
name | string |
與付款方式相關聯的人員的全名。 |
|
country_code
|
country_code | string |
送貨地址所在國家/地區的兩個字母代碼(ISO 3166-1 格式)。 |
|
province_code
|
province_code | string |
送貨地址所在地區的兩個字母縮寫。 |
billing_address
與付款方式相關聯的郵寄地址。 此地址是可選欄位,不適用於不需要付款方式的訂單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
first_name
|
first_name | string |
與付款方式相關聯的人員的名字。 |
|
位址1
|
address1 | string |
帳單地址的街道地址。 |
|
phone
|
phone | string |
帳單地址的電話號碼。 |
|
city
|
city | string |
帳單地址所在的城市、城鎮或村莊。 |
|
壓縮檔
|
zip | string |
帳單地址的郵遞區號 (例如,郵遞區號或 Eircode)。 |
|
省
|
province | string |
帳單地址的區域名稱 (例如,省、州或都道府縣)。 |
|
country
|
country | string |
帳單地址所在的國家/地區名稱。 |
|
last_name
|
last_name | string |
與付款方式相關聯的人員的姓氏。 |
|
位址2
|
address2 | string |
帳單地址街道地址的選用附加欄位。 |
|
公司
|
company | string |
與帳單地址相關聯的人員的公司。 |
|
緯度
|
latitude | float |
帳單地址的緯度。 |
|
經度
|
longitude | float |
帳單地址的經度。 |
|
名稱
|
name | string |
與付款方式相關聯的人員的全名。 |
|
country_code
|
country_code | string |
帳單地址所在國家/地區的兩個字母代碼 (ISO 3166-1 格式)。 |
|
province_code
|
province_code | string |
帳單地址所在地區的兩個字母縮寫。 |
addresses
客戶最近更新的十個地址清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
default_address |
shipping_line
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
全域唯一識別碼。 |
|
title
|
title | string |
運送方式的標題。 |
|
價格
|
price | string |
此運送方式以商店貨幣表示的價格。 |
|
字碼
|
code | string |
對運輸方法的引用。 |
|
來源
|
source | string |
運送方式的來源。 |
|
phone
|
phone | string |
送貨地址的電話號碼。 |
|
requested_fulfillment_service_id
|
requested_fulfillment_service_id | string |
對運送方式所要求的履行服務的參照。 如果運送方式需要由第三方出貨服務處理,請出示;否則為 null。 |
|
delivery_category
|
delivery_category | string |
外送類別。 |
|
carrier_identifier
|
carrier_identifier | string |
對提供費率的運營商服務的引用。 當費率由第三方電信業者服務計算時出現。 |
|
discounted_price
|
discounted_price | string |
套用行級折扣後的運送方式價格。 不反映購物車層級或訂單層級折扣。 |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
discounted_price_set
|
discounted_price_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
折扣應用程式分配的金額的排序清單。 |
|
tax_lines
|
tax_lines | tax_lines |
稅金明細物件的清單,每個物件都會詳細說明套用至品項的稅金。 |
client_detail
客戶下訂單時使用的瀏覽器相關資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
browser_ip
|
browser_ip | string |
瀏覽器 IP 位址。 |
|
accept_language
|
accept_language | string |
瀏覽器可理解的語言和地區設定。 |
|
user_agent
|
user_agent | string |
瀏覽用戶端的詳細資料,包括軟體和操作版本。 |
|
session_hash
|
session_hash | string |
會話的雜湊。 |
|
browser_width
|
browser_width | integer |
瀏覽器螢幕寬度 (以像素為單位) (如果有的話)。 |
|
browser_height
|
browser_height | integer |
瀏覽器螢幕高度 (以像素為單位) (如果有的話)。 |
payment_detail
包含付款相關資訊的物件。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
credit_card_bin
|
credit_card_bin | string |
客戶信用卡的發卡識別號碼 (IIN),以前稱為銀行識別號碼 (BIN)。 |
|
avs_result_code
|
avs_result_code | string |
來自地址驗證系統 (AVS) 的回應碼。 代碼是一個字母。 |
|
cvv_result_code
|
cvv_result_code | string |
信用卡公司的回應碼,指示客戶是否正確輸入卡片安全碼(卡片驗證值)。 代碼是單個字母或空字符串。 |
|
credit_card_number
|
credit_card_number | string |
客戶的信用卡號碼,大部分前導數字已編輯。 |
|
credit_card_company
|
credit_card_company | string |
發行客戶信用卡的公司名稱。 |
subtotal_tax_discount_price_set
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
金額
|
shop_money.amount | string |
實際金額。 |
|
currency_code
|
shop_money.currency_code | string |
採用 ISO 4217 格式。 |
|
金額
|
presentment_money.amount | string |
實際金額。 |
|
currency_code
|
presentment_money.currency_code | string |
採用 ISO 4217 格式。 |
line_item_property
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
產品名稱。 |
|
value
|
value | string |
產品價值。 |
line_item_properties
屬性。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
line_item_property |
履行
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
履行的ID。 |
|
order_id
|
order_id | integer |
訂單的唯一數值識別碼。 |
|
狀態
|
status | string |
履行的狀態。 |
|
建立於
|
created_at | string |
建立履行的日期和時間。 |
|
服務
|
service | string |
使用的服務類型。 |
|
updated_at
|
updated_at | string |
上次修改履行的日期和時間 (ISO 8601 格式)。 |
|
tracking_company
|
tracking_company | string |
追蹤公司的名稱。 |
|
shipment_status
|
shipment_status | string |
履行的目前出貨狀態。 |
|
location_id
|
location_id | integer |
應處理履行的位置的唯一識別碼。 |
|
tracking_number
|
tracking_number | string |
由運輸公司提供的追蹤號碼。 |
|
tracking_numbers
|
tracking_numbers | array of string |
運輸公司提供的追蹤號碼清單。 |
|
tracking_url
|
tracking_url | string |
履行的追蹤頁面URL。 |
|
tracking_urls
|
tracking_urls | array of string |
履行的追蹤頁面的URL。 |
|
收條
|
receipt | receipt |
提供收據相關資訊的文字欄位。 |
|
名稱
|
name | string |
唯一識別的履行名稱。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理員 graphql api id。 |
|
line_items
|
line_items | line_items |
履行
與訂單相關聯的履行陣列。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
fulfillment |
交易
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
交易的識別碼。 |
|
order_id
|
order_id | integer |
與交易相關聯的訂單識別碼。 |
|
類型
|
kind | string |
交易的類型。 |
|
閘道
|
gateway | string |
發出交易所通過的閘道名稱。 |
|
狀態
|
status | string |
交易的狀態。 |
|
訊息
|
message | string |
付款提供者產生的字串,其中包含有關交易成功或失敗原因的其他資訊。 |
|
建立於
|
created_at | string |
建立交易的日期和時間 (ISO 8601 格式)。 |
|
測試
|
test | boolean |
交易是否為測試交易。 |
|
授權
|
authorization | string |
與交易相關聯的授權碼。 |
|
location_id
|
location_id | string |
處理交易之實體位置的識別碼。 |
|
user_id
|
user_id | string |
處理訂單時登入 Shopify POS 裝置的使用者 ID (如果適用)。 |
|
parent_id
|
parent_id | integer |
相關聯交易的 ID。 |
|
processed_at
|
processed_at | string |
處理交易的日期和時間 (ISO 8601 格式)。 |
|
device_id
|
device_id | string |
裝置的識別碼。 |
|
error_code
|
error_code | string |
標準化錯誤代碼,獨立於支付提供者。 |
|
source_name
|
source_name | string |
交易的來源。 這是由 Shopify 設定的,無法覆寫。 |
|
金額
|
amount | string |
交易中包含的金額。 |
|
貨幣
|
currency | string |
用於付款的貨幣的三個字母代碼(ISO 4217 格式)。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理員 graphql api id。 |
交易
退款涉及的交易清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
transaction |
tax_line
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價格
|
price | string |
以商店貨幣收取的稅額。 |
|
價格
|
rate | float |
要應用的稅率。 |
|
title
|
title | string |
稅金名稱。 |
|
price_set
|
price_set | subtotal_tax_discount_price_set |
tax_lines
稅金明細物件的清單,每個物件都會詳細說明套用至品項的稅金。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
tax_line |
退款
退款
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
refund |
退款
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
退款的唯一識別碼。 |
|
order_id
|
order_id | integer |
訂單的 ID,用於 API 目的。 |
|
建立於
|
created_at | string |
建立退款的日期和時間 (ISO 8601 格式)。 |
|
注意
|
note | string |
退款所附的可選附註。 |
|
user_id
|
user_id | integer |
執行退款之使用者的唯一識別碼。 |
|
processed_at
|
processed_at | string |
匯入退款的日期和時間 (ISO 8601 格式)。 |
|
重新進貨
|
restock | boolean |
是否將明細項目新增回商店的庫存。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理員 graphql api id。 |
|
交易
|
transactions | transactions |
退款涉及的交易清單。 |
|
order_adjustments
|
order_adjustments | array of |
附在退款的訂單調整清單。 |
line_item
明細項目物件的清單,每個物件都包含訂單中項目的相關資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | integer |
委刊項的 ID。 |
|
variant_id
|
variant_id | integer |
產品子類的ID。 |
|
title
|
title | string |
產品的標題。 |
|
數量
|
quantity | integer |
已購買的項目數目。 |
|
sku
|
sku | string |
商品的SKU(庫存單位)。 |
|
variant_title
|
variant_title | string |
產品變體的標題。 |
|
供應商
|
vendor | string |
項目供應商的名稱。 |
|
fulfillment_service
|
fulfillment_service | string |
履行項目的服務提供者。 |
|
product_id
|
product_id | integer |
委刊項所屬產品的 ID。 |
|
requires_shipping
|
requires_shipping | boolean |
商品是否需要運送。 |
|
應課稅
|
taxable | boolean |
該物品是否應納稅。 |
|
gift_card
|
gift_card | boolean |
明細項目是否為禮品卡。 |
|
名稱
|
name | string |
產品變體的名稱。 |
|
variant_inventory_management
|
variant_inventory_management | string |
庫存管理服務的名稱。 |
|
properties
|
properties | line_item_properties |
屬性。 |
|
product_exists
|
product_exists | boolean |
產品是否存在。 |
|
fulfillable_quantity
|
fulfillable_quantity | integer |
可履行的金額。 |
|
克
|
grams | integer |
物品的重量(以克為單位)。 |
|
價格
|
price | string |
以商店貨幣套用折扣前的商品價格。 |
|
total_discount
|
total_discount | string |
以商店貨幣分配給明細項目的折扣總額。 |
|
fulfillment_status
|
fulfillment_status | string |
訂單的狀態(根據正在履行的明細項目)。 |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
total_discount_set
|
total_discount_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
折扣應用程式分配的金額的排序清單。 |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
管理員 graphql api id。 |
|
tax_lines
|
tax_lines | tax_lines |
稅金明細物件的清單,每個物件都會詳細說明套用至品項的稅金。 |
line_items
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
line_item |
明細項目物件的清單,每個物件都包含訂單中項目的相關資訊。 |
shipping_lines
使用哪種運輸方式的詳細信息。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
shipping_line |
payment_gateway_names
用於訂單的付款閘道清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
string |
note_attribute
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
附註屬性名稱。 |
|
value
|
value | string |
注意屬性值。 |
note_attributes
新增至訂單的額外資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
note_attribute |
discount_code
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
字碼
|
code | string |
當相關聯的折扣應用程式類型為 code 時,此屬性會傳回結帳時輸入的折扣代碼。 |
|
金額
|
amount | string |
從訂單總額中扣除的金額。 當您建立訂單時,此值是要扣除的百分比或金額。 |
|
型別
|
type | string |
折扣類型。 |
discount_codes
套用至訂單的折扣清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
discount_code |
discount_application
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
型別
|
type | string |
折扣申請類型。 |
|
value
|
value | string |
折扣應用程式的值(以小數表示)。 這代表了折扣申請的意圖。 |
|
value_type
|
value_type | string |
值的類型。 |
|
allocation_method
|
allocation_method | string |
折扣申請值已分配給授權明細的方法。 |
|
target_selection
|
target_selection | string |
訂單上分配折扣的類型為 target_type 的明細。 |
|
target_type
|
target_type | string |
訂單上適用折扣的明細類型。 |
|
字碼
|
code | string |
用於套用折扣的折扣代碼。 僅適用於折扣代碼申請。 |
discount_applications
折扣應用程式的說明,由商家或 Shopify 指令碼定義。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
物品
|
discount_application |
收條
提供收據相關資訊的文字欄位。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
測試用例
|
testcase | boolean |
履行是否是一個測試案例。 |
|
授權
|
authorization | string |
授權碼。 |