ShipStation (versión preliminar)
ShipStation es el software de envío basado en web líder que ayuda a los minoristas en línea a optimizar su suministro de pedidos, dondequiera que vendan y sin embargo se envíen.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| Correo electrónico | iomdri@microsoft.com |
| Metadatos del conector | |
|---|---|
| Publicador | Microsoft |
| Sitio web | https://www.shipstation.com/ |
| Directiva de privacidad | https://www.shipstation.com/privacy-policy/ |
| Categorías | Productividad |
Este conector se desarrolló específicamente para su uso para la integración del proveedor ShipStation de Dynamics 365 Intelligent Order Management.
Prerrequisitos
Se requiere una cuenta de desarrollador de ShipStation. Si no tiene una, puede crearla en https://www.shipstation.com/docs/api/requirements/. Nota: Se recomienda usar este conector específicamente para configurar el proveedor ShipStation de Administración inteligente de pedidos de Dynamics 365.
Obtención de credenciales
ShipStation requiere una clave de API y un secreto para la autenticación. Puede generar un token https://ship13.shipstation.com/settings/api y usarlo para configurar el conector.
Introducción al conector
Configure la conexión con la clave de API y el secreto. Para obtener más información sobre la API de ShipStation, lea la documentación pública: https://www.shipstation.com/docs/api/
Problemas y limitaciones conocidos
Este conector se desarrolló específicamente para su uso para la integración del proveedor ShipStation de Dynamics 365 Intelligent Order Management. La compatibilidad con casos de uso fuera de Dynamics 365 Intelligent Order Management estará limitada.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| nombre de usuario | securestring | El nombre de usuario de esta API | Cierto |
| contraseña | securestring | La contraseña de esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Crear etiqueta para pedido |
Crea una etiqueta de envío para un pedido determinado. El campo labelData devuelto en la respuesta es un valor PDF codificado en base64. Simplemente descodifique y guarde la salida como un archivo PDF para recuperar una etiqueta imprimible. |
| Crear o actualizar pedido |
Si se especifica orderKey, el método se convierte en idempotente y el orden existente con esa clave se actualizará. Nota: Solo los pedidos en un estado abierto en ShipStation (awaiting_payment,awaiting_shipment y on_hold) se pueden actualizar a través de este método. cancelados y enviados se bloquean de la modificación a través de la API. |
| Obtener pedido |
Recupera un único pedido de la base de datos. |
Crear etiqueta para pedido
Crea una etiqueta de envío para un pedido determinado. El campo labelData devuelto en la respuesta es un valor PDF codificado en base64. Simplemente descodifique y guarde la salida como un archivo PDF para recuperar una etiqueta imprimible.
Devoluciones
Crear o actualizar pedido
Si se especifica orderKey, el método se convierte en idempotente y el orden existente con esa clave se actualizará. Nota: Solo los pedidos en un estado abierto en ShipStation (awaiting_payment,awaiting_shipment y on_hold) se pueden actualizar a través de este método. cancelados y enviados se bloquean de la modificación a través de la API.
Devoluciones
Obtener pedido
Recupera un único pedido de la base de datos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Obtener pedido
|
orderId | True | double |
Identificador generado por el sistema para el pedido. |
Devoluciones
- Body
- GetOrderResponse
Desencadenadores
| Suscripción a Webhook |
Se suscribe a un tipo específico de webhook. Si se pasa un store_id, los webhooks solo se desencadenarán para ese store_id específico. El tipo de evento que se pasa determinará qué tipo de webhooks se enviará. Debe contener uno de los siguientes valores: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK. |
Suscripción a Webhook
Se suscribe a un tipo específico de webhook. Si se pasa un store_id, los webhooks solo se desencadenarán para ese store_id específico. El tipo de evento que se pasa determinará qué tipo de webhooks se enviará. Debe contener uno de los siguientes valores: ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
friendly_name
|
friendly_name | True | string | |
|
store_id
|
store_id | string | ||
|
evento
|
event | True | string |
Definiciones
GetOrderResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID de pedido
|
orderId | integer | |
|
número de pedido
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
fechaDePedido
|
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 | |
|
items
|
items | array of Item | |
|
orderTotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
taxAmount
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
regalo
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
paymentMethod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
confirmación
|
confirmation | string | |
|
shipDate
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Peso
|
weight | Weight | |
|
Dimensiones
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |
BillTo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string | |
|
empresa
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
city
|
city | string | |
|
estado
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
residencial
|
residential | string | |
|
addressVerified
|
addressVerified | string |
ShipTo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string | |
|
empresa
|
company | string | |
|
street1
|
street1 | string | |
|
street2
|
street2 | string | |
|
street3
|
street3 | string | |
|
city
|
city | string | |
|
estado
|
state | string | |
|
postalCode
|
postalCode | string | |
|
country
|
country | string | |
|
phone
|
phone | string | |
|
residencial
|
residential | boolean | |
|
addressVerified
|
addressVerified | string |
Opción
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string | |
|
value
|
value | string |
Dimensiones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
unidades
|
units | string | |
|
length
|
length | float | |
|
Ancho
|
width | float | |
|
altura
|
height | float |
InsuranceOptions
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
provider
|
provider | string | |
|
insureShipment
|
insureShipment | boolean | |
|
insuredValue
|
insuredValue | float |
InternationalOptions
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contents
|
contents | string | |
|
customsItems
|
customsItems | array of CustomsItem | |
|
nonDelivery
|
nonDelivery | string |
CustomsItem
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
customsItemId
|
customsItemId | integer | |
|
descripción
|
description | string | |
|
cantidad
|
quantity | float | |
|
value
|
value | float | |
|
harmonidTariffCode
|
harmonizedTariffCode | string | |
|
countryOfOrigin
|
countryOfOrigin | string |
AdvancedOptions
| Nombre | Ruta de acceso | Tipo | 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 |
Elemento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
lineItemKey
|
lineItemKey | string | |
|
sku
|
sku | string | |
|
nombre
|
name | string | |
|
imageUrl
|
imageUrl | string | |
|
Peso
|
weight | Weight | |
|
cantidad
|
quantity | float | |
|
precio unitario
|
unitPrice | double | |
|
taxAmount
|
taxAmount | double | |
|
shippingAmount
|
shippingAmount | double | |
|
warehouseLocation
|
warehouseLocation | string | |
|
options
|
options | array of Option | |
|
ID de producto
|
productId | integer | |
|
fulfillmentSku
|
fulfillmentSku | string | |
|
ajuste
|
adjustment | boolean | |
|
Upc
|
upc | string |
Peso
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | float | |
|
unidades
|
units | string |
CreateLabelforOrderResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
shipmentId
|
shipmentId | integer | |
|
shipmentCost
|
shipmentCost | double | |
|
insuranceCost
|
insuranceCost | float | |
|
trackingNumber
|
trackingNumber | string | |
|
labelData
|
labelData | string | |
|
formData
|
formData | string |
CreateUpdateOrderResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID de pedido
|
orderId | integer | |
|
número de pedido
|
orderNumber | string | |
|
orderKey
|
orderKey | string | |
|
fechaDePedido
|
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 | |
|
items
|
items | array of Item | |
|
orderTotal
|
orderTotal | double | |
|
amountPaid
|
amountPaid | double | |
|
taxAmount
|
taxAmount | float | |
|
shippingAmount
|
shippingAmount | float | |
|
customerNotes
|
customerNotes | string | |
|
internalNotes
|
internalNotes | string | |
|
regalo
|
gift | boolean | |
|
giftMessage
|
giftMessage | string | |
|
paymentMethod
|
paymentMethod | string | |
|
requestedShippingService
|
requestedShippingService | string | |
|
carrierCode
|
carrierCode | string | |
|
serviceCode
|
serviceCode | string | |
|
packageCode
|
packageCode | string | |
|
confirmación
|
confirmation | string | |
|
shipDate
|
shipDate | string | |
|
holdUntilDate
|
holdUntilDate | string | |
|
Peso
|
weight | Weight | |
|
Dimensiones
|
dimensions | Dimensions | |
|
InsuranceOptions
|
insuranceOptions | InsuranceOptions | |
|
InternationalOptions
|
internationalOptions | InternationalOptions | |
|
AdvancedOptions
|
advancedOptions | AdvancedOptions | |
|
tagIds
|
tagIds | string | |
|
userId
|
userId | string | |
|
externallyFulfilled
|
externallyFulfilled | boolean | |
|
externallyFulfilledBy
|
externallyFulfilledBy | string |