Collectibles

Browse available collectibles and customer-owned copies. A collectible is the item definition; a user collectible is a particular customer ownership record.

Access labels such as Origin + Brand key + Customer are defined in Headers and access. Each endpoint ends in a Try it console; set the host and keys once in its Settings tab or on the overview.

Get all collectible

Method	URL path	Required access
GET	/api/v1/brand/collectibles	Origin + Brand key + Customer

Request fields:

Field	Type	Required	Rules / meaning
query.tag	string	optional	No controller schema

Example:

curl -X GET "$BASE_URL/api/v1/brand/collectibles" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY" \
  -H "Authorization: Bearer $CUSTOMER_TOKEN"

Response: JSON with success: true and result containing the operation’s service data. Result fields/details: Available collectible definitions and assets.

Source: app/v1/controller/usercollectible_controller.ts:15 → getAllCollectible; routes: routes/v1/usercollectible_route.ts:133; service: _getAllCollectible (app/v1/service/usercollectible_service.ts:7).

Get all user collectible

Method	URL path	Required access
GET	/api/v1/user/collectibles	Origin + Brand key + Customer

Request fields:

Field	Type	Required	Rules / meaning
query.tag	string	optional	No controller schema

Example:

curl -X GET "$BASE_URL/api/v1/user/collectibles" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY" \
  -H "Authorization: Bearer $CUSTOMER_TOKEN"

Response: JSON with success: true and result containing the operation’s service data. Result fields/details: Collectible ownership records for the current customer.

Source: app/v1/controller/usercollectible_controller.ts:31 → getAllUserCollectible; routes: routes/v1/usercollectible_route.ts:142; service: _getAllUserCollectible (app/v1/service/usercollectible_service.ts:64).

Get user collectible by ID

Method	URL path	Required access
GET	/api/v1/user/collectible/:id	Origin + Brand key + Customer

Request fields:

Field	Type	Required	Rules / meaning
path.id	number	yes	—

Example:

curl -X GET "$BASE_URL/api/v1/user/collectible/1" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY" \
  -H "Authorization: Bearer $CUSTOMER_TOKEN"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/usercollectible_controller.ts:46 → getUserCollectibleById; routes: routes/v1/usercollectible_route.ts:162; service: _getUserCollectibleById (app/v1/service/usercollectible_service.ts:108).

Get collectible by ID

Method	URL path	Required access
GET	/api/v1/collectible/:id	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
path.id	number	yes	—

Example:

curl -X GET "$BASE_URL/api/v1/collectible/1" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/usercollectible_controller.ts:101 → getCollectibleById; routes: routes/v1/usercollectible_route.ts:152; service: _getCollectibleById (app/v1/service/usercollectible_service.ts:145).

Get trending collectibles

Lists the brand's available, unarchived collectibles with their assets, oldest first. The route sits in the loyalty campaign controller, but the service reads only collectibles and returns no campaign data.

Method	URL path	Required access
GET	/api/v1/brand/loyalty/collectibles/trending	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
query	object	optional	—
query.tag	string	optional	Whitespace trimmed; pattern(/^[a-zA-Z0-9_-]+(,[a-zA-Z0-9_-]+)*$/); Maximum (200)

tag accepts comma-separated identifiers with a maximum total length of 200.

Example:

curl -X GET "$BASE_URL/api/v1/brand/loyalty/collectibles/trending" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data.

Source: app/v1/controller/loyalty_campaign_controller.ts:348 → getTrendingCollectibles; routes: routes/v1/loyalty_campaign_route.ts:249; service: _getTrendingCollectibles (app/v1/service/loyalty_campaign_service.ts:1089).

Related pages

• Collectible page (web)
• Ownership-transfer flow (web)
• Batch Commerce API overview
• Collectibles
• Implementation notes