ShipStation - Enable API Access

The Application Programming Interface (API) allows for automated communication between connected systems. In order to automate fulfillment, API access must be enabled.

If you have not yet gathered your API credentials, follow these steps first:

Gather API credentials from ShipStation.

Enter API credentials in DropStream

  1. In your DropStream Dashboard, click Stores.

In the DropStream Dashboard, click Store.

  1. Click the name of your ShipStation store.
  2. In Connection details, enter your API credentials:
  • API Key
  • API Secret

ShipStation connection details

  1. Optional: Edit any of the following settings:
  1. Partner Key — Optional Partner API Key provided by ShipStation support. If specified, the ShipStation API rate limit is increased.
  2. Use Original Request Shipping Description — ShipStation orders contain two shipping descriptions: the original description from the shopping cart request (e.g., from Shopify, Magento, etc.), and the ShipStation-translated shipping description. If this setting is enabled, the original request shipping description is used. Default: disabled (use the ShipStation description).
  3. Notify Customer — If enabled, send an email from ShipStation to the customer with shipment notification after it is posted to ShipStation. Default: disabled.
  4. Notify Sales Channel — If enabled, send an email from the DropStream sales channel to the customer, notifying them that the shipping info has been uploaded to ShipStation. Default: enabled.
  5. Order Tags — If specified, only orders with these tags are imported to DropStream.
  6. Order Acknowledgement Tag — If specified, this tag is applied to an order after it is imported. (Tags are listed after the connection is authorized.)
  7. Exclude Empty Orders — If enabled, orders will not be imported if they have no line items. Default: disabled.

Important: Ensure that the Acknowledgement Tag is not also set as an Order Import Tag.

  1. SKU Configuration — ShipStation may provide either a Product Sku, a Fulfillment Sku, or both. This setting controls which field the SKU is pulled from:
  • Auto(the default) Use whichever field is present. If both are present, use Product Sku
  • Product Sku — always use the Product Sku
  • Fulfillment Sku — always use the Fulfillment Sku
  1. Import Settings: Accept Orders After — Only import orders created after this date. Default value: 5 days before the connection is created. Corresponds to ShipStation order createDate.

ShipStation cart options

  1. Click Save changes.

Save-changes.png


Back to: Integration Overview

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.