Skip to main content

Prerequisites

The connector should already be set up, with a Connector Profile and a Linked Account. See Getting Started on the ShipStation connector page.

How ShipStation webhooks are set up

StackOne creates and manages the ShipStation webhook subscriptions automatically when the account is connected, and removes them when it is disconnected. There is nothing to configure in ShipStation and no URL to paste.

  • StackOne subscribes one ShipStation webhook per event you enable, because each ShipStation webhook covers a single event.
  • Webhooks cover every store on the account.
  • The API Key and API Secret used for the connection must belong to a plan with V1 API access (Standard plan or higher).

Available webhook events

The following ShipStation events can be enabled. Only events selected in StackOne are subscribed, and ShipStation does not send events that are not subscribed.

1

Order events

Events related to new orders created in or imported into ShipStation.

  • Order Notify (ORDER_NOTIFY) — Fired when new orders are created in or imported into ShipStation
  • Item Order Notify (ITEM_ORDER_NOTIFY) — Fired when new orders are created in or imported into ShipStation, with the batch resource including each order’s line items
2

Shipment events

Events related to shipped orders.

  • Ship Notify (SHIP_NOTIFY) — Fired when orders ship with a shipping label
  • Item Ship Notify (ITEM_SHIP_NOTIFY) — Fired when orders ship with a shipping label, with the batch resource including each shipment’s line items
3

Fulfillment events

Events related to orders shipped outside ShipStation labels, by marking them as shipped or through a fulfillment provider.

  • Fulfillment Shipped (FULFILLMENT_SHIPPED) — Fired when an order is marked as shipped without a ShipStation label, including orders shipped by a fulfillment provider
  • Fulfillment Rejected (FULFILLMENT_REJECTED) — Fired when a fulfillment provider rejects an order sent to it

Delivery format

ShipStation sends a notification, not the records themselves.

  • Each delivery contains only resource_url and resource_type, which holds the event code. The resource_url is a batch URL that returns the affected orders, shipments or fulfillments.
  • Request the resource_url with the same ShipStation API Key and API Secret to fetch the records. One notification can cover several records imported or shipped together.
  • ShipStation does not include a timestamp or a signature in the delivery.

Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.