> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ShipStation

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.

**Authentication:** API Key
**Categories:** Automation, Productivity
**Tools:** 29: 18 read, 8 write, 3 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=SHIPSTATION)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".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](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "shipstation"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize ShipStation:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="shipstation_carriers_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their ShipStation credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'shipstation_address_validate',
  toolInput: {
    addresses: [{
        address_line1: '525 S Winchester Blvd',
        city_locality: 'San Jose',
        state_province: 'CA',
        postal_code: '95128',
        country_code: 'US',
      }],
  },
  connector: 'shipstation',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="shipstation_address_validate",
    tool_input={
        "addresses": [{
                "address_line1": "525 S Winchester Blvd",
                "city_locality": "San Jose",
                "state_province": "CA",
                "postal_code": "95128",
                "country_code": "US",
            }],
    },
    connection_name="shipstation",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `shipstation_address_validate`

Validate Addresses · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `addresses` (`array`, required): 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"}]

Example input: `{"addresses":[{"address_line1":"525 S Winchester Blvd","city_locality":"San Jose","state_province":"CA","postal_code":"95128","country_code":"US"}]}`

### `shipstation_carrier_get`

Get Carrier · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `carrier_id` (`string`, required): ID of the carrier. Example: se-28529731

Example input: `{"carrier_id":"<carrier_id>"}`

### `shipstation_carrier_packages_list`

List Carrier Package Types · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `carrier_id` (`string`, required): ID of the carrier. Example: se-28529731

Example input: `{"carrier_id":"<carrier_id>"}`

### `shipstation_carrier_services_list`

List Carrier Services · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `carrier_id` (`string`, required): ID of the carrier. Example: se-28529731

Example input: `{"carrier_id":"<carrier_id>"}`

### `shipstation_carriers_list`

List Carriers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_extended_details` (`boolean`, optional): true (default) to include each carrier's services and packages; false for a smaller response. Example: false
- `page` (`integer`, optional): Page of results to return, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (default 25). Example: 50

Example input: `{}`

### `shipstation_label_get`

Get Label · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `label_id` (`string`, required): ID of the label. Example: se-28529731
- `label_download_type` (`string`, optional): url for links or inline for base64 label data. Example: url. One of: `url`, `inline`.

Example input: `{"label_id":"<label_id>"}`

### `shipstation_label_tracking_get`

Get Label Tracking · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `label_id` (`string`, required): ID of the label. Example: se-28529731

Example input: `{"label_id":"<label_id>"}`

### `shipstation_labels_list`

List Labels · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_id` (`string`, optional): Only labels created in this batch. Example: se-28529731
- `carrier_id` (`string`, optional): Only labels from this carrier account. Example: se-123890
- `created_at_end` (`string`, optional): Created on or before this date-time. Example: 2026-11-15T23:59:59Z
- `created_at_start` (`string`, optional): Created on or after this date-time. Example: 2026-11-01T00:00:00Z
- `external_shipment_id` (`string`, optional): Only labels for this external shipment ID. Example: order-1001
- `label_status` (`string`, optional): Only labels in this status: processing, completed, error or voided. Example: completed. One of: `processing`, `completed`, `error`, `voided`.
- `page` (`integer`, optional): Page of results to return, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (default 25). Example: 50
- `rate_id` (`string`, optional): Only labels bought from this rate. Example: se-28529731
- `refund_status` (`array`, optional): Only labels with these refund statuses. Example: ["pending"]
- `service_code` (`string`, optional): Only labels for this carrier service. Example: usps_priority_mail
- `shipment_id` (`string`, optional): Only labels for this shipment. Example: se-28529731
- `sort_by` (`string`, optional): Sort field: created_at (default), modified_at or voided_at. Example: created_at. One of: `modified_at`, `created_at`, `voided_at`.
- `sort_dir` (`string`, optional): asc or desc (default). Example: desc. One of: `asc`, `desc`.
- `tracking_number` (`string`, optional): Only labels with this tracking number. Example: 9400111899223197428490
- `warehouse_id` (`string`, optional): Only labels shipped from this warehouse. Example: se-28529731

Example input: `{}`

