共用方式為


Etsy(獨立出版商)

此連接器會使用您的 API 金鑰來存取各種 Etsy.com 功能。 它支援庫存、銷售訂單和商店管理的動作。 所有操作都基於 Etsy Open API v3,其中確實有仍處於測試階段的端點。 如果此類動作使用 Beta API,則標題中包含 Beta 的動作將傳回 501 回應代碼。

此連接器適用於以下產品和區域:

服務 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)
連絡人​​
名稱 特洛伊·泰勒
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
連接器中繼資料
Publisher Troy Taylor,日立解決方案
網站 https://www.etsy.com/
隱私策略 https://www.etsy.com/legal/privacy/
類別 Commerce

正在建立連線

連接器支援下列驗證類型:

預設值 建立連線的參數。 所有區域 不可共享

預設

適用:所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
API 金鑰 securestring 此 API 的 API 金鑰

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

Ping

檢查以確認應用程式與 Etsy API 的連線。

上傳房源圖片

將圖片上傳或指派給具有清單 ID 的商店 ID 所識別的清單。 若要上傳新影像,請將影像檔案設定為影像參數的值。 您可以使用清單影像ID引數中已刪除影像的影像ID,將先前刪除的影像指派給清單。 當請求同時包含影像和清單影像 ID 參數值時,端點只會上傳影像參數中的影像。

上傳房源檔案

上傳數位清單的新檔案,或將現有檔案與特定清單建立關聯。 您必須提供現有檔案的清單檔案 ID,或要上傳的檔案名稱和二進位檔案資料。 將現有檔案與實體清單建立關聯,會將實體清單轉換為數位清單,從而消除所有運送成本以及任何產品和庫存變化。

依分類識別碼取得產品屬性

擷取特定賣方分類 ID 支援的產品屬性清單,其中包含適用的比例和值。

依商店區段 ID 取得清單

從特定商店的區段擷取所有清單。

依商店取得清單

傳回屬於商店的清單。 可以使用 state 參數過濾清單。

依運送設定檔取得設定檔目的地

擷取與出貨設定檔相關聯的出貨目的地物件清單。

刪除房源

這個動作會刪除商店資訊。 只有在狀態為下列其中一種狀態時,才能刪除清單:SOLD_OUT、DRAFT、EXPIRED、INACTIVE、ACTIVE 和 is_available 或 ACTIVE 且具有賣家旗標:SUPRESSED (凍結)、VACATION、CUSTOM_SHOPS (模式) SELL_ON_FACEBOOK

刪除房源圖片

刪除清單影像。 檔案的副本仍保留在我們的伺服器上,因此已刪除的圖片可能會重新與房源相關聯,而無需重新上傳原始圖片。

刪除房源資源

從清單中刪除屬性。

刪除運送設定檔

依指定 ID 刪除託運設定檔。

刪除運送設定檔升級

刪除運送設定檔升級,並從使用相關運送設定檔的每個清單中移除升級選項。

刪除運送設定檔目的地

刪除運送目的地,並從使用相關運送設定檔的每個清單中移除目的地選項。 運送設定檔至少需要一個運送目的地,因此此端點無法刪除任何運送設定檔的最終運送目的地。 若要從運送設定檔中刪除最終運送目的地,您必須刪除整個運送設定檔。

取得交易

依交易識別碼擷取交易。

取得付款清單

從商店 ID 識別的商店擷取付款清單。 您也可以使用付款 ID 清單來篩選結果。

取得使用者

傳回使用者 ID 所識別之使用者的使用者設定檔。

取得使用者位址

擷取使用者位址清單。

取得使用者的位址

擷取使用者的位址。 此端點的開發正在進行中。 它只會傳回 501 回應。

取得商店付款帳戶分類帳的分錄

擷取商店付款帳戶分類帳的條目。

取得商店區塊

擷取由商店 ID 識別的特定商店中的商店區段清單。

取得商店的交易

擷取與商店相關聯的交易清單。

取得商店部分

擷取由區段 ID 和商店 ID 所參考的商店區段。

取得房源圖片

擷取具有特定影像ID之清單影像的參考和中繼資料。

取得房源圖片

擷取具有特定清單 ID 之清單的所有清單影像資源。

取得房源的屬性

傳回清單屬性的清單。

取得房源的庫存

擷取清單的庫存記錄。 您未使用 Etsy.com 庫存工具編輯的清單沒有庫存記錄。 如果您是所擷取庫存記錄的擁有者,此端點會傳回SKU資料。

取得房源的產品

獲取列表報價。

取得房源的變化圖片

取得清單上的所有變化影像。

取得房源的資產 (Beta 版)

擷取清單的屬性。 此端點的開發正在進行中。 它只會傳回 501 回應。

取得房源翻譯

傳回指定語言清單的翻譯。

取得所有房源檔案

擷取與指定數位清單相關聯的所有檔案。 從實體清單要求檔案會傳回空白結果。

取得收據

從 Etsy 商店擷取收據 (由收據 ID 識別)。

取得收據

要求來自特定商店的商店收據,未篩選或依收據 ID 範圍或偏移、日期、付款和/或已出貨的購買進行篩選。

取得收據的交易

擷取與特定收據相關聯的交易清單。

取得有效清單

Etsy 上所有有效清單的清單,按其建立日期分頁。 如果沒有排序順序,預設會傳回最新的清單。

取得清單

透過清單 ID 擷取清單記錄。

取得清單的產品

依 ID 擷取清單產品。

取得貨運業者

擷取指定國家/地區的可用託運商清單,以及與其相關聯的郵件類別。

取得賣方分類節點

擷取賣方分類節點的完整階層樹狀結構。

取得運送設定檔

擷取特定 Etsy 商店中可用的運送設定檔清單,該清單由其商店 ID 識別。

取得運送設定檔升級

擷取指派給特定運送設定檔的運送設定檔升級清單。

取得運送資料

擷取運送設定檔 ID 所參考的運送設定檔。

建立商店區段

在特定商店中建立新區段。

建立房源翻譯

透過清單ID和語言建立清單翻譯。

建立草稿清單

在 Etsy 頻道的商店中建立實體草稿商品。

建立貨件收據

提交商店收據的追蹤資訊,這會為指定的收據 ID 建立商店收據出貨項目。 每次您成功提交追蹤資訊時,Etsy 都會向買家用戶發送一封通知電子郵件。 當發送密件副本為真時,Etsy 也會向賣家發送發貨通知。 如果未傳送追蹤代碼和承運商名稱,收據會標示為僅出貨。

建立運送設定檔

建立新的託運設定檔。 您可以在建立運送設定檔時傳遞國家/地區 ISO 代碼或地區,但不能同時傳遞兩者。 只需要一個。 您必須傳遞貨運業者 ID 和郵件類別,或同時傳遞最短和最長遞送天數。

建立運送設定檔升級

建立新的運送設定檔升級,可建立運送選項的價格,例如替代貨運業者或更快的配送速度。

建立運送設定檔目的地

建立新的運送目的地,以設定運送設定檔中目的地的運送成本、承運商和類別。 這會使用關聯商店的貨幣來分配成本。 使用目的地國家/地區 ISO 或目的地區域設定目的地;目的地國家/地區 ISO 和目的地區域是互斥的 — 設定其中一個。 設定兩者會觸發錯誤 400。 如果要求既未設定目的地國家/地區 ISO 也未設定目的地區域,則預設目的地無處不在。 您也必須同時指派貨運業者 ID 和郵件類別,或同時指派最小遞送天數和最長遞送天數。

從付款帳戶分類帳項目識別碼取得付款

從付款帳戶分類帳項目 ID 取得付款 (如果適用)。

從清單中刪除檔案

當您刪除數位清單的最終檔案時,該清單會轉換為實體清單。 刪除要求的回應會傳回與指定清單相關聯的剩餘檔案記錄清單。

從清單取得檔案

擷取與指定數位清單相關聯的單一檔案。 從實體清單要求檔案會傳回空白結果。

從特定收據取得付款

從特定收據 (由收據 ID 識別) 擷取付款,從特定商店 (由商店 ID 識別) 擷取付款。

按 ID 獲取列表

允許一次查詢多個清單 ID。 每個查詢最多限制 100 個 ID。

按商店獲取有效列表

擷取 Etsy 上特定商店中所有有效清單的清單,並依清單建立日期分頁。

按商店獲取精選列表

擷取與精選商店相關聯的清單。

按所有者 ID 獲取商店

擷取由店主的使用者 ID 識別的商店。

搜尋商店

傳回具有相符名稱的商店清單。

擷取清單的交易

擷取與清單相關聯的交易清單。

更新商品的庫存

更新清單 ID 所識別清單的庫存。 如果提供的產品SKU、供應項目數量和/或價格值與屬性欄位中的值不相容,則更新會失敗。 設定價格時,請指派一個浮點數,等於金額除以除數,如貨幣資源中所指定。

更新商店

更新商店。 假設所有字串參數均以商店的主要語言提供。

更新房源

針對由商店 ID 識別的特定商店更新由清單 ID 識別的清單。

更新房源的變化影像

在清單上建立變化影像。

更新房源翻譯

透過列出 ID 和語言來更新清單翻譯。

更新房源資源

更新或填入定義清單產品供應項目的屬性清單。 每一個供應項目都需要一個值和一個值 ID,這些值和值 ID 對於指派給清單的規模 ID 有效,或您使用此要求指派給清單的 ID。

更新運送設定檔

變更運送設定檔中的設定。

更新運送設定檔升級

更新運送設定檔升級,並更新使用運送設定檔的任何清單。

更新運送設定檔目的地

更新現有的運送目的地,可設定或重新指派目的地的運送成本、承運商和類別。

獲取評論

從給定其 ID 的商店擷取評論。

透過商店收據取得清單

取得與收據相關聯的所有清單。

Ping

檢查以確認應用程式與 Etsy API 的連線。

傳回

確認目前應用程式可以存取 Open API

乒乓球
Pong

上傳房源圖片

將圖片上傳或指派給具有清單 ID 的商店 ID 所識別的清單。 若要上傳新影像,請將影像檔案設定為影像參數的值。 您可以使用清單影像ID引數中已刪除影像的影像ID,將先前刪除的影像指派給清單。 當請求同時包含影像和清單影像 ID 參數值時,端點只會上傳影像參數中的影像。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

影像
image string

要上傳之檔案的檔案名稱字串。

清單影像 ID
listing_image_id integer

此交易的主要清單影像的數字 ID。

等級
rank integer

清單中顯示的影像中的正非零數值位置,排名 1 的影像顯示在清單的最左邊位置。

改寫
overwrite boolean

當 true 時,此請求會取代指定排名的現有影像。

有水印
is_watermarked boolean

如果為true,則表示上傳的影像具有浮水印。

傳回

參考與特定清單相關聯之影像的網址和中繼資料。 此 url_fullxfull 參數包含完整大小二進位影像檔案的 URL。

上市圖片
ListingImage

上傳房源檔案

上傳數位清單的新檔案,或將現有檔案與特定清單建立關聯。 您必須提供現有檔案的清單檔案 ID,或要上傳的檔案名稱和二進位檔案資料。 將現有檔案與實體清單建立關聯,會將實體清單轉換為數位清單,從而消除所有運送成本以及任何產品和庫存變化。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

列出檔案 ID
listing_file_id integer

與數位清單相關聯之檔案的唯一數字 ID。

