Skip to main content

ShipStation Component

ShipStation is an ecommerce shipping software solution.

Component key: shipstation

Description​

ShipStation is an e-commerce shipping solution that streamlines the order fulfillment process. This component allows you to list, create, update, and delete orders and shipments in your ShipStation account.

Documentation for the Axios client used in this component is available at 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.

See our Looping Over Orders quickstart for details on how to create a loop over an array of orders.

Connections​

ShipStation API Key​

Prerequisites Before setting up a ShipStation connection, ensure you have:

ShipStation API Key ShipStation API Secret To acquire these, navigate to your ShipStation account dashboard and generate a new API Key and API Secret pair.

Setting up a ShipStation Connection in Your Application To interface with ShipStation, an API Key and API Secret are required for authentication.

Assign the User with Correct Permissions Make sure the API key you are using has the correct permissions to interact with the ShipStation API.

Generating API Credentials Go to your ShipStation account settings. Navigate to the 'API Settings' section. Generate or note down your API Key and API Secret. Adding API Credentials to Connection Once you have the API Key and API Secret, add these to your application’s ShipStation connection settings.

This will enable authenticated requests to ShipStation.

InputNotesExample
API Key

Get your API Key from your ShipStation account settings.

API Secret

Get your API Secret from your ShipStation account settings.

Triggers​

Webhook​

Receive and validate webhook requests from ShipStation for webhooks you configure. | key: shipStationWebhookTrigger

Data Sources​

Select Carriers​

List and select from all of the carriers connected to this ShipStation account. | key: selectCarriers | type: picklist

InputNotesExample
Connection

Select Customers​

List and select from all of the customers based on specified criteria in this ShipStation account. | key: selectCustomers | type: picklist

InputNotesExample
Connection
Country Code

Returns customers that reside in the specified countryCode. Use the two-letter ISO Origin Country code.

Marketplace ID

Returns customers that purchased items from the specified marketplaceId.

Page

Page number.

Page Size

Requested page size. Max value is 500.

Sort By

Sorts the order of the response based off the specified value.

Sort Direction

Sets the direction of the sort order.

State Code

Returns customers that reside in the specified stateCode.

Tag ID

Returns customers that have been tagged with the specified tagId.

Select Packages​

List and select from all of the packages provided by the specified carrier in this ShipStation account. | key: selectPackages | type: picklist

InputNotesExample
Carrier Code

The carrier's code

Connection

Select Services​

List and select from all of the services provided by the specified carrier in this ShipStation account. | key: selectServices | type: picklist

InputNotesExample
Carrier Code

The carrier's code

Connection

Select Stores​

List and select from all of the installed stores in this ShipStation account. | key: selectStores | type: picklist

InputNotesExample
Connection
Marketplace ID

Returns customers that purchased items from the specified marketplaceId.

Show Inactive

Determines whether inactive stores will be returned in the list of stores.

false

Select Users​

List and select from all of the users in this ShipStation account. | key: selectUsers | type: picklist

InputNotesExample
Connection
Show Inactive Users

Determines whether inactive users will be returned in the list of users.

false

Actions​

Create Label for Order​

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

InputNotesExample
Fields

A list of additional fields to include in the label for order.

weight: {value: 2, units: 'pounds'}
Carrier Code

The code for the carrier that is to appear on the label.

Confirmation

The type of delivery confirmation that is to be used once the shipment is created.

none, delivery, signature, adult_signature, direct_signature
Connection
Order ID

The system generated identifier for the Order.

Service Code

The code for the shipping service that is to appear on the label.

Ship Date

The date the order should be shipped.

2014-04-03
Test Label

Specifies whether or not to create a test label.

false

Create or Update Multiple Orders​

Create or update multiple orders in one request. | key: createOrUpdateMultipleOrders

InputNotesExample
Connection
Orders Array

Provide an array of order objects to create or update multiple orders.

Create or Update Order​

Create a new order or update an existing one. | key: createOrUpdateOrder

InputNotesExample
Field

A list of additional fields to include in the order.

paymentMethod: Credit Card
Billing Address

Provide the billing address in JSON format.

Connection
Debug Request

Enabling this flag will log out the current request.

false
Order Date

The date the order was placed.

2023-09-08T12:34:56.000Z
Order Key

If the orderKey is provided, the createorder method will either: create a new order if the provided orderKey is not found, or, update the existing order if the orderKey is found.

0f6bec18-3e89-4881-83aa-f392d84f4c74
Order Number

User-defined order number to identify the order.

TEST-ORDER-API-DOCS
Order Status

Filter orders by status.

awaiting_payment, awaiting_shipment, shipped, etc.
Shipping Address

Provide the shipping address in JSON format.

{
  "data": {
    "orderId": 140335319,
    "orderNumber": "TEST-ORDER-API-DOCS",
    "orderKey": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
    "orderDate": "2015-06-29T08:46:27.0000000",
    "createDate": "2016-02-16T15:16:53.7070000",
    "modifyDate": "2016-02-16T15:16:53.7070000",
    "paymentDate": "2015-06-29T08:46:27.0000000",
    "shipByDate": "2015-07-05T00:00:00.0000000",
    "orderStatus": "awaiting_shipment",
    "customerId": null,
    "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": 192210956,
        "lineItemKey": "vd08-MSLbtx",
        "sku": "ABC123",
        "name": "Test item #1",
        "imageUrl": null,
        "weight": {
          "value": 24,
          "units": "ounces"
        },
        "quantity": 2,
        "unitPrice": 99.99,
        "taxAmount": 2.5,
        "shippingAmount": 5,
        "warehouseLocation": "Aisle 1, Bin 7",
        "options": [
          {
            "name": "Size",
            "value": "Large"
          }
        ],
        "productId": null,
        "fulfillmentSku": null,
        "adjustment": false,
        "upc": "32-65-98",
        "createDate": "2016-02-16T15:16:53.707",
        "modifyDate": "2016-02-16T15:16:53.707"
      },
      {
        "orderItemId": 192210957,
        "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": "SKU-Discount",
        "adjustment": true,
        "upc": null,
        "createDate": "2016-02-16T15:16:53.707",
        "modifyDate": "2016-02-16T15:16:53.707"
      }
    ],
    "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_2day",
    "packageCode": "package",
    "confirmation": "delivery",
    "shipDate": "2015-07-02",
    "holdUntilDate": null,
    "weight": {
      "value": 25,
      "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": 9876,
      "nonMachinable": false,
      "saturdayDelivery": false,
      "containsAlcohol": false,
      "mergedOrSplit": false,
      "mergedIds": [],
      "parentId": null,
      "storeId": 12345,
      "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
Field

A list of additional fields to include in the shipment.

testLabel: false
Carrier Code

The carrier's code

Connection
Package Code

Identifies the packing type that should be used for this label.

Service Code

Identifies the shipping service to be used for this label.

Ship Date

The date the shipment will be shipped.

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.

Create Warehouse​

Adds a Ship From Location (formerly known as warehouse) to your account. | key: createWarehouse

InputNotesExample
Connection
Is Default Warehouse

Specifies whether or not this will be your 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

Name of Ship From Location.

Deactivate Store​

Deactivates the specified store. | key: deactivateStore

InputNotesExample
Connection
Store ID

Unique identifier for the store to retrieve.

Delete Instanced Webhooks​

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

InputNotesExample
Connection

Delete Order​

Soft delete an order from the database, setting it to inactive. | key: deleteOrder

InputNotesExample
Connection
Order ID

The system generated identifier for the Order.

Delete Warehouse​

Removes a warehouse (or Ship From location) from ShipStation's UI. Sets it to Inactive status. | key: deleteWarehouse

InputNotesExample
Connection
Warehouse ID

Unique identifier for the warehouse to retrieve.

Get Customer​

Retrieve a specific customer by their system generated identifier | key: getCustomer

InputNotesExample
Connection
Customer ID

System generated identifier for the Customer.

Get Order​

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

InputNotesExample
Connection
Order ID

The system generated identifier for the Order.

Get Product​

Retrieve a specific product from the database by its ID. | key: getProduct

InputNotesExample
Connection
Product ID

The system generated identifier for the Product.

Get Store​

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

InputNotesExample
Connection
Store ID

Unique identifier for the store to retrieve.

Get Warehouse​

Retrieve detailed information about a specific Ship From Location (formerly known as warehouse). | key: getWarehouse

InputNotesExample
Connection
Warehouse ID

Unique identifier for the warehouse to retrieve.

List Carriers​

List all shipping providers connected to this ShipStation account. | key: listCarriers

InputNotesExample
Connection

List Customers​

Retrieve a list of customers based on specified criteria | key: listCustomers

InputNotesExample
Connection
Country Code

Returns customers that reside in the specified countryCode. Use the two-letter ISO Origin Country code.

Marketplace ID

Returns customers that purchased items from the specified marketplaceId.

Page

Page number.

Page Size

Requested page size. Max value is 500.

Sort By

Sorts the order of the response based off the specified value.

Sort Direction

Sets the direction of the sort order.

State Code

Returns customers that reside in the specified stateCode.

Tag ID

Returns customers that have been tagged with the specified tagId.

List Fulfillments​

Retrieve a list of fulfillments based on specified criteria | key: listFulfillments

InputNotesExample
Connection
Fulfillment ID

Provide the Fulfillment ID as a string. It will be converted to a number internally.

Order ID

Provide the Order ID as a string. It will be converted to a number internally.

18324102
Page

Page number.

1
Page Size

Requested page size. Max value is 500.

1

List Orders​

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

InputNotesExample
Connection
Customer Name

Filter orders by customer name.

test
Order Status

Filter orders by status.

awaiting_payment, awaiting_shipment, shipped, etc.
Page

Page number.

1
Page Size

Requested page size. Max value is 500.

1

List Packages​

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

InputNotesExample
Carrier Code

The carrier's code

Connection

List Products​

Obtains a list of products that match the specified criteria. | key: listProducts

InputNotesExample
Connection
End Date

Returns products that were created before the specified date.

2014-05-04
Page

Page number.

Page Size

Requested page size. Max value is 500.

Product Category ID

Returns products that match the specified productCategoryId.

Product Name

Returns products that match the specified product name.

Product Type ID

Returns products that match the specified productTypeId.

Show Inactive

Determines whether inactive stores will be returned in the list of stores.

false
SKU

Returns products that match the specified SKU.

Sort By

Sorts the order of the response based off the specified value.

Sort Direction

Sets the direction of the sort order.

Start Date

Returns products that were created after the specified date.

2014-04-03
Tag ID

Returns customers that have been tagged with the specified tagId.

List Services​

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

InputNotesExample
Carrier Code

The carrier's code

Connection

List Shipments​

Obtains a list of shipments that match the specified criteria. | key: listShipments

InputNotesExample
Connection
Create Date End

Returns shipments created on or before the specified date.

2014-05-04
Create Date Start

Returns shipments created on or after the specified date.

2014-04-03
Page

Page number.

Page Size

Requested page size. Max value is 500.

Recipient Country Code

Returns shipments shipped to the specified country code. Please use the two-letter ISO Origin Country code.

Recipient Name

Returns shipments shipped to the specified recipient name.

Ship Date End

Returns shipments with the ship date on or before the specified date.

2014-04-03
Ship Date Start

Returns shipments with the ship date on or after the specified date.

2014-04-03
Tracking Number

Returns shipments with the specified tracking number.

List Stores​

Retrieve the list of installed stores on the account. | key: listStores

InputNotesExample
Connection
Marketplace ID

Returns stores of this marketplace type. Provide as a string and it will be converted to a number internally.

Show Inactive

Determines whether inactive stores will be returned in the list of stores.

false

List Users​

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

InputNotesExample
Connection
Show Inactive Users

Determines whether inactive users will be returned in the list of users.

false

List Warehouses​

Retrieves a list of your Ship From Locations (formerly known as warehouses). | key: listWarehouses

InputNotesExample
Connection

List Webhooks​

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

InputNotesExample
Connection

Raw Request​

Send raw HTTP request to ShipStation | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

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

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.

false
Retry Delay (ms)

The delay in milliseconds between retries.

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.

false

Subscribe to Webhook​

Subscribes to a specific type of webhook in ShipStation. | key: subscribeToWebhook

InputNotesExample
Connection
Event

The type of webhook to subscribe to.

Friendly Name

Display name for the webhook.

Store ID

If passed in, the webhooks will only be triggered for this store_id.

Target URL

The URL to send the webhooks to.

Unsubscribe to Webhook​

Unsubscribes from a specific type of webhook in ShipStation. | key: unsubscribeToWebhook

InputNotesExample
Connection
Webhook ID

A unique ID generated by ShipStation and assigned to each webhook.

Update Product​

Updates an existing product. | key: updateProduct

InputNotesExample
Connection
Product Data

The complete data for updating the product. This call does not support partial updates.

Product ID

The system generated identifier for the Product.

Update Store​

Updates an existing store. | key: updateStore

InputNotesExample
Connection
Store ID

Unique identifier for the store to retrieve.

Store Update Data

All the data needed to update an existing store. Must provide the entire resource.

Update Warehouse​

Updates an existing Ship From Location (formerly known as warehouse). | key: updateWarehouse

InputNotesExample
Connection
Warehouse Update Data

All the data needed to update an existing Ship From Location. Must provide the entire resource.