### `shipstation_manifests_list`

List Manifests · Read-only

List end-of-day manifests (SCAN forms) with carrier, warehouse and date filters.
Returns manifests[] with manifest_id, carrier_id, warehouse_id, ship_date, shipments count and manifest_download.
Use shipstation_manifests_list to find past manifests.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `carrier_id` (`string`, optional): Only manifests for this carrier. Example: se-123890
- `created_at_end` (`string`, optional): Created at or before. Example: 2026-11-15T23:59:59Z
- `created_at_start` (`string`, optional): Created at or after. Example: 2026-11-01T00:00:00Z
- `label_ids` (`array`, optional): Only manifests containing these label IDs. Example: ["se-28529731"]
- `page` (`integer`, optional): Page of results to return, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (default 25). Example: 50
- `ship_date_end` (`string`, optional): Ship date range end. Example: 2026-11-15T23:59:59Z
- `ship_date_start` (`string`, optional): Ship date range start. Example: 2026-11-01T00:00:00Z
- `warehouse_id` (`string`, optional): Only manifests for this warehouse. Example: se-28529731

Example input: `{}`

### `shipstation_pickups_list`

List Pickups · Read-only

List scheduled carrier pickups.
Returns pickups[] with pickup_id, carrier_id, confirmation_number, pickup_window and label_ids.
Use shipstation_pickups_list to see upcoming pickups. Use shipstation_pickup_cancel to cancel one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `carrier_id` (`string`, optional): Only pickups for this carrier. Example: se-123890
- `created_at_end` (`string`, optional): Created on or before. Example: 2026-11-15T23:59:59Z
- `created_at_start` (`string`, optional): Created on or after. Example: 2026-11-01T00:00:00Z
- `page` (`integer`, optional): Page of results to return, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (default 25). Example: 50
- `warehouse_id` (`string`, optional): Only pickups for this warehouse. Example: se-28529731

Example input: `{}`

### `shipstation_rate_get`

Get Rate · Read-only

Get one rate by rate ID.
Returns the rate with carrier, service_code, shipping_amount, other_amount, delivery_days and validation_status.
Use shipstation_rate_get to recheck a rate before shipstation_label_create_from_rate.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `rate_id` (`string`, required): ID of the rate. Example: se-28529731

Example input: `{"rate_id":"<rate_id>"}`

### `shipstation_rates_estimate`

Estimate Rates · Read-only

Estimate shipping rates from origin and destination postal details and package weight, without creating a shipment.
Returns an array of rate estimates with carrier, service_code, shipping_amount and delivery_days; these cannot be bought.
Use shipstation_rates_estimate for quick quotes. Use shipstation_rates_calculate for buyable rates.

