Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Recurring Payments API
  • App Functions
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipments & Fulfillment APIs
  • Recurring Payments API
  • App Functions
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Merchants Events
  • Welcome 👋
  • What are App Functions?
  • Get Started
  • Supported Events
  • Testing
  • Responses
  • NodeJs Support
  • Merchants Events
    • Brand Events
    • Cart Events
    • Category Events
    • Communication Events
    • Customer Events
    • Invoice Events
    • Review Events
    • Shipment Events
    • Shipping Company Events
    • Shipping Zone Events
    • Special Offer Events
    • Store Branch Events
  • Customers Events
    • Account Events
    • Cart & Checkout Events
    • Product Events
    • Promotion & Coupon Events
    • Wishlist Events
  1. Merchants Events

Shipment Events

This model defines the structure for events triggered during the shipment lifecycle.

Available Events#

shipment.creating - Synchronous Action - Triggered before a shipment is created (can modify shipment data)
shipment.created - Triggered when a shipment is created
shipment.cancelled - Triggered when a shipment is cancelled
shipment.updated - Triggered when shipment details are updated

Event Type#

Mixed Types:
shipment.creating is Synchronous - Executes immediately and can return data
Other events are Asynchronous - Processed in the background

Common Use Cases#

Calculate custom shipping rates
Generate shipping labels
Send tracking notifications
Update fulfillment systems
Validate shipping addresses

Shipment Context Object#

Schema
Example
Shipments Events Model

Example Implementations#

Generate Shipping Label#

Testing#

1
Install your app
Install your app on a demo store
2
Create shipment
Create a shipment for an order
3
Test in preview
Use the shipment ID in the App Function preview panel
Modified at 2025-11-17 10:20:55
Previous
Review Events
Next
Shipping Company Events