Easyship （獨立發行商）（預覽版）

Easyship 為您提供強大的服務，為您的網站添加無憂的全球運輸選項，並為您的倉庫、ERP 或平台添加端到端運輸功能。

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

服務	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	特洛伊·泰勒
網站	https://www.easyship.com/
隱私策略	https://www.easyship.com/legal/privacy
類別	商業管理;商

正在建立連線

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


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

預設

適用：所有地區

建立連線的參數。

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

名稱	類型	Description	為必填項目
API 存取權杖（格式為：持有人 APIAccessToken）	securestring	此 API 的 API 存取權杖（格式為：持有人 APIAccessToken）	對

節流限制

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

動作

列出所有方塊	擷取所有可用快遞箱的清單。
列出所有貨件	擷取所有貨件的清單。
刪除貨件（V1）	刪除並接收貨件刪除確認。
取得可用的取貨時段（V1）	可用的取件時段將根據當地時間和未來 7 天計算特定快遞公司。然後可以使用「請求取件」動作請求取件。
取得檢查點	擷取貨件檢查點的詳細資料。
取得貨件	取得貨件的詳細資料。
取得追蹤狀態	擷取貨件的追蹤狀態。
取得項目類別	擷取貨件類別清單，以及要使用該類別的 slug。
建立貨件	建立並擷取有關貨件的資訊。
更新倉儲狀態	更新貨件的倉庫狀態。僅適用於在 Easyship 綜合倉庫之一履行的貨件。
更新貨件	更新貨件詳細資料。
獲取稅率和稅金	擷取預期出貨的出貨報價清單。
要求取件（V1）	建立取件後，將直接向快遞員提出取件請求，快遞員將傳回參考號。聯絡快遞公司的客服時可能會使用參考號。必須選擇取貨時段;可以使用“獲取可用的拾取位置”操作找到即將到來的拾取位置。
購買貨件標籤（V1）	購買和擷取運送標籤的相關資訊。

列出所有方塊

作業識別碼：: ListAllBoxes

擷取所有可用快遞箱的清單。

傳回

名稱	路徑	類型	Description
盒子	boxes	array of object
ID	boxes.id	string	唯一識別碼。
快遞傘名稱	boxes.courier_umbrella_name	string	快遞傘名。
名稱	boxes.name	string	名稱。
動態資料欄位	boxes.slug	string	蛞蝓。
外長	boxes.outer_length	float	外長。
外寬	boxes.outer_width	float	外寬。
外部高度	boxes.outer_height	float	外部高度。
Weight	boxes.weight	float	權數。

列出所有貨件

作業識別碼：: ListAllShipments

擷取所有貨件的清單。

參數

名稱	機碼	類型	Description
Easyship 貨件編號	easyship_shipment_id	string	Easyship 貨件唯一識別碼。
平台訂單編號	platform_order_number	string	平台訂單號碼。
頁面	page	integer	頁面。
每頁	per_page	integer	每頁的數目。
建立於	created_at_from	string	創建於 from。
建立時間至	created_at_to	string	創建的。
確認時間為	confirmed_at_from	string	確認在從。
確認時間至	confirm_at_to	string	確認在。
標籤產生自	label_generated_at_from	string	標籤產生於 from。
標籤產生時間至	label_generated_at_to	string	產生的標籤 to.
出貨狀態	shipment_state	string	出貨狀態。
取件狀態	pickup_state	string	拾取狀態。
傳遞狀態	delivery_state	string	傳遞狀態。
標籤狀態	label_state	string	標籤狀態。
倉儲狀態	warehouse_state	string	倉儲狀態。

傳回

