Commerce ShipStation

This module integrates Drupal Commerce with ShipStation to simplify order fulfillment. The integration currently uses ShipStation's Custom Store service to export orders from Drupal Commerce to ShipStation and to receive updates from ShipStation when orders are fulfilled.

The module provides a number of configuration options, allowing you to choose which order status in Drupal Commerce should be used for exporting orders and what field should be used for pushing order comments to ShipStation. It also includes configuration options for billing / shipping phone numbers and product images, and it lets you choose which shipping methods are made available to ShipStation.

Requirements

In order to use this module, you must have a ShipStation account. You must also be using Commerce Shipping.

Installation

Add the module to your site via Composer and install it using your chosen method. This will ensure all prerequisites are fetched and installed. (Refer to the Drupal user guide if you are unsure.)

Need help using or extending this module?

Hire the Drupal Commerce maintainers:

Centarro offers Drupal Commerce Support and Development services, including consulting, module development, and systems integration.

Community support options:

Over 2,000 developers participate in our two support channels on a best-effort basis, Drupal Answers and Drupal Slack (channel: #commerce).

Configuration

You can configure the module settings at Commerce > Configuration > Shipping > ShipStation (or by navigating directly to admin/commerce/config/shipstation).

Configuration Overview

1. First configure the ShipStation connection settings in Drupal. You will use what you configure here to create your custom store in ShipStation later on.
   1. Create a username and password that is different from your ShipStation login, saving these for the next step.
   2. Configure the other settings to meet your business requirements.
2. Login to your ShipStation account and add a "Custom Store" selling channel.
   1. The URL you will need to enter is https://[your.domain.name]/shipstation/api-endpoint.
   2. Use the username and password you created in the previous step.
   3. Make sure to set ShipStation's status codes to match the order workflow used by Drupal. It is recommended that you use "Fulfillment, with validation" and set the states as:
      • Awaiting Payment Status: validation
      • Awaiting Shipment Status: fulfillment
      • Shipped Status: complete
      • Cancelled Status: canceled (note the spelling difference)
      • On-Hold Status: null
   4. If using a custom order workflow, make sure that there is a fulfill transition. This is the transition ShipStation will call after an order is shipped.
   5. Click "Connect" and Custom Store should connect to your Drupal Commerce install.
3. That's it! ShipStation will automatically make export requests to the Drupal Commerce endpoint provided by the integration and import orders. It will also mark orders / shipments complete and save a tracking number on the shipment.

Roadmap

ShipStation is part of the Auctane portfolio. Auctane recently released a new integration method that will allow for one connection to communicate with multiple other products in their portfolio. The 3.0 version of this project is planned to make use of the new integration method.