ShipStation (förhandsversion)
ShipStation är den ledande webbaserade fraktprogramvaran som hjälper onlineåterförsäljare att effektivisera sin orderuppfyllelse, var de än säljer och hur de än levererar.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Service | Class | Regioner |
|---|---|---|
| Logiska appar | Standard | Alla Logic Apps-regioner utom följande: - Azure Government regioner - Azure kinaregioner - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| E-postmeddelande | iomdri@microsoft.com |
| Metadata för anslutningsprogram | |
|---|---|
| Publisher | Microsoft |
| Webbplats | https://www.shipstation.com/ |
| Sekretesspolicy | https://www.shipstation.com/privacy-policy/ |
| Kategorier | Produktivitet |
Den här anslutningsappen har utvecklats specifikt för att användas för Integrering av Dynamics 365 Intelligent Order Managements ShipStation-provider.
Förutsättningar
Ett ShipStation-utvecklarkonto krävs. Om du inte har någon kan du skapa den på https://www.shipstation.com/docs/api/requirements/. Obs! Vi rekommenderar att du använder den här anslutningsappen specifikt för att konfigurera Dynamics 365 Intelligent Order Management ShipStation-providern.
Hämta autentiseringsuppgifter
ShipStation kräver en API-nyckel och hemlighet för autentisering. Du kan generera en token https://ship13.shipstation.com/settings/api och använda den för att konfigurera anslutningsappen.
Komma igång med anslutningsappen
Konfigurera anslutningen med API-nyckeln och hemligheten. Mer information om ShipStations API finns i den offentliga dokumentationen: https://www.shipstation.com/docs/api/
Kända problem och begränsningar
Den här anslutningsappen har utvecklats specifikt för att användas för Integrering av Dynamics 365 Intelligent Order Managements ShipStation-provider. Stöd för användningsfall utanför Dynamics 365 Intelligent Order Management kommer att begränsas.
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Namn | Type | Beskrivning | Obligatoriskt |
|---|---|---|---|
| användarnamn | securestring | Användarnamnet för det här API:et | Sann |
| lösenord | securestring | Lösenordet för det här API:et | Sann |
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Hämta order |
Hämtar en enskild order från databasen. |
| Skapa eller uppdatera order |
Om orderKey anges blir metoden idempotent och den befintliga ordningen med den nyckeln uppdateras. Obs! Endast beställningar i en öppen status i ShipStation (awaiting_payment, awaiting_shipment och on_hold) kan uppdateras via den här metoden. avbrutna och levererade låses från ändring via API:et. |
| Skapa etikett för order |
Skapar en fraktetikett för en viss beställning. Fältet labelData som returneras i svaret är ett base64-kodat PDF-värde. Avkoda och spara bara utdata som en PDF-fil för att hämta en utskrivbar etikett. |
Hämta order
Hämtar en enskild order från databasen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Hämta order
|
orderId | True | double |
Systemgenererad identifierare för ordern. |
Returer
- Body
- GetOrderResponse
Skapa eller uppdatera order
Om orderKey anges blir metoden idempotent och den befintliga ordningen med den nyckeln uppdateras. Obs! Endast beställningar i en öppen status i ShipStation (awaiting_payment, awaiting_shipment och on_hold) kan uppdateras via den här metoden. avbrutna och levererade låses från ändring via API:et.
Returer
Skapa etikett för order
Skapar en fraktetikett för en viss beställning. Fältet labelData som returneras i svaret är ett base64-kodat PDF-värde. Avkoda och spara bara utdata som en PDF-fil för att hämta en utskrivbar etikett.
Returer
Utlösare
| Prenumerera på Webhook |
Prenumererar på en specifik typ av webhook. Om en store_id skickas in utlöses webhooks endast för den specifika store_id. Händelsetypen som skickas in avgör vilken typ av webhooks som ska skickas. Måste innehålla något av följande värden:ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK. |
Prenumerera på Webhook
Prenumererar på en specifik typ av webhook. Om en store_id skickas in utlöses webhooks endast för den specifika store_id. Händelsetypen som skickas in avgör vilken typ av webhooks som ska skickas. Måste innehålla något av följande värden:ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
händelse
|
event | True | string |
Definitioner
GetOrderResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
beställnings-ID
|
orderId | integer | |
|
ordernummer
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
beställningsdatum
|
orderDate | string | |
|
skapaDatum
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
betalningsdatum
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
kundens e-post
|
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 | |
|
Gåva
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
betalningsmetod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
konfirmation
|
confirmation | string | |
|
Datum för sändning
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Vikt
|
weight | Weight | |
|
Mått
|
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 | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string | |
|
Företag
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
stad
|
city | string | |
|
state
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
bostads
|
residential | string | |
|
addressVerified
|
addressVerified | string |
ShipTo
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string | |
|
Företag
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
stad
|
city | string | |
|
state
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
bostads
|
residential | boolean | |
|
addressVerified
|
addressVerified | string |
Option
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string | |
|
value
|
value | string |
Mått
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Enheter
|
units | string | |
|
length
|
length | float | |
|
bredd
|
width | float | |
|
höjd
|
height | float |
InsuranceOptions
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
provider
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
insuredValue
|
insuredValue | float |
InternationalOptions
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
contents
|
contents | string | |
|
customsItems
|
customsItems | array of CustomsItem | |
|
nonDelivery
|
nonDelivery | string |
CustomsItem
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
beskrivning
|
description | string | |
|
kvantitet
|
quantity | float | |
|
value
|
value | float | |
|
harmonizedTariffCode
|
harmonizedTariffCode | string | |
|
countryOfOrigin
|
countryOfOrigin | string |
AdvancedOptions
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
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 | |
|
källa
|
source | string | |
|
billToParty
|
billToParty | string | |
|
billToAccount
|
billToAccount | string | |
|
billToPostalCode
|
billToPostalCode | string | |
|
billToCountryCode
|
billToCountryCode | string |
Objekt
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
lineItemKey
|
lineItemKey | string | |
|
sku
|
sku | string | |
|
Namn
|
name | string | |
|
imageUrl
|
imageUrl | string | |
|
Vikt
|
weight | Weight | |
|
kvantitet
|
quantity | float | |
|
enhetspris
|
unitPrice | double | |
|
taxAmount
|
taxAmount | double | |
|
shippingAmount
|
shippingAmount | double | |
|
warehouseLocation
|
warehouseLocation | string | |
|
options
|
options | array of Option | |
|
produkt-id
|
productId | integer | |
|
fulfillmentSku
|
fulfillmentSku | string | |
|
Justering
|
adjustment | boolean | |
|
Upc
|
upc | string |
Vikt
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
value
|
value | float | |
|
Enheter
|
units | string |
CreateLabelforOrderResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
shipmentId
|
shipmentId | integer | |
|
shipmentCost
|
shipmentCost | double | |
|
insuranceCost
|
insuranceCost | float | |
|
trackingNumber (spårningsnummer)
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
beställnings-ID
|
orderId | integer | |
|
ordernummer
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
beställningsdatum
|
orderDate | string | |
|
skapaDatum
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
betalningsdatum
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
kundens e-post
|
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 | |
|
Gåva
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
betalningsmetod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
konfirmation
|
confirmation | string | |
|
Datum för sändning
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Vikt
|
weight | Weight | |
|
Mått
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |