Skip to main content

ShipStation Component

Manage shipments, orders, and fulfillments in ShipStation

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.

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​

Manual Webhook​

Receive and validate webhook requests from ShipStation for manually configured webhook subscriptions. | key: shipStationWebhookTrigger

New and Updated Orders​

Checks for new and updated orders in ShipStation on a configured schedule. | key: pollOrders

InputNotesExample
Connection

The ShipStation connection to use.

This trigger polls ShipStation for new and updated orders on a configured schedule.

How It Works​

  1. The trigger runs on the configured schedule (e.g., every 5 minutes)
  2. It queries the ShipStation Orders API for records modified since the last poll time
  3. Records are categorized as "new" or "updated" based on their createDate and modifyDate timestamps
  4. The trigger updates its internal state to track the last successful poll time

Returned Data​

The trigger returns an object containing arrays for new and updated records.

Example Response
{
  "data": {
    "newRecords": [
      {
        "orderId": 123456789,
        "orderNumber": "TEST-001",
        "orderStatus": "awaiting_shipment",
        "createDate": "2024-01-15T10:30:00.0000000",
        "modifyDate": "2024-01-15T10:30:00.0000000"
      }
    ],
    "updatedRecords": [
      {
        "orderId": 987654321,
        "orderNumber": "TEST-002",
        "orderStatus": "shipped",
        "createDate": "2024-01-10T09:00:00.0000000",
        "modifyDate": "2024-01-16T14:22:00.0000000"
      }
    ]
  }
}

New and Updated Products​

Checks for new and updated products in ShipStation on a configured schedule. | key: pollProducts

InputNotesExample
Connection

The ShipStation connection to use.

This trigger polls ShipStation for new and updated products on a configured schedule.

How It Works​

  1. The trigger runs on the configured schedule (e.g., every 5 minutes)
  2. It queries the ShipStation Products API for records modified since the last poll time
  3. Records are categorized as "new" or "updated" based on their createDate and modifyDate timestamps
  4. The trigger updates its internal state to track the last successful poll time

Returned Data​

The trigger returns an object containing arrays for new and updated records.

Example Response
{
  "data": {
    "newRecords": [
      {
        "productId": 123456789,
        "sku": "PROD-001",
        "name": "Example Product",
        "createDate": "2024-01-15T10:30:00.0000000",
        "modifyDate": "2024-01-15T10:30:00.0000000"
      }
    ],
    "updatedRecords": [
      {
        "productId": 987654321,
        "sku": "PROD-002",
        "name": "Updated Product",
        "createDate": "2024-01-10T09:00:00.0000000",
        "modifyDate": "2024-01-16T14:22:00.0000000"
      }
    ]
  }
}

New and Updated Shipments​

Checks for new and updated shipments in ShipStation on a configured schedule. | key: pollShipments

InputNotesExample
Connection

The ShipStation connection to use.

This trigger polls ShipStation for new and updated shipments on a configured schedule.

How It Works​

  1. The trigger runs on the configured schedule (e.g., every 5 minutes)
  2. It queries the ShipStation Shipments API for records created since the last poll time
  3. Records are categorized as "new" or "updated" based on their createDate and modifyDate timestamps
  4. The trigger updates its internal state to track the last successful poll time

Returned Data​

The trigger returns an object containing arrays for new and updated records.

Example Response
{
  "data": {
    "newRecords": [
      {
        "shipmentId": 123456789,
        "orderId": 987654321,
        "orderNumber": "TEST-001",
        "createDate": "2024-01-15T10:30:00.0000000",
        "modifyDate": "2024-01-15T10:30:00.0000000"
      }
    ],
    "updatedRecords": [
      {
        "shipmentId": 111222333,
        "orderId": 444555666,
        "orderNumber": "TEST-002",
        "createDate": "2024-01-10T09:00:00.0000000",
        "modifyDate": "2024-01-16T14:22:00.0000000"
      }
    ]
  }
}

Webhook Event Subscription​

Receive webhook event notifications from ShipStation. Automatically creates and manages a webhook subscription for the selected event type when the instance is deployed, and removes the subscription when the instance is deleted. | key: webhookEventSubscription

InputNotesExample
Connection

The ShipStation connection to use.

Friendly Name

A descriptive label to identify the webhook in the dashboard.

Store ID

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

Webhook Event

The event type to subscribe to for webhook notifications.

This trigger receives webhook event notifications from ShipStation. It automatically creates and manages a webhook subscription for the selected event type when the instance is deployed, and removes the subscription when the instance is deleted.

How It Works​

When this trigger is used in a flow:

  • On Instance Deploy: The trigger automatically creates a webhook subscription in ShipStation pointing to the instance's unique webhook URL. If a webhook with the same configuration already exists, it reuses the existing subscription.
  • On Instance Deletion: The trigger automatically removes the webhook subscription from ShipStation.

If the event type or store ID configuration changes between deployments, the trigger deletes the existing webhook and creates a new one with the updated settings.

Configuration​

Configure the following inputs:

  • Webhook Event: The event type to subscribe to for webhook notifications
  • Store ID: (Optional) Limits webhook notifications to a specific store. When omitted, notifications are sent for all stores.
  • Friendly Name: (Optional) A descriptive label to identify the webhook

Event Types​

Available Events (6)
EventDescription
ORDER_NOTIFYTriggers when a new order is created
ITEM_ORDER_NOTIFYTriggers when a new order item is created
SHIP_NOTIFYTriggers when a shipment is created
ITEM_SHIP_NOTIFYTriggers when a shipment item is created
FULFILLMENT_SHIPPEDTriggers when a fulfillment is shipped
FULFILLMENT_REJECTEDTriggers when a fulfillment is rejected

