--- title: "GET /giftcards/{giftcardId}" method: GET path: "/giftcards/{giftcardId}" tags: ["GiftCards"] --- # GET /giftcards/{giftcardId} `GET /giftcards/{giftcardId}` ## Request - Base URL: `https://api.c1st.com/api` - URL: `https://api.c1st.com/api/giftcards/{giftcardId}` - Auth: HTTP bearer Get giftcards ## Path parameters - `giftcardId` integer, required ## Response `200` Ok. The created giftcard is returned in the response. - GetGiftcardResponse: Returns giftcard if found. - `content` Giftcard: A giftcard - `id` integer: A unique ID - `giftcardno` string: a unique string to identify giftcards. - `amount` number, double: The inital amount on the giftcard. Can only be set when the gift is created - `amountspent` number, double: The amount spent of the giftcard. Balance of the giftcard can be calculcated by `amount - amountspent`. - `paymentid` integer, nullable: If the giftcard was issued by a payment. - `type` 'giftcard' | 'voucher' | 'deposit' - `store` Store: Store object - `id` integer - `title` string, required - `cityname` string, nullable - `zipcode` string, nullable - `streetname` string, nullable - `streetno` string, nullable - `phone` string, nullable - `email` string, nullable - `website` string, nullable - `created` string - `countrydata` CountryData - `code` string: Country code in alpha2 format - `currency` string: Currency for this country - `smsprice_dkk` number: Price to send 1 sms to this country, in DKK - `smsprice_eur` number: Price to send 1 sms to this country, in EUR - `eu` boolean: true if country is member of EU - `customer` Customer: The representation of a customer. - `id` integer: A unique customer ID - `storeid` integer: ID for the store for which the customer is associated - `createddate` string, nullable - `name` string, nullable: The name of the customer. - `phone` string, nullable: The phone number of the customer. Should start with country code, like +45. If not, assume +45. - `phone_e164` string, nullable: Phone number in E.164 format, might sometimes be the same as "phone" but this field is guaranteed to be in E.164 format - `country` string, nullable: The country of the phone number. Must be in format ISO 3166-1 alpha-2. - `email` string, nullable: The email of the customer. - `barcode` string, nullable: Barcode used for POS customer lookup via barcode scanning. - `address` string, nullable: The address of the customer. - `city` string, nullable: The city of the customer. - `zipcode` string, nullable: The zip code of the customer. - `addr_country` string, nullable: The country of the customers address. - `lat` number, double, nullable: The latitude of the customer. - `lng` number, double, nullable: The longitude of the customer. - `birthdate` string, nullable - `ean` string, nullable: The EAN number associated with the customer. Must be a valid EAN. - `vat` string, nullable: The VAT/CVR number associated with the customer. - `customerno` string, nullable: The customer-number associated with the customer. - `economic_customernumber` integer, nullable: The e-conomic number of the customer. - `balance` number, nullable: The customer's balance - `note` string, nullable: A note about the customer. - `draft` integer: Whether or not the customer is in draft mode - `deleted` integer: Whether or not the customer is deleted - `tags` CustomerTag[], nullable: Tags associated with the customer. - `title` string, required: The title of the tag - `id` integer, nullable: The id of the tag - `handle` string, nullable: Unique handle for the produttag. Will be set automatically if not set. This value cannot be changed once set. - `color` string, nullable: The color used when displaying the tag in the app - `permission_marketing` string, nullable: Timestamp for if when the permission has been granted. `null` if permission hasn't been granted. - `updated_at` string, nullable: Timestamp for when the last time the customer is updated. - `deleted_at` string, nullable: Timestamp for when the last time the customer is deleted. - `loyaltypointsbalance` number, nullable: The customers loyalty point balance - `loyalty_member_since` string, nullable: Datetime of when the customer joined the loyalty club. If null, the customer is not part of the loyalty club - `loyalty_member_id` number, nullable: Assigned loyalty membership ID when the customer joined the loyalty club. If null, the customer is not part of the loyalty club - `shopify_customer_id` number, nullable: The corresponding ShopifyCustomerId if customer is syncronized with Shopify - `store` object: Name of partner store that customer is registered in. requires scope 'customerlookup' - `id` integer: Store id - `title` string: Store title - `customerid` integer, nullable: The unique customer ID of the currently registered customer of the giftcard, or null if none - `vat` number, nullable: The VAT percentage of the payment that issued the giftcard - `productid` integer, nullable: To be removed - `productno` string, nullable: To be removed - `external_id` number, nullable: The external id to Shopify etc. - `createddate` string: When the giftcard was created. - `expirationdate` string: When the giftcard expires. Defaults to the createddate + the value of the storeconfig "giftcard_expiration_years". - `draft` integer: Whether the giftcard is a draft (1) or finalized (0). Draft giftcards are created during discount-to-voucher conversion and finalized on payment completion. - `expired` boolean: If the giftcard has expired based on expirationdate. - `active` boolean, nullable: The giftcard is active if its not expired and amountspent is less than amount. - `deleted_at` string, nullable: When the giftcard was deleted. - `deleted` boolean: If the giftcard has been deleted based on deleted_at. ## Other responses - `404`: Giftcard not found. --- [API](https://skmtc.dev/c1st/apis/customers-1st-api.md) - [All operations](https://skmtc.dev/c1st/apis/customers-1st-api/llms.txt) - [OpenAPI document](https://skmtc.dev/c1st/apis/customers-1st-api/revisions/4250bb326f2a?raw)