forked from getcandy/candy-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
open-api.yaml
8496 lines (8480 loc) · 228 KB
/
open-api.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: GetCandy
contact:
name: GetCandy
url: 'https://getcandy.io'
email: support@getcandy.io
version: '1.0'
license:
name: MIT
description: The GetCandy API
servers:
- url: 'http://localhost:3000/api/v1'
paths:
/channels:
get:
summary: Get all channels
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelCollection'
operationId: get-channels
parameters:
- schema:
type: string
in: query
name: includes
description: Comma separated includes for the resource
- schema:
type: number
in: query
name: per_page
description: How many results per page
description: Gets a paginated list of all channel
tags:
- Channels
post:
summary: Create a new channel
description: Create a new channel resource
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Channel'
operationId: post-channels
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateChannelBody'
examples: {}
description: ''
tags:
- Channels
'/channels/{channelId}':
parameters:
- schema:
type: string
name: channelId
in: path
required: true
get:
summary: Get the channel resource
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelResponse'
examples:
example-1:
value:
data:
id: y3g6v91o
name: Webstore
handle: webstore
url: 'http://webstore.test'
default: true
published_at: null
meta:
lang: en
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: get-channels-channelId
description: ''
parameters:
- schema:
type: string
in: query
name: includes
tags:
- Channels
put:
summary: Update the channel resource
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
properties:
handle:
type: array
items:
type: string
name:
type: array
items:
type: string
operationId: put-channels-channelId
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateChannelBody'
description: ''
tags:
- Channels
delete:
summary: Delete the channel resource
responses:
'204':
description: No Content
operationId: delete-channels-channelId
tags:
- Channels
description: ''
/orders:
get:
summary: Get orders
tags:
- Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrderCollection'
operationId: get-orders
description: "If you're an admin user you will be able to see all orders, otherwise only the current users orders will be returned."
parameters:
- schema:
type: string
in: query
name: include
post:
summary: Create Order
operationId: post-orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrderResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
forbidden-example:
value:
http_code: 403
message: This basket already has an order that has been placed
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
unprocessable-example:
value:
basket_id:
- The basket id field is required.
description: Create an Order from a Basket instance
tags:
- Orders
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOrderBody'
'/orders/{orderId}':
parameters:
- schema:
type: string
name: orderId
in: path
required: true
get:
summary: Get Order
tags:
- Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrderResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: get-orders-orderId
description: |-
Get an Order by it's ID.
You must be an admin or owner to retrieve the order, otherwise you'll get a 404.
put:
summary: Update Order
operationId: put-orders-orderId
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrderResponse'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Order'
tags:
- Orders
description: Update an Order
requestBody:
content:
application/json:
schema:
type: object
properties:
tracking_no:
type: string
status:
type: string
description: Corresponds to status set in config
send_emails:
type: boolean
default: 0
example: true
description: ''
parameters:
- schema:
type: string
in: query
name: include
/orders/types:
get:
summary: Get order types
tags:
- Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrderTypeCollection'
examples:
order-types-example:
value:
data:
- label: Collection
- label: PayPal
- label: SagePay
operationId: get-orders-types
description: Returns all order types currently in the system
/orders/process:
post:
summary: Processes an order on the API
tags:
- Orders
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OrderResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: post-orders-process
requestBody:
content:
application/json:
schema:
type: object
properties:
payment_type_id:
type: string
payment_type:
type: string
order_id:
type: string
payment_token:
type: string
customer_reference:
type: string
meta:
type: array
items:
type: object
notes:
type: string
company_name:
type: string
required:
- order_id
- payment_token
/attributes:
get:
summary: Get Attributes
tags:
- Attributes
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AttributeCollection'
examples:
paginated-example:
value:
data:
- id: dnj4zky5
name:
en: Name
sv: Namn
handle: name
position: '1'
filterable: false
scopeable: true
translatable: true
variant: false
searchable: true
localised: true
type: text
required: true
lookups: null
system: false
group:
data:
id: vokq5kmj
name:
en: General
handle: general
position: '1'
links:
first: 'http://storefront.test/api/v1/attributes?page=1'
last: 'http://storefront.test/api/v1/attributes?page=5'
prev: null
next: 'http://storefront.test/api/v1/attributes?page=2'
meta:
current_page: 1
from: 1
last_page: 5
path: 'http://storefront.test/api/v1/attributes'
per_page: 15
to: 15
total: 70
operationId: get-attributes
parameters: []
description: Return a paged array of attributes
post:
summary: Create Attribute
tags:
- Attributes
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/AttributeResponse'
examples:
post-example:
value:
data:
id: w52log2p
name:
en: New attribute
handle: new-attribute
position: 2
system: false
lookups: null
required: false
type: text
localised: false
searchable: false
variant: false
translatable: false
scopeable: false
filterable: false
meta:
lang: en
'422':
description: Unprocessable Entity
content:
application/json:
schema:
type: object
properties:
group_id:
type: array
items:
type: string
name:
type: array
items:
type: string
handle:
type: array
items:
type: string
examples:
full-unprocessable:
value:
group_id:
- The group id field is required.
name:
- The name field is required.
handle:
- The handle field is required.
operationId: post-attributes
description: Create a new attribute
requestBody:
content:
application/json:
schema:
type: object
properties:
group_id:
type: string
example: q1jo3jm4
name:
type: array
items:
type: object
properties:
locale:
type: string
required:
- locale
handle:
type: string
position:
type: integer
format: int32
example: 12
filterable:
type: boolean
default: false
scopeable:
type: integer
default: false
format: int32
translatable:
type: boolean
default: false
variant:
type: boolean
default: false
searchable:
type: boolean
default: false
localised:
type: boolean
default: false
type:
type: string
default: text
required:
type: boolean
default: false
lookups:
type: array
items:
type: object
properties:
label:
type: string
value:
type: string
system:
type: boolean
default: false
required:
- group_id
- name
- handle
examples:
post-example:
value:
group_id: q1w24k3l
name:
en: New attribute
handle: new-attribute
lookups:
label: Lookup 1
value: lookup-1
parameters: []
/categories:
get:
summary: Return a paged array of categories
tags:
- Categories
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryCollection'
operationId: get-categories
parameters:
- schema:
type: boolean
in: query
name: full_response
description: ''
- schema:
type: string
in: query
name: include
- schema:
type: boolean
in: query
name: tree
description: Whether response should be a node tree
description: Returns a paginated resource of categories
post:
summary: Create a new category
tags:
- Categories
operationId: post-categories
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCategoryBody'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Unprocessable:
value:
url:
- The url field is required.
description: "Creates a new category and returns it's resource."
'/categories/{categoryId}':
parameters:
- schema:
type: string
name: categoryId
in: path
required: true
description: ''
get:
summary: Return a single category
tags:
- Categories
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryResponse'
examples: {}
operationId: get-categories-categoryId
parameters:
- schema:
type: string
in: query
name: includes
description: Returns a single category from a given ID
put:
summary: Update a category
operationId: put-categories-categoryId
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Unprocessable Entity
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAttributesBody'
description: ''
tags:
- Categories
description: Update a category using a given ID.
/assets:
put:
summary: Update Assets
operationId: put-assets
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAssetBody'
description: ''
tags:
- Assets
description: Update all assets in the given array of ids.
post:
summary: Create Asset
tags:
- Assets
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetResponse'
operationId: post-assets
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateAssetBody'
description: ''
description: Upload an asset to a model
/assets/simple:
post:
summary: Simple asset upload
tags:
- Assets
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetSimple'
examples:
upload-example:
value:
path: uploads/01/04/WGWVDkB2VXkDKx4UeeLnStBwnEJXGL2Vd6j5Le1P.png
filename: the-secret-recipe.png
url: 'http://storefront.test/storage/uploads/01/04/WGWVDkB2VXkDKx4UeeLnStBwnEJXGL2Vd6j5Le1P.png'
thumbnail: uploads/01/04/thumbnails/WGWVDkB2VXkDKx4UeeLnStBwnEJXGL2Vd6j5Le1P.png
thumbnail_url: 'http://storefront.test/storage/uploads/01/04/thumbnails/WGWVDkB2VXkDKx4UeeLnStBwnEJXGL2Vd6j5Le1P.png'
operationId: post-assets-simple
description: This endpoint allows you to upload an asset without having to attach it to a model. This is good for one time uploads where you just want to get back a URL
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/AssetSimpleUploadBody'
description: ''
'/assets/{assetId}/detach/{ownerId}':
parameters:
- schema:
type: string
name: assetId
in: path
required: true
description: The hashed asset id
- schema:
type: string
name: ownerId
in: path
required: true
description: The hashed owner id
post:
summary: "Detach an asset from it's model"
tags:
- Assets
responses:
'204':
description: No Content
operationId: post-assets-assetId-detach-ownerId
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssetDetachBody'
description: Detaches any assets from a given model. Useful if you want to remove certain assets from a product (or another model) without deleting the asset itself.
/associations/groups:
get:
summary: Paginated array of association groups
tags:
- Associations
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssociationGroupCollection'
examples:
full-response:
value:
data:
- id: v8l4pl01
name: Upsell
handle: upsell
- id: p09prlrn
name: Cross-sell
handle: cross-sell
- id: wz6d39dj
name: Alternate
handle: alternate
meta:
lang: en
pagination:
total: 3
count: 3
per_page: 50
current_page: 1
total_pages: 1
links: []
operationId: get-associations-groups
description: Returns a paginated response of association groups available in the system
/attributes/order:
put:
summary: Update request to reorder attributes
tags:
- Attributes
responses:
'204':
description: No Content
operationId: put-attributes-order
description: Allows you to reorder a target category in relation to another.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AttributesReorderBody'
'/attributes/{attributeId}':
parameters:
- schema:
type: string
name: attributeId
in: path
required: true
get:
summary: Get an attribute
tags:
- Attributes
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AttributeResponse'
examples:
full-example:
value:
data:
id: dnj4zky5
name:
en: Name
sv: Namn
handle: name
position: '1'
filterable: false
scopeable: true
translatable: true
variant: false
searchable: true
localised: true
type: text
required: true
lookups: null
system: false
example-with-group:
value:
data:
id: dnj4zky5
name:
en: Name
sv: Namn
handle: name
position: '1'
filterable: false
scopeable: true
translatable: true
variant: false
searchable: true
localised: true
type: text
required: true
lookups: null
system: false
group:
data:
id: vokq5kmj
name:
en: General
handle: general
position: '1'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
operationId: get-attributes-attributeId
parameters:
- schema:
type: string
in: query
name: include
description: ''
description: Returns an attribute from a given ID.
put:
summary: Update an attribute
operationId: put-attributes-attributeId
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AttributeResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
not-found-example:
value:
error:
http_code: 404
message: Resource not found
'422':
description: Unprocessable Entity (WebDAV)
content:
application/json:
schema:
type: object
properties:
name:
type: array
items:
type: string
examples:
validation-example:
value:
name:
- The name field is required.
description: Updates an attribute from a given ID.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Attribute'
tags:
- Attributes
delete:
summary: Delete an attribute
operationId: delete-attributes-attributeId
responses:
'204':
description: No Content
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
not-found-example:
value:
error:
http_code: 404
message: Resource not found
tags:
- Attributes
description: Delete an attribute.
parameters: []
/attribute-groups:
get:
summary: Paginated list of Attribute Groups
tags:
- Attributes
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AttributeGroupCollection'
examples:
without-pagination-example:
value:
data:
- id: vokq5kmj
name:
en: General
handle: general
position: '1'
- id: mqkj8wyj
name:
en: Meta Information
sv: SEO
handle: seo
position: '2'
- id: 96e7nk8r
name:
en: Default
handle: default
position: '4'
operationId: get-attribute-groups
parameters:
- schema:
type: boolean
default: 'false'
in: query
name: all_records
description: Will skip pagination and return all records
- schema:
type: string
in: query
name: include
description: Returns a paginated list of available attribute groups
post:
summary: Create an Attribute Group