Shipments
Shipments Webhook Events Model
event enum value under the Data Schema tabData Schema
Example
Shipments Webhook Events Model
This webhook schema defines shipment event properties, including event name, merchant ID, creation timestamp, shipment data (order and shipment ID, type, courier, tracking, payment, and status), and other details. The webhook provides shipment-specific details to update the receiver's systems.
event
enum<string>
optional
Allowed values:
shipment.creatingshipment.createdshipment.updatedshipment.cancelled
merchant
number
optional
created_at
string
optional
data
object
optional
id
number
optional
Example:
987654321
order_id
integer
optional
Example:
123456789
order_reference_id
number | null
optional
created_at
object
optional
type
enum<string>
optional
Allowed values:
returnshipment
Example:
shipment
courier_id
integer
optional
Example:
1723506348
courier_name
string
optional
Example:
Semsa
courier_logo
string
optional
Example:
https://semsa.com/assets/logo.png
shipping_number
string
optional
Example:
192837465
tracking_number
string
optional
Example:
918273645
pickup_id
null
optional
Example:
10954392
trackable
boolean
optional
Example:
true
tracking_link
string
optional
Example:
https://semsa.com/tracking/order_url.com
label
object
optional
payment_method
enum<string>
optional
Allowed values:
codpre_paid
Example:
cod
source
string
optional
Example:
dashboard
status
enum<string>
optional
Allowed values:
createdin_progressdeliveringdeliveredshippedcancelled
Example:
in_progress
total
object
optional
cash_on_delivery
object
optional
is_international
boolean
optional
Example:
true
total_weight
object
optional
packages
array [object {8}]
optional
ship_from
object
optional
ship_to
object
optional
meta
object
optional
billing_account
enum<string>
optional
Allowed values:
sallamerchant
Modified at 2025-03-04 12:54:02