Order

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

Orders Webhook Events Model

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

Deprecation Notice

The variables, items.codes and items.files, are deprecated. We recommend using instead the data.urls.digital_content variable.

Data Schema

Example

Orders Webhook Events Model

event

enum<string>

optional

Event Name

Allowed values:

order.createdorder.updatedorder.refundedorder.deletedorder.products.updatedorder.payment.updatedorder.coupon.updatedorder.total.price.updatedorder.shipping.address.updatedorder.cancelledorder.customer.updated

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

Timestamp of webhook creation

data

object

optional

number

required

A unique alphanumeric code or identifier assigned to a specific order. List of orders can be found here

cart_reference_id

number

required

A unique alphanumeric code or identifier assigned to a specific order cart.

reference_id

number

required

A specific alphanumeric identifier associated with an order.

urls

object

required

date

object (Date)

required

Date and Time of the order.

updated_at

object (Date)

required

source

enum<string>

required

The source of the order.

Allowed values:

storelandingforgotten_basketabandoned-cartcampaigndashboardbuy_as_giftmahly-appbuy_nowone-clickcomplete_order

draft

boolean

required

Whether or not the order 's status is set to draft

read

boolean

required

Whether or not the Merchant has read the order

source_device

string

required

The machine or device used when the customer placed the order.

source_details

object

required

Order source details.

status

object (NewOrderStatus)

required

Order status.

is_price_quote

boolean

required

The option to quote order price.

payment_method

string

required

The specific payment option or financial mechanism chosen and used by a customer to pay for a product or service as part of an order, encompassing various methods.

receipt_image

string

required

Order's image receipt

currency

string

required

The currency in which order costs and prices are expressed and processed, based on the customer's preferences or the business's operational currency.

amounts

object

required

Order amounts.

exchange_rate

object

required

The order exchange rate.

can_cancel

boolean

required

The option to enable order cancellation by the store customer.
True value should be set if the order status is in under review and in progress, as according to the store settings.

show_weight

boolean

required

Whether or not to show the weight value.

can_reorder

boolean

required

Whether or not to enable reorder .

is_pending_payment

boolean

required

The option of displaying order is pending payment to the customer when the order status is payment_pending.

pending_payment_ends_at

integer

required

Last date allowed to customer to pay the order.

total_weight

string

required

Total weight value

shipping

object

required

Order Shipping details.

shipments

array [object {22}]

required

Order shipment details.

pickup_branch

object (Branch)

required

Order pickup branch details.

shipment_branch

object (ShipmentBranch)

required

Order shipment branch details.

customer

object (Customer)

required

Customer details.

items

array [object {16}]

required

bank

object

required

Order Shipments Webhook Events Model

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

Data Schema

Example

Order Shipments Webhook Events Model

event

enum<string>

optional

Event Name

Allowed values:

order.shipment.creatingorder.shipment.createdorder.shipment.return.creatingorder.shipment.return.created

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

data

object

optional

number

optional

Order ID

reference_id

number

optional

Order refrence ID, that appears to customers in the store.

urls

object (Urls)

optional

To help companies and merchants, Salla provides a “urls” attribute that has been added to different modules to guide the merchants to have the full URL of this module from both scopes, the dashboard scope as a store admin, and as a customer.

date

object (Date)

optional

source

string

optional

The source of the order.

source_device

string

optional

The machine or device used when the customer placed the order.

source_details

object

optional

first_complete_at

string | null

optional

Gets the first date of changing the order status to completed.

status

object

optional

payment_method

string

optional

Order payment method

currency

string

optional

Order currency

amounts

object

optional

shipping

object

optional

shipments

array [object {24}]

optional

can_cancel

boolean

optional

Whether or not if the order is allowed to be cancelled by store customers.
True value should be set if the order status is in under review and in progress, as according to the store settings.

show_weight

boolean

optional

Whether or not to show weight value

can_reorder

boolean

optional

Whether or not the order allowed to be re-order by customers

is_pending_payment

boolean

optional

Waiting the customer to pay the order or the order status is payment_pending

pending_payment_ends_at

integer

optional

Last date allowed to customer to pay the order

total_weight

string

optional

Total weight value

rating_link

string | null

optional

Order Rating Link.
Note that the order has to be of either of the following statuses: completed, delivered, and shipped. The merchant has to allow the product to be rated from the Store Settings > Rating Settings

shipment_branch

object (ShipmentBranch)

optional

Shipment branch details in case of order is being shipped from a branch

customer

object (Customer)

optional

Detailed structure of the customer model object showing its fields and data types.

items

array [object {7}]

optional

Order Shipment Cancelled Webhook Event Model

The following includes 2 order shipment cancelled webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab

Data Schema

Example

Order Shipment Cancelled Webhook Events Model

event

enum<string>

optional

Event Name

Allowed values:

order.shipment.cancelledorder.shipment.return.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

Timestamp of webhook creation

data

object

optional

number

optional

Order ID

reference_id

number

optional

Order refrence ID, that appears to customers in the store.

shipping_number

string

optional

Shipping Number

Order Status Updated Webhook Event Model

Deprecation Notice

The variables, items.codes and items.files, are deprecated. We recommend using instead the data.urls.digital_content variable.

Data Schema

Example

Orders Status Updated Webhook Events Model

event

enum<string>

optional

Event Name

Allowed value:

order.status.updated

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

Created At Date Timestamp

data

object

optional

number

optional

Status ID

status

string

optional

Order Status

customized

object | null

optional

note

string

optional

Order Note

created_at

object

optional

order

object (OrderStatusUpdated)

optional

Detailed structure of the Order model object showing its fields and data types.

Orders Webhook Events Model#

Order Shipments Webhook Events Model#

Order Shipment Cancelled Webhook Event Model#

Order Status Updated Webhook Event Model#

Orders Webhook Events Model

Order Shipments Webhook Events Model

Order Shipment Cancelled Webhook Event Model

Order Status Updated Webhook Event Model