-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
5556 lines (5556 loc) · 145 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.1.0
info:
version: 1.0.0
title: Booking Shopify Api
license:
name: MIT
url: 'http://'
contact:
name: jamal Soueidan
email: [email protected]
url: 'https://github.com/jamalsoueidan'
x-tagGroups:
- name: all api endpoints
tags:
- Schedule
servers:
- url: 'https://booking-shopify-api.azurewebsites.net/api'
components:
responses:
BadResponse:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
ForbiddenResponse:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
NotFoundResponse:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
UnauthorizedResponse:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
schemas:
Errors:
type: object
properties:
success:
type: boolean
example: false
errors:
type: array
items:
type: object
properties:
path:
type: array
items:
type: string
message:
type: string
code:
type: string
expected:
type: string
received:
type: number
required:
- path
- message
- code
required:
- success
- errors
CustomerUploadResourceURLResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
type: object
properties:
resourceUrl:
type: string
url:
type: string
parameters:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
required:
- name
- value
required:
- resourceURL
- url
- parameters
required:
- success
- payload
CustomerPayoutAccount:
type: object
properties:
customerId:
oneOf:
- type: string
- type: integer
payoutType:
$ref: '#/components/schemas/CustomerPayoutAccountType'
payoutDetails:
oneOf:
- $ref: '#/components/schemas/CustomerPayoutMobilePay'
- $ref: '#/components/schemas/CustomerPayoutBankAccount'
required:
- customerId
- payoutType
- payoutDetails
CustomerPayoutAccountType:
type: string
enum:
- MOBILE_PAY
- BANK_ACCOUNT
CustomerPayoutAccountCreateBody:
type: object
properties:
payoutType:
$ref: '#/components/schemas/CustomerPayoutAccountType'
payoutDetails:
oneOf:
- $ref: '#/components/schemas/CustomerPayoutMobilePay'
- $ref: '#/components/schemas/CustomerPayoutBankAccount'
required:
- payoutType
- payoutDetails
CustomerPayoutAccountCreateResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerPayoutAccount'
required:
- success
- payload
CustomerPayoutAccountDestroy:
type: object
properties:
deletedCount:
type: number
acknowledged:
type: boolean
required:
- deletedCount
- acknowledged
CustomerPayoutAccountDestroyResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerPayoutAccountDestroy'
required:
- success
- payload
CustomerPayoutAccountGetResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
allOf:
- $ref: '#/components/schemas/CustomerPayoutAccount'
nullable: true
required:
- success
- payload
CustomerPayoutMobilePay:
type: object
properties:
phoneNumber:
oneOf:
- type: string
- type: integer
required:
- phoneNumber
CustomerPayoutBankAccount:
type: object
properties:
bankName:
type: string
regNum:
type: integer
accountNum:
type: integer
required:
- bankName
- regNum
- accountNum
CustomerProductBase:
type: object
properties:
title:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomerProductOption'
productType:
type: string
description:
type: string
descriptionHtml:
type: string
productHandle:
type: string
productId:
type: number
variantId:
type: number
hideFromProfile:
type: boolean
hideFromCombine:
type: boolean
price:
type: object
properties:
amount:
type: string
currencyCode:
type: string
required:
- amount
- currencyCode
compareAtPrice:
type: object
properties:
amount:
type: string
currencyCode:
type: string
required:
- amount
- currencyCode
duration:
type: number
breakTime:
type: number
noticePeriod:
$ref: '#/components/schemas/CustomerProductNoticePeriod'
bookingPeriod:
$ref: '#/components/schemas/CustomerProductBookingPeriod'
required:
- variantId
- productId
- duration
- price
- compareAtPrice
- breakTime
- noticePeriod
- bookingPeriod
- options
- hideFromCombine
- hideFromProfile
- description
- descriptionHtml
CustomerProduct:
type: object
allOf:
- $ref: '#/components/schemas/CustomerProductBase'
- type: object
properties:
locations:
$ref: '#/components/schemas/CustomerProductLocations'
required:
- locations
CustomerProductBookingPeriod:
type: object
properties:
value:
type: number
unit:
$ref: '#/components/schemas/CustomerProductBookingUnit'
default: months
required:
- value
- unit
CustomerProductBookingUnit:
type: string
enum:
- weeks
- months
CustomerProductNoticePeriod:
type: object
properties:
value:
type: number
unit:
$ref: '#/components/schemas/CustomerProductNoticeUnit'
default: hours
required:
- value
- unit
CustomerProductNoticeUnit:
type: string
enum:
- hours
- days
- weeks
CustomerProductOption:
type: object
properties:
productId:
type: number
title:
type: string
variants:
type: array
items:
type: object
properties:
variantId:
type: number
title:
type: string
price:
type: string
duration:
type: object
properties:
value:
type: number
metafieldId:
type: number
required:
- value
- metafieldId
required:
- variantId
- duration
- title
- price
required:
- productId
- variants
- title
CustomerProductLocations:
type: array
items:
type: object
properties:
location:
type: string
locationType:
type: string
enum:
- home
- commercial
- destination
- virtual
required:
- location
- locationType
CustomerProductUpdateResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerProductList'
required:
- success
- payload
CustomerProductUpdateBody:
type: object
properties:
hideFromProfile:
type: string
hideFromCombine:
type: string
productType:
type: string
price:
type: object
properties:
amount:
type: string
currencyCode:
type: string
compareAtPrice:
type: object
properties:
amount:
type: string
currencyCode:
type: string
duration:
type: number
breakTime:
type: number
noticePeriod:
$ref: '#/components/schemas/CustomerProductNoticePeriod'
bookingPeriod:
$ref: '#/components/schemas/CustomerProductBookingPeriod'
locations:
$ref: '#/components/schemas/CustomerProductLocations'
title:
type: string
description:
type: string
descriptionHtml:
type: string
CustomerProductAddResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerProductList'
required:
- success
- payload
CustomerProductAddBody:
type: object
properties:
title:
type: string
productType:
type: string
description:
type: string
descriptionHtml:
type: string
locations:
$ref: '#/components/schemas/CustomerProductLocations'
scheduleId:
type: string
hideFromProfile:
type: string
hideFromCombine:
type: string
price:
type: object
properties:
amount:
type: string
currencyCode:
type: string
compareAtPrice:
type: object
properties:
amount:
type: string
currencyCode:
type: string
required:
- title
- productType
- description
- descriptionHtml
- scheduleId
- locations
- hideFromProfile
- hideFromCombine
- price
- compareAtPrice
CustomerProductDestroyResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
type: object
properties:
matchedCount:
type: number
modifiedCount:
type: number
upsertedCount:
type: number
required:
- matchedCount
- modifiedCount
- upsertedCount
required:
- success
- payload
CustomerProductGetResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerProductList'
required:
- success
- payload
CustomerProductOptionsUpdateResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerProductOption'
required:
- success
- payload
CustomerProductOptionsUpdateBody:
type: object
properties:
variants:
type: array
items:
type: object
properties:
id:
type: string
price:
type: string
duration:
type: string
required:
- id
- price
- duration
required:
- variants
CustomerProductOptionsList:
type: array
items:
$ref: '#/components/schemas/CustomerProductOption'
CustomerProductOptionsListResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerProductOptionsList'
required:
- success
- payload
CustomerProductOptionsAddResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerProductOption'
required:
- success
- payload
CustomerProductOptionsAddBody:
type: object
properties:
cloneId:
type: string
title:
type: string
required:
- cloneId
- title
CustomerProductOptionsDestroyResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
type: array
items:
$ref: '#/components/schemas/CustomerProductOption'
required:
- success
- payload
CustomerScheduleDestroy:
type: object
properties:
deletedCount:
type: number
acknowledged:
type: boolean
required:
- deletedCount
- acknowledged
CustomerScheduleSlotDay:
type: string
enum:
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- sunday
CustomerScheduleSlotInterval:
type: object
properties:
from:
type: string
to:
type: string
required:
- from
- to
CustomerScheduleSlot:
type: object
properties:
day:
$ref: '#/components/schemas/CustomerScheduleSlotDay'
intervals:
type: array
items:
$ref: '#/components/schemas/CustomerScheduleSlotInterval'
required:
- day
- intervals
CustomerSchedule:
type: object
properties:
_id:
type: string
name:
type: string
customerId:
type: number
slots:
type: array
items:
$ref: '#/components/schemas/CustomerScheduleSlot'
products:
type: array
items:
$ref: '#/components/schemas/CustomerProduct'
required:
- _id
- name
- customerId
- slots
- products
CustomerScheduleCreateBody:
type: object
properties:
name:
type: string
required:
- name
CustomerScheduleCreateResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerSchedule'
required:
- success
- payload
CustomerScheduleDestroyResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerScheduleDestroy'
required:
- success
- payload
CustomerScheduleListResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
type: array
items:
$ref: '#/components/schemas/CustomerSchedule'
required:
- success
- payload
CustomerScheduleGetResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerSchedule'
required:
- success
- payload
CustomerScheduleUpdateResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerSchedule'
required:
- success
- payload
CustomerScheduleUpdateBody:
type: object
properties:
name:
type: string
required:
- name
CustomerScheduleSlotsUpdateResponse:
type: object
properties:
success:
type: boolean
example: true
payload:
$ref: '#/components/schemas/CustomerSchedule'
required:
- success
- payload
CustomerScheduleSlotsUpdateBody:
type: object
properties:
slots:
type: array
items:
$ref: '#/components/schemas/CustomerScheduleSlot'
required:
- slots
CustomerBaseOrder:
type: object
properties:
id:
type: number
order_number:
type: number
admin_graphql_api_id:
type: string
buyer_accepts_marketing:
type: boolean
cancel_reason:
type: string
cancelled_at:
type: string
client_details:
$ref: '#/components/schemas/CustomerBaseOrderClient'
closed_at:
type: string
confirmed:
type: boolean
contact_email:
type: string
created_at:
type: string
currency:
type: string
current_subtotal_price:
type: string
current_subtotal_price_set:
$ref: '#/components/schemas/CustomerBaseOrderMoney'
current_total_additional_fees_set:
$ref: '#/components/schemas/CustomerBaseOrderMoney'
nullable: true
current_total_discounts:
type: string
current_total_discounts_set:
$ref: '#/components/schemas/CustomerBaseOrderMoney'
current_total_duties_set:
$ref: '#/components/schemas/CustomerBaseOrderMoney'
nullable: true
current_total_price:
type: string
current_total_price_set:
$ref: '#/components/schemas/CustomerBaseOrderMoney'
current_total_tax:
type: string
current_total_tax_set:
$ref: '#/components/schemas/CustomerBaseOrderMoney'
customer:
$ref: '#/components/schemas/CustomerBaseOrderCustomer'
fulfillments:
type: array
items:
$ref: '#/components/schemas/CustomerBaseOrderFulfillment'
refunds:
type: array
items:
$ref: '#/components/schemas/CustomerBaseOrderRefund'
shipping_address:
$ref: '#/components/schemas/CustomerBaseOrderAddress'
nullable: true
shipping_lines:
type: array
items:
type: object
properties:
id:
type: number
carrier_identifier:
type: string
code:
type: string
discounted_price:
type: string
discounted_price_set:
$ref: '#/components/schemas/CustomerBaseOrderMoney'
phone:
type: string
price:
type: string
price_set:
$ref: '#/components/schemas/CustomerBaseOrderMoney'
requested_fulfillment_service_id:
type: string
source:
type: string
title:
type: string
required:
- id
- discounted_price
- discounted_price_set
- price
- price_set
- source
- title
required:
- id
- admin_graphql_api_id
- buyer_accepts_marketing
- confirmed
- created_at
- currency
- customer
- current_subtotal_price
- current_subtotal_price_set
- current_total_discounts
- current_total_discounts_set
- current_total_price
- current_total_price_set
- current_total_tax
- current_total_tax_set
- fulfillments
- refunds
- shipping_lines
- order_number
CustomerBaseOrderMoney:
type: object
properties:
shop_money:
type: object
properties:
amount:
type: string
currency_code:
type: string
required:
- amount
- currency_code
presentment_money:
type: object
properties:
amount:
type: string
currency_code:
type: string
required:
- amount
- currency_code
required:
- shop_money
- presentment_money
CustomerBaseOrderAddress:
type: object
properties:
customer_id:
type: number
first_name:
type: string
address1:
type: string
phone:
type: string
city:
type: string
zip:
type: string
province:
type: string
country:
type: string
last_name:
type: string
address2:
type: string
company:
type: string
latitude:
type: number
longitude:
type: number
name:
type: string
country_code:
type: string
country_name:
type: string
province_code:
type: string
default:
type: boolean
required:
- first_name
- last_name
- name
- country_code
- default
CustomerBaseOrderClient:
type: object
properties:
accept_language:
type: string
browser_height:
type: number
browser_ip:
type: string
browser_width:
type: number
session_hash:
type: string
user_agent:
type: string
CustomerBaseOrderLineItemProperties:
type: object
properties:
customer_id:
type: number
from:
type: string
to:
type: string
locationId:
type: string
groupId:
type: string
shippingId:
type: string
required:
- from
- to
- customer_id
- locationId
- groupId
CustomerBaseOrderSimpleLineItem:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
- name
CustomerBaseOrderCustomer:
type: object
properties:
id:
type: number
email:
type: string
accepts_marketing:
type: boolean
created_at:
type: string
updated_at:
type: string
first_name:
type: string
last_name:
type: string
state:
type: string
note:
type: string