名稱	路徑	類型	Description
出貨	shipments	array of object
Easyship 貨件編號	shipments.easyship_shipment_id	string	Easyship 貨件唯一識別碼。
創建於	shipments.created_at	string	創建於。
更新於	shipments.updated_at	string	更新於。
標籤支付地點	shipments.label_paid_at	string	唱片公司支付了費用。
標籤產生於	shipments.label_generated_at	string	生成的。
訂單建立時間	shipments.order_created_at	string	創建的訂單。
Address	shipments.origin_address.line_1	string	位址。
地址行 2	shipments.origin_address.line_2	string	地址行 2.
State	shipments.origin_address.state	string	國家。
城市	shipments.origin_address.city	string	城市。
郵遞區號	shipments.origin_address.postal_code	string	郵遞區號。
國碼 (地區碼)	shipments.origin_address.country_alpha2	string	國家/地區代碼。
連絡人姓名	shipments.origin_address.contact_name	string	聯絡人姓名。
公司名稱	shipments.origin_address.company_name	string	公司名稱。
連絡人電話	shipments.origin_address.contact_phone	string	聯絡電話號碼。
聯絡電子郵件	shipments.origin_address.contact_email	string	聯絡電子郵件地址。
Address	shipments.sender_address.line_1	string	位址。
地址行 2	shipments.sender_address.line_2	string	地址行 2.
State	shipments.sender_address.state	string	國家。
城市	shipments.sender_address.city	string	城市。
郵遞區號	shipments.sender_address.postal_code	string	郵遞區號。
國碼 (地區碼)	shipments.sender_address.country_alpha2	string	國家/地區代碼。
連絡人姓名	shipments.sender_address.contact_name	string	聯絡人姓名。
公司名稱	shipments.sender_address.company_name	string	公司名稱。
連絡人電話	shipments.sender_address.contact_phone	string	聯絡電話號碼。
聯絡電子郵件	shipments.sender_address.contact_email	string	聯絡電子郵件地址。
Address	shipments.return_address.line_1	string	位址。
地址行 2	shipments.return_address.line_2	string	地址行 2.
State	shipments.return_address.state	string	國家。
城市	shipments.return_address.city	string	城市。
郵遞區號	shipments.return_address.postal_code	string	郵遞區號。
國碼 (地區碼)	shipments.return_address.country_alpha2	string	國家/地區代碼。
連絡人姓名	shipments.return_address.contact_name	string	聯絡人姓名。
公司名稱	shipments.return_address.company_name	string	公司名稱。
連絡人電話	shipments.return_address.contact_phone	string	聯絡電話號碼。
聯絡電子郵件	shipments.return_address.contact_email	string	聯絡電子郵件地址。
Address	shipments.destination_address.line_1	string	位址。
地址行 2	shipments.destination_address.line_2	string	地址行 2.
State	shipments.destination_address.state	string	國家。
城市	shipments.destination_address.city	string	城市。
郵遞區號	shipments.destination_address.postal_code	string	郵遞區號。
國碼 (地區碼)	shipments.destination_address.country_alpha2	string	國家/地區代碼。
連絡人姓名	shipments.destination_address.contact_name	string	聯絡人姓名。
公司名稱	shipments.destination_address.company_name	string	公司名稱。
連絡人電話	shipments.destination_address.contact_phone	string	聯絡電話號碼。
聯絡電子郵件	shipments.destination_address.contact_email	string	聯絡電子郵件地址。
平台名稱	shipments.order_data.platform_name	string	平台名稱。
平台訂單編號	shipments.order_data.platform_order_number	string	平台訂單號碼。
訂單標籤清單	shipments.order_data.order_tag_list	array of string	訂單標籤清單
賣家說明	shipments.order_data.seller_notes	string	賣家指出。
買家筆記	shipments.order_data.buyer_notes	string	買家指出。
設定為住宅	shipments.set_as_residential	boolean	是否設定為住宅。
收貨人稅號	shipments.consignee_tax_id	string	收貨人稅務識別碼。
EEI 參考	shipments.eei_reference	string	EEI 參考資料。
國際貿易術語解釋通則	shipments.incoterms	string	國際貿易術語解釋通則。
已投保	shipments.insurance.is_insured	boolean	是否投保。
保額	shipments.insurance.insured_amount	integer	保險金額。
保險貨幣	shipments.insurance.insured_currency	string	保險貨幣。
包裹	shipments.parcels	array of object
總實際重量	shipments.parcels.total_actual_weight	float	總實際重量。
海關總值	shipments.parcels.total_customs_value	float	海關總價值。
總體積重量	shipments.parcels.total_dimensional_weight	float	總體積重量。
總體積重量	shipments.parcels.total_volumetric_weight	float	總體積重量。
ID	shipments.parcels.box.id	string	唯一識別碼。
快遞傘名稱	shipments.parcels.box.courier_umbrella_name	string	快遞傘名。
名稱	shipments.parcels.box.name	string	名稱。
動態資料欄位	shipments.parcels.box.slug	string	蛞蝓。
外長	shipments.parcels.box.outer_length	float	外長。
外寬	shipments.parcels.box.outer_width	float	外寬。
外部高度	shipments.parcels.box.outer_height	float	外部高度。
Weight	shipments.parcels.box.weight	integer	權數。
物品	shipments.parcels.items	array of object
Description	shipments.parcels.items.description	string	描述。
類別	shipments.parcels.items.category	string	類別。
SKU	shipments.parcels.items.sku	string	SKU。
數量	shipments.parcels.items.quantity	integer	數量。
實際重量	shipments.parcels.items.actual_weight	integer	實際重量。
體積重量	shipments.parcels.items.dimensional_weight	integer	體積重量。
體積重量	shipments.parcels.items.volumetric_weight	integer	體積重量。
原產地貨幣	shipments.parcels.items.origin_currency	string	原始貨幣。
原產地海關價值	shipments.parcels.items.origin_customs_value	integer	原點海關價值。
申報貨幣	shipments.parcels.items.declared_currency	string	宣告的貨幣。
申報的海關價值	shipments.parcels.items.declared_customs_value	integer	申報的海關價值。
長度	shipments.parcels.items.dimensions.length	integer	長度。
寬度	shipments.parcels.items.dimensions.width	integer	寬度。
高度	shipments.parcels.items.dimensions.height	integer	高度。
海關總值	shipments.total_customs_value	float	海關總價值。
總實際重量	shipments.total_actual_weight	float	總實際重量。
總體積重量	shipments.total_dimensional_weight	float	總體積重量。
總體積重量	shipments.total_volumetric_weight	float	總體積重量。
出貨狀態	shipments.shipment_state	string	出貨狀態。
取件狀態	shipments.pickup_state	string	拾取狀態。
傳遞狀態	shipments.delivery_state	string	傳遞狀態。
標籤狀態	shipments.label_state	string	標籤狀態。
倉儲狀態	shipments.warehouse_state	string	倉儲狀態。
追蹤	shipments.trackings	array of object
追蹤號碼	shipments.trackings.tracking_number	string	追蹤號碼。
本地追蹤號碼	shipments.trackings.local_tracking_number	string	本地追蹤號碼。
備用追蹤號碼	shipments.trackings.alternate_tracking_number	string	替代追蹤號碼。
腿號	shipments.trackings.leg_number	integer	腿號。
處理常式	shipments.trackings.handler	string	處理人員。
追蹤狀態	shipments.trackings.tracking_state	string	追蹤狀態。
追蹤頁面網址	shipments.tracking_page_url	string	追蹤頁面網址。
運輸文件	shipments.shipping_documents	array of	運輸文件。
貨幣	shipments.currency	string	貨幣。
ID	shipments.selected_courier.id	string	唯一識別碼。
費率	shipments.rates	array of object
快遞員 ID	shipments.rates.courier_id	string	快遞唯一識別碼。
快遞公司名稱	shipments.rates.courier_name	string	快遞員名稱。
最短交貨時間	shipments.rates.min_delivery_time	integer	最短交貨時間。
最長交貨時間	shipments.rates.max_delivery_time	integer	最長交貨時間。
物有所值排名	shipments.rates.value_for_money_rank	integer	物有所值的排名。
交貨時間排名	shipments.rates.delivery_time_rank	integer	交貨時間排名。
運費	shipments.rates.shipment_charge	float	出貨費用。
燃油附加費	shipments.rates.fuel_surcharge	float	燃油附加費。
偏遠地區附加費	shipments.rates.remote_area_surcharge	integer	偏遠地區附加費。
超大附加費	shipments.rates.oversized_surcharge	integer	超大的附加費。
附加服務附加費	shipments.rates.additional_services_surcharge	integer	附加服務附加費。
住宿全額費用	shipments.rates.residential_full_fee	integer	住宿全額費用。
住宅折扣費	shipments.rates.residential_discounted_fee	integer	住宅折扣費。
出貨費用總額	shipments.rates.shipment_charge_total	float	出貨費用總計。
倉庫手續費	shipments.rates.warehouse_handling_fee	integer	倉庫手續費。
保險費	shipments.rates.insurance_fee	integer	保險費。
營業稅	shipments.rates.sales_tax	integer	銷售稅。
省級銷售稅	shipments.rates.provincial_sales_tax	integer	省級銷售稅。
DDP手續費	shipments.rates.ddp_handling_fee	integer	DDP 手續費。
進口稅	shipments.rates.import_tax_charge	integer	進口稅。
進口關稅	shipments.rates.import_duty_charge	integer	進口關稅。
總費用	shipments.rates.total_charge	float	總費用。
高於臨界值	shipments.rates.is_above_threshold	boolean	是否高於閾值。
國際貿易術語解釋通則	shipments.rates.incoterms	string	國際貿易術語解釋通則。
預估進口稅	shipments.rates.estimated_import_tax	integer	預估進口稅。
預計進口關稅	shipments.rates.estimated_import_duty	integer	估計進口關稅。
可用的移交選項	shipments.rates.available_handover_options	string	可用的移交選項。
追蹤評級	shipments.rates.tracking_rating	integer	追蹤評級。
Easyship 評級	shipments.rates.easyship_rating	integer	Easyship 評級。
快遞備註	shipments.rates.courier_remarks	string	信使評論道。
收款人	shipments.rates.payment_recipient	string	付款收款人。
Code	shipments.rates.discount.code	string	代碼。
總數	shipments.rates.discount.amount	integer	金額。
過期時間	shipments.rates.discount.expires_at	string	到期時間。
百分比	shipments.rates.discount.percentage	string	百分比。
有效的國際貿易術語解釋通則	shipments.rates.effective_incoterms	string	有效的國際貿易術語解釋通則。

