Deals Provider API

Method
Description

POST

createDeal

https://api.stb.gov.sg/content/v1/admin/deals

Allow the creation of a Deal listing. To create successfully, the following input parameters are mandatory: name, category, classification, type, tags, body, poiuuid, promotionStartDate, promotionEndDate, validStartDate, validEndDate and termsConditions.

PUT

suspendDeal

https://api.stb.gov.sg/content/v1/admin/deals/{deal_uuid}/suspend

Allow the suspension of an existing Deal listing through the use of a unique identifier. The acronym for the unique identifier is uuid. This uuid is created when you submit a content. If you have not documented the uuid, you can fetch it by using searchDealsByKeyword API.

PUT

updateDeal

https://api.stb.gov.sg/content/v1/admin/deals/{deal_uuid}

Allow an existing Deal listing to be localised by adding the content in other languages, through the use of a unique identifier. The acronym for the unique identifier is uuid. This uuid is created when you submit a content. If you have not documented the uuid, you can fetch it by using searchDealsByKeyword API.

Deals User API

Method
Description

GET

getDealsByPOI

https://api.stb.gov.sg/content/v1/{poi_category}/{poi_uuid}/deals

Retrieve the full list of deals associated with a Place of Interest (POI) by providing the POI’s unique identifier. The acronym for the unique identifier is uuid. The uuid is generated while creating new POI using APIs from content provider API, such as createAccommodation and createAttractions. You can retrieve uuids from searchKeywordByMultiDataset API.

GET

getDealsByUuids

https://api.stb.gov.sg/content/v1/deals/detail

Retrieve the full details of the Deal by providing its unique identifier. The acronym for the unique identifier is uuid. This API allows the retrieval of multiple uuids. The uuid is generated while creating new deal using createDeal from deal user and provider API. You can retrieve the uuids from searchDealsByKeyword API.

GET

listDealTypes

https://api.stb.gov.sg/content/v1/deals/types

Retrieve a list of deal types available, for example buy 1 get 1 free, discount and bundle.

GET

searchDealsByKeyword

https://api.stb.gov.sg/content/v1.1/deals

Retrieve the full list of deals. This API allows developers to retrieve a list of deals that matches the search criteria. The keyword will match with name, description and tags, returning the most relevant deal(s).