ShipStation (préversion)
ShipStation est le principal logiciel d’expédition web qui aide les détaillants en ligne à rationaliser leur traitement des commandes, où qu’ils vendent et qu’ils livrent.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | Classe | Régions |
|---|---|---|
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - régions de chine Azure - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| Courrier électronique | iomdri@microsoft.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Microsoft |
| Website | https://www.shipstation.com/ |
| Politique de confidentialité | https://www.shipstation.com/privacy-policy/ |
| Catégories | Productivité |
Ce connecteur a été spécifiquement développé pour être utilisé pour l’intégration du fournisseur ShipStation de Dynamics 365 Intelligent Order Management.
Prerequisites
Un compte de développeur ShipStation est requis. Si vous n’en avez pas, vous pouvez le créer à https://www.shipstation.com/docs/api/requirements/. Remarque : il est recommandé d’utiliser ce connecteur spécifiquement pour configurer le fournisseur Dynamics 365 Intelligent Order Management ShipStation.
Comment obtenir des informations d’identification
ShipStation nécessite une clé API et un secret pour l’authentification. Vous pouvez générer un jeton https://ship13.shipstation.com/settings/api et l’utiliser pour configurer le connecteur.
Prise en main de votre connecteur
Configurez la connexion avec la clé API et le secret. Pour en savoir plus sur l’API ShipStation, lisez la documentation publique : https://www.shipstation.com/docs/api/
Problèmes connus et limitations
Ce connecteur a été spécifiquement développé pour être utilisé pour l’intégration du fournisseur ShipStation de Dynamics 365 Intelligent Order Management. La prise en charge des cas d’utilisation en dehors de Dynamics 365 Intelligent Order Management sera limitée.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Description | Obligatoire |
|---|---|---|---|
| nom d'utilisateur | securestring | Nom d’utilisateur de cette API | Vrai |
| mot de passe | securestring | Mot de passe de cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer ou mettre à jour l’ordre |
Si la clé orderKey est spécifiée, la méthode devient idempotente et l’ordre existant avec cette clé sera mis à jour. Remarque : Seules les commandes dans un état ouvert dans ShipStation (awaiting_payment,awaiting_shipment et on_hold) peuvent être mises à jour via cette méthode. annulés et expédiés sont verrouillés à partir de la modification via l’API. |
| Créer une étiquette pour l’ordre |
Crée une étiquette d’expédition pour une commande donnée. Le champ labelData retourné dans la réponse est une valeur PDF encodée en base64. Décodez et enregistrez simplement la sortie sous forme de fichier PDF pour récupérer une étiquette imprimable. |
| Obtenir une commande |
Récupère une commande unique à partir de la base de données. |
Créer ou mettre à jour l’ordre
Si la clé orderKey est spécifiée, la méthode devient idempotente et l’ordre existant avec cette clé sera mis à jour. Remarque : Seules les commandes dans un état ouvert dans ShipStation (awaiting_payment,awaiting_shipment et on_hold) peuvent être mises à jour via cette méthode. annulés et expédiés sont verrouillés à partir de la modification via l’API.
Retours
Créer une étiquette pour l’ordre
Crée une étiquette d’expédition pour une commande donnée. Le champ labelData retourné dans la réponse est une valeur PDF encodée en base64. Décodez et enregistrez simplement la sortie sous forme de fichier PDF pour récupérer une étiquette imprimable.
Retours
Obtenir une commande
Récupère une commande unique à partir de la base de données.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Obtenir une commande
|
orderId | True | double |
Identificateur généré par le système pour l’ordre. |
Retours
- Corps
- GetOrderResponse
Déclencheurs
| S’abonner au Webhook |
S’abonne à un type spécifique de webhook. Si un store_id est passé, les webhooks ne sont déclenchés que pour cette store_id spécifique. Le type d’événement passé détermine le type de webhooks qui sera envoyé. Doit contenir l’une des valeurs suivantes : ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK. |
S’abonner au Webhook
S’abonne à un type spécifique de webhook. Si un store_id est passé, les webhooks ne sont déclenchés que pour cette store_id spécifique. Le type d’événement passé détermine le type de webhooks qui sera envoyé. Doit contenir l’une des valeurs suivantes : ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
événement
|
event | True | string |
Définitions
GetOrderResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de commande
|
orderId | integer | |
|
numéro de commande
|
orderNumber | string | |
|
Orderkey
|
orderKey | string | |
|
date de commande
|
orderDate | string | |
|
createDate
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
paymentDate
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
customerEmail
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
Éléments
|
items | array of Item | |
|
orderTotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
taxAmount
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
cadeau
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
paymentMethod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
confirmation
|
confirmation | string | |
|
date d’expédition
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Poids
|
weight | Weight | |
|
Dimensions
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |
BillTo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string | |
|
entreprise
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
city
|
city | string | |
|
état
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
téléphone
|
phone | string | |
|
résidentiel
|
residential | string | |
|
addressVerified
|
addressVerified | string |
ShipTo
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string | |
|
entreprise
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
city
|
city | string | |
|
état
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
téléphone
|
phone | string | |
|
résidentiel
|
residential | boolean | |
|
addressVerified
|
addressVerified | string |
Choix
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
nom
|
name | string | |
|
valeur
|
value | string |
Dimensions
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Unités
|
units | string | |
|
length
|
length | float | |
|
width
|
width | float | |
|
height
|
height | float |
InsuranceOptions
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
provider
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
insuredValue
|
insuredValue | float |
InternationalOptions
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
contents
|
contents | string | |
|
customsItems
|
customsItems | array of CustomsItem | |
|
nonDelivery
|
nonDelivery | string |
CustomsItem
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
descriptif
|
description | string | |
|
quantité
|
quantity | float | |
|
valeur
|
value | float | |
|
uniformedTariffCode
|
harmonizedTariffCode | string | |
|
countryOfOrigin
|
countryOfOrigin | string |
AdvancedOptions
| Nom | Chemin d’accès | Type | 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 | |
|
Source
|
source | string | |
|
billToParty
|
billToParty | string | |
|
billToAccount
|
billToAccount | string | |
|
billToPostalCode
|
billToPostalCode | string | |
|
billToCountryCode
|
billToCountryCode | string |
Élément
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
lineItemKey
|
lineItemKey | string | |
|
sku
|
sku | string | |
|
nom
|
name | string | |
|
imageUrl
|
imageUrl | string | |
|
Poids
|
weight | Weight | |
|
quantité
|
quantity | float | |
|
prix unitaire
|
unitPrice | double | |
|
taxAmount
|
taxAmount | double | |
|
shippingAmount
|
shippingAmount | double | |
|
warehouseLocation
|
warehouseLocation | string | |
|
options
|
options | array of Option | |
|
ID de produit
|
productId | integer | |
|
fulfillmentSku
|
fulfillmentSku | string | |
|
Réglage
|
adjustment | boolean | |
|
Upc
|
upc | string |
Poids
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
valeur
|
value | float | |
|
Unités
|
units | string |
CreateLabelforOrderResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
shipmentId
|
shipmentId | integer | |
|
expéditionCost
|
shipmentCost | double | |
|
insuranceCost
|
insuranceCost | float | |
|
numéro de suivi
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de commande
|
orderId | integer | |
|
numéro de commande
|
orderNumber | string | |
|
Orderkey
|
orderKey | string | |
|
date de commande
|
orderDate | string | |
|
createDate
|
createDate | string | |
|
modifyDate
|
modifyDate | string | |
|
paymentDate
|
paymentDate | string | |
|
shipByDate
|
shipByDate | string | |
|
orderStatus
|
orderStatus | string | |
|
customerId
|
customerId | integer | |
|
customerUsername
|
customerUsername | string | |
|
customerEmail
|
customerEmail | string | |
|
BillTo
|
billTo | BillTo | |
|
ShipTo
|
shipTo | ShipTo | |
|
Éléments
|
items | array of Item | |
|
orderTotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
taxAmount
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
cadeau
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
paymentMethod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
confirmation
|
confirmation | string | |
|
date d’expédition
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Poids
|
weight | Weight | |
|
Dimensions
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |