Skip to content

Store adapter — ShipStation

The adapter object contains properties for connecting to the ShipStation API.

Parent object: a store with property "platform" : "ship_station"

Required properties

The following adapter properties are required for ShipStation stores.

api_key

Propertyapi_key
NameShipStation API Key
DescriptionFound in ShipStation Dashboard > 🔧 Account Settings > Account > API Settings
Data typestring
Required?Yes

api_secret

Propertyapi_secret
NameAPI Secret
DescriptionFound in ShipStation API Settings
Data typestring
Required?Yes

Optional properties

The following adapter properties are optional for ShipStation stores.

acknowledgement_tag_id

Propertyacknowledgement_tag_id
NameAcknowledgement Tag ID
DescriptionTag ID applied to order after imported
Data typestring

force_sku

Propertyforce_sku
NameSKU Configuration
DescriptionShipStation may provide either or both of two SKU fields, sku and fulfillmentSku. This setting controls which field the SKU is pulled from.
Data typestring
Accepted values
  • "Auto" — Use whichever field is present. If both are present, use sku
  • "fulfillmentSku" — always use the Fulfillment Sku
  • "sku" — always use the Product Sku
Default"Auto"

notify_customer

Propertynotify_customer
NameNotify Customer
DescriptionIf true, notify of shipment from ShipStation
Data typeboolean
Defaultfalse

notify_sales_channel

Propertynotify_sales_channel
NameNotify Sales Channel
DescriptionIf true, notify of shipment from sales channel
Data typeboolean
Defaulttrue

tag_ids

Propertytag_ids
NameTag IDs
DescriptionIf specified, only orders with the specified tags are imported
Data typearray of strings
Example[ "mytag1", "mytag2" ]

use_requested_shipping_service

Propertyuse_requested_shipping_service
NameUse Requested Shipping Description
DescriptionShipStation orders contain two shipping descriptions: the original description from the shopping cart request, and the ShipStation-translated shipping description. If this value is set to true, the original request shipping description is used.
Data typeboolean
Defaultfalse

Example

Example: create a new ShipStation store
curl -X POST \
    -H "Authorization: Bearer $JWT_TOKEN" \
    -H "Content-Type: application/json" \
    https://api.getdropstream.com/stores \
    -d @- <<EOF
{ "customer_id": "3775",
  "name": "Your ShipStation Store",
  "platform": "ship_station",
  "adapter": {
    "api_key": "abc123",
    "api_secret": "abc123",
    "acknowledgement_tag_id": "yourtag_1",
    "force_sku": "fulfillmentSku",
    "notify_customer": false,
    "notify_sales_channel": "true",
    "tag_ids": [ "yourtag_2", "yourtag_3" ],
    "use_requested_shipping_service": "false"
  }
}
EOF

For details about this request type, see: Create a new store.