刪除貨件（V1）

作業識別碼：: DeleteAShipment

刪除並接收貨件刪除確認。

參數

名稱	機碼	必要	類型	Description
Easyship 貨件編號	easyship_shipment_id	True	string	Easyship 貨件識別碼。

傳回

名稱	路徑	類型	Description
地位	status	string	狀態。

取得可用的取貨時段（V1）

作業識別碼：: GetAvailablePickupSlots

可用的取件時段將根據當地時間和未來 7 天計算特定快遞公司。然後可以使用「請求取件」動作請求取件。

參數

名稱	機碼	必要	類型	Description
快遞員 ID	courier_id	True	string	快遞識別碼。

傳回

名稱	路徑	類型	Description
快遞員 ID	courier_id	string	快遞識別碼。
快遞公司名稱	courier_name	string	快遞員名稱。
Message	message	string	訊息。
提供者名稱	pickup.provider_name	string	提供者名稱。
提供者客戶服務電話	pickup.provider_customer_service_phone	string	提供者客戶服務電話號碼。

取得檢查點

作業識別碼：: GetCheckpoints

擷取貨件檢查點的詳細資料。

參數

名稱	機碼	必要	類型	Description
Easyship 貨件編號	easyship_shipment_id	True	string	Easyship 貨件唯一識別碼。
平台訂單編號	platform_order_number		string	平台訂單號碼。
頁面	page		integer	頁面。
每頁	per_page		integer	每頁的數目。

傳回

名稱	路徑	類型	Description
總頁數	total_page	integer	總頁面。
當前頁面	current_page	integer	目前頁面。
出貨	shipments	array of object
Easyship 貨件編號	shipments.easyship_shipment_id	string	Easyship 貨件唯一識別碼。
平台訂單編號	shipments.platform_order_number	string	平台訂單號碼。
Origin	shipments.origin	string	原點。
目的地	shipments.destination	string	目的地。
地位	shipments.status	string	狀態。
追蹤號碼	shipments.tracking_number	string	追蹤號碼。
追蹤頁面網址	shipments.tracking_page_url	string	追蹤頁面網址。
Checkpoints	shipments.checkpoints	array of object
訂單編號	shipments.checkpoints.order_number	integer	訂單號碼。
處理常式	shipments.checkpoints.handler	string	處理人員。
Message	shipments.checkpoints.message	string	訊息。
地點	shipments.checkpoints.location	string	位置。
城市	shipments.checkpoints.city	string	城市。
國家	shipments.checkpoints.country_name	string	國家。
國碼 (地區碼)	shipments.checkpoints.country_iso3	string	國家/地區代碼。
座標	shipments.checkpoints.coordinates	array of	座標。
State	shipments.checkpoints.state	string	國家。
郵遞區號	shipments.checkpoints.postal_code	string	郵遞區號。
檢查點時間	shipments.checkpoints.checkpoint_time	string	檢查點時間。
主要狀態	shipments.checkpoints.primary_status	string	主要狀態。

取得貨件

作業識別碼：: GetAShipment

取得貨件的詳細資料。

參數

名稱	機碼	必要	類型	Description
Easyship 貨件編號	easyship_shipment_id	True	string	Easyship 貨件識別碼。
格式	format		string	格式。
標籤	label		string	標籤。
商業發票	commercial_invoice		string	商業發票。
裝箱單	packing_slip		string	裝箱單。

傳回

名稱	路徑	類型	Description
創建於	created_at	string	建立時。
更新於	updated_at	string	更新時。
Easyship 貨件編號	easyship_shipment_id	string	Easyship 貨件識別器。
目的地名稱	destination_name	string	目的地名稱。
目的地位址	destination_address_line_1	string	目的地位址。
目的地地址行 2	destination_address_line_2	string	目的地位址行 2。
目的地城市	destination_city	string	目的地城市。
目的地狀態	destination_state	string	目的地狀態。
目的地郵遞區號	destination_postal_code	string	目的地郵遞區號。
目的地電話號碼	destination_phone_number	string	目的地電話號碼。
目的地電子郵件地址	destination_email_address	string	目的地電子郵件地址。
訂單備註	order_notes	string	命令說明。
訂單建立時間	order_created_at	string	創建的訂單。
平台名稱	platform_name	string	平台名稱。
平台訂單編號	platform_order_number	string	平台訂單號碼。
海關總值	total_customs_value	float	海關總價值。
總實際重量	total_actual_weight	float	總實際重量。
總體積重量	total_dimensional_weight	float	總體積重量。
總體積重量	total_volumetric_weight	float	總體積重量。
已投保	is_insured	boolean	是否投保。
貨幣	currency	string	貨幣。
倉儲狀態	warehouse_state	string	倉儲狀態。
名稱	origin_country.name	string	名稱。
國碼 (地區碼)	origin_country.alpha2	string	國家/地區代碼。
名稱	destination_country.name	string	名稱。
國碼 (地區碼)	destination_country.alpha2	string	國家/地區代碼。
物品	items	array of object
ID	items.id	string	唯一識別碼。
Description	items.title	string	描述。
SKU	items.sku	string	SKU。
寬度	items.width	integer	寬度。
長度	items.length	integer	長度。
高度	items.height	integer	高度。
實際重量	items.actual_weight	float	實際重量。
體積重量	items.dimensional_weight	float	體積重量。
體積重量	items.volumetric_weight	float	體積重量。
申報的海關價值	items.declared_customs_value	integer	申報的海關價值。
申報貨幣	items.declared_currency	string	宣告的貨幣。
原產地海關價值	items.origin_customs_value	float	原點海關價值。
原產地貨幣	items.origin_currency	string	原始貨幣。
類別	items.category	string	類別。
名稱	box.name	string	名稱。
長度	box.length	integer	長度。
寬度	box.width	integer	寬度。
高度	box.height	integer	高度。
ID	selected_courier.id	string	唯一識別碼。
名稱	selected_courier.name	string	名稱。
最短交貨時間	selected_courier.min_delivery_time	integer	最短交貨時間。
最長交貨時間	selected_courier.max_delivery_time	integer	最長交貨時間。
運費	selected_courier.shipment_charge	float	出貨費用。
燃油附加費	selected_courier.fuel_surcharge	float	燃油附加費。
偏遠地區附加費	selected_courier.remote_area_surcharge	integer	偏遠地區附加費。
出貨費用總額	selected_courier.shipment_charge_total	float	出貨費用總計。
倉庫手續費	selected_courier.warehouse_handling_fee	integer	倉庫手續費。
保險費	selected_courier.insurance_fee	integer	保險費。
進口稅	selected_courier.import_tax_charge	integer	進口稅。
進口關稅	selected_courier.import_duty_charge	integer	進口關稅。
DDP手續費	selected_courier.ddp_handling_fee	integer	DDP 手續費。
總費用	selected_courier.total_charge	float	總費用。
高於臨界值	selected_courier.is_above_threshold	boolean	是否高於閾值。
有效的國際貿易術語解釋通則	selected_courier.effective_incoterms	string	有效的國際貿易術語解釋通則。
預估進口稅	selected_courier.estimated_import_tax	integer	估計進口稅。
預計進口關稅	selected_courier.estimated_import_duty	integer	估計進口關稅。
快遞取件	selected_courier.courier_does_pickup	boolean	快遞員是否取件。
快遞投遞網址	selected_courier.courier_dropoff_url	string	快遞投遞 URL 位址。
快遞備註	selected_courier.courier_remarks	string	信使評論道。
收款人	selected_courier.payment_recipient	string	付款收款人。
為必填項目	shipping_documents.label.required	boolean	是否需要。
頁面大小	shipping_documents.label.page_size	string	頁面大小。
格式	shipping_documents.label.format	string	格式。
Base64 編碼字串	shipping_documents.label.base64_encoded_strings	array of string	Base64 編碼的字串。
URL	shipping_documents.label.url	string	URL 位址。
Message	shipping_documents.label.message	string	訊息。
為必填項目	shipping_documents.commercial_invoice.required	boolean	是否需要。
頁面大小	shipping_documents.commercial_invoice.page_size	string	頁面大小。
格式	shipping_documents.commercial_invoice.format	string	格式。
Base64 編碼字串	shipping_documents.commercial_invoice.base64_encoded_strings	array of	Base64 編碼的字串。
URL	shipping_documents.commercial_invoice.url	string	URL 位址。
為必填項目	shipping_documents.packing_slip.required	boolean	是否需要。
頁面大小	shipping_documents.packing_slip.page_size	string	頁面大小。
格式	shipping_documents.packing_slip.format	string	格式。
Base64 編碼字串	shipping_documents.packing_slip.base64_encoded_strings	array of string	Base64 編碼的字串。
URL	shipping_documents.packing_slip.url	string	URL 位址。
為必填項目	shipping_documents.battery_form.required	boolean	是否需要。
頁面大小	shipping_documents.battery_form.page_size	string	頁面大小。
格式	shipping_documents.battery_form.format	string	格式。
Base64 編碼字串	shipping_documents.battery_form.base64_encoded_strings	array of	Base64 編碼的字串。
URL	shipping_documents.battery_form.url	string	URL 位址。
為必填項目	shipping_documents.battery_caution_label.required	boolean	是否需要。
頁面大小	shipping_documents.battery_caution_label.page_size	string	頁面大小。
格式	shipping_documents.battery_caution_label.format	string	格式。
Base64 編碼字串	shipping_documents.battery_caution_label.base64_encoded_strings	array of	Base64 編碼的字串。
URL	shipping_documents.battery_caution_label.url	string	URL 位址。

