ShipStation Connector

ShipStation is an e-commerce shipping and order fulfillment platform. This component allows you to manage orders, shipments, and carriers in ShipStation.

API Documentation

This component was built using the ShipStation API.

Connections

API Key

Authenticate using an API key and secret.

To authenticate with ShipStation, an API Key and API Secret are required.

Prerequisites

A ShipStation account with API access enabled

Setup Steps

Navigate to the ShipStation account settings
Navigate to the API Settings section
Click Generate New Keys to create a new API Key and API Secret pair
Copy both the API Key and API Secret values

Configure the Connection

Create a connection of type API Key and enter:

API Key: The API Key from the ShipStation account settings
API Secret: The API Secret from the ShipStation account settings

The API key must have the correct permissions to interact with the ShipStation API resources being accessed.

Input	Comments	Default
API Key	The API key from the ShipStation account settings.
API Secret	The API secret from the ShipStation account settings.

Triggers

Manual Webhook

Receive and validate webhook requests from ShipStation for manually configured webhook subscriptions.

New and Updated Orders

Checks for new and updated orders in ShipStation on a configured schedule.

Input	Comments	Default
Connection	The ShipStation connection to use.

New and Updated Products

Checks for new and updated products in ShipStation on a configured schedule.

Input	Comments	Default
Connection	The ShipStation connection to use.

New and Updated Shipments

Checks for new and updated shipments in ShipStation on a configured schedule.

Input	Comments	Default
Connection	The ShipStation connection to use.

Webhook Event Subscription

Receive webhook event notifications from ShipStation. Automatically creates and manages a webhook subscription for the selected event type when the instance is deployed, and removes the subscription when the instance is deleted.

Input	Comments	Default
Connection	The ShipStation connection to use.
Webhook Event	The event type to subscribe to for webhook notifications.
Store ID	The store ID to filter webhook triggers. When provided, webhooks will only trigger for this store.
Friendly Name	A descriptive label to identify the webhook in the dashboard.

Actions

Create Label for Order

Creates a shipping label for a specified order.

Input	Comments	Default
Connection	The ShipStation connection to use.
Order ID	The unique identifier for the order.
Carrier Code	The carrier code for the shipping label.
Service Code	The shipping service code for the label.
Confirmation	The delivery confirmation type (e.g., none, delivery, signature, adult_signature, direct_signature).
Ship Date	The date the order should be shipped in YYYY-MM-DD format.
Test Label	When true, creates a test label.	false
Additional Fields	A list of additional fields to include in the label for order.

Create or Update Multiple Orders

Creates or updates multiple orders in one request.

Input Comments Default

Connection The ShipStation connection to use.

Orders Array

Provide an array of order objects to create or update multiple orders.

[
 {
 "orderNumber": "TEST-ORDER-001",
 "orderDate": "2023-09-08T12:34:56.000Z",
 "orderStatus": "awaiting_shipment",
 "billTo": {
 "name": "John Doe",
 "street1": "123 Main St",
 "city": "Anytown",
 "state": "CA",
 "postalCode": "12345",
 "country": "US"
 },
 "shipTo": {
 "name": "John Doe",
 "street1": "123 Main St",
 "city": "Anytown",
 "state": "CA",
 "postalCode": "12345",
 "country": "US"
 }
 },
 {
 "orderNumber": "TEST-ORDER-002",
 "orderDate": "2023-09-09T12:34:56.000Z",
 "orderStatus": "awaiting_payment",
 "billTo": {
 "name": "Jane Doe",
 "street1": "456 Another St",
 "city": "Othertown",
 "state": "NY",
 "postalCode": "67890",
 "country": "US"
 },
 "shipTo": {
 "name": "Jane Doe",
 "street1": "456 Another St",
 "city": "Othertown",
 "state": "NY",
 "postalCode": "67890",
 "country": "US"
 }
 }
]

Create or Update Order

Creates a new order or updates an existing one.

Input	Comments	Default
Connection	The ShipStation connection to use.
Order Number	The user-defined order number to identify the order.
Order Date	The date the order was placed. Format: ISO 8601 (e.g., 2023-09-08T12:34:56.000Z).	2023-09-08T12:34:56.000Z
Order Status	The order status to filter results (e.g., awaiting_payment, awaiting_shipment, shipped).
Order Key	The unique order key. If provided, the create order method will either create a new order if the key is not found, or update the existing order if found.
Billing Address	Provide the billing address in JSON format.	`{ "name": "John Doe", "company": "JD Company", "street1": "123 Main St", "city": "Austin", "state": "TX", "postalCode": "78701", "country": "US", "phone": "123-456-7890", "residential": true }`
Shipping Address	Provide the shipping address in JSON format.	`{ "name": "Jane Doe", "company": "JD Company", "street1": "123 Main St", "city": "Austin", "state": "TX", "postalCode": "78701", "country": "US", "phone": "123-456-7890", "residential": true }`
Additional Fields	A list of additional fields to include in the order.