檔案
file True string

要上傳的二進位檔案。

名稱
name string

要上傳之檔案的檔案名稱字串

等級
rank integer

清單中顯示的影像中的正非零數值位置,排名 1 的影像顯示在清單的最左邊位置。

傳回

與數位清單相關聯的檔案。

商店清單檔案
ShopListingFile

依分類識別碼取得產品屬性

擷取特定賣方分類 ID 支援的產品屬性清單,其中包含適用的比例和值。

參數

名稱 機碼 必要 類型 Description
分類識別碼
taxonomy_id True string

Etsy 分類節點的唯一數字 ID,這是組織到賣家分類層次結構樹狀結構中的列表的元數據類別。

傳回

產品屬性定義的清單。

分類節點屬性
TaxonomyNodeProperties

依商店區段 ID 取得清單

從特定商店的區段擷取所有清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

商店區塊 ID
shop_section_ids True string

特定 Etsy 商店中所有部分的數字 ID 陣列。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

排序
sort_on string

要排序清單搜尋結果的值。

排序順序
sort_order string

排序清單的遞增(向上)或遞減(向下)順序。

傳回

一組商店清單資源。

商店列表
ShopListings

依商店取得清單

傳回屬於商店的清單。 可以使用 state 參數過濾清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

State
State string

來自下列任一的列舉字串:作用中或非作用中。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

排序
Sort On string

要排序清單搜尋結果的值。

排序順序
Sort Order string

排序清單的遞增(向上)或遞減(向下)順序。

傳回

一組商店清單資源。

商店列表
ShopListings

依運送設定檔取得設定檔目的地

擷取與出貨設定檔相關聯的出貨目的地物件清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

代表出貨目的地物件的清單。

ShopShippingProfile目的地
ShopShippingProfileDestinations

刪除房源

這個動作會刪除商店資訊。 只有在狀態為下列其中一種狀態時,才能刪除清單:SOLD_OUT、DRAFT、EXPIRED、INACTIVE、ACTIVE 和 is_available 或 ACTIVE 且具有賣家旗標:SUPRESSED (凍結)、VACATION、CUSTOM_SHOPS (模式) SELL_ON_FACEBOOK

參數

名稱 機碼 必要 類型 Description
房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

刪除房源圖片

刪除清單影像。 檔案的副本仍保留在我們的伺服器上,因此已刪除的圖片可能會重新與房源相關聯,而無需重新上傳原始圖片。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

清單影像 ID
listing_image_id True integer

此交易的主要清單影像的數字 ID。

刪除房源資源

從清單中刪除屬性。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

屬性 ID
property_id True integer

Etsy 清單屬性的唯一 ID。

刪除運送設定檔

依指定 ID 刪除託運設定檔。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

傳回

代表用來設定清單出貨資訊的設定檔。 請注意,您無法透過 API 建立計算運費範本。 不過,您可以使用 API 將從 Shop Manager 建立的計算運送設定檔與清單建立關聯。

商店運送簡介
ShopShippingProfile

刪除運送設定檔升級

刪除運送設定檔升級,並從使用相關運送設定檔的每個清單中移除升級選項。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

運送設定檔的數字 ID。

升級標識碼
upgrade_id True integer

與運送升級相關聯的數字 ID

刪除運送設定檔目的地

刪除運送目的地,並從使用相關運送設定檔的每個清單中移除目的地選項。 運送設定檔至少需要一個運送目的地,因此此端點無法刪除任何運送設定檔的最終運送目的地。 若要從運送設定檔中刪除最終運送目的地,您必須刪除整個運送設定檔。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

運送設定檔目的地ID
shipping_profile_destination_id True integer

與清單相關聯的運送設定檔中運送設定檔目的地的數值ID。

取得交易

依交易識別碼擷取交易。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

交易 ID
transaction_id True integer

交易的唯一數字 ID。

傳回

與商店收據相關聯的交易物件。 Etsy 會為訂單收據上記錄的每筆購買清單產生一筆交易。

商店收據交易
ShopReceiptTransaction

取得付款清單

從商店 ID 識別的商店擷取付款清單。 您也可以使用付款 ID 清單來篩選結果。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

付款標識碼
payment-ids True string

以逗號分隔的付款 ID 號碼陣列。

傳回

代表使用 Etsy Payments 進行的幾筆付款。 除非另有說明,否則所有金額均以美元便士為單位。

付款
Payments

取得使用者

傳回使用者 ID 所識別之使用者的使用者設定檔。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
user_id True integer

使用者的唯一正非零數字 ID。

傳回

代表網站的單一使用者

User
User

取得使用者位址

擷取使用者位址清單。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

代表數個 UserAddress 記錄。

使用者位址
UserAddresses

取得使用者的位址

擷取使用者的位址。 此端點的開發正在進行中。 它只會傳回 501 回應。

參數

名稱 機碼 必要 類型 Description
使用者位址 ID
user_address_id True integer

使用者位址的數字 ID。

傳回

代表使用者的位址。

使用者位址
UserAddress

取得商店付款帳戶分類帳的分錄

擷取商店付款帳戶分類帳的條目。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

建立的最小值
min_created True integer

建立記錄時最早的 Unix 時間戳記。

建立次數上限
max_created True integer

建立記錄時的最新 Unix 時間戳記。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

一組付款帳戶分類帳項目資源

PaymentAccountLedger項目
PaymentAccountLedgerEntries

取得商店區塊

擷取由商店 ID 識別的特定商店中的商店區段清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

傳回

所有部分都位於一個特殊的商店中。

商店區段
ShopSections

取得商店的交易

擷取與商店相關聯的交易清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

一組店單交易資源

商店收據交易
ShopReceiptTransactions

取得商店部分

擷取由區段 ID 和商店 ID 所參考的商店區段。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

商店區塊 ID
shop_section_id True integer

特定 Etsy 商店中某個部分的數字 ID。

傳回

商店內的一個部分,用戶可以將列表排序到其中。

商店區
ShopSection

取得房源圖片

擷取具有特定影像ID之清單影像的參考和中繼資料。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

清單影像 ID
listing_image_id True integer

此交易的主要清單影像的數字 ID。

傳回

參考與特定清單相關聯之影像的網址和中繼資料。 此 url_fullxfull 參數包含完整大小二進位影像檔案的 URL。

上市圖片
ListingImage

取得房源圖片

擷取具有特定清單 ID 之清單的所有清單影像資源。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

傳回

代表清單影像資源的清單,每個資源都包含影像的參考URL和中繼資料。

清單圖片
ListingImages

取得房源的屬性

傳回清單屬性的清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

傳回

代表數個清單屬性值。

清單屬性值
ListingPropertyValues

取得房源的庫存

擷取清單的庫存記錄。 您未使用 Etsy.com 庫存工具編輯的清單沒有庫存記錄。 如果您是所擷取庫存記錄的擁有者,此端點會傳回SKU資料。

參數

名稱 機碼 必要 類型 Description
房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

Includes
includes string

附加有效關聯的列舉字串。

傳回

單一清單的庫存記錄與關聯的表示法

ListingInventoryWithAssociations
ListingInventoryWithAssociations

取得房源的產品

獲取列表報價。

參數

名稱 機碼 必要 類型 Description
房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

產品識別碼
product_id True integer

與此交易相關聯之產品的數字 ID。

產品供應項目 ID
product_offering_id True integer

與此交易相關聯之產品供應項目的數字 ID。

傳回

上市產品的表示。

ListingInventory產品供應
ListingInventoryProductOffering

取得房源的變化圖片

取得清單上的所有變化影像。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

傳回

代表數個清單變數影像。

列表變化圖像
ListingVariationImages

取得房源的資產 (Beta 版)

擷取清單的屬性。 此端點的開發正在進行中。 它只會傳回 501 回應。

參數

名稱 機碼 必要 類型 Description
房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

屬性 ID
property_id True integer

Etsy 清單屬性的唯一 ID。

傳回

結構化資料值的表示法。

清單屬性值
ListingPropertyValue

取得房源翻譯

傳回指定語言清單的翻譯。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

語言
language True string

此翻譯語言的 IETF 語言標籤。 例如:de、en、es、fr、it、ja、nl、pl、pt、ru。

傳回

代表清單的翻譯資料。

上市翻譯
ListingTranslation

取得所有房源檔案

擷取與指定數位清單相關聯的所有檔案。 從實體清單要求檔案會傳回空白結果。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

與此交易相關聯之清單的數值 ID。

房源編號
listing_id True integer

Etsy 商店的唯一正非零數字 ID。

傳回

代表數個 ShopListingFiles。

商店列表文件
ShopListingFiles

取得收據

從 Etsy 商店擷取收據 (由收據 ID 識別)。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

收據 ID
receipt_id True integer

與此交易相關聯之收據的數字 ID。

傳回

從商店購買的記錄。 商店收據使用商店貨幣顯示貨幣價值。

商店收據
ShopReceipt

取得收據

要求來自特定商店的商店收據,未篩選或依收據 ID 範圍或偏移、日期、付款和/或已出貨的購買進行篩選。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

建立的最小值
min_created integer

建立記錄時最早的 Unix 時間戳記。

建立次數上限
max_created integer

建立記錄時的最新 Unix 時間戳記。

最早的最後修改時間
min_last_modified integer

記錄上次變更時間的最早 unix 時間戳記。

最新 最後修改
max_last_modified integer

記錄上次變更時的最新 Unix 時間戳記。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

已支付
was_paid boolean

如果為true,則賣家收到了此收據中產品的付款。

已發貨
was_shipped boolean

如果為true,則賣家在此收據中運送了產品。

傳回

特定商店的收據。

商店收據
ShopReceipts

取得收據的交易

擷取與特定收據相關聯的交易清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

收據 ID
receipt_id True integer

與此交易相關聯之收據的數字 ID。

傳回

一組店單交易資源

商店收據交易
ShopReceiptTransactions

取得有效清單

Etsy 上所有有效清單的清單,按其建立日期分頁。 如果沒有排序順序,預設會傳回最新的清單。

參數

名稱 機碼 必要 類型 Description
限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

Includes
keywords string

必須出現在所有結果中的搜尋字詞或片語。

排序
sort_on string

要排序清單搜尋結果的值。 注意:排序僅在與其中一個搜尋選項(關鍵字、區域等)結合使用時才有效。

排序順序
sort_order string

排序清單的遞增(向上)或遞減(向下)順序。 注意:sort_order僅在與其中一個搜尋選項(關鍵字、區域等)結合使用時才有效。

最低價格
min_price float

搜尋結果要傳回的清單最低價格。

最高價格
max_price float

搜尋結果要傳回的清單最高價格。

分類識別碼
taxonomy_id integer

清單的數值分類識別碼。 賣家管理其商店的列出分類 ID。

店鋪位置
shop_location string

按商店位置過濾。 如果無法解析位置,Etsy 會以錯誤回應。

傳回

一組商店清單資源。

商店列表
ShopListings

取得清單

透過清單 ID 擷取清單記錄。

參數

名稱 機碼 必要 類型 Description
房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

Includes
includes string

附加有效關聯的列舉字串。 可接受的輸入是 'shop'、'images' 和 'user'。

取得清單的產品

依 ID 擷取清單產品。

參數

名稱 機碼 必要 類型 Description
房源編號
listing_id True integer

要傳回清單產品的清單。

產品識別碼
product_id True integer

從清單購買之特定產品的數字ID。

傳回

清單產品的表示法。

ListingInventory產品
ListingInventoryProduct

取得貨運業者

擷取指定國家/地區的可用託運商清單,以及與其相關聯的郵件類別。

參數

名稱 機碼 必要 類型 Description
原產地國家/地區 ISO
origin_country_iso True string

清單發貨國家/地區的 ISO 代碼。

傳回

代表數個 ShippingCarriers。

運輸承運商
ShippingCarriers

取得賣方分類節點

擷取賣方分類節點的完整階層樹狀結構。

傳回

賣方分類樹中的分類節點清單。

賣方分類節點
SellerTaxonomyNodes

取得運送設定檔

擷取特定 Etsy 商店中可用的運送設定檔清單,該清單由其商店 ID 識別。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

傳回

代表用來設定清單出貨資訊的設定檔。 請注意,您無法透過 API 建立計算運費範本。 不過,您可以使用 API 將從 Shop Manager 建立的計算運送設定檔與清單建立關聯。

商店運送簡介
ShopShippingProfile

取得運送設定檔升級

擷取指派給特定運送設定檔的運送設定檔升級清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

傳回

運送升級選項清單。

ShopShippingProfile升級
ShopShippingProfileUpgrades

取得運送資料

擷取運送設定檔 ID 所參考的運送設定檔。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

建立商店區段

在特定商店中建立新區段。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

Title
title True string

商店區段的標題字串。

傳回

商店內的一個部分,用戶可以將列表排序到其中。

商店區
ShopSection

建立房源翻譯

透過清單ID和語言建立清單翻譯。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

語言
language True string

此翻譯語言的 IETF 語言標籤。 例如:de、en、es、fr、it、ja、nl、pl、pt、ru。

Title
title True string

本譯本清單的標題。

Description
description True string

本譯本清單的描述。

Tags
tags string

此翻譯列表的標籤。

傳回

代表清單的翻譯資料。

上市翻譯
ListingTranslation

建立草稿清單

在 Etsy 頻道的商店中建立實體草稿商品。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

數量
quantity True integer

清單中可供購買的正數非零數。

Title
title True string

清單的標題字串。 有效的標題字串僅包含字母、數字、標點符號、數學符號、空格字元、 ™ 、 © 和 ® 。 (正則表達式:/[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u)您只能使用 %、:、& 和 + 字元一次。

Description
description True string

清單中要出售的產品說明字串。

價格
price True float

產品的正非零價格。 (已售產品清單為私人)注意:價格是最低可能的價格。

誰製作的
who_made True string

一個字符串表明是誰製造了該產品。 幫助買家在“手工製作”標題下找到列表。 需要「is_supply」和「when_made」。

製作時
when_made string

製造商在此列表中製造產品的時代的字符串。 幫助買家在“復古”標題下找到列表。 需要「is_supply」和「who_made」。

分類識別碼
taxonomy_id True integer

清單的數值分類識別碼。 賣家管理其商店的列出分類 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

Materials
materials string

產品中使用的材料的材料字符串陣列。 有效的材料字串僅包含字母、數字和空格字元。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}]/u)

商店區塊 ID
shop_section_id integer

此清單的商店區段的數字 ID。

處理最小值
processing_min integer

處理此清單所需的最短天數。

處理最大值
processing_max integer

處理此清單所需的天數上限。

Tags
tags string

清單的標籤字串陣列。 有效的標籤字串僅包含字母、數字、空格字元、 -、 '、 ™ © 和 ® 。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

Recipient
recipient string

一串,表示本產品將作為適當禮物的人。

場合
occasion string

一串表示該產品適合作為適當禮物的場合。

樣式
styles string

此清單的樣式字串陣列,每個字串都是自由格式的文字字串,例如 正式或蒸氣龐克。 清單最多可以有兩種樣式。 有效的樣式字串僅包含字母、數字和空格字元。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}]/u)

物品重量
item_weight float

以商品重量單位設定的單位測量的產品數字重量。

項目長度
item_length integer

以項目維度單位中設定的單位測量的產品數值長度。

項目寬度
item_width float

以「商品尺寸單位」中設定的單位衡量的產品的數字寬度。

項目高度
item_height float

以「商品尺寸單位」中設定的單位為單位測量的產品的數字高度。

項目重量單位
item_weight_unit string

定義用來測量產品重量的單位的字串。

項目維度單位
item_dimensions_unit string

定義用來測量產品尺寸的單位的字串。

是可個性化的
is_personalizable boolean

如果為true,則此清單是可個人化的。

影像 ID
image_ids string

清單中影像的數值影像識別碼陣列,最多可包含 10 個影像。

是供應
is_supply boolean

如果為true,則將清單標記為供應產品,否則則表示它是成品。 協助買家在「耗材」標題下找到清單。 需要「誰製作」和「何時製作」。

可定制
is_customizable boolean

如果屬實,買家可以聯繫賣家進行定制訂單。 當商店接受自訂訂單時,預設值為 true。 不適用於不接受客製化訂單的商店。

應納稅
is_taxable boolean

如果為 true,則適用的商店稅率會在結帳時適用於此清單。

傳回

商店的清單,其中包含產品數量、標題、描述、價格等。

商店列表
ShopListing

建立貨件收據

提交商店收據的追蹤資訊,這會為指定的收據 ID 建立商店收據出貨項目。 每次您成功提交追蹤資訊時,Etsy 都會向買家用戶發送一封通知電子郵件。 當發送密件副本為真時,Etsy 也會向賣家發送發貨通知。 如果未傳送追蹤代碼和承運商名稱,收據會標示為僅出貨。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

收據 ID
receipt_id True integer

要提交追蹤的收據。

追蹤代碼
tracking_code string

此收據的追蹤代碼。

承運商名稱
carrier_name string

此收據的承運人名稱。

發送密件副本
send_bcc boolean

如果屬實,出貨通知也會傳送給賣家

傳回

從商店購買的記錄。 商店收據使用商店貨幣顯示貨幣價值。

商店收據
ShopReceipt

建立運送設定檔

建立新的託運設定檔。 您可以在建立運送設定檔時傳遞國家/地區 ISO 代碼或地區,但不能同時傳遞兩者。 只需要一個。 您必須傳遞貨運業者 ID 和郵件類別,或同時傳遞最短和最長遞送天數。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

Title
title True string

此運送設定檔的名稱字串。

原產地國家/地區 ISO
origin_country_iso True string

清單發貨國家/地區的 ISO 代碼。

主要成本
primary_cost True float

僅運送到該國家/地區的費用,以商店的預設貨幣衡量。

次要成本
secondary_cost True float

運送到此國家/地區與其他商品的成本,以商店的預設貨幣衡量。

最短處理時間
min_processing_time True integer

處理使用此運送設定檔的商品所需的最短時間。

最長處理時間
max_processing_time True integer

清單需要運送的最長時間。

處理時間單位
processing_time_unit string

用來表示處理時間長度的單位。 一週相當於 5 個工作天。

目的地國家/地區 ISO
destination_country_iso string

清單發貨到的國家/地區的 ISO 代碼。 如果為 Null,則要求會將目的地設定為目的地區域。

目的地區域
destination_region string

清單運送到的地區的代碼。 區域代表一組國家/地區。 支援的區域是歐盟和非歐盟 (不在歐盟的歐洲國家/地區)。 如果沒有,則要求會將目的地設定為目的地國家/地區 ISO,如果目的地國家/地區 ISO 也為 Null,則會設定為任何地方。

原產地郵遞區號
origin_postal_code string

商品出貨地點的郵遞區號字串 (不一定是數字)。

貨運業者 ID
shipping_carrier_id integer

支援貨運業者的唯一 ID,用於計算預計送達日期。

郵件類
mail_class string

託運承運商郵件類別的唯一 ID 字串,用於計算預估遞送日期。

最短交貨天數
min_delivery_days integer

買家在購買的商品出貨後可以等待收到的最短工作天數。

最長交貨天數
max_delivery_days integer

買家預計在購買的商品出貨後可以等待收到的最長工作天數。

傳回

代表用來設定清單出貨資訊的設定檔。 請注意,您無法透過 API 建立計算運費範本。 不過,您可以使用 API 將從 Shop Manager 建立的計算運送設定檔與清單建立關聯。

商店運送簡介
ShopShippingProfile

建立運送設定檔升級

建立新的運送設定檔升級,可建立運送選項的價格,例如替代貨運業者或更快的配送速度。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

類型
type True string

運送升級的類型。 國內 (0) 或國際 (1)。

升級名稱
upgrade_name True string

結帳時向購物者顯示的運送升級名稱,例如 USPS Priority。

價格
price True float

新增運送升級的額外費用。

二級價格
secondary_price True float

為每個額外項目添加運費升級的額外費用。

貨運業者 ID
shipping_carrier_id integer

支援貨運業者的唯一 ID,用於計算預估交貨日期。

郵件類
mail_class string

託運承運商郵件類別的唯一 ID 字串,用於計算預估遞送日期。

最短交貨天數
min_delivery_days integer

min_delivery_days

最長交貨天數
max_delivery_days integer

買家預計在購買的商品出貨後可以等待收到的最長工作天數。

傳回

運送設定檔升級選項的表示。

ShopShippingProfile升級
ShopShippingProfileUpgrade

建立運送設定檔目的地

建立新的運送目的地,以設定運送設定檔中目的地的運送成本、承運商和類別。 這會使用關聯商店的貨幣來分配成本。 使用目的地國家/地區 ISO 或目的地區域設定目的地;目的地國家/地區 ISO 和目的地區域是互斥的 — 設定其中一個。 設定兩者會觸發錯誤 400。 如果要求既未設定目的地國家/地區 ISO 也未設定目的地區域,則預設目的地無處不在。 您也必須同時指派貨運業者 ID 和郵件類別,或同時指派最小遞送天數和最長遞送天數。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

主要成本
primary_cost True float

僅運送到該國家/地區的費用,以商店的預設貨幣衡量。

次要成本
secondary_cost True string

運送到此國家/地區與其他商品的成本,以商店的預設貨幣衡量。

destination_country_iso
destination_country_iso string

destination_country_iso

destination_region
destination_region string

destination_region

shipping_carrier_id
shipping_carrier_id integer

shipping_carrier_id

mail_class
mail_class string

mail_class

min_delivery_days
min_delivery_days integer

min_delivery_days

max_delivery_days
max_delivery_days integer

max_delivery_days

傳回

代表指派給運送設定檔的運送目的地。

商店運送個人資料目的地
ShopShippingProfileDestination

從付款帳戶分類帳項目識別碼取得付款

從付款帳戶分類帳項目 ID 取得付款 (如果適用)。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

分類帳項目 ID
ledger_entry_ids True string

整數陣列。

傳回

代表使用 Etsy Payments 進行的幾筆付款。 除非另有說明,否則所有金額均以美元便士為單位。

付款
Payments

從清單中刪除檔案

當您刪除數位清單的最終檔案時,該清單會轉換為實體清單。 刪除要求的回應會傳回與指定清單相關聯的剩餘檔案記錄清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

列出檔案 ID
listing_file_id True integer

與數位清單相關聯之檔案的唯一數字 ID。

從清單取得檔案

擷取與指定數位清單相關聯的單一檔案。 從實體清單要求檔案會傳回空白結果。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

列出檔案 ID
listing_file_id True integer

