Skip to content

Shopgate Documentation

GitHub

Select theme

Shopping Apps
Omnichannel Suite

Introduction
Guides
- Tutorials
- Shopping App Frontend
- Shopping App Backend
- Commerce
  - E-Commerce Integration Checklist
  - Web Checkout
    Overview
    Integration Steps
    Basic integration
    Advanced integration
References
- Shopping App Frontend
  - Actions
    Overview
    Cart
    Category
    Checkout
    Favorites
    Modal
    Page
    Product
    Review
    Router
    Search
    User
  - Components
    I18n
    Link
    Slider
  - Helpers
    I18n
  - Hocs
  - Hooks
  - Portals
    Overview
    Appbar
    Browse
    Cart
    Category List Item
    Category
    Cms Pages
    Components
    Favorites List
    Filters
    General
    Login Page
    Navmenu
    Product Details
    Product List Item
    Scanner
    Search
    Tabbar
  - Routes
    Overview
    Browse
    Cart
    Category Search Filter
    Category
    Favorites
    Home
    Item Gallery
    Item Reviews
    Item Write Review
    Item
    Login
    More
    Scanner
    Search
  - Selectors
    Overview
    Cart
    Checkout
    Client
    Favorites
    Filters
    History
    Menu
    Modal
    Page
    Product
    Router
    Search
    Url
    User
  - Streams
    Overview
    App
    Cart
    Category
    Error
    Favorites
    Filters
    Main
    Product
    Reviews
    Router
    Scanner
    Search
    User
  - Theme
    Overview
    App Bar
    View
  - Tracking Events
- Shopping App Backend
  - Extensions
    Configuration
    Pipeline
    Overview
    Common Step Structure
    Extension Step
    Auth Step
    Conditional Step
    Error Catch Extension Step
    Pipeline Step
    Hook Step
    Step File and Context
    Overview
    Logger
    Storage
    Device Info
    App Info
    Meta
  - Shopgate Pipelines
    Category
    Overview
    Operations
    getLiveshoppingProducts.v1
    getHighlightProducts.v1
    getCategoryChildren.v1
    getCategory.v1
    getRootCategories.v1
    Schemas
    All 19 models
    Availability
    BasicCharacteristic
    BasicProduct
    Category
    CategoryIdSearchPhraseFiltersParam
    CategoryIdSearchPhraseFiltersProductIdsOffsetLimitSortActiveParam
    Characteristic
    Currency
    Filter
    Option
    Price
    ProductCharacteristics
    ProductProperties
    ProductProperty
    ProductRelations
    Shipping
    Stock
    UnknownError
    Variants
    Product
    Overview
    Search
    getFilters.v1
    getSearchSuggestions.v1
    Operations
    getTotalProductCount.v1
    getProducts.v1
    getProduct.v1
    getProductsByIds.v1
    getProductsByCategory.v1
    getProductsBySearchPhrase.v1
    Product Properties
    getProductImages.v1
    getProductImages.v2
    getProductImages.v3
    getProductDescription.v1
    getProductShipping.v1
    getProductProperties.v1
    getProductOptions.v1
    getProductChildren.v1
    getProductVariants.v1
    getProductRelations.v1
    Schemas
    All 19 models
    Availability
    BasicCharacteristic
    BasicProduct
    Category
    CategoryIdSearchPhraseFiltersParam
    CategoryIdSearchPhraseFiltersProductIdsOffsetLimitSortActiveParam
    Characteristic
    Currency
    Filter
    Option
    Price
    ProductCharacteristics
    ProductProperties
    ProductProperty
    ProductRelations
    Shipping
    Stock
    UnknownError
    Variants
    Review
    Overview
    Operations
    getProductReviews.v1
    getReview.v1
    addProductReview.v1
    updateProductReview.v1
    Schemas
    All 9 models
    Review
    ReviewAuthor
    ReviewDate
    ReviewId
    ReviewRate
    ReviewReview
    ReviewTitle
    UnauthorizedError
    ValidationError
    Cart
    Overview
    Operations
    getCart.v1
    Cart Products
    addProducts.v1
    updateProducts.v1
    deleteProducts.v1
    Cart Coupons
    addCoupons.v1
    deleteCoupons.v1
    Checkout
    getUrl.v1
    Schemas
    All 22 models
    AddProductsProductOption
    AppliedDiscount
    Cart
    CartCouponsError
    CartFlags
    CartItem
    CartItemCoupon
    CartItemProduct
    CartItemProductPrice
    CartItemProductProperty
    CartProductsError
    CartResult
    CartText
    CartTotal
    Currency
    EmptyResult
    Message
    MessageParams
    Total
    UnknownError
    Url
    UrlResult
    User
    Overview
    Operations
    loginUser.v1
    logoutUser.v1
    getUser.v1
    updateUser.v1
    updateMail.v1
    updatePassword.v1
    getRegistrationUrl.v1
    Address
    getAddresses.v1
    addAddress.v1
    updateAddress.v1
    deleteAddresses.v1
    Schemas
    All 15 models
    AddressAdd
    AddressGetAndUpdate
    CustomAttributes
    ErrorInvalidCall
    ErrorRemoval
    ErrorUnauthorized
    ErrorUnknown
    ErrorValidation
    Message
    productId
    productIds
    Url
    UserGet
    UserGroup
    UserUpdate
    Favorite
    Overview
    Operations
    getFavorites.v1
    addFavorites.v1
    deleteFavorites.v1
    putFavorites.v1
    Schemas
    All 15 models
    AddressAdd
    AddressGetAndUpdate
    CustomAttributes
    ErrorInvalidCall
    ErrorRemoval
    ErrorUnauthorized
    ErrorUnknown
    ErrorValidation
    Message
    productId
    productIds
    Url
    UserGet
    UserGroup
    UserUpdate
    CMS
    Overview
    Operations
    getPageConfig.v1
    getMenu.v1
    Schemas
    All 19 models
    Availability
    BasicCharacteristic
    BasicProduct
    Category
    CategoryIdSearchPhraseFiltersParam
    CategoryIdSearchPhraseFiltersProductIdsOffsetLimitSortActiveParam
    Characteristic
    Currency
    Filter
    Option
    Price
    ProductCharacteristics
    ProductProperties
    ProductProperty
    ProductRelations
    Shipping
    Stock
    UnknownError
    Variants
  - Platform SDK
    Overview
    Login Action
    Init Action
    Extension Actions
    Theme Action
    Backend Actions
    Frontend Actions
- Commerce
- CMS
- Native Modules
Support
- Contact
- FAQ

GitHub

Select theme

On this page

Overview
Example

Code

Code of the entity

Type: string

Example

Section titled “Example”

"8b2802a6-ab0e-4310-97d4-096ae8b3610f"