Developer Reference
Technical reference for developers building on StoreConnect — Liquid templates, object schemas, APIs, and integration patterns.
Object References
Account Credit Ledger Object Reference
Acount Credit Ledger entries are a record of all the credit and debit entries against an Account Credit record.
Account Credit Object Reference
Account Credit is a record of credit extended to an Account, whether it be for a refund, gift card, or any other use.
Account Object Reference
The Salesforce standard Account object, which StoreConnect extends for B2B and location-based selling. StoreConnect adds lookups for the account...
Account Points Ledger Object Reference
Keeps track of Account Points credits and debits
Account Product Category Object Reference
Reference documentation for the Account Product Category object in StoreConnect.
Address Object Reference
An Address Book entry belonging to an Account. Stores a reusable shipping/billing address that a contact can select at checkout. An Account may hav...
Allocated Fulfillment Payment Object Reference
Links Payment Items and Fulfillment Items to indicate which items have been paid for in a Fulfillment
Article Category Object Reference
Groups articles for navigation and SEO, with a display name, path, position, optional parent category for nesting, and its own meta title, descript...
Article Object Reference
Articles are blog posts, press releases, and other complete items of content that are used on the website. These are different from Pages or Conten...
Article Tag Object Reference
A join object between Article__c and Tag__c
Articles Article Categories Junction Object Reference
Many to Many join table between Content Articles and Article Categories
Asset Object Reference
The Salesforce standard Asset object, which StoreConnect uses for serialized and activatable items: an activation code and PIN, the order line item...
Booking Attendee Object Reference
Booking Attendee tracks the Contacts that attended a Booking
Audit Log Object Reference
The Audit Log object, an append-only record of one security-related action such as a login, logout, password reset, invitation, or payment attempt....
Authentication Provider Object Reference
Configures an authentication provider for single sign on services on your StoreConnect store.
Availability Object Reference
Availabilities define dates and times in which bookings can be made.
Bookable Event Object Reference
Bookable Event defines the date and time for a single occurence of a bookable Product at a Bookable Location.
Bookable Location Object Reference
Book Location defines a location that a bookable Product can be held at. Can be used both physical and virtual locations.
Booking Object Reference
Booking stores all bookings made for bookable products
CampaignMember Object Reference
The Salesforce standard CampaignMember object. StoreConnect adds only its external ID, so campaign membership syncs to the storefront without furth...
Cart Campaign Object Reference
Tracking information attached to a Cart such as the UTM details.
Cart Fulfillment Item Object Reference
Cart Fulfillment Item is the join table between Cart_Fulfillment__c and Cart_Item__c.
Cart Fulfillment Object Reference
Cart Fulfillment groups cart items by fulfillment type before order placement.
Cart Item Object Reference
The item that has been added to a Cart. It is often associated with a Product.
Cart Object Reference
The customer's shopping cart, holding Cart Items until checkout converts it to an Order. Usually created by the storefront, with lookups for st...
Cart Promotion 2 Object Reference
Cart Promotion 2 records a Promotion v2 that has been applied to a shopping cart, tracking the coupon code used and the calculated discount amounts.
Change Event Object Reference
A log of record changes StoreConnect detected for sync, holding the object name, event type, changed fields, timestamps, and any error status code ...
City Object Reference
A City represents a single city to be associated with a Zone which is used in both calculating tax or shipping within StoreConnect.
Collection Point Object Reference
Represents a specific area within a Stock Location where stock can be picked up via Click and Collect such as "front desk", or "Gate...
Compliance Group Object Reference
Compliance Groups are part of our website privacy compliance features. They define different groups of Cookies, required to comply with for GDPR an...
Component Group Object Reference
Defines a group of component products within a bundle. Component groups allow you to organize components and apply rules such as minimum or maximum...
Component Pricing Object Reference
Lets you override the price book price of a component product used in a product bundle. Pricing resolves from the most specific match: the bundle&#...
Condition Object Reference
Condition defines what must be true for a Promotions v2 reward to apply. Set the type, threshold amount, optional currency filter, and Liquid templ...
Console Favorite Object Reference
Stores per-user favorites for any record type (generic favorites)
Console Folder Object Reference
Used to organize records into folders (including nested folders) within the SC Console
Contact Object Reference
The Salesforce standard Contact object, which StoreConnect extends with a store lookup. Contact is the storefront customer record that carts, order...
Content Block Object Reference
Content blocks are reusable pieces of content in the StoreConnect CMS, usable within Pages, Articles, Products, Product Categories, and other conte...
Content Block Article Object Reference
Content Block Article join object
Content Block Child Object Reference
Content Block to Content Block join object
Content Block Page Object Reference
Content Block Page join object
Content Block Product Category Object Reference
Content Block Product Category join object
Content Block Product Object Reference
Content Block Product join object
Content Change Field Object Reference
Tracks content specific record field modifications.
Content Change Object Reference
Tracks and documents content specific record modifications, defaulting changes to draft until approval is secured for publication.
Content Change Record Object Reference
Tracks object content specific record modifications.
Cookie Object Reference
Cookies are part of our website privacy compliance features. They disclose information about cookies that are used on your web store.
Country Object Reference
A Country represents a single country to be assocated with a Zone which is used in both calculating tax or shipping within StoreConnect. ...
Custom Data Mapping Object Reference
Allows custom data to be synced from objects displayable in StoreConnect stores
Data Feed Field Object Reference
Data Feed Fields for each export
Data Feed Object Reference
The Data_Feed__c object allows you to create a custom CSV file that is generated on the server daily allowing you to have external systems download...
Delivery Window Object Reference
Delivery Window defines an available delivery schedule
Discount Credit Object Reference
A record of the discount actually applied at the time of the order, generally used for tracking and audit purposes. This record is autogenerated an...
Discount Object Reference
Discounts are applied automatically whenever an order matches the discount requirements such as for a specific product or account. This is differen...
Error Definition Object Reference
Defines an error or exception encountered from internal/external systems. Primarily used to surface and address sync errors.
Feed Object Reference
Feed definition for the customizable feed endpoint.
Form Answer Object Reference
Represents an answer submitted for a question from a customer to collect arbitrary information in a form.
Form Object Reference
Forms represent the type of arbitrary information to be collected from a customer.
Form Question Object Reference
Represents a question for a customer to answer to collect arbitrary information in a form.
Form Submission Object Reference
Represents the submission of a form to collate the answers to a question.
Fulfillment Category Object Reference
s_c__Fulfillment_Category__c is a named routing bucket used to group products by preparation type, such as Hot Kitchen or Drinks.
Fulfillment Category Station Object Reference
s_c__Fulfillment_Category_Station__c maps a fulfillment category to the station that handles it at a given outlet.
Fulfillment Item Object Reference
Fulfillment_Item__c is the join table between Shipment__c and OrderItem objects.
Fulfillment Station Object Reference
s_c__Fulfillment_Station__c represents a physical preparation station at a POS outlet, such as a kitchen or bar, used for routing POS orders.
Lead Object Reference
The Salesforce standard Lead object, which StoreConnect extends with a preferred contact method and a conversion trigger account used when a lead i...
Locale Translation Object Reference
Locale Translations are key/value pairs of translations that belong to a Theme Locale
Location Group Account Object Reference
A junction joining an Account to a Location Group, so a group of locations can be restricted to, or associated with, particular accounts.
Location Group Object Reference
A named group of locations shown through a store locator, with a display name, path, active flag, social image, and its own meta title, description...
Manual Stock Adjustment Item Object Reference
An adjustment to product stock levels as part of a manual stock adjustment
Manual Stock Adjustment Object Reference
A manual stock adjustment to be applied to a particular StockLocation
Media Object Reference
The media object holds the meta data of all media (images, videos, URLs) you are using for your store across Products, Categories, Articles, Pages ...
Membership Article Object Reference
Membership Article limits access to specified articles to accounts with the related membership. The user must have this members...
Membership Object Reference
Memberships represent a level of access to some privledge within your company, such as Gold or Silver membership.
Membership Page Object Reference
Membership Page limits access to specified pages to accounts with the related membership. The user must have this membership assigned to th...
Menu Item Object Reference
Menu Items belong to menus and represent a single item in the menu such as a product category, link or content.
Menu Object Reference
Menus are a collection of ordered menu items that can are usually used for Headers and Footers. Once created, you display them by setting a Header ...
Opening Time Object Reference
Has the opening time information for a Collection Point
Order Campaign Object Reference
An Order Campaign captures any UTM parameters present when someone visits your store and then creates a shopping cart. If the visitor came to your ...
Order Item Reward Object Reference
Order Item Reward tracks the discount a Promotion v2 reward applied to a specific order line item.
Order Item Tax Object Reference
Order_Items_Taxes__c is the join table between OrderItem and Tax__c objects. It is the tax (or multiple taxes) that are associated with an OrderIt...
Order Object Reference
The Salesforce standard Order object, which StoreConnect extends to record web and POS sales. StoreConnect adds lookups for store, contact, outlet,...
OrderItem Object Reference
The Salesforce standard OrderItem object, which StoreConnect extends for line-level detail on web and POS orders. StoreConnect adds lookups for shi...
Outlet Object Reference
An outlet represents a physical store location or group of registers used for point-of-sale transactions.
Outlet Stock Location Object Reference
Outlet_Stock_Location__c is the join table between Outlet__c and Stock_Location__c objects.
Outlet User Object Reference
Outlet_User__c is the join table between Outlet__c and User objects.
Outlet User Type Object Reference
Outlet_User_Type__c sets the permissions for Outlet Users when using a POS device.
Page Object Reference
A Page represents a path within your store that holds some sort of content. They are different from Articles in that they are not news items or pos...
Page Tag Object Reference
A join object between Page__c and Tag__c
Payment Installment Object Reference
Reference documentation for the Payment Installment object in StoreConnect.
Payment Item Object Reference
Links a Payment to the Order Item it paid for, holding the amount and any loyalty points applied, so a single payment can be split across order lines.
Payment Method Object Reference
Stores saved payment methods (cards) for contacts. Created during checkout when a customer saves their card or when a subscription is created. Toke...
Payment Object Reference
A Payment object holds the payment information associated with an Order checked out by a shopper.
Payment Provider Object Reference
Configures a payment provider to be offered as part of the checkout process. Mainly contains the necessary credentials for the provider's API.
Permitted Restricted Item Object Reference
Defines items that have expended a permitted restricted product.
Permitted Restricted Product Object Reference
Provides authorization to a customer to purchase a restricted product.
POS Action Group Object Reference
A container to hold Action Item UI elements in StoreConnect's Point-Of-Sale system.
POS Action Item Object Reference
A UI element (button) within a menu or grid in a POS Action Group.
POS Layout Field Object Reference
Defines which Salesforce fields appear on a POS layout and controls their visibility, IndexedDB indexing, and keyword search participation via the ...
POS Layout Filter Object Reference
Determines which filters are shown on a given layout.
POS Layout Object Reference
Controls how a specific object’s records are displayed in StoreConnect's Point-Of-Sale system.
POS Print Template Object Reference
Stores print templates for POS receipt, cart, label, and document printing.
POS View Object Reference
Stores Liquid templates (HTML/CSS/JS) used to render custom StoreConnect Point-Of-Sale screens.
Postcode Object Reference
A Postcode represents a single postal or zip code to be associated with a Zone which is used in both calculating tax or shipping within StoreConnec...
Pricebook2 Object Reference
The Salesforce standard Pricebook object, which StoreConnect extends with storefront presentation and loyalty settings: add-to-cart and buy-it-now ...
PricebookEntry Object Reference
The Salesforce standard PricebookEntry object, which sets a product's price in one price book. StoreConnect extends it with bundle behavior, pe...
Printable Template Object Reference
Printable Template represents a label template that can be printed by StoreConnect's Point-of-Sale system.
Product Bookable Location Object Reference
Product Bookable Location defines a locations that offer a bookable product.
Product Category Hierarchy Object Reference
Describes the relationship between Product Categories. A product category can have multiple parents as well as multiple children.
Product Category Object Reference
A Product_Category__c represents a collection of Product2 objects. Every Product_Category__c belongs to exactly one Taxonomy__c. Product_C...
Product Component Object Reference
Defines a component product that is part of a bundle or modifier. The anchor product is the bundle or product being modified, and the component pro...
Product Delivery Window Object Reference
A join object between Product and Delivery Window
Product Form Object Reference
Represents the product under which the form should be shown.
Product Fulfillment Category Object Reference
s_c__Product_Fulfillment_Category__c links a product to the fulfillment categories it belongs to, controlling where POS orders for that product are...
Product Media Object Reference
Holds the relationship between products and media items, such as product image, videos, files etc
[DEPRECATED] Product Purchasable Media Object Reference
Holds the relationship between products and media items, such as product image, videos, files etc that can be downloaded after product purchase
Supplier Account Object Reference
Product Supplier joins a product to the supplier's account. A product can have multiple suppliers so you can create multiple Product Supplier r...
Product Tag Object Reference
A join object between Product2 and Tag__c
Product Tax Group Object Reference
Product_Tax_Group__c is the join table between Product2 and Tax_Group__c objects. It is the tax group (or multiple groups) that are associated wit...
Product Tax Object Reference
Product_Tax__c is the join table between Product2 and Tax__c objects. It is the tax (or multiple taxes) that are associated with a Product2 object.
Product Trait Template Item Object Reference
A product trait template item are the individual trait items that will be created for a product when it has the product trait template applied.
Product Trait Template Object Reference
Holds a set of traits as a template that can be used when assigning the same or similar set of traits to multiple products in the system.
Product Variant Object Reference
Product Variants are variations of the same product, such as small, medium, and large, or red, green, and blue. Each product can have unlimited var...
Product2 Object Reference
The Salesforce standard Product2 object, which StoreConnect extends for storefront and POS selling. StoreConnect adds lookups for brand, product tr...
Product Product Category Object Reference
The join table between Products and the Product Categories they belong to.
Promotion Action Object Reference
Provides the discount that is applied when this promotion is added to a cart. Reductions can be via a fixed amount or a percentage. Available actio...
Promotion Credit Object Reference
A record of the promotion actually applied at the time of the order so that if the promotion is changed in the future, the credit applied to the or...
Promotion Object Reference
Field reference for the Promotion object (s_c__Promotion__c), the discount code a shopper enters at checkout, including the scopes that limit where...
Promotion Scope Object Reference
The optional scope to limit this promotion by. Can be by account, contact, product, product category, brand or membership. The Product in promotion...
Promotion 2 Condition Object Reference
Promotion 2 Condition links a Condition and a Reward to a Promotion 2 record. Each record pairs one condition (what must be met) with one reward (w...
Promotion 2 Object Reference
Promotion 2 is the header record for a Promotions v2 promotion. Defines scheduling, stacking rules, channel and customer scoping, coupon codes, usa...
Promotion 2 Product Scope Object Reference
Promotion 2 Product Scope defines which products, categories, or brands a condition or reward applies to. Use include or exclude scope types to fil...
Promotion 2 Usage Object Reference
Promotion 2 Usage records the application of a promotion to a specific order and customer. Used for usage limit enforcement and reporting.
Query Object Reference
Reusable query definition for the feed endpoint.
Register Fulfillment Category Station Object Reference
s_c__Register_Fulfillment_Category_Station__c is a per-register override of the outlet-level fulfillment category-to-station mapping.
Register Object Reference
Register represent a device used for StoreConnect's Point-Of-Sale system.
Register Shift Object Reference
Register Shift represents a session of usage of a device used for StoreConnect's Point-Of-Sale system. Tracks balances, payment totals, notes, ...
Register Shift Total Object Reference
Register_Shift_Total__c is the total payments received for a given payment method during the shift.
Register Shift User Object Reference
Register_Shift_User__c is the join table between Register_Shift__c and User objects.
Related Article Object Reference
Connects different related articles together which are then shown at the bottom of each article as other related articles.
Related Page Object Reference
Connects different related pages together which can then shown at the bottom of each page as other related pages.
Related Product Category Object Reference
Connects different related product categories together which can then shown with each product category as other related product categories.
Related Product Object Reference
Connects different related products together which can then shown at the bottom of each product page as other related products.
Reward Object Reference
Reward defines the discount to apply when a Promotions v2 condition is met. Supports percentage or fixed discounts on the subtotal, products, or sh...
Reward Usage Object Reference
Reward Usage tracks each individual reward applied to an order from a Promotion v2, recording which reward was applied and the discount value.
Route Mapping Object Reference
Route mappings allow the user to create permanent and temporary redirects for their store. Route mappings are created automatically when a product,...
Script Block Object Reference
Script Blocks contain JavaScript code that will be included on your web store.
Setup Configuration Object Reference
Configuration data for StoreConnect setup
Shipment Object Reference
Holds the information for a shipment of order items, with lookups for the order, ship-to contact and account, shipping rate, carrier and provider p...
Shipping Carrier Product Object Reference
Configures a shipping carrier product, including pricing rules to override, mark up, or clamp the carrier-quoted rate shown to customers.
Shipping Provider Object Reference
Configures a shipping provider to be offered as part of the checkout process. Mainly contains the necessary credentials for the provider's API.
[DEPRECATED] Shipping Provider Product Object Reference
[DEPRECATED] Configures a shipping provider product. Use shipping carrier product.
Shipping Rate Object Reference
Holds the information relating to flat rate shipping rates defined in the system for orders. Can be based on cart weight or value and can be furthe...
State Object Reference
A State represents a single geopolitical state or province to be used in creating a Zone which is used in both calculating tax or shipping within S...
Stock Adjustment Object Reference
Stock Adjustment is a history log that tracks quantity changes for stock levels. It is automatically created and should not be altered directly.
Stock Level Object Reference
Holds the quantity of a product available at each stock location. It applies only when the associated product has Track_Inventory__c set to true; w...
Stock Location Object Reference
Represents a specific location where stock is held to be sold.
Stock Transfer Item Object Reference
Contains the quantity to be transferred or received for each product in a given Stock_Transfer__c.
Stock Transfer Object Reference
Allows stock to be moved from one stock location to another.
Store Campaign Object Reference
Store Campaigns are a junction object between Stores and Campaigns. During the checkout process the customer is asked to sign up to all the Store C...
Store Feed Object Reference
Per-store mounting of a feed.
Store Form Object Reference
Represents the status of a form by store.
Store Group Object Reference
Defines a Group that one or more Stores can belong to.
Store Object Reference
Stores are the entry point to purchase within your StoreConnect site and this provides all the information needed to show a store on your StoreConn...
Store Role Object Reference
Defines a store role's type and level of access
Store Stock Location Object Reference
Join object between Stores and Stock Locations allowing a store to specify specific stock locations that it can ship from.
Store User Role Object Reference
Defines a user's role to determine the level of access within the scope of a store.
Store Variable Object Reference
A key-value setting on a Store that controls how that store behaves. Keys are unique per store, and a variable marked Available in Liquid can be re...
StoreConnect Audit Event Object Reference
Defines the event types recorded in your Audit Log, and the Category, Severity and retention period applied to each.
StoreConnect Runtime Object Reference
Internal StoreConnect runtime flags used during automated operations and unit tests (e.g., temporarily bypassing validation rules). Not intended fo...
StoreConnect Scope Definition Object Reference
Defines the static configuration for scope-enabled fields used by the recordScope LWC, including primary and secondary scope objects, UI labels, an...
StoreConnect Setting Object Reference
A collection of settings required to run your StoreConnect site.
Style Block Object Reference
Style Blocks contain CSS code that will be included on your web store.
Subscription Change Object Reference
Records each subscription plan change (upgrade or downgrade) for audit trail and reporting. Tracks old/new product, pricing, proration, and the mod...
Subscription Object Reference
A subscription purchased by a customer, with lookups for the contact, the subscribed product, the originating and renewal orders, any delinquent or...
Sync Summary Object Reference
Cached row counts of synced objects
Tag Object Reference
Tags are a way to assign simple metadata to various objects
Tax Group Object Reference
A Tax_Group__c object represets a group of Taxes used within StoreConnect, which can be associated with specific products. For example, you could h...
Tax Object Reference
A Tax__c object represents a tax code used within StoreConnect, associated with a specific product and zone. For example, a GST tax code belongs to...
Tax Provider Log Object Reference
Stores the request/response of each call to a tax provider's service when logging is enabled.
Tax Provider Object Reference
Configures a Tax provider to be offered as part of the checkout process. Mainly contains the necessary credentials for the provider's API.
Tax Tax Group Object Reference
Tax_Tax_Group__c is the join table between Tax and Tax_Group__c objects. It is the tax group (or multiple groups) that are associated with a Tax o...
Taxonomy Object Reference
A Taxonomy__c is a collection of Product_Category__c objects, and every Product_Category__c belongs to exactly one Taxonomy__c. Each Taxonomy__c be...
Theme Asset Object Reference
Theme Assets represent media files that belongs to a Theme
Theme Locale Object Reference
Theme Locales contain translation content for various languages and belong to a Theme
Theme Object Reference
Themes are used to implement custom designs for a Store
Theme Template Object Reference
Theme Templates represent Liquid templates that make up a Theme
Theme Variable Object Reference
A key-value setting on a Theme, readable from any template in that theme. Keys are unique per theme. A store variable with the same key overrides i...
Trait Category Object Reference
Holds a number of related trait types, such as "Dimensions" holding trait types of Width, Height and Depth.
Trait Object Reference
Traits provide the join between a specific Trait_Value__c, Trait_Type__c and Trait_Category__c and a Product2 object.
Trait Type Object Reference
A specific type of trait such as Width, Height, Color, Size. This belongs to a Trait Category and can have many Trait Values.
Trait Value Object Reference
A specific value for a Trait_Type__c, such as Red or Blue for a Color trait type. Values are stored individually so they can be reused across multi...
Transactional Email Object Reference
Hold the various transactional emails defined for each store allowing each store to have different branding or messages within their emails. ...
User Object Reference
The Salesforce standard User object, which StoreConnect extends for POS staff and API access: a PIN and OTP seed for register sign-in, attendance t...
Voucher Log Object Reference
Records all voucher events, including redemptions, activations, cancellations, and balance checks, with success status and failure reasons.
Voucher Object Reference
Vouchers can be used at checkout as payment
Voucher Payment Object Reference
A record of Payments made by Vouchers
Web Domain Object Reference
Reference documentation for the Web Domain object in StoreConnect, including field definitions, status values, and the domain connection lifecycle.
Zone City Object Reference
Join table between Zone__c and City__c objects.
Zone Country Object Reference
Join table between Zone__c and Country__c objects.
Zone Object Reference
A Zone represents a tax or shipping zone within StoreConnect. The zone can have one or many Zone_Countries, Zone_States or Zone_Postcodes, all comb...
Zone Postcode Object Reference
Join table between Zone__c and Postcode__c objects.
Zone State Object Reference
Join table between Zone__c and State__c objects.
How the StoreConnect data model fits together
Orientation for the StoreConnect Salesforce schema: the naming conventions, which objects are hubs, how records connect through lookups and junctio...
Standard Objects
StoreConnect extends 11 standard Salesforce objects -- Account, Asset, CampaignMember, Contact, Lead, Order, OrderItem, Pricebook2, PricebookEntry,...
Custom Objects
Complete list of every custom Salesforce object created by the StoreConnect managed package, from Account Credit Ledger to Zone, with links to each...
Junction objects
Understand how StoreConnect connects two records that have a many-to-many relationship, how to recognize a junction object by its name and fields, ...
Catalog objects
The Salesforce objects behind a StoreConnect catalog: products, categories, variants, bundles, traits, media, tags, and pricing. Use it to find the...
Order and checkout objects
The Salesforce objects behind checkout and everything after it: carts, orders, payments, subscriptions, vouchers, promotions, discounts, rewards, a...
Store design objects
The Salesforce objects behind how a storefront looks: stores, themes, templates, assets, pages, content blocks, menus, and style and script blocks....
Fulfillment and inventory objects
The Salesforce objects behind getting goods to customers and tracking what is in stock: shipments, fulfillments, stock levels and locations, transf...
POS objects
The Salesforce objects behind the StoreConnect point of sale: outlets, registers, shifts, POS users and PINs, layouts, views, action groups, and pr...
Customer and account objects
The Salesforce objects behind customers and their entitlements: accounts, contacts, addresses, memberships, account credit, loyalty points, restric...