forked from Leadz04/ecommerce-store
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathetsy_openapi.json
More file actions
15611 lines (15611 loc) · 835 KB
/
etsy_openapi.json
File metadata and controls
15611 lines (15611 loc) · 835 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
{
"openapi": "3.0.2",
"info": {
"title": "Etsy Open API v3",
"description": "<div class=\"wt-text-body-01\"><p class=\"wt-pt-xs-2 wt-pb-xs-2\">Etsy's Open API provides a simple RESTful interface for various Etsy.com features.</p><p class=\"wt-pb-xs-2\">If you'd like to report an issue or provide feedback on the API design, <a target=\"_blank\" class=\"wt-text-link wt-p-xs-0\" href=\"https://github.com/etsy/open-api/discussions\">please add an issue in Github</a>.</p></div>© 2021-2025 Etsy, Inc. All Rights Reserved. Use of this code is subject to Etsy's <a class='wt-text-link wt-p-xs-0' target='_blank' href='https://www.etsy.com/legal/api'>API Developer Terms of Use</a>.",
"termsOfService": "https://www.etsy.com/legal/api",
"contact": {
"email": "developers@etsy.com"
},
"version": "3.0.0"
},
"servers": [
{
"url": "https://openapi.etsy.com",
"description": "Base URL for all Open API endpoints."
}
],
"security": [
{
"api_key": []
}
],
"tags": [
{
"name": "User"
},
{
"name": "UserAddress"
},
{
"name": "Shop Receipt Transactions"
},
{
"name": "Other"
},
{
"name": "Shop"
},
{
"name": "Shop ShippingProfile"
},
{
"name": "Shop Section"
},
{
"name": "ShopListing"
},
{
"name": "Shop ProcessingProfiles"
},
{
"name": "Shop ProductionPartner"
},
{
"name": "Shop Return Policy"
},
{
"name": "Shop HolidayPreferences"
},
{
"name": "SellerTaxonomy"
},
{
"name": "Review"
},
{
"name": "Shop Receipt"
},
{
"name": "Payment"
},
{
"name": "Ledger Entry"
},
{
"name": "ShopListing Video"
},
{
"name": "ShopListing VariationImage"
},
{
"name": "ShopListing Translation"
},
{
"name": "ShopListing Inventory"
},
{
"name": "ShopListing Offering"
},
{
"name": "ShopListing Product"
},
{
"name": "ShopListing Image"
},
{
"name": "ShopListing File"
},
{
"name": "BuyerTaxonomy"
}
],
"x-tagGroups": [
{
"name": "Listing Management",
"tags": [
"BuyerTaxonomy",
"SellerTaxonomy",
"ShopListing",
"ShopListing File",
"ShopListing Image",
"ShopListing Inventory",
"ShopListing Offering",
"ShopListing Product",
"ShopListing Translation",
"ShopListing VariationImage",
"ShopListing Video"
]
},
{
"name": "Other",
"tags": ["Other"]
},
{
"name": "Payment Management",
"tags": ["Ledger Entry", "Payment"]
},
{
"name": "Receipt Management",
"tags": ["Shop Receipt", "Shop Receipt Transactions"]
},
{
"name": "Review Management",
"tags": ["Review"]
},
{
"name": "Shipping Management",
"tags": [
"Shop HolidayPreferences",
"Shop ProcessingProfiles",
"Shop ShippingProfile"
]
},
{
"name": "Shop Management",
"tags": ["Shop", "Shop ProductionPartner", "Shop Section"]
},
{
"name": "Shop Policy Management",
"tags": ["Shop Return Policy"]
},
{
"name": "User Management",
"tags": ["User", "UserAddress"]
}
],
"paths": {
"/v3/application/buyer-taxonomy/nodes": {
"get": {
"operationId": "getBuyerTaxonomyNodes",
"description": "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves the full hierarchy tree of buyer taxonomy nodes.",
"tags": ["BuyerTaxonomy"],
"parameters": [],
"responses": {
"200": {
"description": "List the full hierarchy tree of buyer taxonomy nodes.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuyerTaxonomyNodes"
}
}
}
},
"500": {
"description": "The server encountered an internal error. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
}
}
}
},
"/v3/application/buyer-taxonomy/nodes/{taxonomy_id}/properties": {
"get": {
"operationId": "getPropertiesByBuyerTaxonomyId",
"description": "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a list of product properties, with applicable scales and values, supported for a specific buyer taxonomy ID.",
"tags": ["BuyerTaxonomy"],
"parameters": [
{
"name": "taxonomy_id",
"in": "path",
"description": "The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. For example, the \"shoes\" taxonomy node (ID: 1429, level: 1) is higher in the hierarchy than \"girls' shoes\" (ID: 1440, level: 2). The taxonomy nodes assigned to a listing support access to specific standardized product scales and properties. For example, listings assigned the taxonomy nodes \"shoes\" or \"girls' shoes\" support access to the \"EU\" shoe size scale with its associated property names and IDs for EU shoe sizes, such as property `value_id`:\"1394\", and `name`:\"38\".",
"required": true,
"schema": {
"type": "integer",
"description": "The unique numeric ID of an Etsy taxonomy node, which is a metadata category for listings organized into the seller taxonomy hierarchy tree. For example, the \"shoes\" taxonomy node (ID: 1429, level: 1) is higher in the hierarchy than \"girls' shoes\" (ID: 1440, level: 2). The taxonomy nodes assigned to a listing support access to specific standardized product scales and properties. For example, listings assigned the taxonomy nodes \"shoes\" or \"girls' shoes\" support access to the \"EU\" shoe size scale with its associated property names and IDs for EU shoe sizes, such as property `value_id`:\"1394\", and `name`:\"38\".",
"format": "int64",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "A list of product properties, with applicable scales and values.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuyerTaxonomyNodeProperties"
}
}
}
},
"404": {
"description": "A resource could not be found. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"400": {
"description": "There was a problem with the request data. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"500": {
"description": "The server encountered an internal error. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
}
}
}
},
"/v3/application/shops/{shop_id}/listings": {
"post": {
"operationId": "createDraftListing",
"description": "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nCreates a physical draft [listing](/documentation/reference#tag/ShopListing) product in a shop on the Etsy channel.",
"tags": ["ShopListing"],
"parameters": [
{
"name": "shop_id",
"in": "path",
"description": "The unique positive non-zero numeric ID for an Etsy Shop.",
"required": true,
"schema": {
"type": "integer",
"description": "The unique positive non-zero numeric ID for an Etsy Shop.",
"format": "int64",
"minimum": 1
}
},
{
"name": "legacy",
"in": "query",
"description": "This parameter needed to enable new parameters and response values related to processing profiles.",
"required": false,
"schema": {
"type": "boolean",
"description": "This parameter needed to enable new parameters and response values related to processing profiles."
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"required": [
"quantity",
"title",
"description",
"price",
"who_made",
"when_made",
"taxonomy_id"
],
"properties": {
"quantity": {
"type": "integer",
"description": "The positive non-zero number of products available for purchase in the listing. Note: The listing quantity is the sum of available offering quantities. You can request the quantities for individual offerings from the ListingInventory resource using the [getListingInventory](/documentation/reference#operation/getListingInventory) endpoint."
},
"title": {
"type": "string",
"description": "The listing's title string. When creating or updating a listing, valid title strings contain only letters, numbers, punctuation marks, mathematical symbols, whitespace characters, \u2122, \u00a9, and \u00ae. (regex: /[^\\p{L}\\p{Nd}\\p{P}\\p{Sm}\\p{Zs}\u2122\u00a9\u00ae]/u) You can only use the %, :, & and + characters once each."
},
"description": {
"type": "string",
"description": "A description string of the product for sale in the listing."
},
"price": {
"type": "number",
"description": "The positive non-zero price of the product. (Sold product listings are private) Note: The price is the minimum possible price. The [`getListingInventory`](/documentation/reference/#operation/getListingInventory) method requests exact prices for available offerings.",
"format": "float"
},
"who_made": {
"type": "string",
"description": "An enumerated string indicating who made the product. Helps buyers locate the listing under the Handmade heading. Requires 'is_supply' and 'when_made'.",
"enum": [
"i_did",
"someone_else",
"collective"
]
},
"when_made": {
"type": "string",
"description": "An enumerated string for the era in which the maker made the product in this listing. Helps buyers locate the listing under the Vintage heading. Requires 'is_supply' and 'who_made'.",
"enum": [
"made_to_order",
"2020_2025",
"2010_2019",
"2006_2009",
"before_2006",
"2000_2005",
"1990s",
"1980s",
"1970s",
"1960s",
"1950s",
"1940s",
"1930s",
"1920s",
"1910s",
"1900s",
"1800s",
"1700s",
"before_1700"
]
},
"taxonomy_id": {
"type": "integer",
"description": "The numerical taxonomy ID of the listing. See [SellerTaxonomy](/documentation/reference#tag/SellerTaxonomy) and [BuyerTaxonomy](/documentation/reference#tag/BuyerTaxonomy) for more information.",
"format": "int64",
"minimum": 1
},
"shipping_profile_id": {
"type": "integer",
"description": "The numeric ID of the [shipping profile](/documentation/reference#operation/getShopShippingProfile) associated with the listing. Required when listing type is `physical`.",
"format": "int64",
"nullable": true,
"minimum": 1
},
"return_policy_id": {
"type": "integer",
"description": "The numeric ID of the [Return Policy](/documentation/reference#operation/getShopReturnPolicies).",
"format": "int64",
"nullable": true,
"minimum": 1
},
"materials": {
"type": "array",
"description": "A list of material strings for materials used in the product. Valid materials strings contain only letters, numbers, and whitespace characters. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}]/u) Default value is null.",
"nullable": true,
"items": {
"type": "string"
}
},
"shop_section_id": {
"type": "integer",
"description": "The numeric ID of the [shop section](/documentation/reference#tag/Shop-Section) for this listing. Default value is null.",
"format": "int64",
"nullable": true,
"minimum": 1
},
"processing_min": {
"type": "integer",
"description": "The minimum number of days required to process this listing. Default value is null.",
"nullable": true
},
"processing_max": {
"type": "integer",
"description": "The maximum number of days required to process this listing. Default value is null.",
"nullable": true
},
"readiness_state_id": {
"type": "integer",
"description": "The numeric ID of the [processing profile](/documentation/reference#operation/getShopReadinessStateDefinition) associated with the listing. Returned only when the listing is `active` and of type `physical`, and the endpoint is either shop-scoped (path contains `shop_id`) or a single-listing request such as `getListing`. For every other case this field can be null.",
"format": "int64",
"nullable": true,
"minimum": 1
},
"tags": {
"type": "array",
"description": "A comma-separated list of tag strings for the listing. When creating or updating a listing, valid tag strings contain only letters, numbers, whitespace characters, -, ', \u2122, \u00a9, and \u00ae. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}\\-'\u2122\u00a9\u00ae]/u) Default value is null.",
"nullable": true,
"items": {
"type": "string"
}
},
"styles": {
"type": "array",
"description": "An array of style strings for this listing, each of which is free-form text string such as \"Formal\", or \"Steampunk\". When creating or updating a listing, the listing may have up to two styles. Valid style strings contain only letters, numbers, and whitespace characters. (regex: /[^\\p{L}\\p{Nd}\\p{Zs}]/u) Default value is null.",
"nullable": true,
"items": {
"type": "string"
}
},
"item_weight": {
"type": "number",
"description": "The numeric weight of the product measured in units set in 'item_weight_unit'. Default value is null. If set, the value must be greater than 0.",
"format": "float",
"nullable": true,
"minimum": 0,
"maximum": 1.79769313486e308
},
"item_length": {
"type": "number",
"description": "The numeric length of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.",
"format": "float",
"nullable": true,
"minimum": 0,
"maximum": 1.79769313486e308
},
"item_width": {
"type": "number",
"description": "The numeric width of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.",
"format": "float",
"nullable": true,
"minimum": 0,
"maximum": 1.79769313486e308
},
"item_height": {
"type": "number",
"description": "The numeric height of the product measured in units set in 'item_dimensions_unit'. Default value is null. If set, the value must be greater than 0.",
"format": "float",
"nullable": true,
"minimum": 0,
"maximum": 1.79769313486e308
},
"item_weight_unit": {
"type": "string",
"description": "A string defining the units used to measure the weight of the product. Default value is null.",
"nullable": true,
"enum": ["oz", "lb", "g", "kg"]
},
"item_dimensions_unit": {
"type": "string",
"description": "A string defining the units used to measure the dimensions of the product. Default value is null.",
"nullable": true,
"enum": [
"in",
"ft",
"mm",
"cm",
"m",
"yd",
"inches"
]
},
"is_personalizable": {
"type": "boolean",
"description": "When true, this listing is personalizable. The default value is null."
},
"personalization_is_required": {
"type": "boolean",
"description": "When true, this listing requires personalization. The default value is null. Will only change if is_personalizable is 'true'."
},
"personalization_char_count_max": {
"type": "integer",
"description": "This is an integer value representing the maximum length for the personalization message entered by the buyer. Will only change if is_personalizable is 'true'."
},
"personalization_instructions": {
"type": "string",
"description": "A string representing instructions for the buyer to enter the personalization. Will only change if is_personalizable is 'true'."
},
"production_partner_ids": {
"type": "array",
"description": "An array of unique IDs of production partner ids.",
"nullable": true,
"items": {
"type": "integer",
"format": "int64",
"minimum": 1
}
},
"image_ids": {
"type": "array",
"description": "An array of numeric image IDs of the images in a listing, which can include up to 20 images.",
"nullable": true,
"items": {
"type": "integer",
"format": "int64",
"minimum": 1
}
},
"is_supply": {
"type": "boolean",
"description": "When true, tags the listing as a supply product, else indicates that it's a finished product. Helps buyers locate the listing under the Supplies heading. Requires 'who_made' and 'when_made'."
},
"is_customizable": {
"type": "boolean",
"description": "When true, a buyer may contact the seller for a customized order. The default value is true when a shop accepts custom orders. Does not apply to shops that do not accept custom orders."
},
"should_auto_renew": {
"type": "boolean",
"description": "When true, renews a listing for four months upon expiration."
},
"is_taxable": {
"type": "boolean",
"description": "When true, applicable [shop](/documentation/reference#tag/Shop) tax rates apply to this listing at checkout."
},
"type": {
"type": "string",
"description": "An enumerated type string that indicates whether the listing is physical or a digital download.",
"enum": ["physical", "download", "both"]
}
}
}
}
}
},
"responses": {
"201": {
"description": "A single ShopListing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShopListing"
}
}
}
},
"400": {
"description": "There was a problem with the request data. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"401": {
"description": "The request lacks valid authentication credentials. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"403": {
"description": "The request attempted to perform an operation it is not allowed to. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"404": {
"description": "A resource could not be found. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"500": {
"description": "The server encountered an internal error. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
}
},
"security": [
{
"api_key": [],
"oauth2": ["listings_w"]
}
]
},
"get": {
"operationId": "getListingsByShop",
"description": "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nEndpoint to list Listings that belong to a Shop. Listings can be filtered using the 'state' param.",
"tags": ["ShopListing"],
"parameters": [
{
"name": "shop_id",
"in": "path",
"description": "The unique positive non-zero numeric ID for an Etsy Shop.",
"required": true,
"schema": {
"type": "integer",
"description": "The unique positive non-zero numeric ID for an Etsy Shop.",
"format": "int64",
"minimum": 1
}
},
{
"name": "state",
"in": "query",
"description": "When _updating_ a listing, this value can be either `active` or `inactive`. Note: Setting a `draft` listing to `active` will also publish the listing on etsy.com and requires that the listing have an image set. Setting a `sold_out` listing to active will update the quantity to 1 and renew the listing on etsy.com.",
"required": false,
"schema": {
"type": "string",
"description": "When _updating_ a listing, this value can be either `active` or `inactive`. Note: Setting a `draft` listing to `active` will also publish the listing on etsy.com and requires that the listing have an image set. Setting a `sold_out` listing to active will update the quantity to 1 and renew the listing on etsy.com.",
"enum": [
"active",
"inactive",
"sold_out",
"draft",
"expired"
],
"default": "active"
}
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of results to return.",
"required": false,
"schema": {
"type": "integer",
"description": "The maximum number of results to return.",
"minimum": 1,
"maximum": 100,
"default": 25
}
},
{
"name": "offset",
"in": "query",
"description": "The number of records to skip before selecting the first result.",
"required": false,
"schema": {
"type": "integer",
"description": "The number of records to skip before selecting the first result.",
"minimum": 0,
"default": 0
}
},
{
"name": "sort_on",
"in": "query",
"description": "The value to sort a search result of listings on. NOTES: a) `sort_on` only works when combined with one of the search options (keywords, region, etc.). b) when using `score` the returned results will always be in _descending_ order, regardless of the `sort_order` parameter.",
"required": false,
"schema": {
"type": "string",
"description": "The value to sort a search result of listings on. NOTES: a) `sort_on` only works when combined with one of the search options (keywords, region, etc.). b) when using `score` the returned results will always be in _descending_ order, regardless of the `sort_order` parameter.",
"enum": ["created", "price", "updated", "score"],
"default": "created"
}
},
{
"name": "sort_order",
"in": "query",
"description": "The ascending(up) or descending(down) order to sort listings by. NOTE: sort_order only works when combined with one of the search options (keywords, region, etc.).",
"required": false,
"schema": {
"type": "string",
"description": "The ascending(up) or descending(down) order to sort listings by. NOTE: sort_order only works when combined with one of the search options (keywords, region, etc.).",
"enum": [
"asc",
"ascending",
"desc",
"descending",
"up",
"down"
],
"default": "desc"
}
},
{
"name": "includes",
"in": "query",
"description": "An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations' and 'Inventory'.",
"required": false,
"schema": {
"type": "array",
"description": "An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations' and 'Inventory'.",
"items": {
"type": "string",
"enum": [
"Shipping",
"Images",
"Shop",
"User",
"Translations",
"Inventory",
"Videos"
]
},
"default": null
}
},
{
"name": "legacy",
"in": "query",
"description": "This parameter needed to enable new parameters and response values related to processing profiles.",
"required": false,
"schema": {
"type": "boolean",
"description": "This parameter needed to enable new parameters and response values related to processing profiles."
}
}
],
"responses": {
"200": {
"description": "A list of Listings",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShopListingsWithAssociations"
}
}
}
},
"400": {
"description": "There was a problem with the request data. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"401": {
"description": "The request lacks valid authentication credentials. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"403": {
"description": "The request attempted to perform an operation it is not allowed to. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"500": {
"description": "The server encountered an internal error. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
}
},
"security": [
{
"api_key": [],
"oauth2": ["listings_r"]
}
]
}
},
"/v3/application/listings/{listing_id}": {
"delete": {
"operationId": "deleteListing",
"description": "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nOpen API V3 endpoint to delete a ShopListing. A ShopListing can be deleted only if the state is one of the following: SOLD_OUT, DRAFT, EXPIRED, INACTIVE, ACTIVE and is_available or ACTIVE and has seller flags: SUPRESSED (frozen), VACATION, CUSTOM_SHOPS (pattern), SELL_ON_FACEBOOK",
"tags": ["ShopListing"],
"parameters": [
{
"name": "listing_id",
"in": "path",
"description": "The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.",
"required": true,
"schema": {
"type": "integer",
"description": "The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.",
"format": "int64",
"minimum": 1
}
}
],
"responses": {
"403": {
"description": "The request attempted to perform an operation it is not allowed to. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"409": {
"description": "There was a request conflict with the current state of the target resource. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"204": {
"description": "The Listing resource was correctly deleted"
},
"404": {
"description": "A resource could not be found. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"400": {
"description": "There was a problem with the request data. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"401": {
"description": "The request lacks valid authentication credentials. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"500": {
"description": "The server encountered an internal error. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
}
},
"security": [
{
"api_key": [],
"oauth2": ["listings_d"]
}
]
},
"get": {
"operationId": "getListing",
"description": "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nRetrieves a listing record by listing ID.",
"tags": ["ShopListing"],
"parameters": [
{
"name": "listing_id",
"in": "path",
"description": "The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.",
"required": true,
"schema": {
"type": "integer",
"description": "The numeric ID for the [listing](/documentation/reference#tag/ShopListing) associated to this transaction.",
"format": "int64",
"minimum": 1
}
},
{
"name": "includes",
"in": "query",
"description": "An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations' and 'Inventory'.",
"required": false,
"schema": {
"type": "array",
"description": "An enumerated string that attaches a valid association. Acceptable inputs are 'Shipping', 'Shop', 'Images', 'User', 'Translations' and 'Inventory'.",
"items": {
"type": "string",
"enum": [
"Shipping",
"Images",
"Shop",
"User",
"Translations",
"Inventory",
"Videos"
]
},
"default": null
}
},
{
"name": "language",
"in": "query",
"description": "The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.",
"required": false,
"schema": {
"type": "string",
"description": "The IETF language tag for the language of this translation. Ex: `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pl`, `pt`.",
"default": null
}
},
{
"name": "legacy",
"in": "query",
"description": "This parameter needed to enable new parameters and response values related to processing profiles.",
"required": false,
"schema": {
"type": "boolean",
"description": "This parameter needed to enable new parameters and response values related to processing profiles."
}
},
{
"name": "allow_suggested_title",
"in": "query",
"description": "This parameter will include in the response a suggested title for the listing, if one is available. Since suggestions are only available to the listing's owner, client must submit an oauth_access_token scoped to the owner of the listing.",
"required": false,
"schema": {
"type": "boolean",
"description": "This parameter will include in the response a suggested title for the listing, if one is available. Since suggestions are only available to the listing's owner, client must submit an oauth_access_token scoped to the owner of the listing."
}
}
],
"responses": {
"200": {
"description": "A single Listing.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShopListingWithAssociations"
}
}
}
},
"404": {
"description": "A resource could not be found. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"400": {
"description": "There was a problem with the request data. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
},
"500": {
"description": "The server encountered an internal error. See the error message for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorSchema"
}
}
}
}
}
}
},
"/v3/application/shops/{shop_id}/listings/{listing_id}/files/{listing_file_id}": {
"delete": {
"operationId": "deleteListingFile",
"description": "<div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><span class=\"wt-badge wt-badge--notificationPrimary wt-bg-slime-tint wt-mr-xs-2\">General Release</span><a class=\"wt-text-link\" href=\"https://github.com/etsy/open-api/discussions\" target=\"_blank\" rel=\"noopener noreferrer\">Report bug</a></div><div class=\"wt-display-flex-xs wt-align-items-center wt-mt-xs-2 wt-mb-xs-3\"><p class=\"wt-text-body-01 banner-text\">This endpoint is ready for production use.</p></div>\n\nDeletes a file from a specific listing. When you delete the final file for a digital listing, the listing converts into a physical listing. The response to a delete request returns a list of the remaining file records associated with the given listing.",
"tags": ["ShopListing File"],
"parameters": [
{
"name": "shop_id",
"in": "path",
"description": "The unique positive non-zero numeric ID for an Etsy Shop.",
"required": true,
"schema": {