-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathOCTO API Specification.postman_collection.json
1567 lines (1567 loc) · 166 KB
/
OCTO API Specification.postman_collection.json
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
{
"info": {
"_postman_id": "57e45586-23d9-4da6-89da-32a1e01bd7b6",
"name": "OCTO API Specification",
"description": "OCTO (Open Connectivity for Tours, Activities, and Attractions) is an open standard API specification for the in-destination experiences sector of the travel industry. The standard defines agreed-upon schemas, endpoints, and capabilities commonly needed when connecting platforms, resellers, OTAs, and other technologies in tours, activities, and attractions. \n\nOCTO is open source. Available to anyone who wants to use it. You do not need to be a member to use this specification in your business.\n\nContact Support:\n Name: OCTO Standards NP Inc.\n Email: [email protected]",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "25119365"
},
"item": [
{
"name": "products",
"item": [
{
"name": "Get Products",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/products",
"host": [
"{{baseUrl}}"
],
"path": [
"products"
]
},
"description": "Fetch the list of products."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/products",
"host": [
"{{baseUrl}}"
],
"path": [
"products"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"locale\": \"<string>\",\n \"allowFreesale\": \"<boolean>\",\n \"instantConfirmation\": \"<boolean>\",\n \"instantDelivery\": \"<boolean>\",\n \"availabilityRequired\": \"<boolean>\",\n \"availabilityType\": \"<string>\",\n \"deliveryFormats\": [\n \"<string>\",\n \"<string>\"\n ],\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"redemptionMethod\": \"<string>\",\n \"options\": [\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n }\n ],\n \"timeZone\": \"<string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"locale\": \"<string>\",\n \"allowFreesale\": \"<boolean>\",\n \"instantConfirmation\": \"<boolean>\",\n \"instantDelivery\": \"<boolean>\",\n \"availabilityRequired\": \"<boolean>\",\n \"availabilityType\": \"<string>\",\n \"deliveryFormats\": [\n \"<string>\",\n \"<string>\"\n ],\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"redemptionMethod\": \"<string>\",\n \"options\": [\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n }\n ],\n \"timeZone\": \"<string>\"\n }\n]"
}
]
},
{
"name": "Get Product",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/products/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"products",
":id"
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) The product id"
}
]
},
"description": "Fetch the product for the given id."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/products/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"products",
":id"
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) The product id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"locale\": \"<string>\",\n \"allowFreesale\": \"<boolean>\",\n \"instantConfirmation\": \"<boolean>\",\n \"instantDelivery\": \"<boolean>\",\n \"availabilityRequired\": \"<boolean>\",\n \"availabilityType\": \"<string>\",\n \"deliveryFormats\": [\n \"<string>\",\n \"<string>\"\n ],\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"redemptionMethod\": \"<string>\",\n \"options\": [\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n }\n ],\n \"timeZone\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "availability",
"item": [
{
"name": "Availability Check",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"localDateStart\": \"<date>\",\n \"localDateEnd\": \"<date>\",\n \"availabilityIds\": [\n \"<string>\",\n \"<string>\"\n ],\n \"units\": [\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n },\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/availability",
"host": [
"{{baseUrl}}"
],
"path": [
"availability"
]
},
"description": "This endpoint is slightly slower as it will return an object for each individual departure time (or day). You have to perform this step to retrieve an `availabilityId` in order to confirm a sale, so if you just want to use this endpoint and skip the calendar endpoint then that's perfectly ok.\n\nYou must pass in one of the following combinations of parameters for this endpoint:\n- `localDate`\n- `localeDateStart` and `localDateEnd`\n- `availabilityIds`"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"localDateStart\": \"<date>\",\n \"localDateEnd\": \"<date>\",\n \"availabilityIds\": [\n \"<string>\",\n \"<string>\"\n ],\n \"units\": [\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n },\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/availability",
"host": [
"{{baseUrl}}"
],
"path": [
"availability"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"id\": \"<string>\",\n \"localDateTimeStart\": \"<dateTime>\",\n \"localDateTimeEnd\": \"<dateTime>\",\n \"allDay\": \"<boolean>\",\n \"available\": \"<boolean>\",\n \"status\": \"<string>\",\n \"vacancies\": \"<integer,null>\",\n \"capacity\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\",\n \"utcCutoffAt\": \"<string>\",\n \"openingHours\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"localDateTimeStart\": \"<dateTime>\",\n \"localDateTimeEnd\": \"<dateTime>\",\n \"allDay\": \"<boolean>\",\n \"available\": \"<boolean>\",\n \"status\": \"<string>\",\n \"vacancies\": \"<integer,null>\",\n \"capacity\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\",\n \"utcCutoffAt\": \"<string>\",\n \"openingHours\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n }\n]"
},
{
"name": "Example response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"localDateStart\": \"<date>\",\n \"localDateEnd\": \"<date>\",\n \"availabilityIds\": [\n \"<string>\",\n \"<string>\"\n ],\n \"units\": [\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n },\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/availability",
"host": [
"{{baseUrl}}"
],
"path": [
"availability"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\"\n}"
}
]
},
{
"name": "Availability Calendar",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"localDateStart\": \"<string>\",\n \"localDateEnd\": \"<string>\",\n \"units\": [\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n },\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/availability/calendar",
"host": [
"{{baseUrl}}"
],
"path": [
"availability",
"calendar"
]
},
"description": "This endpoint is highly optimised and will return a single object per day. It's designed to be queried for large date ranges and the result is used to populate an availability calendar.\n\nWhen the end user selects an open date you can call on `/availability` endpoint to get the `availabilityId` to create the booking."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"localDateStart\": \"<string>\",\n \"localDateEnd\": \"<string>\",\n \"units\": [\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n },\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/availability/calendar",
"host": [
"{{baseUrl}}"
],
"path": [
"availability",
"calendar"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"localDate\": \"<date>\",\n \"available\": \"<boolean>\",\n \"status\": \"<string>\",\n \"vacancies\": \"<integer,null>\",\n \"capacity\": \"<integer,null>\",\n \"openingHours\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n },\n {\n \"localDate\": \"<date>\",\n \"available\": \"<boolean>\",\n \"status\": \"<string>\",\n \"vacancies\": \"<integer,null>\",\n \"capacity\": \"<integer,null>\",\n \"openingHours\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n }\n]"
},
{
"name": "Example response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"localDateStart\": \"<string>\",\n \"localDateEnd\": \"<string>\",\n \"units\": [\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n },\n {\n \"id\": \"<string>\",\n \"quantity\": \"<integer>\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/availability/calendar",
"host": [
"{{baseUrl}}"
],
"path": [
"availability",
"calendar"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "bookings",
"item": [
{
"name": "{uuid}",
"item": [
{
"name": "Get Booking",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
},
"description": "Fetch the status of an existing booking."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"<string>\",\n \"uuid\": \"<uuid>\",\n \"testMode\": \"<boolean>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"status\": \"<string>\",\n \"utcCreatedAt\": \"<string>\",\n \"utcUpdatedAt\": \"<string,null>\",\n \"utcExpiresAt\": \"<string,null>\",\n \"utcRedeemedAt\": \"<string,null>\",\n \"utcConfirmedAt\": \"<string,null>\",\n \"productId\": \"<string>\",\n \"product\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"locale\": \"<string>\",\n \"allowFreesale\": \"<boolean>\",\n \"instantConfirmation\": \"<boolean>\",\n \"instantDelivery\": \"<boolean>\",\n \"availabilityRequired\": \"<boolean>\",\n \"availabilityType\": \"<string>\",\n \"deliveryFormats\": [\n \"<string>\",\n \"<string>\"\n ],\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"redemptionMethod\": \"<string>\",\n \"options\": [\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n }\n ],\n \"timeZone\": \"<string>\"\n },\n \"optionId\": \"<string>\",\n \"option\": {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n \"cancellable\": \"<boolean>\",\n \"cancellation\": {\n \"refund\": \"<string>\",\n \"reason\": \"<null,string>\",\n \"utcCancelledAt\": \"<string>\"\n },\n \"freesale\": \"<boolean>\",\n \"availabilityId\": \"<string>\",\n \"availability\": {\n \"id\": \"<string>\",\n \"localDateTimeStart\": \"<string>\",\n \"localDateTimeEnd\": \"<string>\",\n \"allDay\": \"<boolean>\",\n \"openingHours\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n },\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"notes\": \"<string,null>\",\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"unitItems\": [\n {\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"unitId\": \"<string>\",\n \"unit\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n \"status\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"ticket\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n },\n {\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"unitId\": \"<string>\",\n \"unit\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n \"status\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"ticket\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"voucher\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n}"
},
{
"name": "Example response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"<string>\"\n}"
}
]
},
{
"name": "Booking Cancellation",
"request": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reason\": \"<string>\",\n \"force\": \"<boolean>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
},
"description": "For cancelling bookings. You can only cancel a booking if `booking.cancellable` is `TRUE`, and is within the booking cancellation cut-off window."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"description": "Required field on all DELETE requests",
"key": "Content-Type",
"value": "<string>"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reason\": \"<string>\",\n \"force\": \"<boolean>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"<string>\",\n \"uuid\": \"<uuid>\",\n \"testMode\": \"<boolean>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"status\": \"<string>\",\n \"utcCreatedAt\": \"<string>\",\n \"utcUpdatedAt\": \"<string,null>\",\n \"utcExpiresAt\": \"<string,null>\",\n \"utcRedeemedAt\": \"<string,null>\",\n \"utcConfirmedAt\": \"<string,null>\",\n \"productId\": \"<string>\",\n \"product\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"locale\": \"<string>\",\n \"allowFreesale\": \"<boolean>\",\n \"instantConfirmation\": \"<boolean>\",\n \"instantDelivery\": \"<boolean>\",\n \"availabilityRequired\": \"<boolean>\",\n \"availabilityType\": \"<string>\",\n \"deliveryFormats\": [\n \"<string>\",\n \"<string>\"\n ],\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"redemptionMethod\": \"<string>\",\n \"options\": [\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n }\n ],\n \"timeZone\": \"<string>\"\n },\n \"optionId\": \"<string>\",\n \"option\": {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n \"cancellable\": \"<boolean>\",\n \"cancellation\": {\n \"refund\": \"<string>\",\n \"reason\": \"<null,string>\",\n \"utcCancelledAt\": \"<string>\"\n },\n \"freesale\": \"<boolean>\",\n \"availabilityId\": \"<string>\",\n \"availability\": {\n \"id\": \"<string>\",\n \"localDateTimeStart\": \"<string>\",\n \"localDateTimeEnd\": \"<string>\",\n \"allDay\": \"<boolean>\",\n \"openingHours\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n },\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"notes\": \"<string,null>\",\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"unitItems\": [\n {\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"unitId\": \"<string>\",\n \"unit\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n \"status\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"ticket\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n },\n {\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"unitId\": \"<string>\",\n \"unit\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n \"status\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"ticket\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"voucher\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n}"
},
{
"name": "Example response",
"originalRequest": {
"method": "DELETE",
"header": [
{
"description": "Required field on all DELETE requests",
"key": "Content-Type",
"value": "<string>"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"reason\": \"<string>\",\n \"force\": \"<boolean>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"uuid\": \"<string>\"\n}"
}
]
},
{
"name": "Booking Update",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"resellerReference\": \"<string>\",\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"availabilityId\": \"<string>\",\n \"expirationMinutes\": \"<string>\",\n \"notes\": \"<string>\",\n \"emailReceipt\": \"<boolean>\",\n \"unitItems\": [\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n },\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n }\n ],\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
},
"description": "Updates a booking before and after it has been confirmed as long as it hasn''t been redeemed or within the cancellation cutoff window. To know if the booking can be updated check the booking''s `cancellable` field. If the booking can be cancelled, it can also be updated. It''s generally preferred to update a booking rather than cancelling it and rebooking."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Required field on all PATCH requests",
"key": "Content-Type",
"value": "<string>"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"resellerReference\": \"<string>\",\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"availabilityId\": \"<string>\",\n \"expirationMinutes\": \"<string>\",\n \"notes\": \"<string>\",\n \"emailReceipt\": \"<boolean>\",\n \"unitItems\": [\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n },\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n }\n ],\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"<string>\",\n \"uuid\": \"<uuid>\",\n \"testMode\": \"<boolean>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"status\": \"<string>\",\n \"utcCreatedAt\": \"<string>\",\n \"utcUpdatedAt\": \"<string,null>\",\n \"utcExpiresAt\": \"<string,null>\",\n \"utcRedeemedAt\": \"<string,null>\",\n \"utcConfirmedAt\": \"<string,null>\",\n \"productId\": \"<string>\",\n \"product\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"locale\": \"<string>\",\n \"allowFreesale\": \"<boolean>\",\n \"instantConfirmation\": \"<boolean>\",\n \"instantDelivery\": \"<boolean>\",\n \"availabilityRequired\": \"<boolean>\",\n \"availabilityType\": \"<string>\",\n \"deliveryFormats\": [\n \"<string>\",\n \"<string>\"\n ],\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"redemptionMethod\": \"<string>\",\n \"options\": [\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n }\n ],\n \"timeZone\": \"<string>\"\n },\n \"optionId\": \"<string>\",\n \"option\": {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n \"cancellable\": \"<boolean>\",\n \"cancellation\": {\n \"refund\": \"<string>\",\n \"reason\": \"<null,string>\",\n \"utcCancelledAt\": \"<string>\"\n },\n \"freesale\": \"<boolean>\",\n \"availabilityId\": \"<string>\",\n \"availability\": {\n \"id\": \"<string>\",\n \"localDateTimeStart\": \"<string>\",\n \"localDateTimeEnd\": \"<string>\",\n \"allDay\": \"<boolean>\",\n \"openingHours\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n },\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"notes\": \"<string,null>\",\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"unitItems\": [\n {\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"unitId\": \"<string>\",\n \"unit\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n \"status\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"ticket\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n },\n {\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"unitId\": \"<string>\",\n \"unit\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n \"status\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"ticket\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"voucher\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n}"
},
{
"name": "Example response",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Required field on all PATCH requests",
"key": "Content-Type",
"value": "<string>"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"resellerReference\": \"<string>\",\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"availabilityId\": \"<string>\",\n \"expirationMinutes\": \"<string>\",\n \"notes\": \"<string>\",\n \"emailReceipt\": \"<boolean>\",\n \"unitItems\": [\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n },\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n }\n ],\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\"\n}"
}
]
},
{
"name": "Booking Confirmation",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{bearerToken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"emailReceipt\": \"<boolean>\",\n \"resellerReference\": \"<string>\",\n \"unitItems\": [\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n },\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid",
"confirm"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
},
"description": "This endpoint confirms the booking so it's ready to be used."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: bearer",
"key": "Authorization",
"value": "Bearer <token>"
},
{
"description": "Required field on all POST requests",
"key": "Content-Type",
"value": "<string>"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"emailReceipt\": \"<boolean>\",\n \"resellerReference\": \"<string>\",\n \"unitItems\": [\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n },\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid",
"confirm"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"<string>\",\n \"uuid\": \"<uuid>\",\n \"testMode\": \"<boolean>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"status\": \"<string>\",\n \"utcCreatedAt\": \"<string>\",\n \"utcUpdatedAt\": \"<string,null>\",\n \"utcExpiresAt\": \"<string,null>\",\n \"utcRedeemedAt\": \"<string,null>\",\n \"utcConfirmedAt\": \"<string,null>\",\n \"productId\": \"<string>\",\n \"product\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"locale\": \"<string>\",\n \"allowFreesale\": \"<boolean>\",\n \"instantConfirmation\": \"<boolean>\",\n \"instantDelivery\": \"<boolean>\",\n \"availabilityRequired\": \"<boolean>\",\n \"availabilityType\": \"<string>\",\n \"deliveryFormats\": [\n \"<string>\",\n \"<string>\"\n ],\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"redemptionMethod\": \"<string>\",\n \"options\": [\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n }\n ],\n \"timeZone\": \"<string>\"\n },\n \"optionId\": \"<string>\",\n \"option\": {\n \"id\": \"<string>\",\n \"default\": \"<boolean>\",\n \"internalName\": \"<string>\",\n \"reference\": \"<null,string>\",\n \"availabilityLocalStartTimes\": [\n \"00:00\",\n \"00:00\"\n ],\n \"cancellationCutoff\": \"<string>\",\n \"cancellationCutoffAmount\": \"<integer>\",\n \"cancellationCutoffUnit\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minUnits\": \"<integer,null>\",\n \"maxUnits\": \"<integer,null>\"\n },\n \"units\": [\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n }\n ]\n },\n \"cancellable\": \"<boolean>\",\n \"cancellation\": {\n \"refund\": \"<string>\",\n \"reason\": \"<null,string>\",\n \"utcCancelledAt\": \"<string>\"\n },\n \"freesale\": \"<boolean>\",\n \"availabilityId\": \"<string>\",\n \"availability\": {\n \"id\": \"<string>\",\n \"localDateTimeStart\": \"<string>\",\n \"localDateTimeEnd\": \"<string>\",\n \"allDay\": \"<boolean>\",\n \"openingHours\": [\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n ]\n },\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"notes\": \"<string,null>\",\n \"deliveryMethods\": [\n \"<string>\",\n \"<string>\"\n ],\n \"unitItems\": [\n {\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"unitId\": \"<string>\",\n \"unit\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n \"status\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"ticket\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n },\n {\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string,null>\",\n \"supplierReference\": \"<string,null>\",\n \"unitId\": \"<string>\",\n \"unit\": {\n \"id\": \"<string>\",\n \"internalName\": \"<string>\",\n \"type\": \"<string>\",\n \"requiredContactFields\": [\n \"<string>\",\n \"<string>\"\n ],\n \"restrictions\": {\n \"minAge\": \"<integer>\",\n \"maxAge\": \"<integer>\",\n \"idRequired\": \"<boolean>\",\n \"minQuantity\": \"<integer,null>\",\n \"maxQuantity\": \"<null,integer>\",\n \"paxCount\": \"<integer>\",\n \"accompaniedBy\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"reference\": \"<null,string>\"\n },\n \"status\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"contact\": {\n \"fullName\": \"<null,string>\",\n \"firstName\": \"<null,string>\",\n \"lastName\": \"<null,string>\",\n \"emailAddress\": \"<null,string-email>\",\n \"phoneNumber\": \"<null,string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<null,string>\",\n \"country\": \"<null,string>\",\n \"notes\": \"<null,string>\"\n },\n \"ticket\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n }\n ],\n \"voucher\": {\n \"redemptionMethod\": \"<string>\",\n \"utcRedeemedAt\": \"<null,string>\",\n \"deliveryOptions\": [\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n },\n {\n \"deliveryFormat\": \"<string>\",\n \"deliveryValue\": \"<string>\"\n }\n ]\n }\n}"
},
{
"name": "Example response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: bearer",
"key": "Authorization",
"value": "Bearer <token>"
},
{
"description": "Required field on all POST requests",
"key": "Content-Type",
"value": "<string>"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<email>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n },\n \"emailReceipt\": \"<boolean>\",\n \"resellerReference\": \"<string>\",\n \"unitItems\": [\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n },\n {\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\",\n \"resellerReference\": \"<string>\",\n \"contact\": {\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"locales\": [\n \"<string>\",\n \"<string>\"\n ],\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/bookings/:uuid/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
"bookings",
":uuid",
"confirm"
],
"variable": [
{
"key": "uuid",
"value": "<string>",
"description": "(Required) The UUID of the booking"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"productId\": \"<string>\",\n \"optionId\": \"<string>\",\n \"unitId\": \"<string>\",\n \"uuid\": \"<string>\"\n}"
}
]
},
{
"name": "Extend Reservation",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{bearerToken}}",
"type": "string"
}
]