Skip to main content

ShipStation Component

ShipStation is an ecommerce shipping software solution.

Component key: shipstation

Changelog ↓

Description​

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.

Documentation for the Axios client used in this component is available at the Axios GitHub Repository.

A frequent integration pattern is to list orders or shipments from ShipStation and perform actions on the array of orders or shipments returned.

Refer to loop integration patterns for details on how to create a loop over an array of orders.

Connections​

API Key​

key: shipStationApiKey

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.

InputNotesExample
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. | key: shipStationWebhookTrigger

Data Sources​

Select Carriers​

List and select from all of the carriers connected to this ShipStation account. | key: selectCarriers | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Select Customers​

List and select from all of the customers based on specified criteria in this ShipStation account. | key: selectCustomers | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Country Code

The two-letter ISO country code to filter customers.

Marketplace ID

The marketplace ID to filter customers.

Page

The page number to retrieve (starts at 1).

Page Size

The maximum number of results to return per page. Maximum: 500.

Sort By

The field name to sort results by.

Sort Direction

The direction to sort results (asc or desc).

State Code

The state code to filter customers.

Tag ID

The tag ID to filter customers.

Select Orders​

List and select from orders based on customer name and order status. | key: selectOrders | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Customer Name

The customer name to filter orders.

test
Order Status

The order status to filter results (e.g., awaiting_payment, awaiting_shipment, shipped).

awaiting_payment, awaiting_shipment, shipped, etc.
Page

The page number to retrieve (starts at 1).

1
Page Size

The maximum number of results to return per page. Maximum: 500.

1

Select Packages​

List and select from all of the packages provided by the specified carrier in this ShipStation account. | key: selectPackages | type: picklist

InputNotesExample
Carrier Code

The carrier code for shipping.

Connection

The ShipStation connection to use.

Select Products​

List and select from products based on SKU, name, or other criteria. | key: selectProducts | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

End Date

The end date to filter products by creation date in YYYY-MM-DD format.

2014-05-04
Page

The page number to retrieve (starts at 1).

Page Size

The maximum number of results to return per page. Maximum: 500.

Product Category ID

The product category ID to filter results.

Product Name

The product name to filter results.

Product Type ID

The product type ID to filter results.

Show Inactive

When true, includes inactive stores in the results.

false
SKU

The SKU to filter products.

Sort By

The field name to sort results by.

Sort Direction

The direction to sort results (asc or desc).

Start Date

The start date to filter products by creation date in YYYY-MM-DD format.

2014-04-03
Tag ID

The tag ID to filter customers.

Select Services​

List and select from all of the services provided by the specified carrier in this ShipStation account. | key: selectServices | type: picklist

InputNotesExample
Carrier Code

The carrier code for shipping.

Connection

The ShipStation connection to use.

Select Stores​

List and select from all of the installed stores in this ShipStation account. | key: selectStores | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Marketplace ID

The marketplace ID to filter customers.

Show Inactive

When true, includes inactive stores in the results.

false

Select Users​

List and select from all of the users in this ShipStation account. | key: selectUsers | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Show Inactive Users

Determines whether inactive users will be returned in the list of users.

false

Select Warehouses​

List and select from all Ship From Locations (warehouses) in this ShipStation account. | key: selectWarehouses | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Actions​

Create Label for Order​

Creates a shipping label for a specified order. | key: createLabelForOrder

InputNotesExample
Fields

A list of additional fields to include in the label for order.

weight: {value: 2, units: 'pounds'}
Carrier Code

The carrier code for the shipping label.

Confirmation

The delivery confirmation type (e.g., none, delivery, signature, adult_signature, direct_signature).

none, delivery, signature, adult_signature, direct_signature
Connection

The ShipStation connection to use.

Order ID

The unique identifier for the order.

Service Code

The shipping service code for the label.

Ship Date

The date the order should be shipped in YYYY-MM-DD format.

2014-04-03
Test Label

When true, creates a test label.

false

Create or Update Multiple Orders​

Create or update multiple orders in one request. | key: createOrUpdateMultipleOrders

InputNotesExample
Connection

The ShipStation connection to use.

Orders Array

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

Create or Update Order​

Create a new order or update an existing one. | key: createOrUpdateOrder

