Get a stamper card

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/stamper-cards/{stamper_card_id}

Get a definition of a specific stamper card.
⚠️ If no card is returned for active campaign, that means a customer did not collect any stamps yet, so card was not created. After he collects fist stamp, the card will be automatically generated.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

data

object

Stamper card resource.

stamper_card_id

string

The unique ID of the stamper card.

stamper_campaign_id

string

The unique ID of the stamper campaign that the card is part of. The list of stamper campaign is available at GET /stamper-campaigns

customer_id

string

The unique ID of the card holder.

stamper_card_order

integer

An order of the stamper card in the stamper campaign. The stamper campaign can have multiple stamper cards and this parameter determine the order how they were used in the campaign.

is_filled_up

boolean

If true, the card contain all stamps. If false, the card has still free spots for the stamp.

created_at

string

Date and time when stamper card was created. (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 card.
Possible values are: 0 - blocked / 1 - active

1

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/stamper-cards/stamper_card_id \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
12
 
1
{
2
  "data": {
3
    "stamper_card_id": "81eaeea13b8984a169c490a325",
4
    "stamper_campaign_id": "8bed991c68a470e7aaeffbf048",
5
    "customer_id": "8ea2591121e636086a4a9c0992",
6
    "stamper_card_order": 2,
7
    "is_filled_up": false,
8
    "created_at": "2023-03-28 16:59:49",
9
    "last_change": "2019-07-15 17:26:34",
10
    "state": 1
11
  }
12
}

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.