Refer to the ShipStation Webhooks documentation for the complete and up-to-date list.

Returned Data​

The trigger returns the raw webhook payload sent by ShipStation via HTTP POST.

Example Payload
{
  "resource_url": "https://ssapi.shipstation.com/orders?importBatch=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "resource_type": "ORDER_NOTIFY"
}

Data Sources​

Select Carrier​

A picklist of carriers connected to the ShipStation account. | key: selectCarriers | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Select Customer​

A picklist of customers in the 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 unique identifier for the marketplace to filter results by.

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 API field name used to sort the returned results.

Sort Direction

The direction to sort results (asc or desc).

State Code

The two-letter state or province abbreviation for the customer address.

Tag ID

The unique identifier for the tag to filter results by.

Select Fulfillment​

A picklist of fulfillments in the ShipStation account. | key: selectFulfillments | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

{
  "result": [
    {
      "label": "Fulfillment #12345 (Order: ORD-001)",
      "key": "12345"
    }
  ]
}

Select Order​

A picklist of orders in the ShipStation account. | key: selectOrders | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Customer Name

The full name associated with the customer record.

John Smith
Order Status

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

awaiting_shipment
Page

The page number to retrieve (starts at 1).

1
Page Size

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

100

Select Package​

A picklist of packages provided by the specified carrier. | key: selectPackages | type: picklist

InputNotesExample
Carrier Code

The carrier code for the shipping label.

Connection

The ShipStation connection to use.

Select Product​

A picklist of products in the ShipStation account. | 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 unique identifier for the category grouping the product.

Product Name

The display name of the product to search for.

Product Type ID

The unique identifier for the product type classification.

Show Inactive

When true, includes inactive stores in the results.

false
SKU

The stock keeping unit code assigned to the product.

Sort By

The API field name used to sort the returned results.

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 unique identifier for the tag to filter results by.

Select Service​

A picklist of services provided by the specified carrier. | key: selectServices | type: picklist

InputNotesExample
Carrier Code

The carrier code for the shipping label.

Connection

The ShipStation connection to use.

Select Store​

A picklist of installed stores in the ShipStation account. | key: selectStores | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Marketplace ID

The unique identifier for the marketplace to filter results by.

Show Inactive

When true, includes inactive stores in the results.

false

Select User​

A picklist of users in the ShipStation account. | key: selectUsers | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Show Inactive Users

When true, includes inactive users in the results.

false

Select Warehouse​

A picklist of Ship From Locations (warehouses) in the ShipStation account. | key: selectWarehouses | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

Select Webhook​

A picklist of registered webhooks in the ShipStation account. | key: selectWebhooks | type: picklist

InputNotesExample
Connection

The ShipStation connection to use.

{
  "result": [
    {
      "label": "ORDER_NOTIFY → https://example.com/webhook",
      "key": "12345"
    }
  ]
}

Actions​

Create Label for Order​

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

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

18324102
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

{
  "data": {
    "shipmentId": 72513480,
    "shipmentCost": 7.3,
    "insuranceCost": 0,
    "trackingNumber": "248201115029520",
    "labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago...",
    "formData": null
  }
}

Create or Update Multiple Orders​

Creates or updates 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.

