Skip to content
Log in

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

Reference documentation for the Account object in StoreConnect.

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.

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

Reference documentation for the Article Category object in StoreConnect.

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

Reference documentation for the Asset object in StoreConnect.

Booking Attendee Object Reference

Booking Attendee tracks the Contacts that attended a Booking

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

Reference documentation for the CampaignMember object in StoreConnect.

Cart Campaign Object Reference

Tracking information attached to a Cart such as the UTM details.

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. The record is often generated from the Store website.

Change Event Object Reference

Reference documentation for the Change Event object in StoreConnect.

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

Defines special pricing for component products when used in bundles. Component pricing allows you to override the standard pricebook entry pricing ...

Condition Object Reference

Condition defines what must be true for an advanced promotion reward to apply. Set the type, threshold amount, optional currency filter, and Liquid...

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

Reference documentation for the Contact object in StoreConnect.

Content Block Object Reference

Content blocks are reusable pieces of content that are used within the StoreConnect CMS. They can be used within Pages, Articles, Products, Product...

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.

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 Item Object Reference

Fulfillment_Item__c is the join table between Shipment__c and OrderItem objects.

Lead Object Reference

Reference documentation for the Lead object in StoreConnect.

Locale Translation Object Reference

Locale Translations are key/value pairs of translations that belong to a Theme Locale

Location Group Account Object Reference

Reference documentation for the Location Group Account object in StoreConnect.

Location Group Object Reference

Reference documentation for the Location Group object in StoreConnect.

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 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

Reference documentation for the Order object in StoreConnect.

OrderItem Object Reference

Reference documentation for the OrderItem object in StoreConnect.

Outlet Object Reference

Outlet represents a group of Registers used for StoreConnect's Point-Of-Sale system.

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 Item Object Reference

Reference documentation for the Payment Item object in StoreConnect.

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 actions reference

Complete reference for all available POS actions — the identifiers, parameters, and behavior for actions that can be triggered from action buttons,...

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 used for POS receipt printing.

scAction

The scAction global JavaScript function lets custom code in POS views and HTML templates trigger any POS action programmatically, with optional onS...

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

Reference documentation for the Pricebook2 object in StoreConnect.

PricebookEntry Object Reference

Reference documentation for the PricebookEntry object in StoreConnect.

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 collecation of Product2 objects. Every Product_Category__c belongs to exactly one Taxonomy__c. Product_...

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 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 different variations of the same product. For example, small, medium and large, or red, green or blue. Each product ca...

Product2 Object Reference

Reference documentation for the Product2 object in StoreConnect.

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

Promotions are codes that allow your shoppers to get a discount on their shopping cart. Unlike Discounts that are automatically applied, a promotio...

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 an advanced promotion. Defines scheduling, stacking rules, channel and customer scoping, coupon codes, usage l...

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.

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.

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 an advanced promotion condition is met. Supports percentage or fixed discounts on the subtotal, products,...

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 relating to a shipment of a specific order item.

Shipping Carrier Product Object Reference

Configures a shipping carrier product.

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 volumne of products available for each stock location and is utilized by StoreConnect if the associated product has have Track_Inventory_...

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 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

Reference documentation for the Store Variable object in StoreConnect.

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 Object Reference

A subscription that has been purchased by a customer

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 represets a tax code used within StoreConnect and then can be associated with a specific product and zone. For example, you could h...

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 represents a collection of Product_Category__c objects. Every Product_Category__c belongs to exactly one Taxonomy__c. Each Taxonomy__...

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

Reference documentation for the Theme Variable object in StoreConnect.

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, Colour, 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. For example, for a "Colour" Trait Type, the Trait Value would be "Red" or "Blue&quot...

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

Reference documentation for the User object in StoreConnect.

Voucher Log Object Reference

Records all actions and state changes related to vouchers.

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.

checkout:start

The checkout:start POS action starts checkout from the active (or a specified) cart, running the same validation as the cart Pay button. It can be ...

POS icons reference

Complete list of available icon names for POS action items, with descriptions of each icon's appearance and typical use.

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...

sync:full

The sync:full POS action forces a full re-download of POS data from the server. An optional object parameter limits the sync to a single object type.