ShipStation (プレビュー)
ShipStationは、オンライン小売業者が販売する場所や出荷場所を問わず、注文のフルフィルメントを合理化するのに役立つ、主要なWebベースの出荷ソフトウェアです。
このコネクタは、次の製品とリージョンで使用できます。
| Service | クラス | リージョン |
|---|---|---|
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - 中国リージョンAzure - 米国国防総省 (DoD) |
| 連絡先 | |
|---|---|
| 名前 | マイクロソフト・ダイナミクス |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| iomdri@microsoft.com |
| コネクタ メタデータ | |
|---|---|
| 発行者 | マイクロソフト |
| ウェブサイト | https://www.shipstation.com/ |
| プライバシー ポリシー | https://www.shipstation.com/privacy-policy/ |
| カテゴリ | 生産性 |
このコネクタは、Dynamics 365 Intelligent Order Management の ShipStation プロバイダー統合に使用するために特別に開発されました。
前提条件
ShipStation 開発者アカウントが必要です。 お持ちでない場合は、 https://www.shipstation.com/docs/api/requirements/で作成できます。 注: このコネクタを使用して、Dynamics 365 Intelligent Order Management ShipStation プロバイダーを設定することをお勧めします。
資格情報を取得する方法
ShipStation では、認証に API キーとシークレットが必要です。 トークン https://ship13.shipstation.com/settings/api を生成し、これを使用してコネクタを構成できます。
コネクタの概要
API キーとシークレットを使用して接続を構成します。 ShipStation の API の詳細については、パブリック ドキュメントを参照してください。 https://www.shipstation.com/docs/api/
既知の問題と制限事項
このコネクタは、Dynamics 365 Intelligent Order Management の ShipStation プロバイダー統合に使用するために特別に開発されました。 Dynamics 365 Intelligent Order Management 以外のユースケースのサポートは制限されます。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| ユーザー名 | securestring | この API のユーザー名 | 正しい |
| パスワード | securestring | この API のパスワード | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 注文のラベルを作成する |
特定の注文の配送先住所ラベルを作成します。 応答で返される labelData フィールドは、base64 でエンコードされた PDF 値です。 出力をデコードして PDF ファイルとして保存するだけで、印刷可能なラベルを取得できます。 |
| 注文の作成または更新 |
orderKey が指定されている場合、メソッドはべき等になり、そのキーを持つ既存の順序が更新されます。 注: ShipStation (awaiting_payment、awaiting_shipment、およびon_hold) のオープンステータスの注文のみが、この方法で更新できます。 取り消されて出荷された場合、API を使用して変更がロックされます。 |
| 注文を取得する |
データベースから 1 つの注文を取得します。 |
注文のラベルを作成する
特定の注文の配送先住所ラベルを作成します。 応答で返される labelData フィールドは、base64 でエンコードされた PDF 値です。 出力をデコードして PDF ファイルとして保存するだけで、印刷可能なラベルを取得できます。
戻り値
注文の作成または更新
orderKey が指定されている場合、メソッドはべき等になり、そのキーを持つ既存の順序が更新されます。 注: ShipStation (awaiting_payment、awaiting_shipment、およびon_hold) のオープンステータスの注文のみが、この方法で更新できます。 取り消されて出荷された場合、API を使用して変更がロックされます。
戻り値
注文を取得する
データベースから 1 つの注文を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
注文を取得する
|
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のいずれかの値を含む必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
イベント
|
event | True | string |
定義
GetOrderResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
注文ID
|
orderId | integer | |
|
注文番号
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
注文日
|
orderDate | string | |
|
作成日
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
paymentDate
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
顧客メール
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
アイテム
|
items | array of Item | |
|
orderTotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
税額
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
ギフト
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
paymentMethod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
確認
|
confirmation | string | |
|
ship日付
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
重量
|
weight | Weight | |
|
ディメンション
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |
BillTo
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string | |
|
company
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
都市
|
city | string | |
|
状態
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
住宅
|
residential | string | |
|
addressVerified
|
addressVerified | string |
ShipTo
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string | |
|
company
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
都市
|
city | string | |
|
状態
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
住宅
|
residential | boolean | |
|
addressVerified
|
addressVerified | string |
オプション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string | |
|
value
|
value | string |
ディメンション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
単位
|
units | string | |
|
長さ
|
length | float | |
|
幅
|
width | float | |
|
高さ
|
height | float |
InsuranceOptions
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
プロバイダ
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
insuredValue
|
insuredValue | float |
InternationalOptions
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
contents
|
contents | string | |
|
customItems
|
customsItems | array of CustomsItem | |
|
nonDelivery
|
nonDelivery | string |
CustomItem
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
説明
|
description | string | |
|
数量
|
quantity | float | |
|
value
|
value | float | |
|
harmonizedTariffCode
|
harmonizedTariffCode | string | |
|
countryOfOrigin
|
countryOfOrigin | string |
AdvancedOptions
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
warehouseId
|
warehouseId | integer | |
|
nonMachinable
|
nonMachinable | boolean | |
|
saturdayDelivery
|
saturdayDelivery | boolean | |
|
containsAlcohol
|
containsAlcohol | boolean | |
|
mergedOrSplit
|
mergedOrSplit | boolean | |
|
mergedIds
|
mergedIds | array of string | |
|
parentId
|
parentId | string | |
|
storeId
|
storeId | integer | |
|
customField1
|
customField1 | string | |
|
customField2
|
customField2 | string | |
|
customField3
|
customField3 | string | |
|
ソース
|
source | string | |
|
billToParty
|
billToParty | string | |
|
billToAccount
|
billToAccount | string | |
|
billToPostalCode
|
billToPostalCode | string | |
|
billToCountryCode
|
billToCountryCode | string |
品目
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
lineItemKey
|
lineItemKey | string | |
|
sku
|
sku | string | |
|
名前
|
name | string | |
|
imageUrl
|
imageUrl | string | |
|
重量
|
weight | Weight | |
|
数量
|
quantity | float | |
|
単価
|
unitPrice | double | |
|
税額
|
taxAmount | double | |
|
shippingAmount
|
shippingAmount | double | |
|
warehouseLocation
|
warehouseLocation | string | |
|
オプション
|
options | array of Option | |
|
productId
|
productId | integer | |
|
fulfillmentSku
|
fulfillmentSku | string | |
|
精算
|
adjustment | boolean | |
|
upc
|
upc | string |
重量
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | float | |
|
単位
|
units | string |
CreateLabelforOrderResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
shipmentId
|
shipmentId | integer | |
|
shipmentCost
|
shipmentCost | double | |
|
insuranceCost
|
insuranceCost | float | |
|
トラッキングナンバー
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
注文ID
|
orderId | integer | |
|
注文番号
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
注文日
|
orderDate | string | |
|
作成日
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
paymentDate
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
顧客メール
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
アイテム
|
items | array of Item | |
|
orderTotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
税額
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
ギフト
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
paymentMethod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
確認
|
confirmation | string | |
|
ship日付
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
重量
|
weight | Weight | |
|
ディメンション
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |