From 36320d31082bae7781bdf38c7dbe32b57d08e28c Mon Sep 17 00:00:00 2001 From: Abdullah Al-taheri Date: Tue, 17 May 2022 16:02:04 +0300 Subject: [PATCH] Fixing links --- Actions/abandoned/cart.js | 34 +++++ Actions/brand/deleted.js | 34 +++++ Actions/brand/updated.js | 34 +++++ Actions/category/created.js | 34 +++++ Actions/category/updated.js | 34 +++++ Actions/coupon/applied.js | 34 +++++ Actions/order/cancelled.js | 34 +++++ Actions/order/coupon.updated.js | 34 +++++ Actions/order/deleted.js | 34 +++++ Actions/order/payment.updated.js | 34 +++++ Actions/order/products.updated.js | 34 +++++ Actions/order/refunded.js | 34 +++++ Actions/order/shipment.cancelled.js | 34 +++++ Actions/order/shipment.created.js | 34 +++++ Actions/order/shipment.creating.js | 34 +++++ Actions/order/shipment.return.cancelled.js | 34 +++++ Actions/order/shipment.return.created.js | 34 +++++ Actions/order/shipment.return.creating.js | 34 +++++ Actions/order/shipping.address.updated.js | 34 +++++ Actions/order/status.updated.js | 34 +++++ Actions/order/total.price.updated.js | 34 +++++ Actions/order/updated.js | 34 +++++ Actions/product/available.js | 34 +++++ Actions/{project => product}/created.js | 4 +- Actions/product/deleted.js | 34 +++++ Actions/product/quantity.low.js | 34 +++++ Actions/product/updated.js | 34 +++++ Actions/review/added.js | 34 +++++ Actions/shipping/company.created.js | 34 +++++ Actions/shipping/company.deleted.js | 34 +++++ Actions/shipping/company.updated.js | 34 +++++ Actions/shipping/zone.created.js | 34 +++++ Actions/shipping/zone.updated.js | 34 +++++ Actions/specialoffer/created.js | 34 +++++ Actions/specialoffer/updated.js | 34 +++++ Actions/store/branch.activated.js | 34 +++++ Actions/store/branch.deleted.js | 34 +++++ Actions/store/branch.setDefault.js | 34 +++++ Actions/store/branch.updated.js | 34 +++++ Actions/storetax/created.js | 34 +++++ README.md | 147 +++++++++++---------- 41 files changed, 1403 insertions(+), 74 deletions(-) create mode 100644 Actions/abandoned/cart.js create mode 100644 Actions/brand/deleted.js create mode 100644 Actions/brand/updated.js create mode 100644 Actions/category/created.js create mode 100644 Actions/category/updated.js create mode 100644 Actions/coupon/applied.js create mode 100644 Actions/order/cancelled.js create mode 100644 Actions/order/coupon.updated.js create mode 100644 Actions/order/deleted.js create mode 100644 Actions/order/payment.updated.js create mode 100644 Actions/order/products.updated.js create mode 100644 Actions/order/refunded.js create mode 100644 Actions/order/shipment.cancelled.js create mode 100644 Actions/order/shipment.created.js create mode 100644 Actions/order/shipment.creating.js create mode 100644 Actions/order/shipment.return.cancelled.js create mode 100644 Actions/order/shipment.return.created.js create mode 100644 Actions/order/shipment.return.creating.js create mode 100644 Actions/order/shipping.address.updated.js create mode 100644 Actions/order/status.updated.js create mode 100644 Actions/order/total.price.updated.js create mode 100644 Actions/order/updated.js create mode 100644 Actions/product/available.js rename Actions/{project => product}/created.js (88%) create mode 100644 Actions/product/deleted.js create mode 100644 Actions/product/quantity.low.js create mode 100644 Actions/product/updated.js create mode 100644 Actions/review/added.js create mode 100644 Actions/shipping/company.created.js create mode 100644 Actions/shipping/company.deleted.js create mode 100644 Actions/shipping/company.updated.js create mode 100644 Actions/shipping/zone.created.js create mode 100644 Actions/shipping/zone.updated.js create mode 100644 Actions/specialoffer/created.js create mode 100644 Actions/specialoffer/updated.js create mode 100644 Actions/store/branch.activated.js create mode 100644 Actions/store/branch.deleted.js create mode 100644 Actions/store/branch.setDefault.js create mode 100644 Actions/store/branch.updated.js create mode 100644 Actions/storetax/created.js diff --git a/Actions/abandoned/cart.js b/Actions/abandoned/cart.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/abandoned/cart.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/brand/deleted.js b/Actions/brand/deleted.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/brand/deleted.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/brand/updated.js b/Actions/brand/updated.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/brand/updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/category/created.js b/Actions/category/created.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/category/created.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/category/updated.js b/Actions/category/updated.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/category/updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/coupon/applied.js b/Actions/coupon/applied.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/coupon/applied.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/cancelled.js b/Actions/order/cancelled.js new file mode 100644 index 0000000..0310448 --- /dev/null +++ b/Actions/order/cancelled.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.cancelled" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.cancelled', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/coupon.updated.js b/Actions/order/coupon.updated.js new file mode 100644 index 0000000..b2c397c --- /dev/null +++ b/Actions/order/coupon.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.coupon.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.coupon.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/deleted.js b/Actions/order/deleted.js new file mode 100644 index 0000000..b1f4531 --- /dev/null +++ b/Actions/order/deleted.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.deleted" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.deleted', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/payment.updated.js b/Actions/order/payment.updated.js new file mode 100644 index 0000000..58f7906 --- /dev/null +++ b/Actions/order/payment.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.payment.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.payment.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/products.updated.js b/Actions/order/products.updated.js new file mode 100644 index 0000000..bda2d72 --- /dev/null +++ b/Actions/order/products.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.products.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.products.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/refunded.js b/Actions/order/refunded.js new file mode 100644 index 0000000..8b1a0ba --- /dev/null +++ b/Actions/order/refunded.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.refunded" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.refunded', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/shipment.cancelled.js b/Actions/order/shipment.cancelled.js new file mode 100644 index 0000000..57ef014 --- /dev/null +++ b/Actions/order/shipment.cancelled.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.shipment.cancelled" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.shipment.cancelled', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/shipment.created.js b/Actions/order/shipment.created.js new file mode 100644 index 0000000..7954f8d --- /dev/null +++ b/Actions/order/shipment.created.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.shipment.created" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.shipment.created', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/shipment.creating.js b/Actions/order/shipment.creating.js new file mode 100644 index 0000000..d10a9db --- /dev/null +++ b/Actions/order/shipment.creating.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.shipment.creating" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.shipment.creating', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/shipment.return.cancelled.js b/Actions/order/shipment.return.cancelled.js new file mode 100644 index 0000000..91b032b --- /dev/null +++ b/Actions/order/shipment.return.cancelled.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.shipment.return.cancelled" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.shipment.return.cancelled', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/shipment.return.created.js b/Actions/order/shipment.return.created.js new file mode 100644 index 0000000..f308a1c --- /dev/null +++ b/Actions/order/shipment.return.created.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.shipment.return.created" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.shipment.return.created', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/shipment.return.creating.js b/Actions/order/shipment.return.creating.js new file mode 100644 index 0000000..3cfb01c --- /dev/null +++ b/Actions/order/shipment.return.creating.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.shipment.return.creating" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.shipment.return.creating', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/shipping.address.updated.js b/Actions/order/shipping.address.updated.js new file mode 100644 index 0000000..cb94091 --- /dev/null +++ b/Actions/order/shipping.address.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.shipping.address.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.shipping.address.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/status.updated.js b/Actions/order/status.updated.js new file mode 100644 index 0000000..bd1ead1 --- /dev/null +++ b/Actions/order/status.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.status.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.status.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/total.price.updated.js b/Actions/order/total.price.updated.js new file mode 100644 index 0000000..0afdf85 --- /dev/null +++ b/Actions/order/total.price.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.total.price.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.total.price.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/order/updated.js b/Actions/order/updated.js new file mode 100644 index 0000000..dafbe52 --- /dev/null +++ b/Actions/order/updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "order.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'order.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/product/available.js b/Actions/product/available.js new file mode 100644 index 0000000..bfed709 --- /dev/null +++ b/Actions/product/available.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "product.available" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'product.available', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/project/created.js b/Actions/product/created.js similarity index 88% rename from Actions/project/created.js rename to Actions/product/created.js index 982bd6e..25bd429 100644 --- a/Actions/project/created.js +++ b/Actions/product/created.js @@ -1,10 +1,10 @@ /** - * this function is exeucted on "project.created" action triggered by Salla . + * this function is exeucted on "product.created" action triggered by Salla . * * Action Body received from Salla * @param {Object} eventBody * { - * event: 'project.created', + * event: 'product.created', merchant: 472944967, created_at: '2021-11-22 13:51:57', data: diff --git a/Actions/product/deleted.js b/Actions/product/deleted.js new file mode 100644 index 0000000..773baec --- /dev/null +++ b/Actions/product/deleted.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "product.deleted" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'product.deleted', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/product/quantity.low.js b/Actions/product/quantity.low.js new file mode 100644 index 0000000..efef961 --- /dev/null +++ b/Actions/product/quantity.low.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "product.quantity.low" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'product.quantity.low', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/product/updated.js b/Actions/product/updated.js new file mode 100644 index 0000000..dedff0e --- /dev/null +++ b/Actions/product/updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "product.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'product.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/review/added.js b/Actions/review/added.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/review/added.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/shipping/company.created.js b/Actions/shipping/company.created.js new file mode 100644 index 0000000..98c33e7 --- /dev/null +++ b/Actions/shipping/company.created.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "shipping.company.created" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'product.company.created', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/shipping/company.deleted.js b/Actions/shipping/company.deleted.js new file mode 100644 index 0000000..fe935fc --- /dev/null +++ b/Actions/shipping/company.deleted.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "shipping.company.deleted" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'shipping.company.deleted', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/shipping/company.updated.js b/Actions/shipping/company.updated.js new file mode 100644 index 0000000..d6cd7ff --- /dev/null +++ b/Actions/shipping/company.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "shipping.company.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'shipping.company.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/shipping/zone.created.js b/Actions/shipping/zone.created.js new file mode 100644 index 0000000..3c59fb4 --- /dev/null +++ b/Actions/shipping/zone.created.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "shipping.zone.created" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'shipping.zone.created', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/shipping/zone.updated.js b/Actions/shipping/zone.updated.js new file mode 100644 index 0000000..e777830 --- /dev/null +++ b/Actions/shipping/zone.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "shipping.zone.updated" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: 'shipping.zone.updated', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/specialoffer/created.js b/Actions/specialoffer/created.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/specialoffer/created.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/specialoffer/updated.js b/Actions/specialoffer/updated.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/specialoffer/updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/store/branch.activated.js b/Actions/store/branch.activated.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/store/branch.activated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/store/branch.deleted.js b/Actions/store/branch.deleted.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/store/branch.deleted.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/store/branch.setDefault.js b/Actions/store/branch.setDefault.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/store/branch.setDefault.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/store/branch.updated.js b/Actions/store/branch.updated.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/store/branch.updated.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/Actions/storetax/created.js b/Actions/storetax/created.js new file mode 100644 index 0000000..c02e991 --- /dev/null +++ b/Actions/storetax/created.js @@ -0,0 +1,34 @@ +/** + * this function is exeucted on "${event-name}" action triggered by Salla . + * + * Action Body received from Salla + * @param {Object} eventBody + * { + * event: '${event-name}', + merchant: 472944967, + created_at: '2021-11-22 13:51:57', + data: + * { + * "id":1911645512, + * "app_name":"app name", + * "app_description":"desc", + * "app_type":"app", + * "app_scopes":[ + * 'settings.read', + * 'customers.read_write', + * 'orders.read_write', + * 'carts.read', + * ... + * ], + * "installation_date":"2021-11-21 11:07:13" + * } + * } + * Arguments passed by you: + * @param {Object} userArgs + * { key:"val" } + * @api public + */ +module.exports = (eventBody, userArgs) => { + // your logic here + return null; +}; diff --git a/README.md b/README.md index a4236ff..14d237e 100644 --- a/README.md +++ b/README.md @@ -124,10 +124,11 @@ List of existing apps assocaited to your account will be displayed as well as an

(back to top)

-__Important Note:__ -> If you are using [Easy mode.](#auth-modes.easy) the access token will push to the action ([`app.store.authorize`](app\template\Actions\app\store.authorize.js)) via webhook +**Important Note:** + +> If you are using [Easy mode.](#auth-modes.easy) the access token will push to the action ([`app.store.authorize`](Actions/app/store.authorize.js)) via webhook > -> If you are using [Custom mode.](#auth-modes.custom) the browser will redirect you again to the [`store.authorize.js file`](app\template\Actions\app\store.authorize.js). +> If you are using [Custom mode.](#auth-modes.custom) the browser will redirect you again to the [`store.authorize.js file`](Actions/app/store.authorize.js). #### Output URLs @@ -152,7 +153,7 @@ While creating your App in the [Salla Partners Portal](https://salla.partners/), #### Easy Mode This mode is the default mode for the authorization, which means that the `access token` is generated automatically at Salla's side back to you. -You may refer to the class [`StoreAuthorize`](app\template\Actions\app\store.authorize.js) which is defined inside [`app\template\Actions\app\store.authorize.js`](app\template\Actions\app\store.authorize.js) to get more details on how to receive and manage the `access token` +You may refer to the class [`StoreAuthorize`](Actions/app/store.authorize.js) which is defined inside [`Actions/app/store.authorize.js`](Actions/app/store.authorize.js) to get more details on how to receive and manage the `access token` #### Custom Mode @@ -260,6 +261,7 @@ SallaAPI.requestNewAccessToken(SallaAPI.getRefreshToken()) [Webhooks](https://docs.salla.dev/docs/merchant/ZG9jOjI0NTE3NDg1-webhook) simplify the communication between your App and [Salla APIs](https://docs.salla.dev/). In this way, you will be notified whenever your app receives payload/data from the Salla APIs. These webhooks are triggered along with many actions such as an order or product being created, a customer logs in, a coupon is applied, and much more. ### Create new Webhook/Action command + Salla already defined a list of the webhooks/actions that are triggered automatically. The predefined webhooks/actions can be found in the folder [`app/Actions`](https://github.com/SallaApp/express-starter-kit/tree/master/Actions). Run the following command to create your webhook event: @@ -276,126 +278,127 @@ You may find the supported [Webhook events](https://docs.salla.dev/docs/merchant #### Order Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [order.created](app/Actions/Order/Created.js) | This indicates a singular order has been created | -| [order.updated](app/Actions/Order/Updated.js) | Details, data and/or content of a specific order have been refreshed updated | -| [order.status.updated](app/Actions/Order/StatusUpdated.js) | Whenever there is an order status update, this is triggered | -| [order.cancelled](app/Actions/Order/Cancelled.js) | This happens when an order is cancelled | -| [order.refunded](app/Actions/Order/Refunded.js) | The refund action to refund the whole order is triggered. | -| [order.deleted](app/Actions/Order/) | This indicates an order has been deleted | -| [order.products.updated](app/Actions/Order/ProductsUpdated.js) | Order products is updated | -| [order.payment.updated](app/Actions/Order/PaymentUpdated.js) | A payment method has been updated | -| [order.coupon.updated](app/Actions/Order/CouponUpdated.js) | This is triggered whenever a Coupon is updated | -| [order.total.price.updated](app/Actions/Order/TotalPriceUpdated.js) | A total price of an order has been updated | -| [order.shipment.creating](app/Actions/Order/ShipmentCreating.js) | This indicates a new shipment is being created | -| [order.shipment.created](app/Actions/Order/ShipmentCreated.js) | This indicates a new shipment has been created | -| [order.shipment.cancelled](app/Actions/Order/ShipmentCancelled.js) | This indicates a an order shipment has been cancelled | -| [order.shipment.return.creating](app/Actions/Order/ShipmentReturnCreating.js) | This is triggered when a returned order shipment is being created | -| [order.shipment.return.created](app/Actions/Order/ShipmentReturnCreated.js) | This is triggered when a returned order shipment has been created | -| [order.shipment.return.cancelled](app/Actions/Order/ShipmentReturnCancelled.js) | This is triggered when a returned order shipment has been cancelled | -| [order.shipping.address.updated](app/Actions/Order/ShippingAddressUpdated.js) | Occurs when an Order shipping address is updated | +| ** Action Name ** | ** Description ** | +| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [order.created](Actions/order/created.js) | This indicates a singular order has been created | +| [order.updated](Actions/order/updated.js) | Details, data and/or content of a specific order have been refreshed updated | +| [order.status.updated](Actions/order/status.updated.js) | Whenever there is an order status update, this is triggered | +| [order.cancelled](Actions/order/cancelled.js) | This happens when an order is cancelled | +| [order.refunded](Actions/order/refunded.js) | The refund action to refund the whole order is triggered. | +| [order.deleted](Actions/order/deleted.js) | This indicates an order has been deleted | +| [order.products.updated](Actions/order/products.updated.js) | Order products is updated | +| [order.payment.updated](Actions/order/payment.updated.js) | A payment method has been updated | +| [order.coupon.updated](Actions/order/coupon.updated.js) | This is triggered whenever a Coupon is updated | +| [order.total.price.updated](Actions/order/total.price.updated.js) | A total price of an order has been updated | +| [order.shipment.creating](Actions/order/shipment.creating.js) | This indicates a new shipment is being created | +| [order.shipment.created](Actions/order/shipment.created.js) | This indicates a new shipment has been created | +| [order.shipment.cancelled](Actions/order/shipment.cancelled.js) | This indicates a an order shipment has been cancelled | +| [order.shipment.return.creating](Actions/order/shipment.return.creating.js) | This is triggered when a returned order shipment is being created | +| [order.shipment.return.created](Actions/order/shipment.return.created.js) | This is triggered when a returned order shipment has been created | +| [order.shipment.return.cancelled](Actions/order/shipment.return.cancelled.js) | This is triggered when a returned order shipment has been cancelled | +| [order.shipping.address.updated](Actions/order/shipping.address.updated.js) | Occurs when an Order shipping address is updated |

(back to top)

#### Product Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| ---------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| [product.created](app/Actions/Product/Created.js) | A new product is created. Payload of the new product are to accompanying the product | -| [product.updated](app/Actions/Product/Updated.js) | Add/Modify details of a product | -| [product.deleted](app/Actions/Product/Deleted.js) | Delete a product along with all its variants and images | -| [product.available](app/Actions/Product/Available.js) | Flags a product as stock available | -| [product.quantity.low](app/Actions/Product/QuantityLow.js) | Shows warnings whenever a stock is of low quantity | +| ** Action Name ** | ** Description ** | +| ------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| [product.created](Actions/product/created.js) | A new product is created. Payload of the new product are to accompanying the product | +| [product.updated](Actions/product/updated.js) | Add/Modify details of a product | +| [product.deleted](Actions/product/deleted.js) | Delete a product along with all its variants and images | +| [product.available](Actions/product/available.js) | Flags a product as stock available | +| [product.quantity.low](Actions/product/quantity.low.js) | Shows warnings whenever a stock is of low quantity |

(back to top)

#### Shipping Companies Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| ------------------------ | ------------------------------------------------------------------------------------- | -| shipping.zone.created | This is triggered when a shipping zone has been created for a custom shipping company | -| shipping.zone.updated | This is triggered when a shipping zone has been updated for a custom shipping company | -| shipping.company.created | This is triggered when a custom shipping company has been created | -| shipping.company.updated | This is triggered when a custom shipping company has been updated | -| shipping.company.deleted | This is triggered when a custom shipping company has been deleted | +| ** Action Name ** | ** Description ** | +| --------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| [shipping.zone.created](Actions/shipping/zone.created.js) | This is triggered when a shipping zone has been created for a custom shipping company | +| [shipping.zone.updated](Actions/shipping/zone.updated.js) | This is triggered when a shipping zone has been updated for a custom shipping company | +| [shipping.company.created](Actions/shipping/company.created.js) | This is triggered when a custom shipping company has been created | +| [shipping.company.updated](Actions/shipping/company.updated.js) | This is triggered when a custom shipping company has been updated | +| [shipping.company.deleted](Actions/shipping/company.deleted.js) | This is triggered when a custom shipping company has been deleted |

(back to top)

#### Customer Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| ---------------------------------------------------------- | ---------------------------------------- | -| [customer.created](app/Actions/Customer/Created.js) | Create a new customer record | -| [customer.updated](app/Actions/Customer/Updated.js) | Update details for a customer | -| [customer.login](app/Actions/Customer/Login.js) | Triggered whenever a customer log in | -| [customer.otp.request](app/Actions/Customer/OtpRequest.js) | One-Time Password request for a customer | +| ** Action Name ** | ** Description ** | +| ------------------------------------------------------- | ---------------------------------------- | +| [customer.created](Actions/customer/created.js) | Create a new customer record | +| [customer.updated](Actions/customer/updated.js) | Update details for a customer | +| [customer.login](Actions/customer/login.js) | Triggered whenever a customer log in | +| [customer.otp.request](Actions/customer/otp.created.js) | One-Time Password request for a customer |

(back to top)

#### Category Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| --------------------------------------------------- | --------------------------------------------------- | -| [category.created](app/Actions/Category/Created.js) | Creates a new category for products to be put under | -| [category.updated](app/Actions/Category/Updated.js) | Add new or reform existing category details | +| ** Action Name ** | ** Description ** | +| ----------------------------------------------- | --------------------------------------------------- | +| [category.created](Actions/category/created.js) | Creates a new category for products to be put under | +| [category.updated](Actions/category/updated.js) | Add new or reform existing category details |

(back to top)

#### Brand Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| --------------------------------------------- | ------------------------------------------------------------------------------------ | -| [brand.created](app/Actions/Brand/Created.js) | Creates a new Brand. | -| [brand.updated](app/Actions/Brand/Updated.js) | Triggered when Information about a sepcific Brand is updated/refurbished/streamlined | -| [brand.deleted](app/Actions/Brand/Deleted.js) | An existing brand is then deleted and removed from a store | +| ** Action Name ** | ** Description ** | +| ----------------------------------------- | ------------------------------------------------------------------------------------ | +| [brand.created](Actions/brand/created.js) | Creates a new Brand. | +| [brand.updated](Actions/brand/updated.js) | Triggered when Information about a sepcific Brand is updated/refurbished/streamlined | +| [brand.deleted](Actions/brand/deleted.js) | An existing brand is then deleted and removed from a store |

(back to top)

#### Store Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| ---------------------------------------------------------------- | ---------------------------------- | -| [store.branch.created](app/Actions/Store/BranchCreated.js) | Creates a new store. | -| [store.branch.updated](app/Actions/Store/BranchUpdated.js) | Updates an existing branch | -| [store.branch.setDefault](app/Actions/Store/BranchSetDefault.js) | Sets for default a specific branch | -| [store.branch.activated](app/Actions/Store/BranchActivated.js) | Activates a disabled branch | -| [store.branch.deleted](app/Actions/Store/BranchDeleted.js) | Deletes a branch | -| [storetax.created](app/Actions/Store/TaxCreated.js) | Creats a new Store Tax | +| ** Action Name ** | ** Description ** | +| ------------------------------------------------------------- | ---------------------------------- | +| [store.branch.created](Actions/store/branch.created.js) | Creates a new store. | +| [store.branch.updated](Actions/store/branch.updated.js) | Updates an existing branch | +| [store.branch.setDefault](Actions/store/branch.setDefault.js) | Sets for default a specific branch | +| [store.branch.activated](Actions/store/branch.activated.js) | Activates a disabled branch | +| [store.branch.deleted](Actions/store/branch.deleted.js) | Deletes a branch | +| [storetax.created](Actions/store/tax.created.js) | Creats a new Store Tax |

(back to top)

#### Cart Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| ------------------------------------------------------------ | ----------------------------------------------- | -| [abandoned.cart](app/Actions/Miscellaneous/AbandonedCart.js) | Outputs a list of abandoned carts | -| [coupon.applied](app/Actions/Miscellaneous/CouponApplied.js) | Creates a discount code in the form of a coupon | +| ** Action Name ** | ** Description ** | +| -------------------------------------------------------- | ----------------------------------------------- | +| [abandoned.cart](Actions/abandoned/cart.js) | Outputs a list of abandoned carts | +| [coupon.applied](Actions/Miscellaneous/CouponApplied.js) | Creates a discount code in the form of a coupon |

(back to top)

#### Special Offer Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| ------------------------------------------------------------------------ | --------------------------- | -| [specialoffer.created](app/Actions/Miscellaneous/SpecialofferCreated.js) | Creates a new special offer | -| [specialoffer.updated](app/Actions/Miscellaneous/SpecialofferUpdated.js) | Updates a special offer | +| ** Action Name ** | ** Description ** | +| ------------------------------------------------------- | --------------------------- | +| [specialoffer.created](Actions/specialoffer/created.js) | Creates a new special offer | +| [specialoffer.updated](Actions/specialoffer/updated.js) | Updates a special offer |

(back to top)

#### Miscellaneous Related Webhooks/Actions -| ** Action Name ** | ** Description ** | -| -------------------------------------------------------- | ------------------------------- | -| [review.added](app/Actions/Miscellaneous/ReviewAdded.js) | A product review has been added | +| ** Action Name ** | ** Description ** | +| --------------------------------------- | ------------------------------- | +| [review.added](Actions/review/added.js) | A product review has been added |

(back to top)

## Support The team is always here to help you. Happen to face an issue? Want to report a bug? You can submit one here on Github using the [Issue Tracker](https://github.com/SallaApp/Salla-CLI/issues/new). If you still have any questions, please contact us via the [Telegram Bot](https://t.me/SallaSupportBot) or join in the Global Developer Community on [Telegram](https://t.me/salladev). - + + ## Contributing Contributions are what make the open-source community such an amazing place to learn, inspire, and create.