InputNotesExample
Field

A list of additional fields to include in the order.

paymentMethod: Credit Card
Billing Address

Provide the billing address in JSON format.

Connection

The ShipStation connection to use.

Debug Request

Enabling this flag will log out the current request.

false
Order Date

The date the order was placed.

2023-09-08T12:34:56.000Z
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.

0f6bec18-3e89-4881-83aa-f392d84f4c74
Order Number

The user-defined order number to identify the order.

TEST-ORDER-API-DOCS
Order Status

The order status to filter results (e.g., awaiting_payment, awaiting_shipment, shipped).

awaiting_payment, awaiting_shipment, shipped, etc.
Shipping Address

Provide the shipping address in JSON format.

{
  "data": {
    "orderId": 140335319,
    "orderNumber": "TEST-ORDER-API-DOCS",
    "orderKey": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
    "orderDate": "2015-06-29T08:46:27.0000000",
    "createDate": "2016-02-16T15:16:53.7070000",
    "modifyDate": "2016-02-16T15:16:53.7070000",
    "paymentDate": "2015-06-29T08:46:27.0000000",
    "shipByDate": "2015-07-05T00:00:00.0000000",
    "orderStatus": "awaiting_shipment",
    "customerId": null,
    "customerUsername": "president@example.com",
    "customerEmail": "president@example.com",
    "billTo": {
      "name": "The President",
      "company": null,
      "street1": null,
      "street2": null,
      "street3": null,
      "city": null,
      "state": null,
      "postalCode": null,
      "country": null,
      "phone": null,
      "residential": null,
      "addressVerified": null
    },
    "shipTo": {
      "name": "The President",
      "company": "US Govt",
      "street1": "1600 Pennsylvania Ave",
      "street2": "Oval Office",
      "street3": null,
      "city": "Washington",
      "state": "DC",
      "postalCode": "20500",
      "country": "US",
      "phone": "555-555-5555",
      "residential": false,
      "addressVerified": "Address validation warning"
    },
    "items": [
      {
        "orderItemId": 192210956,
        "lineItemKey": "vd08-MSLbtx",
        "sku": "ABC123",
        "name": "Test item #1",
        "imageUrl": null,
        "weight": {
          "value": 24,
          "units": "ounces"
        },
        "quantity": 2,
        "unitPrice": 99.99,
        "taxAmount": 2.5,
        "shippingAmount": 5,
        "warehouseLocation": "Aisle 1, Bin 7",
        "options": [
          {
            "name": "Size",
            "value": "Large"
          }
        ],
        "productId": null,
        "fulfillmentSku": null,
        "adjustment": false,
        "upc": "32-65-98",
        "createDate": "2016-02-16T15:16:53.707",
        "modifyDate": "2016-02-16T15:16:53.707"
      },
      {
        "orderItemId": 192210957,
        "lineItemKey": null,
        "sku": "DISCOUNT CODE",
        "name": "10% OFF",
        "imageUrl": null,
        "weight": {
          "value": 0,
          "units": "ounces"
        },
        "quantity": 1,
        "unitPrice": -20.55,
        "taxAmount": null,
        "shippingAmount": null,
        "warehouseLocation": null,
        "options": [],
        "productId": null,
        "fulfillmentSku": "SKU-Discount",
        "adjustment": true,
        "upc": null,
        "createDate": "2016-02-16T15:16:53.707",
        "modifyDate": "2016-02-16T15:16:53.707"
      }
    ],
    "orderTotal": 194.43,
    "amountPaid": 218.73,
    "taxAmount": 5,
    "shippingAmount": 10,
    "customerNotes": "Please ship as soon as possible!",
    "internalNotes": "Customer called and would like to upgrade shipping",
    "gift": true,
    "giftMessage": "Thank you!",
    "paymentMethod": "Credit Card",
    "requestedShippingService": "Priority Mail",
    "carrierCode": "fedex",
    "serviceCode": "fedex_2day",
    "packageCode": "package",
    "confirmation": "delivery",
    "shipDate": "2015-07-02",
    "holdUntilDate": null,
    "weight": {
      "value": 25,
      "units": "ounces"
    },
    "dimensions": {
      "units": "inches",
      "length": 7,
      "width": 5,
      "height": 6
    },
    "insuranceOptions": {
      "provider": "carrier",
      "insureShipment": true,
      "insuredValue": 200
    },
    "internationalOptions": {
      "contents": null,
      "customsItems": null,
      "nonDelivery": null
    },
    "advancedOptions": {
      "warehouseId": 9876,
      "nonMachinable": false,
      "saturdayDelivery": false,
      "containsAlcohol": false,
      "mergedOrSplit": false,
      "mergedIds": [],
      "parentId": null,
      "storeId": 12345,
      "customField1": "Custom data that you can add to an order. See Custom Field #2 & #3 for more info!",
      "customField2": "Per UI settings, this information can appear on some carrier's shipping labels. See link below",
      "customField3": "https://help.shipstation.com/hc/en-us/articles/206639957",
      "source": "Webstore",
      "billToParty": null,
      "billToAccount": null,
      "billToPostalCode": null,
      "billToCountryCode": null
    },
    "tagIds": null,
    "userId": null,
    "externallyFulfilled": false,
    "externallyFulfilledBy": null
  }
}

