通过

ShipStation （预览版）

ShipStation 是领先的基于 Web 的发货软件，可帮助在线零售商简化订单履行，无论在何处销售，无论它们如何交付。

此连接器在以下产品和区域中可用：

Service Class 区域
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure Government区域
     - Azure中国区域
     - 美国国防部（DoD）
联系人
名称 Microsoft Dynamics
URL https://dynamics.microsoft.com/en-us/support/
Email iomdri@microsoft.com
连接器元数据
发布者 Microsoft
网站 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 智能订单管理 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 智能订单管理之外的用例的支持将受到限制。

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

名称 类型 说明 必需
用户名 securestring 此 API 的用户名 真 实
密码 securestring 此 API 的密码 真 实

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

为订单创建标签

为给定订单创建发货标签。 响应中返回的 labelData 字段是 base64 编码的 PDF 值。 只需将输出解码并保存为 PDF 文件即可检索可打印标签。
创建或更新订单

如果指定 orderKey，该方法将变为幂等，并且将更新具有该键的现有顺序。 注意：只有 ShipStation 中处于打开状态的订单（awaiting_payment，awaiting_shipment和on_hold）才能通过此方法进行更新。 已取消且已发货，无法通过 API 进行修改。
获取订单

从数据库检索单个订单。

为订单创建标签

操作 ID:
CreateLabelForOrder

为给定订单创建发货标签。 响应中返回的 labelData 字段是 base64 编码的 PDF 值。 只需将输出解码并保存为 PDF 文件即可检索可打印标签。

返回

Body
CreateLabelforOrderResponse

创建或更新订单

操作 ID:
CreateUpdateOrder

如果指定 orderKey，该方法将变为幂等，并且将更新具有该键的现有顺序。 注意：只有 ShipStation 中处于打开状态的订单（awaiting_payment，awaiting_shipment和on_hold）才能通过此方法进行更新。 已取消且已发货，无法通过 API 进行修改。

返回

Body
CreateUpdateOrderResponse

获取订单

操作 ID:
GetOrderById

从数据库检索单个订单。

参数

名称 密钥 必需 类型 说明
获取订单
 orderId True double

系统为订单生成标识符。

返回

Body
GetOrderResponse

触发器

订阅 Webhook

订阅特定类型的 Webhook。 如果传入store_id，将仅针对该特定store_id触发 Webhook。 传入的事件类型将确定将发送哪种类型的 Webhook。必须包含以下值之一：ORDER_NOTIFY、ITEM_ORDER_NOTIFY、SHIP_NOTIFY、ITEM_SHIP_NOTIFY、API_TRACK。

订阅 Webhook

操作 ID:
WebhookSubscribe

订阅特定类型的 Webhook。 如果传入store_id，将仅针对该特定store_id触发 Webhook。 传入的事件类型将确定将发送哪种类型的 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

名称 路径 类型 说明
订单编号
 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
 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
shipDate 发货日期
 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
 city string
状态
 state string
postalCode
 postalCode string
国家
 country string
电话
 phone string
住宅
 residential string
addressVerified
 addressVerified string

ShipTo

名称 路径 类型 说明
名字
 name string
company
 company string
street1
 street1 string
street2
 street2 string
street3
 street3 string
city
 city string
状态
 state string
postalCode
 postalCode string
国家
 country string
电话
 phone string
住宅
 residential boolean
addressVerified
 addressVerified string

选项

名称 路径 类型 说明
名字
 name string
value
 value string

尺寸

名称 路径 类型 说明
单位
 units string
length
 length float
width
 width float
身高
 height float

InsuranceOptions

名称 路径 类型 说明
提供商
 provider string
insureShipment
 insureShipment boolean
insuredValue
 insuredValue float

InternationalOptions

名称 路径 类型 说明
内容
 contents string
customsItems
 customsItems array of CustomsItem
nonDelivery
 nonDelivery string

CustomsItem

名称 路径 类型 说明
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
 unitPrice double
taxAmount
 taxAmount double
shippingAmount
 shippingAmount double
warehouseLocation
 warehouseLocation string
选项
 options array of Option
productId
 productId integer
fulfillmentSku
 fulfillmentSku string
调整
 adjustment boolean
刚果（日）
 upc string

重量

名称 路径 类型 说明
value
 value float
单位
 units string

CreateLabelforOrderResponse

名称 路径 类型 说明
shipmentId
 shipmentId integer
shipmentCost
 shipmentCost double
insuranceCost
 insuranceCost float
trackingNumber
 trackingNumber string
labelData
 labelData string
formData
 formData string

CreateUpdateOrderResponse

名称 路径 类型 说明
订单编号
 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
 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
shipDate 发货日期
 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