與數位清單相關聯之檔案的唯一數字 ID。

傳回

與數位清單相關聯的檔案。

商店清單檔案
ShopListingFile

從特定收據取得付款

從特定收據 (由收據 ID 識別) 擷取付款,從特定商店 (由商店 ID 識別) 擷取付款。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

收據 ID
receipt_id True string

與此交易相關聯之收據的數字 ID。

傳回

代表使用 Etsy Payments 進行的幾筆付款。 除非另有說明,否則所有金額均以美元便士為單位。

付款
Payments

按 ID 獲取列表

允許一次查詢多個清單 ID。 每個查詢最多限制 100 個 ID。

參數

名稱 機碼 必要 類型 Description
清單 ID
listing_ids True string

特定 Etsy 商店中清單的數字 ID 陣列。

Includes
includes string

附加有效關聯的列舉字串。

傳回

一組具有關聯的商店清單資源。

商店列表與關聯
ShopListingsWithAssociations

按商店獲取有效列表

擷取 Etsy 上特定商店中所有有效清單的清單,並依清單建立日期分頁。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

Includes
keywords string

必須出現在所有結果中的搜尋字詞或片語。

傳回

一組商店清單資源。

商店列表
ShopListings

按商店獲取精選列表

擷取與精選商店相關聯的清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

一組商店清單資源。

商店列表
ShopListings

按所有者 ID 獲取商店

擷取由店主的使用者 ID 識別的商店。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
user_id True string

擁有此商店之使用者的數字使用者 ID。

傳回

由 Etsy 用戶創建的商店。

商店
Shop

搜尋商店

傳回具有相符名稱的商店清單。

參數

名稱 機碼 必要 類型 Description
店鋪名稱
shop_name True string

店名字串。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

一組商店記錄。

商店
Shops

擷取清單的交易

擷取與清單相關聯的交易清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

一組店單交易資源

商店收據交易
ShopReceiptTransactions

更新商品的庫存

更新清單 ID 所識別清單的庫存。 如果提供的產品SKU、供應項目數量和/或價格值與屬性欄位中的值不相容,則更新會失敗。 設定價格時,請指派一個浮點數,等於金額除以除數,如貨幣資源中所指定。

參數

名稱 機碼 必要 類型 Description
房源編號
listing_id True string

與此交易相關聯之清單的數值 ID。

Products
products True string

清單中可用的產品的 JSON 陣列,即使只有一個產品也一樣。 JSON Blob 中的所有欄位名稱都是小寫的。

房產價格
price_on_property string

變更產品價格的屬性的唯一清單屬性 ID 整數陣列 (如果有的話)。 舉例來說,如果您針對相同清單中不同尺寸的產品收取特定價格,則此陣列會包含大小的資源 ID。

物業數量
quantity_on_property string

唯一清單屬性 ID 整數陣列,適用於變更產品數量 (如果有的話) 的屬性。 例如,如果您在相同清單中儲存特定數量的不同顏色產品,則此陣列會包含顏色的屬性 ID。

房產上的 SKU
sku_on_property string

變更產品SKU的屬性(如果有)的唯一清單屬性ID整數陣列。 例如,如果您針對相同清單中的不同顏色產品使用特定 SKU,則此陣列會包含顏色的屬性 ID。

傳回

單一清單庫存記錄的表示法。

清單庫存
ListingInventory

更新商店

更新商店。 假設所有字串參數均以商店的主要語言提供。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

Title
title string

商店主頁的簡短標題字串。

公告
announcement string

顯示在商店首頁上的給買家的公告字串。

銷售訊息
sale_message string

傳送給從此商店完成購買的使用者的訊息字串。

數位銷售訊息
digital_sale_message string

傳送給從此商店購買數位商品的使用者的訊息字串。

傳回

由 Etsy 用戶創建的商店。

商店
Shop

更新房源

針對由商店 ID 識別的特定商店更新由清單 ID 識別的清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

數量
quantity integer

清單中可供購買的正數非零數。

Title
title string

清單的標題字串。 有效的標題字串僅包含字母、數字、標點符號、數學符號、空格字元、 ™ 、 © 和 ® 。 (正則表達式:/[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u)您只能使用 %、:、& 和 + 字元一次。

Description
description string

清單中要出售的產品說明字串。

價格
price float

產品的正非零價格。 (已售產品清單為私人)注意:價格是最低可能的價格。

誰製作的
who_made string

一個字符串表明是誰製造了該產品。 幫助買家在“手工製作”標題下找到列表。 需要「is_supply」和「when_made」。

製作時
when_made string

製造商在此列表中製造產品的時代的字符串。 幫助買家在“復古”標題下找到列表。 需要「is_supply」和「who_made」。

分類識別碼
taxonomy_id integer

清單的數值分類識別碼。 賣家管理其商店的列出分類 ID。

運送設定檔 ID
shipping_profile_id integer

與清單相關聯的運送設定檔的數字 ID。

Materials
materials string

產品中使用的材料的材料字符串陣列。 有效的材料字串僅包含字母、數字和空格字元。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}]/u)

商店區塊 ID
shop_section_id integer

此清單的商店區段的數字 ID。

處理最小值
processing_min integer

處理此清單所需的最短天數。

處理最大值
processing_max integer

處理此清單所需的天數上限。

Tags
tags string

清單的標籤字串陣列。 有效的標籤字串僅包含字母、數字、空格字元、 -、 '、 ™ © 和 ® 。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

Recipient
recipient string

一串,表示本產品將作為適當禮物的人。

場合
occasion string

一串表示該產品適合作為適當禮物的場合。

樣式
styles string

此清單的樣式字串陣列,每個字串都是自由格式的文字字串,例如 正式或蒸氣龐克。 清單最多可以有兩種樣式。 有效的樣式字串僅包含字母、數字和空格字元。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}]/u)

物品重量
item_weight float

以商品重量單位設定的單位測量的產品數字重量。

項目長度
item_length integer

以項目維度單位中設定的單位測量的產品數值長度。

項目寬度
item_width float

以「商品尺寸單位」中設定的單位衡量的產品的數字寬度。

項目高度
item_height float

以「商品尺寸單位」中設定的單位為單位測量的產品的數字高度。

項目重量單位
item_weight_unit string

定義用來測量產品重量的單位的字串。

項目維度單位
item_dimensions_unit string

定義用來測量產品尺寸的單位的字串。

是可個性化的
is_personalizable boolean

如果為true,則此清單是可個人化的。

影像 ID
image_ids string

清單中影像的數值影像識別碼陣列,最多可包含 10 個影像。

是供應
is_supply boolean

如果為true,則將清單標記為供應產品,否則則表示它是成品。 協助買家在「耗材」標題下找到清單。 需要「誰製作」和「何時製作」。

可定制
is_customizable boolean

如果屬實,買家可以聯繫賣家進行定制訂單。 當商店接受自訂訂單時,預設值為 true。 不適用於不接受客製化訂單的商店。

應納稅
is_taxable boolean

如果為 true,則適用的商店稅率會在結帳時適用於此清單。

特色排名
featured_ rank integer

商店精選清單中的正數非零數值位置,其中排名 1 的清單顯示在商店首頁精選清單的最左邊位置。

是否應該自動續訂
should_auto_renew boolean

如果屬實,則在到期後將清單續簽四個月。 如果先前設定為 false,則 etsy.com 會在清單到期前續訂,但續約期間會立即開始,而不是延長清單的到期日。 清單上剩餘的任何未使用時間都會遺失。 續約會導致使用者的帳單收取費用。

類型
type string

指出清單是實體下載還是數位下載。

渠道
channels string

列舉通道識別碼字串的陣列。 渠道是賣家接觸買家以進行銷售的場所。

傳回

商店的清單,其中包含產品數量、標題、描述、價格等。

商店列表
ShopListing

更新房源的變化影像

在清單上建立變化影像。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

變化圖像
variation_images True string

變數影像資料陣列。

傳回

代表數個清單變數影像。

列表變化圖像
ListingVariationImages

更新房源翻譯

透過列出 ID 和語言來更新清單翻譯。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

語言
language True string

此翻譯語言的 IETF 語言標籤。 例如:de、en、es、fr、it、ja、nl、pl、pt、ru。

Title
title True string

本譯本清單的標題。

Description
description True string

本譯本清單的描述。

Tags
tags string

此翻譯列表的標籤。

傳回

代表清單的翻譯資料。

上市翻譯
ListingTranslation

更新房源資源

更新或填入定義清單產品供應項目的屬性清單。 每一個供應項目都需要一個值和一個值 ID,這些值和值 ID 對於指派給清單的規模 ID 有效,或您使用此要求指派給清單的 ID。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

房源編號
listing_id True integer

與此交易相關聯之清單的數值 ID。

屬性 ID
property_id True integer

Etsy 清單屬性的唯一 ID。

值 ID
value_ids True integer

單一 Etsy.com 測量刻度的數字 ID。

價值觀
values True string

多個 Etsy 清單屬性值的值字串陣列。

比例標識符
scale_id integer

單一 Etsy.com 測量刻度的數字 ID。

傳回

結構化資料值的表示法。

清單屬性值
ListingPropertyValue

更新運送設定檔

變更運送設定檔中的設定。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

Title
title string

此運送設定檔的名稱字串。

原產地國家/地區 ISO
origin_country_iso string

清單發貨國家/地區的 ISO 代碼。

最短處理時間
min_processing_time integer

處理使用此運送設定檔的商品所需的最短時間。

最長處理時間
max_processing_time integer

清單需要運送的最長時間。

處理時間單位
processing_time_unit string

用來表示處理時間長度的單位。 一週相當於 5 個工作天。 如果未提供任何項目,則裝置會設定為business_days。

原產地郵遞區號
origin_postal_code string

商品出貨地點的郵遞區號字串 (不一定是數字)。

傳回

代表用來設定清單出貨資訊的設定檔。 請注意,您無法透過 API 建立計算運費範本。 不過,您可以使用 API 將從 Shop Manager 建立的計算運送設定檔與清單建立關聯。

商店運送簡介
ShopShippingProfile

更新運送設定檔升級

更新運送設定檔升級,並更新使用運送設定檔的任何清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True integer

與清單相關聯的運送設定檔的數字 ID。

升級標識碼
upgrade_id True integer

與運送升級相關聯的數字 ID

類型
type string

運送升級的類型。 國內 (0) 或國際 (1)。

升級名稱
upgrade_name string

結帳時向購物者顯示的運送升級名稱,例如 USPS Priority。

價格
price float

新增運送升級的額外費用。

二級價格
secondary_price float

為每個額外項目添加運費升級的額外費用。

貨運業者 ID
shipping_carrier_id integer

支援貨運業者的唯一 ID,用於計算預估交貨日期。

郵件類
mail_class string

託運承運商郵件類別的唯一 ID 字串,用於計算預估遞送日期。

最短交貨天數
min_delivery_days integer

min_delivery_days

最長交貨天數
max_delivery_days integer

買家預計在購買的商品出貨後可以等待收到的最長工作天數。

傳回

運送設定檔升級選項的表示。

ShopShippingProfile升級
ShopShippingProfileUpgrade

更新運送設定檔目的地

更新現有的運送目的地,可設定或重新指派目的地的運送成本、承運商和類別。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

運送設定檔 ID
shipping_profile_id True string

與清單相關聯的運送設定檔的數字 ID。