取得追蹤狀態

作業識別碼：: GetStatus

擷取貨件的追蹤狀態。

參數

名稱	機碼	必要	類型	Description
Easyship 貨件 ID	easyship_shipment_id	True	string	Easyship 貨件識別碼。
平台訂單編號	platform_order_number		string	平台訂單號碼。
頁面	page		integer	頁面。
每頁	per_page		integer	每頁的數目。

傳回

名稱	路徑	類型	Description
總頁數	total_page	integer	總頁面。
當前頁面	current_page	integer	目前頁面。
出貨	shipments	array of object
Easyship 貨件編號	shipments.easyship_shipment_id	string	Easyship 貨件唯一識別碼。
平台訂單編號	shipments.platform_order_number	string	平台訂單號碼。
Origin	shipments.origin	string	原點。
目的地	shipments.destination	string	目的地。
地位	shipments.status	string	狀態。
追蹤號碼	shipments.tracking_number	string	追蹤號碼。
追蹤頁面網址	shipments.tracking_page_url	string	追蹤頁面網址。

取得項目類別

作業識別碼：: GetItemCategories

擷取貨件類別清單，以及要使用該類別的 slug。

傳回

名稱	路徑	類型	Description
類別	categories	array of object
名稱	categories.name	string	名稱。
動態資料欄位	categories.slug	string	蛞蝓。

建立貨件

作業識別碼：: CreateAShipment

建立並擷取有關貨件的資訊。

參數

名稱	機碼	類型	Description
Address	line_1	string	位址。
地址行 2	line_2	string	地址行 2.
State	state	string	國家。
城市	city	string	城市。
郵遞區號	postal_code	string	郵遞區號。
國碼 (地區碼)	country_alpha2	string	國家/地區代碼。
連絡人姓名	contact_name	string	聯絡人姓名。
公司名稱	company_name	string	公司名稱。
連絡人電話	contact_phone	string	聯絡電話號碼。
聯絡電子郵件	contact_email	string	聯絡電子郵件地址。
Address	line_1	string	位址。
地址行 2	line_2	string	地址行 2.
State	state	string	國家。
城市	city	string	城市。
郵遞區號	postal_code	string	郵遞區號。
國碼 (地區碼)	country_alpha2	string	國家/地區代碼。
連絡人姓名	contact_name	string	聯絡人姓名。
公司名稱	company_name	string	公司名稱。
連絡人電話	contact_phone	string	聯絡電話號碼。
聯絡電子郵件	contact_email	string	聯絡電子郵件地址。
Address	line_1	string	位址。
地址行 2	line_2	string	地址行 2.
State	state	string	國家。
城市	city	string	城市。
郵遞區號	postal_code	string	郵遞區號。
國碼 (地區碼)	country_alpha2	string	國家/地區代碼。
連絡人姓名	contact_name	string	聯絡人姓名。
公司名稱	company_name	string	公司名稱。
連絡人電話	contact_phone	string	聯絡電話號碼。
聯絡電子郵件	contact_email	string	聯絡電子郵件地址。
Address	line_1	string	位址。
地址行 2	line_2	string	地址行 2.
State	state	string	國家。
城市	city	string	城市。
郵遞區號	postal_code	string	郵遞區號。
國碼 (地區碼)	country_alpha2	string	國家/地區代碼。
連絡人姓名	contact_name	string	聯絡人姓名。
公司名稱	company_name	string	公司名稱。
連絡人電話	contact_phone	string	聯絡電話號碼。
聯絡電子郵件	contact_email	string	聯絡電子郵件地址。
設定為住宅	set_as_residential	boolean	是否設定為住宅。
收貨人稅號	consignee_tax_id	string	收貨人稅務識別碼。
EEI 參考	eei_reference	string	EEI 參考資料。
國際貿易術語解釋通則	incoterms	string	國際貿易術語解釋通則。
已投保	is_insured	boolean	是否投保。
保額	insured_amount	integer	保險金額。
保險貨幣	insured_currency	string	保險貨幣。
平台名稱	platform_name	string	平台名稱。
平台訂單編號	platform_order_number	string	平台訂單號碼。
訂單標籤清單	order_tag_list	array of string	訂單標籤清單。
賣家說明	seller_notes	string	賣家指出。
買家筆記	buyer_notes	string	買家指出。
選定的快遞 ID	selected_courier_id	string	選取的快遞識別碼。
允許快遞遞回退	allow_courier_fallback	boolean	是否允許快遞遞回退。
套用運送規則	apply_shipping_rules	boolean	是否應用了運輸規則。
Weight	weight	string	權數。
尺寸	dimensions	string	尺寸。
格式	format	string	格式。
標籤	label	string	標籤。
商業發票	commercial_invoice	string	商業發票。
裝箱單	packing_slip	string	裝箱單。
購買標籤	buy_label	boolean	是否購買了標籤。
購買 Label Synchronous	buy_label_synchronous	boolean	是否同步購買標籤。
總實際重量	total_actual_weight	float	總實際重量。
動態資料欄位	slug	string
長度	length	integer	長度。
寬度	width	integer	寬度。
高度	height	integer	高度。
Description	description	string	描述。
類別	category	string	類別。
SKU	sku	string	SKU。
數量	quantity	integer	數量。
長度	length	string	長度。
寬度	width	string	寬度。
高度	height	string	高度。
實際重量	actual_weight	integer	實際重量。
申報貨幣	declared_currency	string	宣告的貨幣。
申報的海關價值	declared_customs_value	integer	申報的海關價值。

