From fb316fd960e24c3505312c66b1fccaecd6d609f4 Mon Sep 17 00:00:00 2001 From: Mohit Babbar Date: Tue, 17 Oct 2023 17:37:23 +0530 Subject: [PATCH 1/4] Update partner product documentation --- apis/product.md | 444 +++++++++++++++++++++++++----------------------- 1 file changed, 233 insertions(+), 211 deletions(-) diff --git a/apis/product.md b/apis/product.md index 1638cd9..172101d 100644 --- a/apis/product.md +++ b/apis/product.md @@ -4,130 +4,138 @@ ## APIs -METHOD | URL | AUTH | USAGE ---- | --- | --- | --- -GET | [`/product/get/{product_id}`](#GET-/product/get/{product_id}) | no | Get product by `id`. -GET | [`/product/listing/list-by/city`](#GET-/product/listing/list-by/city) | no | List product listing by city -GET | [`/product/listing/list-by/category`](#GET-/product/listing/list-by/category) | no | List product listing by category +| METHOD | URL | AUTH | USAGE | +|--------|-------------------------------------------------------------------------------|------|----------------------------------| +| GET | [`/product/get/{product_id}`](#GET-/product/get/{product_id}) | no | Get product by `id`. | +| GET | [`/product/listing/list-by/city`](#GET-/product/listing/list-by/city) | no | List product listing by city | +| GET | [`/product/listing/list-by/category`](#GET-/product/listing/list-by/category) | no | List product listing by category | ### GET `/product/get/{product_id}` Gets a product by `productId`. +#### Example curl +```shell +curl --location 'https://api.headout.com/api/v1/product/get/3336?currencyCode=EUR&language=PT&fetch-variants=true' +``` + #### Request -MODE | KEY | TYPE | OPTIONAL | DESCRIPTION ---- | --- | --- | --- | --- -PATH | product-id | string | no | Product id +| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | +|-------|----------------|---------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PATH | productId | string | no | Product id | +| QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* | +| QUERY | fetch-variants | boolean | yes (Default: true) | Flag to toggle the option of fetching variants. | +| QUERY | language | string | yes (Default: EN) | The language in which the product details will be returned. Eg: `EN`, `ES`, `FR`, `IT`, `DE`, `PT`, `NL`, etc. | #### Response **Object:** [`product`](/object-models/product-models.md#product) -```javascript +```json5 { - "id": 512, - "name": "Wicked", - "neighbourhood": "Theatre District", - "city": { - "code": "NEW_YORK", - "name": "New York" - }, - "currency": { - "code": "USD", - "name": "United States Dollar", - "symbol": "US$", - "localSymbol": "$", - "precision": 2, - }, - "images": [ - { - "url": "//cdn-imgix.headout.com/tour/647/TOUR-IMAGE/a9e14ae1-78ab-4cbe-8166-2e55f3060c42-512-new-york-wicked-07.jpg" - } - ], - "displayTags": [ - "Broadway", - "Musical", - "Best of Broadway", - "Entertainment" - ], - "content": [ - { - "title": "Summary", - "html": "

Before Dorothy arrived in Oz, there was a girl with emerald-green skin — misunderstood, and extremely talented.

" - } - ], - "startLocation": { - "latitude": 40.762393951416016, - "longitude": -73.9851303100586, - "addressLine1": "The Gershwin Theatre", - "addressLine2": "222 W 51st Street", - "cityName": "New York", - "postalCode": "10036", - "state": "New York", - "countryName": "United States" - }, - "endLocation": { - "geo": { - "latitude": 40.762393951416016, - "longitude": -73.9851303100586, - } - "address": { - "line1": "The Gershwin Theatre", - "ine2": "222 W 51st Street", - "cityName": "New York", - "stateName": "New York", - "countryName": "United States", - "postalCode": "10036", - } - }, - "productType": "EVENT", - "ratingCumulative": { - "avg": 4.2, - "count": 251 - }, - "hasInstantConfirmation": true, - "hasMobileTicket": true, - "variants": [ - { - "id": 654, - "name": "Orchestra (Center Rows: A-O,AA-CC, Side Rows:A-J)", - "description": "The best view of all the seat groups", - "inventoryType": "FIXED_START_FIXED_DURATION", - "duration": 9000000, - "priceType": "PER_PERSON", - "pax": { - "min": 1, - "max": 9, - }, - "cashback": { - "value": 10, - "type": "PERCENTAGE", - }, - "ticketDeliveryInfoHtml": "

Your booking confirmation will be emailed to you shortly.

", - "inputFields": [ - { - "id": "SOME_ID", - "name": "Name", - "dataType": "STRING", - "level": "PRIMARY_CUSTOMER", - "validation": { - "required": true, - "regex": "\\s*[^\\s]+\\s+[^\\s]+.*", - "minLength": 3, - "maxLength": 80, - "minValue": null, - "maxValue": null, - "values": [ - "Vegetarian", - "Non-vegeratian", - "Diabetic" - ] - } - } - ] - } - ] + "id": 512, + "name": "Wicked", + "neighbourhood": "Theatre District", + "city": { + "code": "NEW_YORK", + "name": "New York" + }, + "currency": { + "code": "USD", + "name": "United States Dollar", + "symbol": "US$", + "localSymbol": "$", + "precision": 2, + }, + "images": [ + { + "url": "//cdn-imgix.headout.com/tour/647/TOUR-IMAGE/a9e14ae1-78ab-4cbe-8166-2e55f3060c42-512-new-york-wicked-07.jpg" + } + ], + "displayTags": [ + "Broadway", + "Musical", + "Best of Broadway", + "Entertainment" + ], + "content": [ + { + "title": "Summary", + "html": "

Before Dorothy arrived in Oz, there was a girl with emerald-green skin — misunderstood, and extremely talented.

" + } + ], + "startLocation": { + "latitude": 40.762393951416016, + "longitude": -73.9851303100586, + "addressLine1": "The Gershwin Theatre", + "addressLine2": "222 W 51st Street", + "cityName": "New York", + "postalCode": "10036", + "state": "New York", + "countryName": "United States" + }, + "endLocation": { + "geo": { + "latitude": 40.762393951416016, + "longitude": -73.9851303100586, + }, + "address": { + "line1": "The Gershwin Theatre", + "ine2": "222 W 51st Street", + "cityName": "New York", + "stateName": "New York", + "countryName": "United States", + "postalCode": "10036", + } + }, + "productType": "EVENT", + "ratingCumulative": { + "avg": 4.2, + "count": 251 + }, + "hasInstantConfirmation": true, + "hasMobileTicket": true, + "variants": [ + { + "id": 654, + "name": "Orchestra (Center Rows: A-O,AA-CC, Side Rows:A-J)", + "description": "The best view of all the seat groups", + "inventoryType": "FIXED_START_FIXED_DURATION", + "duration": 9000000, + "priceType": "PER_PERSON", + "pax": { + "min": 1, + "max": 9, + }, + "cashback": { + "value": 10, + "type": "PERCENTAGE", + }, + "ticketDeliveryInfoHtml": "

Your booking confirmation will be emailed to you shortly.

", + "inputFields": [ + { + "id": "SOME_ID", + "name": "Name", + "dataType": "STRING", + "level": "PRIMARY_CUSTOMER", + "validation": { + "required": true, + "regex": "\\s*[^\\s]+\\s+[^\\s]+.*", + "minLength": 3, + "maxLength": 80, + "minValue": null, + "maxValue": null, + "values": [ + "Vegetarian", + "Non-vegeratian", + "Diabetic" + ] + } + } + ] + } + ] } ``` @@ -135,63 +143,70 @@ PATH | product-id | string | no | Product id List product listing using city. +#### Example curl +```shell +curl --location 'https://api.headout.com/api/v1/product/listing/list-by/city?cityCode=LONDON¤cyCode=CAD&language=FR&limit=10&offset=10' +``` + #### Request -MODE | KEY | TYPE | OPTIONAL | DESCRIPTION ---- | --- | --- | --- | --- -QUERY | cityCode | string | no | The city code. Eg: `NEW_YORK`, `DUBAI` -QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* -QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* -QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* +| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | +|-------|--------------|--------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| QUERY | cityCode | string | no | The city code. Eg: `NEW_YORK`, `DUBAI` | +| QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* | +| QUERY | language | string | yes (Default: EN) | The language in which the product details will be returned. Eg: `EN`, `ES`, `FR`, `IT`, `DE`, `PT`, `NL` | +| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* | +| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* | #### Response -**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` +**Object: +** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` -```javascript +```json5 { - "items": [ - { - "id": "Product ID", - "name": "Product Name", - "url": "https://product_url", - "city": { - "code": "NEW_YORK", - "displayName": "New York" - }, - "image": { - "url": "https://imageurl" - }, - "neighbourhood": "Madison Square Garden", - "primaryCategory": { - "id": "123", - "name": "Broadway", - "cityCode": "NEW_YORK", - "canonicalUrl": "https://www.headout.com/category/24/broadway" - }, - "startGeolocation": { - "latitude": 40.701568603515625, - "longitude": -74.0091323852539 - }, - "ratingCumulative": { - "avg": 3.5, - "count": 5 - }, - "pricing": { - "type": "PER_PERSON", - "currencyCode": "AED", - "minimumPrice": { - "originalPrice": 551, - "finalPrice": 518, - } - "bestDiscount": 28 - } - } - ], - "nextUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/city?cityCode=NEW_YORK,offset=21,limit=20", - "prevUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/city?cityCode=NEW_YORK,offset=0,limit=20", - "total": 100, - "nextOffset": 21 + "items": [ + { + "id": "Product ID", + "name": "Product Name", + "url": "https://product_url", + "city": { + "code": "NEW_YORK", + "displayName": "New York" + }, + "image": { + "url": "https://imageurl" + }, + "neighbourhood": "Madison Square Garden", + "primaryCategory": { + "id": "123", + "name": "Broadway", + "cityCode": "NEW_YORK", + "canonicalUrl": "https://www.headout.com/category/24/broadway" + }, + "startGeolocation": { + "latitude": 40.701568603515625, + "longitude": -74.0091323852539 + }, + "ratingCumulative": { + "avg": 3.5, + "count": 5 + }, + "pricing": { + "type": "PER_PERSON", + "currencyCode": "AED", + "minimumPrice": { + "originalPrice": 551, + "finalPrice": 518, + }, + "bestDiscount": 28 + } + } + ], + "nextUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/city?cityCode=NEW_YORK,offset=21,limit=20", + "prevUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/city?cityCode=NEW_YORK,offset=0,limit=20", + "total": 100, + "nextOffset": 21 } ``` @@ -199,62 +214,69 @@ QUERY | currencyCode | string | yes | The currency in which pricing information List product listing using category. +#### Example curl +```shell +curl --location 'https://api.headout.com/api/v1/product/listing/list-by/category?categoryId=3956&language=ES¤cyCode=EUR&limit=20&offset=10' +``` + #### Request -MODE | KEY | TYPE | OPTIONAL | DESCRIPTION ---- | --- | --- | --- | --- -QUERY | categoryId | string | no | The id of the category. -QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* -QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* -QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* +| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | +|-------|--------------|--------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| QUERY | categoryId | string | no | The id of the category. | +| QUERY | language | string | yes (Default: EN) | The language in which the product details will be returned. Eg: `EN`, `ES`, `FR`, `IT`, `DE`, `PT`, `NL` | +| QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* | +| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* | +| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* | #### Response -**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` +**Object: +** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` -```javascript +```json5 { - "items": [ - { - "id": "Product ID", - "name": "Product Name", - "url": "https://product_url", - "city": { - "code": "NEW_YORK", - "displayName": "New York" - }, - "image": { - "url": "https://imageurl" - }, - "neighbourhood": "Madison Square Garden", - "primaryCategory": { - "id": "123", - "name": "Broadway", - "cityCode": "NEW_YORK", - "canonicalUrl": "https://www.headout.com/category/24/broadway" - }, - "startGeolocation": { - "latitude": 40.701568603515625, - "longitude": -74.0091323852539 - }, - "ratingCumulative": { - "avg": 3.5, - "count": 5 - }, - "pricing": { - "type": "PER_PERSON", - "currencyCode": "AED", - "minimumPrice": { - "originalPrice": 551, - "finalPrice": 518, - } - "bestDiscount": 28 - } - } - ], - "nextUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/category?categoryId=23,offset=21,limit=20", - "prevUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/category?categoryId=23,offset=0,limit=20", - "total": 100, - "nextOffset": 21 + "items": [ + { + "id": "Product ID", + "name": "Product Name", + "url": "https://product_url", + "city": { + "code": "NEW_YORK", + "displayName": "New York" + }, + "image": { + "url": "https://imageurl" + }, + "neighbourhood": "Madison Square Garden", + "primaryCategory": { + "id": "123", + "name": "Broadway", + "cityCode": "NEW_YORK", + "canonicalUrl": "https://www.headout.com/category/24/broadway" + }, + "startGeolocation": { + "latitude": 40.701568603515625, + "longitude": -74.0091323852539 + }, + "ratingCumulative": { + "avg": 3.5, + "count": 5 + }, + "pricing": { + "type": "PER_PERSON", + "currencyCode": "AED", + "minimumPrice": { + "originalPrice": 551, + "finalPrice": 518, + }, + "bestDiscount": 28 + } + } + ], + "nextUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/category?categoryId=23,offset=21,limit=20", + "prevUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/category?categoryId=23,offset=0,limit=20", + "total": 100, + "nextOffset": 21 } ``` From 510a357ab68de4e9a48ae51e9be50d90b5b1a312 Mon Sep 17 00:00:00 2001 From: Mohit Babbar Date: Tue, 17 Oct 2023 17:49:25 +0530 Subject: [PATCH 2/4] Update api response examples --- apis/product.md | 245 +++++++++++++++++++++++++++++------------------- 1 file changed, 147 insertions(+), 98 deletions(-) diff --git a/apis/product.md b/apis/product.md index 172101d..423b9a4 100644 --- a/apis/product.md +++ b/apis/product.md @@ -36,106 +36,135 @@ curl --location 'https://api.headout.com/api/v1/product/get/3336?currencyCode=EU { "id": 512, "name": "Wicked", - "neighbourhood": "Theatre District", + "url": "/broadway-tickets/wicked-e-512/", + "canonicalUrl": "https://www.headout.com/broadway-tickets/wicked-e-512/", + "neighbourhood": "", "city": { - "code": "NEW_YORK", - "name": "New York" + "name": "New York", + "code": "NEW_YORK" }, "currency": { "code": "USD", "name": "United States Dollar", "symbol": "US$", "localSymbol": "$", - "precision": 2, + "precision": 2 }, - "images": [ - { - "url": "//cdn-imgix.headout.com/tour/647/TOUR-IMAGE/a9e14ae1-78ab-4cbe-8166-2e55f3060c42-512-new-york-wicked-07.jpg" - } - ], "displayTags": [ "Broadway", "Musical", "Best of Broadway", "Entertainment" ], + "images": [ + { + "url": "https://cdn-imgix.headout.com/media/images/5276fb91a066165e4069516143ae2ea3-512-new-york-wicked-01.jpg", + "altText": "wicked-1", + "description": "Wicked Newyork", + "credit": "Broadway Inbound, Inc" + } + ], + "contentListHtml": [ + { + "title": "Summary", + "type": "SUMMARY_HTML", + "html": "

Why Watch Wicked

\n

Dive deep into the enchanting world of Oz, presented from a perspective you've never witnessed before. Secure your Wicked Broadway tickets to step into a multi-award-winning phenomenon. With its spellbinding cast, extraordinary crew, and accolades that stretch beyond Broadway's glimmering lights, Wicked is an unmatched theatrical experience. The numerous awards and consistent critical acclaim stand testimony to its brilliance. Don't miss your chance to be swept away by this bewitching tale of friendship, love, and the cost of integrity.

\n

The Story

\n

Before Dorothy and her famous ruby slippers, there was a profound friendship between two young women, one with emerald green skin. This is their story. Book your Wicked Broadway tickets now and embark on a magical journey that unveils the untold tale of the witches of Oz. Witness the transformation of Elphaba, the future Wicked Witch of the West, and Glinda, the Good Witch. It's a mesmerizing, heart-tugging story filled with songs and emotions that promise to leave an indelible mark on your soul.

\n

Great For

\n

Fans of Fantasy | Musical Enthusiasts | Night Out with Family

" + } + ], "content": [ { "title": "Summary", - "html": "

Before Dorothy arrived in Oz, there was a girl with emerald-green skin — misunderstood, and extremely talented.

" + "type": "SUMMARY_HTML", + "html": "

Why Watch Wicked

\n

Dive deep into the enchanting world of Oz, presented from a perspective you've never witnessed before. Secure your Wicked Broadway tickets to step into a multi-award-winning phenomenon. With its spellbinding cast, extraordinary crew, and accolades that stretch beyond Broadway's glimmering lights, Wicked is an unmatched theatrical experience. The numerous awards and consistent critical acclaim stand testimony to its brilliance. Don't miss your chance to be swept away by this bewitching tale of friendship, love, and the cost of integrity.

\n

The Story

\n

Before Dorothy and her famous ruby slippers, there was a profound friendship between two young women, one with emerald green skin. This is their story. Book your Wicked Broadway tickets now and embark on a magical journey that unveils the untold tale of the witches of Oz. Witness the transformation of Elphaba, the future Wicked Witch of the West, and Glinda, the Good Witch. It's a mesmerizing, heart-tugging story filled with songs and emotions that promise to leave an indelible mark on your soul.

\n

Great For

\n

Fans of Fantasy | Musical Enthusiasts | Night Out with Family

" } ], "startLocation": { - "latitude": 40.762393951416016, - "longitude": -73.9851303100586, - "addressLine1": "The Gershwin Theatre", - "addressLine2": "222 W 51st Street", - "cityName": "New York", - "postalCode": "10036", - "state": "New York", - "countryName": "United States" + "geolocation": { + "latitude": 40.762332916259766, + "longitude": -73.98523712158203 + }, + "address": { + "addressLine1": "Gershwin Theatre", + "addressLine2": "222 West 51 Street", + "cityName": "New York", + "postalCode": "10019", + "state": "New York", + "countryName": "United States" + } }, "endLocation": { - "geo": { - "latitude": 40.762393951416016, - "longitude": -73.9851303100586, + "geolocation": { + "latitude": 40.762332916259766, + "longitude": -73.98523712158203 }, "address": { - "line1": "The Gershwin Theatre", - "ine2": "222 W 51st Street", + "addressLine1": "Gershwin Theatre", + "addressLine2": "222 West 51 Street", "cityName": "New York", - "stateName": "New York", - "countryName": "United States", - "postalCode": "10036", + "postalCode": "10019", + "state": "New York", + "countryName": "United States" } }, "productType": "EVENT", "ratingCumulative": { - "avg": 4.2, - "count": 251 + "avg": 4.43, + "count": 1262 }, - "hasInstantConfirmation": true, - "hasMobileTicket": true, + "hasInstantConfirmation": false, + "hasMobileTicket": false, "variants": [ { - "id": 654, - "name": "Orchestra (Center Rows: A-O,AA-CC, Side Rows:A-J)", - "description": "The best view of all the seat groups", + "id": 647, + "name": "Rear Orchestra/Rear Mezzanine", + "description": "", + "duration": 9900000, "inventoryType": "FIXED_START_FIXED_DURATION", - "duration": 9000000, - "priceType": "PER_PERSON", "pax": { "min": 1, - "max": 9, + "max": 8 }, "cashback": { - "value": 10, - "type": "PERCENTAGE", + "value": 0.0000, + "type": "PERCENTAGE" }, - "ticketDeliveryInfoHtml": "

Your booking confirmation will be emailed to you shortly.

