Skip to content

Commit

Permalink
seatmap booking api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@manas-tank
manas-tank committed Jun 7, 2023
1 parent e815785 commit ea99a74
Show file tree
Hide file tree
Showing 15 changed files with 365 additions and 340 deletions.
31 changes: 17 additions & 14 deletions apis/booking.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

## APIs

METHOD | URL | AUTH | USAGE
--- | --- | --- | ---
GET | [`/booking`](#GET-/booking) | yes | Fetch all bookings.
GET | [`/booking/{id}`](#GET-/booking/{id}) | yes | Fetch a booking by it's id.
POST | [`/booking`](#POST-/booking) | yes | Create a booking in `UNCAPTURED` state.
PUT | [`/booking/{id}`](#PUT-/booking) | yes | Modify the state of the booking given it's id.
POST | *`DEPRECATED`* [~~`/booking/create`~~](#POST-/booking/create) | yes | Create a booking. Use: [`POST /booking`](#POST-/booking)
| METHOD | URL | AUTH | USAGE |
|--------|---------------------------------------------------------------|------|----------------------------------------------------------|
| GET | [`/booking`](#get-booking) | yes | Fetch all bookings. |
| GET | [`/booking/{id}`](#get-bookingid) | yes | Fetch a booking by it's id. |
| POST | [`/booking`](#POST-/booking) | yes | Create a booking in `UNCAPTURED` state. |
| PUT | [`/booking/{id}`](#PUT-/booking) | yes | Modify the state of the booking given it's id. |
| POST | *`DEPRECATED`* [~~`/booking/create`~~](#POST-/booking/create) | yes | Create a booking. Use: [`POST /booking`](#POST-/booking) |

### <a name="GET-/booking"></a>GET `/booking`
### <a name="GET-/booking"></a>GET `get-booking`

List all bookings.

Expand Down Expand Up @@ -75,13 +75,13 @@ List all bookings.

### <a name="GET-/booking/{id}"></a>GET `/booking/{id}`

Get a booking by it's ID.
Get a booking by its ID.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
PATH | id | string | no | The booking id.
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
|------|-----|--------|----------|-----------------|
| PATH | id | string | no | The booking id. |

#### Response

Expand Down Expand Up @@ -137,7 +137,7 @@ PATH | id | string | no | The booking id.

Create a new booking object in `UNCAPTURED` state.

The booking creation and acceptance flow is a 2 step flow. Calling this API creates the initial booking in `UNCAPTURED` state and returns back the same booking along with the new booking id. You should call this API before fulfilling the booking flow on your end. Once you get a response, you can then fulfill the booking flow on your end and then call [`PUT /booking`](#PUT-/booking) to capture the booking and start the fulfillment process of the booking on our end.
The booking creation and acceptance flow is a 2-step flow. Calling this API creates the initial booking in `UNCAPTURED` state and returns back the same booking along with the new booking id. You should call this API before fulfilling the booking flow on your end. Once you get a response, you can then fulfill the booking flow on your end and then call [`PUT /booking`](#PUT-/booking) to capture the booking and start the fulfillment process of the booking on our end.

If the booking capturing doesn't happen within an hour then the booking status is automatically changed to `CAPTURE_TIMEOUT`.

Expand All @@ -149,6 +149,7 @@ If the booking capturing doesn't happen within an hour then the booking status i
{
"variantId": "1234",
"inventoryId": "1455",
"inventorySeatIds": ["SE-GRANDCIRCLE-A-20","SE-GRANDCIRCLE-A-21"],
"customersDetails": {
"count": 3,
"customers": [{
Expand Down Expand Up @@ -217,9 +218,11 @@ If the booking capturing doesn't happen within an hour then the booking status i
}
```



### <a name="PUT-/booking"></a>PUT `/booking/{id}`

Used to modify a booking. Currently this is only used for capturing the booking and assigning a `partnerReferenceId`. Use this method to capture the booking by specifying the status as `PENDING`. The booking will be fulfilled on our end only once you capture it.
Used to modify a booking. Currently, this is only used for capturing the booking and assigning a `partnerReferenceId`. Use this method to capture the booking by specifying the status as `PENDING`. The booking will be fulfilled on our end only once you capture it.

#### Request

Expand Down
18 changes: 9 additions & 9 deletions apis/category.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@

## APIs

METHOD | URL | AUTH | USAGE
--- | --- | --- | ---
GET | [`/category/list-by/city`](#GET-/category/list-by/city) | no | List all categories by city.
| METHOD | URL | AUTH | USAGE |
|--------|---------------------------------------------------------|------|------------------------------|
| GET | [`/category/list-by/city`](#GET /category/list-by/city) | no | List all categories by city. |

### <a name="GET-/category/list-by/city"></a>GET `/category/list-by/city`

List all categories by city.

#### 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)*
| 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)* |

#### Response

**Object:** [`category`](/object-models/category-models.md#category)

```javascript
```json
{
"items": [
{
Expand Down
16 changes: 8 additions & 8 deletions apis/city.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@

## APIs

METHOD | URL | AUTH | USAGE
--- | --- | --- | ---
GET | [`/city`](#GET-/city) | no | List all the active cities.
| METHOD | URL | AUTH | USAGE |
|--------|-----------------------|------|-----------------------------|
| GET | [`/city`](#GET~/city) | no | List all the active cities. |

### <a name="GET-/city"></a>GET `/city`

List all the active cities.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
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)*
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
|-------|--------|--------|----------|--------------------------------------------------------------------------------------------------------------------|
| 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:** [`city`](/object-models/common-models.md#city)

```javascript
```json
{
"items": [
{
Expand Down
26 changes: 13 additions & 13 deletions apis/inventory-pricing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@

## APIs

METHOD | URL | AUTH | USAGE
--- | --- | --- | ---
GET | [`/inventory/list-by/variant`](#GET-/inventory/list-by/variant) | no | Get the available inventory for a variant.
| METHOD | URL | AUTH | USAGE |
|--------|-----------------------------------------------------------------|------|--------------------------------------------|
| GET | [`/inventory/list-by/variant`](#GET-/inventory/list-by/variant) | no | Get the available inventory for a variant. |

### <a name="GET-/inventory/list-by/variant"></a>GET `/inventory/list-by/variant`

Get the available inventory for a variant.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
QUERY | variantId | string | no | The ID of the variant for which the inventory needs to be fetched.
QUERY | startDateTime | string | yes | The start date time from which the inventory needs to be fetched. If unspecified then the current timestamp is taken into consideration. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)*
QUERY | endDateTime | string | yes | The end date time till which the inventory needs to be fetched. If unspecified then this is taken as infinity. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)*
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 | variantId | string | no | The ID of the variant for which the inventory needs to be fetched. |
| QUERY | startDateTime | string | yes | The start date time from which the inventory needs to be fetched. If unspecified then the current timestamp is taken into consideration. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)* |
| QUERY | endDateTime | string | yes | The end date time till which the inventory needs to be fetched. If unspecified then this is taken as infinity. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)* |
| 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)* |

#### Response

**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`inventory`](/object-models/inventory-pricing-models.md#inventory)`>`

```javascript
```json
{
"items": [
{
"id": "1212121"
"id": "1212121",
"startDateTime": "2017-03-30T15:30:00",
"endDateTime": "2017-03-30T15:30:00",
"availability": "LIMITED/UNLIMITED/CLOSED",
Expand Down
Loading

0 comments on commit ea99a74

Please sign in to comment.