⌘K
Webhook Topics
Webhook events and payloads
OrderStatusChange
object
Triggered when the status of an order changes.
Show child attributes
orderId
string
Unique identifier of the order.
shipments
array of objects
Shipment information of the order. Only provided if order status is
Shipped.Show child attributes
carrierCode
string
ShipStation code of the shipping carrier.
trackingNumber
string
Tracking number of the shipment.
trackingUrl
nullable string
Tracking URL of the shipment.
status
enum
New status of the order.
Possible enum values
PendingFulfillmentActionAwaitingPaymentReceivedInProductionShippedDeliveredCanceledShow more values
ProductSetUpdated
object
Triggerred when a product set is updated.
Show child attributes
productSetId
string
Unique identifier of the product set.
UploadStatusChange
object
Triggered when an upload fails or succeeds to upload.
Show child attributes
imageId
string
Unique identifier of the upload.
status
enum
New status of the upload.
Possible enum values
PendingThe image is currently uploading.
SuccessThe image was successfully uploaded.
FailThe image failed to upload.