Skip to main content

ShipStation Component

ShipStation

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.

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

Select Customers​

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

Select Packages​

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

Select Services​

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

Select Stores​

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

Select Users​

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

Actions​

Create Label for Order​

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

Create or Update Multiple Orders​

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

Create or Update Order​

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

Output Example Payload​

{
  "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

Create Warehouse​

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

Deactivate Store​

Deactivates the specified store. | key: deactivateStore

Delete Instanced Webhooks​

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

Delete Order​

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

Delete Warehouse​

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

Get Customer​

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

Get Order​

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

Get Product​

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

Get Store​

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

Get Warehouse​

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

List Carriers​

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

List Customers​

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

List Fulfillments​

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

List Orders​

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

List Packages​

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

List Products​

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

List Services​

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

List Shipments​

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

List Stores​

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

List Users​

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

List Warehouses​

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

List Webhooks​

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

Raw Request​

Send raw HTTP request to ShipStation | key: rawRequest

Subscribe to Webhook​

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

Unsubscribe to Webhook​

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

Update Product​

Updates an existing product. | key: updateProduct

Update Store​

Updates an existing store. | key: updateStore

Update Warehouse​

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