Create Shipment Label

Creates a shipping label.

Input	Comments	Default
Connection	The ShipStation connection to use.
Carrier Code	The carrier code for the shipping label.
Service Code	The shipping service code for the label.
Package Code	The package type code for the label.
Ship Date	The date the order should be shipped in YYYY-MM-DD format.
Shipment's Weight	The weight of the shipment, following the Weight model. Note: WeightUnits is read-only.	`{ "value": 3, "units": "ounces", "WeightUnits": 2 }`
Shipping Address	Provide the shipping address in JSON format.	`{ "name": "Jane Doe", "company": "JD Company", "street1": "123 Main St", "city": "Austin", "state": "TX", "postalCode": "78701", "country": "US", "phone": "123-456-7890", "residential": true }`
Origin Address	Provide the origin address in JSON format.	`{ "name": "John Smith", "company": "JS Company", "street1": "456 Elm St", "city": "San Francisco", "state": "CA", "postalCode": "94107", "country": "US", "phone": "987-654-3210", "residential": false }`
Additional Fields	A list of additional fields to include in the shipment.

Create Warehouse

Creates a Ship From Location (warehouse) in the ShipStation account.

Input	Comments	Default
Connection	The ShipStation connection to use.
Warehouse Name	A descriptive label for the ship-from location.
Origin Address	The origin address. Shipping rates will be calculated from this address.
Return Address	The return address. If not specified, the origin address will be used.
Is Default Warehouse	When true, sets this as the default ship from location.	false

Deactivate Store

Deactivates the specified store.

Input	Comments	Default
Connection	The ShipStation connection to use.
Store ID	The unique identifier for the store.

Delete Instanced Webhooks

Deletes all webhooks that point to a flow in this instance.

Input	Comments	Default
Connection	The ShipStation connection to use.

Delete Order

Deletes an order from the database by setting it to inactive.

Input	Comments	Default
Connection	The ShipStation connection to use.
Order ID	The unique identifier for the order.

Delete Warehouse

Deletes a warehouse (Ship From Location) by setting it to inactive status.

Input	Comments	Default
Connection	The ShipStation connection to use.
Warehouse ID	The unique identifier for the warehouse.

Get Customer

Retrieves a specific customer by their system-generated identifier.

Input	Comments	Default
Connection	The ShipStation connection to use.
Customer ID	The unique identifier for the customer.

Get Order

Retrieves a single order from the database.

Input	Comments	Default
Connection	The ShipStation connection to use.
Order ID	The unique identifier for the order.

Get Product

Retrieves a specific product from the database by its ID.

Input	Comments	Default
Connection	The ShipStation connection to use.
Product ID	The unique identifier for the product.

Get Store

Retrieves detailed information about a specific store.

Input	Comments	Default
Connection	The ShipStation connection to use.
Store ID	The unique identifier for the store.

Get Warehouse

Retrieves detailed information about a specific Ship From Location (warehouse).

Input	Comments	Default
Connection	The ShipStation connection to use.
Warehouse ID	The unique identifier for the warehouse.

List Carriers

Lists all shipping providers connected to the ShipStation account.

Input	Comments	Default
Connection	The ShipStation connection to use.

List Customers

Retrieves a list of customers based on specified criteria.

Input	Comments	Default
Connection	The ShipStation connection to use.
State Code	The two-letter state or province abbreviation for the customer address.
Country Code	The two-letter ISO country code to filter customers.
Marketplace ID	The unique identifier for the marketplace to filter results by.
Tag ID	The unique identifier for the tag to filter results by.
Sort By	The API field name used to sort the returned results.
Sort Direction	The direction to sort results (asc or desc).
Page	The page number to retrieve (starts at 1).
Page Size	The maximum number of results to return per page. Maximum: 500.

List Fulfillments

Retrieves a list of fulfillments based on specified criteria.

Input	Comments	Default
Connection	The ShipStation connection to use.
Fulfillment ID	The unique identifier for the fulfillment.
Order ID	The unique identifier for the order.
Page	The page number to retrieve (starts at 1).
Page Size	The maximum number of results to return per page. Maximum: 500.

List Orders

Retrieves a list of orders based on specified criteria.

Input	Comments	Default
Connection	The ShipStation connection to use.
Customer Name	The full name associated with the customer record.
Order Status	The order status to filter results (e.g., awaiting_payment, awaiting_shipment, shipped).
Page	The page number to retrieve (starts at 1).
Page Size	The maximum number of results to return per page. Maximum: 500.

List Packages

Retrieves a list of packages for the specified carrier.

Input	Comments	Default
Connection	The ShipStation connection to use.
Carrier Code	The carrier code for the shipping label.

List Products

Retrieves a list of products that match the specified criteria.