Read only: yes. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from_city_locality` (`string`, required): Origin city. Example: Austin
- `from_country_code` (`string`, required): Origin country (ISO 3166-1 two-letter). Example: US
- `from_postal_code` (`string`, required): Origin postal code. Example: 78756
- `from_state_province` (`string`, required): Origin state or province. Example: TX
- `ship_date` (`string`, required): Planned ship date (ISO 8601). Example: 2026-11-16T00:00:00Z
- `to_city_locality` (`string`, required): Destination city. Example: San Jose
- `to_country_code` (`string`, required): Destination country (ISO 3166-1 two-letter). Example: US
- `to_postal_code` (`string`, required): Destination postal code. Example: 95128
- `to_state_province` (`string`, required): Destination state or province. Example: CA
- `weight` (`object`, required): Package weight with value and unit (pound, ounce, gram or kilogram). Example: {"value": 20, "unit": "ounce"}
- `address_residential_indicator` (`string`, optional): Whether the destination is residential: yes, no or unknown. Example: yes. One of: `unknown`, `yes`, `no`.
- `carrier_id` (`string`, optional): A single carrier ID to quote, instead of carrier_ids. Example: se-123890
- `carrier_ids` (`array`, optional): Carrier IDs to quote. Provide carrier_ids or carrier_id. Example: ["se-123890"]
- `confirmation` (`string`, optional): Delivery confirmation type. Example: none. One of: `none`, `delivery`, `signature`, `adult_signature`, `adult_signature_restricted_delivery`, `direct_signature`, `delivery_mailed`, `verbal_confirmation`, `delivery_code`, `age_verification_16_plus`.
- `dimensions` (`object`, optional): Package dimensions with length, width, height and unit (inch or centimeter). Example: {"length": 12, "width": 8, "height": 4, "unit": "inch"}

Example input: `{"from_city_locality":"<from_city_locality>","from_country_code":"<from_country_code>","from_postal_code":"<from_postal_code>","from_state_province":"<from_state_province>","ship_date":"<ship_date>","to_city_locality":"<to_city_locality>","to_country_code":"<to_country_code>","to_postal_code":"<to_postal_code>","to_state_province":"<to_state_province>","weight":{"value":20,"unit":"ounce"}}`

### `shipstation_shipment_get`

Get Shipment · Read-only

Get one shipment by ShipStation shipment ID.
Returns the shipment with status, addresses, carrier and service, packages, items, amounts and tags.
Use shipstation_shipment_get for a known ID. Use shipstation_shipment_get_by_external_id for your own ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `shipment_id` (`string`, required): ID of the shipment. Example: se-28529731

Example input: `{"shipment_id":"<shipment_id>"}`

### `shipstation_shipment_get_by_external_id`

Get Shipment by External ID · Read-only

Get one shipment by the external_shipment_id you assigned when creating it.
Returns the same shipment object as shipstation_shipment_get.
Use shipstation_shipment_get_by_external_id to look up a shipment from your own order system.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `external_shipment_id` (`string`, required): Your external shipment ID. Example: order-1001

Example input: `{"external_shipment_id":"<external_shipment_id>"}`

### `shipstation_shipment_rates_list`

List Shipment Rates · Read-only

List the rates already calculated for a shipment.
Returns rate_response with rates[] (rate_id, carrier, service_code, shipping_amount, delivery_days, estimated_delivery_date) and invalid_rates.
Use shipstation_shipment_rates_list after shipstation_rates_calculate. Use shipstation_label_create_from_rate to buy one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `shipment_id` (`string`, required): ID of the shipment. Example: se-28529731
- `created_at_start` (`string`, optional): Only rates created at or after this date-time. Example: 2026-11-15T00:00:00Z

Example input: `{"shipment_id":"<shipment_id>"}`

### `shipstation_shipments_list`

List Shipments · Read-only

List shipments with status, date, tag, store and keyword filters, sorted and paged.
Returns shipments[] (shipment_id, shipment_number, shipment_status, ship_to, carrier and service, packages, items) plus total, page and pages.
Use shipstation_shipments_list to find shipments or orders awaiting labels. Use shipstation_shipment_get for one shipment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_id` (`string`, optional): Only shipments in this batch. Example: se-28529731
- `created_at_end` (`string`, optional): Created at or before this ISO 8601 date-time. Example: 2026-11-15T23:59:59Z
- `created_at_start` (`string`, optional): Created at or after this ISO 8601 date-time. Example: 2026-11-01T00:00:00Z
- `external_shipment_id` (`string`, optional): Your external shipment ID. Example: order-1001
- `item_keyword` (`string`, optional): Matches item SKU, description or options. Example: mug
- `modified_at_end` (`string`, optional): Modified at or before this date-time. Example: 2026-11-15T23:59:59Z
- `modified_at_start` (`string`, optional): Modified at or after this date-time. Example: 2026-11-01T00:00:00Z
- `page` (`integer`, optional): Page of results to return, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (default 25). Example: 50
- `payment_date_end` (`string`, optional): Order paid at or before this date-time. Example: 2026-11-15T23:59:59Z
- `payment_date_start` (`string`, optional): Order paid at or after this date-time. Example: 2026-11-01T00:00:00Z
- `sales_order_id` (`string`, optional): Only shipments for this sales order. Example: se-28529731
- `ship_to_name` (`string`, optional): Recipient name. Example: Amanda Miller
- `shipment_number` (`string`, optional): Shipment number set by you or the order source. Example: 1001
- `shipment_status` (`string`, optional): Only shipments in this status: pending, processing, label_purchased or cancelled. Example: pending. One of: `pending`, `processing`, `label_purchased`, `cancelled`.
- `sort_by` (`string`, optional): Sort field: created_at or modified_at. Example: created_at. One of: `modified_at`, `created_at`.
- `sort_dir` (`string`, optional): Sort direction: asc or desc (default). Example: desc. One of: `asc`, `desc`.
- `store_id` (`string`, optional): Only shipments from this store. Example: se-123456
- `tag` (`string`, optional): Only shipments with this tag name (one tag). Example: Priority