傳回

名稱	路徑	類型	Description
地位	status	string	狀態。
Errors	errors	array of	錯誤。
Easyship 貨件編號	shipment.easyship_shipment_id	string	Easyship 貨件識別碼。
創建於	shipment.created_at	string	創建於。
更新於	shipment.updated_at	string	更新時。
標籤支付地點	shipment.label_paid_at	string	唱片公司支付了費用。
標籤產生於	shipment.label_generated_at	string	產生的標籤。
訂單建立時間	shipment.order_created_at	string	創建的訂單。
Address	shipment.origin_address.line_1	string	位址。
地址行 2	shipment.origin_address.line_2	string	地址行 2.
State	shipment.origin_address.state	string	國家。
城市	shipment.origin_address.city	string	城市。
郵遞區號	shipment.origin_address.postal_code	string	郵遞區號。
國碼 (地區碼)	shipment.origin_address.country_alpha2	string	國家/地區代碼。
連絡人姓名	shipment.origin_address.contact_name	string	聯絡人姓名。
公司名稱	shipment.origin_address.company_name	string	公司名稱。
連絡人電話	shipment.origin_address.contact_phone	string	聯絡電話號碼。
聯絡電子郵件	shipment.origin_address.contact_email	string	聯絡電子郵件地址。
Address	shipment.sender_address.line_1	string	位址。
地址行 2	shipment.sender_address.line_2	string	地址行 2.
State	shipment.sender_address.state	string	國家。
城市	shipment.sender_address.city	string	城市。
郵遞區號	shipment.sender_address.postal_code	string	郵遞區號。
國碼 (地區碼)	shipment.sender_address.country_alpha2	string	國家/地區代碼。
連絡人姓名	shipment.sender_address.contact_name	string	聯絡人姓名。
公司名稱	shipment.sender_address.company_name	string	公司名稱。
連絡人電話	shipment.sender_address.contact_phone	string	聯絡電話號碼。
聯絡電子郵件	shipment.sender_address.contact_email	string	聯絡電子郵件地址。
Address	shipment.return_address.line_1	string	位址。
地址行 2	shipment.return_address.line_2	string	地址行 2.
State	shipment.return_address.state	string	國家。
城市	shipment.return_address.city	string	城市。
郵遞區號	shipment.return_address.postal_code	string	郵遞區號。
國碼 (地區碼)	shipment.return_address.country_alpha2	string	國家/地區代碼。
連絡人姓名	shipment.return_address.contact_name	string	聯絡人姓名。
公司名稱	shipment.return_address.company_name	string	公司名稱。
連絡人電話	shipment.return_address.contact_phone	string	聯絡電話號碼。
聯絡電子郵件	shipment.return_address.contact_email	string	聯絡電子郵件地址。
Address	shipment.destination_address.line_1	string	位址。
地址行 2	shipment.destination_address.line_2	string	地址行 2.
State	shipment.destination_address.state	string	國家。
城市	shipment.destination_address.city	string	城市。
郵遞區號	shipment.destination_address.postal_code	string	郵遞區號。
國碼 (地區碼)	shipment.destination_address.country_alpha2	string	國家/地區代碼。
連絡人姓名	shipment.destination_address.contact_name	string	聯絡人姓名。
公司名稱	shipment.destination_address.company_name	string	公司名稱。
連絡人電話	shipment.destination_address.contact_phone	string	聯絡電話號碼。
聯絡電子郵件	shipment.destination_address.contact_email	string	聯絡電子郵件地址。
平台名稱	shipment.order_data.platform_name	string	平台名稱。
平台訂單編號	shipment.order_data.platform_order_number	string	平台訂單號碼。
訂單標籤清單	shipment.order_data.order_tag_list	array of string	訂單標籤清單。
賣家說明	shipment.order_data.seller_notes	string	賣家指出。
買家筆記	shipment.order_data.buyer_notes	string	買家指出。
設定為住宅	shipment.set_as_residential	boolean	是否設定為住宅。
收貨人稅號	shipment.consignee_tax_id	string	收貨人稅務識別碼。
EEI 參考	shipment.eei_reference	string	EEI 參考資料。
國際貿易術語解釋通則	shipment.incoterms	string	國際貿易術語解釋通則。
已投保	shipment.insurance.is_insured	boolean	是否投保。
保額	shipment.insurance.insured_amount	integer	保險金額。
保險貨幣	shipment.insurance.insured_currency	string	保險貨幣。
包裹數量	shipment.parcels_count	integer	包裹很重要。
包裹	shipment.parcels	array of object
總實際重量	shipment.parcels.total_actual_weight	float	總實際重量。
海關總值	shipment.parcels.total_customs_value	float	海關總價值。
總體積重量	shipment.parcels.total_dimensional_weight	float	總體積重量。
總體積重量	shipment.parcels.total_volumetric_weight	float	總體積重量。
ID	shipment.parcels.box.id	string	唯一識別碼。
動態資料欄位	shipment.parcels.box.slug	string	蛞蝓。
長度	shipment.parcels.box.length	integer	長度。
寬度	shipment.parcels.box.width	integer	寬度。
高度	shipment.parcels.box.height	integer	高度。
items	shipment.parcels.items	array of object
Description	shipment.parcels.items.description	string	描述。
類別	shipment.parcels.items.category	string	類別。
SKU	shipment.parcels.items.sku	string	SKU。
數量	shipment.parcels.items.quantity	integer	數量。
實際重量	shipment.parcels.items.actual_weight	integer	實際重量。
體積重量	shipment.parcels.items.dimensional_weight	integer	體積重量。
體積重量	shipment.parcels.items.volumetric_weight	integer	體積重量。
原產地貨幣	shipment.parcels.items.origin_currency	string	原始貨幣。
原產地海關價值	shipment.parcels.items.origin_customs_value	integer	原點海關價值。
申報貨幣	shipment.parcels.items.declared_currency	string	宣告的貨幣。
申報的海關價值	shipment.parcels.items.declared_customs_value	integer	申報的海關價值。
長度	shipment.parcels.items.dimensions.length	integer	長度。
寬度	shipment.parcels.items.dimensions.width	integer	寬度。
高度	shipment.parcels.items.dimensions.height	integer	高度。
海關總值	shipment.total_customs_value	float	海關總價值。
總實際重量	shipment.total_actual_weight	float	總實際重量。
總體積重量	shipment.total_dimensional_weight	float	總體積重量。
總體積重量	shipment.total_volumetric_weight	float	總體積重量。
出貨狀態	shipment.shipment_state	string	出貨狀態。
取件狀態	shipment.pickup_state	string	拾取狀態。
傳遞狀態	shipment.delivery_state	string	傳遞狀態。
標籤狀態	shipment.label_state	string	標籤狀態。
倉儲狀態	shipment.warehouse_state	string	倉儲狀態。
追蹤	shipment.trackings	array of object
追蹤號碼	shipment.trackings.tracking_number	string	追蹤號碼。
本地追蹤號碼	shipment.trackings.local_tracking_number	string	本地追蹤號碼。
備用追蹤號碼	shipment.trackings.alternate_tracking_number	string	替代追蹤號碼。
腿號	shipment.trackings.leg_number	integer	腿號。
處理常式	shipment.trackings.handler	string	處理人員。
追蹤狀態	shipment.trackings.tracking_state	string	追蹤狀態。
追蹤頁面網址	shipment.tracking_page_url	string	追蹤頁面URL。
運輸文件	shipment.shipping_documents	array of object
類別	shipment.shipping_documents.category	string	類別。
為必填項目	shipment.shipping_documents.required	boolean	是否需要。
頁面大小	shipment.shipping_documents.page_size	string	頁面大小。
格式	shipment.shipping_documents.format	string	格式。
Base64 編碼字串	shipment.shipping_documents.base64_encoded_strings	array of string	Base64 編碼的字串。
URL	shipment.shipping_documents.url	string	URL 位址。
貨幣	shipment.currency	string	貨幣。
ID	shipment.selected_courier.id	string	唯一識別碼。
費率	shipment.rates	array of object
快遞員 ID	shipment.rates.courier_id	string	快遞識別碼。
快遞公司名稱	shipment.rates.courier_name	string	快遞員名稱。
最短交貨時間	shipment.rates.min_delivery_time	integer	最短交貨時間。
最長交貨時間	shipment.rates.max_delivery_time	integer	最長交貨時間。
物有所值排名	shipment.rates.value_for_money_rank	integer	物有所值的排名。
交貨時間排名	shipment.rates.delivery_time_rank	integer	交貨時間排名。
運費	shipment.rates.shipment_charge	float	出貨費用。
燃油附加費	shipment.rates.fuel_surcharge	float	燃油附加費。
偏遠地區附加費	shipment.rates.remote_area_surcharge	integer	偏遠地區附加費。
超大附加費	shipment.rates.oversized_surcharge	integer	超大的附加費。
附加服務附加費	shipment.rates.additional_services_surcharge	integer	附加服務附加費。
住宿全額費用	shipment.rates.residential_full_fee	integer	住宿全額費用。
住宅折扣費	shipment.rates.residential_discounted_fee	integer	住宅折扣費。
出貨費用總額	shipment.rates.shipment_charge_total	float	出貨費用總計。
倉庫手續費	shipment.rates.warehouse_handling_fee	integer	倉庫手續費。
保險費	shipment.rates.insurance_fee	integer	保險費。
營業稅	shipment.rates.sales_tax	integer	銷售稅。
省級銷售稅	shipment.rates.provincial_sales_tax	integer	省級銷售稅。
DDP手續費	shipment.rates.ddp_handling_fee	integer	DDP 手續費。
進口稅	shipment.rates.import_tax_charge	integer	進口稅變化。
進口關稅	shipment.rates.import_duty_charge	integer	進口關稅。
總費用	shipment.rates.total_charge	float	總費用。
高於臨界值	shipment.rates.is_above_threshold	boolean	是否高於閾值。
國際貿易術語解釋通則	shipment.rates.incoterms	string	國際貿易術語解釋通則。
預估進口稅	shipment.rates.estimated_import_tax	integer	預估進口稅。
預計進口關稅	shipment.rates.estimated_import_duty	integer	估計進口關稅。
可用的移交選項	shipment.rates.available_handover_options	string	可用的移交選項。
追蹤評級	shipment.rates.tracking_rating	integer	追蹤評級。
Easyship 評級	shipment.rates.easyship_rating	integer	Easyship 評級。
快遞備註	shipment.rates.courier_remarks	string	信使評論道。
收款人	shipment.rates.payment_recipient	string	付款收款人。
Code	shipment.rates.discount.code	string	代碼。
總數	shipment.rates.discount.amount	integer	金額。
過期時間	shipment.rates.discount.expires_at	string	到期時間。
百分比	shipment.rates.discount.percentage	string	百分比。
有效的國際貿易術語解釋通則	shipment.rates.effective_incoterms	string	有效的國際貿易術語解釋通則。