運送設定檔目的地ID
shipping_profile_destination_id True string

與清單相關聯的運送設定檔目的地的數字ID。

primary_cost
primary_cost string

primary_cost

secondary_cost
secondary_cost string

secondary_cost

destination_country_iso
destination_country_iso string

destination_country_iso

destination_region
destination_region string

destination_region

shipping_carrier_id
shipping_carrier_id integer

shipping_carrier_id

mail_class
mail_class string

mail_class

min_delivery_days
min_delivery_days integer

min_delivery_days

max_delivery_days
max_delivery_days integer

max_delivery_days

傳回

代表指派給運送設定檔的運送目的地。

商店運送個人資料目的地
ShopShippingProfileDestination

獲取評論

從給定其 ID 的商店擷取評論。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

Etsy 商店的唯一正非零數字 ID。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

使用者留下的一組交易審核記錄。

交易評論
TransactionReviews

透過商店收據取得清單

取得與收據相關聯的所有清單。

參數

名稱 機碼 必要 類型 Description
店鋪編號
shop_id True integer

與此交易相關聯之收據的數字 ID。

收據 ID
receipt_id True integer

Etsy 商店的唯一正非零數字 ID。

限制
limit integer

要傳回的結果數目上限。

Offset
offset integer

選取第一個結果之前要略過的記錄數。

傳回

一組商店清單資源。

商店列表
ShopListings

定義

商店列表

商店的清單,其中包含產品數量、標題、描述、價格等。

名稱 路徑 類型 Description
房源編號
listing_id integer

與此交易相關聯之清單的數值 ID。

使用者識別碼
user_id integer

張貼清單之使用者的數字ID。

店鋪編號
shop_id integer

Etsy 商店的唯一正非零數字 ID。

Title
title string

清單的標題字串。 有效的標題字串僅包含字母、數字、標點符號、數學符號、空格字元、 ™ 、 © 和 ® 。 (正則表達式:/[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u)您只能使用 %、:、& 和 + 字元一次。

Description
description string

清單中要出售的產品說明字串。

State
state State

來自下列任一的列舉字串:作用中或非作用中。 注意:將草稿房源設為有效也會在 etsy.com 上發布房源。

建立時間戳記
creation_timestamp integer

清單的建立時間 (以紀元秒為單位)。

結束時間戳記
ending_timestamp integer

清單的到期時間,以紀元秒為單位。

原始創作時間戳記
original_creation_timestamp integer

清單的建立時間 (以紀元秒為單位)。

上次修改時間戳記
last_modified_timestamp integer

上次更新清單的時間,以紀元秒為單位。

上次狀態變更時間戳記
state_timestamp integer

此清單最後一次狀態變更的日期和時間。

數量
quantity integer

清單中可供購買的正數非零數。 注意:清單數量是可用發行數量的總和。 您可以使用取得清單庫存端點,從ListingInventory資源要求個別供應項目的數量。

商店區塊 ID
shop_section_id integer

特定 Etsy 商店中某個部分的數字 ID。

特色排名
featured_rank integer

商店精選清單中的正數非零數值位置,排名 1 的清單顯示在商店首頁精選清單的最左邊位置。

URL
url string

Etsy 上列表頁面的完整 URL。

青睞者數量
num_favorers integer

將此清單標示為我的最愛的使用者數目。

免稅
non_taxable boolean

如果為 true,則結帳時適用的商店稅率不適用於此清單。

可定制
is_customizable boolean

如果屬實,買家可以聯繫賣家進行定制訂單。 當商店接受自訂訂單時,預設值為 true。 不適用於不接受客製化訂單的商店。

可peronalized嗎
is_personalizable boolean

如果為true,則此清單是可個人化的。 預設值為 null。

需要個人化
personalization_is_required boolean

如果為true,則此清單需要個人化。 預設值為 null。

最大個人化字元數
personalization_char_count_max integer

這是代表買方輸入的個人化訊息長度上限的整數值。

個人化說明
personalization_instructions string

如果為true,則此清單需要個人化。 預設值為 null。

上市類型
listing_type boolean

列舉類型字串,指出清單是實體下載還是數位下載。

Tags
tags array of string

清單的標籤字串清單。 有效的標籤字串僅包含字母、數字、空格字元、 -、 '、 ™ © 和 ® 。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}\-'™©®]/u)預設值為 Null。

Materials
materials array of string

產品所用材料的材料字串清單。 有效的材料字串僅包含字母、數字和空格字元。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}]/u)預設值為 Null。

運送設定檔 ID
shipping_profile_id integer

與清單相關聯的運送設定檔的數字 ID。

最短處理天數
processing_min integer

處理此清單所需的最短天數。 預設值為 null。

最長處理天數
processing_max integer

處理此清單所需的天數上限。 預設值為 null。

誰製造的
who_made WhoMade

列舉字串指出誰製造了該產品。 幫助買家在“手工製作”標題下找到列表。 需要「is_supply」和「when_made」。

何時製造
when_made WhenMade

製造商在此清單中製造產品的時代的列舉字串。 幫助買家在“復古”標題下找到列表。 需要「is_supply」和「who_made」。

供應產品
is_supply boolean

如果為true,則將清單標記為供應產品,否則則表示它是成品。 協助買家在「耗材」標題下找到清單。 需要「who_made」和「when_made」。

物品重量
item_weight double

以商品重量單位設定的單位測量的產品數字重量。 預設值為 null。 如果設定,則值必須大於 0。

項目權重單位
item_weight_unit ItemWeightUnit

定義用來測量產品重量的單位的字串。 預設值為 null。

項目長度
item_length double

以項目維度單位中設定的單位測量的產品數值長度。 預設值為 null。 如果設定,則值必須大於 0。

項目寬度
item_width double

以項目尺寸單位中設定的單位測量的產品的數字寬度。 預設值為 null。 如果設定,則值必須大於 0。

項目高度
item_height double

以項目維度單位中設定的單位測量的產品數值長度。 預設值為 null。 如果設定,則值必須大於 0。

項目維度單位
item_dimensions_unit ItemDimensionsUnit

定義用來測量產品尺寸的單位的字串。 預設值為 null。

是私人
is_private boolean

如果為 true,則這是針對特定買家的私人清單,並且不會在商店視圖中隱藏。

Recipient
recipient Recipient

列舉的字串,表示本產品將作為適當禮物的人。 預設值為 null。

場合
occasion Occasion

列舉的字串,表示該產品將作為適當禮物的場合。 預設值為 null。

Style
style array of string

此清單的樣式字串陣列,每個字串都是自由格式的文字字串,例如 正式或蒸氣龐克。 清單最多可以有兩種樣式。 有效的樣式字串僅包含字母、數字和空格字元。 (正則表達式:/[^\p{L}\p{Nd}\p{Zs}]/u)預設值為 Null。

檔案資料
file_data string

描述附加至數位清單的檔案的字串。

有變化
has_variations boolean

如果為true,則清單會有所不同。

是否應該自動續訂
should_auto_renew boolean

如果屬實,則在到期後將清單續簽四個月。 如果先前設定為 false,則 etsy.com 會在清單到期前續訂,但續約期間會立即開始,而不是延長清單的到期日。 清單上剩餘的任何未使用時間都會遺失。 續約會導致使用者的帳單收取費用。

語言
language string

清單預設語言的 IETF 語言標籤。 例如:deenptplnlfresitjaru

金錢
price Money

金額的表示。

分類識別碼
taxonomy_id integer

清單的數值分類識別碼。 賣家管理其商店的列出分類 ID。 如需詳細資訊,請參閱賣家分類法。

金錢

金額的表示。

名稱 路徑 類型 Description
總數
amount integer

此資料所代表的數量。

除數
divisor integer

轉譯金額的除數。

貨幣代碼
currency_code string

此資料的 ISO 貨幣代碼。

商店清單檔案

與數位清單相關聯的檔案。

名稱 路徑 類型 Description
列出檔案 ID
listing_file_id integer

與數位清單相關聯之檔案的唯一數字 ID。

房源編號
listing_id integer

與此交易相關聯之清單的數值 ID。

等級
rank integer

清單中此檔案的顯示順序位置的數值索引,從 1 開始。

檔名
filename string

與數位清單相關聯之檔案的檔案名稱字串。

檔案大小
filesize string

檔案大小的人類可讀格式大小字串。

大小(以位元組為單位)
size_bytes integer

表示檔案大小的數字,以位元組為單位。

檔案類型
filetype string

表示檔案 MIME 類型的類型字串。

建立時間戳記
create_timestamp integer

與數位清單相關聯之檔案的唯一數值時間戳記。

商店列表文件

代表數個 ShopListingFiles。

名稱 路徑 類型 Description
Count
count integer

傳回的 ShopListingFiles 數目。

Results
results array of ShopListingFile

ShopListingFile 資源的陣列。

商店列表

一組商店清單資源。

名稱 路徑 類型 Description
Count
count integer

找到的商店清單資源數量。

Results
results array of ShopListing

找到的商店清單資源。

User

代表網站的單一使用者

名稱 路徑 類型 Description
使用者識別碼
user_id integer

使用者的數字 ID。 此號碼也是使用者商店的有效商店 ID。

登入名稱
login_name string

使用者的登入名稱字串。

主要電子郵件
primary_email string

使用者主要電子郵件地址的電子郵件地址字串。

名字
first_name string

使用者的名字。

姓氏
last_name string

使用者的姓氏。

建立的時間戳記
create_timestamp integer

使用者建立帳戶的日期和時間,以紀元秒為單位。

由使用者 ID 轉介
referred_by_user_id integer

轉介此使用者之使用者的數字 ID。

使用新的庫存端點
use_new_inventory_endpoints boolean

Deprecated. 永遠是真的。

是賣方
is_seller boolean

如果使用者是賣家,則為 True。

傳記
bio string

用戶的傳記。

性別
gender string

使用者的性別。

出生月份
birth_month string

使用者的出生月份。

生日
birth_day string

使用者的出生日期。

買入交易計數
transaction_buy_count integer

用戶購買的交易數量。

已售出交易計數
transaction_sold_count integer

使用者已出售的交易數量。

商店

由 Etsy 用戶創建的商店。

名稱 路徑 類型 Description
店鋪編號
shop_id integer

Etsy 商店的唯一正非零數字 ID。

使用者識別碼
user_id integer

擁有此商店之使用者的數字使用者 ID。

店鋪名稱
shop_name string

店名字串。

建立日期
create_date integer

這家商店的創建日期和時間,以紀元秒為單位。

Title
title string

商店主頁的簡短標題字串。

公告
announcement string

顯示在商店首頁上的給買家的公告字串。

貨幣代碼
currency_code string

商店貨幣的 ISO(字母)代碼。 商店預設以該貨幣顯示所有價格。

正在度假
is_vacation boolean

如果為真,則該商店不接受購買。

假期寄語
vacation_message string

當is_vacation為 true 時,商店的訊息字串會顯示。

銷售訊息
sale_message string

傳送給從此商店完成購買的使用者的訊息字串。

數位銷售訊息
digital_sale_message string

傳送給從此商店購買數位商品的使用者的訊息字串。

更新日期
update_date integer

商店上次更新的日期和時間,以紀元秒為單位。

活躍列表數量
listing_active_count integer

商店中的作用中清單數量。

數字列表數量
digital_listing_count integer

商店中的數位清單數量。

