Skip to content
Physical Prizes

Get Prize Details

Returns a single prize (physical goods, e-voucher, or redemption code) by reward record ID, for the prize details page that shows the item, grant and delivery status, fulfillment and recipient details, e-voucher claim result, and whether it can be exchanged for a cash card. Fields match the prize object in GET /rewards/member_reward_list.

For physical goods, deliver_status can also return 8 (address not provided), 9 or 11 (address provided), or 10 (shipping). Decide the next step from status and deliver_status:

  • Before a tracking number deliver_order exists, call POST /rewards/update_express_info to provide or change recipient details.
  • When to_cash_card is true, call POST /reward/prize/to/cash-card to exchange it for a cash card.
GEThttps://api.lbkrs.com/rewards/reward_prize_info

Parameters

record_idstringqueryRequired

Prize record ID, that is, prize.record_id

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get prize details” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Physical reward information

record_idstring

Record id

prize_idstring

Physical item id

activity_titlestring

Campaign name

titlestring

Physical item title

coverstring

Cover image

descriptionstring

Client-facing description.

statusinteger

Issuance status (applicable values vary slightly by reward type):

  • 0 - Pending issuance
  • 1 - Issuance cancelled
  • 2 - Withdrawn from campaign
  • 8 - Awaiting claim
  • 10 - Issuing
  • 12 - Issued
  • 13 - Issuance failed
  • 16 - Redeemed (coupon/voucher only)
  • 17 - Expired (physical/coupon only)
Values
0
1
2
8
10
12
13
16
17
exit_statusinteger

Cancel issuance reason (only meaningful when status=1 cancelled issuance):

  • 0 - Did not meet campaign threshold
  • 1 - Campaign mutually exclusive
Values
0
1
send_timestring

Grant time

deliver_orderstring

Logistics/tracking number; present only when shipped

detailstring

Physical item details

deliver_statusinteger

Delivery status (used for subsequent states of status=12 - Issued):

  • 0 - Not activated
  • 1 - Activated
  • 2 - Consumed
  • 5 - E-voucher activating
  • 6 - E-voucher expired and cannot be activated
  • 7 - E-voucher invalid and cannot be consumed
Values
0
1
2
5
6
7
prize_typeinteger

Physical goods business type:

  • 0 - Physical product
  • 1 - E-voucher
Values
0
1
provider_codestring

E-voucher provider: chengquan (Chengquan provider), manager (contact account manager to obtain), deposit (deposit), apple_card (Apple top-up card)

Values
chengquan
manager
deposit
apple_card
end_timestring

E-voucher unactivated expiry time; 0 means does not expire

goods_resultstring

Result after e-voucher activation, e.g., QR code URL or Apple card serial number (JSON)

effective_timestring

Validity period after e-voucher activation; 0 means always valid

reward_rule_urlstring

Link to reward distribution rules; when both this and reward_rule_description exist, this link often takes priority

reward_rule_descriptionstring

Reward distribution rule description

campaign_codestring

Campaign code

express_infoobject

Logistics information for physical item delivery

Child attributes
addresseestring

Recipient

phonestring

Phone

shipping_addressstring

Shipping address

provincestring

Province

citystring

City

districtstring

District

delivery_typestring

Delivery method:

  • 1 - Self pickup
  • 2 - Mail
pickup_infoobject

Self-pickup information

Child attributes
briefstring

Brief description

detailstring

Detailed description

emailstring

Email

country_codestring

Country/region code

receive_deadlinestring

Physical goods collection deadline

delivery_typesarray<integer>

Physical product delivery method:

  • 1 - Self pickup
  • 2 - Mail
addressesarray<object>

Physical goods pickup address information

Child attributes
briefstring

Address short name

detailstring

Address details

coupon_secret_idstring

0 indicates no stock at the time of reward grant; restocking required later

coupon_secretobject

E-voucher information

Child attributes
coupon_secret_typestring

E-voucher type

coupon_idstring

Card number

secretstring

Card PIN

statusinteger

E-voucher status:

  • 0 - Available
  • 1 - Locked (reward issued, Client has not yet claimed)
  • 2 - Claimed
  • 3 - Voucher code expired
Values
0
1
2
3
expire_atstring

Redemption deadline

to_cash_cardboolean

Can be redeemed for a cash card

cash_card_codestring

Cash card code

cash_card_valueobject

Cash card value

coupon_secret_typestring

E-voucher type

Whale Docs