Configuration
Every setting on ShipStation Connect -> Settings. The Settings -> Plugins -> ShipStation Connect entry redirects to the same page.
| Setting | Property | Default | Notes |
|---|---|---|---|
| Select ShipStation Store field | storesFieldHandle |
None | A Dropdown field on the order that says which ShipStation store the order belongs to. With none set, every order goes to one store. See multiple ShipStation stores. |
| Username | shipstationUsername |
None | The username ShipStation authenticates with. Not a Craft user, and not your ShipStation login. Accepts an environment variable. |
| Password | shipstationPassword |
None | The matching password. Accepts an environment variable. |
| Page Size for Orders | ordersPageSize |
25 |
How many orders ShipStation gets per request. Raise it and each request takes longer but there are fewer of them; lower it if requests are timing out. |
| Order ID Prefix | orderIdPrefix |
Empty | Prepended to the Commerce order ID in the OrderID field. Set it when one ShipStation account takes orders from more than one Craft site, so the IDs stay unique. |
| Fail export on validation failure | failOnValidation |
Off | Returns an error to ShipStation when any order in the page is invalid, instead of leaving that order out and sending the rest. See why an order is missing. |
| Product Images Field Handle | productImagesHandle |
None | The Assets field to take each item’s photo from, read off the variant and falling back to the product. With none set, items go out without photos. |
| Billing address same as shipping address | billingSameAsShipping |
Off | Sends the shipping address as the billing address on orders that have no billing address. With it off, an order with no billing address is left out of the export. |
| Phone number field handle | phoneNumberFieldHandle |
Empty | The custom field on the address element that holds the phone number. Craft addresses have no native phone field, so without this ShipStation gets no phone number. See phone numbers. |
| Status Handle | shippedStatusHandle |
shipped |
The order status an order moves to when ShipStation reports it shipped. |
| Matrix Field Handle | matrixFieldHandle |
shippingInfo |
The Matrix field that holds the shipping info. See create the shipping info field. |
| Entry Type Handle | entryTypeHandle |
shippingInfo |
The entry type inside that field. |
| Carrier Field Handle | carrierFieldHandle |
carrier |
The carrier field inside the entry type. |
| Service Field Handle | serviceFieldHandle |
service |
The service field inside the entry type. |
| Tracking Number Field Handle | trackingNumberFieldHandle |
trackingNumber |
The tracking number field inside the entry type. |
Setting values per environment#
Any setting can be set in config/shipstationconnect.php, keyed by property name. A value in the file wins over the one saved on the settings page, and the page keeps showing the saved value.
<?php
return [
'shipstationUsername' => '$SHIPSTATION_USERNAME',
'shipstationPassword' => '$SHIPSTATION_PASSWORD',
'ordersPageSize' => 50,
'productImagesHandle' => 'productImages',
'phoneNumberFieldHandle' => 'phoneNumber',
];