Retrieve Coupon Pool List

API Documentation

Retrieve Coupon Pool List

Get coupon pool list API give the list of all coupon pool available in LMS

Endpoint:

Get /
/api/v1/CouponPool?page=1&limit=10

Request Parameters

Page Int (Optional)

The number of pages of the list.

Limit Int (Optional)

The limit of the list.

Response

Id Int(Not Nullable)

The Id of the coupon pool.

Name String(Not Nullable)

The Name of the coupon pool.

Starts String(Nullable)

The start time of the coupon pool.

Expires String(Nullable)

The end time of the coupon pool.

Size Int(Nullable)

The size of the coupon pool.

CompanyId Int(Not Nullable)

The CompanyId chosen for coupon pool.

ProfileId Int(Not Nullable)

The ProfileId chosen for coupon pool.

InvoiceDetailId Int(Nullable)

The InvoiceDetailId interlinked for invoice in coupon pool.

InvoiceId Int(Nullable)

The Invoice Id interlinked for invoice in coupon pool.

InvoiceNumber String(Nullable)

The Invoice Number interlinked for invoice in coupon pool.

Created DateTime(Not Nullable)

The datetime on which coupon pool was created.

LastModified DateTime(Not Nullable)

The datetime on which coupon pool was created.

				
					{
  "success": true,
  "message": "Data retrieved successfully.",
  "data": {
    "totalPages": 1,
    "currentPage": 1,
    "couponPools": [
      {
        "id": 72315,
        "name": "testing CP",
        "starts": "2023-12-05",
        "expires": "2025-01-29",
        "size": 70,
        "valueUnitId": 2,
        "companyId": 448230,
        "profileId": 6232,
        "invoiceDetailId": null,
        "invoiceId": null,
        "invoiceNumber": null,
        "created": "2023-12-05 19:21:04",
        "lastModified": "2024-12-09 13:22:40"
      },
      {
        "id": 76230,
        "name": "testing CP1",
        "starts": "2023-12-05",
        "expires": "2025-01-20",
        "size": 70,
        "valueUnitId": 2,
        "companyId": 442340,
        "profileId": 60232,
        "invoiceDetailId": null,
        "invoiceId": null,
        "invoiceNumber": null,
        "created": "2024-12-09 13:24:14",
        "lastModified": "2024-12-09 13:24:14"
      },
      {
        "id": 763321,
        "name": "testing CP2",
        "starts": "2023-12-05",
        "expires": "2025-01-24",
        "size": 70,
        "valueUnitId": 2,
        "companyId": 4423940,
        "profileId": 6232,
        "invoiceDetailId": null,
        "invoiceId": null,
        "invoiceNumber": null,
        "created": "2024-12-09 13:24:27",
        "lastModified": "2024-12-09 13:24:27"
      },
      {
        "id": 763242,
        "name": "testing center exanple",
        "starts": "2023-12-05",
        "expires": "2025-01-29",
        "size": 60,
        "valueUnitId": 2,
        "companyId": 4423940,
        "profileId": 6232,
        "invoiceDetailId": null,
        "invoiceId": null,
        "invoiceNumber": null,
        "created": "2024-12-09 13:24:37",
        "lastModified": "2024-12-09 13:28:31"
      }
    ]
  }
}