generated from ecomplus/application-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ecom.config.js
197 lines (176 loc) · 5.97 KB
/
ecom.config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/* eslint-disable comma-dangle, no-multi-spaces, key-spacing */
/**
* Edit base E-Com Plus Application object here.
* Ref.: https://developers.e-com.plus/docs/api/#/store/applications/
*/
const app = {
app_id: 123481,
title: 'Beeviral',
slug: 'beeviral',
type: 'external',
state: 'active',
authentication: true,
/**
* Uncomment modules above to work with E-Com Plus Mods API on Storefront.
* Ref.: https://developers.e-com.plus/modules-api/
*/
modules: {
/**
* Triggered to calculate shipping options, must return values and deadlines.
* Start editing `routes/ecom/modules/calculate-shipping.js`
*/
// calculate_shipping: { enabled: true },
/**
* Triggered to validate and apply discount value, must return discount and conditions.
* Start editing `routes/ecom/modules/apply-discount.js`
*/
// apply_discount: { enabled: true },
/**
* Triggered when listing payments, must return available payment methods.
* Start editing `routes/ecom/modules/list-payments.js`
*/
// list_payments: { enabled: true },
/**
* Triggered when order is being closed, must create payment transaction and return info.
* Start editing `routes/ecom/modules/create-transaction.js`
*/
// create_transaction: { enabled: true },
},
/**
* Uncomment only the resources/methods your app may need to consume through Store API.
*/
auth_scope: {
'stores/me': [
'GET' // Read store info
],
procedures: [
'POST' // Create procedures to receive webhooks
],
products: [
// 'GET', // Read products with public and private fields
// 'POST', // Create products
// 'PATCH', // Edit products
// 'PUT', // Overwrite products
// 'DELETE', // Delete products
],
brands: [
// 'GET', // List/read brands with public and private fields
// 'POST', // Create brands
// 'PATCH', // Edit brands
// 'PUT', // Overwrite brands
// 'DELETE', // Delete brands
],
categories: [
// 'GET', // List/read categories with public and private fields
// 'POST', // Create categories
// 'PATCH', // Edit categories
// 'PUT', // Overwrite categories
// 'DELETE', // Delete categories
],
customers: [
'GET', // List/read customers
'POST', // Create customers
'PATCH', // Edit customers
// 'PUT', // Overwrite customers
// 'DELETE', // Delete customers
],
orders: [
'GET', // List/read orders with public and private fields
// 'POST', // Create orders
// 'PATCH', // Edit orders
// 'PUT', // Overwrite orders
// 'DELETE', // Delete orders
],
carts: [
// 'GET', // List all carts (no auth needed to read specific cart only)
// 'POST', // Create carts
// 'PATCH', // Edit carts
// 'PUT', // Overwrite carts
// 'DELETE', // Delete carts
],
/**
* Prefer using 'fulfillments' and 'payment_history' subresources to manipulate update order status.
*/
'orders/fulfillments': [
// 'GET', // List/read order fulfillment and tracking events
// 'POST', // Create fulfillment event with new status
// 'DELETE', // Delete fulfillment event
],
'orders/payments_history': [
'GET', // List/read order payments history events
// 'POST', // Create payments history entry with new status
// 'DELETE', // Delete payments history entry
],
/**
* Set above 'quantity' and 'price' subresources if you don't need access for full product document.
* Stock and price management only.
*/
'products/quantity': [
// 'GET', // Read product available quantity
// 'PUT', // Set product stock quantity
],
'products/variations/quantity': [
// 'GET', // Read variaton available quantity
// 'PUT', // Set variation stock quantity
],
'products/price': [
// 'GET', // Read product current sale price
// 'PUT', // Set product sale price
],
'products/variations/price': [
// 'GET', // Read variation current sale price
// 'PUT', // Set variation sale price
],
/**
* You can also set any other valid resource/subresource combination.
* Ref.: https://developers.e-com.plus/docs/api/#/store/
*/
},
admin_settings: {
/**
* JSON schema based fields to be configured by merchant and saved to app `data` / `hidden_data`, such as:
*/
token: {
schema: {
type: 'string',
maxLength: 100,
title: 'Beeviral token'
},
hide: true
}
}
}
/**
* List of Procedures to be created on each store after app installation.
* Ref.: https://developers.e-com.plus/docs/api/#/store/procedures/
*/
const procedures = []
/**
* Uncomment and edit code above to configure `triggers` and receive respective `webhooks`:
*/
const { baseUri } = require('./__env')
procedures.push({
title: app.title,
triggers: [
// Receive notifications when new order is created:
// Receive notifications when order financial/fulfillment status are set or changed:
// Obs.: you probably SHOULD NOT enable the orders triggers below and the one above (create) together.
{
resource: 'orders',
field: 'financial_status',
}
// Feel free to create custom combinations with any Store API resource, subresource, action and field.
],
webhooks: [
{
api: {
external_api: {
uri: `${baseUri}/ecom/webhook`
}
},
method: 'POST'
}
]
})
exports.app = app
exports.procedures = procedures