Get all stamper stamps

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/stamps

Get a list of stamps.

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

Direction of sorting the response list.

stamper_card_id

string

The unique ID of the stamper card. The filter reduces data in the response related only to the selected stamper cards.
In case you want to filter multiple options use array syntax: stamper_card_id[]=8bc8ca16f9c5039951021700a2&stamper_card_id[]=82c06812c0756528660784fef

customer_id

string

The unique ID of the customer.

stamper_condition_id

string

The unique ID of the stamper condition.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

stamper_stamps

array of objects

List of stamps.

stamper_stamps

object

stamp_id

string

The unique ID of the stamper stamp.

customer_id

string

The unique ID of the stamper card holder.

purchase_id

string

The unique ID of the purchase that triggered the stamp to be collected.

stamper_card_id

string

The unique ID of the stamper card.

stamp_order

integer

An order of the stamp in the card. If null, the stamp is not assign to any stamper card.

stamper_condition_id

string

The unique ID of the stamper condition. An information about condition is available at the stamper campaign that stamp is part of.

created_at

string

Date and time when the customer collected the stamp. (YYYY-MM-DD HH:MM:SS)

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the stamp.
Possible values are: 0 - deleted / 1 - active

1

total_items

integer

The number of all found stamps.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/stamps?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
18
 
1
{
2
  "data": {
3
    "stamper_stamps": [
4
      {
5
        "stamp_id": "81eaeea13b8984a169c490a325",
6
        "customer_id": "8ea2591121e636086a4a9c0992",
7
        "purchase_id": "81eaeea13b8984a169c490a325",
8
        "stamper_card_id": "8bed991c68a470e7aaeffbf048",
9
        "stamp_order": 7,
10
        "stamper_condition_id": "8bed991c68a470e7aaeffbf048",
11
        "created_at": "2024-07-15 17:26:34",
12
        "last_change": "2025-03-15 17:26:34",
13
        "state": 1
14
      }
15
    ],
16
    "total_items": 1
17
  }
18
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.