Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to ShipStation

Scalekit connector
Open markdown

The ShipStation connector lets your AI agent act in each user's ShipStation account. Each user connects their own ShipStation API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 29 tools.

Tools
29
What they doRead · write · destructive
18 · 8 · 318 read8 write3 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the ShipStation connection

    In AgentKit > Connections, create a ShipStation connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'shipstation'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize ShipStation:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'shipstation_carriers_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their ShipStation credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • shipstation_address_validateValidate and normalize one or more mailing addresses.Read-only

    Validate Addresses

    Validate and normalize one or more mailing addresses. Returns one result per address with status (verified, unverified, warning or error), original_address, matched_address and messages. Use shipstation_address_validate before creating shipments.

    Inputs

    addressesarrayrequired
    Addresses to validate. Each needs address_line1, city_locality, state_province and country_code; postal_code, name, company_name, phone, address_line2 and address_residential_indicator are optional. Example: [{"address_line1": "525 S Winchester Blvd", "city_locality": "San Jose", "state_province": "CA", "postal_code": "95128", "country_code": "US"}]
  • shipstation_carrier_getGet one connected carrier account by ID.Read-only

    Get Carrier

    Get one connected carrier account by ID. Returns carrier_code, friendly_name, account_number, balance, services, packages and options. Use shipstation_carrier_get for a known carrier ID.

    Inputs

    carrier_idstringrequired
    ID of the carrier. Example: se-28529731
  • shipstation_carrier_packages_listList the package types a carrier account supports.Read-only

    List Carrier Package Types

    List the package types a carrier account supports. Returns packages[] with package_code, name, description and dimensions. Use shipstation_carrier_packages_list to pick a package_code.

    Inputs

    carrier_idstringrequired
    ID of the carrier. Example: se-28529731
  • shipstation_carrier_services_listList the shipping services a carrier account offers.Read-only

    List Carrier Services

    List the shipping services a carrier account offers. Returns services[] with service_code, name, domestic, international and is_multi_package_supported. Use shipstation_carrier_services_list to pick a service_code.

    Inputs

    carrier_idstringrequired
    ID of the carrier. Example: se-28529731
  • shipstation_carriers_listList the carrier accounts connected to ShipStation, with their services and package types.Read-only

    List Carriers

    List the carrier accounts connected to ShipStation, with their services and package types. Returns carriers[] with carrier_id, carrier_code, friendly_name, account_number, balance and, by default, services[] and packages[]. Use shipstation_carriers_list to get carrier_id and service_code values for rates and labels.

    Inputs

    include_extended_detailsboolean
    true (default) to include each carrier's services and packages; false for a smaller response. Example: false
    pageinteger
    Page of results to return, starting at 1. Example: 2
    page_sizeinteger
    Results per page (default 25). Example: 50
  • shipstation_label_getGet one label by ID.Read-only

    Get Label

    Get one label by ID. Returns status, tracking_number, shipment_cost, insurance_cost, carrier and service, label_download links (pdf, png, zpl), voided state and packages. Use shipstation_label_get to fetch label download links.

    Inputs

    label_idstringrequired
    ID of the label. Example: se-28529731
    label_download_typestring
    url for links or inline for base64 label data. Example: urlone of urlinline
  • shipstation_label_tracking_getGet tracking events for a label bought through ShipStation.Read-only

    Get Label Tracking

    Get tracking events for a label bought through ShipStation. Returns tracking_number, status_code, status_description, estimated_delivery_date, actual_delivery_date and events[]. Use shipstation_label_tracking_get with a label ID. Use shipstation_tracking_get with a carrier and tracking number.

    Inputs

    label_idstringrequired
    ID of the label. Example: se-28529731
  • shipstation_labels_listList purchased labels with status, carrier, tracking number, date and refund filters.Read-only

    List Labels

    List purchased labels with status, carrier, tracking number, date and refund filters. Returns labels[] (label_id, status, tracking_number, shipment_cost, carrier_code, service_code, label_download, voided) plus total and pages. Use shipstation_labels_list to find labels. Use shipstation_label_get for one label.

    Inputs

    batch_idstring
    Only labels created in this batch. Example: se-28529731
    carrier_idstring
    Only labels from this carrier account. Example: se-123890
    created_at_endstring
    Created on or before this date-time. Example: 2026-11-15T23:59:59Z
    created_at_startstring
    Created on or after this date-time. Example: 2026-11-01T00:00:00Z
    external_shipment_idstring
    Only labels for this external shipment ID. Example: order-1001
    label_statusstring
    Only labels in this status: processing, completed, error or voided. Example: completedone of processingcompletederrorvoided
    pageinteger
    Page of results to return, starting at 1. Example: 2
    page_sizeinteger
    Results per page (default 25). Example: 50
    rate_idstring
    Only labels bought from this rate. Example: se-28529731
    refund_statusarray
    Only labels with these refund statuses. Example: ["pending"]
    service_codestring
    Only labels for this carrier service. Example: usps_priority_mail
    shipment_idstring
    Only labels for this shipment. Example: se-28529731
    sort_bystring
    Sort field: created_at (default), modified_at or voided_at. Example: created_atone of modified_atcreated_atvoided_at
    sort_dirstring
    asc or desc (default). Example: descone of ascdesc
    tracking_numberstring
    Only labels with this tracking number. Example: 9400111899223197428490
    warehouse_idstring
    Only labels shipped from this warehouse. Example: se-28529731