generated from AdobeDocs/dev-site-documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathredoc-static.html
More file actions
1134 lines (1120 loc) · 376 KB
/
redoc-static.html
File metadata and controls
1134 lines (1120 loc) · 376 KB
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf8" />
<title>Catalog Data Ingestion API</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
body {
padding: 0;
margin: 0;
}
</style>
<script src="https://cdn.redocly.com/redoc/v2.4.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.15">.cCTQFs{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.cCTQFs{width:100%;padding:40px 40px;}}/*!sc*/
.Petks{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.Petks{width:100%;padding:0px 40px;}}/*!sc*/
data-styled.g4[id="sc-fLDLck"]{content:"cCTQFs,Petks,"}/*!sc*/
.ijZyAc{padding:40px 0;}/*!sc*/
.ijZyAc:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.ijZyAc>.ijZyAc:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width: 75rem){.ijZyAc{padding:0;}}/*!sc*/
.gWRVHL{padding:40px 0;position:relative;}/*!sc*/
.gWRVHL:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.gWRVHL>.gWRVHL:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width: 75rem){.gWRVHL{padding:0;}}/*!sc*/
.gWRVHL:not(:last-of-type):after{position:absolute;bottom:0;width:100%;display:block;content:'';border-bottom:1px solid rgba(0, 0, 0, 0.2);}/*!sc*/
data-styled.g5[id="sc-dycHyt"]{content:"ijZyAc,gWRVHL,"}/*!sc*/
.lcisZz{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.lcisZz{width:100%;padding:40px 40px;}}/*!sc*/
data-styled.g6[id="sc-jbAkgO"]{content:"lcisZz,"}/*!sc*/
.libpUV{background-color:#263238;}/*!sc*/
data-styled.g7[id="sc-gNZgCX"]{content:"libpUV,"}/*!sc*/
.eTCvZl{display:flex;width:100%;padding:0;}/*!sc*/
@media print,screen and (max-width: 75rem){.eTCvZl{flex-direction:column;}}/*!sc*/
data-styled.g8[id="sc-kfeOyU"]{content:"eTCvZl,"}/*!sc*/
.gbxRgf{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#333333;}/*!sc*/
data-styled.g9[id="sc-hRDKVd"]{content:"gbxRgf,"}/*!sc*/
.ONRDj{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;margin:0 0 20px;}/*!sc*/
data-styled.g10[id="sc-jBIHhB"]{content:"ONRDj,"}/*!sc*/
.joSISv{color:#ffffff;}/*!sc*/
data-styled.g12[id="sc-jUkaYT"]{content:"joSISv,"}/*!sc*/
.dunSEZ{border-bottom:1px solid rgba(38, 50, 56, 0.3);margin:1em 0 1em 0;color:rgba(38, 50, 56, 0.5);font-weight:normal;text-transform:uppercase;font-size:0.929em;line-height:20px;}/*!sc*/
data-styled.g13[id="sc-deSjom"]{content:"dunSEZ,"}/*!sc*/
.ccWJGj{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.ccWJGj:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
h1:hover>.ccWJGj::before,h2:hover>.ccWJGj::before,.ccWJGj:hover::before{visibility:visible;}/*!sc*/
data-styled.g14[id="sc-jHswkR"]{content:"ccWJGj,"}/*!sc*/
.krlsJY{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.VzMTm{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
.VzMTm polygon{fill:black;}/*!sc*/
.hBbXPQ{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.gGbHCS{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.gGbHCS polygon{fill:#1d8127;}/*!sc*/
.kpohcO{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.kpohcO polygon{fill:#d41f1c;}/*!sc*/
data-styled.g15[id="sc-cSaEAk"]{content:"krlsJY,VzMTm,hBbXPQ,gGbHCS,kpohcO,"}/*!sc*/
.eztgDe{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
@media screen and (max-width: 50rem){.eztgDe{display:block;overflow:hidden;}}/*!sc*/
tr:first-of-type>.eztgDe,tr.last>.eztgDe{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
tr:first-of-type>.eztgDe{background-image:linear-gradient(
to bottom,
transparent 0%,
transparent 22px,
#7c7cbb 22px,
#7c7cbb 100%
);}/*!sc*/
tr.last>.eztgDe{background-image:linear-gradient(
to bottom,
#7c7cbb 0%,
#7c7cbb 22px,
transparent 22px,
transparent 100%
);}/*!sc*/
tr.last+tr>.eztgDe{border-left-color:transparent;}/*!sc*/
tr.last:first-child>.eztgDe{background:none;border-left-color:transparent;}/*!sc*/
data-styled.g18[id="sc-kXOizl"]{content:"eztgDe,"}/*!sc*/
.kNyONh{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
.kNyONh.deprecated{text-decoration:line-through;color:#707070;}/*!sc*/
data-styled.g20[id="sc-dPKAra"]{content:"kNyONh,"}/*!sc*/
.eidGeB{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
tr.expanded .eidGeB{border-bottom:none;}/*!sc*/
@media screen and (max-width: 50rem){.eidGeB{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last>.eidGeB{border-left:none;}}/*!sc*/
data-styled.g21[id="sc-fuExOL"]{content:"eidGeB,"}/*!sc*/
.iXqMpQ{color:#7c7cbb;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
.iXqMpQ::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#7c7cbb;}/*!sc*/
.iXqMpQ::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#7c7cbb;height:7px;}/*!sc*/
data-styled.g22[id="sc-gjXmFk"]{content:"iXqMpQ,"}/*!sc*/
.fEMWVS{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;}/*!sc*/
.fEMWVS >tr{vertical-align:middle;}/*!sc*/
@media screen and (max-width: 50rem){.fEMWVS{display:block;}.fEMWVS >tr,.fEMWVS >tbody>tr{display:block;}}/*!sc*/
@media screen and (max-width: 50rem) and (-ms-high-contrast:none){.fEMWVS td{float:left;width:100%;}}/*!sc*/
.fEMWVS .sc-hORkcV,.fEMWVS .sc-hORkcV .sc-hORkcV .sc-hORkcV,.fEMWVS .sc-hORkcV .sc-hORkcV .sc-hORkcV .sc-hORkcV .sc-hORkcV{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
.fEMWVS .sc-hORkcV .sc-hORkcV,.fEMWVS .sc-hORkcV .sc-hORkcV .sc-hORkcV .sc-hORkcV,.fEMWVS .sc-hORkcV .sc-hORkcV .sc-hORkcV .sc-hORkcV .sc-hORkcV .sc-hORkcV{background:#ffffff;}/*!sc*/
data-styled.g24[id="sc-dVupuq"]{content:"fEMWVS,"}/*!sc*/
.cBxiIC{font-size:0.9em;font-family:Courier,monospace;}/*!sc*/
.cBxiIC::after{content:' [';}/*!sc*/
data-styled.g28[id="sc-flQbIK"]{content:"cBxiIC,"}/*!sc*/
.jaRGIg{font-size:0.9em;font-family:Courier,monospace;}/*!sc*/
.jaRGIg::after{content:']';}/*!sc*/
data-styled.g29[id="sc-gQJZgv"]{content:"jaRGIg,"}/*!sc*/
.cnTfwV >ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
.cnTfwV >ul >li{padding:5px 10px;display:inline-block;background-color:#11171a;border-bottom:1px solid rgba(0, 0, 0, 0.5);cursor:pointer;text-align:center;outline:none;color:#ccc;margin:0 5px 5px 5px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;}/*!sc*/
.cnTfwV >ul >li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
.cnTfwV >ul >li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
.cnTfwV >ul >li:only-child{flex:none;min-width:100px;}/*!sc*/
.cnTfwV >ul >li.tab-success{color:#1d8127;}/*!sc*/
.cnTfwV >ul >li.tab-redirect{color:#ffa500;}/*!sc*/
.cnTfwV >ul >li.tab-info{color:#87ceeb;}/*!sc*/
.cnTfwV >ul >li.tab-error{color:#d41f1c;}/*!sc*/
.cnTfwV >.react-tabs__tab-panel{background:#11171a;}/*!sc*/
.cnTfwV >.react-tabs__tab-panel>div,.cnTfwV >.react-tabs__tab-panel>pre{padding:20px;margin:0;}/*!sc*/
.cnTfwV >.react-tabs__tab-panel>div>pre{padding:0;}/*!sc*/
data-styled.g30[id="sc-bCjwNj"]{content:"cnTfwV,"}/*!sc*/
.eOvdyU code[class*='language-'],.eOvdyU pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
@media print{.eOvdyU code[class*='language-'],.eOvdyU pre[class*='language-']{text-shadow:none;}}/*!sc*/
.eOvdyU pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
.eOvdyU .token.comment,.eOvdyU .token.prolog,.eOvdyU .token.doctype,.eOvdyU .token.cdata{color:hsl(30, 20%, 50%);}/*!sc*/
.eOvdyU .token.punctuation{opacity:0.7;}/*!sc*/
.eOvdyU .namespace{opacity:0.7;}/*!sc*/
.eOvdyU .token.property,.eOvdyU .token.tag,.eOvdyU .token.number,.eOvdyU .token.constant,.eOvdyU .token.symbol{color:#4a8bb3;}/*!sc*/
.eOvdyU .token.boolean{color:#e64441;}/*!sc*/
.eOvdyU .token.selector,.eOvdyU .token.attr-name,.eOvdyU .token.string,.eOvdyU .token.char,.eOvdyU .token.builtin,.eOvdyU .token.inserted{color:#a0fbaa;}/*!sc*/
.eOvdyU .token.selector+a,.eOvdyU .token.attr-name+a,.eOvdyU .token.string+a,.eOvdyU .token.char+a,.eOvdyU .token.builtin+a,.eOvdyU .token.inserted+a,.eOvdyU .token.selector+a:visited,.eOvdyU .token.attr-name+a:visited,.eOvdyU .token.string+a:visited,.eOvdyU .token.char+a:visited,.eOvdyU .token.builtin+a:visited,.eOvdyU .token.inserted+a:visited{color:#4ed2ba;text-decoration:underline;}/*!sc*/
.eOvdyU .token.property.string{color:white;}/*!sc*/
.eOvdyU .token.operator,.eOvdyU .token.entity,.eOvdyU .token.url,.eOvdyU .token.variable{color:hsl(40, 90%, 60%);}/*!sc*/
.eOvdyU .token.atrule,.eOvdyU .token.attr-value,.eOvdyU .token.keyword{color:hsl(350, 40%, 70%);}/*!sc*/
.eOvdyU .token.regex,.eOvdyU .token.important{color:#e90;}/*!sc*/
.eOvdyU .token.important,.eOvdyU .token.bold{font-weight:bold;}/*!sc*/
.eOvdyU .token.italic{font-style:italic;}/*!sc*/
.eOvdyU .token.entity{cursor:help;}/*!sc*/
.eOvdyU .token.deleted{color:red;}/*!sc*/
data-styled.g32[id="sc-dJkDXt"]{content:"eOvdyU,"}/*!sc*/
.hzLBDF{opacity:0.7;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
.hzLBDF:focus-within{opacity:1;}/*!sc*/
.hzLBDF >button{background-color:transparent;border:0;color:inherit;padding:2px 10px;font-family:Roboto,sans-serif;font-size:14px;line-height:1.5em;cursor:pointer;outline:0;}/*!sc*/
.hzLBDF >button :hover,.hzLBDF >button :focus{background:rgba(255, 255, 255, 0.1);}/*!sc*/
data-styled.g33[id="sc-lertIE"]{content:"hzLBDF,"}/*!sc*/
.hPiyTK{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
.hPiyTK polyline{color:white;}/*!sc*/
data-styled.g38[id="sc-lkbiLU"]{content:"hPiyTK,"}/*!sc*/
.hAjcNi{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.5);vertical-align:bottom;padding:2px 0px 2px 6px;position:relative;width:auto;background:white;color:#263238;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;cursor:pointer;transition:border 0.25s ease,color 0.25s ease,box-shadow 0.25s ease;}/*!sc*/
.hAjcNi label{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;font-family:Montserrat,sans-serif;color:#333333;vertical-align:bottom;width:auto;text-transform:none;padding:0 22px 0 4px;font-size:0.929em;line-height:1.5em;font-family:inherit;text-overflow:ellipsis;overflow:hidden;white-space:nowrap;}/*!sc*/
.hAjcNi .dropdown-select{position:absolute;top:0;left:0;width:100%;height:100%;opacity:0;border:none;appearance:none;cursor:pointer;color:#333333;line-height:inherit;font-family:inherit;}/*!sc*/
.hAjcNi:hover,.hAjcNi:focus-within{border:1px solid #32329f;color:#32329f;box-shadow:0px 0px 0px 1px #32329f;}/*!sc*/
data-styled.g39[id="sc-cYoYeT"]{content:"hAjcNi,"}/*!sc*/
.lcGauM{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
data-styled.g41[id="sc-dslWvo"]{content:"lcGauM,"}/*!sc*/
.iFgJCs{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.iFgJCs p:last-child{margin-bottom:0;}/*!sc*/
.iFgJCs h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.iFgJCs h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.iFgJCs code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.iFgJCs pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.iFgJCs pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.iFgJCs pre code:before,.iFgJCs pre code:after{content:none;}/*!sc*/
.iFgJCs blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.iFgJCs img{max-width:100%;box-sizing:content-box;}/*!sc*/
.iFgJCs ul,.iFgJCs ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.iFgJCs ul ul,.iFgJCs ol ul,.iFgJCs ul ol,.iFgJCs ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.iFgJCs table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.iFgJCs table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.iFgJCs table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.iFgJCs table th,.iFgJCs table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.iFgJCs table th{text-align:left;font-weight:bold;}/*!sc*/
.iFgJCs .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.iFgJCs .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.iFgJCs h1:hover>.share-link::before,.iFgJCs h2:hover>.share-link::before,.iFgJCs .share-link:hover::before{visibility:visible;}/*!sc*/
.iFgJCs a{text-decoration:auto;color:#32329f;}/*!sc*/
.iFgJCs a:visited{color:#32329f;}/*!sc*/
.iFgJCs a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
.fHLtmm{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.fHLtmm p:last-child{margin-bottom:0;}/*!sc*/
.fHLtmm p:first-child{margin-top:0;}/*!sc*/
.fHLtmm p:last-child{margin-bottom:0;}/*!sc*/
.fHLtmm h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.fHLtmm h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.fHLtmm code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.fHLtmm pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.fHLtmm pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.fHLtmm pre code:before,.fHLtmm pre code:after{content:none;}/*!sc*/
.fHLtmm blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.fHLtmm img{max-width:100%;box-sizing:content-box;}/*!sc*/
.fHLtmm ul,.fHLtmm ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.fHLtmm ul ul,.fHLtmm ol ul,.fHLtmm ul ol,.fHLtmm ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.fHLtmm table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.fHLtmm table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.fHLtmm table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.fHLtmm table th,.fHLtmm table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.fHLtmm table th{text-align:left;font-weight:bold;}/*!sc*/
.fHLtmm .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.fHLtmm .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.fHLtmm h1:hover>.share-link::before,.fHLtmm h2:hover>.share-link::before,.fHLtmm .share-link:hover::before{visibility:visible;}/*!sc*/
.fHLtmm a{text-decoration:auto;color:#32329f;}/*!sc*/
.fHLtmm a:visited{color:#32329f;}/*!sc*/
.fHLtmm a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
.jcthWC{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.jcthWC p:last-child{margin-bottom:0;}/*!sc*/
.jcthWC p:first-child{margin-top:0;}/*!sc*/
.jcthWC p:last-child{margin-bottom:0;}/*!sc*/
.jcthWC p{display:inline-block;}/*!sc*/
.jcthWC h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.jcthWC h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.jcthWC code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.jcthWC pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.jcthWC pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.jcthWC pre code:before,.jcthWC pre code:after{content:none;}/*!sc*/
.jcthWC blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.jcthWC img{max-width:100%;box-sizing:content-box;}/*!sc*/
.jcthWC ul,.jcthWC ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.jcthWC ul ul,.jcthWC ol ul,.jcthWC ul ol,.jcthWC ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.jcthWC table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.jcthWC table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.jcthWC table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.jcthWC table th,.jcthWC table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.jcthWC table th{text-align:left;font-weight:bold;}/*!sc*/
.jcthWC .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.jcthWC .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.jcthWC h1:hover>.share-link::before,.jcthWC h2:hover>.share-link::before,.jcthWC .share-link:hover::before{visibility:visible;}/*!sc*/
.jcthWC a{text-decoration:auto;color:#32329f;}/*!sc*/
.jcthWC a:visited{color:#32329f;}/*!sc*/
.jcthWC a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
data-styled.g42[id="sc-eXfTSZ"]{content:"iFgJCs,fHLtmm,jcthWC,"}/*!sc*/
.iWCNbi{display:inline;}/*!sc*/
data-styled.g43[id="sc-dXYVqG"]{content:"iWCNbi,"}/*!sc*/
.kPewJt{position:relative;}/*!sc*/
data-styled.g44[id="sc-fCSSOr"]{content:"kPewJt,"}/*!sc*/
.jmgBLa:hover>.sc-lertIE{opacity:1;}/*!sc*/
data-styled.g49[id="sc-eOrxMY"]{content:"jmgBLa,"}/*!sc*/
.fAqzdc{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
.fAqzdc .redoc-json code>.collapser{display:none;pointer-events:none;}/*!sc*/
.fAqzdc .callback-function{color:gray;}/*!sc*/
.fAqzdc .collapser:after{content:'-';cursor:pointer;}/*!sc*/
.fAqzdc .collapsed>.collapser:after{content:'+';cursor:pointer;}/*!sc*/
.fAqzdc .ellipsis:after{content:' … ';}/*!sc*/
.fAqzdc .collapsible{margin-left:2em;}/*!sc*/
.fAqzdc .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
.fAqzdc .hovered{background-color:rgba(235, 238, 249, 1);}/*!sc*/
.fAqzdc .collapser{background-color:transparent;border:0;color:#fff;font-family:Courier,monospace;font-size:13px;padding-right:6px;padding-left:6px;padding-top:0;padding-bottom:0;display:flex;align-items:center;justify-content:center;width:15px;height:15px;position:absolute;top:4px;left:-1.5em;cursor:default;user-select:none;-webkit-user-select:none;padding:2px;}/*!sc*/
.fAqzdc .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
.fAqzdc ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
.fAqzdc li{position:relative;display:block;}/*!sc*/
.fAqzdc .hoverable{display:inline-block;}/*!sc*/
.fAqzdc .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
.fAqzdc .collapsed>.collapsible{display:none;}/*!sc*/
.fAqzdc .ellipsis{display:none;}/*!sc*/
.fAqzdc .collapsed>.ellipsis{display:inherit;}/*!sc*/
data-styled.g50[id="sc-gtlvkJ"]{content:"fAqzdc,"}/*!sc*/
.hmEMDU{padding:0.9em;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;}/*!sc*/
data-styled.g51[id="sc-beKSRx"]{content:"hmEMDU,"}/*!sc*/
.dpRqHD{font-family:Montserrat,sans-serif;font-size:12px;position:absolute;z-index:1;top:-11px;left:12px;font-weight:600;color:rgba(255,255,255,0.7);}/*!sc*/
data-styled.g52[id="sc-fEOKFM"]{content:"dpRqHD,"}/*!sc*/
.OIIYS{position:relative;}/*!sc*/
data-styled.g53[id="sc-bxmmIP"]{content:"OIIYS,"}/*!sc*/
.jkMLIl{margin:0 0 10px 0;display:block;background-color:rgba(38,50,56,0.4);border:none;padding:0.9em 1.6em 0.9em 0.9em;box-shadow:none;}/*!sc*/
.jkMLIl label{color:#ffffff;text-overflow:ellipsis;white-space:nowrap;overflow:hidden;font-size:1em;text-transform:none;border:none;}/*!sc*/
.jkMLIl:hover,.jkMLIl:focus-within{border:none;box-shadow:none;background-color:rgba(38,50,56,0.7);}/*!sc*/
data-styled.g54[id="sc-fXqexe"]{content:"jkMLIl,"}/*!sc*/
.exYKuj{margin-top:15px;}/*!sc*/
data-styled.g56[id="sc-loYsQo"]{content:"exYKuj,"}/*!sc*/
.dSXgsG.deprecated span.property-name{text-decoration:line-through;color:#707070;}/*!sc*/
.dSXgsG button{background-color:transparent;border:0;outline:0;font-size:13px;font-family:Courier,monospace;cursor:pointer;padding:0;color:#333333;}/*!sc*/
.dSXgsG button:focus{font-weight:600;}/*!sc*/
.dSXgsG .sc-cSaEAk{height:1.1em;width:1.1em;}/*!sc*/
.dSXgsG .sc-cSaEAk polygon{fill:#666;}/*!sc*/
data-styled.g57[id="sc-hhvUTr"]{content:"dSXgsG,"}/*!sc*/
.jBpAbV{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
data-styled.g58[id="sc-sediK"]{content:"jBpAbV,"}/*!sc*/
.hELCbj{color:rgba(102,102,102,0.9);}/*!sc*/
data-styled.g59[id="sc-cAQujh"]{content:"hELCbj,"}/*!sc*/
.bCDwpq{color:#666;}/*!sc*/
data-styled.g60[id="sc-haUlXw"]{content:"bCDwpq,"}/*!sc*/
.eUvFgO{color:#666;word-break:break-word;}/*!sc*/
data-styled.g61[id="sc-gIivzS"]{content:"eUvFgO,"}/*!sc*/
.kpBMZY{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
data-styled.g62[id="sc-incsXD"]{content:"kpBMZY,"}/*!sc*/
.cPTpOn{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
+{margin-left:0;}/*!sc*/
data-styled.g66[id="sc-cHQrJj"]{content:"cPTpOn,"}/*!sc*/
.gzplQl{border-radius:2px;background-color:rgba(104,104,207,0.05);color:rgba(50,50,159,0.9);margin:0 5px;padding:0 5px;border:1px solid rgba(50,50,159,0.1);}/*!sc*/
+{margin-left:0;}/*!sc*/
data-styled.g68[id="sc-fcddXt"]{content:"gzplQl,"}/*!sc*/
.jhBGuD{padding-left:10px;}/*!sc*/
data-styled.g76[id="sc-gkCgsS"]{content:"jhBGuD,"}/*!sc*/
.jsViCe{margin-top:0;margin-bottom:0.5em;}/*!sc*/
data-styled.g92[id="sc-jYpOcw"]{content:"jsViCe,"}/*!sc*/
.dITHqF{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
.dITHqF.get{background-color:#2F8132;}/*!sc*/
.dITHqF.post{background-color:#186FAF;}/*!sc*/
.dITHqF.put{background-color:#95507c;}/*!sc*/
.dITHqF.options{background-color:#947014;}/*!sc*/
.dITHqF.patch{background-color:#bf581d;}/*!sc*/
.dITHqF.delete{background-color:#cc3333;}/*!sc*/
.dITHqF.basic{background-color:#707070;}/*!sc*/
.dITHqF.link{background-color:#07818F;}/*!sc*/
.dITHqF.head{background-color:#A23DAD;}/*!sc*/
.dITHqF.hook{background-color:#32329f;}/*!sc*/
.dITHqF.schema{background-color:#707070;}/*!sc*/
data-styled.g100[id="sc-ilTbHY"]{content:"dITHqF,"}/*!sc*/
.gsQdUH{margin:0;padding:0;}/*!sc*/
.gsQdUH:first-child{padding-bottom:32px;}/*!sc*/
.sc-kDeqfd .sc-kDeqfd{font-size:0.929em;}/*!sc*/
.iuxSEa{margin:0;padding:0;display:none;}/*!sc*/
.iuxSEa:first-child{padding-bottom:32px;}/*!sc*/
.sc-kDeqfd .sc-kDeqfd{font-size:0.929em;}/*!sc*/
data-styled.g101[id="sc-kDeqfd"]{content:"gsQdUH,iuxSEa,"}/*!sc*/
.khtnrT{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
data-styled.g102[id="sc-UBoew"]{content:"khtnrT,"}/*!sc*/
.fSFepX{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;font-size:0.929em;text-transform:none;background-color:#fafafa;}/*!sc*/
.fSFepX:hover{color:#32329f;background-color:#e1e1e1;}/*!sc*/
.fSFepX .sc-cSaEAk{height:1.5em;width:1.5em;}/*!sc*/
.fSFepX .sc-cSaEAk polygon{fill:#333333;}/*!sc*/
.hPofAt{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;background-color:#fafafa;}/*!sc*/
.hPofAt:hover{color:#32329f;background-color:#ededed;}/*!sc*/
.hPofAt .sc-cSaEAk{height:1.5em;width:1.5em;}/*!sc*/
.hPofAt .sc-cSaEAk polygon{fill:#333333;}/*!sc*/
data-styled.g103[id="sc-edctFj"]{content:"fSFepX,hPofAt,"}/*!sc*/
.dRfQPL{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g104[id="sc-fJVbdy"]{content:"dRfQPL,"}/*!sc*/
.bzVECd{font-size:0.8em;margin-top:10px;text-align:center;position:fixed;width:260px;bottom:0;background:#fafafa;}/*!sc*/
.bzVECd a,.bzVECd a:visited,.bzVECd a:hover{color:#333333!important;padding:5px 0;border-top:1px solid #e1e1e1;text-decoration:none;display:flex;align-items:center;justify-content:center;}/*!sc*/
.bzVECd img{width:15px;margin-right:5px;}/*!sc*/
@media screen and (max-width: 50rem){.bzVECd{width:100%;}}/*!sc*/
data-styled.g105[id="sc-kwHJyZ"]{content:"bzVECd,"}/*!sc*/
.jSOGEJ{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
data-styled.g111[id="sc-dNMyuw"]{content:"jSOGEJ,"}/*!sc*/
.iRWLqc{font-family:Courier,monospace;margin-left:10px;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g112[id="sc-ijEwUV"]{content:"iRWLqc,"}/*!sc*/
.botQvK{outline:0;color:inherit;width:100%;text-align:left;cursor:pointer;padding:10px 30px 10px 10px;border-radius:0;background-color:transparent;display:flex;white-space:nowrap;align-items:center;border:0;border-bottom:1px solid #ccc;transition:border-color 0.25s ease;}/*!sc*/
.botQvK ..sc-ijEwUV{color:#333333;}/*!sc*/
.botQvK:focus{box-shadow:inset 0 2px 2px rgba(0, 0, 0, 0.45),0 2px 0 rgba(128, 128, 128, 0.25);}/*!sc*/
data-styled.g113[id="sc-iNzRy"]{content:"botQvK,"}/*!sc*/
.ejTpka{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.jSvWYY{font-size:0.929em;line-height:20px;background-color:#bf581d;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
data-styled.g114[id="sc-eEFyrX"]{content:"ejTpka,jSvWYY,"}/*!sc*/
.jElwoi{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0 0 6px rgba(0, 0, 0, 0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;transition:all 0.25s ease;visibility:hidden;transform:translateY(-50%) scaleY(0);}/*!sc*/
data-styled.g115[id="sc-dHpROs"]{content:"jElwoi,"}/*!sc*/
.fLVjhV{padding:10px;}/*!sc*/
data-styled.g116[id="sc-idhQoR"]{content:"fLVjhV,"}/*!sc*/
.cpBCZw{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/
.cpBCZw >span{color:#333333;}/*!sc*/
data-styled.g117[id="sc-cqTlu"]{content:"cpBCZw,"}/*!sc*/
.gpjYYu{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/
.gpjYYu:focus{outline:auto #1d8127;}/*!sc*/
.DmZc{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);}/*!sc*/
.DmZc:focus{outline:auto #d41f1c;}/*!sc*/
data-styled.g120[id="sc-kdWPFt"]{content:"gpjYYu,DmZc,"}/*!sc*/
.bniiic{vertical-align:top;}/*!sc*/
data-styled.g123[id="sc-dxpuJR"]{content:"bniiic,"}/*!sc*/
.eXjWTp{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
data-styled.g124[id="sc-frtHmg"]{content:"eXjWTp,"}/*!sc*/
.gzhca{margin-bottom:30px;}/*!sc*/
data-styled.g129[id="sc-bACthX"]{content:"gzhca,"}/*!sc*/
.bCXLbK{user-select:none;width:20px;height:20px;align-self:center;display:flex;flex-direction:column;color:#32329f;}/*!sc*/
data-styled.g130[id="sc-duGFKm"]{content:"bCXLbK,"}/*!sc*/
.hhPdPt{width:260px;background-color:#fafafa;overflow:hidden;display:flex;flex-direction:column;backface-visibility:hidden;height:100vh;position:sticky;position:-webkit-sticky;top:0;}/*!sc*/
@media screen and (max-width: 50rem){.hhPdPt{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
@media print{.hhPdPt{display:none;}}/*!sc*/
data-styled.g131[id="sc-egnSlO"]{content:"hhPdPt,"}/*!sc*/
.RFwOH{outline:none;user-select:none;background-color:#f2f2f2;color:#32329f;display:none;cursor:pointer;position:fixed;right:20px;z-index:100;border-radius:50%;box-shadow:0 0 20px rgba(0, 0, 0, 0.3);bottom:44px;width:60px;height:60px;padding:0 20px;}/*!sc*/
@media screen and (max-width: 50rem){.RFwOH{display:flex;}}/*!sc*/
.RFwOH svg{color:#0065FB;}/*!sc*/
@media print{.RFwOH{display:none;}}/*!sc*/
data-styled.g132[id="sc-iCfQMn"]{content:"RFwOH,"}/*!sc*/
.kHfBoF{font-family:Roboto,sans-serif;font-size:14px;font-weight:400;line-height:1.5em;color:#333333;display:flex;position:relative;text-align:left;-webkit-font-smoothing:antialiased;font-smoothing:antialiased;text-rendering:optimizeSpeed!important;tap-highlight-color:rgba(0, 0, 0, 0);text-size-adjust:100%;}/*!sc*/
.kHfBoF *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255, 255, 255, 0);}/*!sc*/
data-styled.g133[id="sc-kSwkvc"]{content:"kHfBoF,"}/*!sc*/
.kHUtlI{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
@media print,screen and (max-width: 50rem){.kHUtlI{width:100%;}}/*!sc*/
data-styled.g134[id="sc-dYSzwF"]{content:"kHUtlI,"}/*!sc*/
.cVugio{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
@media print,screen and (max-width: 75rem){.cVugio{display:none;}}/*!sc*/
data-styled.g135[id="sc-dZRlFK"]{content:"cVugio,"}/*!sc*/
.fgXvUT{padding:5px 0;}/*!sc*/
data-styled.g136[id="sc-ivJkgj"]{content:"fgXvUT,"}/*!sc*/
.epzymX{width:calc(100% - 40px);box-sizing:border-box;margin:0 20px;padding:5px 10px 5px 20px;border:0;border-bottom:1px solid #e1e1e1;font-family:Roboto,sans-serif;font-weight:bold;font-size:13px;color:#333333;background-color:transparent;outline:none;}/*!sc*/
data-styled.g137[id="sc-kLZDOY"]{content:"epzymX,"}/*!sc*/
.kPTEHE{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/
.kPTEHE path{fill:#333333;}/*!sc*/
data-styled.g138[id="sc-dSvSQB"]{content:"kPTEHE,"}/*!sc*/
</style>
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
</head>
<body>
<div id="redoc"><div class="sc-kSwkvc kHfBoF redoc-wrap"><div class="sc-egnSlO hhPdPt menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-ivJkgj fgXvUT"><svg class="sc-dSvSQB kPTEHE search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-kLZDOY epzymX search-input" value=""/></div><div style="overflow:auto;overscroll-behavior:contain;-ms-overflow-style:-ms-autohiding-scrollbar"><ul role="menu" class="sc-kDeqfd gsQdUH"><li tabindex="0" depth="1" data-item-id="tag/Metadata" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj fSFepX -depth1"><span width="calc(100% - 38px)" title="Metadata" class="sc-fJVbdy dRfQPL">Metadata</span><svg class="sc-cSaEAk krlsJY" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-kDeqfd iuxSEa"><li tabindex="0" depth="2" data-item-id="tag/Metadata/operation/ProductMetadataPut" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="post" class="sc-ilTbHY dITHqF operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Create product attribute metadata.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Metadata/operation/ProductMetadataPatch" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="patch" class="sc-ilTbHY dITHqF operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Update product attribute metadata.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Metadata/operation/ProductMetadataDelete" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="post" class="sc-ilTbHY dITHqF operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Delete product attributes metadata.</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Products" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj fSFepX -depth1"><span width="calc(100% - 38px)" title="Products" class="sc-fJVbdy dRfQPL">Products</span><svg class="sc-cSaEAk krlsJY" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-kDeqfd iuxSEa"><li tabindex="0" depth="2" data-item-id="tag/Products/operation/ProductsPost" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="post" class="sc-ilTbHY dITHqF operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Create or replace products</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Products/operation/ProductsPatch" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="patch" class="sc-ilTbHY dITHqF operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Update products.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Products/operation/ProductsDelete" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="post" class="sc-ilTbHY dITHqF operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Delete products.</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Price-Books" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj fSFepX -depth1"><span width="calc(100% - 38px)" title="Price Books" class="sc-fJVbdy dRfQPL">Price Books</span><svg class="sc-cSaEAk krlsJY" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-kDeqfd iuxSEa"><li tabindex="0" depth="2" data-item-id="tag/Price-Books/operation/PriceBooksPut" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="post" class="sc-ilTbHY dITHqF operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Create price books.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Price-Books/operation/PriceBooksPatch" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="patch" class="sc-ilTbHY dITHqF operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Update price books.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Price-Books/operation/PriceBooksDelete" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="post" class="sc-ilTbHY dITHqF operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Delete price books.</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Prices" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj fSFepX -depth1"><span width="calc(100% - 38px)" title="Prices" class="sc-fJVbdy dRfQPL">Prices</span><svg class="sc-cSaEAk krlsJY" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-kDeqfd iuxSEa"><li tabindex="0" depth="2" data-item-id="tag/Prices/operation/PricesPut" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="post" class="sc-ilTbHY dITHqF operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Create prices.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Prices/operation/PricesPatch" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="patch" class="sc-ilTbHY dITHqF operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Update prices.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Prices/operation/PricesDelete" role="menuitem" class="sc-UBoew khtnrT"><label class="sc-edctFj hPofAt -depth2"><span type="post" class="sc-ilTbHY dITHqF operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fJVbdy dRfQPL">Delete prices.</span></label></li></ul></li></ul><div class="sc-kwHJyZ bzVECd"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-iCfQMn RFwOH"><div class="sc-duGFKm bCXLbK"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg></div></div><div class="sc-dYSzwF kHUtlI api-content"><div class="sc-dycHyt ijZyAc"><div class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs api-info"><h1 class="sc-hRDKVd sc-jYpOcw gbxRgf jsViCe">Catalog Data Ingestion API<!-- --> <span>(<!-- -->1.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div data-role="redoc-summary" html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div data-role="redoc-description" html="<p>The Catalog Data Ingestion API allows you to create and manage products and price books and directly integrate catalog data with the Commerce catalog service.</p>
<p> This API provides the following resource collections to create and update catalog data:</p>
<ul>
<li><strong>Metadata</strong>—define and manage product attribute metadata including display settings, search characteristics, filtering options, and sorting rules.</li>
<li><strong>Products</strong>—define and manage catalog items with their attributes (name, description, SKU, images, and variants).</li>
<li><strong>Price books</strong>—define and manage pricing scopes for different customer tiers and markets.</li>
<li><strong>Prices</strong>—define and manage product SKU prices and their associated price books.</li>
</ul>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>The Catalog Data Ingestion API allows you to create and manage products and price books and directly integrate catalog data with the Commerce catalog service.</p>
<p> This API provides the following resource collections to create and update catalog data:</p>
<ul>
<li><strong>Metadata</strong>—define and manage product attribute metadata including display settings, search characteristics, filtering options, and sorting rules.</li>
<li><strong>Products</strong>—define and manage catalog items with their attributes (name, description, SKU, images, and variants).</li>
<li><strong>Price books</strong>—define and manage pricing scopes for different customer tiers and markets.</li>
<li><strong>Prices</strong>—define and manage product SKU prices and their associated price books.</li>
</ul>
</div></div></div></div><div id="tag/Metadata" data-section-id="tag/Metadata" class="sc-dycHyt ijZyAc"><div class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Metadata" aria-label="tag/Metadata"></a>Metadata</h2></div></div><div class="sc-fLDLck Petks"><div class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs redoc-markdown " html="<p>Manage product attribute definitions including display settings, search behavior, and filtering capabilities.
These settings control how product attributes appear and function throughout the storefront.</p>
<p>Product attribute metadata specifies how product attributes are displayed on the storefront.
For example, you can define a product attribute as searchable, filterable, and sortable.
You can also define the search type for a product attribute, such as autocomplete or exact match.</p>
"><p>Manage product attribute definitions including display settings, search behavior, and filtering capabilities.
These settings control how product attributes appear and function throughout the storefront.</p>
<p>Product attribute metadata specifies how product attributes are displayed on the storefront.
For example, you can define a product attribute as searchable, filterable, and sortable.
You can also define the search type for a product attribute, such as autocomplete or exact match.</p>
</div></div></div><div id="tag/Metadata/operation/ProductMetadataPut" data-section-id="tag/Metadata/operation/ProductMetadataPut" class="sc-dycHyt gWRVHL"><div data-section-id="operation/ProductMetadataPut" id="operation/ProductMetadataPut" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Metadata/operation/ProductMetadataPut" aria-label="tag/Metadata/operation/ProductMetadataPut"></a>Create product attribute metadata.<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="post" class="sc-eEFyrX ejTpka http-verb post">post</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/products/metadata</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/products/metadata</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>To ensure product data is indexed for discovery, create or replace existing product attribute metadata resources before creating products.</p>
<p>For each Commerce project, you must define metadata for the following attributes for each scope (<code>locale</code>):</p>
<ul>
<li><code>sku</code></li>
<li><code>name</code></li>
<li><code>description</code></li>
<li><code>shortDescription</code></li>
<li><code>price</code></li>
</ul>
<p>Also, you can define metadata for custom attributes.</p>
<p>When creating product attribute metadata:</p>
<ul>
<li>Each product attribute requires a unique <code>code</code> and <code>scope</code>.</li>
<li>Use the <code>dataType</code> field to define the data type for the product attribute.</li>
<li>Use the <code>visibleIn</code> field to define where the product attribute is displayed on the storefront.</li>
<li>Use the <code>filterable</code>, <code>sortable</code>, and <code>searchable</code> fields to define how the product attribute
is used for filtering, sorting, and searching.</li>
<li>Use the <code>searchWeight</code> field to define the search weight for the product attribute.</li>
<li>Use the <code>searchTypes</code> field to define the search type for the product attribute.</li>
</ul>
<p>To update existing product attribute metadata, use the update operation.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>To ensure product data is indexed for discovery, create or replace existing product attribute metadata resources before creating products.</p>
<p>For each Commerce project, you must define metadata for the following attributes for each scope (<code>locale</code>):</p>
<ul>
<li><code>sku</code></li>
<li><code>name</code></li>
<li><code>description</code></li>
<li><code>shortDescription</code></li>
<li><code>price</code></li>
</ul>
<p>Also, you can define metadata for custom attributes.</p>
<p>When creating product attribute metadata:</p>
<ul>
<li>Each product attribute requires a unique <code>code</code> and <code>scope</code>.</li>
<li>Use the <code>dataType</code> field to define the data type for the product attribute.</li>
<li>Use the <code>visibleIn</code> field to define where the product attribute is displayed on the storefront.</li>
<li>Use the <code>filterable</code>, <code>sortable</code>, and <code>searchable</code> fields to define how the product attribute
is used for filtering, sorting, and searching.</li>
<li>Use the <code>searchWeight</code> field to define the search weight for the product attribute.</li>
<li>Use the <code>searchTypes</code> field to define the search type for the product attribute.</li>
</ul>
<p>To update existing product attribute metadata, use the update operation.</p>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Client ID generated for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Client ID generated for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="code" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">code</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Attribute code</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Attribute code</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dataType" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">dataType</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"TEXT"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"DECIMAL"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"INTEGER"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"BOOLEAN"</span> </div> <div><div html="<p>Data type</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Data type</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="filterable" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">filterable</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">boolean</span></div> <div><div html="<p>Indicates whether the attribute can be used to filter products.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Indicates whether the attribute can be used to filter products.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="label" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">label</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Label for the attribute that is displayed in user interfaces.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Label for the attribute that is displayed in user interfaces.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="scope" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand scope"><span class="property-name">scope</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">object</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Scope<!-- -->) </span></div> <div><div html="<p>Scope of the entity. For example it&#39;s locale &quot;English&quot;</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Scope of the entity. For example it's locale "English"</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchable" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">searchable</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">boolean</span></div> <div><div html="<p>Indicates whether the attribute value can be used in search queries to filter results.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Indicates whether the attribute value can be used in search queries to filter results.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchTypes" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">searchTypes</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">strings</span></div><div><span class="sc-sediK jBpAbV">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"AUTOCOMPLETE"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"CONTAINS"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"STARTS_WITH"</span> </div> <div><div html="<p>Search types associated with this attribute, for example: <code>autocomplete</code>, <code>starts_with</code>, and so on.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Search types associated with this attribute, for example: <code>autocomplete</code>, <code>starts_with</code>, and so on.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchWeight" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">searchWeight</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">number</span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq"> <!-- --><<!-- -->float<!-- -->><!-- --> </span></div> <div><div html="<p>The weight associated with a searchable attribute.
Attributes with a greater weight are returned before attributes with a lower weight.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>The weight associated with a searchable attribute.
Attributes with a greater weight are returned before attributes with a lower weight.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sortable" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">sortable</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">boolean</span></div> <div><div html="<p>Indicates whether the attribute can be used to sort products.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Indicates whether the attribute can be used to sort products.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="visibleIn" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">visibleIn</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">any</span></div><div><span class="sc-sediK jBpAbV">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"PRODUCT_DETAIL"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"PRODUCT_LISTING"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"SEARCH_RESULTS"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"PRODUCT_COMPARE"</span> </div> <div><div html="<p>Determines how the attribute is used on the storefront.</p>
<ul>
<li><code>PRODUCT_DETAIL</code>: Product attribute is visible on the Product Detail Page.</li>
<li><code>PRODUCT_LISTING</code>: Product attribute is visible on Product Listing Page.</li>
<li><code>SEARCH_RESULTS</code>: Product attribute is visible on Search Results Page.</li>
<li><code>PRODUCT_COMPARE</code>: Product attribute is visible on Product Compare Page.</li>
</ul>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Determines how the attribute is used on the storefront.</p>
<ul>
<li><code>PRODUCT_DETAIL</code>: Product attribute is visible on the Product Detail Page.</li>
<li><code>PRODUCT_LISTING</code>: Product attribute is visible on Product Listing Page.</li>
<li><code>SEARCH_RESULTS</code>: Product attribute is visible on Search Results Page.</li>
<li><code>PRODUCT_COMPARE</code>: Product attribute is visible on Product Compare Page.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items in the request are accepted for further processing.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items in the request are accepted for further processing.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>Request rejected. Some of the received items are invalid. Check the &quot;message&quot; and &quot;errors&quot; fields for details.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Request rejected. Some of the received items are invalid. Check the "message" and "errors" fields for details.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">403<!-- --> </strong><div html="<p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer token in <code>Authorization</code> is still valid.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer token in <code>Authorization</code> is still valid.</p>
</div></button></div></div></div><div class="sc-jbAkgO sc-gNZgCX lcisZz libpUV"><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Request samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riioq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riioq:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riioq:0" aria-labelledby="tab:Riioq:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json</div></div><div class="sc-loYsQo exYKuj"><div html="<p>Creates searchable text attributes. This example defines metadata for the required attributes
with recommended default values.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Creates searchable text attributes. This example defines metadata for the required attributes
with recommended default values.</p>
</div><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"sku"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"Product Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dataType"</span>: <span class="token string">"TEXT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"visibleIn"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_DETAIL"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_LISTING"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"SEARCH_RESULTS"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_COMPARE"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filterable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sortable"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchWeight"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchTypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"AUTOCOMPLETE"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"Product Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dataType"</span>: <span class="token string">"TEXT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"visibleIn"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_DETAIL"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_LISTING"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"SEARCH_RESULTS"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_COMPARE"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filterable"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sortable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchWeight"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchTypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"AUTOCOMPLETE"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"Product Description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dataType"</span>: <span class="token string">"TEXT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"visibleIn"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_DETAIL"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filterable"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sortable"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchable"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchWeight"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchTypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"AUTOCOMPLETE"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"shortDescription"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"Product Short Description"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dataType"</span>: <span class="token string">"TEXT"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"visibleIn"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_DETAIL"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filterable"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sortable"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchWeight"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchTypes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"AUTOCOMPLETE"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"price"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"Price"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dataType"</span>: <span class="token string">"DECIMAL"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"visibleIn"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_DETAIL"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_LISTING"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"SEARCH_RESULTS"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_COMPARE"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"filterable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sortable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchable"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchWeight"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"searchTypes"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Response samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjioq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjioq:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjioq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjioq:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjioq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjioq:2" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjioq:0" aria-labelledby="tab:Rjioq:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json;charset=UTF-8</div></div><div class="sc-loYsQo exYKuj"><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ACCEPTED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"acceptedCount"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjioq:1" aria-labelledby="tab:Rjioq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjioq:2" aria-labelledby="tab:Rjioq:2"></div></div></div></div></div></div><div id="tag/Metadata/operation/ProductMetadataPatch" data-section-id="tag/Metadata/operation/ProductMetadataPatch" class="sc-dycHyt gWRVHL"><div data-section-id="operation/ProductMetadataPatch" id="operation/ProductMetadataPatch" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Metadata/operation/ProductMetadataPatch" aria-label="tag/Metadata/operation/ProductMetadataPatch"></a>Update product attribute metadata.<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="patch" class="sc-eEFyrX jSvWYY http-verb patch">patch</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/products/metadata</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/products/metadata</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>Update existing product attribute metadata with new values.
When the update is processed, the merge strategy is used to apply changes to <code>scalar</code> and <code>object</code> type fields. The replace strategy is used to apply changes for fields in an <code>array</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Update existing product attribute metadata with new values.
When the update is processed, the merge strategy is used to apply changes to <code>scalar</code> and <code>object</code> type fields. The replace strategy is used to apply changes for fields in an <code>array</code>.</p>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Client ID generated for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Client ID generated for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="code" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">code</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Attribute code</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Attribute code</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dataType" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">dataType</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"TEXT"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"DECIMAL"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"INTEGER"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"BOOLEAN"</span> </div> <div><div html="<p>Data type</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Data type</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="filterable" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">filterable</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">boolean</span></div> <div><div html="<p>Indicates whether the attribute can be used to filter products.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Indicates whether the attribute can be used to filter products.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="label" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">label</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Label for the attribute that is displayed in user interfaces.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Label for the attribute that is displayed in user interfaces.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="scope" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand scope"><span class="property-name">scope</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">object</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Scope<!-- -->) </span></div> <div><div html="<p>Scope of the entity. For example it&#39;s locale &quot;English&quot;</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Scope of the entity. For example it's locale "English"</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchable" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">searchable</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">boolean</span></div> <div><div html="<p>Indicates whether the attribute value can be used in search queries to filter results.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Indicates whether the attribute value can be used in search queries to filter results.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchTypes" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">searchTypes</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">strings</span></div><div><span class="sc-sediK jBpAbV">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"AUTOCOMPLETE"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"CONTAINS"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"STARTS_WITH"</span> </div> <div><div html="<p>Search types associated with this attribute, for example: <code>autocomplete</code>, <code>starts_with</code>, and so on.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Search types associated with this attribute, for example: <code>autocomplete</code>, <code>starts_with</code>, and so on.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="searchWeight" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">searchWeight</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">number</span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq"> <!-- --><<!-- -->float<!-- -->><!-- --> </span></div> <div><div html="<p>The weight associated with a searchable attribute.
Attributes with a greater weight are returned before attributes with a lower weight.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>The weight associated with a searchable attribute.
Attributes with a greater weight are returned before attributes with a lower weight.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sortable" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">sortable</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">boolean</span></div> <div><div html="<p>Indicates whether the attribute can be used to sort products.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Indicates whether the attribute can be used to sort products.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="visibleIn" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">visibleIn</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">any</span></div><div><span class="sc-sediK jBpAbV">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"PRODUCT_DETAIL"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"PRODUCT_LISTING"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"SEARCH_RESULTS"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"PRODUCT_COMPARE"</span> </div> <div><div html="<p>Determines how the attribute is used on the storefront.</p>
<ul>
<li><code>PRODUCT_DETAIL</code>: Product attribute is visible on the Product Detail Page.</li>
<li><code>PRODUCT_LISTING</code>: Product attribute is visible on Product Listing Page.</li>
<li><code>SEARCH_RESULTS</code>: Product attribute is visible on Search Results Page.</li>
<li><code>PRODUCT_COMPARE</code>: Product attribute is visible on Product Compare Page.</li>
</ul>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Determines how the attribute is used on the storefront.</p>
<ul>
<li><code>PRODUCT_DETAIL</code>: Product attribute is visible on the Product Detail Page.</li>
<li><code>PRODUCT_LISTING</code>: Product attribute is visible on Product Listing Page.</li>
<li><code>SEARCH_RESULTS</code>: Product attribute is visible on Search Results Page.</li>
<li><code>PRODUCT_COMPARE</code>: Product attribute is visible on Product Compare Page.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items in the request are accepted for further processing.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items in the request are accepted for further processing.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>Request rejected. Some of the received items are invalid. Check the &quot;invalidFeedItems&quot; node for specific errors.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Request rejected. Some of the received items are invalid. Check the "invalidFeedItems" node for specific errors.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">403<!-- --> </strong><div html="<p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
</div></button></div></div></div><div class="sc-jbAkgO sc-gNZgCX lcisZz libpUV"><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Request samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij8q:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij8q:0" aria-labelledby="tab:Rij8q:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json</div></div><div class="sc-loYsQo exYKuj"><div html="<p>Update existing product attribute metadata with new values.
Note that fields with the <code>array</code> type will replace existing data.
The example below updates the following attributes:</p>
<ul>
<li><code>label</code> - Change the product attribute label.</li>
<li><code>visibleIn</code> - Add <code>PRODUCT_LISTING</code> role to the product attribute.</li>
</ul>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Update existing product attribute metadata with new values.
Note that fields with the <code>array</code> type will replace existing data.
The example below updates the following attributes:</p>
<ul>
<li><code>label</code> - Change the product attribute label.</li>
<li><code>visibleIn</code> - Add <code>PRODUCT_LISTING</code> role to the product attribute.</li>
</ul>
</div><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"Updated - Product Name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"visibleIn"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_DETAIL"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"PRODUCT_LISTING"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Response samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj8q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj8q:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjj8q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj8q:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjj8q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj8q:2" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj8q:0" aria-labelledby="tab:Rjj8q:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json;charset=UTF-8</div></div><div class="sc-loYsQo exYKuj"><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ACCEPTED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"acceptedCount"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj8q:1" aria-labelledby="tab:Rjj8q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj8q:2" aria-labelledby="tab:Rjj8q:2"></div></div></div></div></div></div><div id="tag/Metadata/operation/ProductMetadataDelete" data-section-id="tag/Metadata/operation/ProductMetadataDelete" class="sc-dycHyt gWRVHL"><div data-section-id="operation/ProductMetadataDelete" id="operation/ProductMetadataDelete" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Metadata/operation/ProductMetadataDelete" aria-label="tag/Metadata/operation/ProductMetadataDelete"></a>Delete product attributes metadata.<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="post" class="sc-eEFyrX ejTpka http-verb post">post</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/products/metadata/delete</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/products/metadata/delete</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>Remove product attribute metadata resources from the catalog data.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Remove product attribute metadata resources from the catalog data.</p>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Client ID generated for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Client ID generated for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="code" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">code</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Attribute code</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Attribute code</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="scope" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand scope"><span class="property-name">scope</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">object</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Scope<!-- -->) </span></div> <div><div html="<p>Scope of the entity. For example it&#39;s locale &quot;English&quot;</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Scope of the entity. For example it's locale "English"</p>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items in the request are accepted for further processing.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items in the request are accepted for further processing.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>Some received items are invalid. Check the ‘invalidFeedItems’ node for specific errors.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Some received items are invalid. Check the ‘invalidFeedItems’ node for specific errors.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">403<!-- --> </strong><div html="<p>Unauthorized request. Verify the ‘x-api-key’ and make sure that the JWT in ‘x-gw-signature’ is still valid.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Unauthorized request. Verify the ‘x-api-key’ and make sure that the JWT in ‘x-gw-signature’ is still valid.</p>
</div></button></div></div></div><div class="sc-jbAkgO sc-gNZgCX lcisZz libpUV"><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Request samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijoq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijoq:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijoq:0" aria-labelledby="tab:Rijoq:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json</div></div><div class="sc-loYsQo exYKuj"><div html="<p>Marks existing product attribute metadata as deleted.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Marks existing product attribute metadata as deleted.</p>
</div><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Response samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjoq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjoq:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjjoq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjjoq:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjjoq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjjoq:2" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjoq:0" aria-labelledby="tab:Rjjoq:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json;charset=UTF-8</div></div><div class="sc-loYsQo exYKuj"><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ACCEPTED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"acceptedCount"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjjoq:1" aria-labelledby="tab:Rjjoq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjjoq:2" aria-labelledby="tab:Rjjoq:2"></div></div></div></div></div></div><div id="tag/Products" data-section-id="tag/Products" class="sc-dycHyt ijZyAc"><div class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Products" aria-label="tag/Products"></a>Products</h2></div></div><div class="sc-fLDLck Petks"><div class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs redoc-markdown " html="<p>Create and manage product data including simple products, configurable products, and their variants. Control product visibility, attributes, images, and pricing</p>
"><p>Create and manage product data including simple products, configurable products, and their variants. Control product visibility, attributes, images, and pricing</p>
</div></div></div><div id="tag/Products/operation/ProductsPost" data-section-id="tag/Products/operation/ProductsPost" class="sc-dycHyt gWRVHL"><div data-section-id="operation/ProductsPost" id="operation/ProductsPost" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Products/operation/ProductsPost" aria-label="tag/Products/operation/ProductsPost"></a>Create or replace products<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="post" class="sc-eEFyrX ejTpka http-verb post">post</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/products</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/products</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>You can create different types of products, such as simple products and configurable products.</p>
<p>When creating products:</p>
<ul>
<li>Each product requires a unique SKU identifier.</li>
<li>Products must have a defined scope, for example <code>locale</code>.</li>
<li>Add values for the required <code>name</code>, <code>slug</code>, and <code>status</code> fields.</li>
<li>Define optional fields such as descriptions, images, and custom attributes as needed.</li>
<li>Use the <code>links</code> field to define relationships between products, such as linking a product variant to its parent
configurable product.</li>
<li>You can create multiple products in a single request, and also create product variants for configurable products in the same request.</li>
</ul>
<h3>Simple Products</h3><a name="simple"></a>
Create products or replace existing products with a specified `sku` and `scope`.
If a product with the same data exists with the same SKU and scope, the product update request is ignored.
<p>Use the <a href="#operation/ProductsPatch">update operation</a> to modify values for an existing product.</p>
<h3>Configurable Products</h3><a name="configurable"></a>
A configurable product is a product that offers multiple options, such as color and size. Each unique combination of these options,
like 'color green' and 'size large,' defines a product variant. This variant is an independent product with its own SKU, price, and
inventory. The configurable product acts as a container for these product variants.
<p>To create a configurable product, you need the following:</p>
<ul>
<li><a href="#operation/ProductMetadataPut">Product attributes</a>: Define the product attributes used to define a configurable product, such as &quot;color&quot;, &quot;size&quot;, etc.</li>
<li><a href="#operation/ProductsPost">Configurable product</a>: Define the configurable product. <a href="#operation/ProductsPost!path=configurations&t=request">Configurations</a> is a required field. It defines the choices that a shopper can select.</li>
<li><a href="#operation/ProductsPost">Product variant</a>: Define a product variant for a configurable product. <a href="#operation/ProductsPost!path=attributes">&quot;Attributes&quot;</a> with <a href="#operation/ProductsPost!path=attributes/variantReferenceId&t=request">&quot;variantReferenceId&quot;</a> and <a href="#operation/ProductsPost!path=links&t=request">&quot;links&quot;</a> of type <code>VARIANT_OF</code> must be defined for product variants.</li>
</ul>
<p>Each product variant links back to the configurable product through its <code>variantReferenceId</code>, which corresponds to specific <code>configurations[].values[].variantReferenceId</code> in the configurable product.</p>
<p>To unassign a product variant from a configurable product, do one of the following:</p>
<ul>
<li>Use the <a href="#operation/ProductsDelete">Delete Product API</a> to delete the product variant.</li>
<li>Use the <a href="#operation/ProductsPatch">Update Product API</a> to set the <a href="#operation/ProductsPost!path=attributes/variantReferenceId&t=request">&quot;variantReferenceId&quot;</a> to <code>null</code> and unassign the product variant from the configurable product by removing the <a href="#operation/ProductsPost!path=links&t=request">&quot;links&quot;</a> association.</li>
</ul>
<h3>Bundle Products</h3><a =name="bundle"></a>
A bundle product combines several simple products into one sellable unit. Items within the bundle can be categorized into logical categories (groups) like`tops`, `bottoms`, and `accessories`.
Each group can have multiple items, and shoppers can select items from each group to create a customized bundle.
<p>To create a bundle product, you need the following:</p>
<ul>
<li><strong>Bundle product:</strong> Define the bundle product. <a href="#operation/ProductsPost!path=bundles&t=request"><code>Bundles</code></a> is a required field that defines the groups and items included in the bundle.</li>
<li><strong><a href="#simple">Simple products</a>:</strong> Define the simple products that are included in the bundle. Each simple product must be created separately using the create product API.
In the field <a href="#operation/ProductsPost!path=links&t=request">&quot;links&quot;</a>, the type <code>IN_BUNDLE</code> must be defined for simple products that belong to bundle products with reference to it.</li>
</ul>
<p><strong>Note:</strong> A simple product can be included only once in each bundle. If the same item is specified in multiple groups, the API returns a <code>Duplicate SKU found in bundle items</code> error.</p>
<p>To update a bundle product, do one of the following:</p>
<ul>
<li>Use <a href="#operation/ProductsPatch">Update Product API</a> to modify the groups and items in the bundle.</li>
<li>Use <a href="#operation/ProductsDelete">Delete Product API</a> to remove items from the bundle.</li>
</ul>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>You can create different types of products, such as simple products and configurable products.</p>
<p>When creating products:</p>
<ul>
<li>Each product requires a unique SKU identifier.</li>
<li>Products must have a defined scope, for example <code>locale</code>.</li>
<li>Add values for the required <code>name</code>, <code>slug</code>, and <code>status</code> fields.</li>
<li>Define optional fields such as descriptions, images, and custom attributes as needed.</li>
<li>Use the <code>links</code> field to define relationships between products, such as linking a product variant to its parent
configurable product.</li>
<li>You can create multiple products in a single request, and also create product variants for configurable products in the same request.</li>
</ul>
<h3>Simple Products</h3><a name="simple"></a>
Create products or replace existing products with a specified `sku` and `scope`.
If a product with the same data exists with the same SKU and scope, the product update request is ignored.
<p>Use the <a href="#operation/ProductsPatch">update operation</a> to modify values for an existing product.</p>
<h3>Configurable Products</h3><a name="configurable"></a>
A configurable product is a product that offers multiple options, such as color and size. Each unique combination of these options,
like 'color green' and 'size large,' defines a product variant. This variant is an independent product with its own SKU, price, and
inventory. The configurable product acts as a container for these product variants.
<p>To create a configurable product, you need the following:</p>
<ul>
<li><a href="#operation/ProductMetadataPut">Product attributes</a>: Define the product attributes used to define a configurable product, such as "color", "size", etc.</li>
<li><a href="#operation/ProductsPost">Configurable product</a>: Define the configurable product. <a href="#operation/ProductsPost!path=configurations&t=request">Configurations</a> is a required field. It defines the choices that a shopper can select.</li>
<li><a href="#operation/ProductsPost">Product variant</a>: Define a product variant for a configurable product. <a href="#operation/ProductsPost!path=attributes">"Attributes"</a> with <a href="#operation/ProductsPost!path=attributes/variantReferenceId&t=request">"variantReferenceId"</a> and <a href="#operation/ProductsPost!path=links&t=request">"links"</a> of type <code>VARIANT_OF</code> must be defined for product variants.</li>
</ul>
<p>Each product variant links back to the configurable product through its <code>variantReferenceId</code>, which corresponds to specific <code>configurations[].values[].variantReferenceId</code> in the configurable product.</p>
<p>To unassign a product variant from a configurable product, do one of the following:</p>
<ul>
<li>Use the <a href="#operation/ProductsDelete">Delete Product API</a> to delete the product variant.</li>
<li>Use the <a href="#operation/ProductsPatch">Update Product API</a> to set the <a href="#operation/ProductsPost!path=attributes/variantReferenceId&t=request">"variantReferenceId"</a> to <code>null</code> and unassign the product variant from the configurable product by removing the <a href="#operation/ProductsPost!path=links&t=request">"links"</a> association.</li>
</ul>
<h3>Bundle Products</h3><a =name="bundle"></a>
A bundle product combines several simple products into one sellable unit. Items within the bundle can be categorized into logical categories (groups) like`tops`, `bottoms`, and `accessories`.
Each group can have multiple items, and shoppers can select items from each group to create a customized bundle.
<p>To create a bundle product, you need the following:</p>
<ul>
<li><strong>Bundle product:</strong> Define the bundle product. <a href="#operation/ProductsPost!path=bundles&t=request"><code>Bundles</code></a> is a required field that defines the groups and items included in the bundle.</li>
<li><strong><a href="#simple">Simple products</a>:</strong> Define the simple products that are included in the bundle. Each simple product must be created separately using the create product API.
In the field <a href="#operation/ProductsPost!path=links&t=request">"links"</a>, the type <code>IN_BUNDLE</code> must be defined for simple products that belong to bundle products with reference to it.</li>
</ul>
<p><strong>Note:</strong> A simple product can be included only once in each bundle. If the same item is specified in multiple groups, the API returns a <code>Duplicate SKU found in bundle items</code> error.</p>
<p>To update a bundle product, do one of the following:</p>
<ul>
<li>Use <a href="#operation/ProductsPatch">Update Product API</a> to modify the groups and items in the bundle.</li>
<li>Use <a href="#operation/ProductsDelete">Delete Product API</a> to remove items from the bundle.</li>
</ul>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>JWT generated for Production public API key.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>JWT generated for Production public API key.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="attributes" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand attributes"><span class="property-name">attributes</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Product Attribute<!-- -->) </span></div> <div><div html="<p>A list of product attributes.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A list of product attributes.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="bundles" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand bundles"><span class="property-name">bundles</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->ProductBundle<!-- -->) </span></div> <div><div html="<p>Composite products, such as bundle products, must include a list of individual products that are part of the bundle, organized into groups (for example, &quot;shirts&quot;, &quot;pants&quot;, &quot;accessories&quot;).</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Composite products, such as bundle products, must include a list of individual products that are part of the bundle, organized into groups (for example, "shirts", "pants", "accessories").</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="configurations" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand configurations"><span class="property-name">configurations</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->ProductConfiguration<!-- -->) </span></div> <div><div html="<p>Composite products, such as configurable products, must provide a list of product options that a shopper can select (for example, &quot;color&quot;, &quot;size&quot;, etc.).</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Composite products, such as configurable products, must provide a list of product options that a shopper can select (for example, "color", "size", etc.).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">description</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>The main description for the product</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>The main description for the product</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="images" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand images"><span class="property-name">images</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Product Image<!-- -->) </span></div> <div><div html="<p>A list of product images.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A list of product images.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="links" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand links"><span class="property-name">links</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Links<!-- -->) </span></div> <div><div html="<p>A list of linked SKUs.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A list of linked SKUs.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="metaTags" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">metaTags</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">object</span></div> <div><div html="<p>Meta attributes that are specified in <meta> tags.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Meta attributes that are specified in <meta> tags.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">name</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Product name</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Product name</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="routes" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand routes"><span class="property-name">routes</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Routes<!-- -->) </span></div> <div><div html="<p>A list of product routes.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A list of product routes.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="scope" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand scope"><span class="property-name">scope</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">object</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Scope<!-- -->) </span></div> <div><div html="<p>Scope of the entity. For example it&#39;s locale &quot;English&quot;</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Scope of the entity. For example it's locale "English"</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="shortDescription" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">shortDescription</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>A short description of the product</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A short description of the product</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sku" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">sku</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>SKU (Stock Keeping Unit) is a unique identifier for a product.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>SKU (Stock Keeping Unit) is a unique identifier for a product.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="slug" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">slug</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>The URL key for the product.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>The URL key for the product.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="status" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">status</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"ENABLED"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"DISABLED"</span> </div> <div><div html="<p>Indicates whether the product is visible on the storefront.
The value is &quot;Enabled&quot; if it is visible, and &quot;Disabled&quot; if it is not visible.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Indicates whether the product is visible on the storefront.
The value is "Enabled" if it is visible, and "Disabled" if it is not visible.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="visibleIn" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">visibleIn</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">any</span></div><div><span class="sc-sediK jBpAbV">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"CATALOG"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"SEARCH"</span> </div> <div><div html="<p>Storefront area where the product is visible. An empty list means that it is not visible as a stand alone product.</p>
<ul>
<li><code>CATALOG</code>: Product is visible on Product Listing Page and Product Detail Page.</li>
<li><code>SEARCH</code>: Product is visible on Search Results Page and Product Detail Page.</li>
</ul>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Storefront area where the product is visible. An empty list means that it is not visible as a stand alone product.</p>
<ul>
<li><code>CATALOG</code>: Product is visible on Product Listing Page and Product Detail Page.</li>
<li><code>SEARCH</code>: Product is visible on Search Results Page and Product Detail Page.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items accepted and will be processed asynchronously</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items accepted and will be processed asynchronously</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>One or all received items are invalid. Check the &quot;invalidFeedItems&quot; node for details</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>One or all received items are invalid. Check the "invalidFeedItems" node for details</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">403<!-- --> </strong><div html="<p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
</div></button></div></div></div><div class="sc-jbAkgO sc-gNZgCX lcisZz libpUV"><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Request samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riipa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riipa:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riipa:0" aria-labelledby="tab:Riipa:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json</div></div><div class="sc-loYsQo exYKuj"><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Example</span><div class="sc-cYoYeT sc-fXqexe hAjcNi jkMLIl"><svg class="sc-lkbiLU hPiyTK" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="Create a simple product." selected="">Create a simple product.</option><option value="Create a configurable product with four product variants.">Create a configurable product with four product variants.</option><option value="Create a bundle product with multiple items.">Create a bundle product with multiple items.</option></select><label>Create a simple product.</label></div></div><div><div html="<p>Create a simple product with required and optional fields.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Create a simple product with required and optional fields.</p>
</div><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"sku"</span>: <span class="token string">"red-pants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"red pants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"slug"</span>: <span class="token string">"red-pants.html"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"ENABLED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"long description about red pants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"shortDescription"</span>: <span class="token string">"just pants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"visibleIn"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"CATALOG"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"SEARCH"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metaTags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"Yoga pants "</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"Climb with Zeppelin Yoga Pant"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"keywords"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"pants"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"yoga"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"cost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"NUMBER"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"values"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"10.5"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"states"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"ARRAY"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"values"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"TX"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"CA"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"images"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"</span><a href="https://example.com/images/pants.jpg">https://example.com/images/pants.jpg</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"photo of my pants!"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roles"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"BASE"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"SMALL"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"customRoles"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"widget"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"routes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"path"</span>: <span class="token string">"red-pants"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"path"</span>: <span class="token string">"pants/red-pants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"position"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Response samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjipa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjipa:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjipa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjipa:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjipa:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjipa:2" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjipa:0" aria-labelledby="tab:Rjipa:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json;charset=UTF-8</div></div><div class="sc-loYsQo exYKuj"><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ACCEPTED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"acceptedCount"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjipa:1" aria-labelledby="tab:Rjipa:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjipa:2" aria-labelledby="tab:Rjipa:2"></div></div></div></div></div></div><div id="tag/Products/operation/ProductsPatch" data-section-id="tag/Products/operation/ProductsPatch" class="sc-dycHyt gWRVHL"><div data-section-id="operation/ProductsPatch" id="operation/ProductsPatch" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Products/operation/ProductsPatch" aria-label="tag/Products/operation/ProductsPatch"></a>Update products.<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="patch" class="sc-eEFyrX jSvWYY http-verb patch">patch</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/products</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/products</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>Update products with specified &quot;sku&quot; and &quot;scope&quot; to replace existing field data with the data supplied in the request.
When the update is processed, the merge strategy is used to apply changes to <code>scalar</code> and <code>object</code> type fields.
The replace strategy is used to apply changes for fields in an <code>array</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Update products with specified "sku" and "scope" to replace existing field data with the data supplied in the request.
When the update is processed, the merge strategy is used to apply changes to <code>scalar</code> and <code>object</code> type fields.
The replace strategy is used to apply changes for fields in an <code>array</code>.</p>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>JWT generated for Production public API key.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>JWT generated for Production public API key.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="attributes" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand attributes"><span class="property-name">attributes</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Product Attribute<!-- -->) </span></div> <div><div html="<p>A list of product attributes.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A list of product attributes.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="bundles" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand bundles"><span class="property-name">bundles</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->ProductBundle<!-- -->) </span></div> <div><div html="<p>Composite products, such as bundle products, must include a list of individual products that are part of the bundle, organized into groups (for example, &quot;shirts&quot;, &quot;pants&quot;, &quot;accessories&quot;).</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Composite products, such as bundle products, must include a list of individual products that are part of the bundle, organized into groups (for example, "shirts", "pants", "accessories").</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="configurations" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand configurations"><span class="property-name">configurations</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->ProductConfiguration<!-- -->) </span></div> <div><div html="<p>Composite products, such as configurable products, must provide a list of product options that a shopper can select (for example, &quot;color&quot;, &quot;size&quot;, etc.).</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Composite products, such as configurable products, must provide a list of product options that a shopper can select (for example, "color", "size", etc.).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">description</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>The main description for the product</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>The main description for the product</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="images" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand images"><span class="property-name">images</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Product Image<!-- -->) </span></div> <div><div html="<p>A list of product images.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A list of product images.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="links" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand links"><span class="property-name">links</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Links<!-- -->) </span></div> <div><div html="<p>A list of linked SKUs. For product variants, this is a required field that establishes a link between a product variant and the corresponding configurable product.
<code>VARIANT_OF</code> link type must be specified to establish a connection to the configurable product SKU.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A list of linked SKUs. For product variants, this is a required field that establishes a link between a product variant and the corresponding configurable product.
<code>VARIANT_OF</code> link type must be specified to establish a connection to the configurable product SKU.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="metaTags" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">metaTags</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">object</span></div> <div><div html="<p>Meta attributes that are specified in <meta> tags.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Meta attributes that are specified in <meta> tags.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">name</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Product name</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Product name</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="routes" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand routes"><span class="property-name">routes</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">objects</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Routes<!-- -->) </span></div> <div><div html="<p>A list of product routes.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A list of product routes.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="scope" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand scope"><span class="property-name">scope</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">object</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Scope<!-- -->) </span></div> <div><div html="<p>Scope of the entity. For example it&#39;s locale &quot;English&quot;</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Scope of the entity. For example it's locale "English"</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="shortDescription" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">shortDescription</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>A short description of the product</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>A short description of the product</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="sku" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">sku</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>SKU (Stock Keeping Unit) is a unique identifier for a product.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>SKU (Stock Keeping Unit) is a unique identifier for a product.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="slug" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">slug</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>The URL key for the product.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>The URL key for the product.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="status" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">status</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"ENABLED"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"DISABLED"</span> </div> <div><div html="<p>Indicates whether the product is visible on the storefront.
The value is &quot;Enabled&quot; if it is visible, and &quot;Disabled&quot; if it is not visible.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Indicates whether the product is visible on the storefront.
The value is "Enabled" if it is visible, and "Disabled" if it is not visible.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="visibleIn" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">visibleIn</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj">Array of </span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">any</span></div><div><span class="sc-sediK jBpAbV">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"CATALOG"</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"SEARCH"</span> </div> <div><div html="<p>Storefront area where the product is visible. An empty list means that it is not visible as a stand alone product.</p>
<ul>
<li><code>CATALOG</code>: Product is visible on Product Listing Page and Product Detail Page.</li>
<li><code>SEARCH</code>: Product is visible on Search Results Page and Product Detail Page.</li>
</ul>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Storefront area where the product is visible. An empty list means that it is not visible as a stand alone product.</p>
<ul>
<li><code>CATALOG</code>: Product is visible on Product Listing Page and Product Detail Page.</li>
<li><code>SEARCH</code>: Product is visible on Search Results Page and Product Detail Page.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items accepted and will be processed asynchronously</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items accepted and will be processed asynchronously</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>One or all received items are invalid. Check the &quot;invalidFeedItems&quot; node for details</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>One or all received items are invalid. Check the "invalidFeedItems" node for details</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">403<!-- --> </strong><div html="<p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
</div></button></div></div></div><div class="sc-jbAkgO sc-gNZgCX lcisZz libpUV"><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Request samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij9a:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij9a:0" aria-labelledby="tab:Rij9a:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json</div></div><div class="sc-loYsQo exYKuj"><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Example</span><div class="sc-cYoYeT sc-fXqexe hAjcNi jkMLIl"><svg class="sc-lkbiLU hPiyTK" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="Update a simple product." selected="">Update a simple product.</option><option value="Unassign product variant `pants-red-32` from configurable product `pants`.">Unassign product variant `pants-red-32` from configurable product `pants`.</option><option value="Add a new item `gloves` to the accessories group of the bundle product `bundle-outfit`.">Add a new item `gloves` to the accessories group of the bundle product `bundle-outfit`.</option></select><label>Update a simple product.</label></div></div><div><div html="<p>Update a simple product with the values provided in the request.
On update, changes to <code>scalar</code> and <code>object</code> type fields are applied using the merge strategy.
The replace strategy is used to apply changes for fields in an <code>array</code>.</p>
<p>In the example below, the following attributes are updated.</p>
<ul>
<li><code>name</code> - Change the product name.</li>
<li><code>metaTags.title</code> - Change the title of the product detail page.</li>
<li><code>attributes</code> - Add a new state, <code>NM</code> to the <code>states</code> attribute.</li>
</ul>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Update a simple product with the values provided in the request.
On update, changes to <code>scalar</code> and <code>object</code> type fields are applied using the merge strategy.
The replace strategy is used to apply changes for fields in an <code>array</code>.</p>
<p>In the example below, the following attributes are updated.</p>
<ul>
<li><code>name</code> - Change the product name.</li>
<li><code>metaTags.title</code> - Change the title of the product detail page.</li>
<li><code>attributes</code> - Add a new state, <code>NM</code> to the <code>states</code> attribute.</li>
</ul>
</div><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"sku"</span>: <span class="token string">"red-pants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Red pants - discounts!"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"metaTags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"Updated - Red"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"attributes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"cost"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"NUMBER"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"values"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"10.5"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token string">"states"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"ARRAY"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"values"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"TX"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"CA"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"NM"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Response samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj9a:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjj9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj9a:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjj9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj9a:2" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj9a:0" aria-labelledby="tab:Rjj9a:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json;charset=UTF-8</div></div><div class="sc-loYsQo exYKuj"><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ACCEPTED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"acceptedCount"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj9a:1" aria-labelledby="tab:Rjj9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj9a:2" aria-labelledby="tab:Rjj9a:2"></div></div></div></div></div></div><div id="tag/Products/operation/ProductsDelete" data-section-id="tag/Products/operation/ProductsDelete" class="sc-dycHyt gWRVHL"><div data-section-id="operation/ProductsDelete" id="operation/ProductsDelete" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Products/operation/ProductsDelete" aria-label="tag/Products/operation/ProductsDelete"></a>Delete products.<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="post" class="sc-eEFyrX ejTpka http-verb post">post</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/products/delete</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/products/delete</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>Delete products with specified &quot;sku&quot; and &quot;scope&quot;.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Delete products with specified "sku" and "scope".</p>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>JWT generated for Production public API key.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>JWT generated for Production public API key.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="scope" class="sc-kXOizl sc-dPKAra sc-hhvUTr eztgDe kNyONh dSXgsG"><span class="sc-gjXmFk iXqMpQ"></span><button aria-label="expand scope"><span class="property-name">scope</span><svg class="sc-cSaEAk hBbXPQ" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">object</span><span class="sc-sediK sc-gIivzS jBpAbV eUvFgO"> (<!-- -->Scope<!-- -->) </span></div> <div><div html="<p>Scope of the entity. For example it&#39;s locale &quot;English&quot;</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Scope of the entity. For example it's locale "English"</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="sku" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">sku</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Product unique identifier</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Product unique identifier</p>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items accepted and will be processed asynchronously</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items accepted and will be processed asynchronously</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>One or all received items are invalid. Check the &quot;invalidFeedItems&quot; node for details</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>One or all received items are invalid. Check the "invalidFeedItems" node for details</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">403<!-- --> </strong><div html="<p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
</div></button></div></div></div><div class="sc-jbAkgO sc-gNZgCX lcisZz libpUV"><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Request samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijpa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijpa:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijpa:0" aria-labelledby="tab:Rijpa:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json</div></div><div class="sc-loYsQo exYKuj"><div html="<p>Delete a simple product with a specified <code>sku</code> and <code>scope</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Delete a simple product with a specified <code>sku</code> and <code>scope</code>.</p>
</div><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"sku"</span>: <span class="token string">"red-pants"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scope"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"locale"</span>: <span class="token string">"en"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Response samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjpa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjpa:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjjpa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjjpa:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjjpa:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjjpa:2" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjpa:0" aria-labelledby="tab:Rjjpa:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json;charset=UTF-8</div></div><div class="sc-loYsQo exYKuj"><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ACCEPTED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"acceptedCount"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjjpa:1" aria-labelledby="tab:Rjjpa:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjjpa:2" aria-labelledby="tab:Rjjpa:2"></div></div></div></div></div></div><div id="tag/Price-Books" data-section-id="tag/Price-Books" class="sc-dycHyt ijZyAc"><div class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Price-Books" aria-label="tag/Price-Books"></a>Price Books</h2></div></div><div class="sc-fLDLck Petks"><div class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs redoc-markdown " html="<p>Define pricing scopes to manage product prices across different customer tiers and markets. Each price book can have its own currency and discount rules.</p>
<p>The catalog data model provides a default price book with id <code>main</code> and currency in US dollars (<code>USD</code>).</p>
"><p>Define pricing scopes to manage product prices across different customer tiers and markets. Each price book can have its own currency and discount rules.</p>
<p>The catalog data model provides a default price book with id <code>main</code> and currency in US dollars (<code>USD</code>).</p>
</div></div></div><div id="tag/Price-Books/operation/PriceBooksPut" data-section-id="tag/Price-Books/operation/PriceBooksPut" class="sc-dycHyt gWRVHL"><div data-section-id="operation/PriceBooksPut" id="operation/PriceBooksPut" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Price-Books/operation/PriceBooksPut" aria-label="tag/Price-Books/operation/PriceBooksPut"></a>Create price books.<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="post" class="sc-eEFyrX ejTpka http-verb post">post</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/price-books</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/price-books</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>Create or replace existing price books.</p>
<p>Use the update operation to modify values for existing price books.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Create or replace existing price books.</p>
<p>Use the update operation to modify values for existing price books.</p>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Client ID generated for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Client ID generated for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="currency" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">currency</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span><span> <span class="sc-sediK sc-fcddXt jBpAbV gzplQl"> <!-- -->[ 1 .. 5 ] characters<!-- --> </span></span></div> <div><div html="<p>Price book currency</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book currency</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">name</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Price book name</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book name</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="priceBookId" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">priceBookId</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Price book id</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book id</p>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items in the request are accepted for further processing.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items in the request are accepted for further processing.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>Request rejected. Some of the received items are invalid. Check the &quot;invalidFeedItems&quot; node for specific errors.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Request rejected. Some of the received items are invalid. Check the "invalidFeedItems" node for specific errors.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">403<!-- --> </strong><div html="<p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
</div></button></div></div></div><div class="sc-jbAkgO sc-gNZgCX lcisZz libpUV"><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Request samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riipq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riipq:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riipq:0" aria-labelledby="tab:Riipq:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json</div></div><div class="sc-loYsQo exYKuj"><div html="<p>Create a price book and specify the currency for prices.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Create a price book and specify the currency for prices.</p>
</div><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"priceBookId"</span>: <span class="token string">"dealer-north"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"Dealer North price book name"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"currency"</span>: <span class="token string">"USD"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"priceBookId"</span>: <span class="token string">"VIP"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"currency"</span>: <span class="token string">"USD"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Response samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjipq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjipq:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjipq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjipq:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjipq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjipq:2" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjipq:0" aria-labelledby="tab:Rjipq:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json;charset=UTF-8</div></div><div class="sc-loYsQo exYKuj"><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ACCEPTED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"acceptedCount"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjipq:1" aria-labelledby="tab:Rjipq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjipq:2" aria-labelledby="tab:Rjipq:2"></div></div></div></div></div></div><div id="tag/Price-Books/operation/PriceBooksPatch" data-section-id="tag/Price-Books/operation/PriceBooksPatch" class="sc-dycHyt gWRVHL"><div data-section-id="operation/PriceBooksPatch" id="operation/PriceBooksPatch" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Price-Books/operation/PriceBooksPatch" aria-label="tag/Price-Books/operation/PriceBooksPatch"></a>Update price books.<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="patch" class="sc-eEFyrX jSvWYY http-verb patch">patch</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/price-books</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/price-books</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>Update existing price books to change the name or the currency used for pricing.
When the update is processed, the merge strategy is used to apply changes to <code>scalar</code>
and <code>object</code> type fields. The replace strategy is used to apply changes for fields in an <code>array</code>.</p>
<p>To update the currency for the default price book, use the price book id <code>main</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Update existing price books to change the name or the currency used for pricing.
When the update is processed, the merge strategy is used to apply changes to <code>scalar</code>
and <code>object</code> type fields. The replace strategy is used to apply changes for fields in an <code>array</code>.</p>
<p>To update the currency for the default price book, use the price book id <code>main</code>.</p>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Client ID generated for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Client ID generated for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="currency" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">currency</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span><span> <span class="sc-sediK sc-fcddXt jBpAbV gzplQl"> <!-- -->[ 1 .. 5 ] characters<!-- --> </span></span></div> <div><div html="<p>Price book currency</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book currency</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">name</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Price book name</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book name</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="priceBookId" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">priceBookId</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Price book id</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book id</p>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items in the request are accepted for further processing.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items in the request are accepted for further processing.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>Request rejected. Some of the received items are invalid. Check the <code>invalidFeedItems</code> node for specific errors.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Request rejected. Some of the received items are invalid. Check the <code>invalidFeedItems</code> node for specific errors.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">403<!-- --> </strong><div html="<p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>Unauthorized request. Verify the <code>x-api-key</code> and make sure that the bearer access token in <code>Authorization</code> is still valid.</p>
</div></button></div></div></div><div class="sc-jbAkgO sc-gNZgCX lcisZz libpUV"><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Request samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij9q:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij9q:0" aria-labelledby="tab:Rij9q:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json</div></div><div class="sc-loYsQo exYKuj"><div html="<p>Update the &quot;dealer-north&quot; and default &quot;main&quot; price books to change the currency.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Update the "dealer-north" and default "main" price books to change the currency.</p>
</div><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"priceBookId"</span>: <span class="token string">"dealer-north"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"currency"</span>: <span class="token string">"EUR"</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"priceBookId"</span>: <span class="token string">"main"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"currency"</span>: <span class="token string">"EUR"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-jUkaYT joSISv"> <!-- -->Response samples<!-- --> </h3><div class="sc-bCjwNj cnTfwV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj9q:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjj9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj9q:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjj9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj9q:2" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj9q:0" aria-labelledby="tab:Rjj9q:0"><div><div class="sc-bxmmIP OIIYS"><span class="sc-fEOKFM dpRqHD">Content type</span><div class="sc-beKSRx hmEMDU">application/json;charset=UTF-8</div></div><div class="sc-loYsQo exYKuj"><div class="sc-eOrxMY jmgBLa"><div class="sc-lertIE hzLBDF"><button><div class="sc-fCSSOr kPewJt">Copy</div></button></div><div class="sc-dJkDXt eOvdyU sc-gtlvkJ fAqzdc"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"ACCEPTED"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"acceptedCount"</span>: <span class="token number">4</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj9q:1" aria-labelledby="tab:Rjj9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj9q:2" aria-labelledby="tab:Rjj9q:2"></div></div></div></div></div></div><div id="tag/Price-Books/operation/PriceBooksDelete" data-section-id="tag/Price-Books/operation/PriceBooksDelete" class="sc-dycHyt gWRVHL"><div data-section-id="operation/PriceBooksDelete" id="operation/PriceBooksDelete" class="sc-kfeOyU eTCvZl"><div class="sc-fLDLck cCTQFs"><h2 class="sc-jBIHhB ONRDj"><a class="sc-jHswkR ccWJGj" href="#tag/Price-Books/operation/PriceBooksDelete" aria-label="tag/Price-Books/operation/PriceBooksDelete"></a>Delete price books.<!-- --> </h2><div class="sc-dNMyuw jSOGEJ"><button class="sc-iNzRy botQvK"><span type="post" class="sc-eEFyrX ejTpka http-verb post">post</span><span class="sc-ijEwUV iRWLqc">/v1/catalog/price-books/delete</span><svg class="sc-cSaEAk VzMTm" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dHpROs jElwoi"><div class="sc-idhQoR fLVjhV"><div html="<p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Sandbox endpoint. The <code>tenantId</code> is your Adobe Experience Cloud tenant ID. It is a subdomain of your Experience
Cloud URL. For example, if your Experience Cloud URL is <a href="https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html">https://experience.adobe.com/#/@my-cloud-instance/cloud-manager/landing.html</a> or
<code>mycloudinstance</code>.marketing.adobe.com, the tenant ID is <code>mycloudinstance</code>.</p>
</div><div tabindex="0" role="button"><div class="sc-cqTlu cpBCZw"><span>/%3CtenantId%3E</span>/v1/catalog/price-books/delete</div></div></div></div></div><div class="sc-bACthX gzhca"><div html="<p>Delete existing price books.
Note that you cannot delete the default price book with id <code>main</code>.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"><p>Delete existing price books.
Note that you cannot delete the default price book with id <code>main</code>.</p>
</div></div><div><h5 class="sc-deSjom dunSEZ">header<!-- --> Parameters</h5><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="Authorization" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Authorization</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>OAUTH 2.0 access token generated from the Client ID and Client Secret for the
API integration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Encoding" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Encoding</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"gzip"</span> </div> <div><div html="<p>Use this header if the payload is compressed with gzip.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Use this header if the payload is compressed with gzip.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="Content-Type" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">Content-Type</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div><div><span class="sc-sediK jBpAbV"> <!-- -->Value<!-- -->:</span> <span class="sc-sediK sc-cHQrJj jBpAbV cPTpOn">"application/json"</span> </div> <div><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"></div></div></div></td></tr><tr class="last "><td kind="field" title="x-api-key" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">x-api-key</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Client ID generated for the API integration.</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Client ID generated for the API integration.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-deSjom dunSEZ">Request Body schema: <span class="sc-dslWvo lcGauM">application/json</span></h5><div html="" class="sc-dJkDXt sc-eXfTSZ eOvdyU iFgJCs"></div><div><div class="sc-flQbIK cBxiIC"> Array </div><div class="sc-gkCgsS jhBGuD"><table class="sc-dVupuq fEMWVS"><tbody><tr class=""><td kind="field" title="currency" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">currency</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span><span> <span class="sc-sediK sc-fcddXt jBpAbV gzplQl"> <!-- -->[ 1 .. 5 ] characters<!-- --> </span></span></div> <div><div html="<p>Price book currency</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book currency</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">name</span></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Price book name</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book name</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="priceBookId" class="sc-kXOizl sc-dPKAra eztgDe kNyONh"><span class="sc-gjXmFk iXqMpQ"></span><span class="property-name">priceBookId</span><div class="sc-sediK sc-incsXD jBpAbV kpBMZY">required</div></td><td class="sc-fuExOL eidGeB"><div><div><span class="sc-sediK sc-cAQujh jBpAbV hELCbj"></span><span class="sc-sediK sc-haUlXw jBpAbV bCDwpq">string</span></div> <div><div html="<p>Price book id</p>
" class="sc-dJkDXt sc-eXfTSZ eOvdyU fHLtmm"><p>Price book id</p>
</div></div></div></td></tr></tbody></table></div><div class="sc-gQJZgv jaRGIg"></div></div><div><h3 class="sc-frtHmg eXjWTp">Responses</h3><div><button class="sc-kdWPFt gpjYYu"><svg class="sc-cSaEAk gGbHCS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">200<!-- --> </strong><div html="<p>All items in the request are accepted for further processing.</p>
" class="sc-dJkDXt sc-eXfTSZ sc-dXYVqG eOvdyU jcthWC iWCNbi"><p>All items in the request are accepted for further processing.</p>
</div></button></div><div><button class="sc-kdWPFt DmZc"><svg class="sc-cSaEAk kpohcO" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dxpuJR bniiic">400<!-- --> </strong><div html="<p>Request rejected. Some of the received items are invalid. Check the &quot;invalidFeedItems&quot; node for specific errors.</p>