登入名稱
login_name string

店主的登入名稱字串。

接受自訂請求
accepts_custom_requests boolean

如果為true,商店會接受自訂要求。

歡迎政策
policy_welcome string

商店的政策歡迎字串(可能是空白的)。

付款政策
policy_payment string

商店的付款原則字串 (可能為空白)。

運輸政策
policy_shipping string

商店的運送政策字串 (可能為空白)。

退款政策
policy_refunds string

商店的退款政策字串 (可能空白)。

附加政策
policy_additional string

商店的其他政策字串 (可能是空白的)。

賣家資訊
policy_seller_info string

商店的賣家資訊字串 (可能為空白)。

保單更新日期
policy_update_date integer

商店政策上次更新的日期和時間,以紀元秒為單位。

有私人收據政策
policy_has_private_receipt_info boolean

如果為true,歐盟收據會顯示私人資訊。

具有非結構化政策
has_unstructured_policies boolean

如果為true,商店會顯示其他非結構化政策欄位。

隱私權原則
policy_privacy string

商店的隱私權政策字串(可能為空白)。

假期自動回覆
vacation_autoreply string

當is_vacation為 true 時,商店的自動回覆字串會顯示在新對話中。

URL
url string

此商店的 URL 字串。

橫幅影像網址
image_url_760x100 string

此商店橫幅影像的 URL 字串。

青睞者數量
num_favorers integer

將此商店標示為我的最愛的使用者人數。

Languages
languages array of string

商店註冊語言的語言字串清單。

圖示影像網址
icon_url_fullxfull string

此商店圖示影像的 URL 字串。

正在使用結構化原則
is_using_structured_policies boolean

如果為true,則商店接受使用結構化政策。

已加入結構化政策
has_onboarded_structured_policies boolean

如果為true,則表示商店在查看結構化政策上線後接受或拒絕。

包含爭議表單連結
include_dispute_form_link boolean

如果屬實,則該商店的政策包含歐盟線上爭議表單的連結。

直接結帳是否已上線
is_direct_checkout_onboarded boolean

如果屬實,該商店已加入 Etsy Payments。

是否計算符合運費資格
is_calculated_eligible boolean

如果為true,則商店符合計算的運送設定檔的資格。 (僅在美國和加拿大提供)

選擇加入買家承諾
is_opted_in_to_buyer_promise boolean

如果屬實,商店選擇接受買家承諾。

總部位於美國
is_shop_us_based boolean

如果屬實,該商店位於美國。

銷售交易計數
transaction_sold_count integer

此商店的銷售交易總數

從 ISO 國家/地區發貨
shipping_from_country_iso string

商店發貨的國家/地區。

店鋪位置 ISO
shop_location_country_iso string

店所在的國家iso。

評論計數
review_count integer

過去一年的商店列表評論數量。

平均評分
review_average double

基於過去一年商店列表評論的平均評分。

上市圖片

參考與特定清單相關聯之影像的網址和中繼資料。 此 url_fullxfull 參數包含完整大小二進位影像檔案的 URL。

名稱 路徑 類型 Description
房源編號
listing_id integer

與此交易相關聯之清單的數值 ID。

清單影像 ID
listing_image_id integer

此交易的主要清單影像的數字 ID。

十六進位代碼
hex_code string

影像平均色彩的 webhex 字串,以 webhex 表示法表示。

紅色值
red integer

紅色數值等於影像的平均紅色值,範圍為 0-255 (RGB 顏色)。

綠色價值
green integer

紅色數值等於影像的平均紅色值,範圍為 0-255 (RGB 顏色)。

藍色值
blue integer

紅色數值等於影像的平均紅色值,範圍為 0-255 (RGB 顏色)。

色相值
hue integer

數字色調等於影像的平均色調,範圍為 0-360 (HSV 顏色)。

飽和值
saturation integer

數字飽和度等於影像的平均飽和度,範圍為 0-100 (HSV 顏色)。

亮度值
brightness integer

數字亮度等於圖像的平均亮度,從 0-100(HSV 顏色)。

黑白分明
is_black_and_white boolean

如果為 true,則影像為黑白。

創建時間
creation_tsz integer

清單影像的建立時間 (以紀元秒為單位)。

等級
rank integer

清單中顯示的影像中的正非零數值位置,排名 1 的影像顯示在清單的最左邊位置。

75x75 影像網址
url_75x75 string

影像 75x75 像素縮圖的 url 字串。

170x135 影像網址
url_170x135 string

影像 170x135 像素縮圖的 url 字串。

570xN 圖片網址
url_570xN string

影像縮圖的 URL 字串,寬度不超過 570 像素,高度可變。

全尺寸影像網址
url_fullxfull string

完整尺寸影像的 URL 字串,每個維度最多 3000 個像素。

全尺寸影像高度
full_height integer

url_fullxfull中參考的全尺寸影像的數字高度(以像素為單位)。

全尺寸影像寬度
full_width integer

url_fullxfull中參考的全尺寸影像的數字寬度 (以像素為單位)。

清單圖片

代表清單影像資源的清單,每個資源都包含影像的參考URL和中繼資料。

名稱 路徑 類型 Description
Count
count integer

結果數目。

Results
results array of ListingImage

要求的資源清單。

ListingInventoryWithAssociations

單一清單的庫存記錄與關聯的表示法

名稱 路徑 類型 Description
Products
products array of ListingInventoryProduct

清單中可用的產品的 JSON 陣列,即使只有一個產品也一樣。 JSON Blob 中的所有欄位名稱都是小寫的。

房產價格
price_on_property array of integer

變更產品價格的屬性的唯一清單屬性 ID 整數陣列 (如果有的話)。 舉例來說,如果您針對相同清單中不同尺寸的產品收取特定價格,則此陣列會包含大小的資源 ID。

屬性數量
quantity_on_property array of integer

唯一清單屬性 ID 整數陣列,適用於變更產品數量 (如果有的話) 的屬性。 例如,如果您在相同清單中儲存特定數量的不同顏色產品,則此陣列會包含顏色的屬性 ID。

屬性上的 SKU
sku_on_property array of integer

變更產品SKU的屬性(如果有)的唯一清單屬性ID整數陣列。 例如,如果您針對相同清單中的不同顏色產品使用特定 SKU,則此陣列會包含顏色的屬性 ID。

商店列表
listing ShopListing

商店的清單,其中包含產品數量、標題、描述、價格等。

ListingInventory產品

清單產品的表示法。

名稱 路徑 類型 Description
產品識別碼
product_id integer

從清單購買之特定產品的數字ID。

SKU
sku string

產品的SKU字串

已刪除
is_deleted boolean

如果為true,則有人刪除了此產品。

Offerings
offerings array of ListingInventoryProductOffering

此產品的產品供應項目清單。

屬性值
property_values array of ListingPropertyValue

此產品的屬性值項目清單。

ListingInventory產品供應

上市產品的表示。

名稱 路徑 類型 Description
供應項目標識符
offering_id integer

產品供應項目的ID

數量
quantity integer

產品提供的數量

已啟用
is_enabled boolean

產品是否可以向買家展示。

已刪除
is_deleted boolean

產品是否已刪除。

金錢
price Money

金額的表示。

清單屬性值

結構化資料值的表示法。

名稱 路徑 類型 Description
屬性 ID
property_id integer

屬性的數字 ID。

名稱
property_name string

財產的名稱。

比例標識符
scale_id integer

量表的數字 ID (如果有的話)。

比例名稱
scale_name string

用於描述所選比例(如果有)的標籤。

值 ID
value_ids array of integer

屬性值的數值 ID

價值觀
values array of string

屬性值

清單庫存

單一清單庫存記錄的表示法。

名稱 路徑 類型 Description
Products
products array of ListingInventoryProduct

清單中可用的產品的 JSON 陣列,即使只有一個產品也一樣。 JSON Blob 中的所有欄位名稱都是小寫的。

房產價格
price_on_property array of integer

變更產品價格的屬性的唯一清單屬性 ID 整數陣列 (如果有的話)。 舉例來說,如果您針對相同清單中不同尺寸的產品收取特定價格,則此陣列會包含大小的資源 ID。

屬性數量
quantity_on_property array of integer

唯一清單屬性 ID 整數陣列,適用於變更產品數量 (如果有的話) 的屬性。 例如,如果您在相同清單中儲存特定數量的不同顏色產品,則此陣列會包含顏色的屬性 ID。

屬性上的 SKU
sku_on_property array of integer

變更產品SKU的屬性(如果有)的唯一清單屬性ID整數陣列。 例如,如果您針對相同清單中的不同顏色產品使用特定 SKU,則此陣列會包含顏色的屬性 ID。

商店列表與關聯

一組具有關聯的商店清單資源。

名稱 路徑 類型 Description
Count
count integer

找到的商店清單資源數量。

Results
results array of ShopListing

找到的商店清單資源。

清單屬性值

代表數個清單屬性值。

名稱 路徑 類型 Description
Count
count integer

找到的商店清單資源數量。

Results
results array of ListingPropertyValue

找到的商店清單資源。

商店收據交易

一組店單交易資源

名稱 路徑 類型 Description
Count
count integer

找到的商店收據交易資源數目。

Results
results array of ShopReceiptTransaction

找到的商店收據交易資源。

商店收據交易

與商店收據相關聯的交易物件。 Etsy 會為訂單收據上記錄的每筆購買清單產生一筆交易。

名稱 路徑 類型 Description
交易 ID
transaction_id integer

交易的唯一數字 ID。

Title
title string

在此交易中購買的清單的標題字串。

Description
description string

在此交易中購買的清單的描述字串。

賣家使用者 ID
seller_user_id integer

此交易中賣家的數字使用者 ID。

買方使用者 ID
buyer_user_id integer

此交易中買方的數字使用者 ID。

建立的時間戳記
create_timestamp integer

交易的建立日期和時間,以紀元秒為單位。

付費時間戳記
paid_timestamp integer

交易的付款日期和時間,以紀元秒為單位。

出貨時間戳記
shipped_timestamp integer

交易的出貨日期和時間 (以紀元秒為單位)。

數量
quantity integer

在此交易中購買的產品數量。

清單影像 ID
listing_image_id integer

此交易的主要清單影像的數字 ID。

收據 ID
receipt_id integer

與此交易相關聯之收據的數字 ID。

是數字的
is_digital boolean

如果屬實,則該交易記錄了數位清單的購買。

檔案資料
file_data string

描述在此交易中購買的檔案的字串。

房源編號
listing_id integer

與此交易相關聯之清單的數值 ID。

交易類型
transaction_type string

交易的類型字串,通常列出

產品識別碼
product_id integer

從清單購買之特定產品的數字ID。

金錢
price Money

金額的表示。

金錢
shipping_cost Money

金額的表示。

上市翻譯

代表清單的翻譯資料。

名稱 路徑 類型 Description
房源編號
listing_id integer

清單的數字 ID。

語言
language string

此翻譯語言的 IETF 語言標籤 (例如 'fr')。

Title
title string

本譯本清單的標題。

Description
description string

本譯本清單的描述。

Tags
tags array of string

此翻譯列表的標籤。

列表變化圖像

代表數個清單變數影像。

名稱 路徑 類型 Description
Count
count integer

變化影像的計數。

Results
results array of ListingVariationImage

變化影像結果。

清單變化圖像

清單上變化和影像關聯的表示法。