更新倉儲狀態

作業識別碼：: UpdateWarehouseState

更新貨件的倉庫狀態。僅適用於在 Easyship 綜合倉庫之一履行的貨件。

參數

名稱	機碼	類型	Description
Easyship 貨件編號	easyship_shipment_id	string	Easyship 貨件唯一識別碼。
倉儲狀態	warehouse_state	string	倉儲狀態。
Message	message	string	訊息。
序號	serial_number	string	序號。

傳回

名稱	路徑	類型	Description
Message	message	array of object
Easyship 貨件編號	message.easyship_shipment_id	string	Easyship 貨件唯一識別碼。
倉庫狀態已更新	message.warehouse_state_updated	string	更新的倉儲狀態。

更新貨件

作業識別碼：: UpdateAShipment

更新貨件詳細資料。

參數

名稱	機碼	必要	類型	Description
Easyship 貨件編號	easyship_shipment_id	True	string	Easyship 貨件識別碼。
目的地國家代碼	destination_country_alpha2		string	目的地國家/地區代碼。
目的地城市	destination_city		string	目的地城市。
目的地名稱	destination_name		string	目的地名稱。
目的地位址	destination_address_line_1		string	目的地位址。
目的地電話號碼	destination_phone_number		string	目的地電話號碼。
Description	description		string	描述。
實際重量	actual_weight		float	實際重量。
高度	height		integer	高度。
寬度	width		integer	寬度。
長度	length		integer	長度。
類別	category		string	類別。
申報貨幣	declared_currency		string	宣告的貨幣。
申報的海關價值	declared_customs_value		integer	申報的海關價值。
SKU	sku		string	SKU。
平台名稱	platform_name		string	平台名稱。
平台訂單編號	platform_order_number		string	平台訂單號碼。
繳納的稅款	taxes_duties_paid_by		string	繳納的稅款和關稅。
已投保	is_insured		boolean	是否投保。
選定的快遞 ID	selected_courier_id		string	選取的快遞識別碼。
目的地郵遞區號	destination_postal_code		integer	目的地郵遞區號。
目的地狀態	destination_state		string	目的地狀態。
目的地地址行 2	destination_address_line_2		string	目的地位址行 2。
目的地電子郵件地址	destination_email_address		string	目的地電子郵件地址。

傳回

