AirService - Catalogue API v1.0

API Endpoint
https://api-sandbox.airservice.com/

The mobile commerce platform

Info

Properties

Name Type Description

Info collection

Actions on the Info resource

[GET]

  • Response 200 (application/json)
+ Body

        [
            {
              "id": 859
            }
        ]

Regions

Properties

Name Type Description

Regions collection

Actions on the Regions resource

[GET]

  • Response 200 (application/json)
+ Body

        [
            {
              "id": 300
            }
        ]

Sectors

Properties

Name Type Description

Sectors collection

Actions on the Sectors resource

GET https://api-sandbox.airservice.com//catalogue/:version/sectors
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 983
  }
]

Returns active sectors based on proximity to lat/long if supplied
GET/catalogue/:version/sectors

URI Parameters
HideShow
lat
Float (optional) 

Latitude of location to perform the search around

long
Float (optional) 

Longitude of location to perform the search around

Sectors single

Actions on the Sectors resource

GET https://api-sandbox.airservice.com//catalogue/:version/sectors/:id
Responses200
Headers
Content-Type: application/json
Body
{
  "id": 176
}

Returns detailed information about Sector
GET/catalogue/:version/sectors/:id

URI Parameters
HideShow
id
String (required) 

Unique sector id or sector slug

Venues

Properties

Name Type Description

Venues collection

Actions on the Venues resource

GET https://api-sandbox.airservice.com//catalogue/:version/venues
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 719
  }
]

Returns venues grouped by active and coming soon
GET/catalogue/:version/venues

URI Parameters
HideShow
lat
Float (optional) 

Latitude of location to perform the search around

limit
Integer (optional) 

Limit the response size of the search of Collection, Location, Search Terms and Service applied

long
Float (optional) 

Longitude of location to perform the search around

search
String (optional) 

Search string for Venues and all Products

service_time
String (optional) 

The Service time for the customer to filter venue results

service_type_id
Integer (optional) 

The Service Type ID to filter venue results

Venues single

Actions on the Venues resource

GET https://api-sandbox.airservice.com//catalogue/:version/venues/:id
Responses200
Headers
Content-Type: application/json
Body
{
  "id": 977
}

Returns detailed information about Venue
GET/catalogue/:version/venues/:id

URI Parameters
HideShow
id
Integer (required) 

Unique Venue ID or Venue code

Recent

Properties

Name Type Description

Recent collection

Actions on the Recent resource

Search collection

Actions on the Search resource

GET https://api-sandbox.airservice.com//catalogue/:version/venues/:venue_id/search
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 156
  }
]

Search for menus based on supplied parameters
GET/catalogue/:version/venues/:venue_id/search

URI Parameters
HideShow
begins
String (optional) 

Begin time of interval in ‘12:00’ format

ends
String (optional) 

End Time of interval ‘12:00’ format

interval_id
Integer (optional) 

Interval Id for Customer selected Service period

location_id
Integer (optional) 

Location used for in-venue or home delivery

service_id
Integer (required) 

Service ID selected by customer

venue_id
Integer (required) 

Unique Venue ID or Venue code

GET https://api-sandbox.airservice.com//catalogue/:version/venues/:venue_id/menus
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 760
  }
]
GET https://api-sandbox.airservice.com//catalogue/:version/venues/:venue_id/menus/:id
Responses200
Headers
Content-Type: application/json
Body
{
  "id": 630
}

Products

Properties

Name Type Description

Products single

Actions on the Products resource

GET https://api-sandbox.airservice.com//catalogue/:version/venues/:venue_id/products/:id
Responses200
Headers
Content-Type: application/json
Body
{
  "id": 377
}

Returns the specified product
GET/catalogue/:version/venues/:venue_id/products/:id

URI Parameters
HideShow
id
Integer (required) 

Unique product id

venue_id
String (required) 

Unique Venue ID or Venue code

Address Suggestions

Properties

Name Type Description

Address Suggestions collection

Actions on the Address suggestions resource

GET https://api-sandbox.airservice.com//catalogue/:version/address_suggestions
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 511
  }
]

Get list of addresses matching search criteria
GET/catalogue/:version/address_suggestions

URI Parameters
HideShow
q
String (required) 

Address string to search

region
String (optional) 

Geographic Region used for search, defaults to AU

Delivers To

Properties

Name Type Description

Delivers To collection

Actions on the Delivers to resource

GET https://api-sandbox.airservice.com//catalogue/:version/venues/:venue_id/delivers_to
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 461
  }
]

Returns whether or not a venue can deliver to a delivery address
GET/catalogue/:version/venues/:venue_id/delivers_to

URI Parameters
HideShow
address
String (required) 

Delivery address

venue_id
String (required) 

Unique venue id

Locations

Properties

Name Type Description

Locations collection

Actions on the Locations resource

GET https://api-sandbox.airservice.com//catalogue/:version/services/:service_id/locations
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 880
  }
]

Returns services locations for in in-venue delivery
GET/catalogue/:version/services/:service_id/locations

URI Parameters
HideShow
page
Integer (optional) 

Current page or results

search
String (optional) 

Search for locations

service_id
String (required) 

Unique venue id

Promotions

Properties

Name Type Description

Promotions collection

Actions on the Promotions resource

GET https://api-sandbox.airservice.com//catalogue/:version/promotions
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "id": 457
  }
]

Returns detailed information about Promotions
GET/catalogue/:version/promotions

URI Parameters
HideShow
customer_id
Integer (optional) 

Authenticated Customer Id

major
Integer (required) 

Beacon Major

minor
Integer (required) 

Beacon Minor

uuid
String (required) 

Beacon UUID

Generated by aglio on 29 Nov 2016