ShipStation (wersja zapoznawcza)
ShipStation to wiodące internetowe oprogramowanie wysyłkowe, które pomaga sprzedawcom internetowym usprawniać realizację zamówień, niezależnie od miejsca sprzedaży i wysyłki.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Service | Klasa | Regiony |
|---|---|---|
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Kontakt biznesowy | |
|---|---|
| Nazwa | Microsoft Dynamics |
| adres URL | https://dynamics.microsoft.com/en-us/support/ |
| iomdri@microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://www.shipstation.com/ |
| Zasady ochrony prywatności | https://www.shipstation.com/privacy-policy/ |
| Kategorie | Produktywność |
Ten łącznik został specjalnie opracowany do użycia na potrzeby integracji dostawcy ShipStation usługi Dynamics 365 Intelligent Order Management.
Wymagania wstępne
Wymagane jest konto dewelopera ShipStation. Jeśli nie masz go, możesz go utworzyć pod adresem https://www.shipstation.com/docs/api/requirements/. Uwaga: zaleca się użycie tego łącznika w szczególności do skonfigurowania dostawcy usługi Dynamics 365 Intelligent Order Management ShipStation.
Jak uzyskać poświadczenia
Usługa ShipStation wymaga klucza interfejsu API i wpisu tajnego do uwierzytelniania. Możesz wygenerować token https://ship13.shipstation.com/settings/api i użyć go do skonfigurowania łącznika.
Wprowadzenie do łącznika
Skonfiguruj połączenie z kluczem interfejsu API i kluczem tajnym. Aby dowiedzieć się więcej na temat interfejsu API shipStation, przeczytaj publiczną dokumentację: https://www.shipstation.com/docs/api/
Znane problemy i ograniczenia
Ten łącznik został specjalnie opracowany do użycia na potrzeby integracji dostawcy ShipStation usługi Dynamics 365 Intelligent Order Management. Obsługa przypadków użycia poza usługą Dynamics 365 Intelligent Order Management będzie ograniczona.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Nazwa | Typ | Opis | Wymagane |
|---|---|---|---|
| nazwa użytkownika | securestring | Nazwa użytkownika dla tego interfejsu API | Prawda |
| hasło | securestring | Hasło dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobieranie zamówienia |
Pobiera pojedyncze zamówienie z bazy danych. |
| Tworzenie lub aktualizowanie kolejności |
Jeśli określono klucz orderKey, metoda stanie się idempotentna, a istniejąca kolejność z tym kluczem zostanie zaktualizowana. Uwaga: za pomocą tej metody można zaktualizować tylko zamówienia w stanie otwarcia w usłudze ShipStation (awaiting_payment,awaiting_shipment i on_hold). anulowane i wysłane są zablokowane od modyfikacji za pośrednictwem interfejsu API. |
| Utwórz etykietę dla zamówienia |
Tworzy etykietę wysyłkową dla danego zamówienia. Pole labelData zwrócone w odpowiedzi jest wartością PDF zakodowaną w formacie base64. Po prostu zdekoduj i zapisz dane wyjściowe jako plik PDF, aby pobrać etykietę drukowalną. |
Pobieranie zamówienia
Pobiera pojedyncze zamówienie z bazy danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Pobieranie zamówienia
|
orderId | True | double |
System wygenerował identyfikator zamówienia. |
Zwraca
- Body
- GetOrderResponse
Tworzenie lub aktualizowanie kolejności
Jeśli określono klucz orderKey, metoda stanie się idempotentna, a istniejąca kolejność z tym kluczem zostanie zaktualizowana. Uwaga: za pomocą tej metody można zaktualizować tylko zamówienia w stanie otwarcia w usłudze ShipStation (awaiting_payment,awaiting_shipment i on_hold). anulowane i wysłane są zablokowane od modyfikacji za pośrednictwem interfejsu API.
Zwraca
Utwórz etykietę dla zamówienia
Tworzy etykietę wysyłkową dla danego zamówienia. Pole labelData zwrócone w odpowiedzi jest wartością PDF zakodowaną w formacie base64. Po prostu zdekoduj i zapisz dane wyjściowe jako plik PDF, aby pobrać etykietę drukowalną.
Zwraca
Wyzwalacze
| Subskrybowanie elementu webhook |
Subskrybuje określony typ elementu webhook. Jeśli store_id zostanie przekazana, elementy webhook zostaną wyzwolone tylko dla tej konkretnej store_id. Przekazany typ zdarzenia określi, jaki typ elementów webhook zostanie wysłany. Musi zawierać jedną z następujących wartości: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK. |
Subskrybowanie elementu webhook
Subskrybuje określony typ elementu webhook. Jeśli store_id zostanie przekazana, elementy webhook zostaną wyzwolone tylko dla tej konkretnej store_id. Przekazany typ zdarzenia określi, jaki typ elementów webhook zostanie wysłany. Musi zawierać jedną z następujących wartości: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
wydarzenie
|
event | True | string |
Definicje
GetOrderResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator zamówienia
|
orderId | integer | |
|
numer zamówienia
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
dataZamówienia
|
orderDate | string | |
|
createDate (data utworzenia)
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
data płatności
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId (identyfikator klienta)
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
email klienta
|
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 | |
|
Prezent
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
metoda płatności
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
potwierdzenie
|
confirmation | string | |
|
shipDate (data wysyłki)
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Weight
|
weight | Weight | |
|
Wymiary
|
dimensions | Dimensions | |
|
UbezpieczeniaOpcje
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
Advancedoptions
|
advancedOptions | AdvancedOptions | |
|
identyfikatory tagów
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |
BillTo
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
firma
|
company | string | |
|
ulica1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
city
|
city | string | |
|
stan
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
Mieszkalnych
|
residential | string | |
|
addressVerified
|
addressVerified | string |
Shipto
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
firma
|
company | string | |
|
ulica1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
city
|
city | string | |
|
stan
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
Mieszkalnych
|
residential | boolean | |
|
addressVerified
|
addressVerified | string |
Option
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
wartość
|
value | string |
Wymiary
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Jednostek
|
units | string | |
|
length
|
length | float | |
|
width
|
width | float | |
|
height
|
height | float |
UbezpieczeniaOpcje
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dostawca
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
wartość ubezpieczona
|
insuredValue | float |
InternationalOptions
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
contents
|
contents | string | |
|
customsItems
|
customsItems | array of CustomsItem | |
|
nonDelivery
|
nonDelivery | string |
CustomsItem
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
opis
|
description | string | |
|
ilość
|
quantity | float | |
|
wartość
|
value | float | |
|
harmoniedTariffCode
|
harmonizedTariffCode | string | |
|
countryOfOrigin
|
countryOfOrigin | string |
Advancedoptions
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
warehouseId
|
warehouseId | integer | |
|
niemachinable
|
nonMachinable | boolean | |
|
saturdayDelivery
|
saturdayDelivery | boolean | |
|
containsAlcohol
|
containsAlcohol | boolean | |
|
mergedOrSplit
|
mergedOrSplit | boolean | |
|
mergedIds
|
mergedIds | array of string | |
|
parentId (identyfikator rodzica)
|
parentId | string | |
|
storeId
|
storeId | integer | |
|
customField1
|
customField1 | string | |
|
customField2
|
customField2 | string | |
|
customField3
|
customField3 | string | |
|
przesłać źródło
|
source | string | |
|
billToParty
|
billToParty | string | |
|
billToAccount
|
billToAccount | string | |
|
billToPostalCode
|
billToPostalCode | string | |
|
billToCountryCode
|
billToCountryCode | string |
Produkt
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
lineItemKey
|
lineItemKey | string | |
|
sku
|
sku | string | |
|
nazwa
|
name | string | |
|
imageUrl
|
imageUrl | string | |
|
Weight
|
weight | Weight | |
|
ilość
|
quantity | float | |
|
cena jednostkowa
|
unitPrice | double | |
|
taxAmount
|
taxAmount | double | |
|
shippingAmount
|
shippingAmount | double | |
|
warehouseLocation
|
warehouseLocation | string | |
|
options
|
options | array of Option | |
|
ID produktu
|
productId | integer | |
|
fulfillmentSku
|
fulfillmentSku | string | |
|
korekta
|
adjustment | boolean | |
|
Upc
|
upc | string |
Weight
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wartość
|
value | float | |
|
Jednostek
|
units | string |
CreateLabelforOrderResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator wysyłki
|
shipmentId | integer | |
|
wysyłkaCost
|
shipmentCost | double | |
|
insuranceCost
|
insuranceCost | float | |
|
trackingNumber (numer przesyłki)
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator zamówienia
|
orderId | integer | |
|
numer zamówienia
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
dataZamówienia
|
orderDate | string | |
|
createDate (data utworzenia)
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
data płatności
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId (identyfikator klienta)
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
email klienta
|
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 | |
|
Prezent
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
metoda płatności
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
potwierdzenie
|
confirmation | string | |
|
shipDate (data wysyłki)
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Weight
|
weight | Weight | |
|
Wymiary
|
dimensions | Dimensions | |
|
UbezpieczeniaOpcje
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
Advancedoptions
|
advancedOptions | AdvancedOptions | |
|
identyfikatory tagów
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |