-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwoocommerce-rest-api-openapi-specification.yml
1390 lines (1390 loc) · 38.4 KB
/
woocommerce-rest-api-openapi-specification.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: WooCommerce REST API
description: The REST API is a powerful part of WooCommerce which lets you read and write various parts of WooCommerce data such as orders, products, coupons, customers, and shipping zones.
version: v3
contact:
name: WTX Labs Team
url: https://github.com/wtx-labs/woocommerce-api-openapi-specification
servers:
- url: https://example-woocommerce-shop.com/wp-json/wc/v3
security:
- basicAuth: []
tags:
- name: Customers
- name: Products
- name: Orders
- name: Reports
paths:
/customers:
post:
tags:
- Customers
summary: This API helps you to create a new customer.
operationId: createCustomer
requestBody:
description: Customer object with data to create.
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
required: true
responses:
'200':
description: Returns specified customer.
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
get:
tags:
- Customers
summary: This API helps you to view all the customers.
operationId: listAllCustomers
parameters:
- name: context
in: query
description: Scope under which the request is made; determines fields present in response.
required: false
schema:
type: string
enum:
- view
- edit
- name: page
in: query
description: Current page of the collection.
required: false
schema:
type: integer
default: 1
- name: per_page
in: query
description: Maximum number of items to be returned in result set.
required: false
schema:
type: integer
default: 10
- name: search
in: query
description: Limit results to those matching a string.
required: false
schema:
type: string
- name: exclude
in: query
description: Ensure result set excludes specific IDs.
required: false
schema:
type: array
items:
type: integer
- name: include
in: query
description: Limit result set to specific IDs.
required: false
schema:
type: array
items:
type: integer
- name: offset
in: query
description: Offset the result set by a specific number of items.
required: false
schema:
type: integer
- name: order
in: query
description: Order sort attribute ascending or descending (asc as default).
required: false
schema:
type: string
enum:
- asc
- desc
- name: orderby
in: query
description: Sort collection by object attribute.
required: false
schema:
type: string
enum:
- id
- include
- name
- registered_date
- email
- name: email
in: query
description: Limit result set to resources with a specific email address.
required: false
schema:
type: string
- name: role
in: query
description: Limit result set to resources with a specific role. Default is customer.
required: false
schema:
type: string
enum:
- all
- administrator
- editor
- author
- contributor
- subscriber
- customer
- shop_manager
responses:
'200':
description: Returns list of customers.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Customer'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/customers/{customerId}:
get:
tags:
- Customers
summary: This API lets you retrieve and view a specific customer by ID.
operationId: retrieveCustomerById
parameters:
- name: customerId
in: path
description: ID of customer to return
required: true
schema:
type: integer
responses:
'200':
description: Returns specified customer.
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/products:
post:
tags:
- Products
summary: This API helps you to create a new product.
operationId: createProduct
requestBody:
description: Product object with data to create.
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
required: true
responses:
'200':
description: Returns specified product.
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
get:
tags:
- Products
summary: This API helps you to view all the products.
operationId: listAllProducts
parameters:
- name: sku
in: query
description: Limit result set to products with a specific SKU.
schema:
type: string
- name: attribute
in: query
description: Limit result set to products with a specific attribute.
schema:
type: string
- name: per_page
in: query
description: Maximum number of items to be returned in result set. Default is 10.
schema:
type: integer
- name: page
in: query
description: Current page of the collection. Default is 1.
schema:
type: integer
- name: after
in: query
description: Limit response to resources published after a given ISO8601 compliant date (eg. 2023-05-07T10:00:00).
schema:
type: string
- name: before
in: query
description: Limit response to resources published before a given ISO8601 compliant date (eg. 2023-10-07T12:10:16).
schema:
type: string
- name: modified_after
in: query
description: Limit response to resources modified after a given ISO8601 compliant date. (eg. 2023-05-07T10:00:00).
schema:
type: string
- name: status
in: query
description: 'Limit result set to products assigned a specific status. Options: any, draft, pending, private and publish. Default is any.'
style: form
explode: true
schema:
type: array
items:
type: string
default: any
enum:
- any
- draft
- pending
- private
- publish
- name: stock_status
in: query
description: 'Limit result set to products with specified stock status. Options: instock, outofstock and onbackorder.'
schema:
type: string
enum:
- instock
- outofstock
- onbackorder
- name: order
in: query
description: 'Order sort attribute ascending or descending. Options: asc and desc. Default is desc.'
schema:
type: string
default: desc
enum:
- asc
- desc
responses:
'200':
description: Returns list of products.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Product'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/products/{productId}:
get:
tags:
- Products
summary: This API lets you retrieve and view a specific product by ID.
operationId: retrieveProductById
parameters:
- name: productId
in: path
description: ID of product to return
required: true
schema:
type: integer
responses:
'200':
description: Returns specified product.
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
put:
tags:
- Products
summary: This API lets you make changes to a product.
operationId: updateProductById
parameters:
- name: productId
in: path
description: ID of product to update
required: true
schema:
type: integer
requestBody:
description: Product object with data to update.
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
required: true
responses:
'200':
description: Returns updated product.
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
x-codegen-request-body-name: product
/orders:
post:
tags:
- Orders
summary: This API helps you to create a new order.
operationId: createOrder
requestBody:
description: Order object with data to create.
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
required: true
responses:
'200':
description: Returns specified order.
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
get:
tags:
- Orders
summary: This API helps you to view all the orders.
operationId: listAllOrders
parameters:
- name: page
in: query
description: Current page of the collection. Default is 1.
schema:
type: integer
- name: per_page
in: query
description: Maximum number of items to be returned in result set. Default is 10.
schema:
type: integer
- name: after
in: query
description: Limit response to resources published after a given ISO8601 compliant date (eg. 2023-05-07T10:00:00).
schema:
type: string
- name: before
in: query
description: Limit response to resources published before a given ISO8601 compliant date (eg. 2023-10-07T12:10:16).
schema:
type: string
- name: modified_after
in: query
description: Limit response to resources modified after a given ISO8601 compliant date. (eg. 2023-05-07T10:00:00).
schema:
type: string
- name: status
in: query
description: 'Limit result set to orders assigned a specific status. Options: any, pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Default is any.'
style: form
explode: true
schema:
type: array
items:
type: string
default: any
enum:
- any
- pending
- processing
- on-hold
- completed
- cancelled
- refunded
- failed
- trash
- name: order
in: query
description: 'Order sort attribute ascending or descending. Options: asc and desc. Default is desc.'
schema:
type: string
default: desc
enum:
- asc
- desc
responses:
'200':
description: Returns list of orders.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Order'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/orders/{orderId}:
get:
tags:
- Orders
summary: This API lets you retrieve and view a specific order.
operationId: retrieveOrderById
parameters:
- name: orderId
in: path
description: ID of order to return
required: true
schema:
type: integer
responses:
'200':
description: Returns specified order.
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/reports/orders/totals:
get:
tags:
- Reports
summary: This API lets you retrieve and view orders totals report.
operationId: reportOrderTotalsSummary
responses:
'200':
description: Returns list of products.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReportOrderTotalSummary'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/reports/sales:
get:
tags:
- Reports
summary: This API lets you retrieve and view a sales report.
operationId: reportSalesSummary
parameters:
- name: period
in: query
description: 'Report period. Default is today''s date. Options: week, month, last_month and year'
schema:
type: string
enum:
- week
- month
- last_month
- year
- name: date_min
in: query
description: Return sales for a specific start date, the date need to be in the YYYY-MM-DD format.
schema:
type: string
- name: date_max
in: query
description: Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.
schema:
type: string
responses:
'200':
description: Returns list of products.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReportSalesSummary'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
schemas:
Customer:
type: object
properties:
id:
type: integer
description: Unique identifier for the resource. read-only
date_created:
type: string
format: date-time
description: The date the customer was created, in the site's timezone. read-only
date_created_gmt:
type: string
format: date-time
description: The date the customer was created, as GMT. read-only
date_modified:
type: string
format: date-time
description: The date the customer was last modified, in the site's timezone. read-only
date_modified_gmt:
type: string
format: date-time
description: The date the customer was last modified, as GMT. read-only
email:
type: string
description: The email address for the customer. mandatory
first_name:
type: string
description: Customer first name.
last_name:
type: string
description: Customer last name.
role:
type: string
description: Customer role. read-only
username:
type: string
description: Customer login name.
password:
type: string
description: Customer password. write-only
billing:
$ref: '#/components/schemas/Billing'
shipping:
$ref: '#/components/schemas/Shipping'
is_paying_customer:
type: boolean
description: Is the customer a paying customer? read-only
avatar_url:
type: string
description: Avatar URL. read-only
meta_data:
type: array
description: Meta data.
items:
$ref: '#/components/schemas/MetaData'
Product:
type: object
properties:
id:
type: integer
description: Unique identifier for the resource.
date_created:
type: string
description: The date the product was created, in the site's timezone.
format: date-time
date_modified:
type: string
description: The date the product was last modified, in the site's timezone.
format: date-time
name:
type: string
description: Product name.
sku:
type: string
description: Unique identifier.
type:
type: string
description: 'Product type. Options: simple, grouped, external and variable. Default is simple.'
status:
type: string
description: 'Product status (post status). Options: draft, pending, private and publish. Default is publish.'
description:
type: string
description: Product description.
short_description:
type: string
description: Product short description.
price:
type: string
description: Current product price.
stock_quantity:
type: integer
description: Stock quantity.
stock_status:
type: string
description: 'Controls the stock status of the product. Options: instock, outofstock, onbackorder. Default is instock.'
parent_id:
type: integer
description: Product parent ID.
variations:
type: array
description: List of variations IDs.
items:
type: integer
attributes:
type: array
description: List of attributes.
items:
$ref: '#/components/schemas/ProductAttribute'
meta_data:
type: array
description: Meta data properties.
items:
$ref: '#/components/schemas/MetaData'
ProductAttribute:
type: object
properties:
id:
type: integer
description: Attribute ID.
name:
type: string
description: Attribute name.
option:
type: string
description: Selected attribute term name. Applicable only for Product represents SKU (variation)
Order:
type: object
properties:
id:
type: integer
description: Unique identifier for the resource.
parent_id:
type: integer
description: Parent order ID.
number:
type: string
description: Order number.
order_key:
type: string
description: Order key.
created_via:
type: string
description: Shows where the order was created.
version:
type: string
description: Version of WooCommerce which last updated the order.
status:
type: string
description: Order status.
enum:
- pending
- processing
- on-hold
- completed
- cancelled
- refunded
- failed
currency:
type: string
description: Currency the order was created with, in ISO format.
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTC
- BTN
- BWP
- BYR
- BYN
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GGP
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- IMP
- INR
- IQD
- IRR
- IRT
- ISK
- JEP
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PRB
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- SSP
- STN
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VES
- VND
- VUV
- WST
- XAF
- XCD
- XOF
- XPF
- YER
- ZAR
- ZMW
date_created:
type: string
description: The date the order was created, in the site's timezone.
date_created_gmt:
type: string
description: The date the order was created, as GMT.
date_modified:
type: string
description: The date the order was last modified, in the site's timezone.
date_modified_gmt:
type: string
description: The date the order was last modified, as GMT.
discount_total:
type: string
description: Total discount amount for the order.
discount_tax:
type: string
description: Total discount tax amount for the order.
shipping_total:
type: string
description: Total shipping amount for the order.
shipping_tax:
type: string
description: Total shipping tax amount for the order.
cart_tax:
type: string
description: Sum of line item taxes only.
total:
type: string
description: Grand total.
total_tax:
type: string
description: Sum of all taxes.
prices_include_tax:
type: boolean
description: True the prices included tax during checkout.
customer_id:
type: integer
description: User ID who owns the order. 0 for guests.
customer_ip_address:
type: string
description: Customer's IP address.
customer_user_agent:
type: string
description: User agent of the customer.
customer_note:
type: string
description: Note left by customer during checkout.
billing:
$ref: '#/components/schemas/Billing'
shipping:
$ref: '#/components/schemas/Shipping'
payment_method:
type: string
description: Payment method ID.
payment_method_title:
type: string
description: Payment method title.