-
Notifications
You must be signed in to change notification settings - Fork 133
/
VTEX - Marketplace APIs - Sent Offers.json
2341 lines (2341 loc) · 139 KB
/
VTEX - Marketplace APIs - Sent Offers.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": "Sent Offers",
"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://portal.{environment}.com.br",
"description": "Offer Management Server URL.",
"variables": {
"environment": {
"description": "Environment to use. Used as part of the URL.",
"enum": [
"vtexcommercestable"
],
"default": "vtexcommercestable"
}
}
}
],
"paths": {
"/api/sent-offers/channels": {
"post": {
"tags": [
"Offer Management"
],
"summary": "Create Channel",
"description": "❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nThe first step for connectors to integrate with [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors) is to create a channel, that represents the marketplace to where sellers will send their offers. \n\nThis endpoint creates a channel and the integration developers should call it once for each marketplace. The information about the marketplace sent in the request will be shown to sellers in their [Offer Management UI](https://help.vtex.com/en/tutorial/offers-listing--7MRb9S78aBdZjFGpbuffpE). \n\nThe `feedId` created by this call will apply to all sellers connected to the given channel, and will be necessary for the next step of the integration flow, which is to [activate feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds). \n\n>\u2139\r\n> Offer Management is available for integrations with [Mercado Livre (Classic and Premium)](https://help.vtex.com/en/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq), [Netshoes](https://help.vtex.com/en/tracks/configurar-integracao-da-netshoes--5Ua87lhFg4m0kEcuyqmcCm), and VTEX marketplaces. For more information, see [Offer Management Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors).",
"operationId": "CreateChannel",
"parameters": [
{
"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": "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": "environment",
"in": "path",
"description": "Environment to use. Used as part of the URL.",
"required": true,
"schema": {
"type": "string",
"default": "vtexcommercestable"
}
},
{
"name": "an",
"in": "query",
"description": "Name of the seller's VTEX account. Used as query param.",
"required": true,
"schema": {
"type": "string",
"default": "accountName"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateChannel"
},
"example": {
"vendor": "vtex",
"name": "Amazon",
"logo": "https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/madeiramadeira.png"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The `feedId` attribute created by the connector that will identify sellers’ feeds with a channel. The `feedId` is always the same for the relation between sellers and channels, but connectors can create more than one `feedId` with a single marketplace, depending on their business rules. The `feedId` follows the standardized pattern `vendor.channel`.",
"default": "vtex.amazon"
},
"vendor": {
"type": "string",
"description": "Name of the connector making the integration.",
"default": "vtex"
},
"name": {
"type": "string",
"description": "Name of the channel with which the integration is being established.",
"default": "Amazon"
},
"logo": {
"type": "string",
"description": "URL redirecting to the image file of the graphic symbol that identifies the marketplace. The file must in PNG format, and the image's dimension should be 300x300 pixels.",
"default": "https://marketplace.com/logos/logo.png"
}
},
"title": "CreateChannel",
"example": {
"id": "vtex.amazon",
"vendor": "vtex",
"name": "Amazon",
"logo": "https://marketplace.com/logos/logo.png"
}
}
}
}
}
},
"deprecated": false
}
},
"/api/sent-offers/feeds": {
"post": {
"tags": [
"Offer Management"
],
"summary": "Activate Feed",
"operationId": "CreateFeed",
"description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\nIn [Offer Management](https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors), after [creating the channel](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), the next step is to create a feed, which is a list updated nearly in real time with information about the seller's offers sent to the marketplace. \n\nThis endpoint allows the creation of a feed so that the seller's sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is connected to the marketplace. Feeds are nearly real time updated with content provided by the marketplace and VTEX modules. \n\nThis endpoint should only be used once, to activate the channel and establish the connection. However, after a [feed is deactivated](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#delete-/api/sent-offers/feeds/-feedId-), in order to activate it again it will be necessary another call to this endpoint.The integration starts with the creation of the Feed. This endpoint is used to establish the connection between connector and seller through the Sent Offers. \n\nThe `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when calling this endpoint. It follows the pattern `vendor.channel`.",
"parameters": [
{
"name": "environment",
"in": "path",
"required": true,
"description": "Environment to use. Used as part of the URL.",
"schema": {
"type": "string",
"default": "vtexcommercestable"
}
},
{
"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": "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": "an",
"in": "query",
"description": "Name of the VTEX account. Used as query param.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "{{accountName}}"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFeedRequest"
},
"example": {
"id": "{{feedId}}",
"affiliateId": "MKP",
"salesChannels": "5"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "CreateFeed",
"example": {
"account": "grocery1",
"id": "vtex.meli-classic",
"affiliateId": "MDC",
"salesChannel": "4"
},
"properties": {
"account": {
"type": "string",
"description": "Seller's account name."
},
"id": {
"type": "string",
"description": "Channel's ID."
},
"affiliateId": {
"type": "string",
"description": "Corresponds to the 3-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code created by the seller.",
"default": "MKP"
},
"salesChannel": {
"type": "string",
"description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV)) associated to the seller account created."
}
}
},
"example": {
"account": "grocery1",
"id": "vtex.meli-classic",
"affiliateId": "MDC",
"salesChannel": "4"
}
}
}
}
},
"deprecated": false
},
"get": {
"tags": [
"Offer Management"
],
"summary": "List Feeds",
"description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace, and it is updated in real-time with content provided by the marketplace and VTEX modules. \n\nSince a seller can have integrations with multiple marketplaces, numerous feeds can be associated with an account. This endpoint retrieves a list with all the feeds related to an account.",
"operationId": "ListFeeds",
"parameters": [
{
"name": "environment",
"in": "path",
"required": true,
"description": "Environment to use. Used as part of the URL.",
"schema": {
"type": "string",
"default": "vtexcommercestable"
}
},
{
"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": "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": "an",
"in": "query",
"description": "Name of the Seller's VTEX account. Used as query param.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "{{accountName}}"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"example": {
"account": "grocery1",
"id": "digibee.shopee",
"affiliateId": "SHP",
"salesChannel": "1",
"channelName": "shopee",
"channelLogo": "https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/shopee.png"
},
"properties": {
"account": {
"type": "string",
"description": "Seller's account name."
},
"id": {
"type": "string",
"description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when calling this endpoint. It follows the pattern `vendor.channel`."
},
"affiliateId": {
"type": "string",
"description": "Corresponds to the 3-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code created by the seller."
},
"salesChannel": {
"type": "string",
"description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMVa)) used in the integration."
},
"channelName": {
"type": "string",
"description": "Name of the marketplace, or channel, present in the feed."
},
"channelLogo": {
"type": "string",
"description": "URL redirecting to the image file of the graphic symbol that identifies the marketplace."
}
}
},
"example": [
{
"account": "grocery1",
"id": "digibee.shopee",
"affiliateId": "SHP",
"salesChannel": "1",
"channelName": "shopee",
"channelLogo": "https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/shopee.png"
},
{
"account": "grocery1",
"id": "v2v.saggin",
"affiliateId": "SGN",
"salesChannel": "1",
"channelName": "Saggin",
"channelLogo": "https://saggin.myvtex.com/api/license-manager/site/pub/accounts/a44ab387-ab95-439e-81aa-7c1a56b45374/logos/show"
},
{
"account": "grocery1",
"id": "vtex.amazon",
"affiliateId": "MSM",
"salesChannel": "1",
"channelName": "Amazon",
"channelLogo": "https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/amazon.png"
}
]
},
"example": [
{
"account": "grocery1",
"id": "digibee.shopee",
"affiliateId": "SHP",
"salesChannel": "1",
"channelName": "shopee",
"channelLogo": "https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/shopee.png"
},
{
"account": "grocery1",
"id": "v2v.saggin",
"affiliateId": "SGN",
"salesChannel": "1",
"channelName": "Saggin",
"channelLogo": "https://saggin.myvtex.com/api/license-manager/site/pub/accounts/a44ab387-ab95-439e-81aa-7c1a56b45374/logos/show"
},
{
"account": "grocery1",
"id": "vtex.amazon",
"affiliateId": "MSM",
"salesChannel": "1",
"channelName": "Amazon",
"channelLogo": "https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/amazon.png"
}
]
}
}
}
},
"deprecated": false
}
},
"/api/sent-offers/feeds/{feedId}": {
"put": {
"tags": [
"Offer Management"
],
"summary": "Update Feed",
"operationId": "UpdateFeed",
"description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. \n\nOnce you have [created a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/channels), this endpoint allows the seller to update the sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) and [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID used in the integration with the marketplace.",
"parameters": [
{
"name": "environment",
"in": "path",
"required": true,
"description": "Environment to use. Used as part of the URL.",
"schema": {
"type": "string",
"default": "vtexcommercestable"
}
},
{
"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": "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": "an",
"in": "query",
"description": "Name of the VTEX account. Used as query param.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "{{accountName}}"
}
},
{
"name": "feedId",
"in": "path",
"description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "vtex.amazon"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFeedRequest"
},
"example": {
"affiliateId": "MKP",
"salesChannels": "5"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"deprecated": false
},
"get": {
"tags": [
"Offer Management"
],
"summary": "Get Feed by feedId",
"operationId": "RetrieveFeed",
"description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), after you have [created the channel](https://developers.vtex.com/vtex-rest-api/reference/createchannel), the next step is to create a feed, which is a list of information about the seller's offers sent to the marketplace. \n\nThis endpoint retrieves information about a specific feed by searching through its `feedId`.",
"parameters": [
{
"name": "environment",
"in": "path",
"required": true,
"description": "Environment to use. Used as part of the URL.",
"schema": {
"type": "string",
"default": "vtexcommercestable"
}
},
{
"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": "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": "an",
"in": "query",
"description": "Name of the VTEX account. Used as query param.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "{{accountName}}"
}
},
{
"name": "feedId",
"in": "path",
"description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "vtex.amazon"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"title": "RetrieveFeed",
"type": "object",
"example": {
"account": "grocery1",
"id": "vtex.meli-classic",
"affiliateId": "vtex.meli-classic",
"salesChannel": "5",
"channelName": "Mercadolivre Classic",
"channelLogo": "https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/mercadolivre.png"
},
"properties": {
"account": {
"type": "string",
"description": "Seller's account name."
},
"id": {
"type": "string",
"description": "Channel's ID."
},
"affiliateId": {
"type": "string",
"description": "This attribute is created by the seller, in their VTEX store configuration."
},
"salesChannel": {
"type": "string",
"description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) associated to the seller account created."
},
"channelName": {
"type": "string",
"description": "Name of the channel where the offer was sent."
},
"channelLogo": {
"type": "string",
"description": "Logo of the channel where the offer was sent."
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Offer Management"
],
"summary": "Deactivate Feed",
"operationId": "DeleteFeed",
"description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), a feed is a list of information about seller's offers sent to a marketplace. After [creating a feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds), it will be activated; and through this endpoint the seller can deactivate the feed. \n\nWhen a feed is deactivated, all data related to the marketplace is removed from Offer Management UI. That includes the channels, offers, interactions, and errors. \n\nDeactivating a feed does not mean deleting information, and the seller can restore the data by [activating the feed](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds) again.",
"parameters": [
{
"name": "environment",
"in": "path",
"required": true,
"description": "Environment to use. Used as part of the URL.",
"schema": {
"type": "string",
"default": "vtexcommercestable"
}
},
{
"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": "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": "an",
"in": "query",
"description": "Name of the VTEX account. Used as query param.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "{{accountName}}"
}
},
{
"name": "feedId",
"in": "path",
"description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "vtex.amazon"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
}
},
"deprecated": false
}
},
"/api/sent-offers/feeds/{feedId}/skus/{skuId}/interactions": {
"post": {
"tags": [
"Offer Management"
],
"summary": "Open Interaction",
"operationId": "CreateInteraction",
"description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called Interaction. For every action that happens to an offer, whether it is a status notification or a price update, the connector creates an Interaction about it. \n\nThis endpoint creates a new interaction for an SKU so that changes can be applied to an offer. The changes informed by interactions are related to: price, inventory, catalog and status. \n\nUsually, interactions process a single type of change at a time, but it is possible to add data about catalog, price, and inventory simultaneously in the same interaction.",
"parameters": [
{
"name": "environment",
"in": "path",
"required": true,
"description": "Environment to use. Used as part of the URL.",
"schema": {
"type": "string",
"default": "vtexcommercestable"
}
},
{
"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": "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": "an",
"in": "query",
"description": "Name of the VTEX account. Used as query param.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "{{accountName}}"
}
},
{
"name": "feedId",
"in": "path",
"description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "vtex.amazon"
}
},
{
"name": "skuId",
"in": "path",
"description": "This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "1234"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInteractionRequest"
},
"example": {
"startDate": "2020-10-29",
"source": "seller",
"origin": "catalog",
"context": "setup"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"title": "CreateInteraction",
"type": "object",
"example": {
"account": "grocery1",
"feedId": "vtex.madeiramadeira",
"skuId": "1",
"id": "3D585672B15A418EBDFC4BC0E85120A5",
"startDate": "2022-03-07T09:15:00Z",
"result": "processing",
"state": "open",
"source": "seller",
"origin": "inventory",
"context": "setup",
"logs": []
},
"properties": {
"account": {
"type": "string",
"description": "Seller's account name."
},
"feedId": {
"type": "string",
"description": "Attribute that identifies a feed between a seller and a channel. It follows a standardized pattern that will be used by connectors when establishing the connection between the two."
},
"skuId": {
"type": "string",
"description": "SKU's unique identifier number."
},
"id": {
"type": "string",
"description": "Connectors must extend the Sent Offers' codes by adding their own code IDs for mapping specific scenarios that apply to their own system. They can send those codes through a suffix ID added in an existing code."
},
"startDate": {
"type": "string",
"description": "The day the interaction was created."
},
"result": {
"type": "string",
"description": "Search interactions, filtering by result. Results can have the following values: \n\nSuccess: When events close their lifecycle successfully, and generate updates on an offer in terms of price, inventory, or catalog. \n\nFailure: When the connector has detected processes that have failed to be made due to an error. \n\nNotification: When there are processes with the connector that are worth mentioning, but there are no actual updates. Ex: discarded updates or sendings of an offer. \n\nProcessing: When an open interaction has not been concluded, and should still receive more steps."
},
"state": {
"type": "string",
"description": "State, from the seller's address."
},
"source": {
"type": "string",
"description": "This attribute defines the entity responsible for the interaction."
},
"origin": {
"type": "string",
"description": "where the interaction originated from. Possible values include `catalog`, `price` or `inventory`."
},
"context": {
"type": "string",
"description": "This field informs Sent Offers about an offer's lifecycle."
},
"logs": {
"type": "array",
"description": "History of events related to interactions.",
"items": {
"type": "string"
},
"properties": {
"type": {
"type": "string",
"title": "type",
"description": "Type of logs."
}
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/sent-offers/feeds/{feedId}/skus/{skuId}/interactions/{interactionId}": {
"get": {
"tags": [
"Offer Management"
],
"summary": "Get Interaction Data by interactionId",
"operationId": "RetrieveInteraction",
"description": ">❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status.\r\nTo learn more, visit the [announcement](https://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3).\r\n\r\n In [Offer Management](https://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors), VTEX platform and marketplaces interact with offers through a medium called [interaction](https://developers.vtex.com/docs/api-reference/marketplace-apis-offer-management#post-/api/sent-offers/feeds/-feedId-/skus/-skuId-/interactions). \n\nA unique code called `interactionId` is used to identify each interaction. This endpoint retrieves information about an interaction, searching by its `interactionId`. \n\nIt also retrieves existing logs through the `log` field.",
"parameters": [
{
"name": "environment",
"in": "path",
"required": true,
"description": "Environment to use. Used as part of the URL.",
"schema": {
"type": "string",
"default": "vtexcommercestable"
}
},
{
"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": "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": "an",
"in": "query",
"description": "Name of the VTEX account. Used as query param.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "{{accountName}}"
}
},
{
"name": "feedId",
"in": "path",
"description": "The `feedId` attribute that identifies a feed between a seller and a channel, follows a standardized pattern that will be used by connectors when establishing the connection between the two. It follows the pattern `vendor.channel`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "vtex.amazon"
}
},
{
"name": "skuId",
"in": "path",
"description": "This attribute is the SKU ID in the seller's perspective, registered in their VTEX Catalog.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "1234"
}
},
{
"name": "interactionId",
"in": "path",
"description": "This attribute is the code used to identify an existing interaction.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"default": "d3rdjjf094ma0do"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"title": "RetrieveInteraction",
"type": "object",
"example": {
"account": "grocery1",
"feedId": "vtex.madeiramadeira",
"skuId": "1",
"id": "7FC112C52F8F43E6A096E29B04AC63F6",
"startDate": "2022-03-07T09:15:00Z",
"result": "processing",
"state": "open",
"source": "seller",
"origin": "inventory",
"context": "setup",
"logs": []
},
"properties": {
"account": {
"type": "string",
"description": "Seller's account name."
},
"feedId": {
"type": "string",
"description": "Attribute that identifies a feed between a seller and a channel. It follows a standardized pattern that will be used by connectors when establishing the connection between the two."
},
"skuId": {
"type": "string",
"description": "SKU's unique identifier number."
},
"id": {
"type": "string",
"description": "Connectors must extend the Sent Offers' codes by adding their own code IDs for mapping specific scenarios that apply to their own system. They can send those codes through a suffix ID added in an existing code."
},
"startDate": {
"type": "string",
"description": "The day the interaction was created."
},
"result": {
"type": "string",
"description": "Search interactions, filtering by result. Results can have the following values: \n\nSuccess: When events close their lifecycle successfully, and generate updates on an offer in terms of price, inventory, or catalog. \n\nFailure: When the connector has detected processes that have failed to be made due to an error. \n\nNotification: When there are processes with the connector that are worth mentioning, but there are no actual updates. Ex: discarded updates or sendings of an offer. \n\nProcessing: When an open interaction has not been concluded, and should still receive more steps."
},
"state": {
"type": "string",