-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
openapi.yaml
2047 lines (2046 loc) · 60 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Lunar API
version: 1.0.0
contact: {}
servers:
- url: '{{url}}'
paths:
/api/v1/addresses/1:
get:
tags:
- Addresses
summary: Get address
description: Get address
operationId: getAddress
parameters:
- name: include
in: query
schema:
type: string
example: customer,country
responses:
'200':
description: ''
delete:
tags:
- Addresses
summary: Delete address
description: Delete address
operationId: deleteAddress
responses:
'200':
description: ''
patch:
tags:
- Addresses
summary: Update address
description: Update address
operationId: updateAddress
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
city:
type: string
example: New York
company_in:
type: string
example: '12345678'
company_name:
type: string
example: ABC Company
company_tin:
type: string
example: CZ12345678
contact_phone:
type: string
example: '789456789'
first_name:
type: string
example: Jane
last_name:
type: string
example: Doe
line_one:
type: string
example: 123 Main Street
postcode:
type: string
example: '10001'
id:
type: string
example: '1'
relationships:
type: object
properties:
country:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: countries
customer:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: customers
type:
type: string
example: addresses
examples:
Update address:
value:
data:
attributes:
city: New York
company_in: '12345678'
company_name: ABC Company
company_tin: CZ12345678
contact_phone: '789456789'
first_name: Jane
last_name: Doe
line_one: 123 Main Street
postcode: '10001'
id: '1'
relationships:
country:
data:
id: '1'
type: countries
customer:
data:
id: '1'
type: customers
type: addresses
responses:
'200':
description: ''
/api/v1/addresses:
post:
tags:
- Addresses
summary: Create address
description: Create address
operationId: createAddress
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
city:
type: string
example: New York
company_name:
type: string
example: ABC Company
first_name:
type: string
example: John
last_name:
type: string
example: Doe
line_one:
type: string
example: 123 Main Street
postcode:
type: string
example: '10001'
relationships:
type: object
properties:
country:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: countries
customer:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: customers
type:
type: string
example: addresses
examples:
Create address:
value:
data:
attributes:
city: New York
company_name: ABC Company
first_name: John
last_name: Doe
line_one: 123 Main Street
postcode: '10001'
relationships:
country:
data:
id: '1'
type: countries
customer:
data:
id: '1'
type: customers
type: addresses
responses:
'200':
description: ''
/api/v1/addresses/1/country:
get:
tags:
- Addresses
summary: Get address country
description: Get address country
operationId: getAddressCountry
responses:
'200':
description: ''
/api/v1/addresses/1/relationships/country:
get:
tags:
- Addresses
summary: Get address country relationship
description: Get address country relationship
operationId: getAddressCountryRelationship
responses:
'200':
description: ''
/api/v1/addresses/1/customer:
get:
tags:
- Addresses
summary: Get address customer
description: Get address customer
operationId: getAddressCustomer
responses:
'200':
description: ''
/api/v1/addresses/1/relationships/customer:
get:
tags:
- Addresses
summary: Get address customer relationship
description: Get address customer relationship
operationId: getAddressCustomerRelationship
responses:
'200':
description: ''
/api/v1/carts/1/cart_lines:
get:
tags:
- Cart
summary: List cart lines
description: List cart lines
operationId: listCartLines
responses:
'200':
description: ''
/api/v1/carts/1/relationships/cart_lines:
get:
tags:
- Cart
summary: List cart lines relationships
description: List cart lines relationships
operationId: listCartLinesRelationships
responses:
'200':
description: ''
/api/v1/carts/1:
get:
tags:
- Cart
summary: Get cart
description: Get cart
operationId: getCart
parameters:
- name: include
in: query
schema:
type: string
example: transactions
responses:
'200':
description: ''
/api/v1/carts/-actions/apply-coupon:
post:
tags:
- Cart
summary: Apply coupon to cart action
description: Apply coupon to cart action
operationId: applyCouponToCartAction
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
coupon_code:
type: string
example: code
type:
type: string
example: carts
examples:
Apply coupon to cart action:
value:
data:
attributes:
coupon_code: code
type: carts
responses:
'200':
description: ''
/api/v1/carts/-actions/my-cart:
get:
tags:
- Cart
summary: Get cart for logged in user action
description: Get cart for logged in user action
operationId: getCartForLoggedInUserAction
parameters:
- name: include
in: query
schema:
type: string
example: cart_lines
responses:
'200':
description: ''
/api/v1/carts/-actions/clear:
delete:
tags:
- Cart
summary: Clear cart action
description: Clear cart action
operationId: clearCartAction
responses:
'200':
description: ''
/api/v1/carts/-actions/checkout:
post:
tags:
- Cart
summary: Checkout cart action
description: Checkout cart action
operationId: checkoutCartAction
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
agree:
type: boolean
example: true
create_user:
type: boolean
example: true
type:
type: string
example: carts
examples:
Checkout cart action:
value:
data:
attributes:
agree: true
create_user: true
type: carts
responses:
'200':
description: ''
/api/v1/cart-lines:
post:
tags:
- CartLines
summary: Create cart line (add to cart)
description: Create cart line (add to cart)
operationId: createCartLineAddToCart
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
meta:
nullable: true
example: null
purchasable_id:
type: number
example: 349
purchasable_type:
type: string
example: Lunar\Models\ProductVariant
quantity:
type: number
example: 1
type:
type: string
example: cart-lines
examples:
Create cart line (add to cart):
value:
data:
attributes:
meta: null
purchasable_id: 349
purchasable_type: Lunar\Models\ProductVariant
quantity: 1
type: cart-lines
responses:
'200':
description: ''
/api/v1/cart-lines/13516:
patch:
tags:
- CartLines
summary: Update cart line (update quantity)
description: Update cart line (update quantity)
operationId: updateCartLineUpdateQuantity
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
quantity:
type: number
example: 5
id:
type: string
example: '13516'
type:
type: string
example: cart-lines
examples:
Update cart line (update quantity):
value:
data:
attributes:
quantity: 5
id: '13516'
type: cart-lines
responses:
'200':
description: ''
/api/v1/cart-lines/18:
delete:
tags:
- CartLines
summary: Delete cart line (remove from cart)
description: Delete cart line (remove from cart)
operationId: deleteCartLineRemoveFromCart
responses:
'200':
description: ''
/api/v1/cart-addresses:
post:
tags:
- CartAddresses
summary: Create cart address
description: Create cart address
operationId: createCartAddress
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
address_type:
type: string
example: shipping
city:
type: string
example: New York
company_in:
type: string
example: '12345678'
company_name:
type: string
example: ABC Company
company_tin:
type: string
example: CZ12345678
contact_email:
type: string
example: [email protected]
contact_phone:
type: string
example: '777888999'
first_name:
type: string
example: John
last_name:
type: string
example: Doe
line_one:
type: string
example: 123 Main Street
postcode:
type: string
example: '10001'
shipping_option:
type: string
example: Friendly Freight Co.
relationships:
type: object
properties:
cart:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1949444'
type:
type: string
example: carts
country:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: countries
type:
type: string
example: cart-addresses
examples:
Create cart address:
value:
data:
attributes:
address_type: shipping
city: New York
company_in: '12345678'
company_name: ABC Company
company_tin: CZ12345678
contact_email: [email protected]
contact_phone: '777888999'
first_name: John
last_name: Doe
line_one: 123 Main Street
postcode: '10001'
shipping_option: Friendly Freight Co.
relationships:
cart:
data:
id: '1949444'
type: carts
country:
data:
id: '1'
type: countries
type: cart-addresses
responses:
'200':
description: ''
security:
- bearerAuth: []
/api/v1/cart-addresses/1:
patch:
tags:
- CartAddresses
summary: Update cart address
description: Update cart address
operationId: updateCartAddress
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
address_type:
type: string
example: shipping
city:
type: string
example: New York
company_in:
type: string
example: '12345678'
company_name:
type: string
example: ABC Company
company_tin:
type: string
example: CZ12345678
contact_email:
type: string
example: [email protected]
contact_phone:
type: string
example: '777888999'
first_name:
type: string
example: John
last_name:
type: string
example: Doe
line_one:
type: string
example: 123 Main Street
postcode:
type: string
example: '10001'
shipping_option:
type: string
example: SODEL
id:
type: string
example: '1'
relationships:
type: object
properties:
cart:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: carts
country:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: countries
type:
type: string
example: cart-addresses
examples:
Update cart address:
value:
data:
attributes:
address_type: shipping
city: New York
company_in: '12345678'
company_name: ABC Company
company_tin: CZ12345678
contact_email: [email protected]
contact_phone: '777888999'
first_name: John
last_name: Doe
line_one: 123 Main Street
postcode: '10001'
shipping_option: SODEL
id: '1'
relationships:
cart:
data:
id: '1'
type: carts
country:
data:
id: '1'
type: countries
type: cart-addresses
responses:
'200':
description: ''
/api/v1/cart-addresses/1/-actions/attach-shipping-option:
patch:
tags:
- CartAddresses
summary: Attach shipping option action
description: Attach shipping option action
operationId: attachShippingOptionAction
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
shipping_option:
type: string
example: DPDDEL
id:
type: string
example: '1'
type:
type: string
example: cart-addresses
examples:
Attach shipping option action:
value:
data:
attributes:
shipping_option: DPDDEL
id: '1'
type: cart-addresses
responses:
'200':
description: ''
/api/v1/cart-addresses/1/-actions/detach-shipping-option:
delete:
tags:
- CartAddresses
summary: Detach shipping option action
description: Detach shipping option action
operationId: detachShippingOptionAction
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
shipping_option:
type: string
example: DPDDEL
id:
type: string
example: '1'
type:
type: string
example: cart-addresses
examples:
Detach shipping option action:
value:
data:
attributes:
shipping_option: DPDDEL
id: '1'
type: cart-addresses
responses:
'200':
description: ''
/api/v1/cart-addresses/1/-actions/continuous-update:
patch:
tags:
- CartAddresses
summary: Continuous update action
description: Continuous update action
operationId: continuousUpdateAction
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
address_type:
type: string
example: billing
company_in:
type: string
example: '12345678'
company_name:
type: string
example: Hovno
company_tin:
type: string
example: CZ12345678
id:
type: string
example: '1'
relationships:
type: object
properties:
cart:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
example: carts
type:
type: string
example: cart-addresses
examples:
Continuous update action:
value:
data:
attributes:
address_type: billing
company_in: '12345678'
company_name: Hovno
company_tin: CZ12345678
id: '1'
relationships:
cart:
data:
id: '1'
type: carts
type: cart-addresses
responses:
'200':
description: ''
/api/v1/cart-addresses/1/-actions/update-country:
patch:
tags:
- CartAddresses
summary: Update cart address country action
description: Update cart address country action
operationId: updateCartAddressCountryAction
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '1'
relationships:
type: object
properties:
country:
type: object
properties:
data:
type: object
properties:
id:
type: string
example: '2'
type:
type: string
example: countries
type:
type: string
example: cart-addresses
examples:
Update cart address country action:
value:
data:
id: '1'
relationships:
country:
data:
id: '2'
type: countries
type: cart-addresses
responses:
'200':
description: ''
/api/v1/collections/1:
get:
tags:
- Collections
summary: Get collection
description: Get collection
operationId: getCollection
parameters:
- name: filter[url][slug]
in: query
schema:
type: string
example: mechanical-keyboards
responses:
'200':
description: ''
/api/v1/collections:
get:
tags:
- Collections
summary: List collections
description: List collections
operationId: listCollections
responses:
'200':
description: ''
/api/v1/collections/1/default_url:
get:
tags:
- Collections
summary: Get collection default url
description: Get collection default url
operationId: getCollectionDefaultUrl
responses:
'200':
description: ''
/api/v1/collections/1/relationships/default_url:
get:
tags:
- Collections
summary: Get collection default url relation
description: Get collection default url relation
operationId: getCollectionDefaultUrlRelation
responses:
'200':
description: ''
/api/v1/collections/1/products:
get:
tags:
- Collections
summary: List collection products
description: List collection products
operationId: listCollectionProducts
responses:
'200':
description: ''
/api/v1/collections/1/relationships/products:
get:
tags:
- Collections
summary: List collection products relationships
description: List collection products relationships