Skip to content
Shopgate Documentation
Search
Ctrl
K
Cancel
GitHub
A
A
A
Select theme
Dark
Light
Auto
Shopping Apps
Omnichannel Suite
Introduction
Overview
Primer for AI Agents
App Architecture
Development Process
Platform SDK
Getting Started
Set Up Environment
Set Up Local Frontend
Test With Native Apps
Guides
Tutorials
Hello World
Overview
1. Create first extension
2. Build first pipeline
3. Modify existing pipelines
4. Interact with storage
Loyalty Points
1. Backend part
2. Frontend part
Integrate Search Provider
Integrate Tracking Provider
Integrate External Notification Trigger
Shopping App Frontend
Portals
Create Custom Route
Create Custom Widget
Streams
Styling Components
Fetching and processing data
Retrieving data from the store
Extending the built-in Scanner
Using Translations
Mutable Actions
Form Builder
Consent Manager
Requesting App Permisions
Accessibility
Shopping App Backend
Extension Configuration
Pipelines
Product Extensibility
Steps
Step Insertion
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
Category XML
Product XML
Review XML
Web Checkout API
Overview
Cart
Get cart
Get checkout url
Create cart
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
Authentication
Authenticate
User
Login user
Get user
Merge cart with user cart.
Get current cart of user
Schemas
All 15 models
AddressAdd
AddressGetAndUpdate
CustomAttributes
ErrorInvalidCall
ErrorRemoval
ErrorUnauthorized
ErrorUnknown
ErrorValidation
Message
productId
productIds
Url
UserGet
UserGroup
UserUpdate
Cart Manipulation
Adding product(s) to the cart
Remove cart items from the cart
Update quantity of product(s) within the cart
Adding coupon(s) to the cart
Schemas
All 20 models
401-error
AddProductsProductProperty
AppliedDiscount
Cart
CartFlags
CartItem
CartItemCoupon
CartItemProduct
CartItemProductPrice
CartItemProductProperty
CartResult
CartText
CartTotal
Currency
EmptyResult
Message
Total
UnknownError
Url
UrlResult
CMS
Widget Configs
Input Types
CMS Service API
Overview
Widget Config Definitions
Get widget config definitions
Pages
List pages
Create New Pages
Get Live Page Content
Retrieve Current Page Draft
Update Page Draft
Delete Page
Publish Page Draft
List Page History
Get Specific Published Version
Images
Upload Image Asset
Schemas
All 25 models
Code
ConfigValidationError
DeprovisioningRequest
Error
IsFavorite
IsProtected
Layout
Margin
Name
NotFoundError
OptionalLocalization
PageCreate
PageGet
PageGetResolved
PageUpdate
Pagination
Slug
Title
Type
ValidationError
ValidationErrorResult
VersionGet
Visibility
Widget
WidgetConfigDefinitionResolved
Schemas
All 19 models
Availability
BasicCharacteristic
BasicProduct
Category
CategoryIdSearchPhraseFiltersParam
CategoryIdSearchPhraseFiltersProductIdsOffsetLimitSortActiveParam
Characteristic
Currency
Filter
Option
Price
ProductCharacteristics
ProductProperties
ProductProperty
ProductRelations
Shipping
Stock
UnknownError
Variants
Native Modules
Overview
Android Navigation Bar
Braze
Brightness
Camera
Connectivity Monitor
Emarsys
Facebook Analytics
Firebase Analytics
Geolocation
HTTP
In App Browser
Keychain
Linking
Push
Sharing
Splash Screen
Status Bar
Support
Contact
FAQ
GitHub
A
A
A
Select theme
Dark
Light
Auto
IsProtected
Type:
boolean
Example
Section titled “Example”
true
