forked from Ehaic/EbaySellInventory
/
sell_inventory_v1_oas3.yaml
5313 lines (5313 loc) · 466 KB
/
sell_inventory_v1_oas3.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Inventory API
description: The Inventory API is used to create and manage inventory, and then to publish and manage this inventory on an eBay marketplace. There are also methods in this API that will convert eligible, active eBay listings into the Inventory API model.
contact:
name: eBay Inc,
license:
name: eBay API License Agreement
url: https://go.developer.ebay.com/api-license-agreement
version: 1.17.2
servers:
- url: https://api.ebay.com{basePath}
description: Production
variables:
basePath:
default: /sell/inventory/v1
paths:
/bulk_create_or_replace_inventory_item:
post:
tags:
- inventory_item
description: '<span class="tablenote"><strong>Note:</strong> Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.</span><br><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br>This call can be used to create and/or update up to 25 new inventory item records. It is up to sellers whether they want to create a complete inventory item records right from the start, or sellers can provide only some information with the initial <strong>bulkCreateOrReplaceInventoryItem</strong> call, and then make one or more additional <strong>bulkCreateOrReplaceInventoryItem</strong> calls to complete all required fields for the inventory item records and prepare for publishing. Upon first creating inventory item records, only the SKU values are required.<br><br><span class="tablenote"><b>Note:</b> In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, this call also requires the <code>Content-Language</code> and <code>Content-Type</code> headers. See the <a href="/api-docs/sell/inventory/resources/inventory_item/methods/bulkCreateOrReplaceInventoryItem#h3-request-headers">HTTP request headers</a> section for more information.</span><br> In the case of updating existing inventory item records, the <strong>bulkCreateOrReplaceInventoryItem</strong> call will do a complete replacement of the existing inventory item records, so all fields that are currently defined for the inventory item record are required in that update action, regardless of whether their values changed. So, when replacing/updating an inventory item record, it is advised that the seller run a ''Get'' call to retrieve the full details of the inventory item records and see all of its current values/settings before attempting to update the records. Any changes that are made to inventory item records that are part of one or more active eBay listings, a successful call will automatically update these active listings. <br><br> The key information that is set with the <strong>bulkCreateOrReplaceInventoryItem</strong> call include: <ul> <li>Seller-defined SKU value for the product. Each seller product, including products within an item inventory group, must have their own SKU value. </li> <li>Condition of the item</li> <li>Product details, including any product identifier(s), such as a UPC, ISBN, EAN, or Brand/Manufacturer Part Number pair, a product description, a product title, product/item aspects, and links to images. eBay will use any supplied eBay Product ID (ePID) or a GTIN (UPC, ISBN, or EAN) and attempt to match those identifiers to a product in the eBay Catalog, and if a product match is found, the product details for the inventory item will automatically be populated.</li> <li>Quantity of the inventory item that is available for purchase</li> <li>Package weight and dimensions, which is required if the seller will be offering calculated shipping options. The package weight will also be required if the seller will be providing flat-rate shipping services, but charging a weight surcharge.</li> </ul><p>For those who prefer to create or update a single inventory item record, the <strong>createOrReplaceInventoryItem</strong> method can be used.</p>'
operationId: bulkCreateOrReplaceInventoryItem
parameters:
- name: Content-Type
in: header
description: This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
- name: Content-Language
in: header
description: This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be <code>en-US</code> for English or <code>de-DE</code> for German. For more information on the Content-Language header, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
requestBody:
description: Details of the inventories with sku and locale
content:
application/json:
schema:
description: Details of the inventories with sku and locale
$ref: '#/components/schemas/BulkInventoryItem'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInventoryItemResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing options removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25504':
domain: API_INVENTORY
category: APPLICATION
description: '{additionalInfo}'
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: Any User error. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: Invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: Invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: Invalid category. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: Invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: Invalid Shipping policy information. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: Invalid Payment policy information. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: Invalid Return policy information. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: Invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid InventoryItemGroup information. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: Invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: Invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: Invalid {fieldName}. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: Missing field {fieldName}. {additionalInfo}
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: Invalid package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: Invalid condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limits exceeded. {additionalInfo}
'25501':
domain: API_INVENTORY
category: REQUEST
description: Invalid picture. {additionalInfo}
'25502':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute information. {additionalInfo}
'25503':
domain: API_INVENTORY
category: REQUEST
description: Invalid product information. {additionalInfo}
'25601':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25604':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25701':
domain: API_INVENTORY
category: REQUEST
description: These SKU(s) are not in the system
'25702':
domain: API_INVENTORY
category: REQUEST
description: SKU {additionalInfo} is not available in the system
'25707':
domain: API_INVENTORY
category: REQUEST
description: Invalid sku. sku has to be alphanumeric with upto 50 characters in length
'25708':
domain: API_INVENTORY
category: REQUEST
description: Invalid sku
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid request. Invalid value for field {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'25715':
domain: API_INVENTORY
category: REQUEST
description: Invalid Dimension and Weight
'25727':
domain: API_INVENTORY
category: REQUEST
description: The number of InventoryItems in the request cannot exceed {additionalInfo}.
'25728':
domain: API_INVENTORY
category: REQUEST
description: InventoryItems should be unique in the request.
'25733':
domain: API_INVENTORY
category: REQUEST
description: Valid SKU and locale information are required for all the InventoryItems in the request.
'25759':
domain: API_INVENTORY
category: REQUEST
description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of Inventory or InventoryItemGroup. Please try again later
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/bulk_get_inventory_item:
post:
tags:
- inventory_item
description: This call retrieves up to 25 inventory item records. The SKU value of each inventory item record to retrieve is specified in the request payload.<br><br><span class="tablenote"><b>Note:</b> In addition to the <code>authorization</code> header, which is required for all Inventory API calls, this call also requires the <code>Content-Type</code> header. See the <a href="/api-docs/sell/inventory/resources/inventory_item/methods/bulkGetInventoryItem#h3-request-headers">HTTP request headers</a> for more information.</span><br>For those who prefer to retrieve only one inventory item record by SKU value, the <strong>getInventoryItem</strong> method can be used. To retrieve all inventory item records defined on the seller's account, the <strong>getInventoryItems</strong> method can be used (with pagination control if desired).
operationId: bulkGetInventoryItem
parameters:
- name: Content-Type
in: header
description: This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
requestBody:
description: Details of the inventories with sku and locale
content:
application/json:
schema:
description: Details of the inventories with sku and locale
$ref: '#/components/schemas/BulkGetInventoryItem'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkGetInventoryItemResponse'
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: SKU {additionalInfo} is not available in the system
'25708':
domain: API_INVENTORY
category: REQUEST
description: Invalid SKU.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid request. Invalid value for field {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'25727':
domain: API_INVENTORY
category: REQUEST
description: The number of InventoryItems in the request cannot exceed {additionalInfo}.
'25734':
domain: API_INVENTORY
category: REQUEST
description: SKU should be unique in the request.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: Any System error. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
/bulk_update_price_quantity:
post:
tags:
- inventory_item
description: This call is used by the seller to update the total ship-to-home quantity of one inventory item, and/or to update the price and/or quantity of one or more offers associated with one inventory item. Up to 25 offers associated with an inventory item may be updated with one <strong>bulkUpdatePriceQuantity</strong> call. Only one SKU (one product) can be updated per call.<br><br><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br><span class="tablenote"><b>Note:</b> In addition to the <code>authorization</code> header, which is required for all Inventory API calls, this call also requires the <code>Content-Type</code> header. See the <a href="/api-docs/sell/inventory/resources/inventory_item/methods/bulkUpdatePriceQuantity#h3-request-headers">HTTP request headers</a> for more information.</span><br>The <strong>getOffers</strong> call can be used to retrieve all offers associated with a SKU. The seller will just pass in the correct SKU value through the <strong>sku</strong> query parameter. To update an offer, the <strong>offerId</strong> value is required, and this value is returned in the <strong>getOffers</strong> call response. It is also useful to know which offers are unpublished and which ones are published. To get this status, look for the <strong>status</strong> value in the <strong>getOffers</strong> call response. Offers in the published state are live eBay listings, and these listings will be revised with a successful <strong>bulkUpdatePriceQuantity</strong> call.<br><br>An issue will occur if duplicate <strong>offerId</strong> values are passed through the same <strong>offers</strong> container, or if one or more of the specified offers are associated with different products/SKUs.<br><br><span class="tablenote"><strong>Note:</strong> For multiple-variation listings, it is recommended that the <strong>bulkUpdatePriceQuantity</strong> call be used to update price and quantity information for each SKU within that multiple-variation listing instead of using <strong>createOrReplaceInventoryItem</strong> calls to update the price and quantity for each SKU. Just remember that only one SKU (one product variation) can be updated per call.</span></p>
operationId: bulkUpdatePriceQuantity
parameters:
- name: Content-Type
in: header
description: This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
requestBody:
description: Price and allocation details for the given SKU and Marketplace
content:
application/json:
schema:
description: Price and allocation details for the given SKU and Marketplace
$ref: '#/components/schemas/BulkPriceQuantity'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPriceQuantityResponse'
'207':
description: Multi-Status
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: Any User error. {additionalInfo}
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25759':
domain: API_INVENTORY
category: REQUEST
description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/inventory_item/{sku}:
get:
tags:
- inventory_item
description: This call retrieves the inventory item record for a given SKU. The SKU value is passed in at the end of the call URI. There is no request payload for this call.<br><br>The <code>authorization</code> header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the <strong>HTTP request headers</strong> section for more information.<br><br>For those who prefer to retrieve numerous inventory item records by SKU value with one call (up to 25 at a time), the <strong>bulkGetInventoryItem</strong> method can be used. To retrieve all inventory item records defined on the seller's account, the <strong>getInventoryItems</strong> method can be used (with pagination control if desired).
operationId: getInventoryItem
parameters:
- name: sku
in: path
description: 'This is the seller-defined SKU value of the product whose inventory item record you wish to retrieve.<br><br><strong>Max length</strong>: 50.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItemWithSkuLocaleGroupid'
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
put:
tags:
- inventory_item
description: '<span class="tablenote"><strong>Note:</strong> Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls.</span><br><span class="tablenote"><strong>Note:</strong> Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.</span><br>This call creates a new inventory item record or replaces an existing inventory item record. It is up to sellers whether they want to create a complete inventory item record right from the start, or sellers can provide only some information with the initial <strong>createOrReplaceInventoryItem</strong> call, and then make one or more additional <strong>createOrReplaceInventoryItem</strong> calls to complete all required fields for the inventory item record and prepare it for publishing. Upon first creating an inventory item record, only the SKU value in the call path is required.<br><br><span class="tablenote"><b>Note:</b> In addition to the <code>authorization</code> header, which is required for all Inventory API calls, this call also requires the <code>Content-Type</code> and <code>Content-Language</code> headers. See the <a href="/api-docs/sell/inventory/resources/inventory_item/methods/createOrReplaceInventoryItem#h3-request-headers">HTTP request headers</a> for more information.</span><br> In the case of replacing an existing inventory item record, the <strong>createOrReplaceInventoryItem</strong> call will do a complete replacement of the existing inventory item record, so all fields that are currently defined for the inventory item record are required in that update action, regardless of whether their values changed. So, when replacing/updating an inventory item record, it is advised that the seller run a <strong>getInventoryItem</strong> call to retrieve the full inventory item record and see all of its current values/settings before attempting to update the record. And if changes are made to an inventory item that is part of one or more active eBay listings, a successful call will automatically update these eBay listings. <br><br> The key information that is set with the <strong>createOrReplaceInventoryItem</strong> call include: <ul> <li>Seller-defined SKU value for the product. Each seller product, including products within an item inventory group, must have their own SKU value. This SKU value is passed in at the end of the call URI</li> <li>Condition of the item</li> <li>Product details, including any product identifier(s), such as a UPC, ISBN, EAN, or Brand/Manufacturer Part Number pair, a product description, a product title, product/item aspects, and links to images. eBay will use any supplied eBay Product ID (ePID) or a GTIN (UPC, ISBN, or EAN) and attempt to match those identifiers to a product in the eBay Catalog, and if a product match is found, the product details for the inventory item will automatically be populated.</li> <li>Quantity of the inventory item that is available for purchase</li> <li>Package weight and dimensions, which is required if the seller will be offering calculated shipping options. The package weight will also be required if the seller will be providing flat-rate shipping services, but charging a weight surcharge.</li> </ul> <p>In addition to the <code>authorization</code> header, which is required for all eBay REST API calls, the <strong>createOrReplaceInventoryItem</strong> call also requires the <code>Content-Language</code> header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be <code>en-US</code>. To view other supported <code>Content-Language</code> values, and to read more about all supported HTTP headers for eBay REST API calls, see the <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank">HTTP request headers</a> topic in the <strong>Using eBay RESTful APIs</strong> document.</p><p>For those who prefer to create or update numerous inventory item records with one call (up to 25 at a time), the <strong>bulkCreateOrReplaceInventoryItem</strong> method can be used.</p>'
operationId: createOrReplaceInventoryItem
parameters:
- name: Content-Language
in: header
description: This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be <code>en-US</code> for English or <code>de-DE</code> for German. For more information on the Content-Language header, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
- name: sku
in: path
description: 'The seller-defined SKU value for the inventory item is required whether the seller is creating a new inventory item, or updating an existing inventory item. This SKU value is passed in at the end of the call URI. SKU values must be unique across the seller''s inventory. <br><br> <strong>Max length</strong>: 50.'
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
requestBody:
description: Details of the inventory item record.
content:
application/json:
schema:
description: Details of the inventory item record.
$ref: '#/components/schemas/InventoryItem'
required: true
responses:
'200':
description: Success
headers:
Content-Language:
schema:
type: string
description: This header controls the language that is used for any returned errors or warnings in the call response.
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25504':
domain: API_INVENTORY
category: APPLICATION
description: "service\t{additionalInfo}"
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'201':
description: Created
headers:
Content-Language:
schema:
type: string
description: This header controls the language that is used for any returned errors or warnings in the call response.
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'25504':
domain: API_INVENTORY
category: APPLICATION
description: "service\t{additionalInfo}"
'25753':
domain: API_INVENTORY
category: REQUEST
description: listingStartDate is in the past or the offer is live. Value is not updated on the listing.
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: A user error has occurred. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid inventory location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid data in the Inventory Item Group. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: The {fieldName} value is invalid. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is missing. {additionalInfo}'
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limit exceeded. {additionalInfo}
'25501':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture. {additionalInfo}
'25502':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute information. {additionalInfo}
'25503':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid product information. {additionalInfo}
'25601':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is an invalid attribute. '
'25604':
domain: API_INVENTORY
category: REQUEST
description: Input error. {additionalInfo}
'25701':
domain: API_INVENTORY
category: REQUEST
description: One or more of the supplied SKU(s) could not be found in the system.
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25707':
domain: API_INVENTORY
category: REQUEST
description: This is an invalid value for a SKU. Only alphanumeric characters can be used for SKUs, and their length must not exceed 50 characters.
'25708':
domain: API_INVENTORY
category: REQUEST
description: Invalid SKU.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request.
'25713':
domain: API_INVENTORY
category: REQUEST
description: 'This Offer is not available : {additionalInfo}.'
'25715':
domain: API_INVENTORY
category: REQUEST
description: Invalid values for dimensions and/or weight of shipping package.
'25759':
domain: API_INVENTORY
category: REQUEST
description: shipToLocationAvailability quantity value should be greater than or equal to auction allocation. Please provide valid quantity or unpublish auction offers of the sku.
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
'25025':
domain: API_INVENTORY
category: APPLICATION
description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later.
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
delete:
tags:
- inventory_item
description: This call is used to delete an inventory item record associated with a specified SKU. A successful call will not only delete that inventory item record, but will also have the following effects:<ul><li>Delete any and all unpublished offers associated with that SKU;</li><li>Delete any and all single-variation eBay listings associated with that SKU;</li><li>Automatically remove that SKU from a multiple-variation listing and remove that SKU from any and all inventory item groups in which that SKU was a member.</li></ul><p>The <code>authorization</code> header is the only required HTTP header for this call. See the <strong>HTTP request headers</strong> section for more information.</p>
operationId: deleteInventoryItem
parameters:
- name: sku
in: path
description: 'This is the seller-defined SKU value of the product whose inventory item record you wish to delete.<br><br><strong>Max length</strong>: 50.'
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory
/inventory_item:
get:
tags:
- inventory_item
description: This call retrieves all inventory item records defined for the seller's account. The <strong>limit</strong> query parameter allows the seller to control how many records are returned per page, and the <strong>offset</strong> query parameter is used to retrieve a specific page of records. The seller can make multiple calls to scan through multiple pages of records. There is no request payload for this call.<br><br>The <code>authorization</code> header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the <strong>HTTP request headers</strong> section for more information.<br><br>For those who prefer to retrieve numerous inventory item records by SKU value with one call (up to 25 at a time), the <strong>bulkGetInventoryItem</strong> method can be used.
operationId: getInventoryItems
parameters:
- name: limit
in: query
description: 'The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be an integer from <code>1</code> to <code>100</code>. If this query parameter is not set, up to 100 records will be returned on each page of results.<br><br><strong>Min</strong>: 1, <strong>Max</strong>: 100 '
required: false
schema:
type: string
- name: offset
in: query
description: 'The value passed in this query parameter sets the page number to retrieve. The first page of records has a value of <code>0</code>, the second page of records has a value of <code>1</code>, and so on. If this query parameter is not set, its value defaults to <code>0</code>, and the first page of records is returned. '
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryItems'
'400':
description: Bad Request
x-response-codes:
errors:
'25706':
domain: API_INVENTORY
category: REQUEST
description: You have provided invalid pagination values. {additionalInfo}.
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}.
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
/inventory_item/{sku}/product_compatibility:
get:
tags:
- product_compatibility
description: This call is used by the seller to retrieve the list of products that are compatible with the inventory item. The SKU value for the inventory item is passed into the call URI, and a successful call with return the compatible vehicle list associated with this inventory item. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.
operationId: getProductCompatibility
parameters:
- name: sku
in: path
description: A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Compatibility'
'400':
description: Bad Request
x-response-codes:
errors:
'25702':
domain: API_INVENTORY
category: REQUEST
description: '{skuValue} could not be found or is not available in the system.'
'25709':
domain: API_INVENTORY
category: REQUEST
description: Invalid value for {fieldName}. {additionalInfo}
'25710':
domain: API_INVENTORY
category: REQUEST
description: We didn't find the resource/entity you are requesting. Please verify the request
'404':
description: Not Found
'500':
description: Internal Server Error
x-response-codes:
errors:
'25001':
domain: API_INVENTORY
category: APPLICATION
description: A system error has occurred. {additionalInfo}
security:
- api_auth:
- https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
- https://api.ebay.com/oauth/api_scope/sell.inventory
put:
tags:
- product_compatibility
description: This call is used by the seller to create or replace a list of products that are compatible with the inventory item. The inventory item is identified with a SKU value in the URI. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.<br><br><span class="tablenote"><b>Note:</b> In addition to the <code>authorization</code> header, which is required for all Inventory API calls, this call also requires the <code>Content-Type</code> and <code>Content-Language</code> headers. See the <a href="/api-docs/sell/inventory/resources/inventory_item/product_compatibility/methods/createOrReplaceProductCompatibility#h3-request-headers">HTTP request headers</a> for more information.</span>
operationId: createOrReplaceProductCompatibility
parameters:
- name: Content-Language
in: header
description: This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be <code>en-US</code> for English or <code>de-DE</code> for German. For more information on the Content-Language header, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
- name: sku
in: path
description: A SKU (stock keeping unit) is an unique identifier defined by a seller for a product
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header indicates the format of the request body provided by the client. Its value should be set to <b>application/json</b>. <br><br> For more information, refer to <a href="/api-docs/static/rest-request-components.html#HTTP" target="_blank ">HTTP request headers</a>.
required: true
schema:
type: string
requestBody:
description: Details of the compatibility
content:
application/json:
schema:
description: Details of the compatibility
$ref: '#/components/schemas/Compatibility'
required: true
responses:
'200':
description: Success
headers:
Content-Language:
schema:
type: string
description: This response header sets the natural language that will be provided in the field values of the response payload.
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'201':
description: Created
headers:
Content-Language:
schema:
type: string
description: This response header sets the natural language that will be provided in the field values of the response payload.
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
x-response-codes:
errors:
'25401':
domain: API_INVENTORY
category: APPLICATION
description: Invalid listing format removed. {additionalInfo}
'25402':
domain: API_INVENTORY
category: APPLICATION
description: System warning. {additionalInfo}
'204':
description: No Content
'400':
description: Bad Request
x-response-codes:
errors:
'25002':
domain: API_INVENTORY
category: REQUEST
description: A user error has occurred. {additionalInfo}
'25003':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
'25004':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
'25005':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
'25006':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
'25007':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
'25008':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
'25009':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
'25011':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo}
'25012':
domain: API_INVENTORY
category: REQUEST
description: Invalid inventory location. {additionalInfo}
'25013':
domain: API_INVENTORY
category: REQUEST
description: Invalid data in the Inventory Item Group. {additionalInfo}
'25014':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
'25015':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
'25016':
domain: API_INVENTORY
category: REQUEST
description: The {fieldName} value is invalid. {additionalInfo}
'25017':
domain: API_INVENTORY
category: REQUEST
description: '{fieldName} is missing. {additionalInfo}'
'25018':
domain: API_INVENTORY
category: REQUEST
description: Incomplete account information. {additionalInfo}
'25019':
domain: API_INVENTORY
category: REQUEST
description: Cannot revise listing. {additionalInfo}
'25020':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
'25021':
domain: API_INVENTORY
category: REQUEST
description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
'25022':
domain: API_INVENTORY
category: REQUEST
description: Invalid attribute. {fieldName}
'25023':
domain: API_INVENTORY
category: REQUEST
description: Invalid compatibility information. {additionalInfo}
'25026':
domain: API_INVENTORY
category: REQUEST
description: Selling limit exceeded. {additionalInfo}
'25702':
domain: API_INVENTORY