名稱 路徑 類型 Description
屬性 ID
property_id integer

屬性的數字 ID。

值 ID
value_id integer

值的數值識別碼。

影像標識碼
image_id integer

影像的數字 ID。

PaymentAccountLedger項目

一組付款帳戶分類帳項目資源

名稱 路徑 類型 Description
Count
count integer

找到的付款帳戶分類帳項目資源數目。

Results
results array of PaymentAccountLedgerEntry

找到的付款帳戶分類帳項目資源。

付款帳戶分類帳項目

代表商店分類帳中的項目。

名稱 路徑 類型 Description
項目 ID
entry_id integer

分類帳項目的數字識別碼。

分類帳 ID
ledger_id integer

分類帳的數字識別碼。

序號
sequence_number integer

此順序允許按時間順序排序分類帳條目。 序列越高,條目越新。

總數
amount integer

記入分類帳的金額。

貨幣
currency string

分類帳上項目的貨幣。

Description
description string

詳細說明這是哪種分類帳分錄:付款、退款、撤銷失敗退款、付款、退回付款、收回、雜項貸方、雜項借方或帳單付款。

balance integer

應用此條目後商店分類帳中的金額。

建立日期
create_date integer

建立分類帳項目的日期和時間,以紀元秒為單位。

付款

代表使用 Etsy Payments 進行的幾筆付款。 除非另有說明,否則所有金額均以美元便士為單位。

名稱 路徑 類型 Description
Count
count integer

回應中的付款數目。

Results
results array of Payment

付款清單。

付款

代表使用 Etsy Payments 支付的款項。 除非另有說明,否則所有金額均以美元便士為單位。

名稱 路徑 類型 Description
付款標識碼
payment_id integer

用於向特定 Etsy 商店付款的唯一數字 ID。

買方使用者 ID
buyer_user_id integer

支付購買費用之使用者的數字 ID。

店鋪編號
shop_id integer

Etsy 商店的唯一正非零數字 ID。

收據 ID
receipt_id integer

與此交易相關聯之收據的數字 ID。

金錢
amount_gross Money

金額的表示。

金錢
amount_fees Money

金額的表示。

金錢
amount_net Money

金額的表示。

金錢
posted_gross Money

金額的表示。

金錢
posted_fees Money

金額的表示。

金錢
posted_net Money

金額的表示。

金錢
adjusted_gross Money

金額的表示。

金錢
adjusted_fees Money

金額的表示。

金錢
adjusted_net Money

金額的表示。

貨幣
currency string

付款貨幣的 ISO (字母) 代碼字串。

商店貨幣
shop_currency string

商店貨幣的 ISO(字母)代碼。 商店預設以該貨幣顯示所有價格。

買方貨幣
buyer_currency string

買方的貨幣字串。

使用者運送 ID
shipping_user_id integer

賣家將訂單運送到的使用者的數字 ID。

送貨地址 ID
shipping_address_id integer

識別送貨地址的數字 ID。

帳單地址 ID
billing_address_id integer

識別買方帳單地址的數字 ID。

地位
status string

指出付款目前狀態的字串,最常見的是已結算或已驗證。

出貨時間戳記
shipped_timestamp integer

交易的出貨日期和時間 (以紀元秒為單位)。

建立的時間戳記
create_timestamp integer

交易的建立日期和時間,以紀元秒為單位。

更新時間戳記
update_timestamp integer

最後一次變更付款調整的日期和時間,以紀元秒為單位。

付款調整
payment_adjustments array of PaymentAdjustment

Etsy 付款交易的退款物件清單。 除非另有說明,否則所有金額均以美元便士為單位。

付款調整

代表退款,適用於先前的 Etsy 付款。 除非另有說明,否則所有金額均以美元便士為單位。

名稱 路徑 類型 Description
付款調整 ID
payment_adjustment_id integer

付款調整的數字 ID。

付款標識碼
payment_id integer

用於向特定 Etsy 商店付款的唯一數字 ID。

地位
status string

付款調整的狀態字串。

是成功
is_success boolean

如果為true,則付款調整已經或可能成功完成。

使用者識別碼
user_id integer

履行購買的使用者 (賣家) 的數字 ID。

原因代碼
reason_code string

描述退款原因的人類可讀字串。

調整總金額
total_adjustment_amount integer

以付款貨幣表示的退款總金額。

商店總調整金額
shop_total_adjustment_amount integer

以商店貨幣表示的退款金額。

調整總金額
buyer_total_adjustment_amount integer

以買方貨幣表示的退款金額。

總費用調整金額
total_fee_adjustment_amount integer

與付款調整相關的卡片處理費的數字金額。

建立的時間戳記
create_timestamp integer

交易的建立日期和時間,以紀元秒為單位。

更新時間戳記
update_timestamp integer

最後一次變更付款調整的日期和時間,以紀元秒為單位。

乒乓球

確認目前應用程式可以存取 Open API

名稱 路徑 類型 Description
應用程式識別碼
application_id integer

已驗證應用程式的識別碼

商店收據

從商店購買的記錄。 商店收據使用商店貨幣顯示貨幣價值。

名稱 路徑 類型 Description
收據 ID
receipt_id integer

與此交易相關聯之收據的數字 ID。

收據類型
receipt_type integer

為購買提供服務的 Etsy 管道的數值:0 代表 Etsy.com,1 代表圖案商店。

賣家使用者 ID
seller_user_id integer

履行購買的使用者 (賣家) 的數字 ID。

賣家的電子郵件地址
seller_email string

清單賣家的電子郵件地址字串。

買方使用者 ID
buyer_user_id integer

進行購買的使用者的數字 ID。

買家的電子郵件地址
buyer_email string

清單買方的電子郵件地址字串。

名稱
name string

送貨地址中收件人的名稱字串。

第一個地址行
first_line string

送貨地址中收件人的第一個地址行字串。

第二個地址行
second_line string

送貨地址中收件人的選擇性第二個地址行字串。

城市
city string

送貨地址中收件人的城市字串。

State
state string

收件者在送貨地址中的狀態字串。

郵遞區號
zip string

收件者在送貨地址中的郵遞區號字串 (不一定是數字)。

格式化地址
formatted_address string

送貨地址中收件人的格式化送貨地址字串。

國家代碼 ISO
country_iso string

送貨地址中收件人的 ISO-3166 alpha-2 國家/地區代碼字串。

付款方式
payment_method string

識別購買者付款方式的付款方式字串,必須是以下其中一種方式:'cc' (信用卡)、'PayPal'、'check'、'mo' (匯票)、'bt' (銀行轉帳)、'other'、'ideal'、'sofort'、'apple_pay'、'google'、'android_pay'、'google_pay'、'klarna'、'k_pay_in_4' (klarna) 或 'k_financing' (klarna)。

付款電郵地址
payment_email string

要傳送付款確認的電子郵件地址的電子郵件地址字串

賣家寄語
message_from_seller string

來自賣家的選用訊息字串。

買家寄語
message_from_buyer string

來自買方的選用訊息字串。

來自支付系統的訊息
message_from_payment string

機器從付款系統產生的通知字串。

已付費
is_paid boolean

如果為true,則買方支付了此購買費用。

已出貨
is_shipped boolean

如果為true,賣方已出貨。

建立的時間戳記
create_timestamp integer

收據的建立時間 (以紀元秒為單位)。

更新時間戳記
update_timestamp integer

最後更新收據的時間,以紀元秒為單位。

禮物寄語
gift_message string

買家要求隨產品一起交付的禮品訊息字串。

金錢
grandtotal Money

金額的表示。

金錢
subtotal Money

金額的表示。

金錢
total_price Money

金額的表示。

金錢
total_shipping_cost Money

金額的表示。

金錢
total_tax_cost Money

金額的表示。

金錢
total_vat_cost Money

金額的表示。

金錢
discount_amt Money

金額的表示。

金錢
gift_wrap_price Money

金額的表示。

出貨
shipments array of ShopReceiptShipment

此收據的出貨報表清單。

商店收據出貨

ShopReceipt 的一個出貨事件記錄。 收據可能有許多 ShopReceiptShipment 記錄。

名稱 路徑 類型 Description
收據出貨 ID
receipt_shipping_id integer

商店收據出貨記錄的唯一數字 ID。

貨件通知時間戳記
shipment_notification_timestamp integer

Etsy 通知買方出貨事件的時間,以紀元秒為單位。

承運商名稱
carrier_name string

負責遞送貨件的承運人/公司的名稱字串。

追蹤代碼
tracking_code string

承運人/公司為貨件提供的追蹤代碼字串。

商店收據

特定商店的收據。

名稱 路徑 類型 Description
Count
count integer

找到的商店收據數量。

Results
results array of ShopReceipt

找到的商店收據資源清單,以及每個資源的所有商店收據欄位。

交易評論

使用者留下的一組交易審核記錄。

名稱 路徑 類型 Description
Count
count integer

找到的 TransactionReview 資源數目。

Results
results array of TransactionReview

找到的 TransactionReview 資源。

交易回顧

使用者留下的交易審查記錄。

名稱 路徑 類型 Description
店鋪編號
shop_id integer

店家的數字ID。

房源編號
listing_id integer

TransactionReview 所屬商店清單的 ID。

買方使用者 ID
buyer_user_id integer

在此交易中作為買方的使用者的數字 ID。 注意:此欄位可能沒有,視買方的隱私權設定而定。

Rating
rating integer

評分值從 1 到 5

評論訊息
review string

作者留下的留言,解釋回饋。

語言
language string

TransactionReview 的語言

全尺寸影像 URL
image_url_fullxfull string

隨反饋一起提供的照片的 URL,尺寸為 fullxfull。 注意:此欄位可能沒有,視買方的隱私權設定而定。

建立的時間戳記
create_timestamp integer

建立 TransactionReview 的日期和時間,以紀元秒為單位。

更新時間戳記
update_timestamp integer

TransactionReview 更新的日期和時間 (以 epoch 秒為單位)。

賣方分類節點

賣方分類樹中的分類節點清單。

名稱 路徑 類型 Description
Count
count integer

結果數目。

Results
results array of SellerTaxonomyNode

要求的資源清單。

賣家分類節點

賣方分類樹中的分類節點。

名稱 路徑 類型 Description
ID
id integer

Etsy 分類節點的唯一數字 ID,這是組織到賣家分類層次結構樹狀結構中的列表的元數據類別。 例如,鞋子分類節點 (ID: 1429,層級: 1) 在階層中高於 girls' shoes (ID: 1440,層級: 2)。 指派給清單的分類節點支援存取特定的標準化產品規模和屬性。 例如,指派分類節點 shoes 或 girls's shoes 的清單支援存取歐盟鞋碼等級,以及其相關聯的屬性名稱和歐盟鞋碼的 ID,例如屬性 value_id:1394 和 name:38。

Level
level integer

賣方分類樹中此分類節點的整數深度,根位於層級 0。

名稱
name string

此分類節點的名稱字串。

父 ID
parent_id integer

此節點父項的數值分類識別碼。

孩童
children array of SellerTaxonomyNode

賣方分類樹中此分類節點的所有直接子系的分類節點陣列。

分類路徑 ID
full_path_taxonomy_ids array of integer

分類 ID 陣列,包括此節點及其賣方分類樹狀結構中的所有直接父項,直至根節點。 它們按從根到葉的順序列出。

分類節點屬性

產品屬性定義的清單。

名稱 路徑 類型 Description
Count
count integer

結果數目。

Results
results array of TaxonomyNodeProperty

要求的資源清單。

分類節點屬性

產品屬性定義。

名稱 路徑 類型 Description
屬性 ID
property_id integer

此產品屬性的唯一數字 ID。

名稱
name string

此分類節點的名稱字串。

顯示名稱
display_name string

人類可讀的產品屬性名稱字串。

scales array of TaxonomyPropertyScale

可用比例的清單。

是必要的
is_required boolean

如果為true,則指派合格分類ID的清單需要此屬性。

支持屬性
supports_attributes boolean

當 true 時,您可以在列出屬性中使用此屬性。

支持變化
supports_variations boolean

如果為true,您可以在列出變化中使用此屬性。

是多值的
is_multivalued boolean

當 true 時,您可以將多個屬性值指派給此屬性

可能的值
possible_values array of TaxonomyPropertyValue

此屬性支援的屬性值字串清單。

選取的值
selected_values array of TaxonomyPropertyValue

自動且一律為指定屬性選取的屬性值字串清單。

分類法屬性規模

定義特定產品屬性可用屬性值的可指派增量的比例。

名稱 路徑 類型 Description
比例標識符
scale_id integer

尺度的唯一數值識別碼。

顯示名稱
display_name string

尺度的名稱字串。

Description
description string

尺度的描述字串。

分類屬性值

特定產品屬性的屬性值,也可以採用特定比例。

名稱 路徑 類型 Description
值 ID
value_id integer

此屬性值的數值 ID。

名稱
name string

此屬性值的名稱字串。

比例標識符
scale_id integer

此屬性值所屬比例的數值比例識別碼。

等於
equal_to array of integer

此屬性值等於的數值屬性值識別碼清單 (如果有的話)。

運輸承運商

代表數個 ShippingCarriers。

名稱 路徑 類型 Description
count
count integer
results
results array of ShippingCarrier

運輸承運商

支援的貨運承運商,用於計算預計交貨日期。

名稱 路徑 類型 Description
貨運業者 ID
shipping_carrier_id integer

此貨運業者的數字 ID。

名稱
name string

此貨運承運商的名稱。

國內課程
domestic_classes array of ShippingCarrierMailClass

該承運商的國內郵件類別集。

國際課程
international_classes array of ShippingCarrierMailClass

該承運商的國際郵件類別集。

ShippingCarrierMail類別

託運承運商的郵件類別,用於計算預估遞送日期。

名稱 路徑 類型 Description
郵件類別 ID
mail_class_key string

此郵件類別的唯一 ID。

名稱
name string

此郵件類別的名稱。

商店

一組商店記錄。

名稱 路徑 類型 Description
Count
count integer

商店總數

Results
results array of Shop

商店資源。

商店區

商店內的一個部分,用戶可以將列表排序到其中。

名稱 路徑 類型 Description
商店區塊 ID
shop_section_id integer

特定 Etsy 商店中某個部分的數字 ID。

Title
title string

商店區段的標題字串。

等級
rank integer

此區段在商店區段顯示順序中的正非零數值位置,排名 1 區段會先顯示。

使用者識別碼
user_id integer

擁有此商店區段之使用者的數字 ID。

活躍列表數量
active_listing_count integer

特定 Etsy 商店的一個部分中的有效清單數量。

商店區段

所有部分都位於一個特殊的商店中。

名稱 路徑 類型 Description
Count
count integer

結果數目。

Results
results array of ShopSection

要求的資源清單。

商店運送簡介

代表用來設定清單出貨資訊的設定檔。 請注意,您無法透過 API 建立計算運費範本。 不過,您可以使用 API 將從 Shop Manager 建立的計算運送設定檔與清單建立關聯。

名稱 路徑 類型 Description
運送設定檔 ID
shipping_profile_id integer

運送設定檔的數字 ID。

Title
title string

此運送設定檔的名稱字串。

使用者識別碼
user_id integer

擁有運送設定檔之使用者的數字 ID。

最短處理天數
min_processing_days integer

處理清單的最短天數。

最長處理天數
max_processing_days integer

處理清單的天數上限。

處理天數標籤
processing_days_display_label string

處理天數的已翻譯顯示標籤字串。

原產地國家/地區 ISO
origin_country_iso string

清單發貨國家/地區的 ISO 代碼。

已刪除
is_deleted boolean

如果為true,則表示有人刪除了此託運設定檔。

運送設定檔目的地
shipping_profile_destinations array of ShopShippingProfileDestination

此運送設定檔可用的運送設定檔目的地清單。

運送設定檔升級
shipping_profile_upgrades array of ShopShippingProfileUpgrade

適用於此運送設定檔的運送設定檔升級清單。

原產地郵遞區號
origin_postal_code string

商品出貨地點的郵遞區號字串 (不一定是數字)。

ProfileType
profile_type ProfileType

商店運送個人資料目的地

代表指派給運送設定檔的運送目的地。

名稱 路徑 類型 Description
運送設定檔目的地ID
shipping_profile_destination_id integer

與清單相關聯的運送設定檔中運送設定檔目的地的數值ID。

運送設定檔 ID
shipping_profile_id integer

運送設定檔的數字 ID。

原產地國家/地區 ISO
origin_country_iso string

清單發貨國家/地區的 ISO 代碼。

目的地國家/地區 ISO
destination_country_iso string

清單發貨到的國家/地區的 ISO 代碼。 如果為 Null,則要求會將目的地設定為 destination_region

目的地區域
destination_region DestinationRegion

清單運送到的地區的代碼。 區域代表一組國家/地區。 支援的區域是歐盟和非歐盟 (不在歐盟的歐洲國家/地區)。 如果沒有,則要求將目的地設定為destination_country_iso,如果destination_country_iso也為空值,則會設定 everywhere

金錢
primary_cost Money

金額的表示。

金錢
secondary_cost Money

金額的表示。

貨運業者 ID
shipping_carrier_id integer

支援貨運業者的唯一 ID,用於計算預估交貨日期。

郵件類
mail_class string

託運承運商郵件類別的唯一 ID 字串,用於計算預估遞送日期。

最短交貨天數
min_delivery_days integer

買家在購買的商品出貨後可以等待收到的最短工作天數。

最長交貨天數
max_delivery_days integer

買家預計在購買的商品出貨後可以等待收到的最長工作天數。

ShopShippingProfile升級

運送設定檔升級選項的表示。

名稱 路徑 類型 Description
運送設定檔 ID
shipping_profile_id integer

基本託運設定檔的數字 ID。

升級標識碼
upgrade_id integer

與運送升級相關聯的數字 ID

升級名稱
upgrade_name string

結帳時向購物者顯示的運送升級名稱,例如 USPS Priority。

類型
type Type

運送升級的類型。 國內 (0) 或國際 (1)。

等級
rank integer

清單中顯示的影像中的正非零數值位置,排名 1 的影像顯示在清單的最左邊位置。

語言
language string

出貨設定檔語言的 IETF 語言標籤。 例如:de、en、es、fr、it、ja、nl、pl、pt、ru。

金錢
price Money

金額的表示。

金錢
secondary_price Money

金額的表示。

貨運業者 ID
shipping_carrier_id integer

支援貨運業者的唯一 ID,用於計算預估交貨日期。

郵件類
mail_class string

託運承運商郵件類別的唯一 ID 字串,用於計算預估遞送日期。

最短交貨天數
min_delivery_days integer

買家在購買的商品出貨後可以等待收到的最短工作天數。

最長交貨天數
max_delivery_days integer

買家預計在購買的商品出貨後可以等待收到的最長工作天數。

ShopShippingProfile目的地

代表出貨目的地物件的清單。

名稱 路徑 類型 Description
Count
count integer

結果數目。

Results
results array of ShopShippingProfileDestination

要求的資源清單。

ShopShippingProfile升級

運送升級選項清單。

名稱 路徑 類型 Description
Count
count integer

結果數目。

Results
results array of ShopShippingProfileUpgrade

要求的資源清單。

使用者位址

代表使用者的位址。

名稱 路徑 類型 Description
使用者位址 ID
user_address_id integer

使用者位址的數字 ID。

使用者識別碼
user_id integer

使用者的數字 ID。

名稱
name string

此位址的使用者名稱。

第一個地址行
first_line string

使用者位址的第一行。

第二個地址行
second_line string

使用者位址的第二行。

城市
city string

使用者地址的 city 欄位。

State
state string

使用者位址的 state 欄位。

郵遞區號
zip string

使用者地址的郵遞區號欄位。

國家代碼 ISO
iso_country_code string

此地址中國家/地區的 ISO 代碼。

國家
country_name string

使用者國家/地區的名稱。

是預設送貨地址
is_default_shipping_address boolean

這是使用者的預設送貨地址嗎?

使用者位址

代表數個 UserAddress 記錄。

名稱 路徑 類型 Description
Count
count integer

傳回的 UserAddress 記錄數目。

Results
results array of UserAddress

UserAddress 資源陣列。

目的地區域

清單運送到的地區的代碼。 區域代表一組國家/地區。 支援的區域是歐盟和非歐盟 (不在歐盟的歐洲國家/地區)。 如果沒有,則要求將目的地設定為destination_country_iso,如果destination_country_iso也為空值,則會設定 everywhere

清單運送到的地區的代碼。 區域代表一組國家/地區。 支援的區域是歐盟和非歐盟 (不在歐盟的歐洲國家/地區)。 如果沒有,則要求將目的地設定為destination_country_iso,如果destination_country_iso也為空值,則會設定 everywhere

目的地區域
string

項目維度單位

定義用來測量產品尺寸的單位的字串。 預設值為 null。

定義用來測量產品尺寸的單位的字串。 預設值為 null。

項目維度單位
string

項目權重單位

定義用來測量產品重量的單位的字串。 預設值為 null。

定義用來測量產品重量的單位的字串。 預設值為 null。

項目權重單位
string

場合

列舉的字串,表示該產品將作為適當禮物的場合。 預設值為 null。

列舉的字串,表示該產品將作為適當禮物的場合。 預設值為 null。

場合
string

ProfileType

ProfileType
string

Recipient

列舉的字串,表示本產品將作為適當禮物的人。 預設值為 null。

列舉的字串,表示本產品將作為適當禮物的人。 預設值為 null。

Recipient
string

State

來自下列任一的列舉字串:作用中或非作用中。 注意:將草稿房源設為有效也會在 etsy.com 上發布房源。

來自下列任一的列舉字串:作用中或非作用中。 注意:將草稿房源設為有效也會在 etsy.com 上發布房源。

State
integer

類型

運送升級的類型。 國內 (0) 或國際 (1)。

運送升級的類型。 國內 (0) 或國際 (1)。

類型
integer

何時製造

製造商在此清單中製造產品的時代的列舉字串。 幫助買家在“復古”標題下找到列表。 需要「is_supply」和「who_made」。

製造商在此清單中製造產品的時代的列舉字串。 幫助買家在“復古”標題下找到列表。 需要「is_supply」和「who_made」。

何時製造
string

誰製造的

列舉字串指出誰製造了該產品。 幫助買家在“手工製作”標題下找到列表。 需要「is_supply」和「when_made」。

列舉字串指出誰製造了該產品。 幫助買家在“手工製作”標題下找到列表。 需要「is_supply」和「when_made」。

誰製造的
string