ShipStation (предварительная версия)
ShipStation является ведущим веб-программным обеспечением доставки, которое помогает онлайн-розничным продавцам оптимизировать их выполнение заказов, где бы они ни продаются, но они поставляются.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Класс | Регионы |
|---|---|---|
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| Эл. почта | iomdri@microsoft.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Корпорация Майкрософт |
| Веб-сайт | https://www.shipstation.com/ |
| Политика конфиденциальности | https://www.shipstation.com/privacy-policy/ |
| Категории | Продуктивность |
Этот соединитель специально разработан для интеграции поставщика ShipStation в Dynamics 365 Intelligent Order Management.
Необходимые условия
Требуется учетная запись разработчика ShipStation. Если у вас нет его, его можно создать.https://www.shipstation.com/docs/api/requirements/ Примечание. Рекомендуется использовать этот соединитель специально для настройки поставщика Dynamics 365 Intelligent Order Management ShipStation.
Получение учетных данных
ShipStation требует ключа API и секрета для проверки подлинности. Вы можете создать маркер https://ship13.shipstation.com/settings/api и использовать его для настройки соединителя.
Начало работы с соединителем
Настройте подключение с ключом API и секретом. Дополнительные сведения об API ShipStation см. в общедоступной документации: https://www.shipstation.com/docs/api/
Известные проблемы и ограничения
Этот соединитель специально разработан для интеграции поставщика ShipStation в Dynamics 365 Intelligent Order Management. Поддержка регистров использования за пределами Dynamics 365 Intelligent Order Management будет ограничена.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Описание | Обязательный |
|---|---|---|---|
| username | securestring | Имя пользователя для этого API | True |
| пароль | securestring | Пароль для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Получение заказа |
Извлекает один заказ из базы данных. |
| Создание или обновление заказа |
Если указан orderKey, метод становится идемпотентным, а существующий порядок с этим ключом будет обновлен. Примечание. С помощью этого метода можно обновить только заказы в открытом состоянии в ShipStation (awaiting_payment,awaiting_shipment и on_hold). отмененные и отправляемые блокируются из изменения через API. |
| Создание метки для заказа |
Создает метку доставки для заданного заказа. Поле labelData, возвращаемое в ответе, является значением PDF в кодировке Base64. Просто декодировать и сохранять выходные данные в виде PDF-файла, чтобы получить печатаемую метку. |
Получение заказа
Извлекает один заказ из базы данных.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Получение заказа
|
orderId | True | double |
Системный идентификатор для заказа. |
Возвращаемое значение
- Тело
- GetOrderResponse
Создание или обновление заказа
Если указан orderKey, метод становится идемпотентным, а существующий порядок с этим ключом будет обновлен. Примечание. С помощью этого метода можно обновить только заказы в открытом состоянии в ShipStation (awaiting_payment,awaiting_shipment и on_hold). отмененные и отправляемые блокируются из изменения через API.
Возвращаемое значение
Создание метки для заказа
Создает метку доставки для заданного заказа. Поле labelData, возвращаемое в ответе, является значением PDF в кодировке Base64. Просто декодировать и сохранять выходные данные в виде PDF-файла, чтобы получить печатаемую метку.
Возвращаемое значение
Триггеры
| Подписка на веб-перехватчик |
Подписывается на определенный тип веб-перехватчика. Если передается store_id, веб-перехватчики будут запускаться только для этого конкретного store_id. Тип события, переданный в, определяет, какой тип веб-перехватчиков будет отправлен. Должен содержать одно из следующих значений: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK. |
Подписка на веб-перехватчик
Подписывается на определенный тип веб-перехватчика. Если передается store_id, веб-перехватчики будут запускаться только для этого конкретного store_id. Тип события, переданный в, определяет, какой тип веб-перехватчиков будет отправлен. Должен содержать одно из следующих значений: 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
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
Дата платежа
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
электронная почта клиента
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
items
|
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 | string | |
|
запрошенная СлужбаShippingService
|
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 | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
city
|
city | string | |
|
государство
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
жилой
|
residential | string | |
|
addressVerified
|
addressVerified | string |
ShipTo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
name | string | |
|
компания
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
city
|
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
|
length | float | |
|
Ширина
|
width | float | |
|
height
|
height | float |
InsuranceOptions
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
provider
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
страховое значение
|
insuredValue | float |
InternationalOptions
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
contents
|
contents | string | |
|
customsItems
|
customsItems | array of CustomsItem | |
|
nonDelivery
|
nonDelivery | string |
CustomsItem
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
описание
|
description | string | |
|
количество
|
quantity | float | |
|
value
|
value | float | |
|
согласованиеTariffCode
|
harmonizedTariffCode | string | |
|
countryOfOrigin
|
countryOfOrigin | string |
AdvancedOptions
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
warehouseId
|
warehouseId | integer | |
|
nonMachinable
|
nonMachinable | boolean | |
|
субботаDelivery
|
saturdayDelivery | boolean | |
|
containsAlcohol
|
containsAlcohol | boolean | |
|
ОбъединенныйOrSplit
|
mergedOrSplit | boolean | |
|
Объединенные Идентификаторы
|
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
|
taxAmount | double | |
|
shippingAmount
|
shippingAmount | double | |
|
warehouseLocation
|
warehouseLocation | string | |
|
options
|
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 | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
номерЗаказа
|
orderId | integer | |
|
номер заказа
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
дата заказа
|
orderDate | string | |
|
createDate
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
Дата платежа
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
электронная почта клиента
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
items
|
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 | string | |
|
запрошенная СлужбаShippingService
|
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 |