-
Notifications
You must be signed in to change notification settings - Fork 134
/
VTEX - Marketplace APIs - Suggestions.json
2573 lines (2573 loc) · 135 KB
/
VTEX - Marketplace APIs - Suggestions.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.0.0",
"info": {
"title": "Suggestions",
"description": "\r\nThe **Marketplace API** enables marketplaces and sellers hosted on VTEX to perform their collaborative operations. \r\n\r\n>⚠️ The marketplace must [create an appKey and appToken](https://developers.vtex.com/docs/guides/getting-started-authentication) for each non-VTEX seller that will use this API.\r\n\r\n## Index\r\n\r\n### Notification\r\n\r\nEndpoints used by sellers to notify marketplaces that the price or inventory language has changed for one of their SKUs.\r\n\r\n`POST` [Notify marketplace of price update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/price)\r\n\r\n`POST` [Notify marketplace of inventory update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/inventory)\r\n\r\n\r\n### Suggestions\r\n\r\n#### Get Suggestions\r\n\r\nSearch and filter all suggestions using specific criteria.\r\n\r\n`GET` [Get all SKU Suggestions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions)\r\n\r\n`GET` [Get SKU Suggestion by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n\r\n#### Manage Suggestions\r\n\r\nSend or delete SKU suggestions from the seller to marketplace.\r\n\r\n`PUT` [Send SKU Suggestion](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n`DELETE` [Delete SKU Suggestion](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#delete-/suggestions/-sellerId-/-sellerSkuId-)\r\n\r\n\r\n#### Get Versions\r\n\r\nSearch and filter all versions of suggestions, using specific criteria.\r\n\r\n`GET` [Get all versions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerskuid-/versions)\r\n\r\n`GET` [Get version by ID](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/-sellerId-/-sellerskuid-/versions/-version-)\r\n\r\n\r\n#### Match Received SKUs\r\n\r\nMatch SKU suggestions received in the marketplace.\r\n\r\n`PUT` [Match Received SKUs individually](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/-sellerId-/-sellerskuid-/versions/-version-/matches/-matchid-)\r\n\r\n`PUT` [Match Multiple Received SKUs](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/matches/action/-actionName-)\r\n\r\n\r\n#### SKU Approval Settings\r\n\r\nAllows marketplaces to configure rules for automatically and manually approving SKUs received from sellers.\r\n\r\n`GET`[Get autoApprove Status in Account Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration/autoapproval/toggle) \r\n\r\n`PUT`[Activate autoApprove in Marketplace's Account](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/autoapproval/toggle) \r\n\r\n`GET`[Get Account's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration)\r\n\r\n`PUT`[Save Account's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration)\r\n\r\n`GET`[Get Seller's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#get-/suggestions/configuration/seller/-sellerId-)\r\n\r\n`PUT`[Save Seller's Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/seller/-sellerId-)\r\n\r\n`PUT`[Activate autoApprove Setting for a Seller](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/autoapproval/toggle/seller/-sellerId-) \r\n\r\n\r\n### Matched Offers\r\n\r\nOffers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured.\r\n\r\n`GET`[Get Matched Offers List](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/offers)\r\n\r\n`GET`[Get Matched Offer's Data by SKU ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/product/-productId-/sku/-skuId-) \r\n\r\n`GET`[Get Matched Offer's Data by Product ID](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/offer-manager/pvt/product/-productId-)\r\n",
"contact": {},
"version": "1.0"
},
"servers": [
{
"url": "https://api.vtex.com/{accountName}",
"description": "Suggestions Server URL.",
"variables": {
"accountName": {
"description": "Name of the VTEX account. Used as part of the URL.",
"default": "apiexamples"
}
}
}
],
"paths": {
"/suggestions/configuration/autoapproval/toggle": {
"get": {
"tags": [
"SKU Approval Settings"
],
"summary": "Get autoApprove Status in Account Settings",
"description": "This endpoint can be used to check whether the autoapprove setting is active or not, for a specific seller. \n\nIf the response is `true`, the autoapprove setting is active. If the response is `false`, it is inactive.",
"operationId": "GetautoApprovevaluefromconfig",
"parameters": [
{
"name": "sellerId",
"in": "query",
"description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace.",
"required": true,
"style": "form",
"schema": {
"type": "string",
"default": "seller123"
}
},
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "If the auto-approve setting is active for a given seller (`true`) or not (`false`)."
}
}
},
"example": {
"Enabled": false
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"SKU Approval Settings"
],
"summary": "Activate autoApprove in Marketplace's Account",
"description": "This endpoint enables the autoapprove rule to a marketplace's whole Received SKUs module. Once enabling the rule, received SKUs will be automatically approved on your store, regardless of the seller. \n\n For the autoapprove rule to work as expected, the approval [Matcher score](https://help.vtex.com/en/tutorial/entendendo-a-pontuacao-do-vtex-matcher--tutorials_424) should be set up as 80 (default value), but you can configure a different number through the field `Score` in [Save Account's Approval Settings](https://developers.vtex.com/vtex-rest-api/reference/saveaccountconfig).",
"operationId": "Saveautoapproveforaccount",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveautoapproveforaccountRequest"
},
"example": {
"Enabled": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "If the auto-approve setting is active (`true`) or not (`false`)."
}
}
},
"example": {
"Enabled": false
}
}
}
}
},
"deprecated": false
}
},
"/suggestions/configuration": {
"get": {
"tags": [
"SKU Approval Settings"
],
"summary": "Get Account's Approval Settings",
"description": "This endpoint retrieves the current approval settings of a marketplace's Received SKUs module. Its response includes: \n\n- `Score`: Matcher scores for approving and rejecting SKUs received from sellers. \n\n- `Matchers`: All Matchers configured on the marketplace, and their respective details. \n\n- `SpecificationsMapping`: Mapping of product and SKU specifications, per seller. \n\n- `MatchFlux`: This field determines the type of approval configuration applied to SKUs received from a seller. \n\nThe possible values include: \n\n-`default`, where the Matcher reviews the SKU, and approves it based on its score. \n\n-`manual`, for manual approvals through the Received SKU UI, or Match API. \n\n-`autoApprove`, for every SKU received from a given seller to be approved automatically, regardless of their Matcher Score.",
"operationId": "Getaccountconfig",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Score": {
"type": "object",
"description": "Matcher scores for approving and rejecting SKUs received from sellers."
},
"Matchers": {
"type": "array",
"description": "All Matchers configured on the marketplace, and their respective details."
},
"Rules": {
"type": "object",
"description": "Items and products."
},
"SpecificationsMapping": {
"type": "array",
"description": "Mapping of product and SKU specifications, per seller."
},
"MatchFlux": {
"type": "string",
"description": "This field determines the type of approval configuration applied to SKUs received from a seller."
}
}
},
"example": {
"Score": {
"Approve": 80,
"Reject": 30
},
"Matchers": [
{
"MatcherId": "vtex-matcher",
"hook-base-address": "http://portal.vtexinternal.com/api/ssm/hooks",
"IsActive": true,
"UpdatesNotificationEndpoint": null,
"Description": null
}
],
"Rules": {
"Item": [],
"Product": []
},
"SpecificationsMapping": [],
"MatchFlux": "Default"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"SKU Approval Settings"
],
"summary": "Save Account's Approval Settings",
"description": "Marketplaces use this endpoint to create or update approval settings on their Received SKUs module. \n\nThe request includes all the details necessary to implement the chosen approval settings.",
"operationId": "Saveaccountconfig",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveaccountconfigRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {
"Score": {
"Approve": 80,
"Reject": 30
},
"Matchers": [
{
"MatcherId": "vtex-matcher",
"hook-base-address": "http://simple-suggestion-matcher.vtex.com.br",
"IsActive": true,
"UpdatesNotificationEndpoint": "notification.endpoint",
"Description": "Note"
}
],
"Rules": {
"Item": [
1
],
"Product": [
"Shirt"
]
},
"SpecificationsMapping": [
{
"SellerId": "Store1",
"Mapping": {
"Yellow": "Light yellow"
}
}
],
"MatchFlux": "AutoApprove"
},
"properties": {
"Score": {
"type": "object",
"description": "[Matcher's rates](https://help.vtex.com/en/tutorial/understanding-vtex-matcher-scoring) to approve or reject [received SKUs](https://help.vtex.com/en/tutorial/cataloging-received-skus--tutorials_396) sent by sellers.",
"properties": {
"Approve": {
"type": "integer",
"description": "Score to approve SKUs sent by sellers."
},
"Reject": {
"type": "integer",
"description": "Score to reject SKUs sent by sellers."
}
},
"example": {
"Approve": 80,
"Reject": 30
}
},
"Matchers": {
"type": "array",
"description": "[Matchers](https://help.vtex.com/en/tutorial/understanding-vtex-matcher-scoring) configurations for approving and rejecting [received SKUs](https://help.vtex.com/en/tutorial/cataloging-received-skus--tutorials_396) sent by sellers.",
"properties": {
"MatcherId": {
"type": "string",
"description": "Identifies the matching entity. It can be either [VTEX's matcher](https://help.vtex.com/en/tutorial/understanding-vtex-matcher-scoring), or an external matcher."
},
"hook-base-address": {
"type": "string",
"description": "The given Matcher's URL."
},
"IsActive": {
"type": "boolean",
"description": "Whether the matcher is active in the account (`true`), or not (`false`)."
},
"UpdatesNotificationEndpoint": {
"type": "string",
"description": "The [received SKUs](https://help.vtex.com/en/tutorial/cataloging-received-skus--tutorials_396) module calls this endpoint for matcher's suggestions updates."
},
"Description": {
"type": "string",
"description": "The note inserted on the request body."
}
}
},
"Rules": {
"type": "object",
"description": "Items and products that belong to sellers.",
"properties": {
"Item": {
"type": "array",
"description": "SKUs' ID.",
"items": {
"type": "integer",
"description": "SKU ID."
}
},
"Product": {
"type": "array",
"description": "Product's name.",
"items": {
"type": "string",
"description": "Product name."
}
}
}
},
"SpecificationsMapping": {
"type": "array",
"description": "This attribute maps product and SKU's specifications between the marketplace and the seller.",
"properties": {
"SellerId": {
"type": "string",
"description": "The Seller ID."
},
"Mapping": {
"type": "object",
"description": "The attributes and values mapped between the marketplace and the seller."
}
}
},
"MatchFlux": {
"type": "string",
"description": "Type of approval configuration that apply to received SKUs sent by sellers. The possible values are: \n\n`default`: the matcher approves the SKU. \n\n`manual`: manual SKU's approvals. \n\n`AutoApprove`: automatic SKU's approvals."
}
}
}
}
}
}
},
"deprecated": false
}
},
"/suggestions/configuration/account/config": {
"get": {
"tags": [
"SKU Approval Settings"
],
"summary": "Get Account's Matcher Settings",
"description": "This endpoint will be used by the marketplace to query the matcher's current approval settings on their incoming SKUs module. If the account has no matcher configured, the response will be `404 Not Found`. \n\nFor account approval configuration information, with response including specification information, see [Get Account Approval Settings](https://developers.vtex.com/docs/api-reference/marketplace-apis- suggestions#get-/suggestions /configuration) terminal. \n\nThe [VTEX matcher](https://help.vtex.com/pt/tutorial/entendendo-a-punctuacao-do-vtex-matcher--tutorials_424) is a tool used by marketplaces to evaluate SKUs corresponding to information from an advertisement of the seller, with those of items already present in the marketplace catalog.",
"operationId": "Getmatchconfig",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/responseGetAccountsMatcherSettings"
},
"example": {
"score": {
"approve": 85,
"pending": 31,
"reject": 30
},
"matchers": [
{
"matcherId": "example-matcher",
"hook-base-address": "http://portal.vtexinternal.com.br/api/u90/hooks",
"isActive": true,
"updatesNotificationEndpoint": null,
"description": null
}
],
"rules": {
"item": [],
"product": []
},
"specificationsMapping": [],
"matchFlux": "Default"
}
}
}
}
},
"deprecated": false
}
},
"/suggestions/configuration/seller/{sellerId}": {
"get": {
"tags": [
"SKU Approval Settings"
],
"summary": "Get Seller's Approval Settings",
"description": "This endpoint retrieves the current Received SKUs approval settings applied to a specific seller. Its response includes: \n\n- `sellerId`: A string that identifies the seller in the marketplace. \n\n- `accountId`: Marketplace’s account ID. \n\n- `accountName`: Marketplace’s account name. \n\n- `mapping`: Mapping of SKU and product Specifications. \n\n- `matchFlux`: This field determines the type of approval configuration applied to SKUs received from a seller. \n\nThe possible values include: \n\n-`default`, where the Matcher reviews the SKU, and approves it based on its score. \n\n-`manual`, for manual approvals through the Received SKU UI and Match API. \n\n-`autoApprove`, for every SKU received from a given seller to be approved automatically , regardless of the Matcher Score.",
"operationId": "Getselleraccountconfig",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "sellerId",
"in": "path",
"description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "seller123"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/responseGetSellersApprovalSettings"
},
"example": {
"sellerId": "sellerexample",
"accountId": "d74dau71f-325a-4463-bd53-ae8b0453186ca",
"accountName": "marketplaceexample",
"mapping": {
"defaultColor": "white /black",
"searchColor": "color1, color2",
"color1": "black",
"color2": "white",
"color": "black",
"size": "EUR44"
},
"matchFlux": "default"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"SKU Approval Settings"
],
"summary": "Save Seller's Approval Settings",
"description": "Marketplaces use this endpoint to create or update approval settings to a specific seller, on the Received SKUs module. \n\nThe request includes all the details necessary to implement the chosen approval settings.",
"operationId": "Putselleraccountconfig",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "sellerId",
"in": "path",
"description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "seller123"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutselleraccountconfigRequest"
},
"example": {
"sellerId": "1a",
"mapping": null,
"matchFlux": "Default"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"deprecated": false
}
},
"/suggestions/configuration/autoapproval/toggle/seller/{sellerId}": {
"put": {
"tags": [
"SKU Approval Settings"
],
"summary": "Activate autoApprove Setting for a Seller",
"description": "This endpoint enables the auto approve setting to received SKUs from a specific seller. Be aware that once enabling the rule through this request, all received SKUs from that seller will be automatically approved on your store, regardless of the Matcher Score.",
"operationId": "Saveautoapproveforaccountseller",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account that belongs to the marketplace. All data extracted, and changes added will be posted into this account.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "sellerId",
"in": "path",
"description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "seller123"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveautoapproveforaccountsellerRequest"
},
"example": {
"Enabled": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"deprecated": false
}
},
"/suggestions": {
"get": {
"tags": [
"Get Suggestions"
],
"summary": "Get all SKU suggestions",
"description": "This endpoint retrieves a list of all SKUs sent by the seller for the Marketplace's approval. Marketplace operators should use this endpoint whenever they want to check the full list of received SKUs and their information. \n\nNote that all the information sent by the seller will be in the [content] object. All remaining information in this endpoint's response is given by the Matcher. \n\nMatcher rates received SKUs by correlating the data sent by sellers, to existing fields in the marketplace. The calculation of these scores determines whether the product has been: \n\n`Approved`: score equal to or greater than 80 points. \n\n`Pending`: from 31 to 79 points.\n\n`Denied`: from 0 to 30 points. \n\nNote that if the autoApprove setting is enabled, the SKUs will be approved, regardless of the Score.",
"operationId": "Getsuggestions",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account. Used as part of the URL",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "q",
"in": "query",
"description": "This field allows you to customize your search. You can fill in this query param if you want to narrow down your search using the available filters on Received SKU modules.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": ""
}
},
{
"name": "type",
"in": "query",
"description": "This field allows users to filter SKU suggestions, by searching only the new suggestions that were just sent, and suggestions that have already been sent, but were updated. Possible values for this field include `new` and `update`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "new"
}
},
{
"name": "seller",
"in": "query",
"description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller so it can call this endpoint.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": ""
}
},
{
"name": "status",
"in": "query",
"description": "Narrow down you search, filtering by status. Values allowed on this field include: `accepted`, `pending` and `denied.`",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "accepted"
}
},
{
"name": "hasmapping",
"in": "query",
"description": "This field allows you to filter SKUs that have mapping or not. Insert `true` to filter SKUs that have mapping, or `false` to retrieve SKUs that aren't mapped.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "true"
}
},
{
"name": "matcherid",
"in": "query",
"description": "Identifies the matching entity. It can be either VTEX's matcher, or an external matcher developed by partners, for example. The `matcherId`'s value can be obtained through the [Get SKU Suggestion by ID](https://developers.vtex.com/vtex-rest-api/reference/getsuggestion) endpoint.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "vtex-matcher"
}
},
{
"name": "_from",
"in": "query",
"description": "Define your pagination range, by adding the pagination starting value. Values should be bigger than 0, with a maximum of 50 records per page.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"default": 1
}
},
{
"name": "_to",
"in": "query",
"description": "Define your pagination range, by adding the pagination ending value. Values should be bigger than 0, with a maximum of 50 records per page.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"default": 50
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"deprecated": false
}
},
"/suggestions/{sellerId}/{sellerSkuId}": {
"put": {
"tags": [
"Manage Suggestions"
],
"summary": "Send SKU Suggestion",
"description": "This request is used by the seller when it wants to suggest that one of their SKUs is sold in the marketplace.\n\nBefore using this request, the seller should always use the [Change Notification](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-seller-sku-notification) request in order to check if the SKU already exists in the marketplace. If it doesn't, then this is the next call in the SKU integration flow.\n\nIn the Send Suggestion request, the seller must send information about the SKU, such as the product and SKU name, the seller ID, and the image URL. All parameters are explained below. ",
"operationId": "SaveSuggestion",
"parameters": [
{
"name": "accountName",
"in": "path",
"required": true,
"description": "Name of the VTEX account to which the seller wants to suggest a new SKU. It is used as part of the request URL.",
"schema": {
"type": "string",
"default": "apiexamples"
}
},
{
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/vnd.vtex.suggestion.v0+json",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Describes the type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "sellerId",
"in": "path",
"description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "seller123"
}
},
{
"name": "sellerSkuId",
"in": "path",
"description": "A string that identifies the SKU in the seller. This is the ID that the marketplace will use for future references to this SKU, such as price and inventory notifications.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "1234"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveSuggestionRequest"
},