Example input: `{}`

### `shipstation_tracking_get`

Get Tracking · Read-only

Get tracking events for a package by carrier code and tracking number.
Returns status_code, status_description, carrier_status_description, estimated and actual delivery dates and events[].
Use shipstation_tracking_get for any tracking number. Use shipstation_label_tracking_get when you have the label ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `carrier_code` (`string`, required): Carrier code, such as usps, fedex, ups or dhl_express. Example: usps
- `tracking_number` (`string`, required): Tracking number. Example: 9400111899223197428490
- `carrier_id` (`string`, optional): Carrier account ID, when the account has several of the same carrier. Example: se-123890

Example input: `{"carrier_code":"<carrier_code>","tracking_number":"<tracking_number>"}`

### `shipstation_warehouses_list`

List Warehouses · Read-only

List the account's warehouses (ship-from locations).
Returns warehouses[] with warehouse_id, name, origin_address, return_address and is_default.
Use shipstation_warehouses_list to get a warehouse_id for shipments, manifests and pickups.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `shipstation_label_create`

Buy Label · Write

Buy a shipping label for shipment details given inline; this charges the carrier account unless test_label is true.
Returns the label with label_id, tracking_number, shipment_cost and label_download links.
Use shipstation_label_create to ship in one call. Use shipstation_label_create_from_rate to buy a rate you already quoted.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `shipment` (`object`, required): Shipment details: carrier_id and service_code (from shipstation_carriers_list), ship_date, ship_to and ship_from addresses (each needs name, phone, address_line1, city_locality, state_province, postal_code, country_code and address_residential_indicator yes, no or unknown), or warehouse_id instead of ship_from, and packages[] each with weight {value, unit} and optional dimensions {length, width, height, unit}. Example: {"carrier_id": "se-123890", "service_code": "usps_priority_mail", "ship_to": {"name": "Amanda Miller", "phone": "555-555-5555", "address_line1": "525 S Winchester Blvd", "city_locality": "San Jose", "state_province": "CA", "postal_code": "95128", "country_code": "US", "address_residential_indicator": "yes"}, "ship_from": {"name": "John Doe", "company_name": "Example Corp", "phone": "111-111-1111", "address_line1": "4009 Marathon Blvd", "city_locality": "Austin", "state_province": "TX", "postal_code": "78756", "country_code": "US", "address_residential_indicator": "no"}, "packages": [{"weight": {"value": 20, "unit": "ounce"}, "dimensions": {"length": 12, "width": 8, "height": 4, "unit": "inch"}}]}
- `display_scheme` (`string`, optional): label, paperless (QR or code instead of a printed label, where the carrier supports it) or label_and_paperless. Defaults to label. Example: label. One of: `label`, `paperless`, `label_and_paperless`.
- `external_shipment_id` (`string`, optional): Your unique ID for the shipment (max 50 characters). Example: order-1001
- `is_return_label` (`boolean`, optional): true for a return label. Example: false
- `label_download_type` (`string`, optional): url returns links to the label files; inline returns the label as base64 in the response. Defaults to url. Example: url. One of: `url`, `inline`.
- `label_format` (`string`, optional): Label file format: pdf, png or zpl. Defaults to pdf. Example: pdf. One of: `pdf`, `png`, `zpl`.
- `label_layout` (`string`, optional): Label size: 4x6 or letter (letter only for pdf). Defaults to 4x6. Example: 4x6. One of: `4x6`, `letter`.
- `rma_number` (`string`, optional): Return merchandise authorization number for return labels. Example: RMA-1001
- `ship_date` (`string`, optional): Date the package will ship (ISO 8601). Example: 2026-11-16T00:00:00Z
- `test_label` (`boolean`, optional): true to create a test label that is not charged. Example: true
- `validate_address` (`string`, optional): Address validation before buying: no_validation, validate_only or validate_and_clean. Example: validate_and_clean. One of: `no_validation`, `validate_only`, `validate_and_clean`.

