Shipments

Below are the webhook store events paired with their respective data schema related to the Shipments webhook events:

Shipments Webhook Events Model

The following includes 4 shipments webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab

Data 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

Event Name

Allowed values:

shipment.creatingshipment.createdshipment.updatedshipment.cancelled

merchant

number

optional

Merchant ID who installed the application on their store. Get details on the Merchant via the ID using the endpoint here

created_at

string

optional

Webhook Created At Date Timestamp

data

object

optional

number

optional

This field refers to a unique identifier for the shipment.

Example:

987654321

order_id

integer

optional

This field refers to the unique identifier for the order associated with the shipment.

Example:

123456789

order_reference_id

number | null

optional

This field refers to a reference ID that can be used to look up additional information about the order

created_at

object

optional

type

enum<string>

optional

Shipment Type

Allowed values:

returnshipment

Example:

shipment

courier_id

integer

optional

Shipment Courier ID. Find a complete list of Shipment companies here

Example:

1723506348

courier_name

string

optional

Shipment Courier Name

Example:

Semsa

courier_logo

string

optional

Shipment Courier Logo

Example:

https://semsa.com/assets/logo.png

shipping_number

string

optional

Shipment Shipping Number

Example:

192837465

tracking_number

string

optional

Shipment Tracking Number

Example:

918273645

pickup_id

null

optional

Shipment Pickup ID

Example:

10954392

trackable

boolean

optional

Whether or not the shipment is trackable

Example:

true

tracking_link

string

optional

Shipment Tracking Link

Example:

https://semsa.com/tracking/order_url.com

label

object

optional

payment_method

enum<string>

optional

Shipment Payment Method

Allowed values:

codpre_paid

Example:

cod

source

string

optional

Shipment Source

Example:

dashboard

status

enum<string>

optional

Shipment Status

Allowed values:

createdin_progressdeliveringdeliveredshippedcancelled

Example:

in_progress

total

object

optional

cash_on_delivery

object

optional

is_international

boolean

optional

Whether the shipment is shipped internationally

Example:

true

total_weight

object

optional

packages

array [object {8}]

optional

ship_from

object

optional

ship_to

object

optional

Shipments Webhook Events Model#

Shipments Webhook Events Model