ShipStation (preview)
ShipStation is de toonaangevende webgebaseerde verzendsoftware die online retailers helpt hun orderafhandeling te stroomlijnen, waar ze ook verkopen en hoe ze ze verzenden.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | klasse | Regio's |
|---|---|---|
| Logic-apps | Standard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| contact opnemen met | |
|---|---|
| Naam | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| E-mailadres | iomdri@microsoft.com |
| Connectormetagegevens | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.shipstation.com/ |
| Privacybeleid | https://www.shipstation.com/privacy-policy/ |
| Categorieën | Productiviteit |
Deze connector is speciaal ontwikkeld voor de integratie van de ShipStation-provider van Dynamics 365 Intelligent Order Management.
Vereiste voorwaarden
Er is een ShipStation-ontwikkelaarsaccount vereist. Als u geen account hebt, kunt u deze maken op https://www.shipstation.com/docs/api/requirements/. Opmerking: Het is raadzaam om deze connector specifiek te gebruiken om de Dynamics 365 Intelligent Order Management ShipStation-provider in te stellen.
Referenties ophalen
ShipStation vereist een API-sleutel en -geheim voor verificatie. U kunt een token https://ship13.shipstation.com/settings/api genereren en dit gebruiken om de connector te configureren.
Aan de slag met uw connector
Configureer de verbinding met de API-sleutel en het geheim. Lees de openbare documentatie voor meer informatie over de API's van ShipStation: https://www.shipstation.com/docs/api/
Bekende problemen en beperkingen
Deze connector is speciaal ontwikkeld voor de integratie van de ShipStation-provider van Dynamics 365 Intelligent Order Management. Ondersteuning voor usecases buiten Dynamics 365 Intelligent Order Management wordt beperkt.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typ | Beschrijving | Verplicht |
|---|---|---|---|
| username | beveiligde string | De gebruikersnaam voor deze API | Klopt |
| password | beveiligde string | Het wachtwoord voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Label voor order maken |
Hiermee maakt u een verzendlabel voor een bepaalde bestelling. Het labelData-veld dat in het antwoord wordt geretourneerd, is een base64-gecodeerde PDF-waarde. U hoeft alleen de uitvoer te decoderen en op te slaan als EEN PDF-bestand om een afdrukbaar etiket op te halen. |
| Order maken of bijwerken |
Als de orderKey is opgegeven, wordt de methode idempotent en wordt de bestaande order met die sleutel bijgewerkt. Opmerking: Alleen orders in een open status in ShipStation (awaiting_payment,awaiting_shipment en on_hold) kunnen worden bijgewerkt via deze methode. geannuleerd en verzonden zijn vergrendeld tegen wijziging via de API. |
| Order ophalen |
Hiermee haalt u één order op uit de database. |
Label voor order maken
Hiermee maakt u een verzendlabel voor een bepaalde bestelling. Het labelData-veld dat in het antwoord wordt geretourneerd, is een base64-gecodeerde PDF-waarde. U hoeft alleen de uitvoer te decoderen en op te slaan als EEN PDF-bestand om een afdrukbaar etiket op te halen.
Retouren
Order maken of bijwerken
Als de orderKey is opgegeven, wordt de methode idempotent en wordt de bestaande order met die sleutel bijgewerkt. Opmerking: Alleen orders in een open status in ShipStation (awaiting_payment,awaiting_shipment en on_hold) kunnen worden bijgewerkt via deze methode. geannuleerd en verzonden zijn vergrendeld tegen wijziging via de API.
Retouren
Order ophalen
Hiermee haalt u één order op uit de database.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Order ophalen
|
orderId | True | double |
De door het systeem gegenereerde id voor de order. |
Retouren
- Body
- GetOrderResponse
Triggers
| Abonneren op Webhook |
Abonneren op een specifiek type webhook. Als er een store_id wordt doorgegeven, worden de webhooks alleen geactiveerd voor die specifieke store_id. Het gebeurtenistype dat wordt doorgegeven, bepaalt welk type webhooks worden verzonden. Moet een van de volgende waarden bevatten: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK. |
Abonneren op Webhook
Abonneren op een specifiek type webhook. Als er een store_id wordt doorgegeven, worden de webhooks alleen geactiveerd voor die specifieke store_id. Het gebeurtenistype dat wordt doorgegeven, bepaalt welk type webhooks worden verzonden. Moet een van de volgende waarden bevatten: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
gebeurtenis
|
event | True | string |
Definities
GetOrderResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
bestelnummer
|
orderId | integer | |
|
ordernummer
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
besteldatum
|
orderDate | string | |
|
createDate
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
betalingsdatum
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
klant-ID
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
klantE-mail
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
Onderdelen
|
items | array of Item | |
|
orderTotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
taxAmount
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
Gift
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
betalingsmethode
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
bevestiging
|
confirmation | string | |
|
verzenddatum
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Gewicht
|
weight | Weight | |
|
Dimensies
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
extern vervuld
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |
BillTo
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string | |
|
bedrijf
|
company | string | |
|
straat1
|
street1 | string | |
|
street2
|
street2 | string | |
|
straat3
|
street3 | string | |
|
city
|
city | string | |
|
state
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
Residentiële
|
residential | string | |
|
addressVerified
|
addressVerified | string |
ShipTo
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string | |
|
bedrijf
|
company | string | |
|
straat1
|
street1 | string | |
|
street2
|
street2 | string | |
|
straat3
|
street3 | string | |
|
city
|
city | string | |
|
state
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
Residentiële
|
residential | boolean | |
|
addressVerified
|
addressVerified | string |
Option
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string | |
|
value
|
value | string |
Dimensies
| Name | Pad | Type | Description |
|---|---|---|---|
|
Eenheden
|
units | string | |
|
length
|
length | float | |
|
width
|
width | float | |
|
height
|
height | float |
InsuranceOptions
| Name | Pad | Type | Description |
|---|---|---|---|
|
provider
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
verzekerdeWaarde
|
insuredValue | float |
InternationalOptions
| Name | Pad | Type | Description |
|---|---|---|---|
|
contents
|
contents | string | |
|
customsItems
|
customsItems | array of CustomsItem | |
|
nonDelivery
|
nonDelivery | string |
CustomsItem
| Name | Pad | Type | Description |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
beschrijving
|
description | string | |
|
hoeveelheid
|
quantity | float | |
|
value
|
value | float | |
|
geharmoniseerdeTariffCode
|
harmonizedTariffCode | string | |
|
countryOfOrigin
|
countryOfOrigin | string |
AdvancedOptions
| Name | Pad | Type | Description |
|---|---|---|---|
|
warehouseId
|
warehouseId | integer | |
|
niet-Afdrukbaar
|
nonMachinable | boolean | |
|
saturdayDelivery
|
saturdayDelivery | boolean | |
|
contains Alcoholisch
|
containsAlcohol | boolean | |
|
mergedOrSplit
|
mergedOrSplit | boolean | |
|
mergedIds
|
mergedIds | array of string | |
|
ouder-ID
|
parentId | string | |
|
storeId
|
storeId | integer | |
|
customField1
|
customField1 | string | |
|
customField2
|
customField2 | string | |
|
customField3
|
customField3 | string | |
|
bron
|
source | string | |
|
billToParty
|
billToParty | string | |
|
billToAccount
|
billToAccount | string | |
|
billToPostalCode
|
billToPostalCode | string | |
|
billToCountryCode
|
billToCountryCode | string |
Artikel
| Name | Pad | Type | Description |
|---|---|---|---|
|
lineItemKey
|
lineItemKey | string | |
|
sku
|
sku | string | |
|
naam
|
name | string | |
|
imageUrl
|
imageUrl | string | |
|
Gewicht
|
weight | Weight | |
|
hoeveelheid
|
quantity | float | |
|
eenheidsprijs
|
unitPrice | double | |
|
taxAmount
|
taxAmount | double | |
|
shippingAmount
|
shippingAmount | double | |
|
warehouseLocation
|
warehouseLocation | string | |
|
options
|
options | array of Option | |
|
productId
|
productId | integer | |
|
fulfillmentSku
|
fulfillmentSku | string | |
|
Aanpassing
|
adjustment | boolean | |
|
Upc
|
upc | string |
Gewicht
| Name | Pad | Type | Description |
|---|---|---|---|
|
value
|
value | float | |
|
Eenheden
|
units | string |
CreateLabelforOrderResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
shipmentId
|
shipmentId | integer | |
|
shipmentCost
|
shipmentCost | double | |
|
insuranceCost
|
insuranceCost | float | |
|
trackingnummer
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
bestelnummer
|
orderId | integer | |
|
ordernummer
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
besteldatum
|
orderDate | string | |
|
createDate
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
betalingsdatum
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
klant-ID
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
klantE-mail
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
Onderdelen
|
items | array of Item | |
|
orderTotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
taxAmount
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
Gift
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
betalingsmethode
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
bevestiging
|
confirmation | string | |
|
verzenddatum
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Gewicht
|
weight | Weight | |
|
Dimensies
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
extern vervuld
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |