LOTS Vendor API Documentation

Version 1.01 · Base URL: https://{your-domain}

Authentication

All API requests must include a Bearer Token in the HTTP Authorization header.

Authorization: Bearer <your-access-token>

Date & Time Format

All date and time fields follow the format below:

YYYY-MM-DD HH:MM:SS
Example: 2026-02-02 00:00:00

Retrieve Seasons POST

POST /api/lots/season

Retrieve season records based on filter criteria.

Request Parameters (JSON Body)

Field Type Required Description
carparkCode string[] Yes Array of carpark codes.
seasonStatus string[] Yes Array of season status values:
  • Expired – Season which has expired
  • Terminated – Terminated season
  • Active – Active season
  • ActiveTerminated – Active season but terminated (termination date earlier than today)
  • ExpiredComplimentary – Expired complimentary season
  • ActiveComplimentary – Active complimentary season
seasonType string[] No Array of season type.
createTime string No The exact date and time when the season was created.
createTimeFrom string No Filters seasons created from the specified date and time.
createTimeTo string No Filters seasons created up to the specified date and time.
seasonStartDate string No The exact date and time when the season starts.
seasonStartDateFrom string No Filters seasons starting from the specified date and time.
seasonStartDateTo string No Filters seasons starting up to the specified date and time.
seasonEndDate string No The exact date and time when the season ends.
seasonEndDateFrom string No Filters seasons ending from the specified date and time.
seasonEndDateTo string No Filters seasons ending up to the specified date and time.
updateTimeFrom string No Filters records updated from the specified date and time.
updateTimeTo string No Filters records updated up to the specified date and time.
terminationEndDate string | null No The date and time when the season is scheduled to terminate. Default is null.
terminationEndDateFrom string No Filters seasons with termination end dates from the specified date and time.
terminationEndDateTo string No Filters seasons with termination end dates up to the specified date and time.

Filtering Rules

  • If both createTimeFrom and createTimeTo are provided, the query will use BETWEEN createTimeFrom AND createTimeTo.
  • If both seasonStartDateFrom and seasonStartDateTo are provided, the query will use BETWEEN seasonStartDateFrom AND seasonStartDateTo.
  • If both seasonEndDateFrom and seasonEndDateTo are provided, the query will use BETWEEN seasonEndDateFrom AND seasonEndDateTo.
  • If both updateTimeFrom and updateTimeTo are provided, the query will use BETWEEN updateTimeFrom AND updateTimeTo.
  • If both terminationEndDateFrom and terminationEndDateTo are provided, the query will use BETWEEN terminationEndDateFrom AND terminationEndDateTo.

Sample Request

{
  "carparkCode": ["CP001", "CP002"],
  "seasonStatus": ["Active", "Expired"],
  "createTimeFrom": "2026-01-01 00:00:00",
  "createTimeTo": "2026-02-01 23:59:59"
}

Sample Response


[
  {
    "carparkName": "LORUM IPSUM",
    "carparkCode": "LORUM IPSUM",
    "carparkAddress": "LORUM IPSUM",
    "buyerName": "LORUM IPSUM",
    "buyerEmail": "LORUM IPSUM@testing.com.sg",
    "buyerCompany": "LORUM IPSUM PTE LTD",
    "seasonType": "Season with VPC",
    "seasonStatus": "Expired",
    "orderNumber": "ORDW/000001/2024",
    "invoiceNumber": "INV/000001/2024",
    "vehicleNo": "LORUM IPSUM",
    "vehicleType": "LORUM IPSUM",
    "iUNo": "1234567890",
    "createTime": "2024-11-21 15:33:55",
    "updateTime": "2025-12-17 17:02:50",
    "id": 694912,
    "seasonStartDate": "2025-01-01 00:00:00",
    "seasonEndDate": "2025-01-31 00:00:00",
    "terminationEndDate": null
  }
]
              
          

Response Fields

FieldDescription
carparkNameName of the carpark.
carparkCodeCode identifier for the carpark.
carparkAddressFull address of the carpark.
buyerNameName of the season ticket buyer.
buyerEmailEmail address of the buyer.
buyerCompanyCompany name of the buyer.
seasonTypeType of season ticket (e.g., Season with VPC).
seasonStatusCurrent status of the season (Active, Expired, Terminated, etc.).
orderNumberOrder number associated with the season ticket.
invoiceNumberInvoice number linked to the order.
vehicleNoVehicle registration number.
vehicleTypeType or category of the vehicle.
iUNoIU (In-Unit) number for the vehicle.
createTimeTimestamp when the season record was created.
updateTimeTimestamp of the last update to the season record.
idUnique identifier for the season record.
seasonStartDateStart date and time of the season.
seasonEndDateEnd date and time of the season.
terminationEndDateDate and time when the season will be terminated (null if not terminated).

Retrieve Vehicle Change Requests POST

POST /api/lots/vehicle-change-request

Retrieve vehicle change request records based on filter criteria.

Request Parameters (JSON Body)

Field Type Required Description
carparkCode string[] Yes Array of carpark codes.
effectiveDateTimeFrom string Yes Filter vehicle change requests effective from the specified date and time.
effectiveDateTimeTo string Yes Filter vehicle change requests effective up to the specified date and time.

Filtering Rules

  • If both effectiveDateTimeFrom and effectiveDateTimeTo are provided, the query will use BETWEEN effectiveDateTimeFrom AND effectiveDateTimeTo.

Sample Request

{
  "carparkCode": ["CP001"],
  "effectiveDateTimeFrom": "2026-01-01 00:00:00",
  "effectiveDateTimeTo": "2026-02-01 23:59:59"
}

Sample Response

[
  {
    "carparkCode": "Lorum Ipsum",
    "oldVehicleNumber": "Lorum Ipsum",
    "vehicleNumber": "Lorum Ipsum",
    "requestType": "All",
    "oldCardNumber": "1234567890",
    "cardNumber": "1234567890",
    "id": 9510,
    "effectiveDateTime": "2025-12-16 13:00:01"
  }
]

Response Fields

FieldDescription
carparkCodeCode identifier for the carpark.
oldVehicleNumberThe vehicle number before the change request.
vehicleNumberThe updated vehicle number after the change request.
requestTypeType of change request. Possible values:
  • All – update both IU & vehicle number
  • Vehicle Number – update vehicle number only
  • Card Number – update IU/card number only
oldCardNumberThe card/IU number before the change request.
cardNumberThe updated card/IU number after the change request.
idUnique identifier for the vehicle change request record.
effectiveDateTimeThe date and time when the vehicle change request takes effect.