Giftcard

A Giftcard is a gift card sold or issued by the museum. There are two kinds: membership gift cards, which are redeemed for a membership (membershipTypeId is set), and value gift cards, which carry an amount that is spent at the till (originalAmount and remainingAmount are set).

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"bd4a0997-39db-41d9-883a-cdfa83e2101f"
code*stringThe gift card code printed on the card"7391428650"
createdAtstringTimestamp when the gift card was created"2026-01-15T09:30:00.000Z"
expiresAtstringnullTimestamp when the gift card expires"2029-01-15T09:30:00.000Z"
membershipTypeIdstring (UUIDv4)nullThe membership type this gift card is redeemed for. Set on membership gift cards only"bd4a0997-39db-41d9-883a-cdfa83e2101f"
membershipTypeobjectnullNested membership type as it was when the gift card was issued (a snapshot). This is a subset: id, title, cycle, price. Set on membership gift cards only{ "id": "...", "title": "Yearly", "cycle": "YEARLY", "price": 54000 }
orderIdstring (UUIDv4)nullThe order the gift card was purchased on, if it was sold"bd4a0997-39db-41d9-883a-cdfa83e2101f"
redeemOrderIdstring (UUIDv4)nullThe order the gift card was redeemed on"bd4a0997-39db-41d9-883a-cdfa83e2101f"
receiverNamestringnullName of the person the gift card is for"Anna Jensen"
receiverGreetingstringnullGreeting printed on the gift card"Happy birthday!"
usedbooleanfalseWhether the gift card has been redeemed. Set when a membership gift card is redeemedfalse
batchCodestringnullThe batch the gift card was issued in, for gift cards created in batches"XMAS-2026"
originstringnullWhere the gift card was created, e.g. WEB, POS or ADMIN"WEB"
originalAmountnumbernullThe amount the gift card was issued with, in minor units (øre/cents). Set on value gift cards only50000
remainingAmountnumbernullThe amount left on the gift card, in minor units (øre/cents). Set on value gift cards only35000
testModebooleanWhether the gift card is a test record. Only included when the request is made with a test mode API keytrue
Copy
{ "id": "bd4a0997-39db-41d9-883a-cdfa83e2101f", "code": "7391428650", "createdAt": "2026-01-15T09:30:00.000Z", "expiresAt": "2029-01-15T09:30:00.000Z", "membershipTypeId": "0c1de555-6f74-4a83-91b0-0f6594306ac1", "membershipType": { "id": "0c1de555-6f74-4a83-91b0-0f6594306ac1", "title": "Yearly", "cycle": "YEARLY", "price": 54000 }, "orderId": "f0a52c7e-9e04-4bb4-bd38-1bb88e1dd0e4", "redeemOrderId": null, "receiverName": "Anna Jensen", "receiverGreeting": "Happy birthday!", "used": false, "batchCode": null, "origin": "WEB", "originalAmount": null, "remainingAmount": null }
‹ Previous
Membership
Next ›
Order