--- title: "Gets the site item profile and its related data for a specified site" method: GET path: "/ocapi/v1/sites/{siteId}/item-profile" tags: ["Items"] --- # Gets the site item profile and its related data for a specified site `GET /ocapi/v1/sites/{siteId}/item-profile` #### Licenses Required - Vista.Ocapi ## Path parameters - `siteId` string, required ## Headers - `Connect-Region-Code` string ## Response `200` Success - OcapiV1SalesMasterDataItemsProfilesSiteItemProfileDetails — Represents the details of a site item profile entity, and its related data - `itemProfile` OcapiV1SalesMasterDataItemsProfilesSiteItemProfile, required — Represents an item profile for a site - `pages` OcapiV1SalesMasterDataItemsProfilesItemProfilePage[], required — Gets the list of item profile page entities - `number` integer, required — Gets the number that can be used to uniquely identify the page within the item profile - `title` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `buttons` OcapiV1SalesMasterDataItemsProfilesItemProfileButton[], required — Gets the list of item profile button entities - `itemId` string, required — Gets the unique identifier of the item base entity - `prices` OcapiV1SalesMasterDataItemsPricesItemPrice[], required — Gets the list of item price entities - `price` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value - `valueIncludingTax` number, double, required — Gets the monetary value including tax - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax - `tax` number, double, required — Gets the amount of tax - `isDefault` boolean, required — Gets a value indicating whether this is the default price - `restrictions` OcapiV1SalesMasterDataItemsPricesItemPriceRestriction[], required — Gets the restrictions that apply - `rewardId` integer, nullable — Gets the unique identifier of the reward that the price is restricted to - `discount` OcapiV1SalesMasterDataPricesPriceDiscount — Represents the calculation logic and savings associated with a discounted price - `calculation` union, required — Represents the base properties that describe the calculation of a discount - … - `amountSaved` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value - … - `discountId` string, nullable — Gets the unique identifier of the discount that the price is restricted to - `title` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `displayPriority` integer, required — Gets the display priority used for sorting - `displayPriority` integer, required — Gets the display priority used for sorting - `siteId` string, required — Gets the unique identifier of the site - `isDefault` boolean, required — Gets a value indicating whether this is the default item profile for the site - `orderTipOptions` OcapiV1SalesMasterDataOrderTipOptionsOrderTipOption[], required — Gets the list of order tip option entities - `percentage` integer, required — Gets the amount to tip, as a percentage of the total cost of the standard order Items - `isDefault` boolean, required — Gets a value indicating whether this option is applied to an in progress standard order by default - `itemShowtimeDeliveryWindows` OcapiV1SalesMasterDataItemsShowtimeDeliveryWindowsItemShowtimeDeliveryWindowMinutesFromStart[], required — Gets the list of item showtime delivery window base entities - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `type` 'MinutesFromStart', required — Represents the type of an item showtime delivery window base - `siteOrderLocationId` string, nullable — Gets the unique identifier of the site order location, if applicable - `relatedData` OcapiV1SalesMasterDataItemsProfilesSiteItemProfileRelatedData, required — Related data for a site item profile entity - `discounts` OcapiV1SalesMasterDataDiscountsDiscount[], required — Gets the list of related discount entities - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `restriction` 'None' | 'Multiple' | 'MemberReward' | 'Voucher' | 'Availability', required — Represents the restriction options for a discount - `restrictions` OcapiV1SalesMasterDataDiscountsDiscountRestriction[], required — Gets the restrictions - `rewardIds` integer[], required — Gets the list of unique identifiers of the reward entities that the discount is restricted to - `voucherTypeCodes` string[], required — Gets the list of unique identifiers of the voucher types that the discount is restricted to - `expiresAt` string, date-time, required — Gets the date and time that the discount expires - `items` union[], required — Gets the list of related item base entities - union — Represents the base properties of an item that is available for sale - OcapiV1SalesMasterDataItemsWeightBasedWeightBasedItem — Represents the base properties of an item that is available for sale - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `shortName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `description` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `restrictions` OcapiV1SalesMasterDataItemsItemRestriction[], required — Gets the restrictions that apply - `type` 'Normal' | 'ParentSales' | 'Package' | 'Recipe' | 'WeightBased', required — Represents the type of an item base entity - `itemClassId` string, nullable — Gets the unique identifier of the item class the item belongs to, if applicable - `hopk` string, nullable — Gets the Head Office primary key - `hoCode` string, required — Gets the Head Office code - `isSundry` boolean, required — Gets a value indicating whether this is a sundry item - `isPreparationRequired` boolean, required — Gets a value indicating whether the item requires preparation - `allowedDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities - `availableHoursId` string, nullable — Gets the unique identifier of the available hours entity - `barcodes` string[], required — Gets the list of barcodes configured on the item at cinema - OcapiV1SalesMasterDataItemsRecipeRecipeItem — Represents an item base that supports item modifier group entities and has one or more recipe item Components, e.g. a drink made up of a cup, straw, post-mix syrup, and ice - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `shortName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `description` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `restrictions` OcapiV1SalesMasterDataItemsItemRestriction[], required — Gets the restrictions that apply - `itemClassId` string, nullable — Gets the unique identifier of the item class the item belongs to, if applicable - `hopk` string, nullable — Gets the Head Office primary key - `hoCode` string, required — Gets the Head Office code - `isSundry` boolean, required — Gets a value indicating whether this is a sundry item - `isPreparationRequired` boolean, required — Gets a value indicating whether the item requires preparation - `allowedDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities - `availableHoursId` string, nullable — Gets the unique identifier of the available hours entity - `barcodes` string[], required — Gets the list of barcodes configured on the item at cinema - `modifierGroups` OcapiV1SalesMasterDataItemsNormalNormalItemModifierGroup[], required — Gets the list of normal item modifier group entities - `itemModifierGroupId` string, required — Gets the unique identifier of the item modifier group - `displayPriority` integer, required — Gets the display priority used for sorting - `type` 'Normal' | 'ParentSales' | 'Package' | 'Recipe' | 'WeightBased', required — Represents the type of an item base entity - `components` OcapiV1SalesMasterDataItemsRecipeRecipeItemComponent[], required — Gets the list of recipe item component entities - `itemId` string, required — Gets the unique identifier of the item base entity - `isModifiable` boolean, required — Gets a value indicating whether the component can be modified via an order recipe item component modification - `displayPriority` integer, required — Gets the display priority used for sorting - `prices` OcapiV1SalesMasterDataItemsPricesItemPrice[], required — Gets the list of item price entities incurred when adding extra of the component to the recipe - … - OcapiV1SalesMasterDataItemsParentSalesParentSalesItem — Represents the base properties of an item that is available for sale - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `shortName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `description` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `restrictions` OcapiV1SalesMasterDataItemsItemRestriction[], required — Gets the restrictions that apply - `type` 'Normal' | 'ParentSales' | 'Package' | 'Recipe' | 'WeightBased', required — Represents the type of an item base entity - `itemClassId` string, nullable — Gets the unique identifier of the item class the item belongs to, if applicable - `hopk` string, nullable — Gets the Head Office primary key - `hoCode` string, required — Gets the Head Office code - `isSundry` boolean, required — Gets a value indicating whether this is a sundry item - `isPreparationRequired` boolean, required — Gets a value indicating whether the item requires preparation - `allowedDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities - `availableHoursId` string, nullable — Gets the unique identifier of the available hours entity - `barcodes` string[], required — Gets the list of barcodes configured on the item at cinema - OcapiV1SalesMasterDataItemsPackagesPackageItem — Represents the base properties of an item that is available for sale - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `shortName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `description` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `restrictions` OcapiV1SalesMasterDataItemsItemRestriction[], required — Gets the restrictions that apply - `type` 'Normal' | 'ParentSales' | 'Package' | 'Recipe' | 'WeightBased', required — Represents the type of an item base entity - `itemClassId` string, nullable — Gets the unique identifier of the item class the item belongs to, if applicable - `hopk` string, nullable — Gets the Head Office primary key - `hoCode` string, required — Gets the Head Office code - `isSundry` boolean, required — Gets a value indicating whether this is a sundry item - `isPreparationRequired` boolean, required — Gets a value indicating whether the item requires preparation - `allowedDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities - `availableHoursId` string, nullable — Gets the unique identifier of the available hours entity - `barcodes` string[], required — Gets the list of barcodes configured on the item at cinema - OcapiV1SalesMasterDataItemsNormalNormalItem — Represents the base properties of an item that is available for sale - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `shortName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `description` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - … - `restrictions` OcapiV1SalesMasterDataItemsItemRestriction[], required — Gets the restrictions that apply - `type` 'Normal' | 'ParentSales' | 'Package' | 'Recipe' | 'WeightBased', required — Represents the type of an item base entity - `itemClassId` string, nullable — Gets the unique identifier of the item class the item belongs to, if applicable - `hopk` string, nullable — Gets the Head Office primary key - `hoCode` string, required — Gets the Head Office code - `isSundry` boolean, required — Gets a value indicating whether this is a sundry item - `isPreparationRequired` boolean, required — Gets a value indicating whether the item requires preparation - `allowedDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities - `availableHoursId` string, nullable — Gets the unique identifier of the available hours entity - `barcodes` string[], required — Gets the list of barcodes configured on the item at cinema - `itemModifierGroups` OcapiV1SalesMasterDataItemsModifiersItemModifierGroup[], required — Gets the list of related item modifier group entities - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `shortName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `promptText` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `quantityLimit` OcapiV1QuantityLimit, required — Represents a limited or unlimited quantity - `isUnlimited` boolean, required — Gets a value indicating whether the quantity is unlimited - `maximum` integer, nullable — Gets the maximum quantity allowed - `minimum` integer, required — Gets the minimum quantity allowed (0 by default) - `includedQuantity` integer, required — Gets a value indicating the number of item modifier entities that can be added to a supported normal item at no additional charge - `modifiers` OcapiV1SalesMasterDataItemsModifiersItemModifier[], required — Gets the list of item modifier entities - `itemId` string, required — Gets the unique identifier of the item base entity - `prices` OcapiV1SalesMasterDataItemsPricesItemPrice[], required — Gets the list of item price entities - `price` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value - `valueIncludingTax` number, double, required — Gets the monetary value including tax - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax - `tax` number, double, required — Gets the amount of tax - `isDefault` boolean, required — Gets a value indicating whether this is the default price - `restrictions` OcapiV1SalesMasterDataItemsPricesItemPriceRestriction[], required — Gets the restrictions that apply - `rewardId` integer, nullable — Gets the unique identifier of the reward that the price is restricted to - `discount` OcapiV1SalesMasterDataPricesPriceDiscount — Represents the calculation logic and savings associated with a discounted price - `calculation` union, required — Represents the base properties that describe the calculation of a discount - … - `amountSaved` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value - … - `discountId` string, nullable — Gets the unique identifier of the discount that the price is restricted to - `displayPriority` integer, required — Gets the display priority used for sorting - `site` union, required — Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities - OcapiV1LoyaltyMasterDataSitesLoyaltySite — Represents a site in Vista Loyalty - `location` OcapiV1GeographicLocation — Represents a set of geospatial coordinates; longitude and latitude, that can be used to pinpoint a location on a map - `latitude` number, double, required — Gets the latitude (expressed in degrees and minutes) - `longitude` number, double, required — Gets the longitude (expressed in degrees and minutes) - `contactDetails` OcapiV1BrowsingMasterDataSitesSiteContactDetails, required — Represents the contact details of a site - `phoneNumbers` OcapiV1PhoneNumber[], required — Gets the list of phone number entities - `type` 'Home' | 'Mobile' | 'Work' | 'Business' | 'Fax', required — Represents the type of a phone number - `number` string, required — Gets the phone number - `email` string, nullable — Gets the email address - `address` OcapiV1BrowsingMasterDataSitesSiteAddress — Represents the physical address of a site - `line1` string, nullable — Gets the first line - `line2` string, nullable — Gets the second line - `city` string, nullable — Gets the city - `ianaTimeZoneName` string, required — Gets the IANA time zone name - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `hasSellableItems` boolean, required — Gets a value indicating whether the site has any sellable item entities - `allowedItemDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities - OcapiV1BrowsingMasterDataSitesSite — Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities - `id` string, required — Gets the unique identifier - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required — Gets the text in the default language - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required — Gets the translated text - `location` OcapiV1GeographicLocation — Represents a set of geospatial coordinates; longitude and latitude, that can be used to pinpoint a location on a map - `latitude` number, double, required — Gets the latitude (expressed in degrees and minutes) - `longitude` number, double, required — Gets the longitude (expressed in degrees and minutes) - `contactDetails` OcapiV1BrowsingMasterDataSitesSiteContactDetails, required — Represents the contact details of a site - `phoneNumbers` OcapiV1PhoneNumber[], required — Gets the list of phone number entities - `type` 'Home' | 'Mobile' | 'Work' | 'Business' | 'Fax', required — Represents the type of a phone number - `number` string, required — Gets the phone number - `email` string, nullable — Gets the email address - `address` OcapiV1BrowsingMasterDataSitesSiteAddress — Represents the physical address of a site - `line1` string, nullable — Gets the first line - `line2` string, nullable — Gets the second line - `city` string, nullable — Gets the city - `ianaTimeZoneName` string, required — Gets the IANA time zone name - `hasSellableItems` boolean, required — Gets a value indicating whether the site has any sellable item entities - `allowedItemDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities - `availableHours` OcapiV1SalesMasterDataAvailableHoursAvailableHours[], required — Gets the list of related available hours entities - `id` string, required — Gets the unique identifier - `siteId` string, required — Gets the unique identifier of the site - `days` OcapiV1SalesMasterDataAvailableHoursAvailableHoursForDay[], required — Gets the available hours for the days of the week - `day` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday', required - `startTime` string, date-time, required — Gets the start time - `endTime` string, date-time, required — Gets the end time ## Other responses - `404` — Site does not exist. --- [API](https://skmtc.net/vista/apis/vista-digital-platform.md) · [All operations](https://skmtc.net/vista/apis/vista-digital-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vista/vista-digital-platform/revisions/3a81c0aed14e/schema)