-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSchema.json
1618 lines (1618 loc) · 46.1 KB
/
Schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.1.0",
"info": {
"title": "My shops",
"description": "Get information about my business and sales on Selldone.",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://api.selldone.com"
}
],
"paths": {
"/security/2fa/check": {
"get": {
"operationId": "Check2FA",
"description": "Check user two-factor authentication is enabled? If the 'user' value is in response, it means the user successfully logged in. Otherwise, call Verify2FA",
"parameters": [],
"responses": {
"200": {
"description": "2FA status retrieved successfully",
"content": {
"application/json": {
"example": {
"user": {
"$ref": "#/components/schemas/User"
},
"has_2fa": true
}
}
}
},
"400": {
"description": "Invalid Request"
}
}
}
},
"/auth/2fa": {
"post": {
"operationId": "Verify2FA",
"description": "Request user to enter 6 digit number 2FA code if Check2FA does not return 'user' value in its response.",
"parameters": [],
"requestBody": {
"description": "6-digit 2FA numeric code to verify access.",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "^[0-9]{6}$",
"description": "6-digit 2FA numeric code to verify access."
}
}
}
}
}
},
"responses": {
"200": {
"description": "The 2FA code is valid an and now API calls are authenticated with this Bearer token.",
"content": {
"application/json": {
"example": {
"success": true,
"token_verified": true,
"user": {
"$ref": "#/components/schemas/User"
}
}
}
}
},
"401": {
"description": "Unauthorized - Incorrect 2FA Code"
}
}
}
},
"/shops/me": {
"get": {
"operationId": "GetShops",
"description": "Get the list of my shops",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Something about business name or its URL.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "List of shops retrieved successfully",
"content": {
"application/json": {
"example": {
"shops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shop"
},
"description": "List of my shops."
}
}
}
}
},
"400": {
"description": "Invalid Request"
}
}
}
},
"/shops/{shop_id}/products/{product_id}/admin": {
"get": {
"operationId": "GetProductInfo",
"summary": "Get Product Information by Shop and Product ID",
"description": "Returns information about the product by product ID and shop ID, including statistics for a specified time period. Request the user to input the URL for the product's admin page, formatted as 'https://selldone.com/shuttle/shop/{shop_id}/product/{product_id}/...,'",
"parameters": [
{
"name": "shop_id",
"in": "path",
"required": true,
"description": "The unique identifier for the shop",
"schema": {
"type": "string"
}
},
{
"name": "product_id",
"in": "path",
"required": true,
"description": "The unique identifier for the product",
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "Offset days from now to get statistic information about product sell, inventory, finance, views, etc.",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Number of days from the offset day to look back, i.e., the number of data records to return.",
"required": false,
"schema": {
"type": "integer",
"default": 30
}
},
{
"name": "with_trashed",
"in": "query",
"description": "Include or exclude trashed (deleted) items in the response.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "A list of product details and statistics for the specified shop and product",
"content": {
"application/json": {
"example": {
"product": {
"$ref": "#/components/schemas/Product"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductData"
}
},
"orderQue": {
"type": "array",
"items": {
"count": {
"type": "integer",
"description": "Number of orders in the queue."
},
"delivery_state": {
"type": "string",
"description": "Delivery state of the order."
},
"type": {
"type": "string",
"description": "Type of the order."
}
}
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"User": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The unique identifier for the user."
},
"name": {
"type": "string",
"description": "The user's full name."
},
"email": {
"type": "string",
"description": "The user's email address."
},
"phone": {
"type": "string",
"description": "The user's phone number."
},
"email_verified_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the user verified their email address."
},
"socials_login": {
"$ref": "#/components/schemas/UserSocialLogin",
"description": "Social login flags for the user."
},
"preferences": {
"$ref": "#/components/schemas/UserPreferences",
"description": "User preferences settings."
},
"interest": {
"$ref": "#/components/schemas/UserInterest",
"description": "User's interests grouped by categories."
},
"subscribed": {
"type": "boolean",
"description": "Indicates if the user is subscribed."
},
"block_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp indicating when the user was blocked."
},
"block_hours": {
"type": "number",
"description": "Duration (in hours) the user was last blocked. Used for calculating the next punishment period."
},
"ban": {
"type": "string",
"enum": [
"BanLevel1",
"BanLevel2",
"BanLevel3"
],
"description": "Ban level for the user."
},
"meta": {
"type": "object",
"description": "Key-value pairs for storing metadata (private). Used for keeping third-party customer IDs and other values."
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the user was soft deleted."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the user was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the user was last updated."
}
}
},
"UserSocialLogin": {
"type": "object",
"properties": {
}
},
"UserPreferences": {
"type": "object",
"properties": {
}
},
"UserInterest": {
"type": "object",
"properties": {
}
},
"Shop": {
"type": "object",
"properties": {
"id": {
"type": [
"number",
"null"
],
"description": "The unique identifier for the shop."
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the shop."
},
"user_id": {
"type": "number",
"description": "The unique identifier for the user associated with the shop."
},
"home": {
"$ref": "#/components/schemas/ShopHome",
"description": "Represents the shop's homepage configuration."
},
"language": {
"type": "string",
"description": "The default language for the shop."
},
"title": {
"type": "string",
"description": "The title of the shop."
},
"description": {
"type": "string",
"description": "The description of the shop."
},
"icon": {
"type": "string",
"description": "The icon associated with the shop."
},
"fav": {
"type": "string",
"description": "The favorite icon for the shop."
},
"official": {
"type": "boolean",
"description": "Indicates if the shop is official."
},
"active": {
"type": "boolean",
"description": "Indicates if the shop is active."
},
"restriction": {
"type": "string",
"description": "The shop's access restriction setting."
},
"license": {
"type": "string",
"enum": [
"License1",
"License2",
"License3"
],
"description": "The licensing code for the shop."
},
"capacity": {
"type": "number",
"description": "The storage capacity of the shop in KB."
},
"expire_at": {
"type": "string",
"format": "date-time",
"description": "The expiration date of the shop."
},
"info": {
"$ref": "#/components/schemas/ShopInfo",
"description": "Additional info about the shop."
},
"support_mode": {
"type": "string",
"description": "Support mode for the shop."
},
"support": {
"type": "array",
"items": {},
"description": "Support details."
},
"address_verified": {
"type": "boolean",
"description": "Indicates if the address associated with the shop is verified."
},
"phone_verified": {
"type": "boolean",
"description": "Indicates if the phone number associated with the shop is verified."
},
"gold": {
"type": "boolean",
"description": "Indicates if the shop has a gold status."
},
"penalty": {
"type": "boolean",
"description": "Indicates if the shop has any penalties."
},
"purge_at": {
"type": "string",
"description": "The date when the shop and its content will be deleted."
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShopOption"
},
"description": "Configuration options for the shop."
},
"domain": {
"type": "string",
"description": "The domain associated with the shop."
},
"currencies": {
"type": "array",
"items": {
"enum": [
"Currency1",
"Currency2",
"Currency3"
]
},
"description": "Supported currencies for the shop."
},
"footer": {
"type": "array",
"items": {},
"description": "Configuration for the footer of the shop."
},
"theme": {
"$ref": "#/components/schemas/ShopTheme",
"description": "Theme configuration for the shop."
},
"avocado": {
"type": "array",
"items": {},
"description": "Configuration for Avocado form."
},
"hyper": {
"type": "array",
"items": {},
"description": "Configuration for Hyper."
},
"ribbon": {
"$ref": "#/components/schemas/ShopRibbon",
"description": "Configuration for Ribbon. Its the default behavior of subscription products."
},
"marketplace": {
"type": "array",
"items": {},
"description": "Configuration for the marketplace."
},
"model": {
"type": "string",
"description": "The business model of the shop."
},
"local": {
"$ref": "#/components/schemas/Domain",
"description": "Domain details for local configuration."
},
"sub": {
"$ref": "#/components/schemas/Domain",
"description": "Domain details for sub-domain configuration."
},
"countries": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supported countries for the shop."
},
"lottery": {
"type": "array",
"items": {
"type": "string"
},
"description": "Information regarding the lottery."
},
"tax": {
"type": "array",
"items": {},
"description": "Tax information for the shop."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The creation date of the shop."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The last updated date for the shop."
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The deletion date for the shop."
},
"client_id": {
"type": "number",
"description": "Agency client ID associated with the shop."
},
"drop_shipping": {
"type": "boolean",
"description": "Indicates if the shop operates in dropshipping mode."
},
"dropShipping_products": {
"type": "number",
"description": "The number of dropshipping products."
},
"dropShipping_sells": {
"type": "number",
"description": "The number of dropshipping products sold."
},
"dropShipping_score": {
"type": "number",
"description": "The dropshipping score for the shop."
},
"shop_exchange_rates": {
"type": "array",
"items": {},
"description": "Shop exchange rates."
}
}
},
"ShopHome": {
"type": "string",
"enum": [
"blog",
"avocado",
"hyper",
"community",
"shop",
"map",
"landing_page"
],
"description": "Represents the shop's homepage configuration."
},
"ShopInfo": {
"type": "object",
"properties": {
"location": {
"type": "string",
"nullable": true,
"description": "The location of the shop."
},
"daysOpen": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true,
"description": "Days when the shop is open."
},
"times": {
"type": "string",
"nullable": true,
"description": "Opening times of the shop."
},
"address": {
"type": "string",
"nullable": true,
"description": "The address of the shop."
},
"email": {
"type": "string",
"nullable": true,
"description": "The email address of the shop."
},
"country": {
"type": "string",
"nullable": true,
"description": "The country of the shop."
},
"postalCode": {
"type": "string",
"nullable": true,
"description": "The postal code of the shop."
},
"countryCode": {
"type": "string",
"nullable": true,
"description": "The country code of the shop."
},
"region": {
"type": "string",
"nullable": true,
"description": "The region of the shop."
},
"locality": {
"type": "string",
"nullable": true,
"description": "The locality of the shop."
},
"days_open": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
]
},
"nullable": true,
"description": "Days when the shop is open based on the WeekDays enum."
}
},
"description": "Additional info about the shop."
},
"ShopOption": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code for the shop option."
},
"value": {
"type": "array",
"items": {
"code": {
"type": "string",
"description": "The code for the shop option."
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"description": "The value for the shop option."
}
},
"description": "The custom options of shop."
}
}
},
"ShopTheme": {
"type": "object",
"properties": {
"color_light": {
"type": "string"
},
"color_dark": {
"type": "string"
},
"color_deep_dark": {
"type": "string"
},
"color_info": {
"type": "string"
},
"color_buy": {
"type": "string"
},
"color_bill": {
"type": "string"
},
"light_checkout": {
"type": "boolean"
},
"light_header": {
"type": "boolean"
},
"light_footer": {
"type": "boolean"
},
"light_filter": {
"type": "boolean"
},
"mobile": {
"type": "string"
},
"tablet": {
"type": "string"
},
"pc": {
"type": "string"
},
"static": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"hover_actions": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"only_available": {
"type": "boolean"
},
"smart_price": {
"type": "boolean"
},
"order": {
"type": "array",
"items": {
"type": "string"
}
},
"font_family": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"font_res": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"reverse_currency": {
"type": "boolean"
},
"logo": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"logo_w": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"logo_h": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
},
"css": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
}
},
"description": "Shop theme configuration."
},
"ShopRibbon": {
"type": "object",
"properties": {
"shipping": {
"type": "boolean",
"description": "Ask for shipping address"
},
"billing": {
"type": "boolean",
"description": "Ask for billing address"
},
"cart": {
"type": "boolean",
"description": "Car mode (add multiple subscriptions to cart)"
},
"count": {
"type": "boolean",
"description": "User can buy more than one subscription per product."
}
},
"description": "Subscription selling configuration in the shop."
},
"Domain": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Unique identifier for the domain."
},
"shop_id": {
"type": "number",
"description": "Identifier of the associated shop."
},
"primary": {
"type": "boolean",
"description": "Indicates if this is the primary domain for the shop."
},
"indexed": {
"type": "boolean",
"description": "Indicates if the domain is indexed."
},
"domain": {
"type": "string",
"description": "The domain name."
},
"home": {
"type": [
"string",
"null"
],
"description": "Domain home page (can be null, a page_id, 'avocado', or 'blog')."
},
"approved": {
"type": "boolean",
"description": "Indicates if the domain is approved."
},
"enable": {
"type": "boolean",
"description": "Indicates if the domain is enabled."
},
"expire_at": {
"type": [
"string",
"null"
],
"description": "Date and time when the domain expires."
},
"ssl_proxy": {
"type": "boolean",
"description": "Indicates if the domain was added via SSL proxy IPs."
},
"ssl": {
"type": "boolean",
"description": "Indicates the health status of domain SSL."
},
"issue_at": {
"type": [
"string",
"null"
],
"description": "Last date and time when a request was sent to issue SSL by SSL proxy."
},
"check_at": {
"type": [
"string",
"null"
],
"description": "Last date and time when the domain was checked."
},
"https": {
"type": "boolean",
"description": "Indicates if http should be forced to https."
},
"error": {
"type": [
"string",
"null"
],
"description": "Last error message, if any."
},
"affiliate_id": {
"type": "number",
"description": "Identifier of the attached affiliate."
},
"info": {
"type": [
"array",
"null"
],
"description": "Additional domain information provided by the user."
},
"debug": {
"type": [
"array",
"null"
],
"description": "Debug details for selldone admin."
},
"certificate": {
"type": [
"array",
"null"
],
"description": "Certificate information (see SSLCertificate)."
},
"created_at": {
"type": [
"string",
"null"
],
"description": "Date and time when the domain was created."
},
"updated_at": {
"type": [
"string",
"null"
],
"description": "Date and time when the domain was last updated."
}
},
"description": "Information about shop main domain."
},
"Product": {
"type": "object",
"required": [
"id",
"shop_id",
"currency",
"commission",
"condition",
"price"
],
"properties": {
"id": {
"type": "number",
"description": "Unique identifier for the product."
},
"shop_id": {
"type": "number",
"description": "Identifier for the shop owning the product."
},
"action": {
"type": "string",
"description": "Product buy call to action."
},
"ar": {
"$ref": "#/components/schemas/Product.IAR",
"description": "AR 3D model, created by the system."
},
"badges": {
"type": [
"array",
"null"
],
"items": {
"type": "number"
},
"description": "Array of badge identifiers associated with the product."
},
"best_content": {
"type": "boolean",
"description": "Indicates if product has great ranked content."
},
"best_seller": {
"type": "boolean",
"description": "Indicates if this is the bestseller product."
},
"blog": {
"type": "string",
"description": "Link to external resources shown on the product page."
},
"brand": {
"type": "string",