CustomForm - Liquid Object Reference
On this page
Description
The CustomForm object represents a form which is used to collect data from users.
:::note
This object supports custom data via the data attribute.
:::
Backed by
This drop renders the s_c__Form__c Salesforce object. A theme writes it as custom_form.
| Liquid attribute | Salesforce field |
|---|---|
identifier |
s_c__Identifier__c |
name |
s_c__Display_Name__c |
type |
s_c__Record_Type_Name__c |
Every other attribute on this drop is derived by StoreConnect rather than read straight from one field. The Attributes section lists them all.
Fields you add yourself are not listed above. Expose one with a Custom Data Mapping record, then read it from custom_form.data. See custom data fields in Liquid.
Attributes
| Attribute | Type | Description |
|---|---|---|
answers |
List[CustomFormAnswer] | Returns the list of CustomFormAnswers for this CustomForm |
display_mode |
String | Returns the display mode for this CustomForm |
id |
String | Returns a unique ID for this CustomForm |
identifier |
String | Returns the identifier of the CustomForm |
item |
CartItem | Returns the CartItem associated with this CustomForm |
name |
String | Returns the name of the CustomForm |
questions |
List[CustomFormQuestion] | Returns the list of CustomFormQuestions this CustomForm |
success_content |
String | Returns the success content of the CustomForm as HTML |
success_page |
Page | Returns the success page of the CustomForm |
type |
String | Returns the type of the CustomForm |
Available on
- Cart - Liquid Object Reference —
custom_forms - CartItem - Liquid Object Reference —
custom_forms - CustomFormQuestion - Liquid Object Reference —
form - CustomFormSubmission - Liquid Object Reference —
custom_form - Global - Liquid Object Reference —
all_custom_forms - Order - Liquid Object Reference —
custom_forms - OrderItem - Liquid Object Reference —
custom_forms - Product - Liquid Object Reference —
custom_forms
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.