ShipStation(預覽)
ShipStation 是領先的線上運輸軟體,協助線上零售商簡化訂單履行流程,無論在哪裡、以何種方式運送。
此連接器適用於以下產品和區域:
| Service | Class | Regions |
|---|---|---|
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure中國地區 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | Microsoft動力學 |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| iomdri@microsoft.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | Microsoft |
| 網站 | https://www.shipstation.com/ |
| 隱私策略 | https://www.shipstation.com/privacy-policy/ |
| 類別 | Productivity |
此連接器專為 Dynamics 365 智慧訂單管理的 ShipStation 供應商整合而開發。
先決條件
需要 ShipStation 開發者帳號。 如果你沒有,也可以在 https://www.shipstation.com/docs/api/requirements/. 注意:建議使用此連接器來設定 Dynamics 365 智慧訂單管理 ShipStation 供應商。
如何取得認證
ShipStation 需要 API 金鑰和 Secret 來進行認證。 你可以產生一個令牌 https://ship13.shipstation.com/settings/api ,並用它來設定連接器。
開始使用連接器
用 API 金鑰和 Secret 設定連線。 想了解更多 ShipStation 的 API 資訊,請閱讀公開文件: https://www.shipstation.com/docs/api/
已知問題與限制
此連接器專為 Dynamics 365 智慧訂單管理的 ShipStation 供應商整合而開發。 對 Dynamics 365 Intelligent Order Management 以外的使用案例的支援將受到限制。
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有地區 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | 說明 | Required |
|---|---|---|---|
| 使用者名稱 | 安全字串 | 此 API 的使用者名稱 | 對 |
| 密碼 | 安全字串 | 此 API 的密碼 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 建立或更新訂單 |
若指定 orderKey,該方法將成為冪等元,且帶有該鍵的現有排序將被更新。 注意:只有在 ShipStation 中處於開放狀態的訂單(awaiting_payment、awaiting_shipment 和 on_hold)才能透過此方法更新。 取消與發貨的 API 被鎖定,無法修改。 |
| 為訂單建立標籤 |
為特定訂單建立運送標籤。 回覆中回傳的 labelData 欄位為 base64 編碼的 PDF 值。 只要解碼並儲存為 PDF 檔案,即可取得可列印的標籤。 |
| 獲取訂單 |
從資料庫中擷取單一訂單。 |
建立或更新訂單
若指定 orderKey,該方法將成為冪等元,且帶有該鍵的現有排序將被更新。 注意:只有在 ShipStation 中處於開放狀態的訂單(awaiting_payment、awaiting_shipment 和 on_hold)才能透過此方法更新。 取消與發貨的 API 被鎖定,無法修改。
傳回
為訂單建立標籤
為特定訂單建立運送標籤。 回覆中回傳的 labelData 欄位為 base64 編碼的 PDF 值。 只要解碼並儲存為 PDF 檔案,即可取得可列印的標籤。
傳回
獲取訂單
從資料庫中擷取單一訂單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
獲取訂單
|
orderId | True | double |
系統會產生訂單的識別碼。 |
傳回
觸發程序
| 訂閱 Webhook |
訂閱特定類型的 webhook。 如果有 store_id 傳入,webhook 只會針對該特定store_id觸發。 傳遞的事件類型將決定將傳送哪種類型的 webhook。必須包含以下其中一個值:ORDER_NOTIFY、ITEM_ORDER_NOTIFY、SHIP_NOTIFY、ITEM_SHIP_NOTIFY、API_TRACK。 |
訂閱 Webhook
訂閱特定類型的 webhook。 如果有 store_id 傳入,webhook 只會針對該特定store_id觸發。 傳遞的事件類型將決定將傳送哪種類型的 webhook。必須包含以下其中一個值:ORDER_NOTIFY、ITEM_ORDER_NOTIFY、SHIP_NOTIFY、ITEM_SHIP_NOTIFY、API_TRACK。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
事件
|
event | True | string |
定義
GetOrder回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訂單編號
|
orderId | integer | |
|
訂單號碼
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
訂單日期
|
orderDate | string | |
|
創建日期
|
createDate | string | |
|
修改日期
|
modifyDate | string | |
|
付款日期
|
paymentDate | string | |
|
船隻過日
|
shipByDate | string | |
|
訂單狀態
|
orderStatus | string | |
|
客戶ID
|
customerId | integer | |
|
客戶用戶名稱
|
customerUsername | string | |
|
客戶電子郵件
|
customerEmail | string | |
|
帳單至
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
項目
|
items | array of Item | |
|
訂單總數
|
orderTotal | double | |
|
金額已支付
|
amountPaid | double | |
|
稅額
|
taxAmount | float | |
|
shipping金額
|
shippingAmount | float | |
|
客戶筆記
|
customerNotes | string | |
|
內部註解
|
internalNotes | string | |
|
禮物
|
gift | boolean | |
|
gift訊息
|
giftMessage | string | |
|
付款方式
|
paymentMethod | string | |
|
請求運送服務
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
服務代碼
|
serviceCode | string | |
|
套件代碼
|
packageCode | string | |
|
確認
|
confirmation | string | |
|
shipDate 發貨日期
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
重量
|
weight | Weight | |
|
維度
|
dimensions | Dimensions | |
|
保險選項
|
insuranceOptions | InsuranceOptions | |
|
國際期權
|
internationalOptions | InternationalOptions | |
|
進階期權
|
advancedOptions | AdvancedOptions | |
|
tagIds 標籤
|
tagIds | string | |
|
userId
|
userId | string | |
|
外部實現
|
externallyFulfilled | boolean | |
|
外部實現者
|
externallyFulfilledBy | string |
帳單至
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名字
|
name | string | |
|
company
|
company | string | |
|
街道1
|
street1 | string | |
|
街道2
|
street2 | string | |
|
街道3
|
street3 | string | |
|
城市
|
city | string | |
|
狀態
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
住宅的
|
residential | string | |
|
地址已驗證
|
addressVerified | string |
ShipTo
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名字
|
name | string | |
|
company
|
company | string | |
|
街道1
|
street1 | string | |
|
街道2
|
street2 | string | |
|
街道3
|
street3 | string | |
|
城市
|
city | string | |
|
狀態
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
住宅的
|
residential | boolean | |
|
地址已驗證
|
addressVerified | string |
Option
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名字
|
name | string | |
|
value
|
value | string |
維度
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
單位
|
units | string | |
|
length
|
length | float | |
|
寬度
|
width | float | |
|
height
|
height | float |
保險選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
提供者
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
保險價值
|
insuredValue | float |
國際期權
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
contents
|
contents | string | |
|
海關物品
|
customsItems | array of CustomsItem | |
|
非交付
|
nonDelivery | string |
海關項目
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
描述
|
description | string | |
|
數量
|
quantity | float | |
|
value
|
value | float | |
|
harmonizedTariffCode
|
harmonizedTariffCode | string | |
|
起源國
|
countryOfOrigin | string |
進階期權
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
warehouseId
|
warehouseId | integer | |
|
不可加工
|
nonMachinable | boolean | |
|
星期六送貨
|
saturdayDelivery | boolean | |
|
含有酒精
|
containsAlcohol | boolean | |
|
合併或分裂
|
mergedOrSplit | boolean | |
|
合併的
|
mergedIds | array of string | |
|
parentId
|
parentId | string | |
|
儲存標識
|
storeId | integer | |
|
自訂欄位1
|
customField1 | string | |
|
自訂欄位2
|
customField2 | string | |
|
自訂欄位3
|
customField3 | string | |
|
來源
|
source | string | |
|
billToParty
|
billToParty | string | |
|
billToAccount
|
billToAccount | string | |
|
billToPostalCode(郵遞區號)
|
billToPostalCode | string | |
|
billToCountryCode
|
billToCountryCode | string |
Item
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
lineItemKey(線條說明)
|
lineItemKey | string | |
|
sku
|
sku | string | |
|
名字
|
name | string | |
|
imageUrl
|
imageUrl | string | |
|
重量
|
weight | Weight | |
|
數量
|
quantity | float | |
|
單價
|
unitPrice | double | |
|
稅額
|
taxAmount | double | |
|
shipping金額
|
shippingAmount | double | |
|
倉庫位置
|
warehouseLocation | string | |
|
options
|
options | array of Option | |
|
產品ID
|
productId | integer | |
|
實現Sku
|
fulfillmentSku | string | |
|
調整
|
adjustment | boolean | |
|
UPC的
|
upc | string |
重量
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
value
|
value | float | |
|
單位
|
units | string |
CreateLabelforOrderResponse
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
shipmentID
|
shipmentId | integer | |
|
運費
|
shipmentCost | double | |
|
保險成本
|
insuranceCost | float | |
|
trackingNumber
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse(更新排序回應)
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訂單編號
|
orderId | integer | |
|
訂單號碼
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
訂單日期
|
orderDate | string | |
|
創建日期
|
createDate | string | |
|
修改日期
|
modifyDate | string | |
|
付款日期
|
paymentDate | string | |
|
船隻過日
|
shipByDate | string | |
|
訂單狀態
|
orderStatus | string | |
|
客戶ID
|
customerId | integer | |
|
客戶用戶名稱
|
customerUsername | string | |
|
客戶電子郵件
|
customerEmail | string | |
|
帳單至
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
項目
|
items | array of Item | |
|
訂單總數
|
orderTotal | double | |
|
金額已支付
|
amountPaid | double | |
|
稅額
|
taxAmount | float | |
|
shipping金額
|
shippingAmount | float | |
|
客戶筆記
|
customerNotes | string | |
|
內部註解
|
internalNotes | string | |
|
禮物
|
gift | boolean | |
|
gift訊息
|
giftMessage | string | |
|
付款方式
|
paymentMethod | string | |
|
請求運送服務
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
服務代碼
|
serviceCode | string | |
|
套件代碼
|
packageCode | string | |
|
確認
|
confirmation | string | |
|
shipDate 發貨日期
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
重量
|
weight | Weight | |
|
維度
|
dimensions | Dimensions | |
|
保險選項
|
insuranceOptions | InsuranceOptions | |
|
國際期權
|
internationalOptions | InternationalOptions | |
|
進階期權
|
advancedOptions | AdvancedOptions | |
|
tagIds 標籤
|
tagIds | string | |
|
userId
|
userId | string | |
|
外部實現
|
externallyFulfilled | boolean | |
|
外部實現者
|
externallyFulfilledBy | string |