Affiliate Commission
Available variables on AffiliateCommission objects
|
Example liquid accessor
|
|
{% for commission in page.commissions %}
|
| Locator | Description |
| commission.product_name |
{String} Get product's name
|
| commission.date |
{String} Get product's creation date
|
| commission.sale_total |
{String} Get product's total sale
|
| commission.sale_was_refunded |
{Boolean} Has the sale been refunded? True or False
|
| commission.amount_without_refunds |
{String} Amount of commissions ignoring refunds
|
| commission.amount_with_any_refunds |
{String} Amount of commission including any refunds
|
Affiliate Payout
Available variables on AffiliatePayout objects
| Example liquid accessor |
|
{% for payout in page.payouts %}
|
| Locator | Description |
| payout.date |
{String} Get affiliate's payout creation date
|
| payout.amount |
{String} Get affiliate's amount
|
Block
This drop exposes the type and settings for a block within a section.
| Locator | Description |
| block.type |
{String} Block type
|
| block.settings |
{Drops::Manifest} Block settings
|
Bundle
Contains information about the bundle
| Example liquid accessor |
|
{% for bundle in page.bundle %}
|
| Locator | Description |
| bundle.id |
{Number} Get the bundle's ID
|
| bundle.name |
{String} Get the bundle's name
|
| bundle.description |
{String} Get the bundle's description
|
| bundle.status |
{String} Get the bundle's status
|
| bundle.links |
{Drops::ProductLinks} Get the bundle's links
|
| bundle.is_public |
{Boolean} Is the bundle public? True or false
|
| bundle.is_free |
{Boolean} Is the bundle free? True or false
|
| bundle.display_price |
{String} Get the bundle's display price
|
| bundle.enroll_free_button_text |
{String} Get the bundle's enroll for free text
|
| bundle.previously_purchased |
{Boolean} Has the bundle been previously purchased by the current user? Returns true if enrollment is currently active, and false otherwise
|
| bundle.buy_button_text |
{String} Get the bundle's buy button text
|
| bundle.courses |
{String} Get the bundle's courses
|
| bundle.items |
{String} Get the bundle's items (requires system theme version 2.7.0 or higher to include products other than courses)
|
| bundle.course_contents_description |
{String} Get the bundle's course contents description
|
| bundle.coupon_supported |
{Boolean} Does the course support coupons? True or false
|
| bundle.banner_overlay_opacity_percentage |
{String} Get the bundle's banner overlay opacity percentage
|
| bundle.primary_price |
{Drop::ProductPrice} Get the bundle's primary price
|
| bundle.image | {Drops::Image} The course's image. DEPRECATED |
| bundle.card_image_url |
{String} Get the bundle's card image url
|
| bundle.banner_image_url |
{String} Get the bundle's banner image url
|
| bundle.product_metadata |
{String} Get the product's metadata
|
| product.collections |
{Drops::Collection} Collections that the card product card belongs to
|
| product.additional_prices |
{Drops::ProductPrice} Get the product's additional prices
|
Cart
This is the cart object that is used during a checkout flow
| Locator | Description |
| cart.line_items |
{Drops::LineItem} The line items present in the cart.
|
| cart.total_price |
{Number} The total price of the cart
|
| cart.is_free |
{Boolean} Is the checkout for a free product?
|
| cart.is_free_trial |
{Boolean} checkout for a free trial of a product?
|
| cart.currency |
{String} The currency of the current cart (e.g., 'USD')
|
| cart.currency_symbol |
{String} The currency symbol of the current cart (e.g., '\$')
|
| cart.has_items |
{Boolean} Does the cart currently contain any items?
|
| cart.item_count |
{Number} The number of items that the cart currently contains
|
Chapter
Available liquid variables on the chapter object
| Example liquid accessor |
|
{% for chapter in course.chapters %}
|
| Locator | Description |
| chapter.contents |
{Drops::Content} Get the chapter's contents
|
| chapter.name |
{String} Get the chapter's name
|
| chapter.duration_in_seconds |
{Number} Get the chapter's duration in seconds (chapter must have a timed content item, e.g. video)
|
| chapter.duration_in_seconds_as_time |
{Number} Get the chapter's duration in seconds as time
|
| course.has_lessons or chapter.has_lessons |
{Boolean} Does the course or chapter have lessons? True or false
|
| course.lesson_count or chapter.lesson_count |
{Number} Get the course or chapter lessons count. This actually returns the number of videos in the lessons. Eg: "4 Videos"
|
| course.has_quizzes or chapter.has_quizzes |
{Boolean} Does the course or chapter have quizzes? True or false
|
| course.quiz_count or chapter.quiz_count |
{Number} Get the course or chapter quizzes count
|
| course.has_surveys or chapter.has_surveys |
{Boolean} Does the course or chapter have surveys? True or false
|
| course.survey_count or chapter.survey_count |
{Number} Get the course or chapter surveys count
|
| course.has_multimedia or chapter.has_multimedia |
{Boolean} Does the course or chapter have multimedias? True or false
|
| course.multimedia_count or chapter.multimedia_count |
{Number} Get the course or chapter multimedias count
|
| course.has_text or chapter.has_text |
{Boolean} Does the course or chapter have text lessons? True or false
|
| course.text_count or chapter.text_count |
{Number} Get the course or chapter texts count
|
| course.has_pdfs or chapter.has_pdfs |
{Boolean} Does the course or chapter have pdfs? True or false
|
| course.pdf_count or chapter.pdf_count |
{Number} Get the course or chapter pdfs count
|
| course.has_disqus or chapter.has_disqus |
{Boolean} Does the course or chapter have disqus chats? True or false
|
| course.disqus_count or chapter.disqus_count |
{Number} Get the course or chapter disqus count
|
| course.has_audios or chapter.has_audios |
{Boolean} Does the course or chapter have audios? True or false
|
| course.audio_count or chapter.audio_count |
{Number} Get the course or chapter audios count
|
| course.has_downloads or chapter.has_downloads |
{Boolean} Does the course or chapter have downloads? True or false
|
| course.download_count or chapter.download_count |
{Number} Get the course or chapter downloads count
|
| course.has_presentations or chapter.has_presentations |
{Boolean} Does the course or chapter have presentations? True or false
|
| course.presentation_count or chapter.presentation_count |
{Number} Get the course or chapter presentations count
|
| course.has_brillium_exams or chapter.has_brillium_exams |
{Boolean} Does the course or chapter have brillium exams? True or false
|
| course.brillium_exam_count or chapter.brillium_exam_count |
{Number} Get the course or chapter brillium exams count
|
| course.has_duration or chapter.has_duration |
{Boolean} Does the course or chapter have an expected duration set? True or false
|
| course.duration or chapter.duration |
{Number} Get the expected course or chapter duration
|
Collections Drop
These variables are available for use in the product search bar when viewing the collection pages or collections page
| Example liquid accessor |
|
{% for collection in site.collection %}
|
| Locator | Description |
| collection.name |
{String} Get collection's name
|
| collection.id |
{Number} Get collection's id
|
| collection.slug |
{String} Get collection's slug
|
| collection.image |
{Drops::Image} The collection's image
|
| collection.url |
{String} Get collection's url
|
Community
Variables accessible on a community.
| Example liquid accessor |
|
{% for community in page.communities %}
|
| Locator | Description |
| community.id |
{Number} Get the community's ID
|
| community.name |
{String} Get the community's name
|
| community.description |
{String} Get the community's description
|
| community.image_url |
{String} Get the community's image URL
|
| community.post_count |
{Number} Get the total number of posts in the community
|
| community.links |
{Drops::ProductLinks} Get the community's available links
|
| community.is_draft |
{Boolean} Is the community in draft state? True or false
|
| community.is_public |
{Boolean} Is the community public? True or false
|
| community.is_presell |
{Boolean} Is the community set to preorder? True or false
|
| community.status |
{String} The community's current status
|
| community.is_free |
{Boolean} Is the community free? True or false
|
| community.user_can_purchase |
{Boolean} Is the community on sale to this user? True or false
|
| community.user_can_resume |
{Boolean} Is the user able to resume this community? True or false
|
| community.user_has_purchased |
{Boolean} Has the user purchased this community? True or false
|
| community.user_is_enrolled |
{Boolean} Is the user enrolled in the community? True or false
|
| community.card_image_url |
{String} The community's card image url
|
| community.product |
{Drop::Product} Get the community's current product
|
| community.primary_price |
{Drop::ProductPrice} Get the community's primary price
|
| community.display_price |
{String} Get the community's display price
|
| community.buy_button_text |
{String} Get the community's buy button text
|
| community.coupon_supported |
{Boolean} Does the community support coupons? True or false
|
| community.product_metadata |
{String} Get the product's metadata
|
| product.collections |
{Drops::Collection} Collections that the card product card belongs to
|
| product.additional_prices |
{Drops::ProductPrice} Get the product's additional prices
|
Content
Variables that are available in chapter objects
| Example liquid accessor |
|
{% for content in chapter.contents %}
|
| Locator | Description |
| content.name |
{String} Get the content's name
|
| content.free |
{Boolean} Is the content free? True or false.
|
| content.icon_css_class |
{String} Get the content's icon css class
|
| content.take_course_url |
{String} Get the content's url
|
Coupon
This provides information about the coupon code provided
| Locator | Description |
| coupon.name |
{String} Get coupon's name
|
| coupon.is_valid |
{Boolean} Has a valid coupon been entered? True or false
|
| coupon.is_percentage |
{Boolean} Is the currently applied coupon applied as a percentage off? True or false
|
| coupon.discounted_price |
{String} Get the product's price with the currently applied coupon
|
| coupon.discounted_amount |
{String} Get the currently applied coupon's discount amount
|
| coupon.full_price |
{String} Get the product's full price (without coupon applied)
|
| coupon.applied_text |
{String} Get the product's promotion description
|
Course
Variables accessible on course-related pages (such as course landing) on the page variable as well as elsewhere (e.g., bundle pages) through their own page-specific pages (e.g., page.bundle_courses on a bundle page)
| Example liquid accessor |
|
{% for course in page.bundle_courses %}
|
| Locator | Description |
| course.id |
{Number} Get the course's ID
|
| course.name |
{String} Get the course's name
|
| course.description |
{String} Get the course's description
|
| course.links |
{Drops::ProductLinks} Get the course's available links
|
| course.chapters |
{Drops::Chapter} Get the course's chapters
|
| course.is_draft |
{Boolean} Is the course in draft state? True or false
|
| course.is_public |
{Boolean} Is the course public? True or false
|
| course.is_presell |
{Boolean} Is the course set to preorder? True or false
|
| course.status |
{String} The course's current status
|
| course.has_free_trial |
{Boolean} Does the course have a free trial available to this user? True or false
|
| course.is_free |
{Boolean} Is the course free? True or false
|
| course.user_can_purchase |
{Boolean} Is the course on sale to this user? True or false
|
| course.user_can_resume |
{Boolean} Is the user able to resume this course? True or false
|
| course.user_has_purchased |
{Boolean} Has the user purchased this course? True or False
|
| course.user_is_enrolled |
{Boolean} Is the user enrolled in the course? True or false
|
| course.user_enrollment_complete |
{Boolean} Has the user completed the enrollment? True or false
|
| course.reviews_enabled |
{Boolean} Are reviews enabled for this course? True or false
|
| course.reviews |
{Drops::CourseReviews} Get the course's reviews. The number of reviews returned is limited to 100
|
| course.image | {Drops::Image} The course's image. DEPRECATED |
| course.card_image_url |
{String} The course's card image url
|
| course.product |
{Drop::Product} Get the course's current product
|
| course.primary_price |
{Drop::ProductPrice} Get the course's primary price
|
| course.display_price |
{String} Get the course's display price
|
| course.buy_button_text |
{String} Get the course's buy button text
|
| course.coupon_supported |
{Boolean} Does the course support coupons? True or false
|
| course.duration |
{Number} Estimated time to complete (hrs)
|
| course.lesson_count |
{Number} Get the product's lesson count if it's a course and if the theme is a site builder theme otherwise, return lesson_count_display which returns the number of videos
|
| course.instructor |
{Drops::Instructor} Get the instructor of the course
|
| course.has_lessons or chapter.has_lessons |
{Boolean} Does the course or chapter have lessons? True or false
|
| course.lesson_count or chapter.lesson_count |
{Number} Get the course or chapter lessons count. This actually returns the number of videos in the lessons. Eg: "4 Videos"
|
| course.has_quizzes or chapter.has_quizzes |
{Boolean} Does the course or chapter have quizzes? True or false
|
| course.quiz_count or chapter.quiz_count |
{Number} Get the course or chapter quizzes count
|
| course.has_surveys or chapter.has_surveys |
{Boolean} Does the course or chapter have surveys? True or false
|
| course.survey_count or chapter.survey_count |
{Number} Get the course or chapter surveys count
|
| course.has_multimedia or chapter.has_multimedia |
{Boolean} Does the course or chapter have multimedias? True or false
|
| course.multimedia_count or chapter.multimedia_count |
{Number} Get the course or chapter multimedias count
|
| course.has_text or chapter.has_text |
{Boolean} Does the course or chapter have text lessons? True or false
|
| course.text_count or chapter.text_count |
{Number} Get the course or chapter texts count
|
| course.has_pdfs or chapter.has_pdfs |
{Boolean} Does the course or chapter have pdfs? True or false
|
| course.pdf_count or chapter.pdf_count |
{Number} Get the course or chapter pdfs count
|
| course.has_disqus or chapter.has_disqus |
{Boolean} Does the course or chapter have disqus chats? True or false
|
| course.disqus_count or chapter.disqus_count |
{Number} Get the course or chapter disqus count
|
| course.has_audios or chapter.has_audios |
{Boolean} Does the course or chapter have audios? True or false
|
| course.audio_count or chapter.audio_count |
{Number} Get the course or chapter audios count
|
| course.has_downloads or chapter.has_downloads |
{Boolean} Does the course or chapter have downloads? True or false
|
| course.download_count or chapter.download_count |
{Number} Get the course or chapter downloads count
|
| course.has_presentations or chapter.has_presentations |
{Boolean} Does the course or chapter have presentations? True or false
|
| course.presentation_count or chapter.presentation_count |
{Number} Get the course or chapter presentations count
|
| course.has_brillium_exams or chapter.has_brillium_exams |
{Boolean} Does the course or chapter have brillium exams? True or false
|
| course.brillium_exam_count or chapter.brillium_exam_count |
{Number} Get the course or chapter brillium exams count
|
| course.has_duration or chapter.has_duration |
{Boolean} Does the course or chapter have an expected duration set? True or false
|
| course.duration or chapter.duration |
{Number} Get the expected course or chapter duration
|
| course.product_metadata |
{String} Get the product's metadata
|
| product.collections |
{Drops::Collection} Collections that the card product card belongs to
|
| product.additional_prices |
{Drops::ProductPrice} Get the product's additional prices
|
Course Review
Variables available on course review objects
| Example liquid accessor |
| None |
| Locator | Description |
| course.review.title |
{String} Get the review's title
|
| course.review.user |
{String} Get the user who posted the review
|
| course.review.review_text |
{String} Get the review's text
|
| course.review.rating |
{String} Get the review's rating
|
| course.review.course |
{Drops::Course} Get the attached course for this review
|
Reviews
|
Example liquid accessor
|
|
{% for review in course.reviews %}
|
| Locator | Description |
| course.reviews.approved |
{Drops::CourseReview} Get the course's approved reviews
|
| course.reviews.approved_count |
{Number} Get the course's approved reviews count
|
| course.reviews.average_rating |
{Number} Get the course's average review rating
|
Custom Link
Variables available for any user-created custom links
|
Example liquid accessor
|
|
{% for link in site.custom_left_links %} or {% for link in site.custom_right_links %}
|
| Locator | Description |
| link.formatted_url |
{String} Get the custom link's properly formatted target url (href)
|
| link.target |
{String} Get the custom link's target (e.g., Link)
|
| link.formatted_text |
{String} Get the custom link's formatted text
|
| link.position |
{String} Get the custom link's position within the menu
|
| link.is_private |
{Boolean} Is the link private? True or false
|
| link.is_public |
{Boolean} Is the link public? True or false
|
Custom Profile Field
Available current user custom profile field data
| Locator | Description |
| site.current_user.custom_profile_fields[0].value |
Get the value for the field
|
| site.current_user.custom_profile_fields[0].label |
Get the label for the field
|
| site.current_user.custom_profile_fields[0].field_type |
Get the type for the field. Possible values are: 'text' and 'country'
|
| site.current_user.custom_profile_fields[0].is_required |
Is the field required? True or false
|
Sign Up Page
This provides data to help render custom sign-up fields
| Example liquid accessor |
|
{% for field in custom_signup_fields %}
|
| Locator | Description |
| field.name |
{String} Get the custom signup field's name attribute
|
| field.value |
{String} Get the custom signup field's value
|
| field.label |
{String} Get the custom signup field's label
|
| field.required |
{Boolean} Is the custom signup field required? True or False
|
| field.hidden_input |
{String} Get the custom signup field's hidden input
|
| field.type_is_country |
{Boolean} Is the custom signup field's type country? True or False
|
| field.country_options |
{Array} Get custom signup field's country options
|
Dashboard Course Card
Variables available on the student dashboard for the school. Please check out the file "snippets/pagination" in the basic theme package to see an working example of how to use these variables.
| Example liquid accessor |
|
{% for card in paginate.collection %}
|
| Locator | Description |
| card.created_at |
{String} Get the product's creation date
|
| card.display_price |
{String} Get the product's display price
|
| card.enrollment_complete |
{Boolean} Is the student's enrollment in this product complete? True or false
|
| card.enrollment_expired |
{Boolean} Is the student's enrollment in this product expired? True or false
|
| card.enrollment_expiry_date |
{String} Get the student's enrollment expiry date
|
| card.has_enrollment |
{Boolean} Is the student enrolled in the product? True or false
|
| card.last_accessed |
{String} Get the date of last student access to the product
|
| card.name |
{String} Get the coures's name
|
| card.name_truncated |
{String} Get the course's truncated name (truncated to 70 characters)
|
| card.position |
{String} Get the course's position within the dashboard
|
| card.progress_percentage |
{String} Get the course's percentage completed
|
| card.show_enroll_in_free_trial_link |
{Boolean} Should the card show the free trial link? True or false
|
| card.show_enroll_for_free_link |
{Boolean} Should the card show the enroll for free link? True or false
|
| card.show_purchase_link |
{Boolean} Should the card show the purchase link? True or false
|
| card.show_resume_link |
{Boolean} Should the card show the resume link? True or false
|
| card.subtitle_truncated |
{String} Get the course's truncated subtitle - DEPRECATED (2018/04)
|
| card.subtitle |
{String} Get the course's subtitle - DEPRECATED (2018/04)
|
| card.description_truncated |
{String} Get the course's truncated description
|
| card.description |
{String} Get the course's description
|
| card.course_reviews_enabled |
{Boolean} Are reviews enabled for this course? True or false
|
| card.is_hidden |
{Boolean} Is the course hidden? True or false
|
| card.course |
{Drops::Course} The course
|
| card.image |
{Drops::Image} The course's image. DEPRECATED
|
| card.image_url |
{String} Get the course's card image url
|
| card.landing_page_url |
{String} Get the course's landing page url. DEPRECATED
|
| card.free_enroll_url |
{String} Get the course's free enrollment url. DEPRECATED
|
| card.free_trial_enroll_url |
{String} Get the course's free trial enrollment url. DEPRECATED
|
| card.purchase_course_url |
{String} Get the course's purchase url. DEPRECATED
|
| card.resume_course_url |
{String} Get the course's resume url
|
| card.review_course_url |
{String} Get the course's review url. DEPRECATED
|
| card.course_review_url |
{String} Get the course's review url (repeat of above)
|
| card.is_presell |
{Boolean} Is the course set to preorder? True or false
|
Enrollment
This provides information about an enrollment in a course.
| Locator | Description |
| enrollment.course_name |
{String} Get the enrolled course's name
|
| enrollment.completed_at |
{String} Get the enrolled course's completed date
|
| enrollment.certificate_url |
{String} Get the enrolled course's certificate url
|
Imageable
Image at different dimensions.
| Example liquid accessor |
| None |
| Locator | Description |
| .image.thumb |
{String} Large image's url
|
| .image.small |
{String} Small image's url
|
| .image.medium |
{String} Medium image's url
|
| .image.large |
{String} Large image's url
|
| .image.original |
{String} Original image's url
|
Instructor
Contains information about the instructor
| Locator | Description |
| instructor.first_name |
{String} Get the instructor's first name
|
| instructor.last_name |
{String} Get the instructor's last name
|
| instructor.full_name |
{String} Get the instructor's full name
|
| instructor.email |
{String} Get the instructor's email
|
| instructor.title |
{String} Get the instructor's title
|
| instructor.bio |
{String} Get the instructor's bio
|
| instructor.avatar |
{String} Get the instructor's avatar
|
| instructor.image |
{String} Get the instructor's image
|
JSON Object
A drop that accepts a hash of attributes and makes these attributes available as properties on the drop.
No variables are available yet!
Line Item
These variables yield the details of the product which a student has just purchased or is in the process of purchasing. In particular it describes the details of the condition of the purchase, e.g., is the product free or is it a free trial.
| Example liquid accessor |
|
{% for line_item in cart.line_items %}
|
| Locator | Description |
| line_item.name |
{String} Get the order's name
|
| line_item.description |
{String} Get the order's description
|
| line_item.price |
{String} Get the order's cost
|
| line_item.created_date |
Get the date that the line item was created on
|
| line_item.product |
{Drops::Product} The product that the line item refers to
|
| line_item.product_price |
{Drops::ProductPrice} The product price that the line item refers to
|
| line_item.is_free |
{Boolean} Is the current checkout for a free enrollment?
|
| line_item.is_free_trial |
{Boolean} Is the current checkout for a free trial enrollment?
|
| line_item.is_paid |
{Boolean} Is the current checkout for a paid enrollment?
|
| line_item.is_payment_plan |
{Boolean} Is the current checkout for a paid enrollment using a payment plan?
|
| line_item.is_subscription |
{Boolean} Is the current checkout for a paid enrollment using a subscription?
|
| line_item.is_recurring |
{Boolean} Is the current checkout for a paid enrollment using a recurring payment?
|
Manifest
These variables represent the settings for a theme or section, which are defined in their relative schema (within manifest.json for theme and within the {% schema %} block for sections).
No variables are available yet!
Meta Tag
A drop that accepts a hash of attributes and makes an HTML meta tag with these attributes. Example: input: {'name' => 'description', 'content' => 'lorem ipsum'} output: Each attribute is also available as a property on the drop.
No variables are available yet!
Order
Variables available for the order object
| Example liquid accessor |
|
{% for order in page.orders %}
|
| Locator | Description |
| order.id |
{Number} Get the order's ID
|
| order.number |
{Number} Get the order's number
|
| order.has_subscription |
{Boolean} Does the order have a subscription product in it? True or false
|
| order.has_payment_plan |
{Boolean} Does the order have a payment plan in it? True or False
|
| order.has_recurring |
{Boolean} Does the order have a subscription or payment plan in it? True or false
|
| order.description_of_subscription |
{String} Get the order's subscription description
|
| order.product_name |
{String} Get the product's name
|
| order.created_date |
{String} Get the order's creation date
|
| order.payment_method |
{String} Get the order's payment method
|
| order.payment_method_key |
{String} Get the order's payment method key
|
| order.status |
{String} Get the order's status
|
| order.status_key |
{String} Get the order's status key
|
| order.cost |
{String} Get the order's cost
|
| order.cost_in_cents |
{String} Get the order's cost in cents (e.g. 10000 for \$100.00)
|
| order.masked_card_numbers |
{String} Get the order's masked card numbers
|
| order.product_expiry_date |
{String} Get the expiry date of the product contained in the order
|
| order.coupon |
{Drops::Coupon} Get the coupon used in the order
|
| order.line_items |
{Drops::LineItem} Get order's line items
|
| order.refunded_transactions |
{Drops::OrderTransaction} Get order's refunded transactions
|
| order.payments |
{Drops::Payment} Get order's payments
|
| order.cart_purchased_date |
Get the date that the coupon was applied
|
| order.number_of_recurring_payments |
{String} Get the total number of recurring payments
|
| order.billing_name |
{String} Get the billing name
|
| order.billing_email |
{String} Get the billing email
|
| order.referral_code |
{String} Get the order referral code
|
Order transaction
Variables available for the order transaction object
| Example liquid accessor |
|
{% for transaction in page.order.refunded_transactions %}
|
| Locator | Description |
| transaction.amount |
{String} Get order's transaction amount
|
| transaction.created_date |
Get the date that the transaction was created on
|
Payment
Variables available for the payment object
| Example liquid accessor |
|
{% for payments in page.payments %}
|
| Locator | Description |
| payment.id |
{Number} Get the payment's ID
|
| payment.created_date |
{String} Get the payment's creation date
|
| payment.total |
{String} Get the order's cost
|
Product
Available variables on Product objects
| Example liquid accessor |
|
{% for product in page.products %}
|
| Locator | Description |
| product.name |
{String} Get the product's name
|
| product.display_price |
{String} Get the product's display price
|
| product.additional_prices |
{Drops::ProductPrice} Get the product's additional prices
|
| product.links |
{Drops::ProductLinks} Get the product's links
|
| product.is_course |
{Boolean} Is the product a course? True or False
|
| product.is_bundle |
{Boolean} Is the product a bundle? True or False
|
| product.is_community |
{Boolean} Is the product a community? True or False
|
| product.course |
{Drops::Course} Get the product's course
|
| product.bundle |
{Drops::Bundle} Get the product's bundle
|
| product.community |
{Drops::Community} Get the product's community
|
| product.card_image_url |
{String} Get the product's card image url
|
| product.image |
{String} The product's image
|
| product.productable |
{Drops::Course} or {Drops::Bundle} Get the product's course or bundle
|
| product.product_type_icon |
{String} Get the product type icon
|
| product.product_type_name |
{String} Get the product type name
|
| product.product_metadata |
{String} Get the product's metadata
|
Product Links
All of the product-related links available. product_type is either 'Course', 'Bundle', or 'Community'
| Locator | Description |
| links.enroll_free_trial |
{String} Get product's enroll free trial url
|
| links.enroll_free |
{String} Get product's enroll free url
|
| links.buy |
{String} Get product's buy url
|
| links.resume |
{String} Get product's resume url
|
| links.review |
{String} Get product's review url
|
| links.landing_page_url |
{String} Get product's landing page url
|
| links.add_to_cart |
{String} Get product's add to cart url
|
Product Price
Available variables on Product objects
| Example liquid accessor |
|
{% for product in page.products %}
|
| Locator | Description |
| product.name |
{String} Get the price's name
|
| product.display_price |
{String} Get the price's display name
|
| product.buy_button_text |
{String} Get the price's buy button text
|
| product.cta_text |
e.g. "Subscribe \$10.00 / month"
|
| product.cta_text_short |
e.g. "Subscribe Now", "Buy \$10.00"
|
| product.cta_text_without_price |
e.g. "Subscribe Now", "Buy Now", "Enroll Free"
|
| product.product |
{Drops::Product} Get the product that the price belongs to
|
| product.links |
{Drops::Product} Get the price's links
|
Section
This drop exposes settings and blocks for a section.
| Locator | Description |
| section.settings |
{Drops::Manifest} Get the section's settings
|
| section.blocks |
{Drops::Block} Get the section's blocks
|
| section.id |
{String} Get section's unique id
|
User
Available user data
| Locator | Description |
| site.current_user.id or course.review.user.id |
{String} Get the user's unique identificator
|
| site.current_user.custom_profile_fields or course.review.user.custom_profile_fields |
Get a collection of the custom profile fields for this user
|
| site.current_user.sign_in_count or course.review.user.sign_in_count |
{Number} Get the number of times the user signed in
|
| site.current_user.current_sign_in_at or course.review.user.current_sign_in_at |
{String} Get the user's sign in date
|
| site.current_user.last_sign_in_at or course.review.user.last_sign_in_at |
{String} Get the user's last sign in date
|
| site.current_user.current_sign_in_ip or course.review.user.current_sign_in_ip |
{Number} Get the user's current sign in IP
|
| site.current_user.is_first_sign_in or course.review.user.is_first_sign_in |
{Boolean} Is this the first signin for the user?
|
| site.current_user.last_sign_in_ip or course.review.user.last_sign_in_ip |
{Number} Get the user's last sign in IP
|
| site.current_user.stripe_customer_id or course.review.user.stripe_customer_id |
{String} Get the user's stripe id
|
| site.current_user.signed_in or course.review.user.signed_in |
{Boolean} Is the user signed in?
|
| site.current_user.first_name or course.review.user.first_name |
{String} Get the user's first name
|
| site.current_user.first_name_last_initial or course.review.user.first_name_last_initial |
{String} Get the user's first name and last initial
|
| site.current_user.last_name or course.review.user.last_name |
{String} Get the user's last name
|
| site.current_user.full_name or course.review.user.full_name |
{String} Get the user's full name
|
| site.current_user.email or course.review.user.email |
{String} Get the user's email
|
| site.current_user.is_student or course.review.user.is_student |
{Boolean} Is the user a student?
|
| site.current_user.is_site_owner or course.review.user.is_site_owner |
{Boolean} Is the user the site owner?
|
| site.current_user.is_site_admin or course.review.user.is_site_admin |
{Boolean} Is the user an administrator for this site?
|
| site.current_user.is_affiliate or course.review.user.is_affiliate |
{Boolean} Is the user an affiliate on the site?
|
| site.current_user.is_course_admin or course.review.user.is_course_admin |
{Boolean} Is the user a course admin for a course on this site?
|
| site.current_user.can_change_notifications or course.review.user.can_change_notifications |
{Boolean} Can the user change notifications?
|
| site.current_user.has_certificates or course.review.user.has_certificates |
{Boolean} Does the user have certificates?
|
| site.current_user.has_password or course.review.user.has_password |
{Boolean} Does the user have a password set?
|
| site.current_user.external_source or course.review.user.external_source |
{String} Get the user's external source
|
| site.current_user.bio or course.review.user.bio |
{String} Bio field on user's profile
|
| site.current_user.enrolled_course_names or course.review.user.enrolled_course_names |
{Array of Strings} A list of course names that the user is enrolled in
|
| site.current_user.enrolled_bundle_names or course.review.user.enrolled_bundle_names |
{Array of Strings} A list of bundle names that the user is enrolled in
|
| site.current_user.enrolled_bundle_names or course.review.user.enrolled_community_names |
{Array of Strings} List community names that the user is enrolled in
|
| site.current_user.username or course.review.user.username |
{String} Get the user's username
|
| site.current_user.created_at or course.review.user.created_at |
{Date} Get the user's created at date
|
| site.current_user.signed_up_at or course.review.user.signed_up_at |
{Date} Get the user's signed up at date (equal to created_at)
|
| site.current_user.updated_at or course.review.user.updated_at |
{Date} Get the user's updated at date
|
| site.current_user.avatar or course.review.user.avatar |
{String} Get the user's avatar url (150x150px)
|
| site.current_user.default_user_avatar_url or course.review.user.default_user_avatar_url |
{String} Get the thinkific's default avatar url
|
| site.current_user.account_url or course.review.user.account_url |
{String} Get the user's account url
|
| site.current_user.signed_in_via_sso or course.review.user.signed_in_via_sso |
{Boolean} Is the user signed in via SSO (Single Sign-On)?
|
Product
Base variables available to any product objects (e.g, bundles, courses)
| Locator | Description |
| page.seo_title |
{String} Get the SEO Title
|
| page.seo_description |
{String} Get the SEO Description
|
| page.keywords |
{String} Get the product's keywords
|
| page.is_hidden |
{Boolean} Is the product hidden? True or false
|
| page.product_is_course |
{Boolean} Is the product a course?
|
| page.product_is_bundle |
{Boolean} Is the product a bundle?
|
| page.product_is_community |
{Boolean} Is the product a community?
|
| page.landing_page_code |
{String} Get the custom landing page code
|
Authorization Helpers
These variables refer to the various authorization methods that are enabled for the school and are therefore available for authorizing students
| Locator | Description |
| page.has_remote_signin |
{Boolean} Does the user have a remote sign-in? True or false
|
| page.has_linkedin_enabled |
{Boolean} Does the user have LinkedIn enabled? True or false
|
| page.has_facebook_enabled |
{Boolean} Does the user have Facebook enabled? True or false
|
| page.has_google_enabled |
{Boolean} Does the user have Google enabled? True or false
|
| page.supports_remote_auth |
{Boolean} Supports remote auth? Always returns false. DEPRECATED (2018/08)
|
| page.linkedin_oauth_url |
{String} User LinkedIn oAuth Url
|
| page.facebook_oauth_url |
{String} User Facebook oAuth Url
|
| page.google_oauth_url |
{String} User Google oAuth Url
|
| page.tenant_oauth_url |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.tenant_auth_text |
{String} Always returns '' (empty string). DEPRECATED (2018/08)
|
| page.sign_up_url |
{String} Get the sign-in url
|
| page.forgot_password_url |
{String} Get the forgot password url
|
| page.sign_in_url |
{String} Get the sign-in url
|
Collection Helpers
These variables are accessible from the collection/collections pages
| Locator | Description |
| page.should_paginate_products |
{Boolean} Should the collection be paginated? Returns true if the number of pages in the collection is greater than 1. True or false.
|
| page.product_page_numbers |
{Array} Get available page numbers for pagination of the collection
|
| page.current_product_page |
{Number} Get the current product's page
|
| page.has_products |
{Boolean} Does the collection have products? True or false.
|
| page.products |
{Drops::Product} Get the products to be rendered on the page
|
Drop Helper
No variables are available yet!
Course or Chapter Contents
Variables on each course describing the contents of the course
| Example liquid accessor |
|
{% for course in page.bundle_courses %}
|
| Locator | Description |
| course.has_lessons or chapter.has_lessons |
{Boolean} Does the course or chapter have lessons? True or false
|
| course.lesson_count or chapter.lesson_count |
{Number} Get the course or chapter lessons count. This actually returns the number of videos in the lessons. Eg: "4 Videos"
|
| course.has_quizzes or chapter.has_quizzes |
{Boolean} Does the course or chapter have quizzes? True or false
|
| course.quiz_count or chapter.quiz_count |
{Number} Get the course or chapter quizzes count
|
| course.has_surveys or chapter.has_surveys |
{Boolean} Does the course or chapter have surveys? True or false
|
| course.survey_count or chapter.survey_count |
{Number} Get the course or chapter surveys count
|
| course.has_multimedia or chapter.has_multimedia |
{Boolean} Does the course or chapter have multimedias? True or false
|
| course.multimedia_count or chapter.multimedia_count |
{Number} Get the course or chapter multimedias count
|
| course.has_text or chapter.has_text |
{Boolean} Does the course or chapter have text lessons? True or false
|
| course.text_count or chapter.text_count |
{Number} Get the course or chapter texts count
|
| course.has_pdfs or chapter.has_pdfs |
{Boolean} Does the course or chapter have pdfs? True or false
|
| course.pdf_count or chapter.pdf_count |
{Number} Get the course or chapter pdfs count
|
| course.has_disqus or chapter.has_disqus |
{Boolean} Does the course or chapter have disqus chats? True or false
|
| course.disqus_count or chapter.disqus_count |
{Number} Get the course or chapter disqus count
|
| course.has_audios or chapter.has_audios |
{Boolean} Does the course or chapter have audios? True or false
|
| course.audio_count or chapter.audio_count |
{Number} Get the course or chapter audios count
|
| course.has_downloads or chapter.has_downloads |
{Boolean} Does the course or chapter have downloads? True or false
|
| course.download_count or chapter.download_count |
{Number} Get the course or chapter downloads count
|
| course.has_presentations or chapter.has_presentations |
{Boolean} Does the course or chapter have presentations? True or false
|
| course.presentation_count or chapter.presentation_count |
{Number} Get the course or chapter presentations count
|
| course.has_brillium_exams or chapter.has_brillium_exams |
{Boolean} Does the course or chapter have brillium exams? True or false
|
| course.brillium_exam_count or chapter.brillium_exam_count |
{Number} Get the course or chapter brillium exams count
|
| course.has_duration or chapter.has_duration |
{Boolean} Does the course or chapter have an expected duration set? True or false
|
| course.duration or chapter.duration |
{Number} Get the expected course or chapter duration
|
Drop Manifest Helper
No variables are available yet!
Product Helpers
Base variables available to any product card objects (e.g, bundle card, course card)
| Locator | Description |
| product.collections |
{Drops::Collection} Collections that the card product card belongs to
|
| product.additional_prices |
{Drops::ProductPrice} Get the product's additional prices
|
Search Query Helpers
These variables are accessible from the collection/collections pages and the student dashboard page.
| Locator | Description |
| page.has_search_query |
{Boolean} Does the page have a search query applied? True or false.
|
| page.search_query |
{String} Get the currently applied search query
|
Social Login Helpers
These variables are accessible from the sign_in/sign_up pages.
| Locator | Description |
| page.social_providers |
{Array} Get enabled social providers for the tenant with the following attributes: oauth_url, class and fa_icon
|
App
This drop exposes the app data to an app section only.
| Locator | Description |
| app.name |
{String} Get the app's name
|
| app.website |
{String} Get the app's website
|
| app.logo |
{String} Get the app's logo url
|
| app.support_email |
{String} Get the app's support email
|