--- title: "GET /api/pos/{id}/scannable" method: GET path: "/api/pos/{id}/scannable" tags: ["api", "pos"] --- # GET /api/pos/{id}/scannable `GET /api/pos/{id}/scannable` Get scannable information for a code ## Path parameters - `id` string, required ## Query parameters - `code` string, required — The scannable code ## Response `200` OK - union - object - `type` 'product', required - `resource` object - `_id` string, required — The ID of the product - `name` string, required — The name of the product - `active` boolean — Whether the product is active and can be distributed - `isFulfillable` boolean — Whether the product can be delivered - `type` 'voucher' | 'product' | 'donation' | 'membership' | 'addOn', required — The type of the product - `image` string, nullable — The image of the product - `description` string, nullable — The description of the product - `variants` object[] — An array of variants of the product - `_id` string, required — The ID of the product variant of the product - `name` string, nullable — The Name of the product variant, defaults to product name if not specified - `description` string, nullable — A description of the variant - `priceType` 'fixed' | 'range' - `price` number, float, nullable — The price of the product - `priceRange` object - `min` number, float, nullable — The minimum price of the product - `max` number, float, nullable — The maximum price of the product - `taxable` boolean, required — Whether the product is taxable or not - `taxRate` number, float — The tax rate of the product - `compareAtPrice` number, float, nullable — The recommended retail price to compare with the actual price. - `taxServiceTypeId` string, nullable — The ID of the tax service of the product - `gtin` string - `localization` object — Localization of the product for multiple languages - `categoryIds` string[] — An array of categories to which the product belongs - `voucherSettings` object, nullable — If the product is of type voucher - `limitedValidityPeriod` boolean — Whether the voucher should expire - `validityConfig` object - `amount` number, float - `type` number, float - `untilEndOfPeriod` boolean - `pdfImage` string — A marketing image printed onto voucher pdf - `disclaimer` string, nullable — A disclaimer text printed onto voucher pdf - `documentTemplateSettings` object - `templates` object[] - `templateId` string, required — The ID of the document template - `format` 'A4' | 'LETTER' | 'LEGAL' | 'BOARDING-PASS' | 'PLASTIC-CARD' | 'CARD' | 'LABEL' | 'CUSTOM' | 'APPLE' | 'GOOGLE', required — The format of document template for the dimensions. - `target` 'thermal' | 'digital' | 'wallet', required — The target of document template for which targets it should be used. - `type` 'ticket' | 'invoice' | 'voucher' | 'member-card' | 'header-card', required — The type of document template for which document it should be used. ticket = The document template will be used on tickets. invoice = The document template will be used on invoices. - `addOnSettings` object, nullable - `optOutDescription` string, nullable — The description that is shown to the user if he decides to not buy the addOn - `localization` object — Localization of the addOnSettings for multiple languages - `donationSettings` object, nullable — Settings for donation products - `campaignId` string, required — The ID of the fundraise campaign - `fundId` string, required — The ID of the donation fund - `sellerId` string, required — The ID of the seller of the product - `meta` object — Custom key-value data. Metadata is useful for storing additional, structured information on an object. - `localization` object — Localization of the product for multiple languages - `createdAt` string, date-time — An ISO timestamp indicating when the product was created - `updatedAt` string, date-time — An ISO timestamp indicating when the product was updated - object - `type` 'coupon', required - `resource` union - CouponWithSeriesResource - `couponType` 'couponSeries', required - `couponSeriesId` string, required — The ID of the coupon series. - `_id` string — The ID of the coupon. - `code` string, nullable — A random generated 8 char code use to redeem the coupon. - `sellerId` string — The ID of the seller. - `customer` string, nullable — The customer that this promotion code can be used by. - `createdAt` string, date-time — The date the coupon was created. - `updatedAt` string, date-time — The date the coupon was last updated. - `__v` integer - CouponSingleResource - `couponType` 'coupon' - `_id` string — The ID of the coupon. - `code` string, nullable — A random generated 8 char code use to redeem the coupon. - `sellerId` string — The ID of the seller. - `customer` string, nullable — The customer that this promotion code can be used by. - `createdAt` string, date-time — The date the coupon was created. - `updatedAt` string, date-time — The date the coupon was last updated. - `__v` integer - `name` string, required — The Name for the coupon. Visible to public. - `singleUsage` boolean — Whether this coupon can only be used once - `active` boolean — Whether the coupon can be used - `maxUsage` number, float — The max amount of usages. A usage is counted as a completed transaction that used the coupon. - `maxUsagePerEvent` number, float, nullable — The max amount of usages per event. A usage is counted as a completed transaction that used the coupon. - `maxTickets` number, float, nullable — The number of tickets that can be purchased with this coupon - `canBeCombined` boolean — Whether this coupon can be combined with others within one transaction. - `discountType` 'fix' | 'var' | 'fixPerItem' | 'waiveFees' - `discountValue` number, float — The amount of the discount in seller's currency. eg. 50.0 -> 50 EUR - `discountMaxValue` number, float, nullable — When discountType is VAR the max amount of the discount in seller's currency - `allowAllEvents` boolean — Whether the coupon can be used across all events - `allowedEvents` string[] — The ID's of events where the coupon can be used - `allowAllTickets` boolean — Whether the coupon can be used across all tickets within the events - `allowedTickets` string[] — The ID's of the ticket types on which the coupon should be applied - `taggingEnabled` boolean — Whether this coupon tags customers - `tags` string[] — Which tags to add to customers which bought with this coupon - `validFrom` string, date-time, nullable — The date from which this coupon can be redeemed. - `validUntil` string, date-time, nullable — The date until this coupon can be redeemed. - `limitMaxTicketsInCart` boolean — Whether this coupon limits the max tickets in cart. - `maxTicketsInCart` number, float, nullable — If limitMaxTicketsInCart is true, the amount of the max allowed tickets. - `minTicketsInCart` number, float, nullable — The minimum number of tickets that need to be purchased with this coupon - `note` string, nullable — The Note for this coupon. - `revealAllowedTickets` boolean — Whether this coupon reveals the allowed tickets. - `unlocks` object[] — The array of the resources unlocked by undershop. - `target` 'underShop', required - `eventId` string, required — The ID of the event. - `underShopId` string, required — The ID of the under shop. - object - `type` 'voucher', required - `resource` PublicVoucherInfoResource - `_id` string, required - `code` string, required - `balance` number, float, required ## Other responses - `400` — Bad Request - `401` — Unauthorized --- [API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)