-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathopen-api.json
2603 lines (2603 loc) · 118 KB
/
open-api.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
{
"openapi": "3.0.0",
"info": {
"title": "Trivago Express Booking API",
"description": "Trivago Express Booking API",
"contact": {
"email": "[email protected]"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.0"
},
"servers": [
{
"url": "{schema}://advertiser-site.com/api_implementation",
"description": "Booking availability",
"variables": {
"schema": {
"enum": [
"https",
"http"
],
"default": "https"
}
}
}
],
"paths": {
"/booking_availability": {
"post": {
"tags": [
"Booking"
],
"summary": "Trivago Express Booking API",
"description": "To check if an advertised offer is still bookable trivago sends out \"/booking_availability\" POST requests to the advertiser's API. When the booking availability results are returned, they are presented to the user on the trivago Express Booking landing page opened in an additional browser window. The user can then choose the offer they want to book. Please click on one of the flags below to see how the trivago Express Booking landing page would look like for the corresponding point of sale.",
"operationId": "booking-availability",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/booking-availability-request"
}
}
}
},
"responses": {
"200": {
"description": "Booking Availability Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-availability-response"
}
}
}
}
}
}
},
"/booking_prepare": {
"post": {
"tags": [
"Booking"
],
"summary": "Trivago Express Booking API",
"description": "If advertisers cannot provide non-cached rates or all required information (e.g. cancellation policy) in the booking_availability, trivago can optionally submit a \"/booking_prepare\" POST request to the advertiser's API. This request is submitted once users have selected a room after viewing the booking availability results and are being redirected to the trivago Express Booking checkout page where they fill in their details being mandatory to make a booking.",
"operationId": "booking-prepare",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-prepare-request"
}
}
}
},
"responses": {
"200": {
"description": "Booking Prepare Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-prepare-response"
}
}
}
}
}
}
},
"/booking_submit": {
"post": {
"tags": [
"Booking"
],
"summary": "Trivago Express Booking API",
"description": "To submit a booking, trivago sends out a \"/booking_submit\" POST request to the advertiser's API. Once users have selected a room after viewing the booking availability results, they go to the next step of the booking process where they fill in their details being mandatory to make a booking. These details are then sent to the advertiser's endpoint as part of the booking submit request.",
"operationId": "booking-submit",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-submit-request"
}
}
}
},
"responses": {
"200": {
"description": "Booking Submit Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-submit-response"
}
}
}
}
}
}
},
"/booking_payment_authorise": {
"post": {
"tags": [
"Booking"
],
"summary": "Trivago Express Booking API",
"description": "If additional information is needed to authorise a booking, trivago sends out a \"/booking_payment_authorise\" POST request to the advertiser's API.",
"operationId": "booking-payment-authorise",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-payment-authorise-request"
}
}
}
},
"responses": {
"200": {
"description": "Booking Payment Authorise Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-payment-authorise-response"
}
}
}
}
}
}
},
"/booking_verify": {
"get": {
"tags": [
"Booking"
],
"summary": "Trivago Express Booking API",
"description": "In order to check if a booking has been submitted successfully, trivago also offers the possibility to immediately verify the booking status once the booking has been confirmed by sending an additional \"/booking_verify\" request.\nBesides this, the **\"/booking_verify\"** GET request can be used to update trivago about any changes of the booking that have occurred on the hotel/property system. So in an upcoming feature where the booking status of a booking submitted via trivago Express booking, trivago will send out daily a \"/booking_verify\" GET request to the advertiser's API in order to verify which bookings have actually been consumed, cancelled or modified.\nSo for example, if a user decides to cancel a tEB booking over the customer service hotline, trivago would be able to update the booking status by doing daily \"/booking_verify\" requests.",
"operationId": "booking-verify",
"parameters": [
{
"$ref": "#/components/parameters/reference_id"
},
{
"$ref": "#/components/parameters/reservation_id"
},
{
"$ref": "#/components/parameters/partner_reference"
}
],
"responses": {
"200": {
"description": "Booking Verify Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-verify-response"
}
}
}
}
}
}
},
"/booking_cancel": {
"post": {
"tags": [
"Booking"
],
"summary": "Trivago Express Booking API",
"description": "In an upcoming feature, users will be able to cancel a booking through the trivago member area. Trivago will then send out a \"/booking_cancel\" POST request to the advertiser's API.",
"operationId": "booking-cancel",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-cancel-request"
}
}
}
},
"responses": {
"200": {
"description": "Booking Cancellation Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/booking-cancel-response"
}
}
}
}
},
"deprecated": true
}
}
},
"components": {
"schemas": {
"booking-availability-request": {
"title": "Booking Availability Request",
"description": "Schema of booking availability request object",
"required": [
"api_version",
"hotel",
"start_date",
"end_date",
"party",
"lang",
"currency",
"user_country"
],
"properties": {
"api_version": {
"description": "Version of the API used.",
"type": "integer",
"example": 1
},
"hotel": {
"$ref": "#/components/schemas/hotel"
},
"start_date": {
"description": "The user's check-in date in YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"end_date": {
"description": "The user's check-out date in YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2019-01-02"
},
"party": {
"description": "Array of JSON objects inlcuding number of adults and children requested.\nEach party object represents the occupation for a separate room.\nFor example, \"party\":[{\"adults\": 3}] is a request for one room that accommodates three adults,\nor \"party\":[{\"adults\": 2},{\"adults\": 2, \"children\": [11,8]}] is a request for one room for two adults\nand one room for two adults and two children aged 11 and 8.",
"type": "array",
"items": {
"$ref": "#/components/schemas/party"
},
"minItems": 1
},
"lang": {
"description": "Language code (see Supported Languages)[http://developer.trivago.com/expressbooking/supported-languages.html], which identifies the corresponding language and POS.",
"type": "string",
"example": "en_US"
},
"currency": {
"description": "ISO 4217 currency code. All prices, taxes, fees, and discount amounts should be returned in this requested currency.",
"type": "string",
"example": "USD"
},
"user_country": {
"description": "ISO 3166-1 alpha-2 country code corresponding to the user making this request.",
"type": "string",
"example": "US"
}
},
"type": "object"
},
"booking-availability-response-success": {
"title": "Booking Availability Ok",
"description": "Schema Booking availability when response is OK",
"required": [
"api_version",
"hotel_id",
"start_date",
"end_date",
"party",
"lang",
"user_country",
"room_types_array",
"customer_support"
],
"properties": {
"api_version": {
"description": "Version of the API used.",
"type": "integer",
"example": 1
},
"customer_support": {
"$ref": "#/components/schemas/customer-support"
},
"hotel_id": {
"description": "Echo the item_id (not partner_reference) provided by trivago in the corresponding request.",
"type": "integer"
},
"room_types_array": {
"description": "An array of objects detailing the different kinds of rooms that are available for the entire party.\nThe short description must be unique for each room type available in the hotel.",
"type": "array",
"items": {
"$ref": "#/components/schemas/room-type"
}
},
"hotel_details": {
"$ref": "#/components/schemas/hotel-details"
},
"accepted_credit_cards": {
"description": "Accepted Credit Cards",
"type": "array",
"items": {
"type": "string"
}
},
"terms_and_conditions": {
"description": "General terms and conditions.\nText field.\nLength limit of 1000 characters.",
"type": "string"
},
"terms_and_conditions_url": {
"description": "Link to the advertiser's terms and conditions page.",
"type": "string"
},
"payment_policy": {
"description": "Describes how the advertiser will use the credit card information, e.g. charged immediately or hold.\nText field.\nLength limit of 1000 characters.",
"type": "string"
},
"other_policy": {
"description": "Miscellaneous policies\nText field.\nLength limit of 1000 characters.",
"type": "string"
},
"errors": {
"description": "Array of errors",
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
}
},
"query_key": {
"description": "Query Key",
"type": "string",
"deprecated": true
},
"device_type": {
"description": "Device Type",
"type": "string",
"deprecated": true
},
"start_date": {
"description": "The user's check-in date in YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"end_date": {
"description": "The user's check-out date in YYYY-MM-DD",
"type": "string",
"format": "date",
"example": "2019-01-02"
},
"party": {
"description": "Array of JSON objects inlcuding number of adults and children requested.\nEach party object represents the occupation for a separate room.\nFor example, \"party\":[{\"adults\": 3}] is a request for one room that accommodates three adults,\nor \"party\":[{\"adults\": 2},{\"adults\": 2, \"children\": [11,8]}] is a request for one room for two adults\nand one room for two adults and two children aged 11 and 8.",
"type": "array",
"items": {
"$ref": "#/components/schemas/party"
},
"minItems": 1
},
"lang": {
"description": "Language code (see Supported Languages)[http://developer.trivago.com/expressbooking/supported-languages.html], which identifies the corresponding language and POS.",
"type": "string",
"example": "en_US"
},
"currency": {
"description": "ISO 4217 currency code. All prices, taxes, fees, and discount amounts should be returned in this requested currency.",
"type": "string",
"example": "USD"
},
"user_country": {
"description": "ISO 3166-1 alpha-2 country code corresponding to the user making this request.",
"type": "string",
"example": "US"
}
},
"type": "object"
},
"booking-availability-response": {
"title": "Booking Availability",
"description": "Schema of an booking availability.",
"oneOf": [
{
"$ref": "#/components/schemas/booking-availability-response-success"
},
{
"$ref": "#/components/schemas/error-response"
}
]
},
"booking-cancel-request": {
"description": "Schema of booking cancel request object",
"required": [
"partner_reference",
"reservation_id"
],
"properties": {
"reservation_id": {
"description": "The advertiser's unique id for this reservation. Must be used as booking_id in the tracking pixel.",
"type": "string",
"example": "XXX123"
},
"partner_reference": {
"description": "The advertiser's unique identifier for this hotel. In a \"/booking_submit\" request this should be the same as\nin the request.",
"type": "string",
"example": "1"
}
},
"type": "object"
},
"booking-cancel-response": {
"title": "Booking Cancel",
"description": "Schema of a booking cancellation.",
"required": [
"partner_reference",
"reservation_id",
"status",
"cancellation_number",
"customer_support"
],
"properties": {
"customer_support": {
"$ref": "#/components/schemas/customer-support"
},
"reservation_id": {
"description": "The advertiser's unique id for this reservation. Must be used as booking_id in the tracking pixel.",
"type": "string",
"example": "XXX123"
},
"partner_reference": {
"description": "The advertiser's unique identifier for this hotel. In a \"/booking_submit\" request this should be the same as\nin the request.",
"type": "string",
"example": "1"
},
"status": {
"enum": [
"Success",
"AlreadyCancelled",
"UnknownReference",
"CannotBeCancelled",
"Error"
],
"example": "Success"
},
"cancellation_number": {
"description": "Unique identifier for the cancellation. Required if status is \"Success\" or \"AlreadyCancelled.\"",
"type": "string",
"example": "12345678"
}
},
"type": "object"
},
"booking-payment-authorise-request": {
"title": "Booking Payment Confirm Request",
"description": "Schema of an booking payment confirm request.",
"required": [
"api_version",
"reservation_id",
"callback_parameters",
"partner_data"
],
"properties": {
"api_version": {
"description": "Version of the API used.",
"type": "integer",
"example": 1
},
"reservation_id": {
"description": "The advertiser's unique id for the reservation.",
"type": "string",
"example": "1234"
},
"callback_parameters": {
"description": "Params added by the PSP to the callback URL.",
"type": "string",
"example": "a=1&b=2"
},
"partner_data": {
"$ref": "#/components/schemas/partner-data"
}
},
"type": "object",
"additionalProperties": false
},
"booking-payment-authorise-response": {
"title": "Booking Payment Confirm",
"description": "Schema of an booking payment confirm.",
"required": [
"reference_id",
"status",
"customer_support"
],
"properties": {
"customer_support": {
"$ref": "#/components/schemas/customer-support"
},
"status": {
"enum": [
"Success",
"Failure",
"UnknownReference"
],
"example": "Success"
},
"problems": {
"description": "An array containing issues that occurred\nRequired, if status = \"Failure.\"\nOptional, if status = \"Success\"",
"type": "array",
"items": {
"$ref": "#/components/schemas/problem"
}
},
"reference_id": {
"description": "Echo the reference_id provided by trivago in the corresponding request. If the request fails\n(timeout or otherwise), this id can be used in a booking verification request to determine if the call\nwas successful.",
"type": "string",
"example": "692e8acc-d1d9-45dc-b50f-e7b824f3306f"
},
"reservation": {
"$ref": "#/components/schemas/reservation"
}
},
"type": "object"
},
"booking-prepare-request": {
"title": "Booking Prepare",
"description": "Schema of a booking preparation request.",
"required": [
"checkin_date",
"checkout_date",
"partner_reference",
"reference_id",
"partner_data",
"party"
],
"properties": {
"api_version": {
"description": "Version of the API used.",
"type": "integer",
"example": 1
},
"reference_id": {
"description": "trivago identifier for the booking session. Please consider that this id might not be unique and should not be treated as a \"confirmation\" id.",
"type": "string",
"example": "692e8acc-d1d9-45dc-b50f-e7b824f3306f"
},
"partner_data": {
"$ref": "#/components/schemas/partner-data"
},
"party": {
"description": "An array of Party",
"type": "array",
"items": {
"$ref": "#/components/schemas/party"
},
"minItems": 1
},
"checkin_date": {
"description": "The user's check-in date in YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"checkout_date": {
"description": "The user's check-out date in YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2019-01-02"
},
"partner_reference": {
"description": "Advertiser's unique hotel id.",
"type": "string",
"example": "1"
}
},
"type": "object"
},
"booking-prepare-response-available": {
"title": "Booking Prepare Available",
"description": "Schema of a booking preparation.",
"required": [
"status",
"checkin_date",
"checkout_date",
"partner_reference",
"room_type",
"customer_support"
],
"properties": {
"customer_support": {
"$ref": "#/components/schemas/customer-support"
},
"status": {
"enum": [
"ADJUSTED",
"AVAILABLE",
"SOLD_OUT"
],
"example": "AVAILABLE"
},
"room_type": {
"$ref": "#/components/schemas/room-type"
},
"checkin_date": {
"description": "The user's check-in date in YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"checkout_date": {
"description": "The user's check-out date in YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2019-01-02"
},
"partner_reference": {
"description": "Advertiser's unique hotel id.",
"type": "string",
"example": "1"
}
},
"type": "object"
},
"booking-prepare-response": {
"title": "Booking Prepare",
"description": "Schema of a booking preparation.",
"oneOf": [
{
"$ref": "#/components/schemas/booking-prepare-response-available"
},
{
"$ref": "#/components/schemas/booking-prepare-response-sold-out"
}
]
},
"booking-prepare-response-sold-out": {
"title": "Booking Prepare Sold-Out",
"description": "Schema of a booking preparation.",
"required": [
"checkin_date",
"checkout_date",
"partner_reference",
"status",
"customer_support"
],
"properties": {
"status": {
"description": "Specifies the status of the Prepare response:\n- SOLD_OUT",
"type": "string",
"enum": [
"SOLD_OUT"
],
"example": "SOLD_OUT"
},
"customer_support": {
"$ref": "#/components/schemas/customer-support"
},
"checkin_date": {
"description": "The user's check-in date in YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"checkout_date": {
"description": "The user's check-out date in YYYY-MM-DD.",
"type": "string",
"format": "date",
"example": "2019-01-02"
},
"partner_reference": {
"description": "Advertiser's unique hotel id.",
"type": "string",
"example": "1"
}
},
"type": "object"
},
"booking-submit-request": {
"title": "Booking Submit Request",
"description": "Schema of an booking submit request.",
"required": [
"checkin_date",
"checkout_date",
"partner_reference",
"customer",
"rooms",
"final_price_at_booking",
"final_price_at_checkout",
"partner_data"
],
"properties": {
"api_version": {
"description": "Version of the API used.",
"type": "integer",
"example": 1
},
"checkin_date": {
"description": "The user's check-in date in YYYY-MM-DD.\nThe check-in date of the traveler.",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"checkout_date": {
"description": "The user's check-out date in YYYY-MM-DD.\nThe check-out date of the traveler.",
"type": "string",
"format": "date",
"example": "2019-01-02"
},
"partner_reference": {
"description": "Advertiser's unique hotel id.\nPartner hotel id.",
"type": "string",
"example": "1"
},
"ip_address": {
"description": "Sending IP address.",
"type": "string"
},
"reference_id": {
"description": "trivago identifier for the booking session. Please consider that this id might not be unique and should not be\ntreated as a \"confirmation\" id. Identifier for the booking session",
"type": "string",
"example": "692e8acc-d1d9-45dc-b50f-e7b824f3306f"
},
"customer": {
"$ref": "#/components/schemas/customer"
},
"rooms": {
"description": "An array of rooms to be booked.",
"type": "array",
"items": {
"$ref": "#/components/schemas/room-stay"
},
"minItems": 1
},
"payment_method": {
"description": "An object containing the credit card details for payment of the reservation.",
"$ref": "#/components/schemas/booking-submit-request-payment-method"
},
"payment": {
"description": "Defines the selected payment method of the user.",
"$ref": "#/components/schemas/payment"
},
"final_price_at_booking": {
"description": "An object containing the entire price to be paid at time of booking, including taxes and fees.\\nThis will be used to validate the line items.",
"example": {
"amount": 100,
"currency": "USD"
},
"$ref": "#/components/schemas/price"
},
"final_price_at_checkout": {
"description": "An object containing the entire price to be paid at time of stay, including taxes and fees.\\nThis will be used to validate the line items. If the full price is paid at the time of booking,\\nthis element must still be included, with an amount of 0 or 0.00.",
"example": {
"amount": 5,
"currency": "USD"
},
"$ref": "#/components/schemas/price"
},
"partner_data": {
"$ref": "#/components/schemas/partner-data"
},
"tracking_data": {
"description": "Enables advertisers to receive specific information for tracking purpose. Fields supported here can be static fields as given by advertiser or can be dynamic fields as supported for tracking pixel which can be fired from express landing page. Refer here for tracking parameters supported from trivago side at submit e.g:\n\"tracking_data\": {\n\"actor\": \"trivago\",\n\"tracking_id\": \"3125354\"\n}",
"example": {
"actor": "trivago",
"advLink": "http://advertiser-site.com/hoteladlon/Executive_Brilliant_Doppelzimmer?start_date=2016-12-28&end_date=2016-12-29"
}
},
"user_agent": {
"description": "Customer User Agent.",
"type": "string",
"example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.169 Safari/537.36"
}
},
"type": "object",
"additionalProperties": false
},
"booking-submit-response": {
"title": "Booking Submit Response",
"description": "Schema of booking submit response.",
"required": [
"reference_id",
"status",
"customer_support"
],
"properties": {
"customer_support": {
"$ref": "#/components/schemas/customer-support"
},
"status": {
"enum": [
"Success",
"Failure",
"PaymentPending",
"UnknownReference"
],
"example": "Success"
},
"authorisation": {
"$ref": "#/components/schemas/authorisation"
},
"problems": {
"description": "An array containing issues that occurred\nRequired, if status = \"Failure.\"\nOptional, if status = \"Success\"",
"type": "array",
"items": {
"$ref": "#/components/schemas/problem"
}
},
"reference_id": {
"description": "Echo the reference_id provided by trivago in the corresponding request. If the request fails\n(timeout or otherwise), this id can be used in a booking verification request to determine if the call\nwas successful.",
"type": "string",
"example": "692e8acc-d1d9-45dc-b50f-e7b824f3306f"
},
"reservation": {
"$ref": "#/components/schemas/reservation"
}
},
"type": "object"
},
"booking-verify-request": {
"description": "Schema of booking verify request object",
"required": [
"partner_reference",
"reservation_id",
"reference_id"
],
"properties": {
"reservation_id": {
"description": "The advertiser's unique id for this reservation. Must be used as booking_id in the tracking pixel.",
"type": "string",
"example": "XXX123"
},
"partner_reference": {
"description": "The advertiser's unique identifier for this hotel. In a \"/booking_submit\" request this should be the same as\nin the request.",
"type": "string",
"example": "1"
},
"reference_id": {
"description": "trivago identifier for the booking session. Please consider that this id might not be unique and should not be\ntreated as a \"confirmation\" id.",
"type": "string",
"example": "692e8acc-d1d9-45dc-b50f-e7b824f3306f"
}
},
"type": "object"
},
"booking-verify-response": {
"title": "Booking Verify",
"description": "Schema of an booking verify.",
"required": [
"reference_id",
"status",
"customer_support"
],
"properties": {
"customer_support": {
"$ref": "#/components/schemas/customer-support"
},
"status": {
"enum": [
"Success",
"Failure",
"PaymentPending",
"UnknownReference"
],
"example": "Success"
},
"problems": {
"description": "An array containing issues that occurred\nRequired, if status = \"Failure.\"\nOptional, if status = \"Success\"",
"type": "array",
"items": {
"$ref": "#/components/schemas/problem"
}
},
"reference_id": {
"description": "Echo the reference_id provided by trivago in the corresponding request. If the request fails\n(timeout or otherwise), this id can be used in a booking verification request to determine if the call\nwas successful.",
"type": "string",
"example": "692e8acc-d1d9-45dc-b50f-e7b824f3306f"
},
"reservation": {
"$ref": "#/components/schemas/reservation"
}
},
"type": "object"
},
"address": {
"title": "Billing Address object",
"description": "Schema of an billing address.",
"required": [
"address1",
"city",
"country"
],
"properties": {
"address1": {
"description": "Street and number of address",
"type": "string",
"example": "12 Johnson Junction"
},
"address2": {
"description": "Additional address information",
"type": "string"
},
"city": {
"description": "City of addres",
"type": "string",
"example": "Santa Cruz"
},
"state": {
"description": "State or province\nState is required for all addresses from the United States (US), Australia (AU), Canada (CA), Malaysia (MY),\nPhilippines (PH) and Italy (IT). For addresses from the United Kingdom (UK), New Zealand (NZ), Ireland (IE),\nSingapore (SG), South Africa (ZA), France (FR) and others the state is optional. required for addresses\nfrom United States.",
"type": "string",
"example": "Maryland"
},
"postal_code": {
"description": "Zip code or postal code\nrequired for addresses from United States",
"type": "string",
"example": "97897"
},
"country": {
"description": "ISO 3166 country code",
"type": "string",
"example": "US"
}
},
"type": "object",
"additionalProperties": false
},
"authorisation": {
"title": "Authorisation object",
"description": "Schema of an authorisation.",
"required": [
"reservation_id",
"partner_data",
"target"
],
"properties": {
"reservation_id": {
"description": "The advertiser's unique id for the corresponding reservation. Must be used as booking_id in the tracking pixel.",
"type": "string"
},
"partner_data": {
"$ref": "#/components/schemas/partner-data"
},
"target": {
"$ref": "#/components/schemas/authorisation-target"
}
},
"type": "object",
"additionalProperties": false
},
"authorisation-target": {
"title": "Authorisation Target object",
"description": "Schema of an authorisation target.",
"required": [
"url",
"method",
"parameters"
],
"properties": {
"url": {
"description": "The Authorisation target url.",
"type": "string"
},
"method": {
"description": "HTTP method (POST or GET).",
"type": "string",
"enum": [
"GET",
"POST"
]
},
"parameters": {
"description": "Query/Post parameters as JSON object.",
"type": "object"
}
},
"type": "object",
"additionalProperties": false
},
"cancellation": {