@servicenow/sdk - v4.7.0
    Preparing search index...

    Interface CatalogItem<V>

    interface CatalogItem<V extends VariableTypes = VariableTypes> {
        $id: string | number | ExplicitKey<string>;
        $override?: Record<string, string | number | boolean>;
        accessType?: "restricted" | "delegated";
        active?: boolean;
        assignedTopics?: (string | Record<"topic">)[];
        availability?: "desktopOnly" | "both" | "mobileOnly";
        availableFor?: (string | Record<"user_criteria">)[];
        billable?: boolean;
        catalogs?: (string | Record<"sc_catalog">)[];
        categories?: (string | Record<"sc_category">)[];
        checkedOut?: boolean;
        cost?: number;
        customCart?: string | Record<"sys_ui_macro">;
        deliveryPlanScript?: string;
        deliveryTime?: Duration;
        description?: string;
        displayPriceProperty?: string;
        entitlementScript?: string;
        executionPlan?: string | Record<"sc_cat_item_delivery_plan">;
        flow?:
            | string
            | Record<"sys_hub_flow">
            | FlowDefinition<
                Record<string, FlowValueType>,
                { [key: string]: FlowStageConfig },
            >;
        fulfillmentAutomationLevel?:
            | "unspecified"
            | "manual"
            | "semiAutomated"
            | "fullyAutomated";
        fulfillmentGroup?: string
        | Record<"sys_user_group">;
        hideAddToCart?: boolean;
        hideAddToWishList?: boolean;
        hideAttachment?: boolean;
        hideDeliveryTime?: boolean;
        hideQuantitySelector?: boolean;
        hideSaveAsDraft?: boolean;
        hideSP?: boolean;
        icon?: string;
        ignorePrice?: boolean;
        image?: string;
        location?: string | Record<"cmn_location">;
        makeItemNonConversational?: boolean;
        mandatoryAttachment?: boolean;
        meta?: string[];
        mobileHidePrice?: boolean;
        mobilePicture?: string;
        mobilePictureType?: "desktopPicture" | "mobilePicture" | "noPicture";
        model?: string | Record<"cmdb_model">;
        name: string;
        noCart?: boolean;
        noOrder?: boolean;
        noOrderNow?: boolean;
        noProceedCheckout?: boolean;
        noQuantity?: boolean;
        noSearch?: boolean;
        notAvailableFor?: (string | Record<"user_criteria">)[];
        omitPrice?: boolean;
        order?: number;
        owner?: string | Record<"sys_user">;
        picture?: string;
        pricingDetails?: PricingDetail[];
        protectionPolicy?: "read" | "protected";
        recurringFrequency?: Frequency;
        requestMethod?: "order" | "request" | "submit";
        roles?: (string | Role)[];
        shortDescription?: string;
        showVariableHelpOnLoad?: boolean;
        startClosed?: boolean;
        state?: State;
        useScLayout?: boolean;
        variables?: V;
        variableSets?: { order: number; variableSet: string | VariableSet }[];
        vendor?: string | Record<"core_company">;
        version?: number;
        view?: string | Record<"sys_ui_view">;
        visibleBundle?: boolean;
        visibleGuide?: boolean;
        visibleStandalone?: boolean;
        workflow?: string | Record<"wf_workflow">;
    }

    Type Parameters

    Index

    Properties

    $id $override? accessType? active? assignedTopics? availability? availableFor? billable? catalogs? categories? checkedOut? cost? customCart? deliveryPlanScript? deliveryTime? description? displayPriceProperty? entitlementScript? executionPlan? flow? fulfillmentAutomationLevel? fulfillmentGroup? hideAddToCart? hideAddToWishList? hideAttachment? hideDeliveryTime? hideQuantitySelector? hideSaveAsDraft? hideSP? icon? ignorePrice? image? location? makeItemNonConversational? mandatoryAttachment? meta? mobileHidePrice? mobilePicture? mobilePictureType? model? name noCart? noOrder? noOrderNow? noProceedCheckout? noQuantity? noSearch? notAvailableFor? omitPrice? order? owner? picture? pricingDetails? protectionPolicy? recurringFrequency? requestMethod? roles? shortDescription? showVariableHelpOnLoad? startClosed? state? useScLayout? variables? variableSets? vendor? version? view? visibleBundle? visibleGuide? visibleStandalone? workflow?

    Properties

    $id: string | number | ExplicitKey<string>
    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    accessType?: "restricted" | "delegated"

    Option to specify if a request can be submitted for a user who does not have access to the catalog item

    'restricted'
    active?: boolean

    Check box to make the item active (available to be ordered)

    true
    assignedTopics?: (string | Record<"topic">)[]

    The assigned topics for the catalog item

    availability?: "desktopOnly" | "both" | "mobileOnly"

    The availability of the catalog item

    'desktopOnly'
    availableFor?: (string | Record<"user_criteria">)[]

    The users/groups this item is available for

    billable?: boolean

    The billable status of the catalog item

    false
    catalogs?: (string | Record<"sc_catalog">)[]

    The catalogs the catalog item belongs to

    categories?: (string | Record<"sc_category">)[]

    Category for the item. Categories can only be selected after the Catalogs field is populated.

    checkedOut?: boolean

    The checked out for the catalog item

    cost?: number

    The cost of the catalog item

    0
    customCart?: string | Record<"sys_ui_macro">

    The custom cart for the catalog item

    deliveryPlanScript?: string

    The delivery plan script for the catalog item

    deliveryTime?: Duration

    The delivery time for the catalog item

    description?: string

    The detailed description of the catalog item

    displayPriceProperty?: string

    The display price property for the catalog item

    entitlementScript?: string

    The entitlement script for the catalog item

    executionPlan?: string | Record<"sc_cat_item_delivery_plan">

    The execution plan for the catalog item. Mutually exclusive with flow and workflow.

    flow?:
        | string
        | Record<"sys_hub_flow">
        | FlowDefinition<
            Record<string, FlowValueType>,
            { [key: string]: FlowStageConfig },
        >

    Flow that defines how the item request is fulfilled. Mutually exclusive with executionPlan and workflow.

    fulfillmentAutomationLevel?:
        | "unspecified"
        | "manual"
        | "semiAutomated"
        | "fullyAutomated"

    The fulfillment automation level for the catalog item

    'unspecified'
    fulfillmentGroup?: string | Record<"sys_user_group">

    The fulfillment group for the catalog item

    hideAddToCart?: boolean

    Whether add to cart is hidden for the catalog item

    false
    hideAddToWishList?: boolean

    Whether wishlist is hidden for the catalog item

    false
    hideAttachment?: boolean

    Whether attachments are hidden - cannot be true when mandatoryAttachment is true

    hideDeliveryTime?: boolean

    Whether delivery time is hidden for the catalog item

    false
    hideQuantitySelector?: boolean

    Whether quantity selector is hidden for the catalog item

    false
    hideSaveAsDraft?: boolean

    Whether save as draft is hidden for the catalog item

    false
    hideSP?: boolean

    Whether to hide item from Service Portal

    false
    icon?: string

    The icon for the catalog item

    ignorePrice?: boolean

    Whether to ignore the price

    true
    image?: string

    The image for the catalog item

    location?: string | Record<"cmn_location">
    makeItemNonConversational?: boolean

    Whether to make the item non conversational

    false
    mandatoryAttachment?: boolean

    Whether mandatory attachments are required for the catalog item

    meta?: string[]

    Search tags for the catalog item

    mobileHidePrice?: boolean

    Whether to hide the price on mobile

    false
    mobilePicture?: string

    The mobile picture for the catalog item

    mobilePictureType?: "desktopPicture" | "mobilePicture" | "noPicture"

    Whether to use the mobile picture type

    'desktopPicture'
    model?: string | Record<"cmdb_model">

    The model of the catalog item

    name: string

    Name to appear in the catalog. Required.

    noCart?: boolean

    Whether to hide the cart (legacy)

    false
    noOrder?: boolean

    Whether to hide the order (legacy)

    false
    noOrderNow?: boolean

    Whether to hide the order now (legacy)

    false
    noProceedCheckout?: boolean

    Whether to hide the proceed checkout (legacy)

    false
    noQuantity?: boolean

    Whether to hide the quantity (legacy)

    false
    noSearch?: boolean

    Whether to exclude this item from portal search results

    false
    notAvailableFor?: (string | Record<"user_criteria">)[]

    The users/groups this item is not available for

    omitPrice?: boolean

    Whether to omit the price

    false
    order?: number

    The order of the catalog item

    0
    owner?: string | Record<"sys_user">

    The owner for the catalog item

    picture?: string

    The picture for the catalog item

    pricingDetails?: PricingDetail[]

    The pricing details for the catalog item

    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    recurringFrequency?: Frequency

    The recurring frequency for the catalog item

    requestMethod?: "order" | "request" | "submit"

    Setting that controls the label displayed for the Order Now button and the order submission experience

    'order'
    roles?: (string | Role)[]

    Roles for a catalog item

    shortDescription?: string

    A short description of the catalog item

    showVariableHelpOnLoad?: boolean

    Whether to show variable help on load

    false
    startClosed?: boolean

    Whether to start closed

    false
    state?: State

    The state for the catalog item

    useScLayout?: boolean

    Whether to use the service catalog layout

    true
    variables?: V

    The variables for the catalog item

    variableSets?: { order: number; variableSet: string | VariableSet }[]

    The variable sets the catalog item belongs to

    vendor?: string | Record<"core_company">
    version?: number

    The version of the catalog item

    1
    view?: string | Record<"sys_ui_view">

    The view for the catalog item

    visibleBundle?: boolean

    Whether the bundle is visible

    true
    visibleGuide?: boolean

    Whether the guide is visible

    true
    visibleStandalone?: boolean

    Whether the standalone is visible

    true
    workflow?: string | Record<"wf_workflow">

    Workflow that defines how the item request is fulfilled. Mutually exclusive with executionPlan and flow.

    Settings

    Member Visibility

    On This Page

    Properties
    $id$overrideaccessTypeactiveassignedTopicsavailabilityavailableForbillablecatalogscategoriescheckedOutcostcustomCartdeliveryPlanScriptdeliveryTimedescriptiondisplayPricePropertyentitlementScriptexecutionPlanflowfulfillmentAutomationLevelfulfillmentGrouphideAddToCarthideAddToWishListhideAttachmenthideDeliveryTimehideQuantitySelectorhideSaveAsDrafthideSPiconignorePriceimagelocationmakeItemNonConversationalmandatoryAttachmentmetamobileHidePricemobilePicturemobilePictureTypemodelnamenoCartnoOrdernoOrderNownoProceedCheckoutnoQuantitynoSearchnotAvailableForomitPriceorderownerpicturepricingDetailsprotectionPolicyrecurringFrequencyrequestMethodrolesshortDescriptionshowVariableHelpOnLoadstartClosedstateuseScLayoutvariablesvariableSetsvendorversionviewvisibleBundlevisibleGuidevisibleStandaloneworkflow