", + "ticketDeliveryInfoHtml": null, "inputFields": [ { - "id": "SOME_ID", - "name": "Name", + "oldId": 62, + "id": "NAME", + "name": "Full Name", "dataType": "STRING", - "level": "PRIMARY_CUSTOMER", "validation": { - "required": true, "regex": "\\s*[^\\s]+\\s+[^\\s]+.*", "minLength": 3, "maxLength": 80, "minValue": null, "maxValue": null, - "values": [ - "Vegetarian", - "Non-vegeratian", - "Diabetic" - ] - } + "required": true, + "values": null + }, + "level": "PRIMARY_CUSTOMER" } + ], + "tags": [ + "BROADWAY", + "BROADWAY2", + "BROADWAYFORKIDS", + "BROADWAYFORKIDS2", + "BTTFA" ] } - ] + ], + "pricing": { + "type": "PER_PERSON", + "currencyCode": "USD", + "minimumPrice": { + "originalPrice": 96.50, + "finalPrice": 96.50 + }, + "bestDiscount": 0 + } } ``` @@ -167,46 +196,56 @@ curl --location 'https://api.headout.com/api/v1/product/listing/list-by/city?cit { "items": [ { - "id": "Product ID", - "name": "Product Name", - "url": "https://product_url", + "id": "2844", + "name": "Fast Track Tickets to the London Eye", + "url": "/london-eye-tickets/fast-track-tickets-to-the-london-eye-e-2844/", + "canonicalUrl": "https://www.headout.com/london-eye-tickets/fast-track-tickets-to-the-london-eye-e-2844/", "city": { - "code": "NEW_YORK", - "displayName": "New York" + "name": "London", + "code": "LONDON" }, "image": { - "url": "https://imageurl" + "url": "https://cdn-imgix.headout.com/tour/4407/TOUR-IMAGE/12d3a2c5-a39e-4f0f-9724-dcd63f5429cb-2844-london-london-eye--fast-track-entry-tickets-04.jpg" }, - "neighbourhood": "Madison Square Garden", + "neighbourhood": null, "primaryCategory": { - "id": "123", - "name": "Broadway", - "cityCode": "NEW_YORK", - "canonicalUrl": "https://www.headout.com/category/24/broadway" + "id": 279, + "name": "London Eye Tickets", + "cityCode": "LONDON", + "url": "/category/279" + }, + "currency": { + "code": "USD", + "currencyName": "United States Dollar", + "symbol": "US$", + "localSymbol": "$", + "precision": 2, + "currency": "USD" }, "startGeolocation": { - "latitude": 40.701568603515625, - "longitude": -74.0091323852539 + "latitude": 51.50345230102539, + "longitude": -0.119518555700779 }, "ratingCumulative": { - "avg": 3.5, - "count": 5 + "avg": 4.47, + "count": 3398 }, "pricing": { "type": "PER_PERSON", - "currencyCode": "AED", + "currencyCode": "USD", "minimumPrice": { - "originalPrice": 551, - "finalPrice": 518, + "originalPrice": 58.4, + "finalPrice": 58.4 }, - "bestDiscount": 28 - } + "bestDiscount": 0 + }, + "hasInstantConfirmation": true } ], - "nextUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/city?cityCode=NEW_YORK,offset=21,limit=20", - "prevUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/city?cityCode=NEW_YORK,offset=0,limit=20", - "total": 100, - "nextOffset": 21 + "nextUrl": "https://api.headout.com/api/v1/product/listing/list-by/city?cityCode=LONDON¤cyCode=USD&language=EN&offset=11&limit=1", + "prevUrl": "https://api.headout.com/api/v1/product/listing/list-by/city?cityCode=LONDON¤cyCode=USD&language=EN&offset=9&limit=1", + "total": 224, + "nextOffset": 11 } ``` @@ -238,45 +277,55 @@ curl --location 'https://api.headout.com/api/v1/product/listing/list-by/category { "items": [ { - "id": "Product ID", - "name": "Product Name", - "url": "https://product_url", + "id": "11228", + "name": "Tickets to Khao Kheow Open Zoo", + "url": "/es/khao-kheow-open-zoo/khao-kheow-open-zoo-e-11228/", + "canonicalUrl": "https://www.headout.com/es/khao-kheow-open-zoo/khao-kheow-open-zoo-e-11228/", "city": { - "code": "NEW_YORK", - "displayName": "New York" + "name": "Pattaya", + "code": "PATTAYA" }, "image": { - "url": "https://imageurl" + "url": "https://cdn-imgix.headout.com/tour/21259/TOUR-IMAGE/4dd55cf1-4beb-45ad-aa50-7d6b8b58ca39-11228-pattaya-khao-kheow-open-zoo-01.jpg" }, - "neighbourhood": "Madison Square Garden", + "neighbourhood": null, "primaryCategory": { - "id": "123", - "name": "Broadway", - "cityCode": "NEW_YORK", - "canonicalUrl": "https://www.headout.com/category/24/broadway" + "id": 4842, + "name": "Khao Kheow Open Zoo", + "cityCode": "PATTAYA", + "url": "/category/4842" + }, + "currency": { + "code": "EUR", + "currencyName": "Euro", + "symbol": "EUR", + "localSymbol": "€", + "precision": 2, + "currency": "EUR" }, "startGeolocation": { - "latitude": 40.701568603515625, - "longitude": -74.0091323852539 + "latitude": 13.214982986450195, + "longitude": 101.05597686767578 }, "ratingCumulative": { - "avg": 3.5, - "count": 5 + "avg": 4.44, + "count": 2023 }, "pricing": { "type": "PER_PERSON", - "currencyCode": "AED", + "currencyCode": "EUR", "minimumPrice": { - "originalPrice": 551, - "finalPrice": 518, + "originalPrice": 6.51, + "finalPrice": 5.73 }, - "bestDiscount": 28 - } + "bestDiscount": 12 + }, + "hasInstantConfirmation": true } ], - "nextUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/category?categoryId=23,offset=21,limit=20", - "prevUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/category?categoryId=23,offset=0,limit=20", - "total": 100, - "nextOffset": 21 + "nextUrl": "https://api.headout.com/api/v1/product/listing/list-by/category?categoryId=3956&language=ES¤cyCode=EUR&offset=11&limit=1", + "prevUrl": "https://api.headout.com/api/v1/product/listing/list-by/category?categoryId=3956&language=ES¤cyCode=EUR&offset=9&limit=1", + "total": 25, + "nextOffset": 11 } ``` From 03f479c5669873fcc399294a0fb0a1fb53d2c17e Mon Sep 17 00:00:00 2001 From: Mohit Babbar Date: Tue, 17 Oct 2023 17:50:19 +0530 Subject: [PATCH 3/4] Change json5 to json --- apis/product.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/apis/product.md b/apis/product.md index 423b9a4..8f2de2e 100644 --- a/apis/product.md +++ b/apis/product.md @@ -32,7 +32,7 @@ curl --location 'https://api.headout.com/api/v1/product/get/3336?currencyCode=EU **Object:** [`product`](/object-models/product-models.md#product) -```json5 +```json { "id": 512, "name": "Wicked", @@ -192,7 +192,7 @@ curl --location 'https://api.headout.com/api/v1/product/listing/list-by/city?cit **Object: ** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` -```json5 +```json { "items": [ { @@ -273,7 +273,7 @@ curl --location 'https://api.headout.com/api/v1/product/listing/list-by/category **Object: ** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` -```json5 +```json { "items": [ { From 6ee3bace3bbc1fc42f045f737c00fa842065a09f Mon Sep 17 00:00:00 2001 From: Mohit Babbar Date: Tue, 17 Oct 2023 17:51:53 +0530 Subject: [PATCH 4/4] Fix bold texts --- apis/product.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/apis/product.md b/apis/product.md index 8f2de2e..dfe4537 100644 --- a/apis/product.md +++ b/apis/product.md @@ -189,8 +189,7 @@ curl --location 'https://api.headout.com/api/v1/product/listing/list-by/city?cit #### Response -**Object: -** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` +**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` ```json { @@ -270,8 +269,7 @@ curl --location 'https://api.headout.com/api/v1/product/listing/list-by/category #### Response -**Object: -** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` +**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>` ```json {