--- schema_version: "1" id: ee2f28b3c54d2234e81f48dd247af341f70fb27f86364cb5488fb8ec47ed8cef title: SvcCatalogItemDef collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_svccatalogitemdef.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_svccatalogitemdef.htm source_site: developer.salesforce.com content_type: documentation content_hash: f3c404d32cb77964aaf1740ca7892bf99513f66a1ab00f23c00399bf36ab2c0e description: Represents the entity associated with a specific, individual service available in the Service Catalog. --- # SvcCatalogItemDef Represents the entity associated with a specific, individual service available in the Service Catalog. ## File Suffix and Directory Location SvcCatalogItemDef components have the suffix catalogItem and are stored in the svcCatalogItems folder. ## Version SvcCatalogItemDef components are available in API version 53.0 and later. ## Fields | Field Name | Description | | --- | --- | | apiVersion | Field Type double Description The API version in which this catalog item was created. The value for this field updates based on the value of fulfillmentFlow. For catalog items created before version 57.0, the value for this field is null. Available in version 57.0 and later. | | catalogFilterCriteria | Field Type [SvcCatalogItemDefFiltrCrit](#subtype_SvcCatalogCategoryItemDefFilterCrit)\[\] Description The eligibility rule associated with a catalog item. Eligibility rules customize access to catalog items for different audiences, based on the User object. Available in API version 59.0 and later. | | categories | Field Type [SvcCatalogCategoryItem](#subtype_SvcCatalogCategoryItem)\[\] Description A list of catalog categories that contain this catalog item. | | dataCategories | Field Type [SvcCatalogItemDefDataCategorySelection](#SvcCatalogItemDefDataCategorySelection)\[\] Description A list of data categories for this catalog item. Available in API version 59.0 and later. | | description | Field Type string Description Description of the catalog item. | | flow | Field Type string Description The screen flow associated with the catalog item. Available in API version 53.0 to 58.0. | | fulfillmentFlow | Field Type string Description Name of the related [SvcCatalogFulfillmentFlow](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_svccatalogfulfillmentflow.htm "Represents the flow associated with a specific catalog item in the Service Catalog."), which represents the flow associated with a specific catalog item in the Service Catalog. Available in API version 56.0 and later. | | image | Field Type string Description The developer name of a content document to be displayed in the Service Catalog for this item. | | inputs | Field Type [SvcCatalogItemAttribute](#subtype_SvcCatalogItemAttribute)\[\] Description Represents attributes of a catalog item version. Available in API version 57.0 and later. | | internalNotes | Field Type string Description Intended to describe what the catalog item does and its implementation. That value is meant for other catalog builders. | | isAvailableToAllCustomers | Field Type boolean Description Required. Controls catalog item access for internal users. To share with all internal users, set the value to True. This value corresponds to the **Allow Access for All Users** option for Internal Access in the Catalog Item Builder. Available in API version 61.0 and later. | | isFeatured | Field Type boolean Description Determines if the catalog item is part of the featured catalog items. | | isGuestAccessible | Field Type boolean Description Required. Controls catalog item access for guest users. To share with guests, set the value to True. This value corresponds to **Guest Visibility** option for External Access in the Catalog Item Builder. Available in API version 61.0 and later. | | isProtected | Field Type boolean Description An auto-generated value. This value has no impact. | | masterLabel | Field Type string Description Required. The primary label for the catalog item record. | | sharedTo | Field Type [SharedTo](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharedto.htm "SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.") Description Describes how the catalog item is shared across multiple catalog categories. SvcCatalogItemDef only supports sharing with groups. | | status | Field Type PublishStatusType (enumeration of type string) Description Required. Displays the publishing status of a catalog item. Values are: - Deprecated - Draft - PendingChanges - Published | ## SvcCatalogItemDefFiltrCrit Represents the association of an eligibility rule with a catalog item. Eligibility rules customize access to catalog items for different audiences, based on the User object. Available in version 59.0 and later. | Field Name | Description | | --- | --- | | svcCatalogFilterCriteria | Field Type string Description The name of the associated catalogFilerCriteria eligibility filter. | ## SvcCatalogCategoryItem Represents the assignment of this service to a category within the Service Catalog. | Field Name | Description | | --- | --- | | isPrimaryCategory | Field Type boolean Description Determines if the catalog category (svcCatalogCategory) is the primary category for this catalog item. Exactly one category per SvcCatalogItemDef component must set this attribute to true. | | sortOrder | Field Type int Description The position of the catalog item relative to other catalog items in the catalog category. | | svcCatalogCategory | Field Type string Description Required. The catalog category the catalog item is assigned to. | ## SvcCatalogItemDefDataCategorySelection Represents a list of data categories for this catalog item. This subtype is available in API version 59.0 and later. | Field Name | Description | | --- | --- | | category | Field Type string Description API name of a data category. | | categoryGroup | Field Type string Description API Name of a data category group. | ## SvcCatalogItemAttribute Represents an attribute of a catalog item version. It can be a static input filled by the catalog builder user or additional questions that end users answer at runtime. Available in API version 57.0 and later. | Field Name | Description | | --- | --- | | field | Field Type string Description Applicable when the display type is Lookup/Reference. | | inputType | Field Type SvcCatalogItemAttrDataType (enumeration of type string) Description Required. Values are: - Attachment - Checkbox - Currency - Date - Datetime - DisplayText - Email - IPAddress - Integer - ListOfAttachment(available in API version 65.0 and later) - ListOfBoolean - ListOfDouble - ListOfInteger - ListOfMaps - ListOfString - Lookup - Map - MultilineText - MultiSelectPicklist(available in API version 65.0 and later) - Number - NumericScale - Password(available in API version 65.0 and later) - Percentage - Picklist - Queue - RadioButton(available in API version 65.0 and later) - SingleCheckbox (available in API version 59.0 and later) - SinglelineText - Text - Toggle (available in API version 59.0 and later) - Url | | inputVariable | Field Type string Description References the input variable to which the attribute value is forwarded. | | isRequired | Field Type boolean Description Determines if an answer is required for this question. | | label | Field Type string Description A translatable label for rendering the attribute to users. | | maxValue | Field Type double Description Applicable when the display type is slider. | | minValue | Field Type double Description Applicable when the display type is slider. | | name | Field Type string Description Required. Applicable when the display type is Lookup/Reference. | | object | Field Type string Description A picklist object’s custom API Name. Applies when inputType is set to Picklist. | | options | Field Type SvcCatalogItemAttrDetail Description The values attached to an attribute of an item version. | | type | Field Type SvcCatalogItemAttrType (enumeration of type string) Description Required. Type of the attribute; used to determine if it's a pre-filled input or questions to ask users. Values are: - FulfillmentInput - UserQuestion | | value | Field Type string Description Attribute value defined by the catalog builder. | ## SvcCatalogItemAttrDetail Represents the details for an attribute of an item version. Used for options displayed in picklist or checkbox groups. | Field Name | Description | | --- | --- | | isDefault | Field Type boolean Description Required. Marks the attribute detail as the default. Applicable when the input display type is picklist or checkbox. | | label | Field Type string Description Required. Picklist option label when the input type is picklist or checkbox. | | value | Field Type string Description Attribute value defined by the catalog builder. | ## Declarative Metadata Sample Definition The following is an example of a SvcCatalogItemDef component. 57.0 true 3 Category1 France World Item Draft Update Item with a Draft state TestQuestions false false Published Input1 FulfillmentInput input1 Input Static Text false UserQuestion Picklist false My First Question first\_question Option 1 option\_1 true Option 2 option\_2 false Option 3 option\_3 false ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").