Create Shipment Label​

Creates a shipping label. | key: createShipmentLabel

InputNotesExample
Field

A list of additional fields to include in the shipment.

testLabel: false
Carrier Code

The carrier code for shipping.

Connection

The ShipStation connection to use.

Package Code

The package type code for the label.

Service Code

The shipping service code for the label.

Ship Date

The date the shipment will be shipped in YYYY-MM-DD format.

2014-04-03
Origin Address

Provide the origin address in JSON format.

Shipping Address

Provide the shipping address in JSON format.

Shipment's Weight

The weight of the shipment, following the Weight model. Note: WeightUnits is read-only.

Create Warehouse​

Adds a Ship From Location (formerly known as warehouse) to your account. | key: createWarehouse

InputNotesExample
Connection

The ShipStation connection to use.

Is Default Warehouse

When true, sets this as the default ship from location.

false
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.

Warehouse Name

The name of the ship from location.

Deactivate Store​

Deactivates the specified store. | key: deactivateStore

InputNotesExample
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. | key: deleteInstancedWebhooks

InputNotesExample
Connection

The ShipStation connection to use.

Delete Order​

Soft delete an order from the database, setting it to inactive. | key: deleteOrder

InputNotesExample
Connection

The ShipStation connection to use.

Order ID

The unique identifier for the order.

Delete Warehouse​

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

InputNotesExample
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 | key: getCustomer

InputNotesExample
Connection

The ShipStation connection to use.

Customer ID

The unique identifier for the customer.

Get Order​

Retrieve a single order from the database. | key: getOrder

InputNotesExample
Connection

The ShipStation connection to use.

Order ID

The unique identifier for the order.

Get Product​

Retrieve a specific product from the database by its ID. | key: getProduct

InputNotesExample
Connection

The ShipStation connection to use.

Product ID

The unique identifier for the product.

Get Store​

Retrieve detailed information about a specific store. | key: getStore

InputNotesExample
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). | key: getWarehouse

InputNotesExample
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. | key: listCarriers

InputNotesExample
Connection

The ShipStation connection to use.

List Customers​

Retrieve a list of customers based on specified criteria | key: listCustomers

InputNotesExample
Connection

The ShipStation connection to use.

Country Code

The two-letter ISO country code to filter customers.

Marketplace ID

The marketplace ID to filter customers.

Page

The page number to retrieve (starts at 1).

Page Size

The maximum number of results to return per page. Maximum: 500.

Sort By

The field name to sort results by.

Sort Direction

The direction to sort results (asc or desc).

State Code

The state code to filter customers.

Tag ID

The tag ID to filter customers.

List Fulfillments​

Retrieve a list of fulfillments based on specified criteria. | key: listFulfillments

InputNotesExample
Connection

The ShipStation connection to use.

Fulfillment ID

The unique identifier for the fulfillment.

Order ID

The unique identifier for the order.

18324102
Page

The page number to retrieve (starts at 1).

1
Page Size

The maximum number of results to return per page. Maximum: 500.

1

List Orders​

Retrieve a list of orders based on specified criteria. | key: listOrders

InputNotesExample
Connection

The ShipStation connection to use.

Customer Name

The customer name to filter orders.

