C1c1st
GiftCards

GET /giftcards

Search for giftcards

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/giftcards
  • Auth
    HTTP bearer

Query parameters

freetextstring

The free text that is used to search in name, type, giftcardno, phone etc.

fromdatestring

date

todatestring

date

giftcardidinteger

filter on id

customeridinteger

filter on customerid

giftcardnostring

filter on id

paginationStartinteger

Determine the offset (in number of item) to fetch. This is usually a multiple of the pageLength.

paginationPageLengthinteger

Determine the number of items to fetch in one page.

sortOrder-1 | 1

Sorting order. If order is 1, items are retrieved in ascending order, if -1, in descending order.

sortFieldstring

Sort by field e.g. giftcardno, date,..

Response

Ok

countinteger

The total number of items found by the query.

hasMoreboolean

True if there are data to retrieve than the given page length

Example response

{
  "content": [
    {
      "giftcardno": "1234567891234",
      "amount": 100,
      "store": {
        "countrydata": {
          "code": "DK",
          "currency": "DKK",
          "smsprice_dkk": 0.48,
          "smsprice_eur": 0.06
        }
      },
      "customer": {
        "id": 1,
        "storeid": 1,
        "createddate": "2019-01-02 01:02:03",
        "name": "John Doe",
        "phone": "+4533608586",
        "phone_e164": "+4533608586",
        "country": "dk",
        "email": "johndoe@example.com",
        "barcode": "1234567890",
        "address": "Andebyvej 1",
        "city": "Odense",
        "zipcode": "5000",
        "addr_country": "dk",
        "birthdate": "1993-12-31",
        "ean": "12345678",
        "vat": "12345678",
        "customerno": "19181715",
        "economic_customernumber": 12345678,
        "balance": 123.45,
        "note": "Pays on time.",
        "tags": [
          {
            "color": "#4baf4f"
          }
        ],
        "permission_marketing": "2022-03-10 00:00:00",
        "updated_at": "2022-03-10 00:00:00",
        "deleted_at": "2022-03-10 00:00:00",
        "store": {
          "id": 1
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.