Input	Comments	Default
Connection	The ShipStation connection to use.
SKU	The stock keeping unit code assigned to the product.
Product Name	The display name of the product to search for.
Product Category ID	The unique identifier for the category grouping the product.
Product Type ID	The unique identifier for the product type classification.
Tag ID	The unique identifier for the tag to filter results by.
Start Date	The start date to filter products by creation date in YYYY-MM-DD format.
End Date	The end date to filter products by creation date in YYYY-MM-DD format.
Sort By	The API field name used to sort the returned results.
Sort Direction	The direction to sort results (asc or desc).
Page	The page number to retrieve (starts at 1).
Page Size	The maximum number of results to return per page. Maximum: 500.
Show Inactive	When true, includes inactive stores in the results.	false

List Services

Retrieves the list of available shipping services for the specified carrier.

Input	Comments	Default
Connection	The ShipStation connection to use.
Carrier Code	The carrier code for the shipping label.

List Shipments

Retrieves a list of shipments that match the specified criteria.

Input	Comments	Default
Connection	The ShipStation connection to use.
Tracking Number	The carrier-assigned tracking number for the shipment.
Create Date Start	The start date to filter shipments by creation date in YYYY-MM-DD format.
Create Date End	The end date to filter shipments by creation date in YYYY-MM-DD format.
Ship Date Start	The start date to filter shipments by ship date in YYYY-MM-DD format.
Ship Date End	The end date to filter shipments by ship date in YYYY-MM-DD format.
Recipient Name	The name of the person or business receiving the shipment.
Recipient Country Code	The two-letter ISO country code to filter shipments by recipient country.
Page	The page number to retrieve (starts at 1).
Page Size	The maximum number of results to return per page. Maximum: 500.

List Stores

Retrieves the list of installed stores on the account.

Input	Comments	Default
Connection	The ShipStation connection to use.
Show Inactive	When true, includes inactive stores in the results.	false
Marketplace ID	The marketplace ID to filter stores.

List Users

Retrieves the list of users on the account.

Input	Comments	Default
Connection	The ShipStation connection to use.
Show Inactive Users	When true, includes inactive users in the results.	false

List Warehouses

Retrieves a list of Ship From Locations (warehouses) in the account.

Input	Comments	Default
Connection	The ShipStation connection to use.

List Webhooks

Retrieves a list of registered webhooks for the account.

Input	Comments	Default
Connection	The ShipStation connection to use.

Raw Request

Sends a raw HTTP request to the ShipStation API.

Input	Comments	Default
URL	This is the URL to call.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false
Connection	The ShipStation connection to use.

Subscribe to Webhook

Subscribes to a specific type of webhook in ShipStation.

Input	Comments	Default
Connection	The ShipStation connection to use.
Target URL	The URL where webhook events will be sent.
Event	The webhook event type to subscribe to.
Store ID	The store ID to filter webhook triggers. When provided, webhooks will only trigger for this store.
Friendly Name	A descriptive label to identify the webhook in the dashboard.

Unsubscribe from Webhook

Unsubscribes from a specific type of webhook in ShipStation.

Input	Comments	Default
Connection	The ShipStation connection to use.
Webhook ID	The unique identifier for the webhook.

Update Product

Updates an existing product.

Input	Comments	Default
Connection	The ShipStation connection to use.
Product ID	The unique identifier for the product.
Product Data	The complete data for updating the product. This call does not support partial updates.	`{ "aliases": null, "productId": 123456789, "sku": "BEAU-000" }`

Update Store

Updates an existing store.

Input	Comments	Default
Connection	The ShipStation connection to use.
Store ID	The unique identifier for the store.
Store Update Data	All the data needed to update an existing store. Must provide the entire resource.	`{ "storeId": 12345, "storeName": "WooCommerce Store", "marketplaceId": 36 }`

Update Warehouse

Updates an existing Ship From Location (warehouse).

Input	Comments	Default
Connection	The ShipStation connection to use.
Warehouse Update Data	All the data needed to update an existing Ship From Location. Must provide the entire resource.	`{ "warehouseId": 12345, "warehouseName": "API Ship From Location" }`

API Documentation​

Connections​

API Key​

Prerequisites​

Setup Steps​

Configure the Connection​

Triggers​

Manual Webhook​

New and Updated Orders​

New and Updated Products​

New and Updated Shipments​

Webhook Event Subscription​

Actions​

Create Label for Order​

Create or Update Multiple Orders​

Create or Update Order​

Create Shipment Label​

Create Warehouse​

Deactivate Store​

Delete Instanced Webhooks​

Delete Order​

Delete Warehouse​

Get Customer​

Get Order​

Get Product​

Get Store​

Get Warehouse​

List Carriers​

List Customers​

List Fulfillments​

List Orders​

List Packages​

List Products​

List Services​

List Shipments​

List Stores​

List Users​

List Warehouses​

List Webhooks​

Raw Request​

Subscribe to Webhook​

Unsubscribe from Webhook​

Update Product​

Update Store​

Update Warehouse​