名稱	路徑	類型	Description
創建於	shipment.created_at	string	創建於。
更新於	shipment.updated_at	string	更新時。
Easyship 貨件編號	shipment.easyship_shipment_id	string	Easyship 貨件識別碼。
目的地名稱	shipment.destination_name	string	目的地名稱。
目的地位址	shipment.destination_address_line_1	string	目的地位址。
目的地地址行 2	shipment.destination_address_line_2	string	目的地位址行 2。
目的地城市	shipment.destination_city	string	目的地城市。
目的地狀態	shipment.destination_state	string	目的地狀態。
目的地郵遞區號	shipment.destination_postal_code	string	目的地郵遞區號。
目的地電話號碼	shipment.destination_phone_number	string	目的地電話號碼。
目的地電子郵件地址	shipment.destination_email_address	string	目的地電子郵件地址。
平台名稱	shipment.platform_name	string	平台名稱。
平台訂單編號	shipment.platform_order_number	string	平台訂單號碼。
海關總值	shipment.total_customs_value	float	海關總價值。
總實際重量	shipment.total_actual_weight	float	總實際重量。
總體積重量	shipment.total_dimensional_weight	float	總體積重量。
總體積重量	shipment.total_volumetric_weight	float	總體積重量。
已投保	shipment.is_insured	boolean	是否投保。
貨幣	shipment.currency	string	貨幣。
名稱	shipment.origin_country.name	string	名稱。
國碼 (地區碼)	shipment.origin_country.alpha2	string	國家/地區代碼。
名稱	shipment.destination_country.name	string	名稱。
國碼 (地區碼)	shipment.destination_country.alpha2	string	國家/地區代碼。
物品	shipment.items	array of object
ID	shipment.items.id	string	唯一識別碼。
Description	shipment.items.description	string	描述。
SKU	shipment.items.sku	string	SKU。
寬度	shipment.items.width	integer	寬度。
長度	shipment.items.length	integer	長度。
高度	shipment.items.height	integer	高度。
實際重量	shipment.items.actual_weight	float	實際重量。
體積重量	shipment.items.dimensional_weight	float	體積重量。
體積重量	shipment.items.volumetric_weight	float	columetric 重量。
申報的海關價值	shipment.items.declared_customs_value	integer	申報的海關價值。
申報貨幣	shipment.items.declared_currency	string	宣告的貨幣。
原產地海關價值	shipment.items.origin_customs_value	float	原點海關價值。
原產地貨幣	shipment.items.origin_currency	string	原始貨幣。
類別	shipment.items.category	string	類別。
名稱	shipment.box.name	string	名稱。
長度	shipment.box.length	integer	長度。
寬度	shipment.box.width	integer	寬度。
高度	shipment.box.height	integer	高度。
ID	shipment.selected_courier.id	string	唯一識別碼。
名稱	shipment.selected_courier.name	string	名稱。
最短交貨時間	shipment.selected_courier.min_delivery_time	integer	最短交貨時間。
最長交貨時間	shipment.selected_courier.max_delivery_time	integer	最長交貨時間。
運費	shipment.selected_courier.shipment_charge	float	出貨費用。
燃油附加費	shipment.selected_courier.fuel_surcharge	float	燃油附加費。
偏遠地區附加費	shipment.selected_courier.remote_area_surcharge	integer	偏遠地區附加費。
出貨費用總額	shipment.selected_courier.shipment_charge_total	float	出貨費用總計。
倉庫手續費	shipment.selected_courier.warehouse_handling_fee	integer	倉庫手續費。
保險費	shipment.selected_courier.insurance_fee	integer	保險費。
進口稅	shipment.selected_courier.import_tax_charge	integer	進口稅。
進口關稅	shipment.selected_courier.import_duty_charge	integer	進口關稅。
DDP手續費	shipment.selected_courier.ddp_handling_fee	integer	DDP 手續費。
總費用	shipment.selected_courier.total_charge	float	總費用。
高於臨界值	shipment.selected_courier.is_above_threshold	boolean	是否高於閾值。
有效的國際貿易術語解釋通則	shipment.selected_courier.effective_incoterms	string	有效的國際貿易術語解釋通則。
預估進口稅	shipment.selected_courier.estimated_import_tax	integer	估計進口稅。
預計進口關稅	shipment.selected_courier.estimated_import_duty	integer	估計進口稅。
快遞取件	shipment.selected_courier.courier_does_pickup	boolean	快遞員是否取件。
快遞投遞網址	shipment.selected_courier.courier_dropoff_url	string	快遞投遞 URL 位址。
快遞備註	shipment.selected_courier.courier_remarks	string	信使評論道。
收款人	shipment.selected_courier.payment_recipient	string	付款收款人。
費率	shipment.rates	array of object
快遞員 ID	shipment.rates.courier_id	string	快遞識別碼。
快遞公司名稱	shipment.rates.courier_name	string	快遞員名稱。
最短交貨時間	shipment.rates.min_delivery_time	integer	最短交貨時間。
最長交貨時間	shipment.rates.max_delivery_time	integer	最長交貨時間。
物有所值排名	shipment.rates.value_for_money_rank	integer	物有所值的排名。
交貨時間排名	shipment.rates.delivery_time_rank	integer	交貨時間排名。
運費	shipment.rates.shipment_charge	float	出貨費用。
燃油附加費	shipment.rates.fuel_surcharge	float	燃油附加費。
偏遠地區附加費	shipment.rates.remote_area_surcharge	integer	偏遠地區附加費。
出貨費用總額	shipment.rates.shipment_charge_total	float	出貨費用總計。
倉庫手續費	shipment.rates.warehouse_handling_fee	integer	倉庫手續費。
保險費	shipment.rates.insurance_fee	integer	保險費。
DDP手續費	shipment.rates.ddp_handling_fee	integer	DDP 手續費。
進口稅	shipment.rates.import_tax_charge	integer	進口稅變化。
進口關稅	shipment.rates.import_duty_charge	integer	進口關稅。
總費用	shipment.rates.total_charge	float	總費用。
高於臨界值	shipment.rates.is_above_threshold	boolean	是否高於閾值。
有效的國際貿易術語解釋通則	shipment.rates.effective_incoterms	string	有效的國際貿易術語解釋通則。
預估進口稅	shipment.rates.estimated_import_tax	integer	預估進口稅。
預計進口關稅	shipment.rates.estimated_import_duty	integer	估計進口關稅。
快遞取件	shipment.rates.courier_does_pickup	boolean	快遞員是否取件。
快遞投遞網址	shipment.rates.courier_dropoff_url	string	快遞投遞 URL 位址。
追蹤評級	shipment.rates.tracking_rating	integer	追蹤評級。
Easyship 評級	shipment.rates.easyship_rating	float	Easyship 評級。
快遞備註	shipment.rates.courier_remarks	string	信使評論道。
收款人	shipment.rates.payment_recipient	string	付款收款人。

獲取稅率和稅金

作業識別碼：: GetRatesTaxes

擷取預期出貨的出貨報價清單。

參數

