Skip to content

Get Offers

This endpoint gets list of offers for a customer.

1
GET /customers/<customerId>/offers

Input Parameters

Path Param Type Required Description
customerId int Required Unique identifier for customer
Query Param Type Required Description
merchantName string Optional The name of the merchant this offer is for. If provided, then this should be exact match of Merchant name
offerStatus int Optional The status of the offer for the customer. See the OfferStatus section for details
startDate string Optional Date string representing the date the offer starts
endDate string Optional Date string representing the date the offer ends

Output

This endpoint returns an array of OfferFilterResponse.


Example

Request

1
GET /v1/customers/2349/offers

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
      {
            "offerId": 1000022731,
            "customerId": 2349,
            "startDt": "2021-08-23T00:00:00",
            "endDt": "2021-10-10T00:00:00",
            "redemptionName": "Benjamin Moore",
            "offerStatus": null
      },
      {
            "offerId": 1000025038,
            "customerId": 2349,
            "startDt": "2021-10-27T00:00:00",
            "endDt": "2021-11-10T00:00:00",
            "redemptionName": "Redemption Name Not Available",
            "offerStatus": null
      }
]