Example input: `{"shipment":{}}`

### `shipstation_label_create_from_rate`

Buy Label from Rate · Write

Buy a label using a rate ID returned by shipstation_rates_calculate; this charges the carrier account.
Returns the label with label_id, tracking_number, shipment_cost and label_download links.
Use shipstation_label_create_from_rate after comparing rates. Use shipstation_label_create_from_shipment to buy with the shipment's own carrier and service.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `rate_id` (`string`, required): ID of the rate to buy. Example: se-28529731
- `display_scheme` (`string`, optional): label, paperless (QR or code instead of a printed label, where the carrier supports it) or label_and_paperless. Defaults to label. Example: label. One of: `label`, `paperless`, `label_and_paperless`.
- `external_shipment_id` (`string`, optional): Your unique ID for the shipment (max 100 characters). Example: order-1001
- `label_download_type` (`string`, optional): url returns links to the label files; inline returns the label as base64 in the response. Defaults to url. Example: url. One of: `url`, `inline`.
- `label_format` (`string`, optional): Label file format: pdf, png or zpl. Defaults to pdf. Example: pdf. One of: `pdf`, `png`, `zpl`.
- `label_layout` (`string`, optional): Label size: 4x6 or letter (letter only for pdf). Defaults to 4x6. Example: 4x6. One of: `4x6`, `letter`.
- `validate_address` (`string`, optional): Address validation before buying: no_validation, validate_only or validate_and_clean. Example: validate_and_clean. One of: `no_validation`, `validate_only`, `validate_and_clean`.

Example input: `{"rate_id":"<rate_id>"}`

### `shipstation_label_create_from_shipment`

Buy Label from Shipment · Write

Buy a label for an existing shipment using the carrier and service already set on it; this charges the carrier account.
Returns the label with label_id, tracking_number, shipment_cost and label_download links.
Use shipstation_label_create_from_shipment for shipments created with shipstation_shipments_create or imported from a store.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `shipment_id` (`string`, required): ID of the shipment to buy a label for. Example: se-28529731
- `display_scheme` (`string`, optional): label, paperless (QR or code instead of a printed label, where the carrier supports it) or label_and_paperless. Defaults to label. Example: label. One of: `label`, `paperless`, `label_and_paperless`.
- `label_download_type` (`string`, optional): url returns links to the label files; inline returns the label as base64 in the response. Defaults to url. Example: url. One of: `url`, `inline`.
- `label_format` (`string`, optional): Label file format: pdf, png or zpl. Defaults to pdf. Example: pdf. One of: `pdf`, `png`, `zpl`.
- `label_layout` (`string`, optional): Label size: 4x6 or letter (letter only for pdf). Defaults to 4x6. Example: 4x6. One of: `4x6`, `letter`.
- `validate_address` (`string`, optional): Address validation before buying: no_validation, validate_only or validate_and_clean. Example: validate_and_clean. One of: `no_validation`, `validate_only`, `validate_and_clean`.

Example input: `{"shipment_id":"<shipment_id>"}`

### `shipstation_label_return_create`

Create Return Label · Write

Create a return label for an outbound label; carriers may charge on creation or when scanned.
Returns the new return label with label_id, tracking_number and label_download links.
Use shipstation_label_return_create when a customer sends an order back.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `label_id` (`string`, required): ID of the outbound label. Example: se-28529731
- `carrier_id` (`string`, optional): Carrier to use for the return instead of the outbound carrier; needs service_code. Example: se-123890
- `charge_event` (`string`, optional): When the return label is charged: carrier_default, on_creation or on_carrier_acceptance. Example: on_carrier_acceptance. One of: `carrier_default`, `on_creation`, `on_carrier_acceptance`.
- `confirmation` (`string`, optional): Delivery confirmation for the return. Example: none. One of: `none`, `delivery`, `signature`, `adult_signature`, `adult_signature_restricted_delivery`, `direct_signature`, `delivery_mailed`, `verbal_confirmation`, `delivery_code`, `age_verification_16_plus`.
- `display_scheme` (`string`, optional): label, paperless (QR or code instead of a printed label, where the carrier supports it) or label_and_paperless. Defaults to label. Example: label. One of: `label`, `paperless`, `label_and_paperless`.
- `label_download_type` (`string`, optional): url returns links to the label files; inline returns the label as base64 in the response. Defaults to url. Example: url. One of: `url`, `inline`.
- `label_format` (`string`, optional): Label file format: pdf, png or zpl. Defaults to pdf. Example: pdf. One of: `pdf`, `png`, `zpl`.
- `label_layout` (`string`, optional): Label size: 4x6 or letter (letter only for pdf). Defaults to 4x6. Example: 4x6. One of: `4x6`, `letter`.
- `package_code` (`string`, optional): Package type to use instead of the outbound one. Example: package
- `service_code` (`string`, optional): Service to use for the return. Example: usps_priority_mail

Example input: `{"label_id":"<label_id>"}`

### `shipstation_manifest_create`

Create Manifest · Write

Create an end-of-day manifest so the carrier can scan many labels at once, either from a list of label IDs or from a carrier, warehouse and ship date.
Returns the manifest(s) with manifest_id, form_id, label_ids and manifest_download (PDF).
Use shipstation_manifest_create before carrier pickup or drop-off.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `carrier_id` (`string`, optional): Carrier to manifest all labels for, with warehouse_id and ship_date. Example: se-123890
- `excluded_label_ids` (`array`, optional): Labels to leave out when manifesting by carrier and date. Example: ["se-28529732"]
- `label_ids` (`array`, optional): Labels to include. Provide label_ids, or carrier_id + warehouse_id + ship_date. Example: ["se-28529731"]
- `ship_date` (`string`, optional): Ship date of the labels to include. Example: 2026-11-16T00:00:00Z
- `warehouse_id` (`string`, optional): Warehouse the labels ship from. Example: se-28529731

Example input: `{}`

### `shipstation_pickup_schedule`

Schedule Pickup · Write

Schedule a carrier pickup for one or more labels; some carriers charge for pickups.
Returns the pickup with pickup_id, confirmation_number and the pickup_windows the carrier accepted.
Use shipstation_pickup_schedule after buying labels. Use shipstation_pickup_cancel to cancel.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `contact_details` (`object`, required): Contact for the pickup with name, email and phone (all required). Example: {"name": "John Doe", "email": "john@example.com", "phone": "111-111-1111"}
- `label_ids` (`array`, required): Labels to be picked up (same carrier). Example: ["se-28529731"]
- `pickup_window` (`object`, required): Requested pickup time range with start_at and end_at (ISO 8601). Example: {"start_at": "2026-11-17T14:00:00Z", "end_at": "2026-11-17T18:00:00Z"}
- `pickup_notes` (`string`, optional): Instructions for the driver. Example: Packages are at the loading dock

Example input: `{"contact_details":{"name":"John Doe","email":"john@example.com","phone":"111-111-1111"},"label_ids":["se-28529731"],"pickup_window":{"start_at":"2026-11-17T14:00:00Z","end_at":"2026-11-17T18:00:00Z"}}`

### `shipstation_rates_calculate`

Calculate Rates · Write

Get shipping rates from one or more carriers for an existing shipment ID or a new shipment, which ShipStation then saves.
Returns the shipment with rate_response.rates[] (rate_id, carrier_id, service_code, shipping_amount, delivery_days) and invalid_rates.
Use shipstation_rates_calculate before buying with shipstation_label_create_from_rate. Use shipstation_rates_estimate for a quick quote without addresses.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `rate_options` (`object`, required): Rate options; carrier_ids is required, and service_codes, package_types, calculate_tax_amount, preferred_currency, is_return and rate_type are optional. Example: {"carrier_ids": ["se-123890"]}
- `shipment` (`object`, optional): Shipment details: carrier_id and service_code (from shipstation_carriers_list), ship_date, ship_to and ship_from addresses (each needs name, phone, address_line1, city_locality, state_province, postal_code, country_code and address_residential_indicator yes, no or unknown), or warehouse_id instead of ship_from, and packages[] each with weight {value, unit} and optional dimensions {length, width, height, unit}. Example: {"carrier_id": "se-123890", "service_code": "usps_priority_mail", "ship_to": {"name": "Amanda Miller", "phone": "555-555-5555", "address_line1": "525 S Winchester Blvd", "city_locality": "San Jose", "state_province": "CA", "postal_code": "95128", "country_code": "US", "address_residential_indicator": "yes"}, "ship_from": {"name": "John Doe", "company_name": "Example Corp", "phone": "111-111-1111", "address_line1": "4009 Marathon Blvd", "city_locality": "Austin", "state_province": "TX", "postal_code": "78756", "country_code": "US", "address_residential_indicator": "no"}, "packages": [{"weight": {"value": 20, "unit": "ounce"}, "dimensions": {"length": 12, "width": 8, "height": 4, "unit": "inch"}}]}
- `shipment_id` (`string`, optional): Existing shipment to rate. Provide shipment_id or shipment. Example: se-28529731

Example input: `{"rate_options":{"carrier_ids":["se-123890"]}}`

### `shipstation_shipments_create`

Create Shipments · Write

Create one or more shipments (orders ready to ship) without buying labels.
Returns has_errors and shipments[] with each new shipment_id, status and any errors.
Use shipstation_shipments_create to stage shipments, then shipstation_rates_calculate or shipstation_label_create_from_shipment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `shipments` (`array`, required): Shipments to create. Each takes carrier_id, service_code, ship_date, external_shipment_id, ship_to, ship_from (or warehouse_id), packages, items, and notes or amount fields as needed. Addresses need name, phone, address_line1, city_locality, state_province, postal_code, country_code and address_residential_indicator. Packages need weight {value, unit}. Example: [{"carrier_id": "se-123890", "service_code": "usps_priority_mail", "ship_to": {"name": "Amanda Miller", "phone": "555-555-5555", "address_line1": "525 S Winchester Blvd", "city_locality": "San Jose", "state_province": "CA", "postal_code": "95128", "country_code": "US", "address_residential_indicator": "yes"}, "ship_from": {"name": "John Doe", "company_name": "Example Corp", "phone": "111-111-1111", "address_line1": "4009 Marathon Blvd", "city_locality": "Austin", "state_province": "TX", "postal_code": "78756", "country_code": "US", "address_residential_indicator": "no"}, "packages": [{"weight": {"value": 20, "unit": "ounce"}, "dimensions": {"length": 12, "width": 8, "height": 4, "unit": "inch"}}]}]

Example input: `{"shipments":[]}`

### `shipstation_label_void`

Void Label · Destructive

Void an unused label and request a refund of its postage.
Returns approved (true or false) and a message from the carrier.
Use shipstation_label_void for labels that will not be used. Use shipstation_shipment_cancel for shipments without a label.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `label_id` (`string`, required): ID of the label to void. Example: se-28529731

Example input: `{"label_id":"<label_id>"}`

### `shipstation_pickup_cancel`

Cancel Pickup · Destructive

Cancel a scheduled carrier pickup.
Returns the pickup_id of the cancelled pickup.
Use shipstation_pickup_cancel with an ID from shipstation_pickups_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `pickup_id` (`string`, required): ID of the pickup to cancel. Example: pik_3YcKU5zdtJuCqoeNwyqqbW

Example input: `{"pickup_id":"<pickup_id>"}`

### `shipstation_shipment_cancel`

Cancel Shipment · Destructive

Cancel a shipment so it is no longer awaiting a label.
Returns no content on success.
Use shipstation_shipment_cancel for a shipment that will not ship. Use shipstation_label_void to void a label that was already bought.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `shipment_id` (`string`, required): ID of the shipment to cancel. Example: se-28529731

Example input: `{"shipment_id":"<shipment_id>"}`

## Related

Other Automation connectors ([all 91](/agentkit/connectors/?category=automation)):

- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twilio](/agentkit/connectors/twilio/): Scalekit connector, Username and password, 61 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