名稱	機碼	類型	Description
Address	line_1	string	位址。
地址行 2	line_2	string	地址行 2.
State	state	string	國家。
城市	city	string	城市。
郵遞區號	postal_code	string	郵遞區號。
國碼 (地區碼)	country_alpha2	string	國家/地區代碼。
Address	line_1	string	位址。
地址行 2	line_2	string	地址行 2.
State	state	string	國家。
城市	city	string	城市。
郵遞區號	postal_code	string	郵遞區號。
國碼 (地區碼)	country_alpha2	string	國家/地區代碼。
國際貿易術語解釋通則	incoterms	string	國際貿易術語解釋通則。
已投保	is_insured	boolean	是否投保。
保額	insured_amount	integer	保險金額。
保險貨幣	insured_currency	string	保險貨幣。
套用運送規則	apply_shipping_rules	boolean	是否應用了運輸規則。
Weight	weight	string	權數。
尺寸	dimensions	string	尺寸。
輸出貨幣	output_currency	string	輸出貨幣。
總實際重量	total_actual_weight	float	總實際重量。
動態資料欄位	slug	string	參考蛞蝓。
長度	length	integer	長度。
寬度	width	integer	寬度。
高度	height	integer	高度。
Description	description	string	描述。
類別	category	string	類別。
SKU	sku	string	SKU。
數量	quantity	integer	數量。
長度	length	string	長度。
寬度	width	string	寬度。
高度	height	string	高度。
實際重量	actual_weight	integer	實際重量。
申報貨幣	declared_currency	string	宣告的貨幣。
申報的海關價值	declared_customs_value	integer	申報的海關價值。

傳回

名稱	路徑	類型	Description
費率	rates	array of object
快遞員 ID	rates.courier_id	string	快遞唯一識別碼。
快遞公司名稱	rates.courier_name	string	快遞員名稱。
最短交貨時間	rates.min_delivery_time	integer	最短交貨時間。
最長交貨時間	rates.max_delivery_time	integer	最長交貨時間。
物有所值排名	rates.value_for_money_rank	integer	物有所值的排名。
交貨時間排名	rates.delivery_time_rank	integer	交貨時間排名。
運費	rates.shipment_charge	float	出貨費用。
燃油附加費	rates.fuel_surcharge	float	燃油附加費。
偏遠地區附加費	rates.remote_area_surcharge	integer	偏遠地區附加費。
出貨費用總額	rates.shipment_charge_total	float	出貨費用總計。
倉庫手續費	rates.warehouse_handling_fee	integer	倉庫手續費。
保險費	rates.insurance_fee	integer	保險費。
DDP手續費	rates.ddp_handling_fee	integer	如果國際貿易術語解釋通則為DDP，則DDP手續費。
進口稅	rates.import_tax_charge	integer	進口稅。
進口關稅	rates.import_duty_charge	integer	進口關稅。
總費用	rates.total_charge	float	總費用。
高於臨界值	rates.is_above_threshold	boolean	是否高於閾值。
有效的國際貿易術語解釋通則	rates.effective_incoterms	string	有效的國際貿易術語解釋通則。
預估進口稅	rates.estimated_import_tax	integer	預估進口稅。
預計進口關稅	rates.estimated_import_duty	integer	估計進口關稅。
快遞取件	rates.courier_does_pickup	boolean	快遞員是否取件。
快遞投遞網址	rates.courier_dropoff_url	string	快遞投遞 URL 位址。
追蹤評級	rates.tracking_rating	integer	追蹤評級。
收款人	rates.payment_recipient	string	付款收款人。
快遞備註	rates.courier_remarks	string	信使評論道。
貨幣	rates.currency	string	貨幣。
名稱	rates.box.name	string	名稱。
長度	rates.box.length	integer	長度。
寬度	rates.box.width	integer	寬度。
高度	rates.box.height	integer	高度。
最低接送費	rates.minimum_pickup_fee	integer	最低取件費。
Description	rates.title	string	描述。
完整說明	rates.full_description	string	完整描述。

要求取件（V1）

作業識別碼：: RequestAPickup

建立取件後，將直接向快遞員提出取件請求，快遞員將傳回參考號。聯絡快遞公司的客服時可能會使用參考號。必須選擇取貨時段;可以使用“獲取可用的拾取位置”操作找到即將到來的拾取位置。

參數

名稱	機碼	類型	Description
快遞員 ID	courier_id	string	快遞識別碼。
首選日期	preferred_date	string	首選日期。
偏好最大時間	preferred_max_time	string	偏好的時間上限。
偏好的最小時間	preferred_min_time	string	偏好的最短時間。
Easyship 貨件 ID	easyship_shipment_ids	array of string	Easyship 貨件識別器。

傳回

名稱	路徑	類型	Description
快遞員 ID	courier_id	string	快遞識別碼。
快遞公司名稱	courier_name	string	快遞員名稱。
Easyship 貨件 ID	easyship_shipment_ids	array of string	Easyship 貨件識別碼。
Easyship 取件 ID	pickup.easyship_pickup_id	string	Easyship 取件識別碼。
偏好的最小時間	pickup.preferred_min_time	string	偏好的最短時間。
偏好最大時間	pickup.preferred_max_time	string	偏好的時間上限。
取件參考編號	pickup.pickup_reference_number	string	取貨參考號碼。
取件費	pickup.pickup_fee	string	取貨費。
提供者名稱	pickup.provider_name	string	提供者名稱。
提供者客戶服務電話	pickup.provider_customer_service_phone	string	提供者客戶服務電話號碼。
出貨量	pickup.shipments_count	string	發貨很重要。
總實際重量	pickup.total_actual_weight	string	總實際重量。
取件狀態	pickup.pickup_state	string	拾取狀態。
Address	pickup.address.line_1	string	位址。
地址行 2	pickup.address.line_2	string	地址行 2.
地址行 3	pickup.address.line_3	string	地址行 3.
郵遞區號	pickup.address.postal_code	string	郵遞區號。
城市	pickup.address.city	string	城市。
State	pickup.address.state	string	國家。
國家	pickup.address.country	string	國家。
聯絡電子郵件	pickup.address.contact_email	string	聯絡電子郵件地址。
連絡人電話	pickup.address.contact_phone	string	聯絡電話號碼。
公司名稱	pickup.address.company_name	string	公司名稱。
連絡人姓名	pickup.address.contact_name	string	聯絡人姓名。

購買貨件標籤（V1）

作業識別碼：: BuyAShipmentLabel

購買和擷取運送標籤的相關資訊。

參數

名稱	機碼	必要	類型	Description
Easyship 貨件編號	easyship_shipment_id		string	Easyship 貨件唯一識別碼。
快遞員 ID	courier_id		string	快遞唯一識別碼。

傳回

名稱	路徑	類型	Description
Message	message	string	訊息。
Errors	errors	array of	錯誤。
總成本	total_cost	integer	總成本。
可用餘額	available_balance	integer	可用餘額。
Labels	labels	array of object
Easyship 貨件編號	labels.easyship_shipment_id	string	Easyship 貨件唯一識別碼。
標籤狀態	labels.label_state	string	標籤的狀態。
標籤網址	labels.label_url	string	標籤的 URL 位址。
地位	labels.status	string	狀態。
追蹤號碼	labels.tracking_number	string	追蹤號碼。
追蹤頁面網址	labels.tracking_page_url	string	追蹤頁面網址。

共用方式為

Easyship （獨立發行商） （預覽版）