Skip to main content

Topics

A topic names a moment as <subject>/<moment>, both parts in kebab-case. The subject is the GraphQL type of the records the notification is about. The moment is some specific event happening to the subject, such as an order being shipped. Topics are always bound to a specific business event, there are no topics for generic entity updates.

These are the topics you can subscribe to in API version 2026-06-unstable:

TopicFires when
fulfillment-order/cancelled
Required scopefulfillment_orders:read
A fulfillment order is cancelled.
fulfillment-order/fulfilled
Required scopefulfillment_orders:read
The last open quantity of a fulfillment order is fulfilled. The same shipment also fires order/partially-shipped or order/completely-shipped, see Order or fulfillment order topics.
fulfillment-order/hold-released
Required scopefulfillment_orders:read
The hold on a fulfillment order is released, so it can be fulfilled again.
fulfillment-order/partially-fulfilled
Required scopefulfillment_orders:read
Fires for each fulfillment that leaves quantities of the fulfillment order open. The same shipment also fires order/partially-shipped, see Order or fulfillment order topics.
fulfillment-order/picking-started
Required scopefulfillment_orders:read
Picking of the fulfillment order starts in the Pickware WMS app, once for every fulfillment order picked together in the same picking process. Pausing, resuming or taking over the picking does not fire again.
fulfillment-order/placed-on-hold
Required scopefulfillment_orders:read
A fulfillment order is put on hold, in Pickware or in Shopify.
goods-receipt/approved
Required scopegoods_receipts:read
A goods receipt is approved and its quantities are booked into the goods receipt stock location.
goods-receipt/captured
Required scopegoods_receipts:read
A goods receipt is captured, i.e. it reaches the state created. Drafts do not fire.
goods-receipt/completed
Required scopegoods_receipts:read
A goods receipt is completed and its quantities are booked into stock.
goods-receipt/in-progress
Required scopegoods_receipts:read
Stocking of a goods receipt starts. A goods receipt can also be completed without passing this state.
order/completely-shipped
SubjectOrder
Required scopeorders:read
A shipment closes the last open quantity of the order. The same shipment also fires fulfillment-order/fulfilled, see Order or fulfillment order topics.
order/partially-shipped
SubjectOrder
Required scopeorders:read
A shipment leaves quantities of the order open. The same shipment also fires fulfillment-order/partially-fulfilled or fulfillment-order/fulfilled, see Order or fulfillment order topics.
product/back-in-available-stock
SubjectProduct
Required scopeproducts:read
The available stock of a product — what customers can buy — rises from zero or below to positive. Stock that arrives while open orders still claim all of it does not fire, only product/back-in-stock does. A product that runs out and is restocked again fires again.
product/back-in-stock
SubjectProduct
Required scopeproducts:read
The physical stock of a product — the units actually counted in the warehouses — rises from zero to positive, including when a product receives its first stock. A product that runs out and is restocked again fires again. Stock that customers can buy again is product/back-in-available-stock instead.
product/out-of-available-stock
SubjectProduct
Required scopeproducts:read
The available stock of a product — what customers can still buy — drops from positive to zero or below. A product whose warehouses are empty fires product/out-of-stock as well. A product that is restocked and runs out again fires again.
product/out-of-stock
SubjectProduct
Required scopeproducts:read
The physical stock of a product — the units actually counted in the warehouses — drops from positive to zero. A product that is restocked and runs out again fires again. Stock that is still in the warehouse but no longer sellable is product/out-of-available-stock instead.
return-order/announced
Required scopereturn_orders:read
A requested return order is approved and the shop now expects the goods.
return-order/cancelled
Required scopereturn_orders:read
A return order is cancelled, regardless of its previous state.
return-order/completed
Required scopereturn_orders:read
A return order is completed. A return order is always completed as a whole. A completed return order that is reopened and completed again fires again.
return-order/declined
Required scopereturn_orders:read
A requested return order is declined. Only requested return orders can be declined.
return-order/partially-received
Required scopereturn_orders:read
A return order reaches the state partially received because some, but not all, of the announced goods have arrived. A return order that is reopened from completed does not fire.
return-order/received
Required scopereturn_orders:read
A return order reaches the state received because all announced goods have arrived, whether with one goods receipt or with the last of several. A return order that is reopened from completed does not fire.
return-order/requested
Required scopereturn_orders:read
A return order is requested. A return order that is created already approved fires return-order/requested and then return-order/announced.
supplier-order/cancelled
Required scopesupplier_orders:read
A supplier order is cancelled.
supplier-order/completed
Required scopesupplier_orders:read
A supplier order is completed. Open quantities are cancelled at that point.
supplier-order/confirmed
Required scopesupplier_orders:read
A supplier order reaches the state confirmed.
supplier-order/created
Required scopesupplier_orders:read
A supplier order is created.
supplier-order/delivered
Required scopesupplier_orders:read
A supplier order reaches the state delivered.
supplier-order/expected-delivery-date-changed
Required scopesupplier_orders:read
The expected delivery date of a supplier order or of one of its line items changes, including when it is set automatically on confirmation.
supplier-order/line-items-changed
Required scopesupplier_orders:read
The ordered content of a supplier order changes: a line item is added or removed, or the ordered quantity or price of a line item changes.
supplier-order/partially-delivered
Required scopesupplier_orders:read
A supplier order reaches the state partially delivered.
supplier-order/sent-to-supplier
Required scopesupplier_orders:read
A supplier order reaches the state sent to supplier.

The reference page of every subject type lists the topics it can be the subject of. Creating a subscription with an unknown topic fails with a BAD_REQUEST error that lists the reason.

Order or fulfillment order topics​

An order and its fulfillment orders both have topics about shipping. Subscribe on the level your purpose belongs to:

  • The order for everything that concerns the customer, such as a shipping notification or an invoice: order/partially-shipped and order/completely-shipped.
  • The fulfillment order for everything that happens per location, such as handing work to a logistics provider or a process of one location: fulfillment-order/partially-fulfilled and fulfillment-order/fulfilled.

One shipment fires on both levels. Take an order that two locations fulfill: the first location ships everything it holds, which fires fulfillment-order/fulfilled for its fulfillment order and order/partially-shipped for the order. When the second location ships afterwards, that fires fulfillment-order/fulfilled for the second fulfillment order and order/completely-shipped for the order.

The order in which the notifications of the two levels arrive is not guaranteed. Subscribe to one level per purpose, so you never have to decide which of two notifications about the same shipment came first.