> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ShipStation

> How to set up the ShipStation connector, plus the actions and events that are available.

![ShipStation](https://stackone-logos.com/api/shipstation/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/shipstation/changelog.md)

[45 actions](#actions) · [6 events](#events) · 1 auth method

Logistics

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/shipstation/guides/connector-profile/api-key.md)
>
> Uses HTTP Basic Auth with an API Key and API Secret. Generated by the Account Owner in ShipStation's Account API Setting...

Optionally, configure receiving Events for ShipStation into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/shipstation/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/shipstation/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

45 actions

ActionDescription

List Account Tags`shipstation_list_account_tags`

List all tags defined for this account

Register Account`shipstation_register_account`

Register a new ShipStation account

List Carriers`shipstation_list_carriers`

List all shipping carriers connected to the account

Get Carrier`shipstation_get_carrier`

Retrieve a single carrier by carrierCode

List Carrier Packages`shipstation_list_carrier_packages`

List package types available for a specific carrier

List Carrier Services`shipstation_list_carrier_services`

List shipping services available for a specific carrier

Add Carrier Funds`shipstation_add_carrier_funds`

Add funds to a carrier account

List Customers`shipstation_list_customers`

Retrieve a paginated list of customers

Get Customer`shipstation_get_customer`

Retrieve a single customer by ID

List Fulfillments`shipstation_list_fulfillments`

Retrieve a paginated list of fulfillments

List Orders`shipstation_list_orders`

List orders matching search criteria

List Orders By Tag`shipstation_list_orders_by_tag`

List orders matching a status and a tag

Get Order`shipstation_get_order`

Retrieve a single order by ID

Create Or Update Order`shipstation_create_update_order`

Create a new order or update an existing one

Create Or Update Multiple Orders`shipstation_create_update_multiple_orders`

Create or update multiple orders in a single call

Mark Order As Shipped`shipstation_mark_order_as_shipped`

Mark an order as shipped without creating a label

Add Tag To Order`shipstation_add_order_tag`

Add a tag to an order

Remove Tag From Order`shipstation_remove_order_tag`

Remove a tag from an order

Assign User To Order`shipstation_assign_user_to_order`

Assign a user to one or more orders

Unassign User From Order`shipstation_unassign_user_from_order`

Unassign the user from one or more orders

Hold Order Until`shipstation_hold_order_until`

Place an order on hold until a specified date

Restore Order From Hold`shipstation_restore_order_from_hold`

Restore an on-hold order to awaiting shipment

Delete Order`shipstation_delete_order`

Soft-delete an order

Create Label For Order`shipstation_create_label_for_order`

Create a shipping label for an existing order

List Products`shipstation_list_products`

Retrieve a paginated list of products

Get Product`shipstation_get_product`

Retrieve a single product by ID

Update Product`shipstation_update_product`

Update an existing product

List Shipments`shipstation_list_shipments`

Retrieve a paginated list of shipments

Get Shipping Rates`shipstation_get_shipping_rates`

Retrieve shipping rates for the specified shipping details

Create Shipping Label`shipstation_create_shipping_label`

Create a shipping label and obtain label data

Void Label`shipstation_void_label`

Void a previously created shipping label

List Stores`shipstation_list_stores`

List all stores associated with the ShipStation account

List Store Marketplaces`shipstation_list_store_marketplaces`

List marketplaces that can be integrated with ShipStation

Get Store`shipstation_get_store`

Retrieve details for a specific store by ID

Get Store Refresh Status`shipstation_get_store_refresh_status`

Retrieve the refresh status of a specific store

Update Store`shipstation_update_store`

Update an existing store

Refresh Store`shipstation_refresh_store`

Initiate a store refresh

Deactivate Store`shipstation_deactivate_store`

Deactivate a specific store

Reactivate Store`shipstation_reactivate_store`

Reactivate a previously deactivated store

List Users`shipstation_list_users`

Retrieve a list of users in the ShipStation account

List Warehouses`shipstation_list_warehouses`

List all Ship From Locations (warehouses) on the ShipStation account

Get Warehouse`shipstation_get_warehouse`

Retrieve a single warehouse (Ship From Location) by its ID

Create Warehouse`shipstation_create_warehouse`

Create a new warehouse (Ship From Location)

Update Warehouse`shipstation_update_warehouse`

Update an existing warehouse (Ship From Location)

Delete Warehouse`shipstation_delete_warehouse`

Delete a warehouse (Ship From Location)

## Events

Tags

Select all
|
Clear

Fulfillments

Orders

Shipments

Webhooks

No tags found

6 events

EventDescriptionTags

Order Notify Webhook`shipstation_webhook_order_notify`

Processes ShipStation ORDER\_NOTIFY webhook events, fired when new orders are created in or imported into ShipStation. Th...

OrdersWebhooks

Item Order Notify Webhook`shipstation_webhook_item_order_notify`

Processes ShipStation ITEM\_ORDER\_NOTIFY webhook events, fired when new orders are created in or imported into ShipStatio...

OrdersWebhooks

Ship Notify Webhook`shipstation_webhook_ship_notify`

Processes ShipStation SHIP\_NOTIFY webhook events, fired when orders ship with a shipping label. Orders marked as shipped...

ShipmentsWebhooks

Item Ship Notify Webhook`shipstation_webhook_item_ship_notify`

Processes ShipStation ITEM\_SHIP\_NOTIFY webhook events, fired when orders ship with a shipping label. Orders marked as sh...

ShipmentsWebhooks

Fulfillment Shipped Webhook`shipstation_webhook_fulfillment_shipped`

Processes ShipStation FULFILLMENT\_SHIPPED webhook events, fired when an order is marked as shipped without a ShipStation...

FulfillmentsWebhooks

Fulfillment Rejected Webhook`shipstation_webhook_fulfillment_rejected`

Processes ShipStation FULFILLMENT\_REJECTED webhook events, fired when a fulfillment provider rejects an order that was s...

FulfillmentsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.