@retailcrm/embed-ui-v1-contexts 0.9.23-alpha.2 → 0.9.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -1
- package/bin/embed-ui-v1-contexts-mcp.mjs +10 -0
- package/bin/embed-ui-v1-contexts.mjs +587 -0
- package/dist/mcp/server.cjs +147 -0
- package/dist/mcp/server.d.ts +3 -0
- package/dist/mcp/server.js +129 -0
- package/dist/meta.json +3 -3
- package/docs/actions/index.json +10 -0
- package/docs/actions/order-card.yml +107 -0
- package/docs/contexts/customer-card-phone.yml +37 -0
- package/docs/contexts/customer-card.yml +59 -0
- package/docs/contexts/index.json +35 -0
- package/docs/contexts/order-card-settings.yml +221 -0
- package/docs/contexts/order-card.yml +815 -0
- package/docs/contexts/settings.yml +54 -0
- package/docs/contexts/user-current.yml +119 -0
- package/docs/custom-contexts/index.json +10 -0
- package/docs/custom-contexts/order.yml +65 -0
- package/docs/ru/CONCEPT.md +195 -10
- package/package.json +22 -5
|
@@ -0,0 +1,815 @@
|
|
|
1
|
+
"context": "order/card"
|
|
2
|
+
"summary": "Order card context with order identity, customer data, company fields, order items, delivery address, discount and status."
|
|
3
|
+
"language": "en-GB"
|
|
4
|
+
"audience": "ai"
|
|
5
|
+
"public_import":
|
|
6
|
+
"usage_import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/order/card'"
|
|
7
|
+
"usage_call": "const order = useContext()"
|
|
8
|
+
"fields":
|
|
9
|
+
-
|
|
10
|
+
"name": "id"
|
|
11
|
+
"type": "number|null"
|
|
12
|
+
"readonly": true
|
|
13
|
+
"description": "Order ID in CRM"
|
|
14
|
+
"mutation":
|
|
15
|
+
"mode": "readonly"
|
|
16
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
17
|
+
"related_actions": []
|
|
18
|
+
"ai_notes": []
|
|
19
|
+
-
|
|
20
|
+
"name": "externalId"
|
|
21
|
+
"type": "string|null"
|
|
22
|
+
"readonly": true
|
|
23
|
+
"description": "The order ID in the external source system"
|
|
24
|
+
"mutation":
|
|
25
|
+
"mode": "readonly"
|
|
26
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
27
|
+
"related_actions": []
|
|
28
|
+
"ai_notes": []
|
|
29
|
+
-
|
|
30
|
+
"name": "type"
|
|
31
|
+
"type": "string|null"
|
|
32
|
+
"readonly": true
|
|
33
|
+
"description": "Order type code"
|
|
34
|
+
"mutation":
|
|
35
|
+
"mode": "readonly"
|
|
36
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
37
|
+
"related_actions": []
|
|
38
|
+
"ai_notes": []
|
|
39
|
+
-
|
|
40
|
+
"name": "site"
|
|
41
|
+
"type": "string|null"
|
|
42
|
+
"readonly": true
|
|
43
|
+
"description": "Store code associated with the order"
|
|
44
|
+
"mutation":
|
|
45
|
+
"mode": "readonly"
|
|
46
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
47
|
+
"related_actions": []
|
|
48
|
+
"ai_notes": []
|
|
49
|
+
-
|
|
50
|
+
"name": "number"
|
|
51
|
+
"type": "string|null"
|
|
52
|
+
"readonly": true
|
|
53
|
+
"description": "Displayed order number"
|
|
54
|
+
"mutation":
|
|
55
|
+
"mode": "readonly"
|
|
56
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
57
|
+
"related_actions": []
|
|
58
|
+
"ai_notes": []
|
|
59
|
+
-
|
|
60
|
+
"name": "country"
|
|
61
|
+
"type": "string|null"
|
|
62
|
+
"readonly": true
|
|
63
|
+
"description": "Character code of the country"
|
|
64
|
+
"mutation":
|
|
65
|
+
"mode": "readonly"
|
|
66
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
67
|
+
"related_actions": []
|
|
68
|
+
"ai_notes": []
|
|
69
|
+
-
|
|
70
|
+
"name": "currency"
|
|
71
|
+
"type": "string"
|
|
72
|
+
"readonly": true
|
|
73
|
+
"description": "Currency code"
|
|
74
|
+
"mutation":
|
|
75
|
+
"mode": "readonly"
|
|
76
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
77
|
+
"related_actions": []
|
|
78
|
+
"ai_notes": []
|
|
79
|
+
-
|
|
80
|
+
"name": "customer.id"
|
|
81
|
+
"type": "number|null"
|
|
82
|
+
"readonly": true
|
|
83
|
+
"description": "Customer ID"
|
|
84
|
+
"mutation":
|
|
85
|
+
"mode": "readonly"
|
|
86
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
87
|
+
"related_actions": []
|
|
88
|
+
"ai_notes": []
|
|
89
|
+
-
|
|
90
|
+
"name": "customer.externalId"
|
|
91
|
+
"type": "string|null"
|
|
92
|
+
"readonly": true
|
|
93
|
+
"description": "Customer external ID"
|
|
94
|
+
"mutation":
|
|
95
|
+
"mode": "readonly"
|
|
96
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
97
|
+
"related_actions": []
|
|
98
|
+
"ai_notes": []
|
|
99
|
+
-
|
|
100
|
+
"name": "customer.type"
|
|
101
|
+
"type": "\"customer\"|\"customer_corporate\""
|
|
102
|
+
"readonly": true
|
|
103
|
+
"description": "Client type"
|
|
104
|
+
"mutation":
|
|
105
|
+
"mode": "readonly"
|
|
106
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
107
|
+
"related_actions": []
|
|
108
|
+
"ai_notes": []
|
|
109
|
+
-
|
|
110
|
+
"name": "customer.lastName"
|
|
111
|
+
"type": "string|null"
|
|
112
|
+
"readonly": false
|
|
113
|
+
"description": "Client last name"
|
|
114
|
+
"mutation":
|
|
115
|
+
"mode": "direct"
|
|
116
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
117
|
+
"related_actions": []
|
|
118
|
+
"ai_notes": []
|
|
119
|
+
-
|
|
120
|
+
"name": "customer.firstName"
|
|
121
|
+
"type": "string|null"
|
|
122
|
+
"readonly": false
|
|
123
|
+
"description": "Client name"
|
|
124
|
+
"mutation":
|
|
125
|
+
"mode": "direct"
|
|
126
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
127
|
+
"related_actions": []
|
|
128
|
+
"ai_notes": []
|
|
129
|
+
-
|
|
130
|
+
"name": "customer.patronymic"
|
|
131
|
+
"type": "string|null"
|
|
132
|
+
"readonly": false
|
|
133
|
+
"description": "Patronymic of the client"
|
|
134
|
+
"mutation":
|
|
135
|
+
"mode": "direct"
|
|
136
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
137
|
+
"related_actions": []
|
|
138
|
+
"ai_notes": []
|
|
139
|
+
-
|
|
140
|
+
"name": "customer.phone"
|
|
141
|
+
"type": "string|null"
|
|
142
|
+
"readonly": false
|
|
143
|
+
"description": "Customer phone"
|
|
144
|
+
"mutation":
|
|
145
|
+
"mode": "direct"
|
|
146
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
147
|
+
"related_actions": []
|
|
148
|
+
"ai_notes": []
|
|
149
|
+
-
|
|
150
|
+
"name": "customer.email"
|
|
151
|
+
"type": "string|null"
|
|
152
|
+
"readonly": false
|
|
153
|
+
"description": "Customer email"
|
|
154
|
+
"mutation":
|
|
155
|
+
"mode": "direct"
|
|
156
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
157
|
+
"related_actions": []
|
|
158
|
+
"ai_notes": []
|
|
159
|
+
-
|
|
160
|
+
"name": "company.contragentType"
|
|
161
|
+
"type": "\"enterpreneur\"|\"legal-entity\"|\"individual\""
|
|
162
|
+
"readonly": true
|
|
163
|
+
"description": "Legal entity type"
|
|
164
|
+
"mutation":
|
|
165
|
+
"mode": "readonly"
|
|
166
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
167
|
+
"related_actions": []
|
|
168
|
+
"ai_notes": []
|
|
169
|
+
-
|
|
170
|
+
"name": "company.certificateNumber"
|
|
171
|
+
"type": "string|null"
|
|
172
|
+
"readonly": false
|
|
173
|
+
"description": "Certificate number"
|
|
174
|
+
"mutation":
|
|
175
|
+
"mode": "direct"
|
|
176
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
177
|
+
"related_actions": []
|
|
178
|
+
"ai_notes": []
|
|
179
|
+
-
|
|
180
|
+
"name": "company.certificateDate"
|
|
181
|
+
"type": "string|null"
|
|
182
|
+
"readonly": false
|
|
183
|
+
"description": "Certificate date"
|
|
184
|
+
"mutation":
|
|
185
|
+
"mode": "direct"
|
|
186
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
187
|
+
"related_actions": []
|
|
188
|
+
"ai_notes": []
|
|
189
|
+
-
|
|
190
|
+
"name": "company.OGRN"
|
|
191
|
+
"type": "string|null"
|
|
192
|
+
"readonly": false
|
|
193
|
+
"description": "PSRN of the counterparty"
|
|
194
|
+
"mutation":
|
|
195
|
+
"mode": "direct"
|
|
196
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
197
|
+
"related_actions": []
|
|
198
|
+
"ai_notes": []
|
|
199
|
+
-
|
|
200
|
+
"name": "company.OGRNIP"
|
|
201
|
+
"type": "string|null"
|
|
202
|
+
"readonly": false
|
|
203
|
+
"description": "PSRN of Individual entrepreneur"
|
|
204
|
+
"mutation":
|
|
205
|
+
"mode": "direct"
|
|
206
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
207
|
+
"related_actions": []
|
|
208
|
+
"ai_notes": []
|
|
209
|
+
-
|
|
210
|
+
"name": "company.name"
|
|
211
|
+
"type": "string|null"
|
|
212
|
+
"readonly": false
|
|
213
|
+
"description": "Company's name"
|
|
214
|
+
"mutation":
|
|
215
|
+
"mode": "direct"
|
|
216
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
217
|
+
"related_actions": []
|
|
218
|
+
"ai_notes": []
|
|
219
|
+
-
|
|
220
|
+
"name": "company.legalName"
|
|
221
|
+
"type": "string|null"
|
|
222
|
+
"readonly": false
|
|
223
|
+
"description": "Full name of the company"
|
|
224
|
+
"mutation":
|
|
225
|
+
"mode": "direct"
|
|
226
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
227
|
+
"related_actions": []
|
|
228
|
+
"ai_notes": []
|
|
229
|
+
-
|
|
230
|
+
"name": "company.legalAddress"
|
|
231
|
+
"type": "string|null"
|
|
232
|
+
"readonly": false
|
|
233
|
+
"description": "Company's registration address"
|
|
234
|
+
"mutation":
|
|
235
|
+
"mode": "direct"
|
|
236
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
237
|
+
"related_actions": []
|
|
238
|
+
"ai_notes": []
|
|
239
|
+
-
|
|
240
|
+
"name": "company.INN"
|
|
241
|
+
"type": "string|null"
|
|
242
|
+
"readonly": false
|
|
243
|
+
"description": "Counterparty's INN"
|
|
244
|
+
"mutation":
|
|
245
|
+
"mode": "direct"
|
|
246
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
247
|
+
"related_actions": []
|
|
248
|
+
"ai_notes": []
|
|
249
|
+
-
|
|
250
|
+
"name": "company.KPP"
|
|
251
|
+
"type": "string|null"
|
|
252
|
+
"readonly": false
|
|
253
|
+
"description": "Counterparty's KPP"
|
|
254
|
+
"mutation":
|
|
255
|
+
"mode": "direct"
|
|
256
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
257
|
+
"related_actions": []
|
|
258
|
+
"ai_notes": []
|
|
259
|
+
-
|
|
260
|
+
"name": "company.OKPO"
|
|
261
|
+
"type": "string|null"
|
|
262
|
+
"readonly": false
|
|
263
|
+
"description": "OKPO of the counterparty"
|
|
264
|
+
"mutation":
|
|
265
|
+
"mode": "direct"
|
|
266
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
267
|
+
"related_actions": []
|
|
268
|
+
"ai_notes": []
|
|
269
|
+
-
|
|
270
|
+
"name": "company.BIK"
|
|
271
|
+
"type": "string|null"
|
|
272
|
+
"readonly": false
|
|
273
|
+
"description": "Counterparty's BIC"
|
|
274
|
+
"mutation":
|
|
275
|
+
"mode": "direct"
|
|
276
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
277
|
+
"related_actions": []
|
|
278
|
+
"ai_notes": []
|
|
279
|
+
-
|
|
280
|
+
"name": "company.bank"
|
|
281
|
+
"type": "string|null"
|
|
282
|
+
"readonly": false
|
|
283
|
+
"description": "Counterparty's bank"
|
|
284
|
+
"mutation":
|
|
285
|
+
"mode": "direct"
|
|
286
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
287
|
+
"related_actions": []
|
|
288
|
+
"ai_notes": []
|
|
289
|
+
-
|
|
290
|
+
"name": "company.bankAddress"
|
|
291
|
+
"type": "string|null"
|
|
292
|
+
"readonly": false
|
|
293
|
+
"description": "The address of the counterparty's bank"
|
|
294
|
+
"mutation":
|
|
295
|
+
"mode": "direct"
|
|
296
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
297
|
+
"related_actions": []
|
|
298
|
+
"ai_notes": []
|
|
299
|
+
-
|
|
300
|
+
"name": "company.corrAccount"
|
|
301
|
+
"type": "string|null"
|
|
302
|
+
"readonly": false
|
|
303
|
+
"description": "Correspondent account of the counterparty"
|
|
304
|
+
"mutation":
|
|
305
|
+
"mode": "direct"
|
|
306
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
307
|
+
"related_actions": []
|
|
308
|
+
"ai_notes": []
|
|
309
|
+
-
|
|
310
|
+
"name": "company.bankAccount"
|
|
311
|
+
"type": "string|null"
|
|
312
|
+
"readonly": false
|
|
313
|
+
"description": "Counterparty's current account"
|
|
314
|
+
"mutation":
|
|
315
|
+
"mode": "direct"
|
|
316
|
+
"notes": "Writable context field; set it directly through the context API when the host accepts the value."
|
|
317
|
+
"related_actions": []
|
|
318
|
+
"ai_notes": []
|
|
319
|
+
-
|
|
320
|
+
"name": "items"
|
|
321
|
+
"type": "Array<OrderItem>"
|
|
322
|
+
"readonly": true
|
|
323
|
+
"description": "List of items in the order"
|
|
324
|
+
"source_of_truth": "Readonly source of truth for the current order item list."
|
|
325
|
+
"mutation":
|
|
326
|
+
"mode": "action"
|
|
327
|
+
"action": "order/card actions"
|
|
328
|
+
"notes": "Do not mutate items directly. Use item actions such as changeItemQuantity, changeItemPriceType, changeItemDiscount, changeItemStatus, removeItem or createItem."
|
|
329
|
+
"related_actions":
|
|
330
|
+
- "createItem"
|
|
331
|
+
- "changeItemPrice"
|
|
332
|
+
- "changeItemPriceType"
|
|
333
|
+
- "changeItemDiscount"
|
|
334
|
+
- "changeItemQuantity"
|
|
335
|
+
- "changeItemStatus"
|
|
336
|
+
- "removeItem"
|
|
337
|
+
"ai_notes":
|
|
338
|
+
- "Use items for promotions, product composition analysis, item display and calculations based on the current order form state."
|
|
339
|
+
-
|
|
340
|
+
"name": "delivery.address"
|
|
341
|
+
"type": "string|null"
|
|
342
|
+
"readonly": false
|
|
343
|
+
"description": "Delivery address"
|
|
344
|
+
"mutation":
|
|
345
|
+
"mode": "direct"
|
|
346
|
+
"notes": "Writable delivery address field."
|
|
347
|
+
"related_actions": []
|
|
348
|
+
"ai_notes": []
|
|
349
|
+
-
|
|
350
|
+
"name": "discount.amount"
|
|
351
|
+
"type": "number"
|
|
352
|
+
"readonly": false
|
|
353
|
+
"description": "One-time discount amount in order currency"
|
|
354
|
+
"mutation":
|
|
355
|
+
"mode": "direct"
|
|
356
|
+
"notes": "Writable one-time order discount amount in the order currency."
|
|
357
|
+
"related_actions": []
|
|
358
|
+
"ai_notes": []
|
|
359
|
+
-
|
|
360
|
+
"name": "discount.percent"
|
|
361
|
+
"type": "number"
|
|
362
|
+
"readonly": false
|
|
363
|
+
"description": "One-time discount percentage"
|
|
364
|
+
"mutation":
|
|
365
|
+
"mode": "direct"
|
|
366
|
+
"notes": "Writable one-time order discount percent."
|
|
367
|
+
"related_actions": []
|
|
368
|
+
"ai_notes": []
|
|
369
|
+
-
|
|
370
|
+
"name": "discount.total"
|
|
371
|
+
"type": "number"
|
|
372
|
+
"readonly": true
|
|
373
|
+
"description": "Total order discount"
|
|
374
|
+
"source_of_truth": "Readonly calculated total order discount."
|
|
375
|
+
"mutation":
|
|
376
|
+
"mode": "readonly"
|
|
377
|
+
"notes": "Use this field for display and calculations only; write discount.amount or discount.percent when changing the order discount."
|
|
378
|
+
"related_actions": []
|
|
379
|
+
"ai_notes": []
|
|
380
|
+
-
|
|
381
|
+
"name": "status"
|
|
382
|
+
"type": "string"
|
|
383
|
+
"readonly": true
|
|
384
|
+
"description": "Order status"
|
|
385
|
+
"mutation":
|
|
386
|
+
"mode": "readonly"
|
|
387
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
388
|
+
"related_actions": []
|
|
389
|
+
"ai_notes": []
|
|
390
|
+
"field_groups":
|
|
391
|
+
-
|
|
392
|
+
"name": "customer"
|
|
393
|
+
"fields":
|
|
394
|
+
- "customer.id"
|
|
395
|
+
- "customer.externalId"
|
|
396
|
+
- "customer.type"
|
|
397
|
+
- "customer.lastName"
|
|
398
|
+
- "customer.firstName"
|
|
399
|
+
- "customer.patronymic"
|
|
400
|
+
- "customer.phone"
|
|
401
|
+
- "customer.email"
|
|
402
|
+
"ai_notes":
|
|
403
|
+
- "Customer id, externalId and type identify the selected customer and are readonly; contact and name fields are writable order-form values."
|
|
404
|
+
"types":
|
|
405
|
+
-
|
|
406
|
+
"name": "CreateOrderItemInput"
|
|
407
|
+
"fields":
|
|
408
|
+
-
|
|
409
|
+
"name": "productId"
|
|
410
|
+
"type": "number"
|
|
411
|
+
"description": "Product or service ID"
|
|
412
|
+
"mutation": {}
|
|
413
|
+
"ai_notes": []
|
|
414
|
+
-
|
|
415
|
+
"name": "offerId"
|
|
416
|
+
"type": "number"
|
|
417
|
+
"description": "Trade offer ID"
|
|
418
|
+
"mutation": {}
|
|
419
|
+
"ai_notes": []
|
|
420
|
+
-
|
|
421
|
+
"name": "priceAmount"
|
|
422
|
+
"type": "number"
|
|
423
|
+
"description": "Price value in order currency"
|
|
424
|
+
"mutation": {}
|
|
425
|
+
"ai_notes": []
|
|
426
|
+
-
|
|
427
|
+
"name": "priceTypeCode"
|
|
428
|
+
"type": "string"
|
|
429
|
+
"description": "Character price type code"
|
|
430
|
+
"mutation": {}
|
|
431
|
+
"ai_notes": []
|
|
432
|
+
-
|
|
433
|
+
"name": "quantity"
|
|
434
|
+
"type": "number"
|
|
435
|
+
"description": "Item quantity"
|
|
436
|
+
"mutation": {}
|
|
437
|
+
"ai_notes": []
|
|
438
|
+
-
|
|
439
|
+
"name": "Discount"
|
|
440
|
+
"fields":
|
|
441
|
+
-
|
|
442
|
+
"name": "type"
|
|
443
|
+
"type": "\"bonus_charge\"|\"loyalty_event\"|\"loyalty_level\"|\"manual_order\"|\"manual_product\"|\"personal\"|\"round\""
|
|
444
|
+
"description": "Discount type"
|
|
445
|
+
"mutation": {}
|
|
446
|
+
"ai_notes": []
|
|
447
|
+
-
|
|
448
|
+
"name": "amount"
|
|
449
|
+
"type": "number"
|
|
450
|
+
"description": "Discount amount"
|
|
451
|
+
"mutation": {}
|
|
452
|
+
"ai_notes": []
|
|
453
|
+
-
|
|
454
|
+
"name": "Offer"
|
|
455
|
+
"fields":
|
|
456
|
+
-
|
|
457
|
+
"name": "id"
|
|
458
|
+
"type": "number"
|
|
459
|
+
"description": "ID"
|
|
460
|
+
"mutation": {}
|
|
461
|
+
"ai_notes": []
|
|
462
|
+
-
|
|
463
|
+
"name": "name"
|
|
464
|
+
"type": "string"
|
|
465
|
+
"description": "Name"
|
|
466
|
+
"mutation": {}
|
|
467
|
+
"ai_notes": []
|
|
468
|
+
-
|
|
469
|
+
"name": "image"
|
|
470
|
+
"type": "string|null"
|
|
471
|
+
"description": "Image URL"
|
|
472
|
+
"mutation": {}
|
|
473
|
+
"ai_notes": []
|
|
474
|
+
-
|
|
475
|
+
"name": "dimensions"
|
|
476
|
+
"type": "Dimensions"
|
|
477
|
+
"description": "Product dimensions L - length, W - width, H - height"
|
|
478
|
+
"mutation": {}
|
|
479
|
+
"ai_notes": []
|
|
480
|
+
-
|
|
481
|
+
"name": "weight"
|
|
482
|
+
"type": "Weight|null"
|
|
483
|
+
"description": "Weight"
|
|
484
|
+
"mutation": {}
|
|
485
|
+
"ai_notes": []
|
|
486
|
+
-
|
|
487
|
+
"name": "article"
|
|
488
|
+
"type": "string|null"
|
|
489
|
+
"description": "Article"
|
|
490
|
+
"mutation": {}
|
|
491
|
+
"ai_notes": []
|
|
492
|
+
-
|
|
493
|
+
"name": "barcode"
|
|
494
|
+
"type": "string|null"
|
|
495
|
+
"description": "Barcode"
|
|
496
|
+
"mutation": {}
|
|
497
|
+
"ai_notes": []
|
|
498
|
+
-
|
|
499
|
+
"name": "properties"
|
|
500
|
+
"type": "Array<Property>"
|
|
501
|
+
"description": "Array of custom properties"
|
|
502
|
+
"mutation": {}
|
|
503
|
+
"ai_notes": []
|
|
504
|
+
-
|
|
505
|
+
"name": "unit"
|
|
506
|
+
"type": "string|null"
|
|
507
|
+
"description": "Unit of quantity measurement, if not specified (null), will be set to \"pcs.\""
|
|
508
|
+
"mutation": {}
|
|
509
|
+
"ai_notes": []
|
|
510
|
+
-
|
|
511
|
+
"name": "purchasePrice"
|
|
512
|
+
"type": "Money|null"
|
|
513
|
+
"description": "Purchase price, value + currency"
|
|
514
|
+
"mutation": {}
|
|
515
|
+
"ai_notes": []
|
|
516
|
+
-
|
|
517
|
+
"name": "PriceType"
|
|
518
|
+
"fields":
|
|
519
|
+
-
|
|
520
|
+
"name": "id"
|
|
521
|
+
"type": "number"
|
|
522
|
+
"description": "ID"
|
|
523
|
+
"mutation": {}
|
|
524
|
+
"ai_notes": []
|
|
525
|
+
-
|
|
526
|
+
"name": "code"
|
|
527
|
+
"type": "string"
|
|
528
|
+
"description": "Character code"
|
|
529
|
+
"mutation": {}
|
|
530
|
+
"ai_notes": []
|
|
531
|
+
-
|
|
532
|
+
"name": "name"
|
|
533
|
+
"type": "string"
|
|
534
|
+
"description": "Name"
|
|
535
|
+
"mutation": {}
|
|
536
|
+
"ai_notes": []
|
|
537
|
+
-
|
|
538
|
+
"name": "title"
|
|
539
|
+
"type": "string"
|
|
540
|
+
"description": "Title"
|
|
541
|
+
"mutation": {}
|
|
542
|
+
"ai_notes": []
|
|
543
|
+
-
|
|
544
|
+
"name": "default"
|
|
545
|
+
"type": "boolean"
|
|
546
|
+
"description": "Whether this type is the default price type"
|
|
547
|
+
"mutation": {}
|
|
548
|
+
"ai_notes": []
|
|
549
|
+
-
|
|
550
|
+
"name": "currency"
|
|
551
|
+
"type": "string"
|
|
552
|
+
"description": "Currency code (USD/EUR/...)"
|
|
553
|
+
"mutation": {}
|
|
554
|
+
"ai_notes": []
|
|
555
|
+
-
|
|
556
|
+
"name": "Property"
|
|
557
|
+
"fields":
|
|
558
|
+
-
|
|
559
|
+
"name": "code"
|
|
560
|
+
"type": "string"
|
|
561
|
+
"description": "Character code"
|
|
562
|
+
"mutation": {}
|
|
563
|
+
"ai_notes": []
|
|
564
|
+
-
|
|
565
|
+
"name": "name"
|
|
566
|
+
"type": "string"
|
|
567
|
+
"description": "Name"
|
|
568
|
+
"mutation": {}
|
|
569
|
+
"ai_notes": []
|
|
570
|
+
-
|
|
571
|
+
"name": "value"
|
|
572
|
+
"type": "string"
|
|
573
|
+
"description": "Value"
|
|
574
|
+
"mutation": {}
|
|
575
|
+
"ai_notes": []
|
|
576
|
+
-
|
|
577
|
+
"name": "Product"
|
|
578
|
+
"fields":
|
|
579
|
+
-
|
|
580
|
+
"name": "id"
|
|
581
|
+
"type": "number"
|
|
582
|
+
"description": "ID"
|
|
583
|
+
"mutation": {}
|
|
584
|
+
"ai_notes": []
|
|
585
|
+
-
|
|
586
|
+
"name": "type"
|
|
587
|
+
"type": "\"PRODUCT\"|\"SERVICE\""
|
|
588
|
+
"description": "Type - product or service"
|
|
589
|
+
"mutation": {}
|
|
590
|
+
"ai_notes": []
|
|
591
|
+
-
|
|
592
|
+
"name": "name"
|
|
593
|
+
"type": "string"
|
|
594
|
+
"description": "Name"
|
|
595
|
+
"mutation": {}
|
|
596
|
+
"ai_notes": []
|
|
597
|
+
-
|
|
598
|
+
"name": "image"
|
|
599
|
+
"type": "string|null"
|
|
600
|
+
"description": "Image URL"
|
|
601
|
+
"mutation": {}
|
|
602
|
+
"ai_notes": []
|
|
603
|
+
-
|
|
604
|
+
"name": "article"
|
|
605
|
+
"type": "string|null"
|
|
606
|
+
"description": "Article"
|
|
607
|
+
"mutation": {}
|
|
608
|
+
"ai_notes": []
|
|
609
|
+
-
|
|
610
|
+
"name": "manufacturer"
|
|
611
|
+
"type": "string|null"
|
|
612
|
+
"description": "Manufacturer name"
|
|
613
|
+
"mutation": {}
|
|
614
|
+
"ai_notes": []
|
|
615
|
+
-
|
|
616
|
+
"name": "markable"
|
|
617
|
+
"type": "boolean"
|
|
618
|
+
"description": "Marking requirement"
|
|
619
|
+
"mutation": {}
|
|
620
|
+
"ai_notes": []
|
|
621
|
+
-
|
|
622
|
+
"name": "groups"
|
|
623
|
+
"type": "Array<ProductGroup>"
|
|
624
|
+
"description": "Groups this product or service belongs to"
|
|
625
|
+
"mutation": {}
|
|
626
|
+
"ai_notes": []
|
|
627
|
+
-
|
|
628
|
+
"name": "unit"
|
|
629
|
+
"type": "string|null"
|
|
630
|
+
"description": "Unit of quantity measurement, if not specified (null), will be set to \"pcs.\""
|
|
631
|
+
"mutation": {}
|
|
632
|
+
"ai_notes": []
|
|
633
|
+
-
|
|
634
|
+
"name": "url"
|
|
635
|
+
"type": "string|null"
|
|
636
|
+
"description": "Link to product/service page in store"
|
|
637
|
+
"mutation": {}
|
|
638
|
+
"ai_notes": []
|
|
639
|
+
-
|
|
640
|
+
"name": "ProductGroup"
|
|
641
|
+
"fields":
|
|
642
|
+
-
|
|
643
|
+
"name": "id"
|
|
644
|
+
"type": "number"
|
|
645
|
+
"description": "ID"
|
|
646
|
+
"mutation": {}
|
|
647
|
+
"ai_notes": []
|
|
648
|
+
-
|
|
649
|
+
"name": "name"
|
|
650
|
+
"type": "string"
|
|
651
|
+
"description": "Name"
|
|
652
|
+
"mutation": {}
|
|
653
|
+
"ai_notes": []
|
|
654
|
+
-
|
|
655
|
+
"name": "OrderItem"
|
|
656
|
+
"fields":
|
|
657
|
+
-
|
|
658
|
+
"name": "id"
|
|
659
|
+
"type": "number|null"
|
|
660
|
+
"description": "ID"
|
|
661
|
+
"mutation": {}
|
|
662
|
+
"ai_notes": []
|
|
663
|
+
-
|
|
664
|
+
"name": "index"
|
|
665
|
+
"type": "number"
|
|
666
|
+
"description": "Temporary ID while editing order"
|
|
667
|
+
"mutation": {}
|
|
668
|
+
"ai_notes":
|
|
669
|
+
- "Temporary item identifier used by order/card item action calls."
|
|
670
|
+
-
|
|
671
|
+
"name": "type"
|
|
672
|
+
"type": "\"PRODUCT\"|\"SERVICE\""
|
|
673
|
+
"description": "Item type - product or service"
|
|
674
|
+
"mutation": {}
|
|
675
|
+
"ai_notes": []
|
|
676
|
+
-
|
|
677
|
+
"name": "offer"
|
|
678
|
+
"type": "Offer|null"
|
|
679
|
+
"description": "Trade offer for selected product or service"
|
|
680
|
+
"mutation": {}
|
|
681
|
+
"ai_notes":
|
|
682
|
+
- "Trade offer data for SKU-level logic, promotions and UI display. It can be null."
|
|
683
|
+
-
|
|
684
|
+
"name": "product"
|
|
685
|
+
"type": "Product|null"
|
|
686
|
+
"description": "Selected product or service"
|
|
687
|
+
"mutation": {}
|
|
688
|
+
"ai_notes":
|
|
689
|
+
- "Product data for product logic, promotions and UI display. It can be null."
|
|
690
|
+
-
|
|
691
|
+
"name": "properties"
|
|
692
|
+
"type": "Array<Property>"
|
|
693
|
+
"description": "Array of custom properties"
|
|
694
|
+
"mutation": {}
|
|
695
|
+
"ai_notes": []
|
|
696
|
+
-
|
|
697
|
+
"name": "quantity"
|
|
698
|
+
"type": "number"
|
|
699
|
+
"description": "Item quantity"
|
|
700
|
+
"mutation":
|
|
701
|
+
"mode": "action"
|
|
702
|
+
"action": "changeItemQuantity"
|
|
703
|
+
"notes": "Use changeItemQuantity(index, quantity) to change item quantity."
|
|
704
|
+
"ai_notes": []
|
|
705
|
+
-
|
|
706
|
+
"name": "purchasePrice"
|
|
707
|
+
"type": "Money|null"
|
|
708
|
+
"description": "Purchase price, value + currency"
|
|
709
|
+
"mutation": {}
|
|
710
|
+
"ai_notes": []
|
|
711
|
+
-
|
|
712
|
+
"name": "initialPrice"
|
|
713
|
+
"type": "Money|null"
|
|
714
|
+
"description": "Product/SKU price (in object currency)"
|
|
715
|
+
"mutation": {}
|
|
716
|
+
"ai_notes": []
|
|
717
|
+
-
|
|
718
|
+
"name": "priceType"
|
|
719
|
+
"type": "PriceType|null"
|
|
720
|
+
"description": "Price type"
|
|
721
|
+
"mutation":
|
|
722
|
+
"mode": "action"
|
|
723
|
+
"action": "changeItemPriceType"
|
|
724
|
+
"notes": "Use changeItemPriceType(index, code) to change item price type."
|
|
725
|
+
"ai_notes": []
|
|
726
|
+
-
|
|
727
|
+
"name": "bonusesChargeTotal"
|
|
728
|
+
"type": "number"
|
|
729
|
+
"description": "Amount of charged bonuses"
|
|
730
|
+
"mutation": {}
|
|
731
|
+
"ai_notes": []
|
|
732
|
+
-
|
|
733
|
+
"name": "bonusesCreditTotal"
|
|
734
|
+
"type": "number"
|
|
735
|
+
"description": "Amount of credited bonuses"
|
|
736
|
+
"mutation": {}
|
|
737
|
+
"ai_notes": []
|
|
738
|
+
-
|
|
739
|
+
"name": "discounts"
|
|
740
|
+
"type": "Array<Discount>"
|
|
741
|
+
"description": "Array of discounts applied to the item"
|
|
742
|
+
"mutation":
|
|
743
|
+
"mode": "action"
|
|
744
|
+
"action": "changeItemDiscount"
|
|
745
|
+
"notes": "Use changeItemDiscount when item discount mutation is available."
|
|
746
|
+
"ai_notes": []
|
|
747
|
+
-
|
|
748
|
+
"name": "discountTotal"
|
|
749
|
+
"type": "number"
|
|
750
|
+
"description": "Final monetary discount per unit considering all product and order discounts (in object currency)"
|
|
751
|
+
"mutation":
|
|
752
|
+
"mode": "readonly"
|
|
753
|
+
"notes": "Readonly calculated item discount total."
|
|
754
|
+
"ai_notes": []
|
|
755
|
+
-
|
|
756
|
+
"name": "vatRate"
|
|
757
|
+
"type": "\"none\"|number | `${number}`"
|
|
758
|
+
"description": "VAT rate"
|
|
759
|
+
"mutation": {}
|
|
760
|
+
"ai_notes": []
|
|
761
|
+
-
|
|
762
|
+
"name": "vatSum"
|
|
763
|
+
"type": "number"
|
|
764
|
+
"description": "VAT amount"
|
|
765
|
+
"mutation": {}
|
|
766
|
+
"ai_notes": []
|
|
767
|
+
-
|
|
768
|
+
"name": "comment"
|
|
769
|
+
"type": "string"
|
|
770
|
+
"description": "Comment"
|
|
771
|
+
"mutation": {}
|
|
772
|
+
"ai_notes": []
|
|
773
|
+
-
|
|
774
|
+
"name": "status"
|
|
775
|
+
"type": "OrderItemStatus|null"
|
|
776
|
+
"description": "Status"
|
|
777
|
+
"mutation": {}
|
|
778
|
+
"ai_notes": []
|
|
779
|
+
-
|
|
780
|
+
"name": "OrderItemStatus"
|
|
781
|
+
"fields":
|
|
782
|
+
-
|
|
783
|
+
"name": "id"
|
|
784
|
+
"type": "number"
|
|
785
|
+
"description": "ID"
|
|
786
|
+
"mutation": {}
|
|
787
|
+
"ai_notes": []
|
|
788
|
+
-
|
|
789
|
+
"name": "code"
|
|
790
|
+
"type": "string"
|
|
791
|
+
"description": "Character code"
|
|
792
|
+
"mutation": {}
|
|
793
|
+
"ai_notes": []
|
|
794
|
+
-
|
|
795
|
+
"name": "name"
|
|
796
|
+
"type": "string"
|
|
797
|
+
"description": "Name"
|
|
798
|
+
"mutation": {}
|
|
799
|
+
"ai_notes": []
|
|
800
|
+
-
|
|
801
|
+
"name": "isCancel"
|
|
802
|
+
"type": "boolean"
|
|
803
|
+
"description": "Whether the status cancels the item"
|
|
804
|
+
"mutation": {}
|
|
805
|
+
"ai_notes": []
|
|
806
|
+
"usage":
|
|
807
|
+
"import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/order/card'"
|
|
808
|
+
"call": "const order = useContext()"
|
|
809
|
+
"related_actions":
|
|
810
|
+
-
|
|
811
|
+
"scope": "order/card"
|
|
812
|
+
"uri": "embed-ui-v1-contexts://actions/order%2Fcard"
|
|
813
|
+
"ai_notes":
|
|
814
|
+
- "Use this context as the source of truth for data already present in the order form."
|
|
815
|
+
- "Use order/card actions for item mutations instead of trying to write the readonly items field."
|