We're currently building and refining our Knowledge Center. You may encounter layout issues, styling inconsistencies, or minor technical quirks as we finalize the platform.

ShipStation Connector

Updated
  • Updated on Mar 25, 2026
  • Published on Feb 19, 2026
  • 11 minute(s) read
  • SG
 Prev Next
Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

ShipStation is an e-commerce shipping solution that streamlines the order fulfillment process.
This component allows listing, creating, updating, and deleting orders and shipments in the ShipStation account.

API Documentation

This component was built using the ShipStation API Documentation.

Connections

API Key

Authenticate requests 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

  1. Navigate to the ShipStation account settings
  2. Navigate to the API Settings section
  3. Click Generate New Keys to create a new API Key and API Secret pair
  4. 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

Webhook

Receive and validate webhook requests from ShipStation for webhooks you configure.

Actions

Create Label for Order

Creates a shipping label for a specified order.

Input Comments Default
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
Connection The ShipStation connection to use.
Fields A list of additional fields to include in the label for order.

Create or Update Multiple Orders

Create or update multiple orders in one request.

Input Comments Default
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"
}
}
]
Connection The ShipStation connection to use.

Create or Update Order

Create a new order or update an existing one.

Input Comments Default
Order Number The user-defined order number to identify the order.
Order Date The date the order was placed. 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
}
Connection The ShipStation connection to use.
Field A list of additional fields to include in the order.
Debug Request Enabling this flag will log out the current request. false

Create Shipment Label

Creates a shipping label.

Input Comments Default
Connection The ShipStation connection to use.
Carrier Code The carrier code for shipping.
Service Code The shipping service code for the label.
Package Code The package type code for the label.
Ship Date The date the shipment will 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
}
Field A list of additional fields to include in the shipment.

Create Warehouse

Adds a Ship From Location (formerly known as warehouse) to your account.

Input Comments Default
Connection The ShipStation connection to use.
Warehouse Name The name of 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

Soft delete an order from the database, setting it to inactive.

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

Delete Warehouse

Removes a warehouse (or Ship From location) from ShipStation's UI. Sets it to Inactive status.

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

Get Customer

Retrieve a specific customer by their system generated identifier

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

Get Order

Retrieve a single order from the database.

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

Get Product

Retrieve a specific product from the database by its ID.

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

Get Store

Retrieve 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

Retrieve detailed information about a specific Ship From Location (formerly known as warehouse).

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

List Carriers

List all shipping providers connected to this ShipStation account.

Input Comments Default
Connection The ShipStation connection to use.

List Customers

Retrieve a list of customers based on specified criteria

Input Comments Default
State Code The state code to filter customers.
Country Code The two-letter ISO country code to filter customers.
Marketplace ID The marketplace ID to filter customers.
Tag ID The tag ID to filter customers.
Sort By The field name to sort results by.
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.
Connection The ShipStation connection to use.

List Fulfillments

Retrieve 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

Retrieve a list of orders based on specified criteria.

Input Comments Default
Customer Name The customer name to filter orders.
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.
Connection The ShipStation connection to use.

List Packages

Retrieves a list of packages for the specified carrier.

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

List Products

Obtains a list of products that match the specified criteria.

Input Comments Default
Connection The ShipStation connection to use.
SKU The SKU to filter products.
Product Name The product name to filter results.
Product Category ID The product category ID to filter results.
Product Type ID The product type ID to filter results.
Tag ID The tag ID to filter customers.
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 field name to sort results by.
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 provided by the specified carrier.

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

List Shipments

Obtains a list of shipments that match the specified criteria.

Input Comments Default
Connection The ShipStation connection to use.
Tracking Number The tracking number to filter shipments.
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 recipient name to filter shipments.
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

Retrieve 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

Retrieve the list of users on the account.

Input Comments Default
Connection The ShipStation connection to use.
Show Inactive Users Determines whether inactive users will be returned in the list of users. false

List Warehouses

Retrieves a list of your Ship From Locations (formerly known as warehouses).

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

Send raw HTTP request to ShipStation.

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
Debug Request Enabling this flag will log out the current request. false
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 The display name for the webhook.

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
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"
}
Connection The ShipStation connection to use.

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 (formerly known as 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"
}
Related articles

Contact

Copyright © 2026 Lansweeper

Trust Center

Privacy Policy

Cookie declaration

Terms of Service

Reselling Terms