README

ShipStation Custom Store provider for the Foster Commerce Shipments plugin.

This package does not add its own Control Panel settings page. Install it, then create or edit a Shipments integration and choose ShipStation as the provider.

Configuration

In Craft CP, go to Shipments -> Settings -> Integrations, create a ShipStation integration, and configure the provider settings there.

The provider settings screen shows:

• ShipStation endpoint URL for exports and ship notifications.
• Basic-auth username/password for ShipStation Custom Store access.
• Shipment export page size.
• Optional shipment ID prefix.
• Optional product image and address phone field handles.
• The hardcoded Shipments fulfillment/shipping statuses used for ShipStation status setup.

ShipStation URLs

Use the Shipments integration handle in the endpoint URL:

https://my-store.com/actions/shipments/gateway/handle?integration={integrationHandle}

Statuses

The provider exports the shipment fulfillment status as ShipStation’s OrderStatus by default. Configure ShipStation Custom Store buckets with the values shown in the provider settings screen.

If ShipStation needs different external values, use the Shipments integration status mappings page. Outbound fulfillment mappings control exported OrderStatus values. Inbound mappings can translate ShipStation notification status codes back to Shipments fulfillment and shipping statuses.

Shipment Data

Each ShipStation XML Order represents one Shipments shipment, not one Commerce order.

• OrderID and OrderNumber use the shipment reference, plus the optional configured prefix.
• Item rows come from the shipment’s allocated line items.
• Customer/address data still comes from the related Commerce order.
• ShipStation ship notifications update the shipment’s carrier, service, tracking number, fulfillment status, and shipping status.