⇡ GET /bookings
This request allows you to download bookings that you sold, or for products you supply. Bookings are always returned in booking date order descending.
The /bookings request must be made as a GET request to https://api.cityconnect.net/v1/bookings. You must use your account identifier and token created in your account as HTTP Basic Authentication header to authenticate the request.
| Parameter | Description | Example |
|---|---|---|
| as | Allows you to specify bookings depending on what part you played in the sale. Valid options are: - supplier - agent | supplier |
| agent | The agent that sold the booking. Set this to me to represent your account | viator.com |
| supplier | The supplier that received the booking. Set this to me to represent your account | mysightseeingtours.com |
| product | The product code to filter bookings by | BUSLONDON |
| option | The option code to filter bookings by (must be set with product) | 1DAY |
| travel_from | From what date the booking was made for | 2018-01-01 |
| travel_to | To what date the booking was made for | 2018-01-31 |
| booking_from | From what date the booking was made on | 2018-01-01 |
| booking_to | To what date the booking was made on | 2018-01-31 |
| search | A search term that will try and match both the agent and supplier reference, booking or ticket code, and any customer records. | SMITH |
City Connect by default only returns the top 25 bookings. Use pagination documented below to download more.
Each request will return a X-Total-Count header which is an integer value indicating the total number of bookings available given the query parameters above.
It's possible to alter your selection of those bookings by providing an offset and limit parameter.
| Parameter | Description | Example |
|---|---|---|
| offset | Which booking to start from, default is 0. | 500 |
| limit | The total number of bookings returned. Default is 25, this has a max value of 500. | 100 |
Updated over 8 years ago
