GET /loyalty/{program_id}/identifiersΒΆ
Get a list of loyalty identifiers and their values.
Path parameters:
Name |
Type |
Description |
---|---|---|
|
integer, required |
the loyalty program identifier |
Query parameters:
Name |
Type |
Description |
---|---|---|
|
boolean, optional, default: false |
readable output formatting |
|
string, optional |
a consumer identifier |
|
integer, optional, min: 1, max: 100, default: 100 |
number of returned loyalty identifiers |
Example request:
GET /loyalty/1/identifiers HTTP/1.1
Host: api.ereceipts.co.uk
Accept: application/json
Example response:
This response contains two loyalty identifiers, sorted over value
in
descending order. See Loyalty Identifier Object for a description of
the format.
HTTP/1.1 200 OK
Content-Length: 125
Content-Type: application/json; charset=UTF-8
[
{
"identifier": "990000000002",
"value": 100.0
},
{
"identifier": "990000000001",
"value": 50.0
}
]
A downloadable CSV file can be requested as follows:
GET /loyalty/1/identifiers.csv HTTP/1.1
Host: api.ereceipts.co.uk
Accept: text/csv