· 7 years ago · Feb 21, 2019, 10:54 AM
1openapi: 3.0.0
2x-origin:
3 - url: http://localhost:3000/explorer/swagger.json
4 format: swagger
5 version: "2.0"
6 converter:
7 url: https://github.com/mermade/oas-kit
8 version: 5.2.2
9info:
10 version: 3.3.16
11 title: saitama
12 description: LoopBack Application
13paths:
14 /Status/get-status:
15 get:
16 tags:
17 - Status
18 summary: "[DEPRECATED] Get the latest environmental status of the server."
19 operationId: Status.getStatus
20 responses:
21 "200":
22 description: Request was successful
23 content:
24 application/json:
25 schema:
26 type: object
27 application/xml:
28 schema:
29 type: object
30 text/xml:
31 schema:
32 type: object
33 application/javascript:
34 schema:
35 type: object
36 text/javascript:
37 schema:
38 type: object
39 deprecated: false
40 /Status/health:
41 get:
42 tags:
43 - Status
44 summary: Get the current server health.
45 operationId: Status.healthCheck
46 responses:
47 "200":
48 description: Request was successful
49 content:
50 application/json:
51 schema:
52 type: object
53 application/xml:
54 schema:
55 type: object
56 text/xml:
57 schema:
58 type: object
59 application/javascript:
60 schema:
61 type: object
62 text/javascript:
63 schema:
64 type: object
65 deprecated: false
66 "/customers/{id}":
67 get:
68 tags:
69 - Customer
70 summary: Get a customer by it's id.
71 operationId: Customer.findById
72 parameters:
73 - name: id
74 in: path
75 required: true
76 schema:
77 type: string
78 responses:
79 "200":
80 description: Request was successful
81 content:
82 application/json:
83 schema:
84 $ref: "#/components/schemas/Customer"
85 application/xml:
86 schema:
87 $ref: "#/components/schemas/Customer"
88 text/xml:
89 schema:
90 $ref: "#/components/schemas/Customer"
91 application/javascript:
92 schema:
93 $ref: "#/components/schemas/Customer"
94 text/javascript:
95 schema:
96 $ref: "#/components/schemas/Customer"
97 deprecated: false
98 /customers:
99 put:
100 tags:
101 - Customer
102 summary: Update the current logged-in customer on it's respective tenant
103 operationId: Customer.update
104 requestBody:
105 $ref: "#/components/requestBodies/Customer.updateBody"
106 responses:
107 "200":
108 description: Request was successful
109 content:
110 application/json:
111 schema:
112 $ref: "#/components/schemas/Customer"
113 application/xml:
114 schema:
115 $ref: "#/components/schemas/Customer"
116 text/xml:
117 schema:
118 $ref: "#/components/schemas/Customer"
119 application/javascript:
120 schema:
121 $ref: "#/components/schemas/Customer"
122 text/javascript:
123 schema:
124 $ref: "#/components/schemas/Customer"
125 deprecated: false
126 /customers/properties:
127 put:
128 tags:
129 - Customer
130 summary: Update the current logged-in customer properties.
131 operationId: Customer.updateProperties
132 requestBody:
133 $ref: "#/components/requestBodies/Customer.updateBody"
134 responses:
135 "200":
136 description: Request was successful
137 content:
138 application/json:
139 schema:
140 $ref: "#/components/schemas/Customer"
141 application/xml:
142 schema:
143 $ref: "#/components/schemas/Customer"
144 text/xml:
145 schema:
146 $ref: "#/components/schemas/Customer"
147 application/javascript:
148 schema:
149 $ref: "#/components/schemas/Customer"
150 text/javascript:
151 schema:
152 $ref: "#/components/schemas/Customer"
153 deprecated: false
154 "/customers/{id}/update-properties":
155 put:
156 tags:
157 - Customer
158 summary: Update the customer properties by id.
159 operationId: Customer.updatePropertiesById
160 parameters:
161 - name: id
162 in: path
163 required: true
164 schema:
165 type: string
166 requestBody:
167 $ref: "#/components/requestBodies/Customer.updateBody"
168 responses:
169 "200":
170 description: Request was successful
171 content:
172 application/json:
173 schema:
174 $ref: "#/components/schemas/Customer"
175 application/xml:
176 schema:
177 $ref: "#/components/schemas/Customer"
178 text/xml:
179 schema:
180 $ref: "#/components/schemas/Customer"
181 application/javascript:
182 schema:
183 $ref: "#/components/schemas/Customer"
184 text/javascript:
185 schema:
186 $ref: "#/components/schemas/Customer"
187 deprecated: false
188 /customers/address/check:
189 post:
190 tags:
191 - Customer
192 summary: Checks and creates address for current logged in user.
193 operationId: Customer.checkAddress
194 requestBody:
195 $ref: "#/components/requestBodies/Customer.updateBody"
196 responses:
197 "200":
198 description: Request was successful
199 content:
200 application/json:
201 schema:
202 type: object
203 application/xml:
204 schema:
205 type: object
206 text/xml:
207 schema:
208 type: object
209 application/javascript:
210 schema:
211 type: object
212 text/javascript:
213 schema:
214 type: object
215 deprecated: false
216 /customers/address:
217 get:
218 tags:
219 - Customer
220 summary: Get current customer's selected address.
221 operationId: Customer.getCurrentAddress
222 responses:
223 "200":
224 description: Request was successful
225 content:
226 application/json:
227 schema:
228 type: object
229 application/xml:
230 schema:
231 type: object
232 text/xml:
233 schema:
234 type: object
235 application/javascript:
236 schema:
237 type: object
238 text/javascript:
239 schema:
240 type: object
241 deprecated: false
242 /customers/store:
243 get:
244 tags:
245 - Customer
246 summary: Get current customer's selected store.
247 operationId: Customer.getCurrentStore
248 responses:
249 "200":
250 description: Request was successful
251 content:
252 application/json:
253 schema:
254 type: object
255 application/xml:
256 schema:
257 type: object
258 text/xml:
259 schema:
260 type: object
261 application/javascript:
262 schema:
263 type: object
264 text/javascript:
265 schema:
266 type: object
267 deprecated: false
268 /customers/last-order:
269 get:
270 tags:
271 - Customer
272 summary: Get current customer's last order.
273 operationId: Customer.getLastOrder
274 responses:
275 "200":
276 description: Request was successful
277 content:
278 application/json:
279 schema:
280 type: object
281 application/xml:
282 schema:
283 type: object
284 text/xml:
285 schema:
286 type: object
287 application/javascript:
288 schema:
289 type: object
290 text/javascript:
291 schema:
292 type: object
293 deprecated: false
294 "/customers/{id}/change-budget":
295 put:
296 tags:
297 - Customer
298 summary: Changes the budget of the user and creates a budgetlog
299 operationId: Customer.changeBudget
300 parameters:
301 - name: id
302 in: path
303 required: true
304 schema:
305 type: string
306 requestBody:
307 content:
308 application/x-www-form-urlencoded:
309 schema:
310 type: object
311 properties:
312 amount:
313 type: number
314 format: double
315 reason:
316 type: string
317 paymentId:
318 type: string
319 allowNegative:
320 description: throws an error if the resulting budget is less than zero
321 type: boolean
322 default: true
323 required:
324 - amount
325 - reason
326 responses:
327 "200":
328 description: Request was successful
329 content:
330 application/json:
331 schema:
332 $ref: "#/components/schemas/Customer"
333 application/xml:
334 schema:
335 $ref: "#/components/schemas/Customer"
336 text/xml:
337 schema:
338 $ref: "#/components/schemas/Customer"
339 application/javascript:
340 schema:
341 $ref: "#/components/schemas/Customer"
342 text/javascript:
343 schema:
344 $ref: "#/components/schemas/Customer"
345 deprecated: false
346 /customers/order-history:
347 get:
348 tags:
349 - Customer
350 summary: Gets the orders of the current user
351 operationId: Customer.orderHistory
352 parameters:
353 - name: limit
354 in: query
355 required: false
356 schema:
357 type: number
358 format: double
359 - name: page
360 in: query
361 required: false
362 schema:
363 type: number
364 format: double
365 responses:
366 "200":
367 description: Request was successful
368 content:
369 application/json:
370 schema:
371 type: array
372 items:
373 $ref: "#/components/schemas/x-any"
374 application/xml:
375 schema:
376 type: array
377 items:
378 $ref: "#/components/schemas/x-any"
379 text/xml:
380 schema:
381 type: array
382 items:
383 $ref: "#/components/schemas/x-any"
384 application/javascript:
385 schema:
386 type: array
387 items:
388 $ref: "#/components/schemas/x-any"
389 text/javascript:
390 schema:
391 type: array
392 items:
393 $ref: "#/components/schemas/x-any"
394 deprecated: false
395 "/customers/{storeBrandId}/most-bought":
396 get:
397 tags:
398 - Customer
399 summary: Gets the orders of the user by id
400 operationId: Customer.mostBoughtProducts
401 parameters:
402 - name: storeBrandId
403 in: path
404 required: true
405 schema:
406 type: string
407 - name: limit
408 in: query
409 required: false
410 schema:
411 type: number
412 format: double
413 - name: page
414 in: query
415 required: false
416 schema:
417 type: number
418 format: double
419 responses:
420 "200":
421 description: Request was successful
422 content:
423 application/json:
424 schema:
425 type: array
426 items:
427 $ref: "#/components/schemas/x-any"
428 application/xml:
429 schema:
430 type: array
431 items:
432 $ref: "#/components/schemas/x-any"
433 text/xml:
434 schema:
435 type: array
436 items:
437 $ref: "#/components/schemas/x-any"
438 application/javascript:
439 schema:
440 type: array
441 items:
442 $ref: "#/components/schemas/x-any"
443 text/javascript:
444 schema:
445 type: array
446 items:
447 $ref: "#/components/schemas/x-any"
448 deprecated: false
449 "/customers/{tenant}/{id}/detail":
450 get:
451 tags:
452 - Customer
453 summary: get the full detail of the customer
454 operationId: Customer.detail
455 parameters:
456 - name: id
457 in: path
458 required: true
459 schema:
460 type: string
461 - name: tenant
462 in: path
463 required: true
464 schema:
465 type: string
466 responses:
467 "200":
468 description: Request was successful
469 content:
470 application/json:
471 schema:
472 $ref: "#/components/schemas/Customer"
473 application/xml:
474 schema:
475 $ref: "#/components/schemas/Customer"
476 text/xml:
477 schema:
478 $ref: "#/components/schemas/Customer"
479 application/javascript:
480 schema:
481 $ref: "#/components/schemas/Customer"
482 text/javascript:
483 schema:
484 $ref: "#/components/schemas/Customer"
485 deprecated: false
486 /customers/budget-log:
487 get:
488 tags:
489 - Customer
490 summary: get the full budget log of the customer by id
491 operationId: Customer.budgetLog
492 responses:
493 "200":
494 description: Request was successful
495 content:
496 application/json:
497 schema:
498 type: array
499 items:
500 type: object
501 application/xml:
502 schema:
503 type: array
504 items:
505 type: object
506 text/xml:
507 schema:
508 type: array
509 items:
510 type: object
511 application/javascript:
512 schema:
513 type: array
514 items:
515 type: object
516 text/javascript:
517 schema:
518 type: array
519 items:
520 type: object
521 deprecated: false
522 "/customers/{id}/budget-log":
523 get:
524 tags:
525 - Customer
526 summary: get the full budget log of the customer
527 operationId: Customer.budgetLogByCustomerId
528 parameters:
529 - name: id
530 in: path
531 required: true
532 schema:
533 type: string
534 - name: limit
535 in: query
536 required: false
537 schema:
538 type: number
539 format: double
540 - name: skip
541 in: query
542 required: false
543 schema:
544 type: number
545 format: double
546 responses:
547 "200":
548 description: Request was successful
549 content:
550 application/json:
551 schema:
552 type: array
553 items:
554 type: object
555 application/xml:
556 schema:
557 type: array
558 items:
559 type: object
560 text/xml:
561 schema:
562 type: array
563 items:
564 type: object
565 application/javascript:
566 schema:
567 type: array
568 items:
569 type: object
570 text/javascript:
571 schema:
572 type: array
573 items:
574 type: object
575 deprecated: false
576 /customers/search:
577 get:
578 tags:
579 - Customer
580 summary: Queries Customer in ES
581 operationId: Customer.search
582 parameters:
583 - name: query
584 in: query
585 required: false
586 schema:
587 type: string
588 - name: filters
589 in: query
590 required: false
591 schema:
592 type: string
593 format: JSON
594 - name: sort
595 in: query
596 required: false
597 schema:
598 type: string
599 format: JSON
600 - name: limit
601 in: query
602 required: false
603 schema:
604 type: number
605 format: double
606 - name: skip
607 in: query
608 required: false
609 schema:
610 type: number
611 format: double
612 responses:
613 "200":
614 description: Request was successful
615 content:
616 application/json:
617 schema:
618 type: object
619 application/xml:
620 schema:
621 type: object
622 text/xml:
623 schema:
624 type: object
625 application/javascript:
626 schema:
627 type: object
628 text/javascript:
629 schema:
630 type: object
631 deprecated: false
632 "/customers/{id}/finance-summary":
633 get:
634 tags:
635 - Customer
636 summary: Gets a summary of the financial data of the customer
637 operationId: Customer.financeSummary
638 parameters:
639 - name: id
640 in: path
641 required: true
642 schema:
643 type: string
644 responses:
645 "200":
646 description: Request was successful
647 content:
648 application/json:
649 schema:
650 type: object
651 application/xml:
652 schema:
653 type: object
654 text/xml:
655 schema:
656 type: object
657 application/javascript:
658 schema:
659 type: object
660 text/javascript:
661 schema:
662 type: object
663 deprecated: false
664 /customers/salesforce-contact-case:
665 post:
666 tags:
667 - Customer
668 summary: Create a case in salesforce from the contact form.
669 operationId: Customer.salesForceContactCase
670 requestBody:
671 $ref: "#/components/requestBodies/Customer.updateBody"
672 responses:
673 "200":
674 description: Request was successful
675 content:
676 application/json:
677 schema:
678 type: object
679 application/xml:
680 schema:
681 type: object
682 text/xml:
683 schema:
684 type: object
685 application/javascript:
686 schema:
687 type: object
688 text/javascript:
689 schema:
690 type: object
691 deprecated: false
692 "/customers/{id}/timezone":
693 get:
694 tags:
695 - Customer
696 summary: Gets the timezone of the user.
697 operationId: Customer.timezone
698 parameters:
699 - name: id
700 in: path
701 required: true
702 schema:
703 type: string
704 responses:
705 "200":
706 description: Request was successful
707 content:
708 application/json:
709 schema:
710 type: object
711 properties:
712 timezone:
713 type: string
714 application/xml:
715 schema:
716 type: object
717 properties:
718 timezone:
719 type: string
720 text/xml:
721 schema:
722 type: object
723 properties:
724 timezone:
725 type: string
726 application/javascript:
727 schema:
728 type: object
729 properties:
730 timezone:
731 type: string
732 text/javascript:
733 schema:
734 type: object
735 properties:
736 timezone:
737 type: string
738 deprecated: false
739 /customers/is-subscribed:
740 get:
741 tags:
742 - Customer
743 summary: Check if the current user has an active subscription
744 operationId: Customer.isSubscribed
745 responses:
746 "200":
747 description: Request was successful
748 content:
749 application/json:
750 schema:
751 $ref: "#/components/schemas/Customer"
752 application/xml:
753 schema:
754 $ref: "#/components/schemas/Customer"
755 text/xml:
756 schema:
757 $ref: "#/components/schemas/Customer"
758 application/javascript:
759 schema:
760 $ref: "#/components/schemas/Customer"
761 text/javascript:
762 schema:
763 $ref: "#/components/schemas/Customer"
764 deprecated: false
765 /carts/process:
766 post:
767 tags:
768 - Cart
769 summary: Validate products and apply specialties to cart
770 operationId: Cart.process
771 requestBody:
772 $ref: "#/components/requestBodies/Customer.updateBody"
773 responses:
774 "200":
775 description: Request was successful
776 content:
777 application/json:
778 schema:
779 type: object
780 application/xml:
781 schema:
782 type: object
783 text/xml:
784 schema:
785 type: object
786 application/javascript:
787 schema:
788 type: object
789 text/javascript:
790 schema:
791 type: object
792 deprecated: false
793 /carts:
794 get:
795 tags:
796 - Cart
797 summary: Get current user's cart.
798 operationId: Cart.get
799 parameters:
800 - name: guestData
801 in: query
802 required: false
803 schema:
804 type: string
805 format: JSON
806 responses:
807 "200":
808 description: Request was successful
809 content:
810 application/json:
811 schema:
812 type: object
813 application/xml:
814 schema:
815 type: object
816 text/xml:
817 schema:
818 type: object
819 application/javascript:
820 schema:
821 type: object
822 text/javascript:
823 schema:
824 type: object
825 deprecated: false
826 /carts/clear:
827 delete:
828 tags:
829 - Cart
830 summary: Clear the current user's cart.
831 operationId: Cart.clear
832 requestBody:
833 content:
834 application/x-www-form-urlencoded:
835 schema:
836 type: object
837 properties:
838 guestData:
839 type: string
840 format: JSON
841 responses:
842 "200":
843 description: Request was successful
844 content:
845 application/json:
846 schema:
847 type: object
848 application/xml:
849 schema:
850 type: object
851 text/xml:
852 schema:
853 type: object
854 application/javascript:
855 schema:
856 type: object
857 text/javascript:
858 schema:
859 type: object
860 deprecated: false
861 /carts/product:
862 put:
863 tags:
864 - Cart
865 summary: Add or change quantity of product in user's cart.
866 operationId: Cart.setProductQuantity
867 requestBody:
868 content:
869 application/x-www-form-urlencoded:
870 schema:
871 type: object
872 properties:
873 guestData:
874 type: string
875 format: JSON
876 productId:
877 type: string
878 quantity:
879 type: number
880 format: double
881 required:
882 - productId
883 - quantity
884 responses:
885 "200":
886 description: Request was successful
887 content:
888 application/json:
889 schema:
890 type: object
891 application/xml:
892 schema:
893 type: object
894 text/xml:
895 schema:
896 type: object
897 application/javascript:
898 schema:
899 type: object
900 text/javascript:
901 schema:
902 type: object
903 deprecated: false
904 /carts/products/remove:
905 put:
906 tags:
907 - Cart
908 summary: Remove multiple products from cart
909 operationId: Cart.removeProducts
910 requestBody:
911 $ref: "#/components/requestBodies/Customer.updateBody"
912 responses:
913 "200":
914 description: Request was successful
915 content:
916 application/json:
917 schema:
918 type: object
919 application/xml:
920 schema:
921 type: object
922 text/xml:
923 schema:
924 type: object
925 application/javascript:
926 schema:
927 type: object
928 text/javascript:
929 schema:
930 type: object
931 deprecated: false
932 /carts/force-new-order:
933 put:
934 tags:
935 - Cart
936 summary: Marks previous order as being live updated
937 operationId: Cart.forceNewOrder
938 responses:
939 "200":
940 description: Request was successful
941 content:
942 application/json:
943 schema:
944 type: object
945 application/xml:
946 schema:
947 type: object
948 text/xml:
949 schema:
950 type: object
951 application/javascript:
952 schema:
953 type: object
954 text/javascript:
955 schema:
956 type: object
957 deprecated: false
958 /Addresses/check:
959 post:
960 tags:
961 - Address
962 summary: Get an address based on postcode, houseNumber and houseNumberAddition
963 operationId: Address.check
964 requestBody:
965 $ref: "#/components/requestBodies/Customer.updateBody"
966 responses:
967 "200":
968 description: Request was successful
969 content:
970 application/json:
971 schema:
972 type: object
973 application/xml:
974 schema:
975 type: object
976 text/xml:
977 schema:
978 type: object
979 application/javascript:
980 schema:
981 type: object
982 text/javascript:
983 schema:
984 type: object
985 deprecated: false
986 /Addresses/get-by-id:
987 get:
988 tags:
989 - Address
990 summary: Get an address object
991 operationId: Address.getById
992 parameters:
993 - name: addressId
994 in: query
995 required: true
996 schema:
997 type: string
998 - name: tenant
999 in: query
1000 required: true
1001 schema:
1002 type: string
1003 responses:
1004 "200":
1005 description: Request was successful
1006 content:
1007 application/json:
1008 schema:
1009 type: object
1010 application/xml:
1011 schema:
1012 type: object
1013 text/xml:
1014 schema:
1015 type: object
1016 application/javascript:
1017 schema:
1018 type: object
1019 text/javascript:
1020 schema:
1021 type: object
1022 deprecated: false
1023 /Categories/headers:
1024 get:
1025 tags:
1026 - Category
1027 summary: Gets all internal categories of a brand with their children
1028 operationId: Category.headers
1029 parameters:
1030 - name: brandId
1031 in: query
1032 required: true
1033 schema:
1034 type: string
1035 responses:
1036 "200":
1037 description: Request was successful
1038 content:
1039 application/json:
1040 schema:
1041 type: array
1042 items:
1043 $ref: "#/components/schemas/Category"
1044 application/xml:
1045 schema:
1046 type: array
1047 items:
1048 $ref: "#/components/schemas/Category"
1049 text/xml:
1050 schema:
1051 type: array
1052 items:
1053 $ref: "#/components/schemas/Category"
1054 application/javascript:
1055 schema:
1056 type: array
1057 items:
1058 $ref: "#/components/schemas/Category"
1059 text/javascript:
1060 schema:
1061 type: array
1062 items:
1063 $ref: "#/components/schemas/Category"
1064 deprecated: false
1065 /Categories/sub:
1066 get:
1067 tags:
1068 - Category
1069 summary: Gets all sub data of a category
1070 operationId: Category.sub
1071 parameters:
1072 - name: brandID
1073 in: query
1074 required: true
1075 schema:
1076 type: string
1077 - name: slug
1078 in: query
1079 required: true
1080 schema:
1081 type: string
1082 - name: maxProducts
1083 in: query
1084 required: false
1085 schema:
1086 type: number
1087 format: double
1088 - name: page
1089 in: query
1090 required: false
1091 schema:
1092 type: number
1093 format: double
1094 responses:
1095 "200":
1096 description: Request was successful
1097 content:
1098 application/json:
1099 schema:
1100 $ref: "#/components/schemas/Category"
1101 application/xml:
1102 schema:
1103 $ref: "#/components/schemas/Category"
1104 text/xml:
1105 schema:
1106 $ref: "#/components/schemas/Category"
1107 application/javascript:
1108 schema:
1109 $ref: "#/components/schemas/Category"
1110 text/javascript:
1111 schema:
1112 $ref: "#/components/schemas/Category"
1113 deprecated: false
1114 /Lists/create-new:
1115 post:
1116 tags:
1117 - List
1118 summary: Creates a new list
1119 operationId: List.createNew
1120 requestBody:
1121 content:
1122 application/x-www-form-urlencoded:
1123 schema:
1124 type: object
1125 properties:
1126 storeBrandId:
1127 type: string
1128 listName:
1129 type: string
1130 required:
1131 - storeBrandId
1132 - listName
1133 responses:
1134 "200":
1135 description: Request was successful
1136 content:
1137 application/json:
1138 schema:
1139 $ref: "#/components/schemas/List"
1140 application/xml:
1141 schema:
1142 $ref: "#/components/schemas/List"
1143 text/xml:
1144 schema:
1145 $ref: "#/components/schemas/List"
1146 application/javascript:
1147 schema:
1148 $ref: "#/components/schemas/List"
1149 text/javascript:
1150 schema:
1151 $ref: "#/components/schemas/List"
1152 deprecated: false
1153 /Lists/get-all-with-lines:
1154 get:
1155 tags:
1156 - List
1157 summary: Get all lists with lines by userId. It will minimize product info.
1158 operationId: List.getAllWithLines
1159 responses:
1160 "200":
1161 description: Request was successful
1162 content:
1163 application/json:
1164 schema:
1165 type: array
1166 items:
1167 $ref: "#/components/schemas/List"
1168 application/xml:
1169 schema:
1170 type: array
1171 items:
1172 $ref: "#/components/schemas/List"
1173 text/xml:
1174 schema:
1175 type: array
1176 items:
1177 $ref: "#/components/schemas/List"
1178 application/javascript:
1179 schema:
1180 type: array
1181 items:
1182 $ref: "#/components/schemas/List"
1183 text/javascript:
1184 schema:
1185 type: array
1186 items:
1187 $ref: "#/components/schemas/List"
1188 deprecated: false
1189 /Lists/get-public-with-lines:
1190 get:
1191 tags:
1192 - List
1193 summary: Get all public lists with lines. It will minimize product info.
1194 operationId: List.getAllPublicWithLines
1195 responses:
1196 "200":
1197 description: Request was successful
1198 content:
1199 application/json:
1200 schema:
1201 type: array
1202 items:
1203 $ref: "#/components/schemas/List"
1204 application/xml:
1205 schema:
1206 type: array
1207 items:
1208 $ref: "#/components/schemas/List"
1209 text/xml:
1210 schema:
1211 type: array
1212 items:
1213 $ref: "#/components/schemas/List"
1214 application/javascript:
1215 schema:
1216 type: array
1217 items:
1218 $ref: "#/components/schemas/List"
1219 text/javascript:
1220 schema:
1221 type: array
1222 items:
1223 $ref: "#/components/schemas/List"
1224 deprecated: false
1225 /Lists/get-with-lines:
1226 get:
1227 tags:
1228 - List
1229 summary: Get list with lines by listId. It will minimize product info.
1230 operationId: List.getWithLines
1231 parameters:
1232 - name: listId
1233 in: query
1234 required: true
1235 schema:
1236 type: string
1237 responses:
1238 "200":
1239 description: Request was successful
1240 content:
1241 application/json:
1242 schema:
1243 $ref: "#/components/schemas/List"
1244 application/xml:
1245 schema:
1246 $ref: "#/components/schemas/List"
1247 text/xml:
1248 schema:
1249 $ref: "#/components/schemas/List"
1250 application/javascript:
1251 schema:
1252 $ref: "#/components/schemas/List"
1253 text/javascript:
1254 schema:
1255 $ref: "#/components/schemas/List"
1256 deprecated: false
1257 /Lists/create-or-update-line:
1258 post:
1259 tags:
1260 - List
1261 summary: Creates a line if none is found, if one is found we update the line.
1262 operationId: List.createOrUpdateLine
1263 requestBody:
1264 content:
1265 application/x-www-form-urlencoded:
1266 schema:
1267 type: object
1268 properties:
1269 listId:
1270 type: string
1271 productId:
1272 type: string
1273 quantity:
1274 type: number
1275 format: double
1276 required:
1277 - listId
1278 - productId
1279 - quantity
1280 responses:
1281 "200":
1282 description: Request was successful
1283 content:
1284 application/json:
1285 schema:
1286 $ref: "#/components/schemas/List"
1287 application/xml:
1288 schema:
1289 $ref: "#/components/schemas/List"
1290 text/xml:
1291 schema:
1292 $ref: "#/components/schemas/List"
1293 application/javascript:
1294 schema:
1295 $ref: "#/components/schemas/List"
1296 text/javascript:
1297 schema:
1298 $ref: "#/components/schemas/List"
1299 deprecated: false
1300 /Lists/get-private-per-prand:
1301 get:
1302 tags:
1303 - List
1304 summary: Gets private lists per brand
1305 operationId: List.getPrivateByBrand
1306 parameters:
1307 - name: storeBrandId
1308 in: query
1309 required: true
1310 schema:
1311 type: string
1312 responses:
1313 "200":
1314 description: Request was successful
1315 content:
1316 application/json:
1317 schema:
1318 $ref: "#/components/schemas/List"
1319 application/xml:
1320 schema:
1321 $ref: "#/components/schemas/List"
1322 text/xml:
1323 schema:
1324 $ref: "#/components/schemas/List"
1325 application/javascript:
1326 schema:
1327 $ref: "#/components/schemas/List"
1328 text/javascript:
1329 schema:
1330 $ref: "#/components/schemas/List"
1331 deprecated: false
1332 /Lists/delete-line:
1333 delete:
1334 tags:
1335 - List
1336 summary: Deletes a line from a list.
1337 operationId: List.deleteLine
1338 requestBody:
1339 content:
1340 application/x-www-form-urlencoded:
1341 schema:
1342 type: object
1343 properties:
1344 listId:
1345 type: string
1346 productId:
1347 type: string
1348 required:
1349 - listId
1350 - productId
1351 responses:
1352 "200":
1353 description: Request was successful
1354 content:
1355 application/json:
1356 schema:
1357 $ref: "#/components/schemas/List"
1358 application/xml:
1359 schema:
1360 $ref: "#/components/schemas/List"
1361 text/xml:
1362 schema:
1363 $ref: "#/components/schemas/List"
1364 application/javascript:
1365 schema:
1366 $ref: "#/components/schemas/List"
1367 text/javascript:
1368 schema:
1369 $ref: "#/components/schemas/List"
1370 deprecated: false
1371 /Lists/delete-list:
1372 delete:
1373 tags:
1374 - List
1375 summary: Deletes a list.
1376 operationId: List.delete
1377 requestBody:
1378 content:
1379 application/x-www-form-urlencoded:
1380 schema:
1381 type: object
1382 properties:
1383 listId:
1384 type: string
1385 required:
1386 - listId
1387 responses:
1388 "200":
1389 description: Request was successful
1390 content:
1391 application/json:
1392 schema:
1393 $ref: "#/components/schemas/List"
1394 application/xml:
1395 schema:
1396 $ref: "#/components/schemas/List"
1397 text/xml:
1398 schema:
1399 $ref: "#/components/schemas/List"
1400 application/javascript:
1401 schema:
1402 $ref: "#/components/schemas/List"
1403 text/javascript:
1404 schema:
1405 $ref: "#/components/schemas/List"
1406 deprecated: false
1407 /orders/from-cart:
1408 post:
1409 tags:
1410 - Order
1411 summary: Create an order from the customers current cart.
1412 operationId: Order.createFromCart
1413 requestBody:
1414 $ref: "#/components/requestBodies/Customer.updateBody"
1415 responses:
1416 "200":
1417 description: Request was successful
1418 content:
1419 application/json:
1420 schema:
1421 type: object
1422 application/xml:
1423 schema:
1424 type: object
1425 text/xml:
1426 schema:
1427 type: object
1428 application/javascript:
1429 schema:
1430 type: object
1431 text/javascript:
1432 schema:
1433 type: object
1434 deprecated: false
1435 "/orders/{id}/detail":
1436 get:
1437 tags:
1438 - Order
1439 summary: Return a default detail set of an order.
1440 operationId: Order.detail
1441 parameters:
1442 - name: id
1443 in: path
1444 required: true
1445 schema:
1446 type: string
1447 responses:
1448 "200":
1449 description: Request was successful
1450 content:
1451 application/json:
1452 schema:
1453 $ref: "#/components/schemas/Order"
1454 application/xml:
1455 schema:
1456 $ref: "#/components/schemas/Order"
1457 text/xml:
1458 schema:
1459 $ref: "#/components/schemas/Order"
1460 application/javascript:
1461 schema:
1462 $ref: "#/components/schemas/Order"
1463 text/javascript:
1464 schema:
1465 $ref: "#/components/schemas/Order"
1466 deprecated: false
1467 "/orders/{id}/detail-full":
1468 get:
1469 tags:
1470 - Order
1471 summary: Return a default detail set of an order, not filtering buddy data.
1472 operationId: Order.detailFull
1473 parameters:
1474 - name: id
1475 in: path
1476 required: true
1477 schema:
1478 type: string
1479 responses:
1480 "200":
1481 description: Request was successful
1482 content:
1483 application/json:
1484 schema:
1485 $ref: "#/components/schemas/Order"
1486 application/xml:
1487 schema:
1488 $ref: "#/components/schemas/Order"
1489 text/xml:
1490 schema:
1491 $ref: "#/components/schemas/Order"
1492 application/javascript:
1493 schema:
1494 $ref: "#/components/schemas/Order"
1495 text/javascript:
1496 schema:
1497 $ref: "#/components/schemas/Order"
1498 deprecated: false
1499 "/orders/{displayId}/detail-by-displayid":
1500 get:
1501 tags:
1502 - Order
1503 summary: Return a default detail set of an order by it's display id.
1504 operationId: Order.detailByDisplayId
1505 parameters:
1506 - name: displayId
1507 in: path
1508 required: true
1509 schema:
1510 type: string
1511 responses:
1512 "200":
1513 description: Request was successful
1514 content:
1515 application/json:
1516 schema:
1517 $ref: "#/components/schemas/Order"
1518 application/xml:
1519 schema:
1520 $ref: "#/components/schemas/Order"
1521 text/xml:
1522 schema:
1523 $ref: "#/components/schemas/Order"
1524 application/javascript:
1525 schema:
1526 $ref: "#/components/schemas/Order"
1527 text/javascript:
1528 schema:
1529 $ref: "#/components/schemas/Order"
1530 deprecated: false
1531 "/orders/{id}/complete":
1532 post:
1533 tags:
1534 - Order
1535 summary: Complete an order.
1536 operationId: Order.complete
1537 parameters:
1538 - name: id
1539 in: path
1540 required: true
1541 schema:
1542 type: string
1543 responses:
1544 "200":
1545 description: Request was successful
1546 content:
1547 application/json:
1548 schema:
1549 type: object
1550 application/xml:
1551 schema:
1552 type: object
1553 text/xml:
1554 schema:
1555 type: object
1556 application/javascript:
1557 schema:
1558 type: object
1559 text/javascript:
1560 schema:
1561 type: object
1562 deprecated: false
1563 "/orders/{id}/rate-buddy":
1564 post:
1565 tags:
1566 - Order
1567 summary: Rate the buddy of an order.
1568 operationId: Order.rateBuddy
1569 parameters:
1570 - name: id
1571 in: path
1572 required: true
1573 schema:
1574 type: string
1575 requestBody:
1576 $ref: "#/components/requestBodies/Customer.updateBody"
1577 responses:
1578 "200":
1579 description: Request was successful
1580 content:
1581 application/json:
1582 schema:
1583 type: object
1584 application/xml:
1585 schema:
1586 type: object
1587 text/xml:
1588 schema:
1589 type: object
1590 application/javascript:
1591 schema:
1592 type: object
1593 text/javascript:
1594 schema:
1595 type: object
1596 deprecated: false
1597 "/orders/{id}/rate-customer":
1598 post:
1599 tags:
1600 - Order
1601 summary: Rate the customer of an order.
1602 operationId: Order.rateCustomer
1603 parameters:
1604 - name: id
1605 in: path
1606 required: true
1607 schema:
1608 type: string
1609 requestBody:
1610 $ref: "#/components/requestBodies/Customer.updateBody"
1611 responses:
1612 "200":
1613 description: Request was successful
1614 content:
1615 application/json:
1616 schema:
1617 type: object
1618 application/xml:
1619 schema:
1620 type: object
1621 text/xml:
1622 schema:
1623 type: object
1624 application/javascript:
1625 schema:
1626 type: object
1627 text/javascript:
1628 schema:
1629 type: object
1630 deprecated: false
1631 /orders/change-status:
1632 put:
1633 tags:
1634 - Order
1635 summary: Change buddy assigned to order
1636 operationId: Order.changeStatus
1637 requestBody:
1638 content:
1639 application/x-www-form-urlencoded:
1640 schema:
1641 type: object
1642 properties:
1643 status:
1644 type: string
1645 orderId:
1646 type: string
1647 required:
1648 - status
1649 - orderId
1650 responses:
1651 "200":
1652 description: Request was successful
1653 content:
1654 application/json:
1655 schema:
1656 $ref: "#/components/schemas/Order"
1657 application/xml:
1658 schema:
1659 $ref: "#/components/schemas/Order"
1660 text/xml:
1661 schema:
1662 $ref: "#/components/schemas/Order"
1663 application/javascript:
1664 schema:
1665 $ref: "#/components/schemas/Order"
1666 text/javascript:
1667 schema:
1668 $ref: "#/components/schemas/Order"
1669 deprecated: false
1670 /orders/update-delivertime:
1671 put:
1672 tags:
1673 - Order
1674 summary: Changes the deliverDate, earliest and latestDeliverTime
1675 operationId: Order.updateDeliverTime
1676 requestBody:
1677 content:
1678 application/x-www-form-urlencoded:
1679 schema:
1680 type: object
1681 properties:
1682 deliverDate:
1683 type: string
1684 format: date-time
1685 earliestDeliverTime:
1686 type: string
1687 format: date-time
1688 latestDeliverTime:
1689 type: string
1690 format: date-time
1691 orderId:
1692 type: string
1693 required:
1694 - deliverDate
1695 - earliestDeliverTime
1696 - latestDeliverTime
1697 - orderId
1698 responses:
1699 "200":
1700 description: Request was successful
1701 content:
1702 application/json:
1703 schema:
1704 $ref: "#/components/schemas/Order"
1705 application/xml:
1706 schema:
1707 $ref: "#/components/schemas/Order"
1708 text/xml:
1709 schema:
1710 $ref: "#/components/schemas/Order"
1711 application/javascript:
1712 schema:
1713 $ref: "#/components/schemas/Order"
1714 text/javascript:
1715 schema:
1716 $ref: "#/components/schemas/Order"
1717 deprecated: false
1718 /orders/search:
1719 get:
1720 tags:
1721 - Order
1722 summary: Queries Order in ES
1723 operationId: Order.search
1724 parameters:
1725 - name: query
1726 in: query
1727 required: false
1728 schema:
1729 type: string
1730 - name: filters
1731 in: query
1732 required: false
1733 schema:
1734 type: string
1735 format: JSON
1736 - name: sort
1737 in: query
1738 required: false
1739 schema:
1740 type: string
1741 format: JSON
1742 - name: limit
1743 in: query
1744 required: false
1745 schema:
1746 type: number
1747 format: double
1748 - name: skip
1749 in: query
1750 required: false
1751 schema:
1752 type: number
1753 format: double
1754 responses:
1755 "200":
1756 description: Request was successful
1757 content:
1758 application/json:
1759 schema:
1760 type: object
1761 application/xml:
1762 schema:
1763 type: object
1764 text/xml:
1765 schema:
1766 type: object
1767 application/javascript:
1768 schema:
1769 type: object
1770 text/javascript:
1771 schema:
1772 type: object
1773 deprecated: false
1774 "/orders/{id}/update-receipt-price":
1775 put:
1776 tags:
1777 - Order
1778 summary: Changes the receiptPrice
1779 operationId: Order.updateReceiptPrice
1780 parameters:
1781 - name: id
1782 in: path
1783 required: true
1784 schema:
1785 type: string
1786 requestBody:
1787 content:
1788 application/x-www-form-urlencoded:
1789 schema:
1790 type: object
1791 properties:
1792 price:
1793 type: string
1794 required:
1795 - price
1796 responses:
1797 "200":
1798 description: Request was successful
1799 content:
1800 application/json:
1801 schema:
1802 $ref: "#/components/schemas/Order"
1803 application/xml:
1804 schema:
1805 $ref: "#/components/schemas/Order"
1806 text/xml:
1807 schema:
1808 $ref: "#/components/schemas/Order"
1809 application/javascript:
1810 schema:
1811 $ref: "#/components/schemas/Order"
1812 text/javascript:
1813 schema:
1814 $ref: "#/components/schemas/Order"
1815 deprecated: false
1816 /Payments/banks:
1817 get:
1818 tags:
1819 - Payment
1820 operationId: Payment.getBanks
1821 responses:
1822 "200":
1823 description: Request was successful
1824 content:
1825 application/json:
1826 schema:
1827 type: object
1828 application/xml:
1829 schema:
1830 type: object
1831 text/xml:
1832 schema:
1833 type: object
1834 application/javascript:
1835 schema:
1836 type: object
1837 text/javascript:
1838 schema:
1839 type: object
1840 deprecated: false
1841 "/Payments/{CMPaymentId}/information":
1842 get:
1843 tags:
1844 - Payment
1845 summary: Get basic information from payment by CM Payment ID
1846 operationId: Payment.information
1847 parameters:
1848 - name: CMPaymentId
1849 in: path
1850 required: true
1851 schema:
1852 type: string
1853 responses:
1854 "200":
1855 description: Request was successful
1856 content:
1857 application/json:
1858 schema:
1859 type: object
1860 application/xml:
1861 schema:
1862 type: object
1863 text/xml:
1864 schema:
1865 type: object
1866 application/javascript:
1867 schema:
1868 type: object
1869 text/javascript:
1870 schema:
1871 type: object
1872 deprecated: false
1873 /Payments/pay-order:
1874 post:
1875 tags:
1876 - Payment
1877 summary: Initiate payment for an order
1878 operationId: Payment.payOrder
1879 requestBody:
1880 content:
1881 application/x-www-form-urlencoded:
1882 schema:
1883 type: object
1884 properties:
1885 orderId:
1886 type: string
1887 issuerId:
1888 type: string
1889 required:
1890 - orderId
1891 responses:
1892 "200":
1893 description: Request was successful
1894 content:
1895 application/json:
1896 schema:
1897 type: object
1898 application/xml:
1899 schema:
1900 type: object
1901 text/xml:
1902 schema:
1903 type: object
1904 application/javascript:
1905 schema:
1906 type: object
1907 text/javascript:
1908 schema:
1909 type: object
1910 deprecated: false
1911 /Payments/pay-live-order:
1912 post:
1913 tags:
1914 - Payment
1915 summary: Pay for a live order
1916 operationId: Payment.payLiveOrder
1917 requestBody:
1918 $ref: "#/components/requestBodies/Payment.payLiveOrder"
1919 responses:
1920 "200":
1921 description: Request was successful
1922 content:
1923 application/json:
1924 schema:
1925 type: object
1926 application/xml:
1927 schema:
1928 type: object
1929 text/xml:
1930 schema:
1931 type: object
1932 application/javascript:
1933 schema:
1934 type: object
1935 text/javascript:
1936 schema:
1937 type: object
1938 deprecated: false
1939 /Payments/saldo-charge:
1940 post:
1941 tags:
1942 - Payment
1943 summary: Initiate payment for increasing budget
1944 operationId: Payment.saldoCharge
1945 requestBody:
1946 content:
1947 application/x-www-form-urlencoded:
1948 schema:
1949 type: object
1950 properties:
1951 amount:
1952 type: number
1953 format: double
1954 issuerId:
1955 type: string
1956 responses:
1957 "200":
1958 description: Request was successful
1959 content:
1960 application/json:
1961 schema:
1962 type: object
1963 application/xml:
1964 schema:
1965 type: object
1966 text/xml:
1967 schema:
1968 type: object
1969 application/javascript:
1970 schema:
1971 type: object
1972 text/javascript:
1973 schema:
1974 type: object
1975 deprecated: false
1976 /Payments/webhook:
1977 post:
1978 tags:
1979 - Payment
1980 operationId: Payment.webhook
1981 requestBody:
1982 $ref: "#/components/requestBodies/Customer.updateBody"
1983 responses:
1984 "200":
1985 description: Request was successful
1986 content:
1987 application/json:
1988 schema:
1989 type: boolean
1990 application/xml:
1991 schema:
1992 type: boolean
1993 text/xml:
1994 schema:
1995 type: boolean
1996 application/javascript:
1997 schema:
1998 type: boolean
1999 text/javascript:
2000 schema:
2001 type: boolean
2002 deprecated: false
2003 /Payments/get-with-cm-data:
2004 get:
2005 tags:
2006 - Payment
2007 summary: Get payment data for the payments table
2008 operationId: Payment.getWithCMData
2009 parameters:
2010 - name: limit
2011 in: query
2012 required: false
2013 schema:
2014 type: number
2015 format: double
2016 - name: skip
2017 in: query
2018 required: false
2019 schema:
2020 type: number
2021 format: double
2022 responses:
2023 "200":
2024 description: Request was successful
2025 content:
2026 application/json:
2027 schema:
2028 type: array
2029 items:
2030 $ref: "#/components/schemas/x-any"
2031 application/xml:
2032 schema:
2033 type: array
2034 items:
2035 $ref: "#/components/schemas/x-any"
2036 text/xml:
2037 schema:
2038 type: array
2039 items:
2040 $ref: "#/components/schemas/x-any"
2041 application/javascript:
2042 schema:
2043 type: array
2044 items:
2045 $ref: "#/components/schemas/x-any"
2046 text/javascript:
2047 schema:
2048 type: array
2049 items:
2050 $ref: "#/components/schemas/x-any"
2051 deprecated: false
2052 /Payments/total:
2053 get:
2054 tags:
2055 - Payment
2056 summary: Get table total for the payments table
2057 operationId: Payment.total
2058 responses:
2059 "200":
2060 description: Request was successful
2061 content:
2062 application/json:
2063 schema:
2064 type: number
2065 format: double
2066 application/xml:
2067 schema:
2068 type: number
2069 format: double
2070 text/xml:
2071 schema:
2072 type: number
2073 format: double
2074 application/javascript:
2075 schema:
2076 type: number
2077 format: double
2078 text/javascript:
2079 schema:
2080 type: number
2081 format: double
2082 deprecated: false
2083 /Payments/refund:
2084 post:
2085 tags:
2086 - Payment
2087 summary: Refunds the complete payment
2088 operationId: Payment.refund
2089 requestBody:
2090 content:
2091 application/x-www-form-urlencoded:
2092 schema:
2093 type: object
2094 properties:
2095 paymentId:
2096 type: string
2097 reason:
2098 type: string
2099 responses:
2100 "200":
2101 description: Request was successful
2102 content:
2103 application/json:
2104 schema:
2105 type: array
2106 items:
2107 $ref: "#/components/schemas/x-any"
2108 application/xml:
2109 schema:
2110 type: array
2111 items:
2112 $ref: "#/components/schemas/x-any"
2113 text/xml:
2114 schema:
2115 type: array
2116 items:
2117 $ref: "#/components/schemas/x-any"
2118 application/javascript:
2119 schema:
2120 type: array
2121 items:
2122 $ref: "#/components/schemas/x-any"
2123 text/javascript:
2124 schema:
2125 type: array
2126 items:
2127 $ref: "#/components/schemas/x-any"
2128 deprecated: false
2129 /pushtokens/get-users-from-tokens:
2130 get:
2131 tags:
2132 - PushToken
2133 summary: Gets users names from tokens.
2134 operationId: PushToken.getUsersFromTokens
2135 parameters:
2136 - name: token
2137 in: query
2138 required: true
2139 schema:
2140 type: string
2141 format: JSON
2142 responses:
2143 "200":
2144 description: Request was successful
2145 content:
2146 application/json:
2147 schema:
2148 type: array
2149 items:
2150 $ref: "#/components/schemas/x-any"
2151 application/xml:
2152 schema:
2153 type: array
2154 items:
2155 $ref: "#/components/schemas/x-any"
2156 text/xml:
2157 schema:
2158 type: array
2159 items:
2160 $ref: "#/components/schemas/x-any"
2161 application/javascript:
2162 schema:
2163 type: array
2164 items:
2165 $ref: "#/components/schemas/x-any"
2166 text/javascript:
2167 schema:
2168 type: array
2169 items:
2170 $ref: "#/components/schemas/x-any"
2171 deprecated: false
2172 /pushtokens/send-for-order:
2173 post:
2174 tags:
2175 - PushToken
2176 summary: Sends a push notification according to an order.
2177 operationId: PushToken.sendForOrder
2178 requestBody:
2179 $ref: "#/components/requestBodies/Payment.payLiveOrder"
2180 responses:
2181 "200":
2182 description: Request was successful
2183 content:
2184 application/json:
2185 schema:
2186 type: boolean
2187 application/xml:
2188 schema:
2189 type: boolean
2190 text/xml:
2191 schema:
2192 type: boolean
2193 application/javascript:
2194 schema:
2195 type: boolean
2196 text/javascript:
2197 schema:
2198 type: boolean
2199 deprecated: false
2200 /pushtokens/check-token:
2201 get:
2202 tags:
2203 - PushToken
2204 summary: check if app token exists on our side.
2205 operationId: PushToken.checkToken
2206 parameters:
2207 - name: token
2208 in: query
2209 required: true
2210 schema:
2211 type: string
2212 - name: appId
2213 in: query
2214 required: true
2215 schema:
2216 type: string
2217 - name: os
2218 in: query
2219 required: true
2220 schema:
2221 type: string
2222 - name: tenantName
2223 in: query
2224 required: true
2225 schema:
2226 type: string
2227 responses:
2228 "200":
2229 description: Request was successful
2230 content:
2231 application/json:
2232 schema:
2233 type: boolean
2234 application/xml:
2235 schema:
2236 type: boolean
2237 text/xml:
2238 schema:
2239 type: boolean
2240 application/javascript:
2241 schema:
2242 type: boolean
2243 text/javascript:
2244 schema:
2245 type: boolean
2246 deprecated: false
2247 /Search/query:
2248 get:
2249 tags:
2250 - Search
2251 summary: Query elastic, accepts an object as parameter
2252 operationId: Search.query
2253 parameters:
2254 - name: storeBrandId
2255 in: query
2256 description: ID for the storeBrand to search in
2257 required: false
2258 schema:
2259 type: string
2260 - name: query
2261 in: query
2262 description: Search query
2263 required: false
2264 schema:
2265 type: string
2266 - name: limit
2267 in: query
2268 description: Limit of products
2269 required: false
2270 schema:
2271 type: number
2272 format: double
2273 responses:
2274 "200":
2275 description: Request was successful
2276 content:
2277 application/json:
2278 schema:
2279 type: array
2280 items:
2281 $ref: "#/components/schemas/x-any"
2282 application/xml:
2283 schema:
2284 type: array
2285 items:
2286 $ref: "#/components/schemas/x-any"
2287 text/xml:
2288 schema:
2289 type: array
2290 items:
2291 $ref: "#/components/schemas/x-any"
2292 application/javascript:
2293 schema:
2294 type: array
2295 items:
2296 $ref: "#/components/schemas/x-any"
2297 text/javascript:
2298 schema:
2299 type: array
2300 items:
2301 $ref: "#/components/schemas/x-any"
2302 deprecated: false
2303 /Search/query-filter:
2304 get:
2305 tags:
2306 - Search
2307 summary: Query products and returns them with different filters
2308 operationId: Search.queryFilter
2309 parameters:
2310 - name: storeBrandId
2311 in: query
2312 description: ID for the storeBrand to search in
2313 required: false
2314 schema:
2315 type: string
2316 - name: query
2317 in: query
2318 description: Search query
2319 required: false
2320 schema:
2321 type: string
2322 - name: limit
2323 in: query
2324 description: Limit of products
2325 required: false
2326 schema:
2327 type: number
2328 format: double
2329 responses:
2330 "200":
2331 description: Request was successful
2332 content:
2333 application/json:
2334 schema:
2335 type: array
2336 items:
2337 $ref: "#/components/schemas/x-any"
2338 application/xml:
2339 schema:
2340 type: array
2341 items:
2342 $ref: "#/components/schemas/x-any"
2343 text/xml:
2344 schema:
2345 type: array
2346 items:
2347 $ref: "#/components/schemas/x-any"
2348 application/javascript:
2349 schema:
2350 type: array
2351 items:
2352 $ref: "#/components/schemas/x-any"
2353 text/javascript:
2354 schema:
2355 type: array
2356 items:
2357 $ref: "#/components/schemas/x-any"
2358 deprecated: false
2359 /Search/query-term:
2360 get:
2361 tags:
2362 - Search
2363 summary: Query terms and returns them with different filters
2364 operationId: Search.queryTerm
2365 parameters:
2366 - name: term
2367 in: query
2368 required: false
2369 schema:
2370 type: string
2371 responses:
2372 "200":
2373 description: Request was successful
2374 content:
2375 application/json:
2376 schema:
2377 type: array
2378 items:
2379 $ref: "#/components/schemas/x-any"
2380 application/xml:
2381 schema:
2382 type: array
2383 items:
2384 $ref: "#/components/schemas/x-any"
2385 text/xml:
2386 schema:
2387 type: array
2388 items:
2389 $ref: "#/components/schemas/x-any"
2390 application/javascript:
2391 schema:
2392 type: array
2393 items:
2394 $ref: "#/components/schemas/x-any"
2395 text/javascript:
2396 schema:
2397 type: array
2398 items:
2399 $ref: "#/components/schemas/x-any"
2400 deprecated: false
2401 /Stores/get-all-filtered:
2402 get:
2403 tags:
2404 - Store
2405 summary: Get all the stores by id and name
2406 operationId: Store.getAllNames
2407 responses:
2408 "200":
2409 description: Request was successful
2410 content:
2411 application/json:
2412 schema:
2413 type: array
2414 items:
2415 $ref: "#/components/schemas/Store"
2416 application/xml:
2417 schema:
2418 type: array
2419 items:
2420 $ref: "#/components/schemas/Store"
2421 text/xml:
2422 schema:
2423 type: array
2424 items:
2425 $ref: "#/components/schemas/Store"
2426 application/javascript:
2427 schema:
2428 type: array
2429 items:
2430 $ref: "#/components/schemas/Store"
2431 text/javascript:
2432 schema:
2433 type: array
2434 items:
2435 $ref: "#/components/schemas/Store"
2436 deprecated: false
2437 /Stores/get-by-brand-and-store:
2438 get:
2439 tags:
2440 - Store
2441 summary: Get all the stores by brandId and cityId
2442 operationId: Store.getByBrandAndCity
2443 parameters:
2444 - name: brandId
2445 in: query
2446 required: false
2447 schema:
2448 type: string
2449 - name: cityId
2450 in: query
2451 required: false
2452 schema:
2453 type: string
2454 responses:
2455 "200":
2456 description: Request was successful
2457 content:
2458 application/json:
2459 schema:
2460 type: array
2461 items:
2462 $ref: "#/components/schemas/Store"
2463 application/xml:
2464 schema:
2465 type: array
2466 items:
2467 $ref: "#/components/schemas/Store"
2468 text/xml:
2469 schema:
2470 type: array
2471 items:
2472 $ref: "#/components/schemas/Store"
2473 application/javascript:
2474 schema:
2475 type: array
2476 items:
2477 $ref: "#/components/schemas/Store"
2478 text/javascript:
2479 schema:
2480 type: array
2481 items:
2482 $ref: "#/components/schemas/Store"
2483 deprecated: false
2484 /Stores/current-time-slots:
2485 get:
2486 tags:
2487 - Store
2488 summary: Gets the current timeslots for the store
2489 operationId: Store.currentTimeSlots
2490 parameters:
2491 - name: ids
2492 in: query
2493 required: true
2494 schema:
2495 type: string
2496 format: JSON
2497 - name: products
2498 in: query
2499 required: false
2500 schema:
2501 type: number
2502 format: double
2503 default: 0
2504 responses:
2505 "200":
2506 description: Request was successful
2507 content:
2508 application/json:
2509 schema:
2510 type: object
2511 application/xml:
2512 schema:
2513 type: object
2514 text/xml:
2515 schema:
2516 type: object
2517 application/javascript:
2518 schema:
2519 type: object
2520 text/javascript:
2521 schema:
2522 type: object
2523 deprecated: false
2524 /Stores/earliest-time-slots:
2525 get:
2526 tags:
2527 - Store
2528 summary: Gets the earliest timeslots for the store
2529 operationId: Store.earliestTimeSlots
2530 parameters:
2531 - name: ids
2532 in: query
2533 required: true
2534 schema:
2535 type: string
2536 format: JSON
2537 - name: products
2538 in: query
2539 required: false
2540 schema:
2541 type: number
2542 format: double
2543 default: 0
2544 responses:
2545 "200":
2546 description: Request was successful
2547 content:
2548 application/json:
2549 schema:
2550 type: object
2551 application/xml:
2552 schema:
2553 type: object
2554 text/xml:
2555 schema:
2556 type: object
2557 application/javascript:
2558 schema:
2559 type: object
2560 text/javascript:
2561 schema:
2562 type: object
2563 deprecated: false
2564 /Stores/get-from-lat-lng:
2565 get:
2566 tags:
2567 - Store
2568 operationId: Store.getFromLatLng
2569 parameters:
2570 - name: lat
2571 in: query
2572 required: true
2573 schema:
2574 type: number
2575 format: double
2576 - name: lng
2577 in: query
2578 required: true
2579 schema:
2580 type: number
2581 format: double
2582 - name: city
2583 in: query
2584 required: true
2585 schema:
2586 type: string
2587 responses:
2588 "200":
2589 description: Request was successful
2590 content:
2591 application/json:
2592 schema:
2593 type: object
2594 application/xml:
2595 schema:
2596 type: object
2597 text/xml:
2598 schema:
2599 type: object
2600 application/javascript:
2601 schema:
2602 type: object
2603 text/javascript:
2604 schema:
2605 type: object
2606 deprecated: false
2607 /Stores/get-store-by-id:
2608 get:
2609 tags:
2610 - Store
2611 summary: Gets store by id
2612 operationId: Store.getStoreById
2613 parameters:
2614 - name: storeId
2615 in: query
2616 required: true
2617 schema:
2618 type: string
2619 responses:
2620 "200":
2621 description: Request was successful
2622 content:
2623 application/json:
2624 schema:
2625 $ref: "#/components/schemas/Store"
2626 application/xml:
2627 schema:
2628 $ref: "#/components/schemas/Store"
2629 text/xml:
2630 schema:
2631 $ref: "#/components/schemas/Store"
2632 application/javascript:
2633 schema:
2634 $ref: "#/components/schemas/Store"
2635 text/javascript:
2636 schema:
2637 $ref: "#/components/schemas/Store"
2638 deprecated: false
2639 /Stores/get-multiple-stores-by-id:
2640 post:
2641 tags:
2642 - Store
2643 summary: Gets multiple stores by id
2644 operationId: Store.getMultiStoreById
2645 requestBody:
2646 $ref: "#/components/requestBodies/Customer.updateBody"
2647 responses:
2648 "200":
2649 description: Request was successful
2650 content:
2651 application/json:
2652 schema:
2653 $ref: "#/components/schemas/Store"
2654 application/xml:
2655 schema:
2656 $ref: "#/components/schemas/Store"
2657 text/xml:
2658 schema:
2659 $ref: "#/components/schemas/Store"
2660 application/javascript:
2661 schema:
2662 $ref: "#/components/schemas/Store"
2663 text/javascript:
2664 schema:
2665 $ref: "#/components/schemas/Store"
2666 deprecated: false
2667 "/Stores/{storeBrandId}/home":
2668 get:
2669 tags:
2670 - Store
2671 summary: Gets the main categories, most bought products and discount products
2672 operationId: Store.home
2673 parameters:
2674 - name: storeBrandId
2675 in: path
2676 description: The store brand of which to get the store front
2677 required: true
2678 schema:
2679 type: string
2680 responses:
2681 "200":
2682 description: Request was successful
2683 content:
2684 application/json:
2685 schema:
2686 type: array
2687 items:
2688 type: object
2689 application/xml:
2690 schema:
2691 type: array
2692 items:
2693 type: object
2694 text/xml:
2695 schema:
2696 type: array
2697 items:
2698 type: object
2699 application/javascript:
2700 schema:
2701 type: array
2702 items:
2703 type: object
2704 text/javascript:
2705 schema:
2706 type: array
2707 items:
2708 type: object
2709 deprecated: false
2710 "/Stores/{brandId}/specialties":
2711 get:
2712 tags:
2713 - Store
2714 summary: Gets the main categories, most bought products and discount products
2715 operationId: Store.specialties
2716 parameters:
2717 - name: brandId
2718 in: path
2719 description: The store brand of which to get the store front
2720 required: true
2721 schema:
2722 type: string
2723 - name: limit
2724 in: query
2725 required: false
2726 schema:
2727 type: number
2728 format: double
2729 default: 50
2730 - name: page
2731 in: query
2732 required: false
2733 schema:
2734 type: number
2735 format: double
2736 default: 1
2737 responses:
2738 "200":
2739 description: Request was successful
2740 content:
2741 application/json:
2742 schema:
2743 type: array
2744 items:
2745 type: object
2746 application/xml:
2747 schema:
2748 type: array
2749 items:
2750 type: object
2751 text/xml:
2752 schema:
2753 type: array
2754 items:
2755 type: object
2756 application/javascript:
2757 schema:
2758 type: array
2759 items:
2760 type: object
2761 text/javascript:
2762 schema:
2763 type: array
2764 items:
2765 type: object
2766 deprecated: false
2767 "/Stores/{id}/area/link/{areaId}":
2768 put:
2769 tags:
2770 - Store
2771 summary: Link an area to this model
2772 operationId: Store.linkArea
2773 parameters:
2774 - name: id
2775 in: path
2776 required: true
2777 schema:
2778 type: string
2779 - name: areaId
2780 in: path
2781 required: true
2782 schema:
2783 type: string
2784 responses:
2785 "200":
2786 description: Request was successful
2787 content:
2788 application/json:
2789 schema:
2790 $ref: "#/components/schemas/Store"
2791 application/xml:
2792 schema:
2793 $ref: "#/components/schemas/Store"
2794 text/xml:
2795 schema:
2796 $ref: "#/components/schemas/Store"
2797 application/javascript:
2798 schema:
2799 $ref: "#/components/schemas/Store"
2800 text/javascript:
2801 schema:
2802 $ref: "#/components/schemas/Store"
2803 deprecated: false
2804 "/Stores/{id}/area/unlink/{areaId}":
2805 delete:
2806 tags:
2807 - Store
2808 summary: Unlink an area to this model
2809 operationId: Store.unlinkArea
2810 parameters:
2811 - name: id
2812 in: path
2813 required: true
2814 schema:
2815 type: string
2816 - name: areaId
2817 in: path
2818 required: true
2819 schema:
2820 type: string
2821 responses:
2822 "200":
2823 description: Request was successful
2824 content:
2825 application/json:
2826 schema:
2827 $ref: "#/components/schemas/Store"
2828 application/xml:
2829 schema:
2830 $ref: "#/components/schemas/Store"
2831 text/xml:
2832 schema:
2833 $ref: "#/components/schemas/Store"
2834 application/javascript:
2835 schema:
2836 $ref: "#/components/schemas/Store"
2837 text/javascript:
2838 schema:
2839 $ref: "#/components/schemas/Store"
2840 deprecated: false
2841 "/Stores/{id}/area/add":
2842 post:
2843 tags:
2844 - Store
2845 summary: Add an area to this model
2846 operationId: Store.addArea
2847 parameters:
2848 - name: id
2849 in: path
2850 required: true
2851 schema:
2852 type: string
2853 requestBody:
2854 $ref: "#/components/requestBodies/Area"
2855 responses:
2856 "200":
2857 description: Request was successful
2858 content:
2859 application/json:
2860 schema:
2861 $ref: "#/components/schemas/Store"
2862 application/xml:
2863 schema:
2864 $ref: "#/components/schemas/Store"
2865 text/xml:
2866 schema:
2867 $ref: "#/components/schemas/Store"
2868 application/javascript:
2869 schema:
2870 $ref: "#/components/schemas/Store"
2871 text/javascript:
2872 schema:
2873 $ref: "#/components/schemas/Store"
2874 deprecated: false
2875 "/Stores/{id}/buddy/unlink/{buddyId}":
2876 put:
2877 tags:
2878 - Store
2879 summary: Unlink a buddy from this model
2880 operationId: Store.unlinkBuddy
2881 parameters:
2882 - name: id
2883 in: path
2884 required: true
2885 schema:
2886 type: string
2887 - name: buddyId
2888 in: path
2889 required: true
2890 schema:
2891 type: string
2892 responses:
2893 "200":
2894 description: Request was successful
2895 content:
2896 application/json:
2897 schema:
2898 $ref: "#/components/schemas/Store"
2899 application/xml:
2900 schema:
2901 $ref: "#/components/schemas/Store"
2902 text/xml:
2903 schema:
2904 $ref: "#/components/schemas/Store"
2905 application/javascript:
2906 schema:
2907 $ref: "#/components/schemas/Store"
2908 text/javascript:
2909 schema:
2910 $ref: "#/components/schemas/Store"
2911 deprecated: false
2912 "/Stores/{id}/closedScheme/{fk}":
2913 delete:
2914 tags:
2915 - Store
2916 summary: Destroy a closed scheme connected to this model
2917 operationId: Store.destroyClosedScheme
2918 parameters:
2919 - name: id
2920 in: path
2921 required: true
2922 schema:
2923 type: string
2924 - name: fk
2925 in: path
2926 required: true
2927 schema:
2928 type: string
2929 responses:
2930 "200":
2931 description: Request was successful
2932 content:
2933 application/json:
2934 schema:
2935 $ref: "#/components/schemas/Store"
2936 application/xml:
2937 schema:
2938 $ref: "#/components/schemas/Store"
2939 text/xml:
2940 schema:
2941 $ref: "#/components/schemas/Store"
2942 application/javascript:
2943 schema:
2944 $ref: "#/components/schemas/Store"
2945 text/javascript:
2946 schema:
2947 $ref: "#/components/schemas/Store"
2948 deprecated: false
2949 put:
2950 tags:
2951 - Store
2952 summary: Update a closed scheme connected to this model
2953 operationId: Store.updateClosedScheme
2954 parameters:
2955 - name: id
2956 in: path
2957 required: true
2958 schema:
2959 type: string
2960 - name: fk
2961 in: path
2962 required: true
2963 schema:
2964 type: string
2965 requestBody:
2966 $ref: "#/components/requestBodies/Store.updateClosedSchemeSchemeobj"
2967 responses:
2968 "200":
2969 description: Request was successful
2970 content:
2971 application/json:
2972 schema:
2973 $ref: "#/components/schemas/Store"
2974 application/xml:
2975 schema:
2976 $ref: "#/components/schemas/Store"
2977 text/xml:
2978 schema:
2979 $ref: "#/components/schemas/Store"
2980 application/javascript:
2981 schema:
2982 $ref: "#/components/schemas/Store"
2983 text/javascript:
2984 schema:
2985 $ref: "#/components/schemas/Store"
2986 deprecated: false
2987 "/Stores/{id}/closedScheme/add":
2988 post:
2989 tags:
2990 - Store
2991 summary: Add a closed scheme to this model
2992 operationId: Store.addClosedScheme
2993 parameters:
2994 - name: id
2995 in: path
2996 required: true
2997 schema:
2998 type: string
2999 requestBody:
3000 $ref: "#/components/requestBodies/Store.updateClosedSchemeSchemeobj"
3001 responses:
3002 "200":
3003 description: Request was successful
3004 content:
3005 application/json:
3006 schema:
3007 $ref: "#/components/schemas/Store"
3008 application/xml:
3009 schema:
3010 $ref: "#/components/schemas/Store"
3011 text/xml:
3012 schema:
3013 $ref: "#/components/schemas/Store"
3014 application/javascript:
3015 schema:
3016 $ref: "#/components/schemas/Store"
3017 text/javascript:
3018 schema:
3019 $ref: "#/components/schemas/Store"
3020 deprecated: false
3021 "/Stores/{id}/scheme/{fk}":
3022 delete:
3023 tags:
3024 - Store
3025 summary: Destroy a scheme connected to this model
3026 operationId: Store.destroyScheme
3027 parameters:
3028 - name: id
3029 in: path
3030 required: true
3031 schema:
3032 type: string
3033 - name: fk
3034 in: path
3035 required: true
3036 schema:
3037 type: string
3038 responses:
3039 "200":
3040 description: Request was successful
3041 content:
3042 application/json:
3043 schema:
3044 $ref: "#/components/schemas/Store"
3045 application/xml:
3046 schema:
3047 $ref: "#/components/schemas/Store"
3048 text/xml:
3049 schema:
3050 $ref: "#/components/schemas/Store"
3051 application/javascript:
3052 schema:
3053 $ref: "#/components/schemas/Store"
3054 text/javascript:
3055 schema:
3056 $ref: "#/components/schemas/Store"
3057 deprecated: false
3058 put:
3059 tags:
3060 - Store
3061 summary: Update a scheme connected to this model
3062 operationId: Store.updateScheme
3063 parameters:
3064 - name: id
3065 in: path
3066 required: true
3067 schema:
3068 type: string
3069 - name: fk
3070 in: path
3071 required: true
3072 schema:
3073 type: string
3074 requestBody:
3075 $ref: "#/components/requestBodies/Store.updateClosedSchemeSchemeobj"
3076 responses:
3077 "200":
3078 description: Request was successful
3079 content:
3080 application/json:
3081 schema:
3082 $ref: "#/components/schemas/Store"
3083 application/xml:
3084 schema:
3085 $ref: "#/components/schemas/Store"
3086 text/xml:
3087 schema:
3088 $ref: "#/components/schemas/Store"
3089 application/javascript:
3090 schema:
3091 $ref: "#/components/schemas/Store"
3092 text/javascript:
3093 schema:
3094 $ref: "#/components/schemas/Store"
3095 deprecated: false
3096 "/Stores/{id}/scheme/add":
3097 post:
3098 tags:
3099 - Store
3100 summary: Add a scheme to this model
3101 operationId: Store.addScheme
3102 parameters:
3103 - name: id
3104 in: path
3105 required: true
3106 schema:
3107 type: string
3108 requestBody:
3109 $ref: "#/components/requestBodies/Store.updateClosedSchemeSchemeobj"
3110 responses:
3111 "200":
3112 description: Request was successful
3113 content:
3114 application/json:
3115 schema:
3116 $ref: "#/components/schemas/Store"
3117 application/xml:
3118 schema:
3119 $ref: "#/components/schemas/Store"
3120 text/xml:
3121 schema:
3122 $ref: "#/components/schemas/Store"
3123 application/javascript:
3124 schema:
3125 $ref: "#/components/schemas/Store"
3126 text/javascript:
3127 schema:
3128 $ref: "#/components/schemas/Store"
3129 deprecated: false
3130 "/Stores/product/{slug}/{brandId}":
3131 get:
3132 tags:
3133 - Store
3134 summary: Get a product by slug & brand id
3135 operationId: Store.getProduct
3136 parameters:
3137 - name: slug
3138 in: path
3139 required: true
3140 schema:
3141 type: string
3142 - name: brandId
3143 in: path
3144 required: true
3145 schema:
3146 type: string
3147 responses:
3148 "200":
3149 description: Request was successful
3150 content:
3151 application/json:
3152 schema:
3153 type: object
3154 application/xml:
3155 schema:
3156 type: object
3157 text/xml:
3158 schema:
3159 type: object
3160 application/javascript:
3161 schema:
3162 type: object
3163 text/javascript:
3164 schema:
3165 type: object
3166 deprecated: false
3167 "/Stores/{id}/detail":
3168 get:
3169 tags:
3170 - Store
3171 summary: Gets the details of a store for BO
3172 operationId: Store.getDetail
3173 parameters:
3174 - name: id
3175 in: path
3176 required: true
3177 schema:
3178 type: string
3179 - name: tenant
3180 in: query
3181 required: false
3182 schema:
3183 type: string
3184 responses:
3185 "200":
3186 description: Request was successful
3187 content:
3188 application/json:
3189 schema:
3190 $ref: "#/components/schemas/Store"
3191 application/xml:
3192 schema:
3193 $ref: "#/components/schemas/Store"
3194 text/xml:
3195 schema:
3196 $ref: "#/components/schemas/Store"
3197 application/javascript:
3198 schema:
3199 $ref: "#/components/schemas/Store"
3200 text/javascript:
3201 schema:
3202 $ref: "#/components/schemas/Store"
3203 deprecated: false
3204 /Stores:
3205 post:
3206 tags:
3207 - Store
3208 summary: Creates an store
3209 operationId: Store.create
3210 requestBody:
3211 $ref: "#/components/requestBodies/Store"
3212 responses:
3213 "200":
3214 description: Request was successful
3215 content:
3216 application/json:
3217 schema:
3218 type: object
3219 application/xml:
3220 schema:
3221 type: object
3222 text/xml:
3223 schema:
3224 type: object
3225 application/javascript:
3226 schema:
3227 type: object
3228 text/javascript:
3229 schema:
3230 type: object
3231 deprecated: false
3232 "/Stores/{id}/update":
3233 patch:
3234 tags:
3235 - Store
3236 summary: Updates an store
3237 operationId: Store.update
3238 parameters:
3239 - name: id
3240 in: path
3241 required: true
3242 schema:
3243 type: string
3244 requestBody:
3245 $ref: "#/components/requestBodies/Store"
3246 responses:
3247 "200":
3248 description: Request was successful
3249 content:
3250 application/json:
3251 schema:
3252 type: object
3253 application/xml:
3254 schema:
3255 type: object
3256 text/xml:
3257 schema:
3258 type: object
3259 application/javascript:
3260 schema:
3261 type: object
3262 text/javascript:
3263 schema:
3264 type: object
3265 deprecated: false
3266 "/Stores/{id}/schemes":
3267 get:
3268 tags:
3269 - Store
3270 summary: Gets a store with schemes
3271 operationId: Store.schemes
3272 parameters:
3273 - name: id
3274 in: path
3275 required: true
3276 schema:
3277 type: string
3278 responses:
3279 "200":
3280 description: Request was successful
3281 content:
3282 application/json:
3283 schema:
3284 $ref: "#/components/schemas/Store"
3285 application/xml:
3286 schema:
3287 $ref: "#/components/schemas/Store"
3288 text/xml:
3289 schema:
3290 $ref: "#/components/schemas/Store"
3291 application/javascript:
3292 schema:
3293 $ref: "#/components/schemas/Store"
3294 text/javascript:
3295 schema:
3296 $ref: "#/components/schemas/Store"
3297 deprecated: false
3298 "/Stores/{id}/refresh-time-slots":
3299 get:
3300 tags:
3301 - Store
3302 summary: Refreshes the timeslots of the store
3303 operationId: Store.refreshTimeSlots
3304 parameters:
3305 - name: id
3306 in: path
3307 required: true
3308 schema:
3309 type: string
3310 responses:
3311 "200":
3312 description: Request was successful
3313 content:
3314 application/json:
3315 schema:
3316 $ref: "#/components/schemas/Store"
3317 application/xml:
3318 schema:
3319 $ref: "#/components/schemas/Store"
3320 text/xml:
3321 schema:
3322 $ref: "#/components/schemas/Store"
3323 application/javascript:
3324 schema:
3325 $ref: "#/components/schemas/Store"
3326 text/javascript:
3327 schema:
3328 $ref: "#/components/schemas/Store"
3329 deprecated: false
3330 "/Stores/{id}/enable/{tenant}":
3331 put:
3332 tags:
3333 - Store
3334 summary: Enables a store on a tenant
3335 operationId: Store.enable
3336 parameters:
3337 - name: id
3338 in: path
3339 required: true
3340 schema:
3341 type: string
3342 - name: tenant
3343 in: path
3344 required: true
3345 schema:
3346 type: string
3347 responses:
3348 "200":
3349 description: Request was successful
3350 content:
3351 application/json:
3352 schema:
3353 type: boolean
3354 application/xml:
3355 schema:
3356 type: boolean
3357 text/xml:
3358 schema:
3359 type: boolean
3360 application/javascript:
3361 schema:
3362 type: boolean
3363 text/javascript:
3364 schema:
3365 type: boolean
3366 deprecated: false
3367 "/Stores/{id}/disable/{tenant}":
3368 put:
3369 tags:
3370 - Store
3371 summary: Disables a store on a tenant
3372 operationId: Store.disable
3373 parameters:
3374 - name: id
3375 in: path
3376 required: true
3377 schema:
3378 type: string
3379 - name: tenant
3380 in: path
3381 required: true
3382 schema:
3383 type: string
3384 responses:
3385 "200":
3386 description: Request was successful
3387 content:
3388 application/json:
3389 schema:
3390 type: boolean
3391 application/xml:
3392 schema:
3393 type: boolean
3394 text/xml:
3395 schema:
3396 type: boolean
3397 application/javascript:
3398 schema:
3399 type: boolean
3400 text/javascript:
3401 schema:
3402 type: boolean
3403 deprecated: false
3404 "/auth/{id}":
3405 get:
3406 tags:
3407 - Auth
3408 summary: Find a model instance by {{id}} from the data source.
3409 operationId: Auth.findById
3410 parameters:
3411 - name: id
3412 in: path
3413 description: Model id
3414 required: true
3415 schema:
3416 type: string
3417 format: JSON
3418 - name: filter
3419 in: query
3420 description: Filter defining fields and include - must be a JSON-encoded string
3421 ({"something":"value"})
3422 required: false
3423 schema:
3424 type: string
3425 format: JSON
3426 responses:
3427 "200":
3428 description: Request was successful
3429 content:
3430 application/json:
3431 schema:
3432 $ref: "#/components/schemas/Auth"
3433 application/xml:
3434 schema:
3435 $ref: "#/components/schemas/Auth"
3436 text/xml:
3437 schema:
3438 $ref: "#/components/schemas/Auth"
3439 application/javascript:
3440 schema:
3441 $ref: "#/components/schemas/Auth"
3442 text/javascript:
3443 schema:
3444 $ref: "#/components/schemas/Auth"
3445 deprecated: false
3446 "/auth/from-customer-id/{customerId}":
3447 get:
3448 tags:
3449 - Auth
3450 summary: Gets auth by customerId.
3451 operationId: Auth.getFromCustomerId
3452 parameters:
3453 - name: customerId
3454 in: path
3455 required: true
3456 schema:
3457 type: string
3458 - name: filter
3459 in: query
3460 required: false
3461 schema:
3462 type: string
3463 format: JSON
3464 responses:
3465 "200":
3466 description: Request was successful
3467 content:
3468 application/json:
3469 schema:
3470 $ref: "#/components/schemas/Auth"
3471 application/xml:
3472 schema:
3473 $ref: "#/components/schemas/Auth"
3474 text/xml:
3475 schema:
3476 $ref: "#/components/schemas/Auth"
3477 application/javascript:
3478 schema:
3479 $ref: "#/components/schemas/Auth"
3480 text/javascript:
3481 schema:
3482 $ref: "#/components/schemas/Auth"
3483 deprecated: false
3484 /auth/whoami:
3485 get:
3486 tags:
3487 - Auth
3488 summary: Get the customer with all it's user instances.
3489 operationId: Auth.whoami
3490 parameters:
3491 - name: type
3492 in: query
3493 required: false
3494 schema:
3495 type: string
3496 default: sb
3497 responses:
3498 "200":
3499 description: Request was successful
3500 content:
3501 application/json:
3502 schema:
3503 $ref: "#/components/schemas/Customer"
3504 application/xml:
3505 schema:
3506 $ref: "#/components/schemas/Customer"
3507 text/xml:
3508 schema:
3509 $ref: "#/components/schemas/Customer"
3510 application/javascript:
3511 schema:
3512 $ref: "#/components/schemas/Customer"
3513 text/javascript:
3514 schema:
3515 $ref: "#/components/schemas/Customer"
3516 deprecated: false
3517 "/auth/login/{type}":
3518 post:
3519 tags:
3520 - Auth
3521 summary: login user for certain tenant.
3522 operationId: Auth.login
3523 parameters:
3524 - name: type
3525 in: path
3526 required: true
3527 schema:
3528 type: string
3529 requestBody:
3530 $ref: "#/components/requestBodies/Customer.updateBody"
3531 responses:
3532 "200":
3533 description: Request was successful
3534 content:
3535 application/json:
3536 schema:
3537 $ref: "#/components/schemas/AccessToken"
3538 application/xml:
3539 schema:
3540 $ref: "#/components/schemas/AccessToken"
3541 text/xml:
3542 schema:
3543 $ref: "#/components/schemas/AccessToken"
3544 application/javascript:
3545 schema:
3546 $ref: "#/components/schemas/AccessToken"
3547 text/javascript:
3548 schema:
3549 $ref: "#/components/schemas/AccessToken"
3550 deprecated: false
3551 /auth/register:
3552 post:
3553 tags:
3554 - Auth
3555 summary: Register base login on sb tenant.
3556 operationId: Auth.register
3557 requestBody:
3558 $ref: "#/components/requestBodies/Customer.updateBody"
3559 responses:
3560 "200":
3561 description: Request was successful
3562 content:
3563 application/json:
3564 schema:
3565 type: object
3566 application/xml:
3567 schema:
3568 type: object
3569 text/xml:
3570 schema:
3571 type: object
3572 application/javascript:
3573 schema:
3574 type: object
3575 text/javascript:
3576 schema:
3577 type: object
3578 deprecated: false
3579 /auth/facebook:
3580 get:
3581 tags:
3582 - Auth
3583 summary: Redirect to facebook login environment.
3584 operationId: Auth.facebookLogin
3585 responses:
3586 "200":
3587 description: Request was successful
3588 content:
3589 application/json:
3590 schema:
3591 type: object
3592 application/xml:
3593 schema:
3594 type: object
3595 text/xml:
3596 schema:
3597 type: object
3598 application/javascript:
3599 schema:
3600 type: object
3601 text/javascript:
3602 schema:
3603 type: object
3604 deprecated: false
3605 /auth/facebook/token:
3606 get:
3607 tags:
3608 - Auth
3609 summary: Processes user based on received code for facebook.
3610 operationId: Auth.facebookToken
3611 parameters:
3612 - name: code
3613 in: query
3614 required: true
3615 schema:
3616 type: string
3617 responses:
3618 "200":
3619 description: Request was successful
3620 content:
3621 application/json:
3622 schema:
3623 $ref: "#/components/schemas/AccessToken"
3624 application/xml:
3625 schema:
3626 $ref: "#/components/schemas/AccessToken"
3627 text/xml:
3628 schema:
3629 $ref: "#/components/schemas/AccessToken"
3630 application/javascript:
3631 schema:
3632 $ref: "#/components/schemas/AccessToken"
3633 text/javascript:
3634 schema:
3635 $ref: "#/components/schemas/AccessToken"
3636 deprecated: false
3637 /auth/facebook/callback:
3638 get:
3639 tags:
3640 - Auth
3641 summary: Processes user based on received code for facebook and redirects them to
3642 superbuddy.
3643 operationId: Auth.facebookCallback
3644 parameters:
3645 - name: code
3646 in: query
3647 required: false
3648 schema:
3649 type: string
3650 responses:
3651 "200":
3652 description: Request was successful
3653 content:
3654 application/json:
3655 schema:
3656 type: string
3657 application/xml:
3658 schema:
3659 type: string
3660 text/xml:
3661 schema:
3662 type: string
3663 application/javascript:
3664 schema:
3665 type: string
3666 text/javascript:
3667 schema:
3668 type: string
3669 deprecated: false
3670 /auth/roles:
3671 get:
3672 tags:
3673 - Auth
3674 summary: Get the customer's roles.
3675 operationId: Auth.getRoles
3676 parameters:
3677 - name: authId
3678 in: query
3679 required: false
3680 schema:
3681 type: string
3682 responses:
3683 "200":
3684 description: Request was successful
3685 content:
3686 application/json:
3687 schema:
3688 type: array
3689 items:
3690 $ref: "#/components/schemas/x-any"
3691 application/xml:
3692 schema:
3693 type: array
3694 items:
3695 $ref: "#/components/schemas/x-any"
3696 text/xml:
3697 schema:
3698 type: array
3699 items:
3700 $ref: "#/components/schemas/x-any"
3701 application/javascript:
3702 schema:
3703 type: array
3704 items:
3705 $ref: "#/components/schemas/x-any"
3706 text/javascript:
3707 schema:
3708 type: array
3709 items:
3710 $ref: "#/components/schemas/x-any"
3711 deprecated: false
3712 /auth/roles/all:
3713 get:
3714 tags:
3715 - Auth
3716 summary: Get all roles.
3717 operationId: Auth.getAllRoles
3718 responses:
3719 "200":
3720 description: Request was successful
3721 content:
3722 application/json:
3723 schema:
3724 type: array
3725 items:
3726 $ref: "#/components/schemas/x-any"
3727 application/xml:
3728 schema:
3729 type: array
3730 items:
3731 $ref: "#/components/schemas/x-any"
3732 text/xml:
3733 schema:
3734 type: array
3735 items:
3736 $ref: "#/components/schemas/x-any"
3737 application/javascript:
3738 schema:
3739 type: array
3740 items:
3741 $ref: "#/components/schemas/x-any"
3742 text/javascript:
3743 schema:
3744 type: array
3745 items:
3746 $ref: "#/components/schemas/x-any"
3747 deprecated: false
3748 "/auth/roles/{roleId}/users":
3749 get:
3750 tags:
3751 - Auth
3752 summary: Get all role's customers.
3753 operationId: Auth.getAllRoleUsers
3754 parameters:
3755 - name: roleId
3756 in: path
3757 required: true
3758 schema:
3759 type: string
3760 responses:
3761 "200":
3762 description: Request was successful
3763 content:
3764 application/json:
3765 schema:
3766 type: array
3767 items:
3768 $ref: "#/components/schemas/x-any"
3769 application/xml:
3770 schema:
3771 type: array
3772 items:
3773 $ref: "#/components/schemas/x-any"
3774 text/xml:
3775 schema:
3776 type: array
3777 items:
3778 $ref: "#/components/schemas/x-any"
3779 application/javascript:
3780 schema:
3781 type: array
3782 items:
3783 $ref: "#/components/schemas/x-any"
3784 text/javascript:
3785 schema:
3786 type: array
3787 items:
3788 $ref: "#/components/schemas/x-any"
3789 deprecated: false
3790 "/auth/roles/{roleId}":
3791 post:
3792 tags:
3793 - Auth
3794 summary: Add a role to a Customer.
3795 operationId: Auth.addRole
3796 parameters:
3797 - name: authId
3798 in: path
3799 required: true
3800 schema:
3801 type: string
3802 - name: roleId
3803 in: path
3804 required: true
3805 schema:
3806 type: string
3807 responses:
3808 "200":
3809 description: Request was successful
3810 content:
3811 application/json:
3812 schema:
3813 type: object
3814 application/xml:
3815 schema:
3816 type: object
3817 text/xml:
3818 schema:
3819 type: object
3820 application/javascript:
3821 schema:
3822 type: object
3823 text/javascript:
3824 schema:
3825 type: object
3826 deprecated: false
3827 "/auth/role-by-email/{roleId}":
3828 post:
3829 tags:
3830 - Auth
3831 summary: Add a role to a Customer by email.
3832 operationId: Auth.addRoleByEmail
3833 parameters:
3834 - name: roleId
3835 in: path
3836 required: true
3837 schema:
3838 type: string
3839 requestBody:
3840 content:
3841 application/x-www-form-urlencoded:
3842 schema:
3843 type: object
3844 properties:
3845 email:
3846 type: string
3847 required:
3848 - email
3849 responses:
3850 "200":
3851 description: Request was successful
3852 content:
3853 application/json:
3854 schema:
3855 type: object
3856 application/xml:
3857 schema:
3858 type: object
3859 text/xml:
3860 schema:
3861 type: object
3862 application/javascript:
3863 schema:
3864 type: object
3865 text/javascript:
3866 schema:
3867 type: object
3868 deprecated: false
3869 "/auth/{id}/roles/{roleId}":
3870 delete:
3871 tags:
3872 - Auth
3873 summary: Remove a role to a user.
3874 operationId: Auth.removeRole
3875 parameters:
3876 - name: id
3877 in: path
3878 required: true
3879 schema:
3880 type: string
3881 - name: roleId
3882 in: path
3883 required: true
3884 schema:
3885 type: string
3886 responses:
3887 "200":
3888 description: Request was successful
3889 content:
3890 application/json:
3891 schema:
3892 type: object
3893 application/xml:
3894 schema:
3895 type: object
3896 text/xml:
3897 schema:
3898 type: object
3899 application/javascript:
3900 schema:
3901 type: object
3902 text/javascript:
3903 schema:
3904 type: object
3905 deprecated: false
3906 /auth/roles/check:
3907 get:
3908 tags:
3909 - Auth
3910 summary: Check if a user has a role.
3911 operationId: Auth.hasRole
3912 parameters:
3913 - name: userId
3914 in: query
3915 required: false
3916 schema:
3917 type: string
3918 - name: roleName
3919 in: query
3920 required: true
3921 schema:
3922 type: string
3923 - name: skipSuperAdmin
3924 in: query
3925 required: false
3926 schema:
3927 type: boolean
3928 responses:
3929 "200":
3930 description: Request was successful
3931 content:
3932 application/json:
3933 schema:
3934 type: boolean
3935 application/xml:
3936 schema:
3937 type: boolean
3938 text/xml:
3939 schema:
3940 type: boolean
3941 application/javascript:
3942 schema:
3943 type: boolean
3944 text/javascript:
3945 schema:
3946 type: boolean
3947 deprecated: false
3948 /auth/reset/request:
3949 get:
3950 tags:
3951 - Auth
3952 operationId: Auth.requestResetToken
3953 parameters:
3954 - name: email
3955 in: query
3956 required: true
3957 schema:
3958 type: string
3959 responses:
3960 "200":
3961 description: Request was successful
3962 content:
3963 application/json:
3964 schema:
3965 type: object
3966 application/xml:
3967 schema:
3968 type: object
3969 text/xml:
3970 schema:
3971 type: object
3972 application/javascript:
3973 schema:
3974 type: object
3975 text/javascript:
3976 schema:
3977 type: object
3978 deprecated: false
3979 /auth/reset/check:
3980 get:
3981 tags:
3982 - Auth
3983 operationId: Auth.checkResetToken
3984 parameters:
3985 - name: token
3986 in: query
3987 required: true
3988 schema:
3989 type: number
3990 format: double
3991 - name: returnInstance
3992 in: query
3993 required: false
3994 schema:
3995 type: boolean
3996 default: false
3997 responses:
3998 "200":
3999 description: Request was successful
4000 content:
4001 application/json:
4002 schema:
4003 type: object
4004 application/xml:
4005 schema:
4006 type: object
4007 text/xml:
4008 schema:
4009 type: object
4010 application/javascript:
4011 schema:
4012 type: object
4013 text/javascript:
4014 schema:
4015 type: object
4016 deprecated: false
4017 /auth/reset/password:
4018 post:
4019 tags:
4020 - Auth
4021 operationId: Auth.resetPassword
4022 requestBody:
4023 $ref: "#/components/requestBodies/Customer.updateBody"
4024 responses:
4025 "200":
4026 description: Request was successful
4027 content:
4028 application/json:
4029 schema:
4030 type: object
4031 application/xml:
4032 schema:
4033 type: object
4034 text/xml:
4035 schema:
4036 type: object
4037 application/javascript:
4038 schema:
4039 type: object
4040 text/javascript:
4041 schema:
4042 type: object
4043 deprecated: false
4044 /auth/password/update:
4045 put:
4046 tags:
4047 - Auth
4048 operationId: Auth.updatePassword
4049 requestBody:
4050 $ref: "#/components/requestBodies/Customer.updateBody"
4051 responses:
4052 "200":
4053 description: Request was successful
4054 content:
4055 application/json:
4056 schema:
4057 type: object
4058 application/xml:
4059 schema:
4060 type: object
4061 text/xml:
4062 schema:
4063 type: object
4064 application/javascript:
4065 schema:
4066 type: object
4067 text/javascript:
4068 schema:
4069 type: object
4070 deprecated: false
4071 /auth/email-existence:
4072 get:
4073 tags:
4074 - Auth
4075 operationId: Auth.checkEmailExistence
4076 parameters:
4077 - name: email
4078 in: query
4079 required: true
4080 schema:
4081 type: string
4082 responses:
4083 "200":
4084 description: Request was successful
4085 content:
4086 application/json:
4087 schema:
4088 type: object
4089 application/xml:
4090 schema:
4091 type: object
4092 text/xml:
4093 schema:
4094 type: object
4095 application/javascript:
4096 schema:
4097 type: object
4098 text/javascript:
4099 schema:
4100 type: object
4101 deprecated: false
4102 "/auth/{id}/anonimize":
4103 delete:
4104 tags:
4105 - Auth
4106 operationId: Auth.anonimize
4107 parameters:
4108 - name: id
4109 in: path
4110 required: true
4111 schema:
4112 type: string
4113 responses:
4114 "200":
4115 description: Request was successful
4116 content:
4117 application/json:
4118 schema:
4119 type: object
4120 application/xml:
4121 schema:
4122 type: object
4123 text/xml:
4124 schema:
4125 type: object
4126 application/javascript:
4127 schema:
4128 type: object
4129 text/javascript:
4130 schema:
4131 type: object
4132 deprecated: false
4133 /auth/anonimize:
4134 delete:
4135 tags:
4136 - Auth
4137 operationId: Auth.anonimizeSelf
4138 requestBody:
4139 content:
4140 application/x-www-form-urlencoded:
4141 schema:
4142 type: object
4143 properties:
4144 password:
4145 type: string
4146 required:
4147 - password
4148 responses:
4149 "200":
4150 description: Request was successful
4151 content:
4152 application/json:
4153 schema:
4154 type: object
4155 application/xml:
4156 schema:
4157 type: object
4158 text/xml:
4159 schema:
4160 type: object
4161 application/javascript:
4162 schema:
4163 type: object
4164 text/javascript:
4165 schema:
4166 type: object
4167 deprecated: false
4168 "/auth/{id}/upsert-salesforce":
4169 put:
4170 tags:
4171 - Auth
4172 operationId: Auth.upsertSalesforce
4173 parameters:
4174 - name: id
4175 in: path
4176 required: true
4177 schema:
4178 type: string
4179 requestBody:
4180 content:
4181 application/x-www-form-urlencoded:
4182 schema:
4183 type: object
4184 properties:
4185 type:
4186 type: string
4187 responses:
4188 "200":
4189 description: Request was successful
4190 content:
4191 application/json:
4192 schema:
4193 type: object
4194 application/xml:
4195 schema:
4196 type: object
4197 text/xml:
4198 schema:
4199 type: object
4200 application/javascript:
4201 schema:
4202 type: object
4203 text/javascript:
4204 schema:
4205 type: object
4206 deprecated: false
4207 /auth/find-by-body:
4208 post:
4209 tags:
4210 - Auth
4211 summary: Executes find with data from body
4212 operationId: Auth.findByBody
4213 requestBody:
4214 $ref: "#/components/requestBodies/Customer.updateBody"
4215 responses:
4216 "200":
4217 description: Request was successful
4218 content:
4219 application/json:
4220 schema:
4221 $ref: "#/components/schemas/Auth"
4222 application/xml:
4223 schema:
4224 $ref: "#/components/schemas/Auth"
4225 text/xml:
4226 schema:
4227 $ref: "#/components/schemas/Auth"
4228 application/javascript:
4229 schema:
4230 $ref: "#/components/schemas/Auth"
4231 text/javascript:
4232 schema:
4233 $ref: "#/components/schemas/Auth"
4234 deprecated: false
4235 /Buddies/registration-webhook:
4236 post:
4237 tags:
4238 - Buddy
4239 summary: This is a webhook for a typeform registration.
4240 operationId: Buddy.registrationWebhook
4241 requestBody:
4242 content:
4243 application/x-www-form-urlencoded:
4244 schema:
4245 type: object
4246 properties:
4247 buddyregistration:
4248 type: string
4249 format: JSON
4250 required:
4251 - buddyregistration
4252 responses:
4253 "200":
4254 description: Request was successful
4255 content:
4256 application/json:
4257 schema:
4258 $ref: "#/components/schemas/Order"
4259 application/xml:
4260 schema:
4261 $ref: "#/components/schemas/Order"
4262 text/xml:
4263 schema:
4264 $ref: "#/components/schemas/Order"
4265 application/javascript:
4266 schema:
4267 $ref: "#/components/schemas/Order"
4268 text/javascript:
4269 schema:
4270 $ref: "#/components/schemas/Order"
4271 deprecated: false
4272 /Buddies/count-orders:
4273 get:
4274 tags:
4275 - Buddy
4276 summary: Count the orders of a buddy.
4277 operationId: Buddy.countOrders
4278 responses:
4279 "200":
4280 description: Request was successful
4281 content:
4282 application/json:
4283 schema:
4284 $ref: "#/components/schemas/Order"
4285 application/xml:
4286 schema:
4287 $ref: "#/components/schemas/Order"
4288 text/xml:
4289 schema:
4290 $ref: "#/components/schemas/Order"
4291 application/javascript:
4292 schema:
4293 $ref: "#/components/schemas/Order"
4294 text/javascript:
4295 schema:
4296 $ref: "#/components/schemas/Order"
4297 deprecated: false
4298 /Buddies/order-history:
4299 get:
4300 tags:
4301 - Buddy
4302 summary: returns order history of a buddy.
4303 operationId: Buddy.orderHistory
4304 parameters:
4305 - name: limit
4306 in: query
4307 required: true
4308 schema:
4309 type: number
4310 format: double
4311 - name: skip
4312 in: query
4313 required: true
4314 schema:
4315 type: number
4316 format: double
4317 responses:
4318 "200":
4319 description: Request was successful
4320 content:
4321 application/json:
4322 schema:
4323 type: array
4324 items:
4325 $ref: "#/components/schemas/x-any"
4326 application/xml:
4327 schema:
4328 type: array
4329 items:
4330 $ref: "#/components/schemas/x-any"
4331 text/xml:
4332 schema:
4333 type: array
4334 items:
4335 $ref: "#/components/schemas/x-any"
4336 application/javascript:
4337 schema:
4338 type: array
4339 items:
4340 $ref: "#/components/schemas/x-any"
4341 text/javascript:
4342 schema:
4343 type: array
4344 items:
4345 $ref: "#/components/schemas/x-any"
4346 deprecated: false
4347 /Buddies/delete-registration:
4348 delete:
4349 tags:
4350 - Buddy
4351 summary: Deletes a registration.
4352 operationId: Buddy.deleteRegistration
4353 requestBody:
4354 content:
4355 application/x-www-form-urlencoded:
4356 schema:
4357 type: object
4358 properties:
4359 registrationId:
4360 type: string
4361 required:
4362 - registrationId
4363 responses:
4364 "200":
4365 description: Request was successful
4366 content:
4367 application/json:
4368 schema:
4369 type: object
4370 application/xml:
4371 schema:
4372 type: object
4373 text/xml:
4374 schema:
4375 type: object
4376 application/javascript:
4377 schema:
4378 type: object
4379 text/javascript:
4380 schema:
4381 type: object
4382 deprecated: false
4383 /Buddies/does-exist:
4384 get:
4385 tags:
4386 - Buddy
4387 summary: Checks if auth is a buddy.
4388 operationId: Buddy.doesExist
4389 parameters:
4390 - name: email
4391 in: query
4392 required: true
4393 schema:
4394 type: string
4395 responses:
4396 "200":
4397 description: Request was successful
4398 content:
4399 application/json:
4400 schema:
4401 type: boolean
4402 application/xml:
4403 schema:
4404 type: boolean
4405 text/xml:
4406 schema:
4407 type: boolean
4408 application/javascript:
4409 schema:
4410 type: boolean
4411 text/javascript:
4412 schema:
4413 type: boolean
4414 deprecated: false
4415 /Buddies/stores/link:
4416 put:
4417 tags:
4418 - Buddy
4419 summary: Links store to buddy.
4420 operationId: Buddy.linkManyStores
4421 requestBody:
4422 $ref: "#/components/requestBodies/Buddy.linkManyStores"
4423 responses:
4424 "200":
4425 description: Request was successful
4426 content:
4427 application/json:
4428 schema:
4429 type: object
4430 properties:
4431 success:
4432 type: boolean
4433 application/xml:
4434 schema:
4435 type: object
4436 properties:
4437 success:
4438 type: boolean
4439 text/xml:
4440 schema:
4441 type: object
4442 properties:
4443 success:
4444 type: boolean
4445 application/javascript:
4446 schema:
4447 type: object
4448 properties:
4449 success:
4450 type: boolean
4451 text/javascript:
4452 schema:
4453 type: object
4454 properties:
4455 success:
4456 type: boolean
4457 deprecated: false
4458 /Buddies/stores/unlink:
4459 put:
4460 tags:
4461 - Buddy
4462 summary: Unlinks store from buddy.
4463 operationId: Buddy.unlinkManyStores
4464 requestBody:
4465 $ref: "#/components/requestBodies/Buddy.linkManyStores"
4466 responses:
4467 "200":
4468 description: Request was successful
4469 content:
4470 application/json:
4471 schema:
4472 type: object
4473 properties:
4474 success:
4475 type: boolean
4476 application/xml:
4477 schema:
4478 type: object
4479 properties:
4480 success:
4481 type: boolean
4482 text/xml:
4483 schema:
4484 type: object
4485 properties:
4486 success:
4487 type: boolean
4488 application/javascript:
4489 schema:
4490 type: object
4491 properties:
4492 success:
4493 type: boolean
4494 text/javascript:
4495 schema:
4496 type: object
4497 properties:
4498 success:
4499 type: boolean
4500 deprecated: false
4501 /Buddies/create-new:
4502 post:
4503 tags:
4504 - Buddy
4505 summary: Registers a new buddy
4506 operationId: Buddy.register
4507 requestBody:
4508 $ref: "#/components/requestBodies/Store.updateClosedSchemeSchemeobj"
4509 responses:
4510 "200":
4511 description: Request was successful
4512 content:
4513 application/json:
4514 schema:
4515 $ref: "#/components/schemas/Buddy"
4516 application/xml:
4517 schema:
4518 $ref: "#/components/schemas/Buddy"
4519 text/xml:
4520 schema:
4521 $ref: "#/components/schemas/Buddy"
4522 application/javascript:
4523 schema:
4524 $ref: "#/components/schemas/Buddy"
4525 text/javascript:
4526 schema:
4527 $ref: "#/components/schemas/Buddy"
4528 deprecated: false
4529 /Buddies/get-by-city:
4530 get:
4531 tags:
4532 - Buddy
4533 summary: Get all by city
4534 operationId: Buddy.getAllByCity
4535 parameters:
4536 - name: cityId
4537 in: query
4538 required: false
4539 schema:
4540 type: string
4541 responses:
4542 "200":
4543 description: Request was successful
4544 content:
4545 application/json:
4546 schema:
4547 type: array
4548 items:
4549 $ref: "#/components/schemas/x-any"
4550 application/xml:
4551 schema:
4552 type: array
4553 items:
4554 $ref: "#/components/schemas/x-any"
4555 text/xml:
4556 schema:
4557 type: array
4558 items:
4559 $ref: "#/components/schemas/x-any"
4560 application/javascript:
4561 schema:
4562 type: array
4563 items:
4564 $ref: "#/components/schemas/x-any"
4565 text/javascript:
4566 schema:
4567 type: array
4568 items:
4569 $ref: "#/components/schemas/x-any"
4570 deprecated: false
4571 /Buddies/assign-buddy:
4572 put:
4573 tags:
4574 - Buddy
4575 summary: Change buddy assigned to order
4576 operationId: Buddy.assignToOrder
4577 requestBody:
4578 content:
4579 application/x-www-form-urlencoded:
4580 schema:
4581 type: object
4582 properties:
4583 customerId:
4584 type: string
4585 orderId:
4586 type: string
4587 required:
4588 - orderId
4589 responses:
4590 "200":
4591 description: Request was successful
4592 content:
4593 application/json:
4594 schema:
4595 $ref: "#/components/schemas/Order"
4596 application/xml:
4597 schema:
4598 $ref: "#/components/schemas/Order"
4599 text/xml:
4600 schema:
4601 $ref: "#/components/schemas/Order"
4602 application/javascript:
4603 schema:
4604 $ref: "#/components/schemas/Order"
4605 text/javascript:
4606 schema:
4607 $ref: "#/components/schemas/Order"
4608 deprecated: false
4609 "/Buddies/order/{orderId}/is-live-updated":
4610 get:
4611 tags:
4612 - Buddy
4613 summary: Returns a boolean whether an order is live updated.
4614 operationId: Buddy.isOrderLiveUpdated
4615 parameters:
4616 - name: orderId
4617 in: path
4618 required: true
4619 schema:
4620 type: string
4621 responses:
4622 "200":
4623 description: Request was successful
4624 content:
4625 application/json:
4626 schema:
4627 type: boolean
4628 application/xml:
4629 schema:
4630 type: boolean
4631 text/xml:
4632 schema:
4633 type: boolean
4634 application/javascript:
4635 schema:
4636 type: boolean
4637 text/javascript:
4638 schema:
4639 type: boolean
4640 deprecated: false
4641 "/Buddies/{customerId}/detail":
4642 get:
4643 tags:
4644 - Buddy
4645 summary: Get buddy by id
4646 operationId: Buddy.detailByCustomerId
4647 parameters:
4648 - name: customerId
4649 in: path
4650 required: true
4651 schema:
4652 type: string
4653 responses:
4654 "200":
4655 description: Request was successful
4656 content:
4657 application/json:
4658 schema:
4659 $ref: "#/components/schemas/Buddy"
4660 application/xml:
4661 schema:
4662 $ref: "#/components/schemas/Buddy"
4663 text/xml:
4664 schema:
4665 $ref: "#/components/schemas/Buddy"
4666 application/javascript:
4667 schema:
4668 $ref: "#/components/schemas/Buddy"
4669 text/javascript:
4670 schema:
4671 $ref: "#/components/schemas/Buddy"
4672 deprecated: false
4673 "/Buddies/{id}/update":
4674 put:
4675 tags:
4676 - Buddy
4677 summary: Update attributes of the buddy
4678 operationId: Buddy.updateById
4679 parameters:
4680 - name: id
4681 in: path
4682 required: true
4683 schema:
4684 type: string
4685 requestBody:
4686 content:
4687 application/x-www-form-urlencoded:
4688 schema:
4689 type: object
4690 properties:
4691 attributes:
4692 type: string
4693 format: JSON
4694 required:
4695 - attributes
4696 responses:
4697 "200":
4698 description: Request was successful
4699 content:
4700 application/json:
4701 schema:
4702 $ref: "#/components/schemas/Buddy"
4703 application/xml:
4704 schema:
4705 $ref: "#/components/schemas/Buddy"
4706 text/xml:
4707 schema:
4708 $ref: "#/components/schemas/Buddy"
4709 application/javascript:
4710 schema:
4711 $ref: "#/components/schemas/Buddy"
4712 text/javascript:
4713 schema:
4714 $ref: "#/components/schemas/Buddy"
4715 deprecated: false
4716 /Buddies/change-product-status:
4717 put:
4718 tags:
4719 - Buddy
4720 summary: Change the status of a product. (orderline)
4721 operationId: Buddy.changeProductStatus
4722 requestBody:
4723 content:
4724 application/x-www-form-urlencoded:
4725 schema:
4726 type: object
4727 properties:
4728 orderId:
4729 type: string
4730 productId:
4731 type: string
4732 status:
4733 type: string
4734 alternativeQuantity:
4735 type: string
4736 alternativePrice:
4737 type: string
4738 required:
4739 - orderId
4740 - productId
4741 - status
4742 responses:
4743 "200":
4744 description: Request was successful
4745 content:
4746 application/json:
4747 schema:
4748 $ref: "#/components/schemas/Order"
4749 application/xml:
4750 schema:
4751 $ref: "#/components/schemas/Order"
4752 text/xml:
4753 schema:
4754 $ref: "#/components/schemas/Order"
4755 application/javascript:
4756 schema:
4757 $ref: "#/components/schemas/Order"
4758 text/javascript:
4759 schema:
4760 $ref: "#/components/schemas/Order"
4761 deprecated: false
4762 /Buddies/get-registrations:
4763 get:
4764 tags:
4765 - Buddy
4766 summary: Get all buddy registration within a city
4767 operationId: Buddy.getRegistrations
4768 parameters:
4769 - name: limit
4770 in: query
4771 required: false
4772 schema:
4773 type: number
4774 format: double
4775 - name: skip
4776 in: query
4777 required: false
4778 schema:
4779 type: number
4780 format: double
4781 - name: city
4782 in: query
4783 required: false
4784 schema:
4785 type: string
4786 responses:
4787 "200":
4788 description: Request was successful
4789 content:
4790 application/json:
4791 schema:
4792 type: object
4793 application/xml:
4794 schema:
4795 type: object
4796 text/xml:
4797 schema:
4798 type: object
4799 application/javascript:
4800 schema:
4801 type: object
4802 text/javascript:
4803 schema:
4804 type: object
4805 deprecated: false
4806 "/Buddies/{id}/get-registration-by-id":
4807 get:
4808 tags:
4809 - Buddy
4810 summary: Get buddy registration specified by ID
4811 operationId: Buddy.getRegistrationById
4812 parameters:
4813 - name: id
4814 in: path
4815 required: true
4816 schema:
4817 type: string
4818 responses:
4819 "200":
4820 description: Request was successful
4821 content:
4822 application/json:
4823 schema:
4824 type: object
4825 application/xml:
4826 schema:
4827 type: object
4828 text/xml:
4829 schema:
4830 type: object
4831 application/javascript:
4832 schema:
4833 type: object
4834 text/javascript:
4835 schema:
4836 type: object
4837 deprecated: false
4838 /Buddies/open-orders:
4839 get:
4840 tags:
4841 - Buddy
4842 summary: Get a list of open orders.
4843 operationId: Buddy.openOrders
4844 responses:
4845 "200":
4846 description: Request was successful
4847 content:
4848 application/json:
4849 schema:
4850 $ref: "#/components/schemas/Order"
4851 application/xml:
4852 schema:
4853 $ref: "#/components/schemas/Order"
4854 text/xml:
4855 schema:
4856 $ref: "#/components/schemas/Order"
4857 application/javascript:
4858 schema:
4859 $ref: "#/components/schemas/Order"
4860 text/javascript:
4861 schema:
4862 $ref: "#/components/schemas/Order"
4863 deprecated: false
4864 /Buddies/accept-order:
4865 put:
4866 tags:
4867 - Buddy
4868 summary: Assigns buddy to order and set order to inProgress.
4869 operationId: Buddy.acceptOrder
4870 requestBody:
4871 $ref: "#/components/requestBodies/Payment.payLiveOrder"
4872 responses:
4873 "200":
4874 description: Request was successful
4875 content:
4876 application/json:
4877 schema:
4878 $ref: "#/components/schemas/Order"
4879 application/xml:
4880 schema:
4881 $ref: "#/components/schemas/Order"
4882 text/xml:
4883 schema:
4884 $ref: "#/components/schemas/Order"
4885 application/javascript:
4886 schema:
4887 $ref: "#/components/schemas/Order"
4888 text/javascript:
4889 schema:
4890 $ref: "#/components/schemas/Order"
4891 deprecated: false
4892 /Buddies/decline-order:
4893 put:
4894 tags:
4895 - Buddy
4896 summary: Add buddy to declinedBy.
4897 operationId: Buddy.declineOrder
4898 requestBody:
4899 content:
4900 application/x-www-form-urlencoded:
4901 schema:
4902 type: object
4903 properties:
4904 orderId:
4905 type: string
4906 reason:
4907 type: string
4908 required:
4909 - orderId
4910 - reason
4911 responses:
4912 "200":
4913 description: Request was successful
4914 content:
4915 application/json:
4916 schema:
4917 $ref: "#/components/schemas/Order"
4918 application/xml:
4919 schema:
4920 $ref: "#/components/schemas/Order"
4921 text/xml:
4922 schema:
4923 $ref: "#/components/schemas/Order"
4924 application/javascript:
4925 schema:
4926 $ref: "#/components/schemas/Order"
4927 text/javascript:
4928 schema:
4929 $ref: "#/components/schemas/Order"
4930 deprecated: false
4931 /Buddies/availability/create:
4932 post:
4933 tags:
4934 - Buddy
4935 summary: Add availability to a buddy.
4936 operationId: Buddy.createAvailability
4937 requestBody:
4938 $ref: "#/components/requestBodies/Customer.updateBody"
4939 responses:
4940 "200":
4941 description: Request was successful
4942 content:
4943 application/json:
4944 schema:
4945 type: object
4946 application/xml:
4947 schema:
4948 type: object
4949 text/xml:
4950 schema:
4951 type: object
4952 application/javascript:
4953 schema:
4954 type: object
4955 text/javascript:
4956 schema:
4957 type: object
4958 deprecated: false
4959 /Buddies/availability/current:
4960 get:
4961 tags:
4962 - Buddy
4963 summary: Get a list of availabilities that haven't yet passed.
4964 operationId: Buddy.currentAvailabilities
4965 responses:
4966 "200":
4967 description: Request was successful
4968 content:
4969 application/json:
4970 schema:
4971 type: array
4972 items:
4973 $ref: "#/components/schemas/x-any"
4974 application/xml:
4975 schema:
4976 type: array
4977 items:
4978 $ref: "#/components/schemas/x-any"
4979 text/xml:
4980 schema:
4981 type: array
4982 items:
4983 $ref: "#/components/schemas/x-any"
4984 application/javascript:
4985 schema:
4986 type: array
4987 items:
4988 $ref: "#/components/schemas/x-any"
4989 text/javascript:
4990 schema:
4991 type: array
4992 items:
4993 $ref: "#/components/schemas/x-any"
4994 deprecated: false
4995 "/Buddies/availability/update/{fk}":
4996 put:
4997 tags:
4998 - Buddy
4999 summary: Patch attributes for a model instance and persist it into the data
5000 source.
5001 operationId: Buddy.updateAvailability
5002 parameters:
5003 - name: fk
5004 in: path
5005 required: true
5006 schema:
5007 type: string
5008 requestBody:
5009 $ref: "#/components/requestBodies/Customer.updateBody"
5010 responses:
5011 "200":
5012 description: Request was successful
5013 content:
5014 application/json:
5015 schema:
5016 type: array
5017 items:
5018 $ref: "#/components/schemas/x-any"
5019 application/xml:
5020 schema:
5021 type: array
5022 items:
5023 $ref: "#/components/schemas/x-any"
5024 text/xml:
5025 schema:
5026 type: array
5027 items:
5028 $ref: "#/components/schemas/x-any"
5029 application/javascript:
5030 schema:
5031 type: array
5032 items:
5033 $ref: "#/components/schemas/x-any"
5034 text/javascript:
5035 schema:
5036 type: array
5037 items:
5038 $ref: "#/components/schemas/x-any"
5039 deprecated: false
5040 "/Buddies/availability/{fk}/update-as-operator":
5041 put:
5042 tags:
5043 - Buddy
5044 summary: Patch attributes for a model instance and persist it into the data
5045 source.
5046 operationId: Buddy.updateAvailabilityAsOperator
5047 parameters:
5048 - name: fk
5049 in: path
5050 required: true
5051 schema:
5052 type: string
5053 requestBody:
5054 $ref: "#/components/requestBodies/Customer.updateBody"
5055 responses:
5056 "200":
5057 description: Request was successful
5058 content:
5059 application/json:
5060 schema:
5061 type: array
5062 items:
5063 $ref: "#/components/schemas/x-any"
5064 application/xml:
5065 schema:
5066 type: array
5067 items:
5068 $ref: "#/components/schemas/x-any"
5069 text/xml:
5070 schema:
5071 type: array
5072 items:
5073 $ref: "#/components/schemas/x-any"
5074 application/javascript:
5075 schema:
5076 type: array
5077 items:
5078 $ref: "#/components/schemas/x-any"
5079 text/javascript:
5080 schema:
5081 type: array
5082 items:
5083 $ref: "#/components/schemas/x-any"
5084 deprecated: false
5085 "/Buddies/availability/delete/{fk}":
5086 delete:
5087 tags:
5088 - Buddy
5089 summary: Delete own availability.
5090 operationId: Buddy.deleteAvailability
5091 parameters:
5092 - name: fk
5093 in: path
5094 required: true
5095 schema:
5096 type: string
5097 responses:
5098 "200":
5099 description: Request was successful
5100 content:
5101 application/json:
5102 schema:
5103 type: object
5104 application/xml:
5105 schema:
5106 type: object
5107 text/xml:
5108 schema:
5109 type: object
5110 application/javascript:
5111 schema:
5112 type: object
5113 text/javascript:
5114 schema:
5115 type: object
5116 deprecated: false
5117 /Buddies/availability/delete-many:
5118 post:
5119 tags:
5120 - Buddy
5121 summary: Delete a related item by id for availability.
5122 operationId: Buddy.deleteManyAvailability
5123 requestBody:
5124 $ref: "#/components/requestBodies/Customer.updateBody"
5125 responses:
5126 "200":
5127 description: Request was successful
5128 content:
5129 application/json:
5130 schema:
5131 type: object
5132 application/xml:
5133 schema:
5134 type: object
5135 text/xml:
5136 schema:
5137 type: object
5138 application/javascript:
5139 schema:
5140 type: object
5141 text/javascript:
5142 schema:
5143 type: object
5144 deprecated: false
5145 /Buddies/availability/all:
5146 get:
5147 tags:
5148 - Buddy
5149 summary: Get all availabilities in a city.
5150 operationId: Buddy.allAvailabilities
5151 parameters:
5152 - name: cityId
5153 in: query
5154 required: true
5155 schema:
5156 type: string
5157 - name: date
5158 in: query
5159 required: true
5160 schema:
5161 type: string
5162 format: date-time
5163 responses:
5164 "200":
5165 description: Request was successful
5166 content:
5167 application/json:
5168 schema:
5169 type: array
5170 items:
5171 $ref: "#/components/schemas/x-any"
5172 application/xml:
5173 schema:
5174 type: array
5175 items:
5176 $ref: "#/components/schemas/x-any"
5177 text/xml:
5178 schema:
5179 type: array
5180 items:
5181 $ref: "#/components/schemas/x-any"
5182 application/javascript:
5183 schema:
5184 type: array
5185 items:
5186 $ref: "#/components/schemas/x-any"
5187 text/javascript:
5188 schema:
5189 type: array
5190 items:
5191 $ref: "#/components/schemas/x-any"
5192 deprecated: false
5193 /Buddies/orders/in-progress:
5194 get:
5195 tags:
5196 - Buddy
5197 summary: Get in progress orders by buddyId
5198 operationId: Buddy.inProgressOrders
5199 responses:
5200 "200":
5201 description: Request was successful
5202 content:
5203 application/json:
5204 schema:
5205 type: object
5206 application/xml:
5207 schema:
5208 type: object
5209 text/xml:
5210 schema:
5211 type: object
5212 application/javascript:
5213 schema:
5214 type: object
5215 text/javascript:
5216 schema:
5217 type: object
5218 deprecated: false
5219 /Buddies/deliver-order:
5220 put:
5221 tags:
5222 - Buddy
5223 summary: Updates status and receipt price.
5224 operationId: Buddy.deliverOrder
5225 requestBody:
5226 content:
5227 application/x-www-form-urlencoded:
5228 schema:
5229 type: object
5230 properties:
5231 orderId:
5232 type: string
5233 receiptPrice:
5234 type: number
5235 format: double
5236 required:
5237 - orderId
5238 - receiptPrice
5239 responses:
5240 "200":
5241 description: Request was successful
5242 content:
5243 application/json:
5244 schema:
5245 type: object
5246 application/xml:
5247 schema:
5248 type: object
5249 text/xml:
5250 schema:
5251 type: object
5252 application/javascript:
5253 schema:
5254 type: object
5255 text/javascript:
5256 schema:
5257 type: object
5258 deprecated: false
5259 /Buddies/set-identification:
5260 post:
5261 tags:
5262 - Buddy
5263 summary: Sets if the customer had a valid identification for the required
5264 products.
5265 operationId: Buddy.setValidIdentification
5266 requestBody:
5267 content:
5268 application/x-www-form-urlencoded:
5269 schema:
5270 type: object
5271 properties:
5272 orderId:
5273 type: string
5274 isValidIdentification:
5275 type: boolean
5276 required:
5277 - orderId
5278 - isValidIdentification
5279 responses:
5280 "200":
5281 description: Request was successful
5282 content:
5283 application/json:
5284 schema:
5285 type: object
5286 application/xml:
5287 schema:
5288 type: object
5289 text/xml:
5290 schema:
5291 type: object
5292 application/javascript:
5293 schema:
5294 type: object
5295 text/javascript:
5296 schema:
5297 type: object
5298 deprecated: false
5299 "/Buddies/{id}/check-dispatch":
5300 put:
5301 tags:
5302 - Buddy
5303 summary: Checks dispatch and sets found address as dispatch location.
5304 operationId: Buddy.checkDispatch
5305 parameters:
5306 - name: id
5307 in: path
5308 required: true
5309 schema:
5310 type: string
5311 requestBody:
5312 $ref: "#/components/requestBodies/Customer.updateBody"
5313 responses:
5314 "200":
5315 description: Request was successful
5316 content:
5317 application/json:
5318 schema:
5319 type: boolean
5320 application/xml:
5321 schema:
5322 type: boolean
5323 text/xml:
5324 schema:
5325 type: boolean
5326 application/javascript:
5327 schema:
5328 type: boolean
5329 text/javascript:
5330 schema:
5331 type: boolean
5332 deprecated: false
5333 /slack/send:
5334 post:
5335 tags:
5336 - Slack
5337 summary: Send an mail
5338 operationId: Slack.sendMessage
5339 requestBody:
5340 $ref: "#/components/requestBodies/Customer.updateBody"
5341 responses:
5342 "200":
5343 description: Request was successful
5344 content:
5345 application/json:
5346 schema:
5347 type: object
5348 application/xml:
5349 schema:
5350 type: object
5351 text/xml:
5352 schema:
5353 type: object
5354 application/javascript:
5355 schema:
5356 type: object
5357 text/javascript:
5358 schema:
5359 type: object
5360 deprecated: false
5361 "/Cities/{id}/area/link/{areaId}":
5362 put:
5363 tags:
5364 - City
5365 summary: Link an area to this model
5366 operationId: City.linkArea
5367 parameters:
5368 - name: id
5369 in: path
5370 required: true
5371 schema:
5372 type: string
5373 - name: areaId
5374 in: path
5375 required: true
5376 schema:
5377 type: string
5378 responses:
5379 "200":
5380 description: Request was successful
5381 content:
5382 application/json:
5383 schema:
5384 $ref: "#/components/schemas/City"
5385 application/xml:
5386 schema:
5387 $ref: "#/components/schemas/City"
5388 text/xml:
5389 schema:
5390 $ref: "#/components/schemas/City"
5391 application/javascript:
5392 schema:
5393 $ref: "#/components/schemas/City"
5394 text/javascript:
5395 schema:
5396 $ref: "#/components/schemas/City"
5397 deprecated: false
5398 "/Cities/{id}/area/unlink/{areaId}":
5399 put:
5400 tags:
5401 - City
5402 summary: Unlink an area to this model
5403 operationId: City.unlinkArea
5404 parameters:
5405 - name: id
5406 in: path
5407 required: true
5408 schema:
5409 type: string
5410 - name: areaId
5411 in: path
5412 required: true
5413 schema:
5414 type: string
5415 responses:
5416 "200":
5417 description: Request was successful
5418 content:
5419 application/json:
5420 schema:
5421 $ref: "#/components/schemas/City"
5422 application/xml:
5423 schema:
5424 $ref: "#/components/schemas/City"
5425 text/xml:
5426 schema:
5427 $ref: "#/components/schemas/City"
5428 application/javascript:
5429 schema:
5430 $ref: "#/components/schemas/City"
5431 text/javascript:
5432 schema:
5433 $ref: "#/components/schemas/City"
5434 deprecated: false
5435 "/Cities/{id}/area/add":
5436 post:
5437 tags:
5438 - City
5439 summary: Add an area to this model
5440 operationId: City.addArea
5441 parameters:
5442 - name: id
5443 in: path
5444 required: true
5445 schema:
5446 type: string
5447 requestBody:
5448 $ref: "#/components/requestBodies/Area"
5449 responses:
5450 "200":
5451 description: Request was successful
5452 content:
5453 application/json:
5454 schema:
5455 $ref: "#/components/schemas/City"
5456 application/xml:
5457 schema:
5458 $ref: "#/components/schemas/City"
5459 text/xml:
5460 schema:
5461 $ref: "#/components/schemas/City"
5462 application/javascript:
5463 schema:
5464 $ref: "#/components/schemas/City"
5465 text/javascript:
5466 schema:
5467 $ref: "#/components/schemas/City"
5468 deprecated: false
5469 "/Cities/{id}/mapDetail":
5470 get:
5471 tags:
5472 - City
5473 summary: Retrieves the city and all related details for the map
5474 operationId: City.mapDetail
5475 parameters:
5476 - name: id
5477 in: path
5478 required: true
5479 schema:
5480 type: string
5481 responses:
5482 "200":
5483 description: Request was successful
5484 content:
5485 application/json:
5486 schema:
5487 $ref: "#/components/schemas/City"
5488 application/xml:
5489 schema:
5490 $ref: "#/components/schemas/City"
5491 text/xml:
5492 schema:
5493 $ref: "#/components/schemas/City"
5494 application/javascript:
5495 schema:
5496 $ref: "#/components/schemas/City"
5497 text/javascript:
5498 schema:
5499 $ref: "#/components/schemas/City"
5500 deprecated: false
5501 "/Cities/{id}/stores":
5502 get:
5503 tags:
5504 - City
5505 summary: Retrieves the stores of a city
5506 operationId: City.withStores
5507 parameters:
5508 - name: id
5509 in: path
5510 required: true
5511 schema:
5512 type: string
5513 responses:
5514 "200":
5515 description: Request was successful
5516 content:
5517 application/json:
5518 schema:
5519 $ref: "#/components/schemas/Store"
5520 application/xml:
5521 schema:
5522 $ref: "#/components/schemas/Store"
5523 text/xml:
5524 schema:
5525 $ref: "#/components/schemas/Store"
5526 application/javascript:
5527 schema:
5528 $ref: "#/components/schemas/Store"
5529 text/javascript:
5530 schema:
5531 $ref: "#/components/schemas/Store"
5532 deprecated: false
5533 /Cities/all:
5534 get:
5535 tags:
5536 - City
5537 summary: Retrieves all cities
5538 operationId: City.getAll
5539 responses:
5540 "200":
5541 description: Request was successful
5542 content:
5543 application/json:
5544 schema:
5545 type: array
5546 items:
5547 type: object
5548 application/xml:
5549 schema:
5550 type: array
5551 items:
5552 type: object
5553 text/xml:
5554 schema:
5555 type: array
5556 items:
5557 type: object
5558 application/javascript:
5559 schema:
5560 type: array
5561 items:
5562 type: object
5563 text/javascript:
5564 schema:
5565 type: array
5566 items:
5567 type: object
5568 deprecated: false
5569 "/Areas/{id}/delete":
5570 delete:
5571 tags:
5572 - Area
5573 summary: Delete an area and unlinks from city and shops
5574 operationId: Area.delete
5575 parameters:
5576 - name: id
5577 in: path
5578 required: true
5579 schema:
5580 type: string
5581 responses:
5582 "200":
5583 description: Request was successful
5584 content:
5585 application/json:
5586 schema:
5587 type: boolean
5588 application/xml:
5589 schema:
5590 type: boolean
5591 text/xml:
5592 schema:
5593 type: boolean
5594 application/javascript:
5595 schema:
5596 type: boolean
5597 text/javascript:
5598 schema:
5599 type: boolean
5600 deprecated: false
5601 "/Areas/{id}/update":
5602 patch:
5603 tags:
5604 - Area
5605 summary: Updates an area
5606 operationId: Area.update
5607 parameters:
5608 - name: id
5609 in: path
5610 required: true
5611 schema:
5612 type: string
5613 requestBody:
5614 $ref: "#/components/requestBodies/Area"
5615 responses:
5616 "200":
5617 description: Request was successful
5618 content:
5619 application/json:
5620 schema:
5621 type: boolean
5622 application/xml:
5623 schema:
5624 type: boolean
5625 text/xml:
5626 schema:
5627 type: boolean
5628 application/javascript:
5629 schema:
5630 type: boolean
5631 text/javascript:
5632 schema:
5633 type: boolean
5634 deprecated: false
5635 /tos/latest-tos:
5636 get:
5637 tags:
5638 - TOS
5639 summary: Get the latest version of the Tos
5640 operationId: TOS.getLatestTOS
5641 responses:
5642 "200":
5643 description: Request was successful
5644 content:
5645 application/json:
5646 schema:
5647 $ref: "#/components/schemas/TOS"
5648 application/xml:
5649 schema:
5650 $ref: "#/components/schemas/TOS"
5651 text/xml:
5652 schema:
5653 $ref: "#/components/schemas/TOS"
5654 application/javascript:
5655 schema:
5656 $ref: "#/components/schemas/TOS"
5657 text/javascript:
5658 schema:
5659 $ref: "#/components/schemas/TOS"
5660 deprecated: false
5661 /tos/latest-cookies:
5662 get:
5663 tags:
5664 - TOS
5665 summary: Get the latest version of the cookies
5666 operationId: TOS.getLatestCookies
5667 responses:
5668 "200":
5669 description: Request was successful
5670 content:
5671 application/json:
5672 schema:
5673 $ref: "#/components/schemas/TOS"
5674 application/xml:
5675 schema:
5676 $ref: "#/components/schemas/TOS"
5677 text/xml:
5678 schema:
5679 $ref: "#/components/schemas/TOS"
5680 application/javascript:
5681 schema:
5682 $ref: "#/components/schemas/TOS"
5683 text/javascript:
5684 schema:
5685 $ref: "#/components/schemas/TOS"
5686 deprecated: false
5687 /tos/download-latest-tos:
5688 get:
5689 tags:
5690 - TOS
5691 summary: Get a pdf of the latest tos
5692 operationId: TOS.downloadLatestTos
5693 responses:
5694 "200":
5695 description: Request was successful
5696 content:
5697 application/json:
5698 schema:
5699 type: string
5700 format: binary
5701 application/xml:
5702 schema:
5703 type: string
5704 format: binary
5705 text/xml:
5706 schema:
5707 type: string
5708 format: binary
5709 application/javascript:
5710 schema:
5711 type: string
5712 format: binary
5713 text/javascript:
5714 schema:
5715 type: string
5716 format: binary
5717 deprecated: false
5718 /tos/check-tos:
5719 get:
5720 tags:
5721 - TOS
5722 summary: Checks if user tos is equal or not or needs refreshing
5723 operationId: TOS.check
5724 responses:
5725 "200":
5726 description: Request was successful
5727 content:
5728 application/json:
5729 schema:
5730 type: object
5731 application/xml:
5732 schema:
5733 type: object
5734 text/xml:
5735 schema:
5736 type: object
5737 application/javascript:
5738 schema:
5739 type: object
5740 text/javascript:
5741 schema:
5742 type: object
5743 deprecated: false
5744 /tos/accept-latest:
5745 post:
5746 tags:
5747 - TOS
5748 summary: Accept the latest version of the tos
5749 operationId: TOS.accept
5750 responses:
5751 "200":
5752 description: Request was successful
5753 content:
5754 application/json:
5755 schema:
5756 type: object
5757 application/xml:
5758 schema:
5759 type: object
5760 text/xml:
5761 schema:
5762 type: object
5763 application/javascript:
5764 schema:
5765 type: object
5766 text/javascript:
5767 schema:
5768 type: object
5769 deprecated: false
5770 /Reports/range:
5771 get:
5772 tags:
5773 - Report
5774 summary: Gets the order data for finance view of a requested range
5775 operationId: Report.range
5776 parameters:
5777 - name: start
5778 in: query
5779 required: true
5780 schema:
5781 type: string
5782 format: date-time
5783 - name: end
5784 in: query
5785 required: true
5786 schema:
5787 type: string
5788 format: date-time
5789 - name: city
5790 in: query
5791 required: true
5792 schema:
5793 type: string
5794 responses:
5795 "200":
5796 description: Request was successful
5797 content:
5798 application/json:
5799 schema:
5800 type: array
5801 items:
5802 type: object
5803 application/xml:
5804 schema:
5805 type: array
5806 items:
5807 type: object
5808 text/xml:
5809 schema:
5810 type: array
5811 items:
5812 type: object
5813 application/javascript:
5814 schema:
5815 type: array
5816 items:
5817 type: object
5818 text/javascript:
5819 schema:
5820 type: array
5821 items:
5822 type: object
5823 deprecated: false
5824 /Reports/customer-orders:
5825 get:
5826 tags:
5827 - Report
5828 summary: Queries orders and format them for the customer orders view
5829 operationId: Report.customerOrders
5830 parameters:
5831 - name: start
5832 in: query
5833 required: true
5834 schema:
5835 type: string
5836 format: date-time
5837 - name: end
5838 in: query
5839 required: true
5840 schema:
5841 type: string
5842 format: date-time
5843 - name: city
5844 in: query
5845 required: true
5846 schema:
5847 type: string
5848 - name: filters
5849 in: query
5850 required: false
5851 schema:
5852 type: string
5853 format: JSON
5854 responses:
5855 "200":
5856 description: Request was successful
5857 content:
5858 application/json:
5859 schema:
5860 type: array
5861 items:
5862 $ref: "#/components/schemas/x-any"
5863 application/xml:
5864 schema:
5865 type: array
5866 items:
5867 $ref: "#/components/schemas/x-any"
5868 text/xml:
5869 schema:
5870 type: array
5871 items:
5872 $ref: "#/components/schemas/x-any"
5873 application/javascript:
5874 schema:
5875 type: array
5876 items:
5877 $ref: "#/components/schemas/x-any"
5878 text/javascript:
5879 schema:
5880 type: array
5881 items:
5882 $ref: "#/components/schemas/x-any"
5883 deprecated: false
5884 /Reports/customers:
5885 get:
5886 tags:
5887 - Report
5888 summary: Queries customers and orders and format them for the customers view
5889 operationId: Report.customers
5890 parameters:
5891 - name: city
5892 in: query
5893 required: true
5894 schema:
5895 type: string
5896 responses:
5897 "200":
5898 description: Request was successful
5899 content:
5900 application/json:
5901 schema:
5902 type: array
5903 items:
5904 $ref: "#/components/schemas/x-any"
5905 application/xml:
5906 schema:
5907 type: array
5908 items:
5909 $ref: "#/components/schemas/x-any"
5910 text/xml:
5911 schema:
5912 type: array
5913 items:
5914 $ref: "#/components/schemas/x-any"
5915 application/javascript:
5916 schema:
5917 type: array
5918 items:
5919 $ref: "#/components/schemas/x-any"
5920 text/javascript:
5921 schema:
5922 type: array
5923 items:
5924 $ref: "#/components/schemas/x-any"
5925 deprecated: false
5926 /Reports/stores:
5927 get:
5928 tags:
5929 - Report
5930 summary: Queries orders and format them for the orders view
5931 operationId: Report.stores
5932 parameters:
5933 - name: start
5934 in: query
5935 required: false
5936 schema:
5937 type: string
5938 format: date-time
5939 - name: end
5940 in: query
5941 required: false
5942 schema:
5943 type: string
5944 format: date-time
5945 - name: cityId
5946 in: query
5947 required: false
5948 schema:
5949 type: string
5950 - name: brandId
5951 in: query
5952 required: false
5953 schema:
5954 type: string
5955 - name: storeId
5956 in: query
5957 required: false
5958 schema:
5959 type: string
5960 - name: limit
5961 in: query
5962 required: false
5963 schema:
5964 type: number
5965 format: double
5966 - name: skip
5967 in: query
5968 required: false
5969 schema:
5970 type: number
5971 format: double
5972 responses:
5973 "200":
5974 description: Request was successful
5975 content:
5976 application/json:
5977 schema:
5978 type: object
5979 application/xml:
5980 schema:
5981 type: object
5982 text/xml:
5983 schema:
5984 type: object
5985 application/javascript:
5986 schema:
5987 type: object
5988 text/javascript:
5989 schema:
5990 type: object
5991 deprecated: false
5992 /Reports/stores-totals:
5993 get:
5994 tags:
5995 - Report
5996 summary: Queries orders and format them for the orders view
5997 operationId: Report.storesTotals
5998 parameters:
5999 - name: start
6000 in: query
6001 required: false
6002 schema:
6003 type: string
6004 format: date-time
6005 - name: end
6006 in: query
6007 required: false
6008 schema:
6009 type: string
6010 format: date-time
6011 - name: cityId
6012 in: query
6013 required: false
6014 schema:
6015 type: string
6016 - name: brandId
6017 in: query
6018 required: false
6019 schema:
6020 type: string
6021 - name: storeId
6022 in: query
6023 required: false
6024 schema:
6025 type: string
6026 responses:
6027 "200":
6028 description: Request was successful
6029 content:
6030 application/json:
6031 schema:
6032 type: object
6033 application/xml:
6034 schema:
6035 type: object
6036 text/xml:
6037 schema:
6038 type: object
6039 application/javascript:
6040 schema:
6041 type: object
6042 text/javascript:
6043 schema:
6044 type: object
6045 deprecated: false
6046 /Reports/budget:
6047 get:
6048 tags:
6049 - Report
6050 summary: Gets all customers of a city with their budget at a set date
6051 operationId: Report.budget
6052 parameters:
6053 - name: date
6054 in: query
6055 required: false
6056 schema:
6057 type: string
6058 format: date-time
6059 - name: city
6060 in: query
6061 required: false
6062 schema:
6063 type: string
6064 - name: limit
6065 in: query
6066 required: false
6067 schema:
6068 type: number
6069 format: double
6070 - name: skip
6071 in: query
6072 required: false
6073 schema:
6074 type: number
6075 format: double
6076 - name: sort
6077 in: query
6078 required: false
6079 schema:
6080 type: string
6081 format: JSON
6082 - name: order
6083 in: query
6084 required: false
6085 schema:
6086 type: string
6087 format: JSON
6088 responses:
6089 "200":
6090 description: Request was successful
6091 content:
6092 application/json:
6093 schema:
6094 type: object
6095 application/xml:
6096 schema:
6097 type: object
6098 text/xml:
6099 schema:
6100 type: object
6101 application/javascript:
6102 schema:
6103 type: object
6104 text/javascript:
6105 schema:
6106 type: object
6107 deprecated: false
6108 /Reports/dashboard:
6109 get:
6110 tags:
6111 - Report
6112 summary: Gets the dashboard data for a given city
6113 operationId: Report.dashboard
6114 parameters:
6115 - name: city
6116 in: query
6117 required: true
6118 schema:
6119 type: string
6120 responses:
6121 "200":
6122 description: Request was successful
6123 content:
6124 application/json:
6125 schema:
6126 type: object
6127 application/xml:
6128 schema:
6129 type: object
6130 text/xml:
6131 schema:
6132 type: object
6133 application/javascript:
6134 schema:
6135 type: object
6136 text/javascript:
6137 schema:
6138 type: object
6139 deprecated: false
6140 /StoreBrands/get-from-address:
6141 post:
6142 tags:
6143 - StoreBrand
6144 operationId: StoreBrand.getFromAddress
6145 requestBody:
6146 $ref: "#/components/requestBodies/Customer.updateBody"
6147 responses:
6148 "200":
6149 description: Request was successful
6150 content:
6151 application/json:
6152 schema:
6153 type: object
6154 application/xml:
6155 schema:
6156 type: object
6157 text/xml:
6158 schema:
6159 type: object
6160 application/javascript:
6161 schema:
6162 type: object
6163 text/javascript:
6164 schema:
6165 type: object
6166 deprecated: false
6167 /StoreBrands/all:
6168 get:
6169 tags:
6170 - StoreBrand
6171 summary: Gets all store brands
6172 operationId: StoreBrand.all
6173 responses:
6174 "200":
6175 description: Request was successful
6176 content:
6177 application/json:
6178 schema:
6179 type: object
6180 application/xml:
6181 schema:
6182 type: object
6183 text/xml:
6184 schema:
6185 type: object
6186 application/javascript:
6187 schema:
6188 type: object
6189 text/javascript:
6190 schema:
6191 type: object
6192 deprecated: false
6193 /notes/create:
6194 post:
6195 tags:
6196 - Note
6197 summary: Creates a note,
6198 operationId: Note.createNote
6199 requestBody:
6200 content:
6201 application/x-www-form-urlencoded:
6202 schema:
6203 type: object
6204 properties:
6205 text:
6206 type: string
6207 customerId:
6208 type: string
6209 reportedId:
6210 type: string
6211 required:
6212 - text
6213 - customerId
6214 - reportedId
6215 responses:
6216 "200":
6217 description: Request was successful
6218 content:
6219 application/json:
6220 schema:
6221 $ref: "#/components/schemas/ObjectID"
6222 application/xml:
6223 schema:
6224 $ref: "#/components/schemas/ObjectID"
6225 text/xml:
6226 schema:
6227 $ref: "#/components/schemas/ObjectID"
6228 application/javascript:
6229 schema:
6230 $ref: "#/components/schemas/ObjectID"
6231 text/javascript:
6232 schema:
6233 $ref: "#/components/schemas/ObjectID"
6234 deprecated: false
6235 "/notes/{id}/update":
6236 put:
6237 tags:
6238 - Note
6239 summary: Updates a note
6240 operationId: Note.updateNote
6241 parameters:
6242 - name: id
6243 in: path
6244 required: true
6245 schema:
6246 type: string
6247 requestBody:
6248 content:
6249 application/x-www-form-urlencoded:
6250 schema:
6251 type: object
6252 properties:
6253 customerId:
6254 type: string
6255 text:
6256 type: string
6257 required:
6258 - customerId
6259 - text
6260 responses:
6261 "200":
6262 description: Request was successful
6263 content:
6264 application/json:
6265 schema:
6266 type: object
6267 application/xml:
6268 schema:
6269 type: object
6270 text/xml:
6271 schema:
6272 type: object
6273 application/javascript:
6274 schema:
6275 type: object
6276 text/javascript:
6277 schema:
6278 type: object
6279 deprecated: false
6280 "/notes/{id}/delete":
6281 delete:
6282 tags:
6283 - Note
6284 summary: Deletes a note
6285 operationId: Note.deleteNote
6286 parameters:
6287 - name: id
6288 in: path
6289 required: true
6290 schema:
6291 type: string
6292 requestBody:
6293 content:
6294 application/x-www-form-urlencoded:
6295 schema:
6296 type: object
6297 properties:
6298 customerId:
6299 type: string
6300 required:
6301 - customerId
6302 responses:
6303 "200":
6304 description: Request was successful
6305 content:
6306 application/json:
6307 schema:
6308 type: object
6309 application/xml:
6310 schema:
6311 type: object
6312 text/xml:
6313 schema:
6314 type: object
6315 application/javascript:
6316 schema:
6317 type: object
6318 text/javascript:
6319 schema:
6320 type: object
6321 deprecated: false
6322 /notes/formatted:
6323 get:
6324 tags:
6325 - Note
6326 summary: Gets the notes of a customer
6327 operationId: Note.getFormatted
6328 parameters:
6329 - name: customerId
6330 in: query
6331 required: true
6332 schema:
6333 type: string
6334 responses:
6335 "200":
6336 description: Request was successful
6337 content:
6338 application/json:
6339 schema:
6340 type: array
6341 items:
6342 $ref: "#/components/schemas/x-any"
6343 application/xml:
6344 schema:
6345 type: array
6346 items:
6347 $ref: "#/components/schemas/x-any"
6348 text/xml:
6349 schema:
6350 type: array
6351 items:
6352 $ref: "#/components/schemas/x-any"
6353 application/javascript:
6354 schema:
6355 type: array
6356 items:
6357 $ref: "#/components/schemas/x-any"
6358 text/javascript:
6359 schema:
6360 type: array
6361 items:
6362 $ref: "#/components/schemas/x-any"
6363 deprecated: false
6364 "/tenant/{tenantName}/health":
6365 get:
6366 tags:
6367 - Tenant
6368 summary: Get a tenants health
6369 operationId: Tenant.health
6370 parameters:
6371 - name: tenantName
6372 in: path
6373 required: true
6374 schema:
6375 type: string
6376 responses:
6377 "200":
6378 description: Request was successful
6379 content:
6380 application/json:
6381 schema:
6382 type: object
6383 application/xml:
6384 schema:
6385 type: object
6386 text/xml:
6387 schema:
6388 type: object
6389 application/javascript:
6390 schema:
6391 type: object
6392 text/javascript:
6393 schema:
6394 type: object
6395 deprecated: false
6396 "/tenant/{tenantName}/config":
6397 get:
6398 tags:
6399 - Tenant
6400 summary: Get a tenants config
6401 operationId: Tenant.getConfig
6402 parameters:
6403 - name: tenantName
6404 in: path
6405 required: true
6406 schema:
6407 type: string
6408 responses:
6409 "200":
6410 description: Request was successful
6411 content:
6412 application/json:
6413 schema:
6414 type: object
6415 application/xml:
6416 schema:
6417 type: object
6418 text/xml:
6419 schema:
6420 type: object
6421 application/javascript:
6422 schema:
6423 type: object
6424 text/javascript:
6425 schema:
6426 type: object
6427 deprecated: false
6428tags:
6429 - name: Status
6430 - name: Customer
6431 - name: Cart
6432 - name: Address
6433 - name: Category
6434 - name: List
6435 - name: Order
6436 - name: Payment
6437 - name: PushToken
6438 - name: Search
6439 - name: Store
6440 - name: Auth
6441 - name: Buddy
6442 - name: Slack
6443 - name: City
6444 - name: Area
6445 - name: TOS
6446 - name: Report
6447 - name: StoreBrand
6448 - name: Note
6449 - name: Tenant
6450servers:
6451 - url: /api
6452components:
6453 requestBodies:
6454 Customer.updateBody:
6455 content:
6456 application/json:
6457 schema:
6458 type: object
6459 application/x-www-form-urlencoded:
6460 schema:
6461 type: object
6462 application/xml:
6463 schema:
6464 type: object
6465 text/xml:
6466 schema:
6467 type: object
6468 Area:
6469 content:
6470 application/json:
6471 schema:
6472 $ref: "#/components/schemas/Area"
6473 application/x-www-form-urlencoded:
6474 schema:
6475 $ref: "#/components/schemas/Area"
6476 application/xml:
6477 schema:
6478 $ref: "#/components/schemas/Area"
6479 text/xml:
6480 schema:
6481 $ref: "#/components/schemas/Area"
6482 required: true
6483 Buddy.linkManyStores:
6484 content:
6485 application/x-www-form-urlencoded:
6486 schema:
6487 type: object
6488 properties:
6489 buddyId:
6490 type: string
6491 storeId:
6492 type: string
6493 required:
6494 - buddyId
6495 - storeId
6496 Payment.payLiveOrder:
6497 content:
6498 application/x-www-form-urlencoded:
6499 schema:
6500 type: object
6501 properties:
6502 orderId:
6503 type: string
6504 required:
6505 - orderId
6506 Store.updateClosedSchemeSchemeobj:
6507 content:
6508 application/json:
6509 schema:
6510 type: object
6511 application/x-www-form-urlencoded:
6512 schema:
6513 type: object
6514 application/xml:
6515 schema:
6516 type: object
6517 text/xml:
6518 schema:
6519 type: object
6520 required: true
6521 Store:
6522 content:
6523 application/json:
6524 schema:
6525 $ref: "#/components/schemas/Store"
6526 application/x-www-form-urlencoded:
6527 schema:
6528 $ref: "#/components/schemas/Store"
6529 application/xml:
6530 schema:
6531 $ref: "#/components/schemas/Store"
6532 text/xml:
6533 schema:
6534 $ref: "#/components/schemas/Store"
6535 required: true
6536 schemas:
6537 Customer:
6538 properties:
6539 id:
6540 type: number
6541 format: double
6542 additionalProperties: false
6543 x-any:
6544 properties: {}
6545 Category:
6546 properties:
6547 id:
6548 type: number
6549 format: double
6550 additionalProperties: false
6551 List:
6552 properties:
6553 id:
6554 type: number
6555 format: double
6556 additionalProperties: false
6557 Order:
6558 properties:
6559 id:
6560 type: number
6561 format: double
6562 additionalProperties: false
6563 Store:
6564 properties:
6565 id:
6566 type: number
6567 format: double
6568 additionalProperties: false
6569 Area:
6570 properties:
6571 id:
6572 type: number
6573 format: double
6574 additionalProperties: false
6575 Auth:
6576 properties:
6577 customerId:
6578 $ref: "#/components/schemas/ObjectID"
6579 tenant:
6580 type: string
6581 id:
6582 $ref: "#/components/schemas/ObjectID"
6583 created:
6584 type: string
6585 format: date-time
6586 modified:
6587 type: string
6588 format: date-time
6589 deleted:
6590 type: string
6591 format: date-time
6592 additionalProperties: false
6593 AccessToken:
6594 properties:
6595 id:
6596 type: string
6597 ttl:
6598 default: 1209600
6599 description: time to live in seconds (2 weeks by default)
6600 type: number
6601 format: double
6602 scopes:
6603 description: Array of scopes granted to this access token.
6604 type: array
6605 items:
6606 type: string
6607 created:
6608 type: string
6609 format: date-time
6610 modified:
6611 type: string
6612 format: date-time
6613 deleted:
6614 type: string
6615 format: date-time
6616 userId:
6617 $ref: "#/components/schemas/ObjectID"
6618 required:
6619 - id
6620 additionalProperties: false
6621 Buddy:
6622 properties:
6623 id:
6624 type: number
6625 format: double
6626 additionalProperties: false
6627 City:
6628 properties:
6629 id:
6630 type: number
6631 format: double
6632 additionalProperties: false
6633 TOS:
6634 properties:
6635 id:
6636 type: number
6637 format: double
6638 additionalProperties: false
6639 ObjectID:
6640 type: string
6641 pattern: ^[a-fA-F\d]{24}$