Share via

ShipStation (Preview)

ShipStation is the leading web-based shipping software that helps online retailers streamline their order fulfillment, wherever they sell and however they ship.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Contact
Name Microsoft Dynamics
URL https://dynamics.microsoft.com/en-us/support/
Email iomdri@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://www.shipstation.com/
Privacy policy https://www.shipstation.com/privacy-policy/
Categories Productivity

This connector was specifically developed to be used for Dynamics 365 Intelligent Order Management's ShipStation provider integration.

Prerequisites

A ShipStation developer account is required. If you don't have one you can create it at https://www.shipstation.com/docs/api/requirements/. Note: It is recommended to use this connector specifically to set up the Dynamics 365 Intelligent Order Management ShipStation provider.

How to get credentials

ShipStation requires an API Key and Secret for authentication. You can generate a token https://ship13.shipstation.com/settings/api and use that to configure the connector.

Getting started with your connector

Configure the connection with the API Key and Secret. To learn more about ShipStation's API's read the public documentation: https://www.shipstation.com/docs/api/

Known issues and limitations

This connector was specifically developed to be used for Dynamics 365 Intelligent Order Management's ShipStation provider integration. Support for usecases outside of Dynamics 365 Intelligent Order Management will be limited.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
username securestring The username for this api True
password securestring The password for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create Label for Order

Creates a shipping label for a given order. The labelData field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label.
Create or Update Order

If the orderKey is specified, the method becomes idempotent and the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (awaiting_payment,awaiting_shipment, and on_hold) can be updated through this method. cancelled and shipped are locked from modification through the API.
Get Order

Retrieves a single order from the database.

Create Label for Order

Operation ID:
CreateLabelForOrder

Creates a shipping label for a given order. The labelData field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label.

Returns

Body
CreateLabelforOrderResponse

Create or Update Order

Operation ID:
CreateUpdateOrder

If the orderKey is specified, the method becomes idempotent and the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (awaiting_payment,awaiting_shipment, and on_hold) can be updated through this method. cancelled and shipped are locked from modification through the API.

Returns

Body
CreateUpdateOrderResponse

Get Order

Operation ID:
GetOrderById

Retrieves a single order from the database.

Parameters

Name Key Required Type Description
Get Order
 orderId True double

The system generated identifier for the order.

Returns

Body
GetOrderResponse

Triggers

Subscribe to Webhook

Subscribes to a specific type of webhook. If a store_id is passed in, the webhooks will only be triggered for that specific store_id. The event type that is passed in will determine what type of webhooks will be sent.Must contain one of the following values:ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK.

Subscribe to Webhook

Operation ID:
WebhookSubscribe

Subscribes to a specific type of webhook. If a store_id is passed in, the webhooks will only be triggered for that specific store_id. The event type that is passed in will determine what type of webhooks will be sent.Must contain one of the following values:ORDER_NOTIFY, ITEM_ORDER_NOTIFY, SHIP_NOTIFY, ITEM_SHIP_NOTIFY, API_TRACK.

Parameters

Name Key Required Type Description
friendly_name
 friendly_name True string
store_id
 store_id string
event
 event True string

Returns

Definitions

GetOrderResponse

Name Path Type Description
orderId
 orderId integer
orderNumber
 orderNumber string
orderKey
 orderKey string
orderDate
 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
gift
 gift boolean
giftMessage
 giftMessage string
paymentMethod
 paymentMethod string
requestedShippingService
 requestedShippingService string
carrierCode
 carrierCode string
serviceCode
 serviceCode string
packageCode
 packageCode string
confirmation
 confirmation string
shipDate
 shipDate string
holdUntilDate
 holdUntilDate string
Weight
 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

Name Path Type Description
name
 name string
company
 company string
street1
 street1 string
street2
 street2 string
street3
 street3 string
city
 city string
state
 state string
postalCode
 postalCode string
country
 country string
phone
 phone string
residential
 residential string
addressVerified
 addressVerified string

ShipTo

Name Path Type Description
name
 name string
company
 company string
street1
 street1 string
street2
 street2 string
street3
 street3 string
city
 city string
state
 state string
postalCode
 postalCode string
country
 country string
phone
 phone string
residential
 residential boolean
addressVerified
 addressVerified string

Option

Name Path Type Description
name
 name string
value
 value string

Dimensions

Name Path Type Description
units
 units string
length
 length float
width
 width float
height
 height float

InsuranceOptions

Name Path Type Description
provider
 provider string
insureShipment
 insureShipment boolean
insuredValue
 insuredValue float

InternationalOptions

Name Path Type Description
contents
 contents string
customsItems
 customsItems array of CustomsItem
nonDelivery
 nonDelivery string

CustomsItem

Name Path Type Description
customsItemId
 customsItemId integer
description
 description string
quantity
 quantity float
value
 value float
harmonizedTariffCode
 harmonizedTariffCode string
countryOfOrigin
 countryOfOrigin string

AdvancedOptions

Name Path 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

Item

Name Path Type Description
lineItemKey
 lineItemKey string
sku
 sku string
name
 name string
imageUrl
 imageUrl string
Weight
 weight Weight
quantity
 quantity float
unitPrice
 unitPrice double
taxAmount
 taxAmount double
shippingAmount
 shippingAmount double
warehouseLocation
 warehouseLocation string
options
 options array of Option
productId
 productId integer
fulfillmentSku
 fulfillmentSku string
adjustment
 adjustment boolean
upc
 upc string

Weight

Name Path Type Description
value
 value float
units
 units string

CreateLabelforOrderResponse

Name Path Type Description
shipmentId
 shipmentId integer
shipmentCost
 shipmentCost double
insuranceCost
 insuranceCost float
trackingNumber
 trackingNumber string
labelData
 labelData string
formData
 formData string

CreateUpdateOrderResponse

Name Path Type Description
orderId
 orderId integer
orderNumber
 orderNumber string
orderKey
 orderKey string
orderDate
 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
gift
 gift boolean
giftMessage
 giftMessage string
paymentMethod
 paymentMethod string
requestedShippingService
 requestedShippingService string
carrierCode
 carrierCode string
serviceCode
 serviceCode string
packageCode
 packageCode string
confirmation
 confirmation string
shipDate
 shipDate string
holdUntilDate
 holdUntilDate string
Weight
 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