{
  "data": {
    "results": [
      {
        "orderId": 94113592,
        "orderNumber": "TEST-ORDER-API-DOCS",
        "orderKey": "0f6bec18-9-4771-83aa-f392d84f4c74",
        "orderDate": "2015-06-29T08:46:27.0000000",
        "createDate": "2015-07-16T14:00:34.8230000",
        "modifyDate": "2015-09-08T11:03:12.3800000",
        "paymentDate": "2015-06-29T08:46:27.0000000",
        "shipByDate": "2015-07-05T00:00:00.0000000",
        "orderStatus": "awaiting_shipment",
        "customerId": 37701499,
        "customerUsername": "headhoncho@whitehouse.gov",
        "customerEmail": "headhoncho@whitehouse.gov",
        "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": 128836912,
            "lineItemKey": "vd08-MSLbtx",
            "sku": "ABC123",
            "name": "Test item #1",
            "imageUrl": null,
            "weight": {
              "value": 24,
              "units": "ounces"
            },
            "quantity": 2,
            "unitPrice": 99.99,
            "taxAmount": null,
            "shippingAmount": null,
            "warehouseLocation": "Aisle 1, Bin 7",
            "options": [
              {
                "name": "Size",
                "value": "Large"
              }
            ],
            "productId": 7239919,
            "fulfillmentSku": null,
            "adjustment": false,
            "upc": null,
            "createDate": "2015-07-16T14:00:34.823",
            "modifyDate": "2015-07-16T14:00:34.823"
          },
          {
            "orderItemId": 128836913,
            "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": null,
            "adjustment": true,
            "upc": null,
            "createDate": "2015-07-16T14:00:34.823",
            "modifyDate": "2015-07-16T14:00:34.823"
          }
        ],
        "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_home_delivery",
        "packageCode": "package",
        "confirmation": "delivery",
        "shipDate": "2015-07-02",
        "holdUntilDate": null,
        "weight": {
          "value": 48,
          "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": 24079,
          "nonMachinable": false,
          "saturdayDelivery": false,
          "containsAlcohol": false,
          "mergedOrSplit": false,
          "mergedIds": [],
          "parentId": null,
          "storeId": 26815,
          "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 or Update Order​

Creates a new order or updates an existing one. | key: createOrUpdateOrder

InputNotesExample
Additional Fields

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.

Order Date

The date the order was placed. Format: ISO 8601 (e.g., 2023-09-08T12:34:56.000Z).

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_shipment
Shipping Address

Provide the shipping address in JSON format.

{
  "data": {
    "orderId": 94113592,
    "orderNumber": "TEST-ORDER-API-DOCS",
    "orderKey": "0f6bec18-9-4771-83aa-f392d84f4c74",
    "orderDate": "2015-06-29T08:46:27.0000000",
    "createDate": "2015-07-16T14:00:34.8230000",
    "modifyDate": "2015-09-08T11:03:12.3800000",
    "paymentDate": "2015-06-29T08:46:27.0000000",
    "shipByDate": "2015-07-05T00:00:00.0000000",
    "orderStatus": "awaiting_shipment",
    "customerId": 37701499,
    "customerUsername": "headhoncho@whitehouse.gov",
    "customerEmail": "headhoncho@whitehouse.gov",
    "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": 128836912,
        "lineItemKey": "vd08-MSLbtx",
        "sku": "ABC123",
        "name": "Test item #1",
        "imageUrl": null,
        "weight": {
          "value": 24,
          "units": "ounces"
        },
        "quantity": 2,
        "unitPrice": 99.99,
        "taxAmount": null,
        "shippingAmount": null,
        "warehouseLocation": "Aisle 1, Bin 7",
        "options": [
          {
            "name": "Size",
            "value": "Large"
          }
        ],
        "productId": 7239919,
        "fulfillmentSku": null,
        "adjustment": false,
        "upc": null,
        "createDate": "2015-07-16T14:00:34.823",
        "modifyDate": "2015-07-16T14:00:34.823"
      },
      {
        "orderItemId": 128836913,
        "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": null,
        "adjustment": true,
        "upc": null,
        "createDate": "2015-07-16T14:00:34.823",
        "modifyDate": "2015-07-16T14:00:34.823"
      }
    ],
    "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_home_delivery",
    "packageCode": "package",
    "confirmation": "delivery",
    "shipDate": "2015-07-02",
    "holdUntilDate": null,
    "weight": {
      "value": 48,
      "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": 24079,
      "nonMachinable": false,
      "saturdayDelivery": false,
      "containsAlcohol": false,
      "mergedOrSplit": false,
      "mergedIds": [],
      "parentId": null,
      "storeId": 26815,
      "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
Additional Fields

A list of additional fields to include in the shipment.

testLabel: false
Carrier Code

The carrier code for the shipping label.

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 order should 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.

{
  "data": {
    "shipmentId": 123456789,
    "orderId": null,
    "userId": null,
    "customerEmail": null,
    "orderNumber": null,
    "createDate": "2016-04-03T12:11:36.8630000",
    "shipDate": "2016-04-03",
    "shipmentCost": 9.06,
    "insuranceCost": 0,
    "trackingNumber": "782390443992",
    "isReturnLabel": false,
    "batchNumber": null,
    "carrierCode": "fedex",
    "serviceCode": "fedex_ground",
    "packageCode": "package",
    "confirmation": "delivery",
    "warehouseId": null,
    "voided": false,
    "voidDate": null,
    "marketplaceNotified": false,
    "notifyErrorMessage": null,
    "shipTo": null,
    "weight": null,
    "dimensions": null,
    "insuranceOptions": null,
    "advancedOptions": null,
    "shipmentItems": null,
    "labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago...",
    "formData": null
  }
}

Create Warehouse​

Creates a Ship From Location (warehouse) in the ShipStation 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

A descriptive label for the ship-from location.

{
  "data": {
    "warehouseId": 17977,
    "warehouseName": "New Ship From Location",
    "originAddress": {
      "name": "NM Warehouse",
      "company": "White Sands Co",
      "street1": "4704 Arabela Dr.",
      "street2": "",
      "street3": "",
      "city": "Las Cruces",
      "state": "NM",
      "postalCode": "88012",
      "country": "US",
      "phone": "512-111-2222",
      "residential": true
    },
    "returnAddress": {
      "name": "NM Warehouse",
      "company": "White Sands Co",
      "street1": "4704 Arabela Dr.",
      "street2": "",
      "street3": "",
      "city": "Las Cruces",
      "state": "NM",
      "postalCode": "88012",
      "country": "US",
      "phone": "512-111-2222",
      "residential": null
    },
    "createDate": "2014-10-21T08:11:43.8800000",
    "isDefault": false
  }
}

Deactivate Store​

Deactivates the specified store. | key: deactivateStore

InputNotesExample
Connection

The ShipStation connection to use.

Store ID

The unique identifier for the store.

{
  "data": {
    "success": "true",
    "message": "The requested store has been reactivated."
  }
}

Delete Instanced Webhooks​

Deletes all webhooks that point to a flow in this instance. | key: deleteInstancedWebhooks

InputNotesExample
Connection

The ShipStation connection to use.

{
  "data": "Webhooks deleted successfully."
}

Delete Order​

Deletes an order from the database by setting it to inactive. | key: deleteOrder

InputNotesExample
Connection

The ShipStation connection to use.

Order ID

The unique identifier for the order.

18324102

{
  "data": {
    "success": true,
    "message": "The requested order has been deleted."
  }
}

Delete Warehouse​

Deletes a warehouse (Ship From Location) by setting it to inactive status. | key: deleteWarehouse

InputNotesExample
Connection

The ShipStation connection to use.

Warehouse ID

The unique identifier for the warehouse.

{
  "data": {
    "success": true,
    "message": "The requested warehouse has been deleted."
  }
}

Get Customer​

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

{
  "data": {
    "customerId": 12345678,
    "createDate": "2014-11-18T10:33:01.1900000",
    "modifyDate": "2014-11-18T10:33:01.1900000",
    "name": "Cam Newton",
    "company": "Test Company",
    "street1": "123 War Eagle Lane",
    "street2": "",
    "city": "Auburn",
    "state": "AL",
    "postalCode": "36830",
    "countryCode": "US",
    "phone": "555-555-5555",
    "email": "camn1@example.com",
    "addressVerified": "Verified",
    "marketplaceUsernames": [
      {
        "customerUserId": 67195020,
        "customerId": 12345678,
        "createDate": "2015-04-27T12:35:03.8300000",
        "modifyDate": "2015-05-14T08:16:15.2700000",
        "marketplaceId": 0,
        "marketplace": "ShipStation",
        "username": "camn1@example.com"
      },
      {
        "customerUserId": 37568588,
        "customerId": 12345678,
        "createDate": "2014-11-18T10:33:01.1970000",
        "modifyDate": "2014-11-18T10:33:01.1970000",
        "marketplaceId": 36,
        "marketplace": "WooCommerce",
        "username": "camn1@example.com"
      }
    ],
    "tags": [
      {
        "tagId": 1234,
        "name": "Expedited"
      },
      {
        "tagId": 9725,
        "name": "00 BULK ORDERED"
      }
    ]
  }
}

Get Order​

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

InputNotesExample
Connection

The ShipStation connection to use.

Order ID

The unique identifier for the order.

18324102

{
  "data": {
    "orderId": 94113592,
    "orderNumber": "TEST-ORDER-API-DOCS",
    "orderKey": "0f6bec18-9-4771-83aa-f392d84f4c74",
    "orderDate": "2015-06-29T08:46:27.0000000",
    "createDate": "2015-07-16T14:00:34.8230000",
    "modifyDate": "2015-09-08T11:03:12.3800000",
    "paymentDate": "2015-06-29T08:46:27.0000000",
    "shipByDate": "2015-07-05T00:00:00.0000000",
    "orderStatus": "awaiting_shipment",
    "customerId": 37701499,
    "customerUsername": "headhoncho@whitehouse.gov",
    "customerEmail": "headhoncho@whitehouse.gov",
    "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": 128836912,
        "lineItemKey": "vd08-MSLbtx",
        "sku": "ABC123",
        "name": "Test item #1",
        "imageUrl": null,
        "weight": {
          "value": 24,
          "units": "ounces"
        },
        "quantity": 2,
        "unitPrice": 99.99,
        "taxAmount": null,
        "shippingAmount": null,
        "warehouseLocation": "Aisle 1, Bin 7",
        "options": [
          {
            "name": "Size",
            "value": "Large"
          }
        ],
        "productId": 7239919,
        "fulfillmentSku": null,
        "adjustment": false,
        "upc": null,
        "createDate": "2015-07-16T14:00:34.823",
        "modifyDate": "2015-07-16T14:00:34.823"
      },
      {
        "orderItemId": 128836913,
        "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": null,
        "adjustment": true,
        "upc": null,
        "createDate": "2015-07-16T14:00:34.823",
        "modifyDate": "2015-07-16T14:00:34.823"
      }
    ],
    "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_home_delivery",
    "packageCode": "package",
    "confirmation": "delivery",
    "shipDate": "2015-07-02",
    "holdUntilDate": null,
    "weight": {
      "value": 48,
      "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": 24079,
      "nonMachinable": false,
      "saturdayDelivery": false,
      "containsAlcohol": false,
      "mergedOrSplit": false,
      "mergedIds": [],
      "parentId": null,
      "storeId": 26815,
      "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
  }
}

Get Product​

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

{
  "data": {
    "aliases": null,
    "productId": 12345678,
    "sku": "1004",
    "name": "Coffee Mug",
    "price": 26,
    "defaultCost": 0,
    "length": 3,
    "width": 3,
    "height": 3,
    "weightOz": 26,
    "internalNotes": null,
    "fulfillmentSku": "F1004",
    "createDate": "2014-09-04T09:18:01.293",
    "modifyDate": "2014-09-18T12:38:43.893",
    "active": true,
    "productCategory": {
      "categoryId": 9999,
      "name": "Door Closers"
    },
    "productType": null,
    "warehouseLocation": "Bin 22",
    "defaultCarrierCode": "fedex",
    "defaultServiceCode": "fedex_home_delivery",
    "defaultPackageCode": "package",
    "defaultIntlCarrierCode": "ups",
    "defaultIntlServiceCode": "ups_worldwide_saver",
    "defaultIntlPackageCode": "package",
    "defaultConfirmation": "direct_signature",
    "defaultIntlConfirmation": "adult_signature",
    "customsDescription": null,
    "customsValue": null,
    "customsTariffNo": null,
    "customsCountryCode": null,
    "noCustoms": null,
    "tags": [
      {
        "tagId": 9180,
        "name": "APItest"
      }
    ],
    "upc": "012345678905",
    "thumbnailURL": "url_to_thumbnail_image"
  }
}

Get Store​

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

InputNotesExample
Connection

The ShipStation connection to use.

Store ID

The unique identifier for the store.

{
  "data": {
    "storeId": 12345,
    "storeName": "WooCommerce Store",
    "marketplaceId": 36,
    "marketplaceName": "WooCommerce",
    "accountName": null,
    "email": null,
    "integrationUrl": "http://shipstation-test.wpengine.com",
    "active": true,
    "companyName": "",
    "phone": "",
    "publicEmail": "",
    "website": "",
    "refreshDate": "2014-12-16T17:47:05.457",
    "lastRefreshAttempt": "2014-12-16T09:47:05.457",
    "createDate": "2014-11-06T15:21:13.223",
    "modifyDate": "2014-11-10T08:02:19.117",
    "autoRefresh": true,
    "statusMappings": [
      {
        "orderStatus": "awaiting_payment",
        "statusKey": "Pending"
      },
      {
        "orderStatus": "awaiting_shipment",
        "statusKey": "Processing"
      },
      {
        "orderStatus": "shipped",
        "statusKey": "Completed"
      },
      {
        "orderStatus": "cancelled",
        "statusKey": "Cancelled"
      },
      {
        "orderStatus": "on_hold",
        "statusKey": "On-hold"
      }
    ]
  }
}

Get Warehouse​

Retrieves detailed information about a specific Ship From Location (warehouse). | key: getWarehouse

InputNotesExample
Connection

The ShipStation connection to use.

Warehouse ID

The unique identifier for the warehouse.

{
  "data": {
    "warehouseId": 12345,
    "warehouseName": "API Ship From Location",
    "originAddress": {
      "name": "API Warehouse",
      "company": "ShipStation",
      "street1": "2815 Exposition Blvd",
      "street2": null,
      "street3": null,
      "city": "Austin",
      "state": "TX",
      "postalCode": "78703",
      "country": "US",
      "phone": "512-555-5555",
      "residential": true,
      "addressVerified": null
    },
    "returnAddress": {
      "name": "API Ship From Location",
      "company": "ShipStation",
      "street1": "2815 Exposition Blvd",
      "street2": null,
      "street3": null,
      "city": "Austin",
      "state": "TX",
      "postalCode": "78703",
      "country": "US",
      "phone": "512-555-5555",
      "residential": null,
      "addressVerified": null
    },
    "createDate": "2015-07-02T08:38:31.4870000",
    "isDefault": true
  }
}

List Carriers​

Lists all shipping providers connected to the ShipStation account. | key: listCarriers

InputNotesExample
Connection

The ShipStation connection to use.

{
  "data": [
    {
      "name": "Stamps.com",
      "code": "stamps_com",
      "accountNumber": "SS123",
      "requiresFundedAccount": true,
      "balance": 24.27,
      "nickname": null,
      "shippingProviderId": 12345,
      "primary": true
    },
    {
      "name": "FedEx",
      "code": "fedex",
      "accountNumber": "297929999",
      "requiresFundedAccount": false,
      "balance": 0,
      "nickname": "SS",
      "shippingProviderId": 12348,
      "primary": true
    }
  ]
}

List Customers​

Retrieves 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 unique identifier for the marketplace to filter results by.

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 API field name used to sort the returned results.

Sort Direction

The direction to sort results (asc or desc).

State Code

The two-letter state or province abbreviation for the customer address.

Tag ID

The unique identifier for the tag to filter results by.

{
  "data": {
    "customers": [
      {
        "customerId": 12345678,
        "createDate": "2014-11-18T10:33:01.1900000",
        "modifyDate": "2014-11-18T10:33:01.1900000",
        "name": "Cam Newton",
        "company": "Test Company",
        "street1": "123 War Eagle Lane",
        "street2": "",
        "city": "Auburn",
        "state": "AL",
        "postalCode": "36830",
        "countryCode": "US",
        "phone": "555-555-5555",
        "email": "camn1@example.com",
        "addressVerified": "Verified",
        "marketplaceUsernames": [
          {
            "customerUserId": 67195020,
            "customerId": 12345678,
            "createDate": "2015-04-27T12:35:03.8300000",
            "modifyDate": "2015-05-14T08:16:15.2700000",
            "marketplaceId": 0,
            "marketplace": "ShipStation",
            "username": "camn1@example.com"
          },
          {
            "customerUserId": 37568588,
            "customerId": 12345678,
            "createDate": "2014-11-18T10:33:01.1970000",
            "modifyDate": "2014-11-18T10:33:01.1970000",
            "marketplaceId": 36,
            "marketplace": "WooCommerce",
            "username": "camn1@example.com"
          }
        ],
        "tags": [
          {
            "tagId": 1234,
            "name": "Expedited"
          },
          {
            "tagId": 9725,
            "name": "00 BULK ORDERED"
          }
        ]
      }
    ],
    "total": 1,
    "page": 1,
    "pages": 1
  }
}

List Fulfillments​

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

100

{
  "data": {
    "fulfillments": [
      {
        "fulfillmentId": 33974374,
        "orderId": 191759016,
        "orderNumber": "101",
        "userId": "c9f06d74-95de-4263-9b04-e87095cababf",
        "customerEmail": "headhoncho@whitehouse.gov",
        "trackingNumber": "783408231234",
        "createDate": "2016-06-07T08:50:50.0670000",
        "shipDate": "2016-06-07T00:00:00.0000000",
        "voidDate": null,
        "deliveryDate": null,
        "carrierCode": "USPS",
        "fulfillmentProviderCode": null,
        "fulfillmentServiceCode": null,
        "fulfillmentFee": 0,
        "voidRequested": false,
        "voided": false,
        "marketplaceNotified": true,
        "notifyErrorMessage": null,
        "shipTo": {
          "name": "Yoda",
          "company": null,
          "street1": "3800 N Lamar Blvd # 220",
          "street2": null,
          "street3": null,
          "city": "AUSTIN",
          "state": "TX",
          "postalCode": "78756",
          "country": "US",
          "phone": "512-485-4282",
          "residential": null,
          "addressVerified": null
        }
      }
    ],
    "total": 1,
    "page": 1,
    "pages": 1
  }
}

List Orders​

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

InputNotesExample
Connection

The ShipStation connection to use.

Customer Name

The full name associated with the customer record.

John Smith
Order Status

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

awaiting_shipment
Page

The page number to retrieve (starts at 1).

1
Page Size

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

100

{
  "data": {
    "orders": [
      {
        "orderId": 94113592,
        "orderNumber": "TEST-ORDER-API-DOCS",
        "orderKey": "0f6bec18-9-4771-83aa-f392d84f4c74",
        "orderDate": "2015-06-29T08:46:27.0000000",
        "createDate": "2015-07-16T14:00:34.8230000",
        "modifyDate": "2015-09-08T11:03:12.3800000",
        "paymentDate": "2015-06-29T08:46:27.0000000",
        "shipByDate": "2015-07-05T00:00:00.0000000",
        "orderStatus": "awaiting_shipment",
        "customerId": 37701499,
        "customerUsername": "headhoncho@whitehouse.gov",
        "customerEmail": "headhoncho@whitehouse.gov",
        "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": 128836912,
            "lineItemKey": "vd08-MSLbtx",
            "sku": "ABC123",
            "name": "Test item #1",
            "imageUrl": null,
            "weight": {
              "value": 24,
              "units": "ounces"
            },
            "quantity": 2,
            "unitPrice": 99.99,
            "taxAmount": null,
            "shippingAmount": null,
            "warehouseLocation": "Aisle 1, Bin 7",
            "options": [
              {
                "name": "Size",
                "value": "Large"
              }
            ],
            "productId": 7239919,
            "fulfillmentSku": null,
            "adjustment": false,
            "upc": null,
            "createDate": "2015-07-16T14:00:34.823",
            "modifyDate": "2015-07-16T14:00:34.823"
          },
          {
            "orderItemId": 128836913,
            "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": null,
            "adjustment": true,
            "upc": null,
            "createDate": "2015-07-16T14:00:34.823",
            "modifyDate": "2015-07-16T14:00:34.823"
          }
        ],
        "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_home_delivery",
        "packageCode": "package",
        "confirmation": "delivery",
        "shipDate": "2015-07-02",
        "holdUntilDate": null,
        "weight": {
          "value": 48,
          "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": 24079,
          "nonMachinable": false,
          "saturdayDelivery": false,
          "containsAlcohol": false,
          "mergedOrSplit": false,
          "mergedIds": [],
          "parentId": null,
          "storeId": 26815,
          "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
      }
    ],
    "total": 1,
    "page": 1,
    "pages": 1
  }
}

List Packages​

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

InputNotesExample
Carrier Code

The carrier code for the shipping label.

Connection

The ShipStation connection to use.

{
  "data": [
    {
      "carrierCode": "express_1",
      "code": "flat_rate_envelope",
      "name": "Flat Rate Envelope",
      "domestic": true,
      "international": true
    },
    {
      "carrierCode": "express_1",
      "code": "large_flat_rate_box",
      "name": "Large Flat Rate Box",
      "domestic": true,
      "international": true
    },
    {
      "carrierCode": "express_1",
      "code": "package",
      "name": "Package",
      "domestic": true,
      "international": true
    }
  ]
}

List Products​

Retrieves 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 unique identifier for the category grouping the product.

Product Name

The display name of the product to search for.

Product Type ID

The unique identifier for the product type classification.

Show Inactive

When true, includes inactive stores in the results.

false
SKU

The stock keeping unit code assigned to the product.

Sort By

The API field name used to sort the returned results.

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 unique identifier for the tag to filter results by.

{
  "data": {
    "products": [
      {
        "aliases": null,
        "productId": 12345678,
        "sku": "1004",
        "name": "Coffee Mug",
        "price": 26,
        "defaultCost": 0,
        "length": 3,
        "width": 3,
        "height": 3,
        "weightOz": 26,
        "internalNotes": null,
        "fulfillmentSku": "F1004",
        "createDate": "2014-09-04T09:18:01.293",
        "modifyDate": "2014-09-18T12:38:43.893",
        "active": true,
        "productCategory": {
          "categoryId": 9999,
          "name": "Door Closers"
        },
        "productType": null,
        "warehouseLocation": "Bin 22",
        "defaultCarrierCode": "fedex",
        "defaultServiceCode": "fedex_home_delivery",
        "defaultPackageCode": "package",
        "defaultIntlCarrierCode": "ups",
        "defaultIntlServiceCode": "ups_worldwide_saver",
        "defaultIntlPackageCode": "package",
        "defaultConfirmation": "direct_signature",
        "defaultIntlConfirmation": "adult_signature",
        "customsDescription": null,
        "customsValue": null,
        "customsTariffNo": null,
        "customsCountryCode": null,
        "noCustoms": null,
        "tags": [
          {
            "tagId": 9180,
            "name": "APItest"
          }
        ],
        "upc": "012345678905",
        "thumbnailURL": "url_to_thumbnail_image"
      }
    ],
    "total": 1,
    "page": 1,
    "pages": 1
  }
}

List Services​

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

InputNotesExample
Carrier Code

The carrier code for the shipping label.

Connection

The ShipStation connection to use.

{
  "data": [
    {
      "carrierCode": "fedex",
      "code": "fedex_ground",
      "name": "FedEx Ground®",
      "domestic": true,
      "international": false
    },
    {
      "carrierCode": "fedex",
      "code": "fedex_home_delivery",
      "name": "FedEx Home Delivery®",
      "domestic": true,
      "international": false
    },
    {
      "carrierCode": "fedex",
      "code": "fedex_2day",
      "name": "FedEx 2Day®",
      "domestic": true,
      "international": false
    }
  ]
}

List Shipments​

Retrieves 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 name of the person or business receiving the shipment.

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 carrier-assigned tracking number for the shipment.

{
  "data": {
    "shipments": [
      {
        "shipmentId": 33974374,
        "orderId": 43945660,
        "orderKey": "8061c220f0794a9b92460b8bae6837e4",
        "userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
        "orderNumber": "100038-1",
        "createDate": "2014-10-03T06:51:33.6270000",
        "shipDate": "2014-10-03",
        "shipmentCost": 1.93,
        "insuranceCost": 0,
        "trackingNumber": "9400111899561704681189",
        "isReturnLabel": false,
        "batchNumber": "100301",
        "carrierCode": "stamps_com",
        "serviceCode": "usps_first_class_mail",
        "packageCode": "package",
        "confirmation": "delivery",
        "warehouseId": 16079,
        "voided": false,
        "voidDate": null,
        "marketplaceNotified": true,
        "notifyErrorMessage": null,
        "shipTo": {
          "name": "Yoda",
          "company": "",
          "street1": "12223 LOWDEN LN",
          "street2": "",
          "street3": null,
          "city": "MANCHACA",
          "state": "TX",
          "postalCode": "78652-3602",
          "country": "US",
          "phone": "2101235544",
          "residential": null
        },
        "weight": {
          "value": 1,
          "units": "ounces"
        },
        "dimensions": null,
        "insuranceOptions": {
          "provider": null,
          "insureShipment": false,
          "insuredValue": 0
        },
        "advancedOptions": null,
        "shipmentItems": [
          {
            "orderItemId": 56568665,
            "lineItemKey": null,
            "sku": "SQ3785739",
            "name": "Potato Kitten -",
            "imageUrl": null,
            "weight": null,
            "quantity": 1,
            "unitPrice": 1,
            "warehouseLocation": null,
            "options": null,
            "productId": 7565777,
            "fulfillmentSku": null
          }
        ],
        "labelData": null,
        "formData": null
      }
    ],
    "total": 1,
    "page": 1,
    "pages": 1
  }
}

List Stores​

Retrieves 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

{
  "data": [
    {
      "storeId": 22766,
      "storeName": "ShipStation Manual Store",
      "marketplaceId": 0,
      "marketplaceName": "ShipStation",
      "accountName": null,
      "email": null,
      "integrationUrl": null,
      "active": true,
      "companyName": "",
      "phone": "",
      "publicEmail": "testemail@email.com",
      "website": "",
      "refreshDate": "2014-12-03T11:46:11.283",
      "lastRefreshAttempt": "2014-12-03T11:46:53.433",
      "createDate": "2014-07-25T11:05:55.307",
      "modifyDate": "2014-11-12T08:45:20.55",
      "autoRefresh": false
    },
    {
      "storeId": 25748,
      "storeName": "Ashley's Test WooCommerce",
      "marketplaceId": 36,
      "marketplaceName": "WooCommerce",
      "accountName": null,
      "email": null,
      "integrationUrl": "http://shipstation.wpengine.com/",
      "active": true,
      "companyName": "",
      "phone": "",
      "publicEmail": "",
      "website": "",
      "refreshDate": "2014-11-26T22:28:14.07",
      "lastRefreshAttempt": "2014-11-26T14:28:14.07",
      "createDate": "2014-11-10T08:53:48.077",
      "modifyDate": "2014-12-03T14:53:50.557",
      "autoRefresh": true
    }
  ]
}

List Users​

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

InputNotesExample
Connection

The ShipStation connection to use.

Show Inactive Users

When true, includes inactive users in the results.

false

{
  "data": [
    {
      "userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
      "userName": "SS-user1",
      "name": "Shipping Employee 1"
    }
  ]
}

List Warehouses​

Retrieves a list of Ship From Locations (warehouses) in the account. | key: listWarehouses

InputNotesExample
Connection

The ShipStation connection to use.

{
  "data": [
    {
      "warehouseId": 17977,
      "warehouseName": "Main warehouse",
      "originAddress": {
        "name": "Spring warehouse",
        "company": "",
        "street1": "123 S SPRING RD",
        "street2": "",
        "street3": "",
        "city": "Elmhurst",
        "state": "IL",
        "postalCode": "60126",
        "country": "US",
        "phone": "5121112222",
        "residential": false
      },
      "returnAddress": {
        "name": "Chicago House",
        "company": "",
        "street1": "123 S SPRING RD",
        "street2": "",
        "street3": "",
        "city": "Elmhurst",
        "state": "IL",
        "postalCode": "60126",
        "country": "US",
        "phone": "5121112222",
        "residential": null
      },
      "createDate": "2014-10-21T08:11:43.8800000",
      "isDefault": true
    },
    {
      "warehouseId": 14265,
      "warehouseName": "Austin",
      "originAddress": {
        "name": "Austin",
        "company": "ShipStation",
        "street1": "2815 Exposition Blvd",
        "street2": "",
        "street3": "",
        "city": "Austin",
        "state": "TX",
        "postalCode": "78703",
        "country": "US",
        "phone": "5124445555",
        "residential": false
      },
      "returnAddress": {
        "name": "ShipStation",
        "company": "ShipStation",
        "street1": "2815 Exposition Blvd",
        "street2": "",
        "street3": "",
        "city": "Austin",
        "state": "TX",
        "postalCode": "78703",
        "country": "US",
        "phone": "5124445555",
        "residential": null
      },
      "createDate": "2014-05-27T09:54:29.9600000",
      "isDefault": false
    }
  ]
}

List Webhooks​

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

InputNotesExample
Connection

The ShipStation connection to use.

{
  "data": {
    "webhooks": [
      {
        "IsLabelAPIHook": false,
        "WebHookID": 123,
        "SellerID": 100000,
        "StoreID": 12345,
        "HookType": "ITEM_ORDER_NOTIFY",
        "MessageFormat": "Json",
        "Url": "http://example.endpoint/orders",
        "Name": "My Order Webhook",
        "BulkCopyBatchID": null,
        "BulkCopyRecordID": null,
        "Active": true,
        "WebhookLogs": [],
        "Seller": null,
        "Store": null
      },
      {
        "IsLabelAPIHook": false,
        "WebHookID": 456,
        "SellerID": 100000,
        "StoreID": 98765,
        "HookType": "SHIP_NOTIFY",
        "MessageFormat": "Json",
        "Url": "https://example.endpoint/shipment",
        "Name": "My Shipment Webhook",
        "BulkCopyBatchID": null,
        "BulkCopyRecordID": null,
        "Active": true,
        "WebhookLogs": [],
        "Seller": null,
        "Store": null
      }
    ]
  }
}

Raw Request​

Sends a raw HTTP request to the ShipStation API. | key: rawRequest

InputNotesExample
Connection

The ShipStation connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
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

{
  "data": {}
}

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

A descriptive label to identify the webhook in the dashboard.

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.

{
  "data": {
    "id": 123456
  }
}

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.

{
  "data": null
}

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.

{
  "data": {
    "success": true,
    "message": "The requested product has been updated"
  }
}

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.

{
  "data": {
    "storeId": 12345,
    "storeName": "WooCommerce Store",
    "marketplaceId": 36,
    "marketplaceName": "WooCommerce",
    "accountName": null,
    "email": null,
    "integrationUrl": "http://shipstation-test.wpengine.com",
    "active": true,
    "companyName": "",
    "phone": "",
    "publicEmail": "",
    "website": "",
    "refreshDate": "2014-12-16T17:47:05.457",
    "lastRefreshAttempt": "2014-12-16T09:47:05.457",
    "createDate": "2014-11-06T15:21:13.223",
    "modifyDate": "2014-11-10T08:02:19.117",
    "autoRefresh": true,
    "statusMappings": [
      {
        "orderStatus": "awaiting_payment",
        "statusKey": "Pending"
      },
      {
        "orderStatus": "awaiting_shipment",
        "statusKey": "Processing"
      },
      {
        "orderStatus": "shipped",
        "statusKey": "Completed"
      },
      {
        "orderStatus": "cancelled",
        "statusKey": "Cancelled"
      },
      {
        "orderStatus": "on_hold",
        "statusKey": "On-hold"
      }
    ]
  }
}

Update Warehouse​

Updates an existing Ship From Location (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.

{
  "data": {
    "warehouseId": 12345,
    "warehouseName": "API Ship From Location",
    "originAddress": {
      "name": "API Warehouse",
      "company": "ShipStation",
      "street1": "2815 Exposition Blvd",
      "street2": null,
      "street3": null,
      "city": "Austin",
      "state": "TX",
      "postalCode": "78703",
      "country": "US",
      "phone": "512-555-5555",
      "residential": true,
      "addressVerified": null
    },
    "returnAddress": {
      "name": "API Ship From Location",
      "company": "ShipStation",
      "street1": "2815 Exposition Blvd",
      "street2": null,
      "street3": null,
      "city": "Austin",
      "state": "TX",
      "postalCode": "78703",
      "country": "US",
      "phone": "512-555-5555",
      "residential": null,
      "addressVerified": null
    },
    "createDate": "2015-07-02T08:38:31.4870000",
    "isDefault": true
  }
}

Changelog​

2026-03-20​

Added new triggers for webhook and polling-based integrations:

  • Webhook Event Subscription - Automatically creates and manages webhook subscriptions on deploy and removes them on instance deletion
  • New and Updated Orders - Polling trigger that checks for new and updated orders on a configured schedule
  • New and Updated Products - Polling trigger that checks for new and updated products on a configured schedule
  • New and Updated Shipments - Polling trigger that checks for new and updated shipments on a configured schedule

2026-03-05​

Added data sources:

  • Select Webhook for selecting registered webhooks from the ShipStation account
  • Select Fulfillment for selecting fulfillments from the ShipStation account

2026-02-24​

Added data sources:

  • Select Carrier for selecting carriers
  • Select Service for selecting shipping services
  • Select Package for selecting package types
  • Select Customer for selecting customers
  • Select Store for selecting stores
  • Select User for selecting users
  • Select Order for selecting orders
  • Select Product for selecting products
  • Select Warehouse for selecting warehouses

2024-03-29​

Added orderKey input to the Create/Update Order action for specifying a custom order key

2023-09-28​

Initial release of the ShipStation component