For the complete documentation index, see llms.txt. This page is also available as Markdown.

ShipStation

Last updated: May 15, 2026

Connect ShipStation to let Aissist track shipments and delivery status.

ShipStation is the integration.

Actions use ShipStation during conversations.

With ShipStation, Aissist can work with:

  • shipment tracking

  • delivery events

  • carrier status updates

  • order-level shipping information

Create the ShipStation integration

Step 1: create an API key

  1. Log in to ShipStation.

  2. Go to Settings → API Settings.

  3. Select V2 API.

  4. Click Generate API Key.

  5. Copy the API key.

See ShipStation API key docs for more detail.

Step 2: add the integration in Aissist

  1. Go to Workspace → Integrations.

  2. Click Add Integration.

  3. Choose ShipStation.

  4. Enter:

    • a name for the integration

    • the ShipStation API key

    • the timeout value

  5. Click Test to confirm the connection.

Example:

  • Name: Aissist ShipStation

  • API Key: your ShipStation API key

  • Timeout: 30

Default action

The ShipStation integration includes one default action:

trackOrder

Use it to track a shipment by order ID.

Use it for most shipment tracking workflows.

The integration returns structured tracking data such as:

  • tracking number

  • tracking URL

  • current status

  • carrier status details

  • shipment and delivery dates

  • event history

{
  "shipstation": {
    "order_id": "12345",
    "tracking": {
      "tracking_number": "1Z999AA1234567890",
      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=1Z999AA1234567890",
      "status_description": "Delivered",
      "carrier_status_description": "Your item was delivered in or at the mailbox at 11:40 am on September 25, 2025 in GREENWOOD, SC 29646.",
      "ship_date": "2025-09-23T02:07:00Z",
      "actual_delivery_date": "2025-09-25T15:40:00Z"
    }
  }
}
Custom action settings

You can customize the trackOrder action for your workflow.

  1. Select the integration then go to Actions.

  2. Click Add Action.

  3. Choose the trackOrder method.

  4. Give the action a clear name and description.

You can choose whether it runs:

  • at the start of a session

  • during an interaction

  • in both places

You can also set the trigger direction:

  • Inbound

  • Outbound

Parameter guidance

Link trackOrder to an order_tracking sub agent when you want tracking only for shipping-related conversations.

Order ID

  • Default description: Order ID, such as a Shopify, WooCommerce, or Adobe Commerce order ID

  • Example description: Track order by Shopify order ID, format: SHOPIFY-123456789

You can also add instructions for how Aissist should present tracking information.

Example:

Summarize the tracking status and highlight key events.
Include the current status, estimated delivery date, and carrier information.
If the package is delayed or has exceptions, explain the situation and suggest next steps.

Next step

After setup, test your ShipStation action in Action Debugger.

Last updated