test
Order Status

The order status to filter results (e.g., awaiting_payment, awaiting_shipment, shipped).

awaiting_payment, awaiting_shipment, shipped, etc.
Page

The page number to retrieve (starts at 1).

1
Page Size

The maximum number of results to return per page. Maximum: 500.

1

List Packages​

Retrieves a list of packages for the specified carrier. | key: listPackages

InputNotesExample
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. | key: listProducts

InputNotesExample
Connection

The ShipStation connection to use.

End Date

The end date to filter products by creation date in YYYY-MM-DD format.

2014-05-04
Page

The page number to retrieve (starts at 1).

Page Size

The maximum number of results to return per page. Maximum: 500.

Product Category ID

The product category ID to filter results.

Product Name

The product name to filter results.

Product Type ID

The product type ID to filter results.

Show Inactive

When true, includes inactive stores in the results.

false
SKU

The SKU to filter products.

Sort By

The field name to sort results by.

Sort Direction

The direction to sort results (asc or desc).

Start Date

The start date to filter products by creation date in YYYY-MM-DD format.

2014-04-03
Tag ID

The tag ID to filter customers.

List Services​

Retrieves the list of available shipping services provided by the specified carrier. | key: listServices

InputNotesExample
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. | key: listShipments

InputNotesExample
Connection

The ShipStation connection to use.

Create Date End

The end date to filter shipments by creation date in YYYY-MM-DD format.

2014-05-04
Create Date Start

The start date to filter shipments by creation date in YYYY-MM-DD format.

2014-04-03
Page

The page number to retrieve (starts at 1).

Page Size

The maximum number of results to return per page. Maximum: 500.

Recipient Country Code

The two-letter ISO country code to filter shipments by recipient country.

Recipient Name

The recipient name to filter shipments.

Ship Date End

The end date to filter shipments by ship date in YYYY-MM-DD format.

2014-04-03
Ship Date Start

The start date to filter shipments by ship date in YYYY-MM-DD format.

2014-04-03
Tracking Number

The tracking number to filter shipments.

List Stores​

Retrieve the list of installed stores on the account. | key: listStores

InputNotesExample
Connection

The ShipStation connection to use.

Marketplace ID

The marketplace ID to filter stores.

Show Inactive

When true, includes inactive stores in the results.

false

List Users​

Retrieve the list of users on the account. | key: listUsers

InputNotesExample
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). | key: listWarehouses

InputNotesExample
Connection

The ShipStation connection to use.

List Webhooks​

Retrieves a list of registered webhooks for the account. | key: listWebhooks

InputNotesExample
Connection

The ShipStation connection to use.

Raw Request​

Send raw HTTP request to ShipStation. | key: rawRequest

InputNotesExample
Connection

The ShipStation connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

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.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
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
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

This is the URL to call.

/stores
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Subscribe to Webhook​

Subscribes to a specific type of webhook in ShipStation. | key: subscribeToWebhook

InputNotesExample
Connection

The ShipStation connection to use.

Event

The webhook event type to subscribe to.

Friendly Name

The display name for the webhook.

Store ID

The store ID to filter webhook triggers. When provided, webhooks will only trigger for this store.

Target URL

The URL where webhook events will be sent.

Unsubscribe from Webhook​

Unsubscribes from a specific type of webhook in ShipStation. | key: unsubscribeToWebhook

InputNotesExample
Connection

The ShipStation connection to use.

Webhook ID

The unique identifier for the webhook.

Update Product​

Updates an existing product. | key: updateProduct

InputNotesExample
Connection

The ShipStation connection to use.

Product Data

The complete data for updating the product. This call does not support partial updates.

Product ID

The unique identifier for the product.

Update Store​

Updates an existing store. | key: updateStore

InputNotesExample
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.

Update Warehouse​

Updates an existing Ship From Location (formerly known as warehouse). | key: updateWarehouse

InputNotesExample
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.

Changelog​

2026-02-24​

Added inline data sources for carriers, services, packages, customers, stores, users, orders, products, and warehouses to enhance data selection capabilities

2024-03-29​

Enhanced Create/Update Order action with additional orderKey parameter and debug request support

2023-09-28​

Initial release of ShipStation component with comprehensive integration capabilities