-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
1870 lines (1869 loc) · 70.2 KB
/
openapi.yaml
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.1
info:
title: Content Management
description: >-
The content management feed allows you to process content for items in bulk.
You can take in content via the content feeds. Use the XSDs to manage
content.
servers:
- url: https://marketplace.walmartapis.com/v3/feeds
tags:
- name: Feeds
paths:
/v3/feeds:
post:
tags:
- Feeds
summary: Content feeds
operationId: Feeds_createContentFeed
description: >-
You can update 10,000 items at once; updates with more than 10,000 items
are not supported. Keep feed sizes below 10 MB to ensure optimal feed
processing time.
parameters:
- description: The feed Type
name: feedType
in: query
required: true
schema:
type: string
default: CONTENT_PRODUCT
- description: >-
A unique ID to track the consumer request by channel. Use the
Consumer Channel Type received during onboarding
in: header
name: WM_CONSUMER.CHANNEL.TYPE
required: false
schema:
type: string
- description: >-
A unique ID which identifies each API call and used to track and
debug issues; use a random generated GUID for this ID
in: header
name: WM_QOS.CORRELATION_ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- description: Walmart Service Name
in: header
name: WM_SVC.NAME
required: true
schema:
type: string
example: Walmart Service Name
- description: The Epoch timestamp
name: WM_SEC.TIMESTAMP
in: header
required: true
schema:
type: string
example: '1443748249449'
- description: >-
The vendor's digital signature, generated by running the JAR file or
custom generation code
name: WM_SEC.AUTH_SIGNATURE
in: header
required: true
schema:
type: string
example: 9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=
- description: A unique ID required to access the API
name: WM_CONSUMER.ID
in: header
required: true
schema:
type: string
example: Get the Consumer ID from Developer Center after logging in
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/FeedsCreateContentFeedRequest'
examples:
xml1:
value: |-
<ContentProductFeed xmlns="http://walmart.com/content">
<ContentProductFeedHeader>
<version>3.0</version>
</ContentProductFeedHeader>
<ContentProduct>
<sku>02782382027292</sku>
<SkuUpdate>No</SkuUpdate>
<productName>
KIND Bars, Nuts and Spices Bar, Dark Chocolate Cinnamon Pecan, 1.4 oz, 12/Box
</productName>
<productIdentifiers>
<productIdentifier>
<productIdType>GTIN</productIdType>
<productId>02782382027292</productId>
</productIdentifier>
<productIdentifier>
<productIdType>UPC</productIdType>
<productId>278238202729</productId>
</productIdentifier>
</productIdentifiers>
<category>
<FoodAndBeverageCategory>
<FoodAndBeverage>
<shortDescription>
Kind Bar, Dark Chocolate Cinnamon Pecan - Mfg Part No. 602652177521
</shortDescription>
<keyFeatures>
<keyFeaturesValue>
Ingredients You Can See & Pronounce. ONLY 5g SUGAR7g FIBER / 6g PROTEIN .All Natural / NON GMO. Gluten Free. No Sugar Alcohols. Low Glycemic .Low Sodium .No Trans Fats .No Sulphur Dioxide. No Hydrogenated Oils Kosher
</keyFeaturesValue>
<keyFeaturesValue>All Natural / NON GMO</keyFeaturesValue>
<keyFeaturesValue>7g fiber. 6g protein. Only 5g sugar</keyFeaturesValue>
<keyFeaturesValue>So go on, have your KIND and eat it too!</keyFeaturesValue>
</keyFeatures>
<unitsPerConsumerUnit>6</unitsPerConsumerUnit>
<brand>Kind</brand>
<manufacturer>Nestle</manufacturer>
<mainImageUrl>
http://i5.walmartimages.com/asr/99eb373e-3041-4a0b-9846-53e0260f8b10_1.5c4c950aae18d21febf427a72d42ad01.jpeg?odnHeight=180&odnWidth=180&odnBg=ffffff
</mainImageUrl>
<isPrivateLabelOrUnbranded>Yes</isPrivateLabelOrUnbranded>
<exclusiveBrandsIndicator>Yes</exclusiveBrandsIndicator>
<isProp65WarningRequired>Yes</isProp65WarningRequired>
<prop65WarningText>
Many food and beverage cans have linings containing bisphenol A (BPA), a chemical known to the State of California to cause harm to the female reproductive system. Jar lids and bottle caps may also contain BPA. You can be exposed to BPA when you consume foods or beverages packaged in these containers. For more information go to: www.P65Warnings.ca.gov/BPA.
</prop65WarningText>
<hasExpiration>Yes</hasExpiration>
<shelfLife>
<measure>500</measure>
<unit>days</unit>
</shelfLife>
<hasPricePerUnit>Yes</hasPricePerUnit>
<pricePerUnitQuantity>1.80</pricePerUnitQuantity>
<pricePerUnitUom>Ounce</pricePerUnitUom>
<hasGMOs>No</hasGMOs>
<isTemperatureSensitive>No</isTemperatureSensitive>
<hasStateRestrictions>No</hasStateRestrictions>
<isIntendedForHumanConsumption>Yes</isIntendedForHumanConsumption>
<isNutritionFactsLabelRequired>Yes</isNutritionFactsLabelRequired>
<nutritionFactsLabel>
http://www.mymreviews.com/wp-content/uploads/2014/02/KIND-Nutrition2.jpg
</nutritionFactsLabel>
<nutritionIngredientsImage>
http://www.mymreviews.com/wp-content/uploads/2014/02/KIND-Nutrition2.jpg
</nutritionIngredientsImage>
<hasIngredientList>Yes</hasIngredientList>
<ingredientListImage>
http://www.mymreviews.com/wp-content/uploads/2014/02/KIND-Nutrition2.jpg
</ingredientListImage>
<isPerishable>No</isPerishable>
<containerType>
<containerTypeValue>box</containerTypeValue>
</containerType>
<isGmoFree>Yes</isGmoFree>
<servingSize>1 bar</servingSize>
<servingsPerContainer>12.00</servingsPerContainer>
<calories>
<measure>200</measure>
<unit>Calories</unit>
</calories>
<caloriesFromFat>
<measure>20</measure>
<unit>Calories</unit>
</caloriesFromFat>
<totalFat>
<measure>8.00</measure>
<unit>g</unit>
</totalFat>
<totalFatPercentageDailyValue>20.00</totalFatPercentageDailyValue>
<fatCaloriesPerGram>
<measure>20</measure>
<unit>Calories</unit>
</fatCaloriesPerGram>
<nutrients>
<nutrient>
<nutrientName>Calcium</nutrientName>
<nutrientAmount>12g</nutrientAmount>
<nutrientPercentageDailyValue>20</nutrientPercentageDailyValue>
</nutrient>
</nutrients>
<foodForm>Bars</foodForm>
<isImitation>No</isImitation>
<usdaInspected>Yes</usdaInspected>
<hasHighFructoseCornSyrup>No</hasHighFructoseCornSyrup>
<foodAllergenStatements>
<foodAllergenStatement>Contains nuts</foodAllergenStatement>
</foodAllergenStatements>
<caffeineDesignation>Naturally Decaffeinated</caffeineDesignation>
</FoodAndBeverage>
</FoodAndBeverageCategory>
</category>
</ContentProduct>
</ContentProductFeed>
responses:
'200':
description: Successful Operation
content:
application/xml:
schema:
$ref: '#/components/schemas/FeedsCreateContentFeedResponse'
example: |-
<?xml version="1.0" encoding="UTF-8"?>
<ns2:FeedAcknowledgement xmlns:ns2="http://walmart.com/">
<ns2:feedid>039F4AEA0B3A4E1FBEF0A6403507B18C@AQQBAQA</ns2:feedid>
</ns2:FeedAcknowledgement>
/v2/feeds:
post:
tags:
- Feeds
summary: Rich Media
operationId: Feeds_createRichMediaFeed
description: >-
Rich Media includes material such as videos, comparison tables, and
view360 media which is item-specific.
parameters:
- description: The feed Type
name: feedType
in: query
required: true
schema:
type: string
default: item
- description: >-
A unique ID to track the consumer request by channel. Use the
Consumer Channel Type received during onboarding
in: header
name: WM_CONSUMER.CHANNEL.TYPE
required: false
schema:
type: string
- description: >-
A unique ID which identifies each API call and used to track and
debug issues; use a random generated GUID for this ID
in: header
name: WM_QOS.CORRELATION_ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- description: Walmart Service Name
in: header
name: WM_SVC.NAME
required: true
schema:
type: string
example: Walmart Service Name
- description: The Epoch timestamp
name: WM_SEC.TIMESTAMP
in: header
required: true
schema:
type: string
example: '1443748249449'
- description: >-
The vendor's digital signature, generated by running the JAR file or
custom generation code
name: WM_SEC.AUTH_SIGNATURE
in: header
required: true
schema:
type: string
example: 9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=
- description: A unique ID required to access the API
name: WM_CONSUMER.ID
in: header
required: true
schema:
type: string
example: Get the Consumer ID from Developer Center after logging in
requestBody:
content:
application/xml:
schema:
$ref: '#/components/schemas/FeedsCreateRichMediaFeedRequest'
examples:
xml1:
value: >
<?xml version="1.0" encoding="UTF-8"?>
<RichMediaFeed xmlns="http://walmart.com/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://walmart.com/ RichMediaFeed.xsd ">
<RichMediaFeedHeader>
<version>2.1.2</version>
<requestId>requestId</requestId>
<requestBatchId>requestBatchId</requestBatchId>
<feedDate>2001-12-31T12:00:00</feedDate>
<mart>WALMART_US</mart>
</RichMediaFeedHeader>
<RichMedia>
<productIdentifiers>
<productIdentifier>
<productIdType>UPC</productIdType>
<productId>815812013182</productId>
</productIdentifier>
</productIdentifiers>
<Modules processMode="MERGE">
<view360 provider="">
<html-content>html-content</html-content>
</view360>
<marketing-content provider="">
<html-content>html-content</html-content>
</marketing-content>
<product-tour provider="">
<html-content>html-content</html-content>
</product-tour>
<videos provider="">
<video provider="">
<title>title</title>
<description>description</description>
<language>en-US</language>
<closed-caption>
<url>url</url>
<format>webvtt</format>
<language>en-US</language>
</closed-caption>
<age-gate>0</age-gate>
<source-mobile>
<url>url</url>
<width>720</width>
<height>480</height>
<format>mp4</format>
<thumbnail>
<url>url</url>
<format>png</format>
<width>120</width>
<height>100</height>
</thumbnail>
<poster>
<url>url</url>
<format>jpg</format>
<width>720</width>
<height>480</height>
</poster>
</source-mobile>
<sources>
<source>
<url>url</url>
<width>720</width>
<height>480</height>
<format>mp4</format>
<screen>mobile</screen>
<thumbnail>
<url>url</url>
<format>png</format>
<width>120</width>
<height>100</height>
</thumbnail>
<poster>
<url>url</url>
<format>jpg</format>
<width>720</width>
<height>480</height>
</poster>
</source>
</sources>
<duration>0</duration>
<likes>0</likes>
<views>0</views>
<tags>tags</tags>
</video>
</videos>
<documents provider="">
<document>
<title>title</title>
<url>url</url>
<format>pdf</format>
<pages>0</pages>
<thumbnail>
<url>url</url>
<format>png</format>
<width>120</width>
<height>100</height>
</thumbnail>
<size>0</size>
</document>
</documents>
<customer-review-videos provider="">
<customer-review-video provider="">
<title>title</title>
<description>description</description>
<language>en-US</language>
<closed-caption>
<url>url</url>
<format>webvtt</format>
<language>en-US</language>
</closed-caption>
<age-gate>0</age-gate>
<source-computer>
<url>url</url>
<width>720</width>
<height>480</height>
<format>mp4</format>
<thumbnail>
<url>url</url>
<format>png</format>
<width>120</width>
<height>100</height>
</thumbnail>
<poster>
<url>url</url>
<format>jpg</format>
<width>720</width>
<height>480</height>
</poster>
</source-computer>
<sources>
<source>
<url>url</url>
<width>720</width>
<height>480</height>
<format>mp4</format>
<screen>mobile</screen>
<thumbnail>
<url>url</url>
<format>png</format>
<width>120</width>
<height>100</height>
</thumbnail>
<poster>
<url>url</url>
<format>jpg</format>
<width>720</width>
<height>480</height>
</poster>
</source>
</sources>
<duration>0</duration>
<likes>0</likes>
<views>0</views>
<tags>tags</tags>
</customer-review-video>
</customer-review-videos>
<comparison-table provider="">
<headline>
<image>
<title>title</title>
<url>url</url>
<height>0</height>
<width>0</width>
<format>png</format>
</image>
</headline>
<feature-column>
<sections>
<section>
<header>
<caption>caption</caption>
</header>
<feature>
<caption>caption</caption>
</feature>
</section>
</sections>
</feature-column>
<product-columns>
<product-column>
<products-info>
<product-info>
<title>title</title>
<thumbnail>
<url>url</url>
<format>png</format>
<width>120</width>
<height>120</height>
</thumbnail>
<productIdentifiers>
<productIdentifier>
<productIdType>UPC</productIdType>
<productId>productId</productId>
</productIdentifier>
</productIdentifiers>
</product-info>
</products-info>
<value>value</value>
</product-column>
</product-columns>
</comparison-table>
<expert-reviews provider="">
<expert-review provider="">
<html-content>html-content</html-content>
</expert-review>
</expert-reviews>
<misc-modules provider="">
<misc-module>
<attributeName>attributeName</attributeName>
<attributeValue>attributeValue</attributeValue>
</misc-module>
</misc-modules>
</Modules>
<additionalProductAttributes>
<NameValueAttribute>
<name>name</name>
<type>LOCALIZABLE_TEXT</type>
<value>
<value>value</value>
<group>group</group>
<rank>0</rank>
</value>
</NameValueAttribute>
</additionalProductAttributes>
</RichMedia>
</RichMediaFeed>
required: true
responses:
'200':
description: Successful Operation
content:
application/xml:
schema:
$ref: '#/components/schemas/FeedsCreateRichMediaFeedResponse'
/feeds:
get:
tags:
- Feeds
summary: Feed status
operationId: Feeds_displayItemStatus
description: >-
You can display an item status for a specific feed ID. Use the feed ID
returned from the upload an item feed API.
parameters:
- description: >-
A unique ID returned from the Bulk Upload API, used for tracking the
Feed File. Special characters must be escaped (e.g., feedId:
'...3456@789...' must be entered in the URL as '...3456%40789).
name: feedId
in: query
required: true
schema:
type: string
- description: >-
The object response to the starting number, where 0 is the first
entity that can be requested.
name: offset
in: query
required: false
schema:
type: string
default: '0'
- description: The number of entities to be returned. Maximum 20 entities.
name: limit
in: query
required: false
schema:
type: string
default: '20'
- description: >-
A unique ID to track the consumer request by channel. Use the
Consumer Channel Type received during onboarding
in: header
name: WM_CONSUMER.CHANNEL.TYPE
required: false
schema:
type: string
- description: >-
A unique ID which identifies each API call and used to track and
debug issues; use a random generated GUID for this ID
in: header
name: WM_QOS.CORRELATION_ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- description: Walmart Service Name
in: header
name: WM_SVC.NAME
required: true
schema:
type: string
example: Walmart Service Name
- description: The Epoch timestamp
name: WM_SEC.TIMESTAMP
in: header
required: true
schema:
type: string
example: '1443748249449'
- description: >-
The vendor's digital signature, generated by running the JAR file or
custom generation code
name: WM_SEC.AUTH_SIGNATURE
in: header
required: true
schema:
type: string
example: 9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=
- description: A unique ID required to access the API
name: WM_CONSUMER.ID
in: header
required: true
schema:
type: string
example: Get the Consumer ID from Developer Center after logging in
responses:
'200':
description: Successful Operation
content:
application/xml:
schema:
$ref: '#/components/schemas/FeedsDisplayItemStatusResponse'
example: |-
<?xml version="1.0" encoding="UTF-8"?>
<ns2:list xmlns:ns2="http://walmart.com/">
<ns2:totalresults>1</ns2:totalresults>
<ns2:offset>0</ns2:offset>
<ns2:limit>50</ns2:limit>
<ns2:results>
<ns2:feed>
<ns2:feedid>039F4AEA0B3A4E1FBEF0A6403507B18C@AQQBAQA</ns2:feedid>
<ns2:feedtype>CONTENT_PRODUCT</ns2:feedtype>
<ns2:partnerid>721407</ns2:partnerid>
<ns2:itemsreceived>1</ns2:itemsreceived>
<ns2:itemssucceeded>1</ns2:itemssucceeded>
<ns2:itemsfailed>0</ns2:itemsfailed>
<ns2:itemsprocessing>0</ns2:itemsprocessing>
<ns2:feedstatus>PROCESSED</ns2:feedstatus>
<ns2:feeddate>2016-08-29T21:00:47.546Z</ns2:feeddate>
<ns2:batchid>b1234</ns2:batchid>
<ns2:modifieddtm>2016-08-29T21:01:17.099Z</ns2:modifieddtm>
<ns2:filename>V3_101_Electronics.xlsm</ns2:filename>
<ns2:itemdataerrorcount>0</ns2:itemdataerrorcount>
<ns2:itemsystemerrorcount>0</ns2:itemsystemerrorcount>
<ns2:itemtimeouterrorcount>0</ns2:itemtimeouterrorcount>
</ns2:feed>
</ns2:results>
</ns2:list>
/feeds/{feedId}:
get:
tags:
- Feeds
summary: Feed item status
operationId: Feeds_getFeedStatus
description: >-
You can display the status of all items for a specific feed ID. Use the
feed ID returned from the upload an item feed API.
parameters:
- description: >-
A unique ID returned from the Bulk Upload API, used for tracking the
Feed File. Special characters must be escaped (e.g., feedId:
'...3456@789...' must be entered in the URL as '...3456%40789).
name: feedId
in: path
required: true
schema:
type: string
- description: >-
Includes details of each entity in the feed. Do not set this
parameter to true.
name: includeDetails
in: query
required: false
schema:
type: string
default: 'false'
- description: >-
The object response to the starting number, where 0 is the first
entity that can be requested.
name: offset
in: query
required: false
schema:
type: string
default: '0'
- description: The number of entities to be returned. Maximum 20 entities.
name: limit
in: query
required: false
schema:
type: string
default: '20'
- description: >-
A unique ID to track the consumer request by channel. Use the
Consumer Channel Type received during onboarding
in: header
name: WM_CONSUMER.CHANNEL.TYPE
required: false
schema:
type: string
- description: >-
A unique ID which identifies each API call and used to track and
debug issues; use a random generated GUID for this ID
in: header
name: WM_QOS.CORRELATION_ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- description: Walmart Service Name
in: header
name: WM_SVC.NAME
required: true
schema:
type: string
example: Walmart Service Name
- description: The Epoch timestamp
name: WM_SEC.TIMESTAMP
in: header
required: true
schema:
type: string
example: '1443748249449'
- description: >-
The vendor's digital signature, generated by running the JAR file or
custom generation code
name: WM_SEC.AUTH_SIGNATURE
in: header
required: true
schema:
type: string
example: 9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=
- description: A unique ID required to access the API
name: WM_CONSUMER.ID
in: header
required: true
schema:
type: string
example: Get the Consumer ID from Developer Center after logging in
responses:
'200':
description: Successful Operation
content:
application/xml:
schema:
$ref: '#/components/schemas/FeedsGetFeedStatusResponse'
example: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:PartnerFeedResponse xmlns:ns2="http://walmart.com/">
<ns2:feedId>4BD182294ECD4398AEBF3A4FAEB1AE30@AQMBAAA</ns2:feedId>
<ns2:feedStatus>PROCESSED</ns2:feedStatus>
<ns2:ingestionErrors/>
<ns2:itemsReceived>3</ns2:itemsReceived>
<ns2:itemsSucceeded>3</ns2:itemsSucceeded>
<ns2:itemsFailed>0</ns2:itemsFailed>
<ns2:itemsProcessing>0</ns2:itemsProcessing>
<ns2:offset>0</ns2:offset>
<ns2:limit>50</ns2:limit>
<ns2:itemDetails>
<ns2:itemIngestionStatus>
<ns2:martId>0</ns2:martId>
<ns2:sku>Ikk3EoRhOVsL9kmWgM6y</ns2:sku>
<ns2:wpid>2SID2R8VLS5F</ns2:wpid>
<ns2:ingestionStatus>SUCCESS</ns2:ingestionStatus>
<ns2:ingestionErrors/>
</ns2:itemIngestionStatus>
<ns2:itemIngestionStatus>
<ns2:martId>0</ns2:martId>
<ns2:sku>pfszvVuJ8TWgz4nKLHst</ns2:sku>
<ns2:wpid>4NZ5M2JBIK2O</ns2:wpid>
<ns2:ingestionStatus>SUCCESS</ns2:ingestionStatus>
<ns2:ingestionErrors/>
</ns2:itemIngestionStatus>
<ns2:itemIngestionStatus>
<ns2:martId>0</ns2:martId>
<ns2:sku>JWEWrfXxN9WSEPuJ1usA</ns2:sku>
<ns2:wpid>5C1J547KN0UT</ns2:wpid>
<ns2:ingestionStatus>SUCCESS</ns2:ingestionStatus>
<ns2:ingestionErrors/>
</ns2:itemIngestionStatus>
</ns2:itemDetails>
</ns2:PartnerFeedResponse>
components:
parameters:
authorization:
description: >-
Basic authorization header. Base 64 encodes the Client ID and Client
Secret retrieved in step two of the integration steps.
name: Authorization
in: header
required: true
schema:
type: string
example: Basic YzcyOTFjNmItNzI5MC00....
accessToken:
description: The access token retrieved in the Token API call
name: WM_SEC.ACCESS_TOKEN
in: header
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
channelType:
description: >-
A unique ID to track the consumer request by channel. Use the Consumer
Channel Type received during onboarding
name: WM_CONSUMER.CHANNEL.TYPE
in: header
required: false
schema:
type: string
correlationId:
description: >-
A unique ID which identifies each API call and used to track and debug
issues; use a random generated GUID for this ID
name: WM_QOS.CORRELATION_ID
in: header
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
svcName:
description: Walmart Service Name
name: WM_SVC.NAME
in: header
required: true
schema:
type: string
example: Walmart Service Name
accept:
description: 'Only supported Media Type : application/json'
name: Accept
in: header
required: true
schema:
type: string
example: application/json
content-type:
description: 'Only supported Media Type : application/json'
name: Content-Type
in: header
required: true
schema:
type: string
example: application/json
schemas:
FeedId:
type: object
properties:
feedId:
description: >-
A unique ID, returned from the Bulk Upload API, used for tracking
the feed file.
type: string
Cause:
type: object
properties:
description:
type: string
code:
type: string
field:
type: string
type:
type: string
xml:
name: Cause
FeedRecord:
description: Information about the individual feed
type: object
properties:
feedId:
description: A unique ID used for tracking the Feed File
type: string
feedSource:
description: The source of the feed
type: string
feedType:
description: The feed type
type: string
partnerId:
description: The seller ID
type: string
itemsReceived:
description: The number of items received
type: integer
format: int64
itemsSucceeded:
description: The number of items in the feed that have successfully processed
type: integer
format: int64
itemsFailed:
description: >-
The number of items in the feed that failed due to a data or system
error
type: integer
format: int64
itemsProcessing:
description: The number of items in the feed that are still in progress
type: integer
format: int64
feedStatus:
description: >-
Can be one of the following: RECEIVED, INPROGRESS, PROCESSED, or
ERROR. For details, see the definitions listed under 'Feed Statuses'
at the beginning of this section.
type: string
feedDate:
description: >-
The date and time the feed was submitted. Format:
yyyymmddThh:mm:ss.xxxz
type: string
format: date-time
batchId:
description: The batch ID for the feed, if provided
type: string
modifiedDtm:
description: >-
The most recent time the feed was modified. Format:
yyyymmddThh:mm:ss.xxxz
type: string
format: date-time
xml:
name: feed
FeedRecordResponse:
type: object
properties:
errors:
type: array
xml:
name: error
items:
required:
- code
type: object
properties:
info:
type: string
description:
type: string
code:
type: string
field:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
description:
type: string
code:
type: string
field:
type: string
type:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
component:
type: string
type:
type: string
serviceName:
type: string
gatewayErrorCategory:
type: string
enum:
- INTERNAL_DATA_ERROR
- EXTERNAL_DATA_ERROR
- SYSTEM_ERROR
xml:
name: GatewayError
totalResults:
description: Total number of feeds returned
type: integer
format: int64
offset:
description: >-
The object response to the starting number, where 0 is the first
available
type: integer
format: int64
limit:
description: The number of items to be returned
type: integer
format: int32
results:
type: array
xml:
wrapped: true
items:
description: Information about the individual feed
type: object
properties:
feedId:
description: A unique ID used for tracking the Feed File
type: string