Ecommerce

Brisk managed documentation

Core Records

Core Records

Abandoned Carts

Abandoned Carts

Purpose and when to use this record

Review a shopper cart that was not completed, its customer/contact context, totals, recovery state, and any later order.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on abandoned carts. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Abandoned Cart belongs and which later screens can find it.

Review Abandoned Cart details

Use the detail page as the shared record of what this Abandoned Cart currently means. Verify Subtotal, Tax Total, Discount Total, Total, and Status before relying on it for a decision.

Follow Store, Customer Link, Order, and Discount Code to determine whether the issue is on this Abandoned Cart or on one of those linked records.

Next check: If recovery is appropriate, use the recorded contact and cart context; if the shopper later checks out, verify the resulting order link rather than treating both records as separate demand.

Edit an existing Abandoned Cart

Edit this Abandoned Cart to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Store, Customer Link, Order, and Discount Code with the supporting document or approved request.

  2. Recheck Customer Link, Subtotal, Tax Total, Discount Total, Total, and Status. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Abandoned Cart now appears under the expected Status.

After the change: If recovery is appropriate, use the recorded contact and cart context; if the shopper later checks out, verify the resulting order link rather than treating both records as separate demand.

Find and review abandoned carts

Brisk Abandoned Carts list screen displayed with fictional documentation-demo data.
The Abandoned Carts list screen in the Brisk documentation demo.

Use the Abandoned Carts list to find the correct record before opening or changing it. Compare Discount Code, First Name, Last Name, and Status. Records with similar names or numbers can still belong to different Store, Customer Link, Order, and Discount Code.

Open the Abandoned Cart whose Discount Code, First Name, Last Name, and Status match the task. If it is missing, clear the list filters and recheck Store, Customer Link, Order, Discount Code, Last Activity At, and Status rather than creating a replacement immediately.

Fields and business rules

Brisk stores 23 user-relevant fields for this Abandoned Cart, including 4 linked-record selections and 1 controlled-choice field. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this abandoned cart.
Customer Link No The customer link associated with this abandoned cart.
Order No The order associated with this abandoned cart.
Discount Code No The discount code associated with this abandoned cart.
Session Key No The session key recorded for this abandoned cart.
Auth User Id No The auth user ID value recorded for this abandoned cart.
Email No Email address recorded as email for this abandoned cart.
First Name No The first name recorded for this abandoned cart.
Last Name No The last name recorded for this abandoned cart.
Recovery Token No The recovery token recorded for this abandoned cart.
Cart Snapshot No Structured cart snapshot data stored for this abandoned cart.
Subtotal No The subtotal value recorded for this abandoned cart.
Tax Total No The tax total value recorded for this abandoned cart.
Discount Total No The discount total value recorded for this abandoned cart.
Total No The total value recorded for this abandoned cart.
Item Count No The item count value recorded for this abandoned cart.
Status No Current status of this abandoned cart. Available values: Open, Recovered, Expired.
Last Activity At No Date and time recorded for last activity at on this abandoned cart.
Abandoned At No Date and time recorded for abandoned at on this abandoned cart.
Reminder Count No The reminder count value recorded for this abandoned cart.
Reminder Sent At No Date and time recorded for reminder sent at on this abandoned cart.
Recovered At No Date and time recorded for recovered at on this abandoned cart.
Last Recovery Clicked At No Date and time recorded for last recovery clicked at on this abandoned cart.

What happens next

If recovery is appropriate, use the recorded contact and cart context; if the shopper later checks out, verify the resulting order link rather than treating both records as separate demand.

Common mistakes and troubleshooting

Core Records

Api Credentials

Api Credentials

Purpose and when to use this record

Grant an ecommerce integration only the product, page, store, order, tracking, status, or shipping capabilities it needs.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on api credentials. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this API Credential belongs and which later screens can find it.

Create an API Credential

Brisk Api Credentials create screen displayed with fictional documentation-demo data.
The Api Credentials create screen in the Brisk documentation demo.

Create an API Credential for one identifiable integration or device. Do not share one credential across unrelated systems because revocation and audit history would become ambiguous.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, and Name.

  3. Review Is Active, Allow Read Products, Allow Read Pages, Allow Read Store, Allow Read Orders, and Allow Write Tracking, plus the remaining screen fields deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the API Credential, then confirm Name, and Allow Write Order Status on its detail page before continuing.

After saving: Give the generated secret only to the named client, test each granted capability, and disable the credential promptly if its source network or owner changes.

Delete an API Credential

Disable or revoke this API Credential when access must stop. Delete it only after its audit value is no longer needed and the integration has been moved to a replacement credential.

If the record is merely obsolete, use Is Active to remove it from future use while preserving existing references.

On the confirmation page, verify Name, and Allow Write Order Status. After confirmation, return to the API Credentials list and make sure only the intended API Credential was removed.

Review API Credential details

Use the detail page as the shared record of what this API Credential currently means. Verify Is Active, and Allow Write Order Status before relying on it for a decision.

Follow Store to determine whether the issue is on this API Credential or on one of those linked records.

Next check: Give the generated secret only to the named client, test each granted capability, and disable the credential promptly if its source network or owner changes.

Edit an existing API Credential

Edit this API Credential to reduce access, rotate ownership, set an expiration, or disable the integration. Create a separate credential when the calling system changes.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Is Active, and Allow Write Order Status. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the API Credential now appears under the expected Is Active, and Allow Write Order Status.

After the change: Give the generated secret only to the named client, test each granted capability, and disable the credential promptly if its source network or owner changes.

Find and review api credentials

Brisk Api Credentials list screen displayed with fictional documentation-demo data.
The Api Credentials list screen in the Brisk documentation demo.

Use the Api Credentials list to find the correct record before opening or changing it. Compare Name, and Allow Write Order Status. Records with similar names or numbers can still belong to different Store.

Open the API Credential whose Name, and Allow Write Order Status match the task. If it is missing, clear the list filters and recheck Store, Is Active, and Allow Write Order Status rather than creating a replacement immediately.

Fields and business rules

Brisk stores 15 user-relevant fields for this API Credential, including 1 linked-record selection and 0 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this API credential.
Name Yes Human-readable name for this API credential.
Is Active No Whether this API credential is active.
Allow Read Products No Whether this API credential allows read products.
Allow Read Pages No Whether this API credential allows read pages.
Allow Read Store No Whether this API credential allows read store.
Allow Read Orders No Whether this API credential allows read orders.
Allow Write Tracking No Whether this API credential allows write tracking.
Allow Write Order Status No Whether this API credential allows write order status.
Allow Quote Shipping No Whether this API credential allows quote shipping.
Expires At No Date and time recorded for expires at on this API credential.
Allowed Ip Cidrs No Optional newline/comma-separated list of allowed IP or CIDR ranges.
Last Used At No Date and time recorded for last used at on this API credential.
Last Used Ip No The last used IP recorded for this API credential.
Last Rotated At No Date and time recorded for last rotated at on this API credential.

What happens next

Give the generated secret only to the named client, test each granted capability, and disable the credential promptly if its source network or owner changes.

Common mistakes and troubleshooting

Core Records

Blog Posts

Blog Posts

Purpose and when to use this record

Prepare and publish store-specific editorial content with its URL slug, imagery, scheduling, tags, and search metadata.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on blog posts. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Blog Post belongs and which later screens can find it.

Create a Blog Post

Brisk Blog Posts create screen displayed with fictional documentation-demo data.
The Blog Posts create screen in the Brisk documentation demo.

Create a Blog Post only after confirming that the source document or operational event has not already been entered.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, Title, and Body.

  3. Review Is Published, and Is Featured deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Blog Post, then confirm Author Name on its detail page before continuing.

After saving: Use Store to interpret this Blog Post. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Delete a Blog Post

Delete this Blog Post only when it was entered by mistake and no downstream history depends on it. Use a reversal, void, credit, counter-adjustment, or status correction for a real event that later changed.

If the record is merely obsolete, use Is Published to remove it from future use while preserving existing references.

On the confirmation page, verify Author Name. After confirmation, return to the Blog Posts list and make sure only the intended Blog Post was removed.

Review Blog Post details

Use the detail page as the shared record of what this Blog Post currently means. Verify Store, Title, Slug, and Excerpt before relying on it for a decision.

Follow Store to determine whether the issue is on this Blog Post or on one of those linked records.

Next check: Use Store to interpret this Blog Post. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Edit an existing Blog Post

Edit this Blog Post to correct or complete the same source document or operational event; use the supported reversal or follow-up workflow when the business event itself changed.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Is Published, and Published At. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Blog Post now appears under the expected Is Published, and Published At.

After the change: Use Store to interpret this Blog Post. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Find and review blog posts

Brisk Blog Posts list screen displayed with fictional documentation-demo data.
The Blog Posts list screen in the Brisk documentation demo.

Use the Blog Posts list to find the correct record before opening or changing it. Compare Author Name. Records with similar names or numbers can still belong to different Store.

Open the Blog Post whose Author Name match the task. If it is missing, clear the list filters and recheck Store, Published At, and Is Published rather than creating a replacement immediately.

Fields and business rules

Brisk stores 13 user-relevant fields for this Blog Post, including 1 linked-record selection and 0 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this blog post.
Title Yes The title recorded for this blog post.
Slug No URL-safe identifier for this blog post.
Excerpt No The excerpt recorded for this blog post.
Body Yes The body recorded for this blog post.
Featured Image No File stored as featured image for this blog post.
Is Published No Whether this blog post is published.
Is Featured No Whether this blog post is featured.
Published At No Date and time recorded for published at on this blog post.
Author Name No The author name recorded for this blog post.
Seo Title No The SEO title recorded for this blog post.
Meta Description No The meta description recorded for this blog post.
Seo Keywords No Comma-separated focus keywords used for on-page SEO guidance and meta tags.

What happens next

Use Store to interpret this Blog Post. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Common mistakes and troubleshooting

Core Records

Campaign Deliveries

Campaign Deliveries

Purpose and when to use this record

Audit whether a marketing message was sent, skipped, or failed for a particular recipient and business event.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on campaign deliveries. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store, and Campaign records ready first. Those selections determine where this Campaign Delivery belongs and which later screens can find it.

Find and review campaign deliveries

Brisk Campaign Deliveries list screen displayed with fictional documentation-demo data.
The Campaign Deliveries list screen in the Brisk documentation demo.

Use the Campaign Deliveries list to find the correct record before opening or changing it. Compare Status. Records with similar names or numbers can still belong to different Store, Campaign, Customer Link, Mailing Subscriber, Order, and Abandoned Cart.

Open the Campaign Delivery whose Status match the task. If it is missing, clear the list filters and recheck Store, Campaign, Customer Link, Mailing Subscriber, Order, and Created At, plus the remaining screen fields rather than creating a replacement immediately.

Review Campaign Delivery details

Use the detail page as the shared record of what this Campaign Delivery currently means. Verify Status before relying on it for a decision.

Follow Store, Campaign, Customer Link, Mailing Subscriber, Order, and Abandoned Cart to determine whether the issue is on this Campaign Delivery or on one of those linked records.

Next check: Use Store, Campaign, Customer Link, Mailing Subscriber, Order, and Abandoned Cart to interpret this Campaign Delivery. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Fields and business rules

Brisk stores 12 user-relevant fields for this Campaign Delivery, including 6 linked-record selections and 1 controlled-choice field. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this campaign delivery.
Campaign Yes The campaign associated with this campaign delivery.
Customer Link No The customer link associated with this campaign delivery.
Mailing Subscriber No The mailing subscriber associated with this campaign delivery.
Order No The order associated with this campaign delivery.
Abandoned Cart No The abandoned cart associated with this campaign delivery.
Email Yes Email address recorded as email for this campaign delivery.
Status No Current status of this campaign delivery. Available values: Sent, Skipped, Failed.
Reason No The reason recorded for this campaign delivery.
Dedupe Key Yes The dedupe key recorded for this campaign delivery.
Sent At No Date and time recorded for sent at on this campaign delivery.
External Id No The external ID recorded for this campaign delivery.

What happens next

Use Store, Campaign, Customer Link, Mailing Subscriber, Order, and Abandoned Cart to interpret this Campaign Delivery. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Common mistakes and troubleshooting

Core Records

Collections

Collections

Purpose and when to use this record

Curate a published product grouping using explicit products or tags and control whether it appears in storefront navigation.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on collections. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Collection belongs and which later screens can find it.

Create a Collection

Brisk Collections create screen displayed with fictional documentation-demo data.
The Collections create screen in the Brisk documentation demo.

Create a Collection after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, and Name.

  3. Review Is Published, and Show In Navigation deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Collection, then confirm Name on its detail page before continuing.

After saving: Verify this Collection in the next transaction or assignment screen before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Delete a Collection

Delete this Collection only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Published to remove it from future use while preserving existing references.

On the confirmation page, verify Name. After confirmation, return to the Collections list and make sure only the intended Collection was removed.

Review Collection details

Use the detail page as the shared record of what this Collection currently means. Verify Store, Name, Slug, and Description before relying on it for a decision.

Follow Store to determine whether the issue is on this Collection or on one of those linked records.

Next check: Verify this Collection in the next transaction or assignment screen before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Edit an existing Collection

Edit this Collection to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Is Published. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Collection now appears under the expected Is Published.

After the change: Verify this Collection in the next transaction or assignment screen before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Find and review collections

Brisk Collections list screen displayed with fictional documentation-demo data.
The Collections list screen in the Brisk documentation demo.

Use the Collections list to find the correct record before opening or changing it. Compare Name. Records with similar names or numbers can still belong to different Store.

Open the Collection whose Name match the task. If it is missing, clear the list filters and recheck Store, and Is Published rather than creating a replacement immediately.

Fields and business rules

Brisk stores 8 user-relevant fields for this Collection, including 1 linked-record selection and 0 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this collection.
Name Yes Human-readable name for this collection.
Slug No URL-safe identifier for this collection.
Description No Description of this collection.
Featured Image No File stored as featured image for this collection.
Is Published No Whether this collection is published.
Show In Navigation No Whether the show in navigation option applies to this collection.
Sort Order No The sort order value recorded for this collection.

What happens next

Verify this Collection in the next transaction or assignment screen before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Common mistakes and troubleshooting

Core Records

Contact Submissions

Contact Submissions

Purpose and when to use this record

Review and respond to a storefront contact request while retaining its store, sender, subject, and original message.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on contact submissions. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Review Contact Submission details

Use the detail page as the shared record of what this Contact Submission currently means. Verify Store, Name, Email, and Phone before relying on it for a decision.

Follow Store to determine whether the issue is on this Contact Submission or on one of those linked records.

Next check: Use Store to interpret this Contact Submission. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Find and review contact submissions

Brisk Contact Submissions list screen displayed with fictional documentation-demo data.
The Contact Submissions list screen in the Brisk documentation demo.

Use the Contact Submissions list to find the correct record before opening or changing it. Compare Name, and Order Number. Records with similar names or numbers can still belong to different Store.

Open the Contact Submission whose Name, and Order Number match the task. If it is missing, clear the list filters and recheck Store, and Created At rather than creating a replacement immediately.

Fields and business rules

Brisk stores 9 user-relevant fields for this Contact Submission, including 1 linked-record selection and 0 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store No The store associated with this contact submission.
Name Yes Human-readable name for this contact submission.
Email Yes Email address recorded as email for this contact submission.
Phone No The phone recorded for this contact submission.
Subject No The subject recorded for this contact submission.
Message Yes The message recorded for this contact submission.
Source Ip No The source IP recorded for this contact submission.
Order Number No The order number recorded for this contact submission.
Sent To No The sent to recorded for this contact submission.

What happens next

Use Store to interpret this Contact Submission. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Common mistakes and troubleshooting

Core Records

Customers

Customers

Purpose and when to use this record

Connect an online shopper identity to the corresponding Brisk customer used for orders and account history.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on customers. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store, and Customer records ready first. Those selections determine where this Customer belongs and which later screens can find it.

Create a Customer

Brisk Customers create screen displayed with fictional documentation-demo data.
The Customers create screen in the Brisk documentation demo.

Create a Customer only when the existing choices do not represent the policy or classification you need. Near-duplicate setup values split reporting and make later selection harder.

  1. Select the business context first: Store, and Customer.

  2. Enter the required identifying and operational values: Store, and Customer.

  3. Review Marketing Opt In, and Invite Status deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Customer, then confirm Invite Status on its detail page before continuing.

After saving: Open Abandoned Carts, Campaign Deliveries, Mailing Subscribers, and Orders and confirm the Customer appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Review Customer details

Use the detail page as the shared record of what this Customer currently means. Verify Invite Status before relying on it for a decision.

Follow Store, and Customer to determine whether the issue is on this Customer or on one of those linked records.

Next check: Open Abandoned Carts, Campaign Deliveries, Mailing Subscribers, and Orders and confirm the Customer appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Edit an existing Customer

Edit this Customer when the underlying policy or classification changed. First determine whether historical transactions should retain the old value; if so, deactivate the old choice and create a new one.

  1. Open the detail page. Compare Store, and Customer with the supporting document or approved request.

  2. Recheck Customer, and Invite Status. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Customer now appears under the expected Invite Status.

After the change: Open Abandoned Carts, Campaign Deliveries, Mailing Subscribers, and Orders and confirm the Customer appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Find and review customers

Brisk Customers list screen displayed with fictional documentation-demo data.
The Customers list screen in the Brisk documentation demo.

Use the Customers list to find the correct record before opening or changing it. Compare Invite Status. Records with similar names or numbers can still belong to different Store, and Customer.

Open the Customer whose Invite Status match the task. If it is missing, clear the list filters and recheck Store, Customer, and Invite Status rather than creating a replacement immediately.

Fields and business rules

Brisk stores 15 user-relevant fields for this Customer, including 2 linked-record selections and 1 controlled-choice field. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this customer link.
Auth User Id No The auth user ID value recorded for this customer link.
Customer Yes The customer associated with this customer link.
Marketing Opt In No Whether the marketing opt in option applies to this customer link.
Acquisition Source No The acquisition source recorded for this customer link.
Acquisition Campaign No The acquisition campaign recorded for this customer link.
Invite Status No The invite status recorded for this customer link. Available values: Not Invited, Invitation Sent, Invitation Accepted, Invitation Expired, Invitation Failed.
Invite Email No Email address recorded as invite email for this customer link.
Invite Token No The invite token recorded for this customer link.
Invite Token Expires At No Date and time recorded for invite token expires at on this customer link.
Invite Last Sent At No Date and time recorded for invite last sent at on this customer link.
Invite Accepted At No Date and time recorded for invite accepted at on this customer link.
Invite Send Count No The invite send count value recorded for this customer link.
Invite Last Error No The invite last error recorded for this customer link.
Notes No Additional internal notes about this customer link.

What happens next

Open Abandoned Carts, Campaign Deliveries, Mailing Subscribers, and Orders and confirm the Customer appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Common mistakes and troubleshooting

Core Records

Customer Segments

Customer Segments

Purpose and when to use this record

Define the reusable audience rules used to select customers for ecommerce marketing.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on customer segments. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Customer Segment belongs and which later screens can find it.

Create a Customer Segment

Brisk Customer Segments create screen displayed with fictional documentation-demo data.
The Customer Segments create screen in the Brisk documentation demo.

Create a Customer Segment after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, and Name.

  3. Review Is Active, and Match Type deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Customer Segment, then confirm Name on its detail page before continuing.

After saving: Verify this Customer Segment in Marketing Campaigns before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Delete a Customer Segment

Delete this Customer Segment only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Active to remove it from future use while preserving existing references.

Before confirming, check for related Marketing Campaigns. Brisk may refuse deletion when another record depends on this one; resolve the duplicate or use the supported correction workflow instead of breaking the trail.

On the confirmation page, verify Name. After confirmation, return to the Customer Segments list and make sure only the intended Customer Segment was removed.

Review Customer Segment details

Use the detail page as the shared record of what this Customer Segment currently means. Verify Is Active, and Match Type before relying on it for a decision.

Follow Store to determine whether the issue is on this Customer Segment or on one of those linked records.

Next check: Verify this Customer Segment in Marketing Campaigns before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Edit an existing Customer Segment

Edit this Customer Segment to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Is Active, and Match Type. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Customer Segment now appears under the expected Is Active, and Match Type.

After the change: Verify this Customer Segment in Marketing Campaigns before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Find and review customer segments

Brisk Customer Segments list screen displayed with fictional documentation-demo data.
The Customer Segments list screen in the Brisk documentation demo.

Use the Customer Segments list to find the correct record before opening or changing it. Compare Name. Records with similar names or numbers can still belong to different Store.

Open the Customer Segment whose Name match the task. If it is missing, clear the list filters and recheck Store, Is Active, and Match Type rather than creating a replacement immediately.

Fields and business rules

Brisk stores 9 user-relevant fields for this Customer Segment, including 1 linked-record selection and 1 controlled-choice field. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this customer segment.
Name Yes Human-readable name for this customer segment.
Slug No URL-safe identifier for this customer segment.
Description No Description of this customer segment.
Is Active No Whether this customer segment is active.
Match Type No The match type recorded for this customer segment. Available values: All Rules Must Match, Any Rule Can Match.
Rules No List of rules. Example: [{"field":"total_orders","op":"gte","value":2}].
Estimated Size No The estimated size value recorded for this customer segment.
Last Evaluated At No Date and time recorded for last evaluated at on this customer segment.

What happens next

Verify this Customer Segment in Marketing Campaigns before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Common mistakes and troubleshooting

Core Records

Discount Codes

Discount Codes

Purpose and when to use this record

Configure a storefront promotion’s code, eligibility, date window, usage limits, and discount calculation.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on discount codes. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Discount Code belongs and which later screens can find it.

Create a Discount Code

Brisk Discount Codes create screen displayed with fictional documentation-demo data.
The Discount Codes create screen in the Brisk documentation demo.

Create a Discount Code only when the existing choices do not represent the policy or classification you need. Near-duplicate setup values split reporting and make later selection harder.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, Name, and Code.

  3. Review Is Active, Auto Apply, and Discount Type deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Discount Code, then confirm Name, and Code on its detail page before continuing.

After saving: Open Abandoned Carts, and Discount Redemptions and confirm the Discount Code appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Delete a Discount Code

Delete this Discount Code only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Active to remove it from future use while preserving existing references.

Before confirming, check for related Abandoned Carts, and Discount Redemptions. Brisk may refuse deletion when another record depends on this one; resolve the duplicate or use the supported correction workflow instead of breaking the trail.

On the confirmation page, verify Name, and Code. After confirmation, return to the Discount Codes list and make sure only the intended Discount Code was removed.

Review Discount Code details

Use the detail page as the shared record of what this Discount Code currently means. Verify Is Active, Discount Type, Amount, and Minimum Subtotal before relying on it for a decision.

Follow Store to determine whether the issue is on this Discount Code or on one of those linked records.

Next check: Open Abandoned Carts, and Discount Redemptions and confirm the Discount Code appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Edit an existing Discount Code

Edit this Discount Code when the underlying policy or classification changed. First determine whether historical transactions should retain the old value; if so, deactivate the old choice and create a new one.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Is Active, Discount Type, Amount, Minimum Subtotal, Usage Limit Per Customer, and Customer Email Allowlist. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Discount Code now appears under the expected Is Active, and Discount Type.

After the change: Open Abandoned Carts, and Discount Redemptions and confirm the Discount Code appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Find and review discount codes

Brisk Discount Codes list screen displayed with fictional documentation-demo data.
The Discount Codes list screen in the Brisk documentation demo.

Use the Discount Codes list to find the correct record before opening or changing it. Compare Name, and Code. Records with similar names or numbers can still belong to different Store.

Open the Discount Code whose Name, and Code match the task. If it is missing, clear the list filters and recheck Store, Is Active, and Discount Type rather than creating a replacement immediately.

Fields and business rules

Brisk stores 17 user-relevant fields for this Discount Code, including 1 linked-record selection and 1 controlled-choice field. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this discount code.
Name Yes Human-readable name for this discount code.
Code Yes Short code used to identify this discount code.
Description No Description of this discount code.
Is Active No Whether this discount code is active.
Auto Apply No Automatically applies when eligible and no other code is set.
Priority No The priority value recorded for this discount code.
Discount Type No The discount type recorded for this discount code. Available values: Percentage Off, Fixed Amount Off, Free Shipping.
Amount No The amount value recorded for this discount code.
Minimum Subtotal No The minimum subtotal value recorded for this discount code.
Maximum Discount No The maximum discount value recorded for this discount code.
Starts At No Date and time recorded for starts at on this discount code.
Ends At No Date and time recorded for ends at on this discount code.
Usage Limit No The usage limit value recorded for this discount code.
Usage Limit Per Customer No The usage limit per customer value recorded for this discount code.
Customer Email Allowlist No Optional newline/comma-separated emails allowed to use this code.
Times Redeemed No The times redeemed value recorded for this discount code.

What happens next

Open Abandoned Carts, and Discount Redemptions and confirm the Discount Code appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Common mistakes and troubleshooting

Core Records

Discount Redemptions

Discount Redemptions

Purpose and when to use this record

Audit a customer or order’s use of a discount code and the value it removed from the order.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on discount redemptions. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store, Discount Code, and Order records ready first. Those selections determine where this Discount Redemption belongs and which later screens can find it.

Review Discount Redemption details

Use the detail page as the shared record of what this Discount Redemption currently means. Verify Discount Amount before relying on it for a decision.

Follow Store, Discount Code, and Order to determine whether the issue is on this Discount Redemption or on one of those linked records.

Next check: Use Store, Discount Code, and Order to interpret this Discount Redemption. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Find and review discount redemptions

Brisk Discount Redemptions list screen displayed with fictional documentation-demo data.
The Discount Redemptions list screen in the Brisk documentation demo.

Use the Discount Redemptions list to find the correct record before opening or changing it. Compare Discount Code. Records with similar names or numbers can still belong to different Store, Discount Code, and Order.

Open the Discount Redemption whose Discount Code match the task. If it is missing, clear the list filters and recheck Store, Discount Code, Order, and Created At rather than creating a replacement immediately.

Fields and business rules

Brisk stores 5 user-relevant fields for this Discount Redemption, including 3 linked-record selections and 0 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this discount redemption.
Discount Code Yes The discount code associated with this discount redemption.
Order Yes The order associated with this discount redemption.
Customer Email No Email address recorded as customer email for this discount redemption.
Discount Amount No The discount amount value recorded for this discount redemption.

What happens next

Use Store, Discount Code, and Order to interpret this Discount Redemption. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Common mistakes and troubleshooting

Core Records

Mailing Subscribers

Mailing Subscribers

Purpose and when to use this record

Maintain an email address’s subscription and consent state for a specific storefront mailing list.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on mailing subscribers. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Mailing List records ready first. Those selections determine where this Mailing Subscriber belongs and which later screens can find it.

Create a Mailing Subscriber

Brisk Mailing Subscribers create screen displayed with fictional documentation-demo data.
The Mailing Subscribers create screen in the Brisk documentation demo.

Create a Mailing Subscriber after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Mailing List, and Customer Link.

  2. Enter the required identifying and operational values: Mailing List, and Email.

  3. Review Status deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Mailing Subscriber, then confirm First Name, Last Name, and Status on its detail page before continuing.

After saving: Verify this Mailing Subscriber in Campaign Deliveries before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Delete a Mailing Subscriber

Delete this Mailing Subscriber only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

Before confirming, check for related Campaign Deliveries. Brisk may refuse deletion when another record depends on this one; resolve the duplicate or use the supported correction workflow instead of breaking the trail.

On the confirmation page, verify First Name, Last Name, and Status. After confirmation, return to the Mailing Subscribers list and make sure only the intended Mailing Subscriber was removed.

Review Mailing Subscriber details

Use the detail page as the shared record of what this Mailing Subscriber currently means. Verify Status before relying on it for a decision.

Follow Mailing List, and Customer Link to determine whether the issue is on this Mailing Subscriber or on one of those linked records.

Next check: Verify this Mailing Subscriber in Campaign Deliveries before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Edit an existing Mailing Subscriber

Edit this Mailing Subscriber to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Mailing List, and Customer Link with the supporting document or approved request.

  2. Recheck Customer Link, and Status. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Mailing Subscriber now appears under the expected Status.

After the change: Verify this Mailing Subscriber in Campaign Deliveries before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Find and review mailing subscribers

Brisk Mailing Subscribers list screen displayed with fictional documentation-demo data.
The Mailing Subscribers list screen in the Brisk documentation demo.

Use the Mailing Subscribers list to find the correct record before opening or changing it. Compare First Name, Last Name, and Status. Records with similar names or numbers can still belong to different Mailing List, and Customer Link.

Open the Mailing Subscriber whose First Name, Last Name, and Status match the task. If it is missing, clear the list filters and recheck Mailing List, Customer Link, Subscribed At, and Status rather than creating a replacement immediately.

Fields and business rules

Brisk stores 10 user-relevant fields for this Mailing Subscriber, including 2 linked-record selections and 1 controlled-choice field. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Mailing List Yes The mailing list associated with this mailing list subscriber.
Customer Link No The customer link associated with this mailing list subscriber.
Email Yes Email address recorded as email for this mailing list subscriber.
First Name No The first name recorded for this mailing list subscriber.
Last Name No The last name recorded for this mailing list subscriber.
Status No Current status of this mailing list subscriber. Available values: Subscribed, Pending Confirmation, Unsubscribed, Bounced.
Source No The source recorded for this mailing list subscriber.
Subscribed At No Date and time recorded for subscribed at on this mailing list subscriber.
Unsubscribed At No Date and time recorded for unsubscribed at on this mailing list subscriber.
Last Engaged At No Date and time recorded for last engaged at on this mailing list subscriber.

What happens next

Verify this Mailing Subscriber in Campaign Deliveries before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Common mistakes and troubleshooting

Core Records

Mailing Lists

Mailing Lists

Purpose and when to use this record

Maintain a store’s opt-in audience list and the subscribers eligible for campaign delivery.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on mailing lists. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Mailing List belongs and which later screens can find it.

Create a Mailing List

Brisk Mailing Lists create screen displayed with fictional documentation-demo data.
The Mailing Lists create screen in the Brisk documentation demo.

Create a Mailing List after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, and Name.

  3. Review Is Active, Is Default, and Require Double Opt In deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Mailing List, then confirm Name on its detail page before continuing.

After saving: Verify this Mailing List in Mailing Subscribers before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Delete a Mailing List

Delete this Mailing List only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Active to remove it from future use while preserving existing references.

Before confirming, check for related Mailing Subscribers. Brisk may refuse deletion when another record depends on this one; resolve the duplicate or use the supported correction workflow instead of breaking the trail.

On the confirmation page, verify Name. After confirmation, return to the Mailing Lists list and make sure only the intended Mailing List was removed.

Review Mailing List details

Use the detail page as the shared record of what this Mailing List currently means. Verify Is Active before relying on it for a decision.

Follow Store to determine whether the issue is on this Mailing List or on one of those linked records.

Next check: Verify this Mailing List in Mailing Subscribers before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Edit an existing Mailing List

Edit this Mailing List to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Is Active. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Mailing List now appears under the expected Is Active.

After the change: Verify this Mailing List in Mailing Subscribers before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Find and review mailing lists

Brisk Mailing Lists list screen displayed with fictional documentation-demo data.
The Mailing Lists list screen in the Brisk documentation demo.

Use the Mailing Lists list to find the correct record before opening or changing it. Compare Name. Records with similar names or numbers can still belong to different Store.

Open the Mailing List whose Name match the task. If it is missing, clear the list filters and recheck Store, and Is Active rather than creating a replacement immediately.

Fields and business rules

Brisk stores 7 user-relevant fields for this Mailing List, including 1 linked-record selection and 0 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this mailing list.
Name Yes Human-readable name for this mailing list.
Slug No URL-safe identifier for this mailing list.
Description No Description of this mailing list.
Is Active No Whether this mailing list is active.
Is Default No Whether this mailing list is default.
Require Double Opt In No Whether the require double opt in option applies to this mailing list.

What happens next

Verify this Mailing List in Mailing Subscribers before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Common mistakes and troubleshooting

Core Records

Marketing Campaigns

Marketing Campaigns

Purpose and when to use this record

Draft, schedule, target, and monitor a store marketing message without losing its delivery history.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on marketing campaigns. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Marketing Campaign belongs and which later screens can find it.

Create a Marketing Campaign

Brisk Marketing Campaigns create screen displayed with fictional documentation-demo data.
The Marketing Campaigns create screen in the Brisk documentation demo.

Create a Marketing Campaign after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Store, and Segment.

  2. Enter the required identifying and operational values: Store, Name, and Subject.

  3. Review Is Active, Trigger Type, and Channel deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Marketing Campaign, then confirm Name, and From Name on its detail page before continuing.

After saving: Review delivery results by Sent, Skipped, and Failed, and correct audience or consent problems before sending another campaign.

Delete a Marketing Campaign

Delete this Marketing Campaign only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Active to remove it from future use while preserving existing references.

Before confirming, check for related Campaign Deliveries. Brisk may refuse deletion when another record depends on this one; resolve the duplicate or use the supported correction workflow instead of breaking the trail.

On the confirmation page, verify Name, and From Name. After confirmation, return to the Marketing Campaigns list and make sure only the intended Marketing Campaign was removed.

Review Marketing Campaign details

Use the detail page as the shared record of what this Marketing Campaign currently means. Verify Is Active, Trigger Type, Channel, Win Back Inactive Days, and Total Sent before relying on it for a decision.

Follow Store, and Segment to determine whether the issue is on this Marketing Campaign or on one of those linked records.

Next check: Review delivery results by Sent, Skipped, and Failed, and correct audience or consent problems before sending another campaign.

Edit an existing Marketing Campaign

Edit this Marketing Campaign to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Store, and Segment with the supporting document or approved request.

  2. Recheck Is Active, Trigger Type, Channel, Max Sends Per Customer, Win Back Inactive Days, and Total Sent. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Marketing Campaign now appears under the expected Is Active, Trigger Type, Channel, and Win Back Inactive Days.

After the change: Review delivery results by Sent, Skipped, and Failed, and correct audience or consent problems before sending another campaign.

Find and review marketing campaigns

Brisk Marketing Campaigns list screen displayed with fictional documentation-demo data.
The Marketing Campaigns list screen in the Brisk documentation demo.

Use the Marketing Campaigns list to find the correct record before opening or changing it. Compare Name, and From Name. Records with similar names or numbers can still belong to different Store, and Segment.

Open the Marketing Campaign whose Name, and From Name match the task. If it is missing, clear the list filters and recheck Store, Segment, Is Active, Trigger Type, Channel, and Win Back Inactive Days rather than creating a replacement immediately.

Fields and business rules

Brisk stores 23 user-relevant fields for this Marketing Campaign, including 2 linked-record selections and 2 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this marketing campaign.
Segment No The segment associated with this marketing campaign.
Name Yes Human-readable name for this marketing campaign.
Slug No URL-safe identifier for this marketing campaign.
Description No Description of this marketing campaign.
Is Active No Whether this marketing campaign is active.
Trigger Type No The trigger type recorded for this marketing campaign. Available values: Welcome Series, Post Purchase, Win-Back.
Channel No The channel recorded for this marketing campaign. Available values: Email.
Subject Yes The subject recorded for this marketing campaign.
Preview Text No The preview text recorded for this marketing campaign.
Body Html No The body HTML recorded for this marketing campaign.
Body Text No The body text recorded for this marketing campaign.
From Name No The from name recorded for this marketing campaign.
Reply To No Email address recorded as reply to for this marketing campaign.
Send Delay Minutes No The send delay minutes value recorded for this marketing campaign.
Cooldown Days No The cooldown days value recorded for this marketing campaign.
Max Sends Per Customer No The max sends per customer value recorded for this marketing campaign.
Win Back Inactive Days No The win back inactive days value recorded for this marketing campaign.
Utm Source No The utm source recorded for this marketing campaign.
Utm Campaign No The utm campaign recorded for this marketing campaign.
Last Run At No Date and time recorded for last run at on this marketing campaign.
Last Sent At No Date and time recorded for last sent at on this marketing campaign.
Total Sent No The total sent value recorded for this marketing campaign.

What happens next

Review delivery results by Sent, Skipped, and Failed, and correct audience or consent problems before sending another campaign.

Common mistakes and troubleshooting

Core Records

Orders

Orders

Purpose and when to use this record

Brisk Orders overview screen displayed with fictional documentation-demo data.
The Orders overview screen in the Brisk documentation demo.

Review an online order from checkout through payment and fulfillment while preserving its customer, totals, address, and tracking state.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on orders. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store, and Sale records ready first. Those selections determine where this Order belongs and which later screens can find it.

Find and review orders

Brisk Orders list screen displayed with fictional documentation-demo data.
The Orders list screen in the Brisk documentation demo.

Use the Orders list to find the correct record before opening or changing it. Compare Order Number, Status, Tracking Number, Shipping Name, and Shipping Postal Code. Records with similar names or numbers can still belong to different Store, Sale, Customer Link, Fulfillment Method, Ship From Warehouse, and Pickup Warehouse, plus the remaining screen fields.

Open the Order whose Order Number, Status, Tracking Number, Shipping Name, and Shipping Postal Code match the task. If it is missing, clear the list filters and recheck Store, Sale, Customer Link, Placed At, Status, and Fulfillment Type, plus the remaining screen fields rather than creating a replacement immediately.

Create an Order

Brisk Orders create screen displayed with fictional documentation-demo data.
The Orders create screen in the Brisk documentation demo.

Create an Order only after confirming that the source document or operational event has not already been entered.

  1. Select the business context first: Store, Sale, Customer Link, Fulfillment Method, Ship From Warehouse, and Pickup Warehouse, plus the remaining screen fields.

  2. Enter the required identifying and operational values: Store, Sale, and Order Number.

  3. Review Status, Fulfillment Type, and Carrier deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Order, then confirm Order Number, Status, Tracking Number, Shipping Name, and Shipping Postal Code on its detail page before continuing.

After saving: Move paid orders into the appropriate fulfillment method, record shipment or pickup progress, and investigate failed payment events before releasing goods.

Review Order details

Use the detail page as the shared record of what this Order currently means. Verify Status, Fulfillment Type, Carrier, and Paid At before relying on it for a decision.

Follow Store, Sale, Customer Link, Fulfillment Method, Ship From Warehouse, and Pickup Warehouse, plus the remaining screen fields to determine whether the issue is on this Order or on one of those linked records.

Next check: Move paid orders into the appropriate fulfillment method, record shipment or pickup progress, and investigate failed payment events before releasing goods.

Edit an existing Order

Edit this Order to correct or complete the same source document or operational event; use the supported reversal or follow-up workflow when the business event itself changed.

  1. Open the detail page. Compare Store, Sale, Customer Link, Fulfillment Method, Ship From Warehouse, and Pickup Warehouse, plus the remaining screen fields with the supporting document or approved request.

  2. Recheck Customer Link, Status, Fulfillment Type, Ship From Warehouse, Pickup Warehouse, and Drop Ship Vendor, plus the remaining screen fields. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Order now appears under the expected Status, Fulfillment Type, Carrier, and Paid At.

After the change: Move paid orders into the appropriate fulfillment method, record shipment or pickup progress, and investigate failed payment events before releasing goods.

Fields and business rules

Brisk stores 26 user-relevant fields for this Order, including 7 linked-record selections and 3 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this order.
Sale Yes The sale associated with this order.
Customer Link No The customer link associated with this order.
Order Number Yes The order number recorded for this order.
Status No Current status of this order. Available values: Submitted, Awaiting Payment, Awaiting Fulfillment, Fulfilled, Complete, Cancelled.
Fulfillment Type No The fulfillment type recorded for this order. Available values: Direct Shipping, In-Store Pickup, Drop Shipping, Freight Delivery.
Fulfillment Method No The fulfillment method associated with this order.
Ship From Warehouse No The ship from warehouse associated with this order.
Pickup Warehouse No The pickup warehouse associated with this order.
Drop Ship Vendor No The drop ship vendor associated with this order.
Carrier No The carrier recorded for this order. Available values: Not Assigned, USPS, UPS, FedEx, Freight Carrier, Other.
Carrier Service No The carrier service recorded for this order.
Tracking Number No The tracking number recorded for this order.
Customer Email No Email address recorded as customer email for this order.
Customer Phone No The customer phone recorded for this order.
Shipping Name No The shipping name recorded for this order.
Shipping Address1 No The shipping address1 recorded for this order.
Shipping Address2 No The shipping address2 recorded for this order.
Shipping City No The shipping city recorded for this order.
Shipping State No The shipping state recorded for this order.
Shipping Postal Code No The shipping postal code recorded for this order.
Shipping Country No The shipping country recorded for this order.
Special Instructions No The special instructions recorded for this order.
Source Ip No The source IP recorded for this order.
Placed At No Date and time recorded for placed at on this order.
Paid At No Date and time recorded for paid at on this order.

What happens next

Move paid orders into the appropriate fulfillment method, record shipment or pickup progress, and investigate failed payment events before releasing goods.

Common mistakes and troubleshooting

Core Records

Pages

Pages

Purpose and when to use this record

Build and publish a storefront information page with stable URL, navigation placement, content, and search metadata.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on pages. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Page belongs and which later screens can find it.

Create a Page

Brisk Pages create screen displayed with fictional documentation-demo data.
The Pages create screen in the Brisk documentation demo.

Create a Page after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, and Title.

  3. Review Template, Is Published, and Show In Navigation deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Page, then confirm Hero Cta Label on its detail page before continuing.

After saving: Verify this Page in the next transaction or assignment screen before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Delete a Page

Delete this Page only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Published to remove it from future use while preserving existing references.

On the confirmation page, verify Hero Cta Label. After confirmation, return to the Pages list and make sure only the intended Page was removed.

Review Page details

Use the detail page as the shared record of what this Page currently means. Verify Template before relying on it for a decision.

Follow Store to determine whether the issue is on this Page or on one of those linked records.

Next check: Verify this Page in the next transaction or assignment screen before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Edit an existing Page

Edit this Page to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Template, and Is Published. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Page now appears under the expected Template, and Is Published.

After the change: Verify this Page in the next transaction or assignment screen before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Find and review pages

Brisk Pages list screen displayed with fictional documentation-demo data.
The Pages list screen in the Brisk documentation demo.

Use the Pages list to find the correct record before opening or changing it. Compare Store, Title, Slug, and Summary. Records with similar names or numbers can still belong to different Store.

Open the Page whose Store, Title, Slug, and Summary match the task. If it is missing, clear the list filters and recheck Store, Template, and Is Published rather than creating a replacement immediately.

Fields and business rules

Brisk stores 18 user-relevant fields for this Page, including 1 linked-record selection and 1 controlled-choice field. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this page.
Title Yes The title recorded for this page.
Slug No URL-safe identifier for this page.
Summary No The summary recorded for this page.
Nav Title No The nav title recorded for this page.
Template No The template recorded for this page. Available values: Default, Landing, FAQ, About.
Hero Title No The hero title recorded for this page.
Hero Subtitle No The hero subtitle recorded for this page.
Hero Cta Label No The hero cta label recorded for this page.
Hero Cta Url No The hero cta URL recorded for this page.
Content Blocks No Structured content blocks data stored for this page.
Seo Title No The SEO title recorded for this page.
Meta Description No The meta description recorded for this page.
Seo Keywords No Comma-separated focus keywords used for on-page SEO guidance and meta tags.
Body No The body recorded for this page.
Is Published No Whether this page is published.
Show In Navigation No Whether the show in navigation option applies to this page.
Sort Order No The sort order value recorded for this page.

What happens next

Verify this Page in the next transaction or assignment screen before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Common mistakes and troubleshooting

Core Records

Payment Events

Payment Events

Purpose and when to use this record

Audit payment-provider events associated with an ecommerce order, including processing status and failure detail.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on payment events. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Review Payment Event details

Use the detail page as the shared record of what this Payment Event currently means. Verify Status before relying on it for a decision.

Follow Store, and Order to determine whether the issue is on this Payment Event or on one of those linked records.

Next check: Use Store, and Order to interpret this Payment Event. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Find and review payment events

Brisk Payment Events list screen displayed with fictional documentation-demo data.
The Payment Events list screen in the Brisk documentation demo.

Use the Payment Events list to find the correct record before opening or changing it. Compare Status. Records with similar names or numbers can still belong to different Store, and Order.

Open the Payment Event whose Status match the task. If it is missing, clear the list filters and recheck Store, Order, and Status rather than creating a replacement immediately.

Fields and business rules

Brisk stores 8 user-relevant fields for this Payment Event, including 2 linked-record selections and 1 controlled-choice field. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store No The store associated with this payment event.
Order No The order associated with this payment event.
Provider No The provider recorded for this payment event.
Event Type No The event type recorded for this payment event.
External Id No The external ID recorded for this payment event.
Status No Current status of this payment event. Available values: Received, Processed, Ignored, Error.
Message No The message recorded for this payment event.
Payload No Structured payload data stored for this payment event.

What happens next

Use Store, and Order to interpret this Payment Event. If it records a failure or exception, correct the source process and create a new successful event rather than rewriting the audit trail.

Common mistakes and troubleshooting

Core Records

Products

Products

Purpose and when to use this record

Control how a Brisk inventory item is described, priced, categorized, imaged, and made available in a storefront.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on products. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store, and Item records ready first. Those selections determine where this Product belongs and which later screens can find it.

Create a Product

Brisk Products create screen displayed with fictional documentation-demo data.
The Products create screen in the Brisk documentation demo.

Create a Product after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Store, Item, and Default Fulfillment Warehouse.

  2. Enter the required identifying and operational values: Store, and Item.

  3. Review Is Published, Featured, Allow Backorder, Allow Shipping, Allow Pickup, and Allow Drop Ship deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Product, then confirm Created by, Last modified by, Custom fields, Deleted at, Store, and Item, plus the remaining screen fields on its detail page before continuing.

After saving: Preview the storefront listing and confirm price, availability, imagery, collections, and publication state before promoting it.

Delete a Product

Delete this Product only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Published to remove it from future use while preserving existing references.

Before confirming, check for related Collections, and Product Images. Brisk may refuse deletion when another record depends on this one; resolve the duplicate or use the supported correction workflow instead of breaking the trail.

On the confirmation page, verify Store, Item, Slug, and Short Description. After confirmation, return to the Products list and make sure only the intended Product was removed.

Review Product details

Use the detail page as the shared record of what this Product currently means. Verify Store, Item, Slug, and Short Description before relying on it for a decision.

Follow Store, Item, and Default Fulfillment Warehouse to determine whether the issue is on this Product or on one of those linked records.

Next check: Preview the storefront listing and confirm price, availability, imagery, collections, and publication state before promoting it.

Edit an existing Product

Edit this Product to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Store, Item, and Default Fulfillment Warehouse with the supporting document or approved request.

  2. Recheck Is Published, Sale Price, Compare At Price, Default Fulfillment Warehouse, Min Order Quantity, and Max Order Quantity. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Product now appears under the expected Is Published.

After the change: Preview the storefront listing and confirm price, availability, imagery, collections, and publication state before promoting it.

Find and review products

Brisk Products list screen displayed with fictional documentation-demo data.
The Products list screen in the Brisk documentation demo.

Use the Products list to find the correct record before opening or changing it. Compare Store, Item, Slug, and Short Description. Records with similar names or numbers can still belong to different Store, Item, and Default Fulfillment Warehouse.

Open the Product whose Store, Item, Slug, and Short Description match the task. If it is missing, clear the list filters and recheck Store, Item, and Is Published rather than creating a replacement immediately.

Fields and business rules

Brisk stores 20 user-relevant fields for this Product, including 3 linked-record selections and 0 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this product listing.
Item Yes The item associated with this product listing.
Slug No URL-safe identifier for this product listing.
Short Description No The short description recorded for this product listing.
Description No Description of this product listing.
Seo Title No The SEO title recorded for this product listing.
Meta Description No The meta description recorded for this product listing.
Seo Keywords No Comma-separated focus keywords used for storefront SEO guidance and search metadata.
Featured Image No File stored as featured image for this product listing.
Is Published No Whether this product listing is published.
Featured No Whether the featured option applies to this product listing.
Sale Price No The sale price value recorded for this product listing.
Compare At Price No The compare at price value recorded for this product listing.
Allow Backorder No Whether this product listing allows backorder.
Allow Shipping No Whether this product listing allows shipping.
Allow Pickup No Whether this product listing allows pickup.
Allow Drop Ship No Whether this product listing allows drop ship.
Default Fulfillment Warehouse No The default fulfillment warehouse associated with this product listing.
Min Order Quantity No The min order quantity value recorded for this product listing.
Max Order Quantity No The max order quantity value recorded for this product listing.

What happens next

Preview the storefront listing and confirm price, availability, imagery, collections, and publication state before promoting it.

Common mistakes and troubleshooting

Core Records

Stores

Stores

Purpose and when to use this record

Configure a storefront’s identity, domain, fulfillment behavior, customer-facing contact information, and publication state.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on stores. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Create a Store

Brisk Stores create screen displayed with fictional documentation-demo data.
The Stores create screen in the Brisk documentation demo.

Create a Store after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Default Customer Class, Default Tax Code, Default Payment Terms, Default Receivable Account, and Default Fulfillment Method.

  2. Enter the required identifying and operational values: Name.

  3. Review Is Active, Allow Guest Checkout, Homepage Mode, Checkout Payment Provider, Checkout Payment Mode, and Enable Payment Provider Nmi, plus the remaining screen fields deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Store, then confirm Name, and Default Tax Code on its detail page before continuing.

After saving: Verify this Store in Abandoned Carts, Api Credentials, Blog Posts, and Campaign Deliveries, plus the remaining screen fields before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Delete a Store

Delete this Store only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Active to remove it from future use while preserving existing references.

Before confirming, check for related Api Credentials, Abandoned Carts, Blog Posts, Campaign Deliveries, and Collections, plus the remaining screen fields. Brisk may refuse deletion when another record depends on this one; resolve the duplicate or use the supported correction workflow instead of breaking the trail.

On the confirmation page, verify Name, and Default Tax Code. After confirmation, return to the Stores list and make sure only the intended Store was removed.

Review Store details

Use the detail page as the shared record of what this Store currently means. Verify Is Active, Homepage Mode, Checkout Payment Provider, Checkout Payment Mode, and Paypal Environment before relying on it for a decision.

Follow Default Customer Class, Default Tax Code, Default Payment Terms, Default Receivable Account, and Default Fulfillment Method to determine whether the issue is on this Store or on one of those linked records.

Next check: Verify this Store in Abandoned Carts, Api Credentials, Blog Posts, and Campaign Deliveries, plus the remaining screen fields before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Edit an existing Store

Edit this Store to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Default Customer Class, Default Tax Code, Default Payment Terms, Default Receivable Account, and Default Fulfillment Method with the supporting document or approved request.

  2. Recheck Is Active, Homepage Mode, Checkout Payment Provider, Checkout Payment Mode, Paypal Environment, and Default Customer Class, plus the remaining screen fields. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Store now appears under the expected Is Active, Homepage Mode, Checkout Payment Provider, Checkout Payment Mode, and Paypal Environment.

After the change: Verify this Store in Abandoned Carts, Api Credentials, Blog Posts, and Campaign Deliveries, plus the remaining screen fields before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Find and review stores

Brisk Stores list screen displayed with fictional documentation-demo data.
The Stores list screen in the Brisk documentation demo.

Use the Stores list to find the correct record before opening or changing it. Compare Name, and Default Tax Code. Records with similar names or numbers can still belong to different Default Customer Class, Default Tax Code, Default Payment Terms, Default Receivable Account, and Default Fulfillment Method.

Open the Store whose Name, and Default Tax Code match the task. If it is missing, clear the list filters and recheck Is Active, Homepage Mode, Checkout Payment Provider, Checkout Payment Mode, and Paypal Environment rather than creating a replacement immediately.

Fields and business rules

Brisk stores 23 user-relevant fields for this Store, including 5 linked-record selections and 4 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Name Yes Human-readable name for this store.
Slug No URL-safe identifier for this store.
Primary Domain No Public domain where customers access this storefront.
Support Email No Email address recorded as support email for this store.
Order Prefix No The order prefix recorded for this store.
Is Active No Whether this store is active.
Allow Guest Checkout No Whether this store allows guest checkout.
Homepage Mode No Controls whether the homepage highlights products, blog posts, or both. Available values: Products, Blog, Mixed.
Checkout Payment Provider No Payment provider used at checkout for this storefront. Available values: NMI, eBizCharge, PayPal, Manual/Offline.
Checkout Payment Mode No Use one checkout provider or allow customers to choose between multiple providers. Available values: Single Provider, Multiple Options.
Enable Payment Provider Nmi No Whether payment provider NMI is enabled for this store.
Enable Payment Provider Ebizcharge No Whether payment provider ebizcharge is enabled for this store.
Enable Payment Provider Paypal No Whether payment provider paypal is enabled for this store.
Enable Payment Provider Manual No Whether payment provider manual is enabled for this store.
Ebizcharge Webhook Secret No Optional shared secret expected from eBizCharge webhook requests.
Paypal Client Id No PayPal REST client ID for checkout redirects.
Paypal Client Secret No PayPal REST client secret for checkout redirects.
Paypal Environment No Choose sandbox for testing or live for production PayPal checkout. Available values: Sandbox, Live.
Default Customer Class No The default customer class associated with this store.
Default Tax Code No The default tax code associated with this store.
Default Payment Terms No The default payment terms associated with this store.
Default Receivable Account No The default receivable account associated with this store.
Default Fulfillment Method No The default fulfillment method associated with this store.

What happens next

Verify this Store in Abandoned Carts, Api Credentials, Blog Posts, and Campaign Deliveries, plus the remaining screen fields before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Common mistakes and troubleshooting

Core Records

Tags

Tags

Purpose and when to use this record

Maintain reusable storefront labels used to organize products, collections, posts, or campaigns.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on tags. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Tag belongs and which later screens can find it.

Create a Tag

Brisk Tags create screen displayed with fictional documentation-demo data.
The Tags create screen in the Brisk documentation demo.

Create a Tag after searching for the person, organization, item, location, or resource under alternate names and identifiers. Merge or correct an existing master record instead of creating a duplicate.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, and Name.

  3. Review Is Published deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Tag, then confirm Name on its detail page before continuing.

After saving: Verify this Tag in Blog Posts, Collections, and Products before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Delete a Tag

Delete this Tag only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Published to remove it from future use while preserving existing references.

Before confirming, check for related Blog Posts, Collections, and Products. Brisk may refuse deletion when another record depends on this one; resolve the duplicate or use the supported correction workflow instead of breaking the trail.

On the confirmation page, verify Name. After confirmation, return to the Tags list and make sure only the intended Tag was removed.

Review Tag details

Use the detail page as the shared record of what this Tag currently means. Verify Store, Name, Slug, and Description before relying on it for a decision.

Follow Store to determine whether the issue is on this Tag or on one of those linked records.

Next check: Verify this Tag in Blog Posts, Collections, and Products before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Edit an existing Tag

Edit this Tag to keep the same real-world party, item, location, or resource accurate. Do not repurpose it for a different entity after activity is attached.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Is Published. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Tag now appears under the expected Is Published.

After the change: Verify this Tag in Blog Posts, Collections, and Products before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Find and review tags

Brisk Tags list screen displayed with fictional documentation-demo data.
The Tags list screen in the Brisk documentation demo.

Use the Tags list to find the correct record before opening or changing it. Compare Name. Records with similar names or numbers can still belong to different Store.

Open the Tag whose Name match the task. If it is missing, clear the list filters and recheck Store, and Is Published rather than creating a replacement immediately.

Fields and business rules

Brisk stores 5 user-relevant fields for this Tag, including 1 linked-record selection and 0 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this tag.
Name Yes Human-readable name for this tag.
Slug No URL-safe identifier for this tag.
Description No Description of this tag.
Is Published No Whether this tag is published.

What happens next

Verify this Tag in Blog Posts, Collections, and Products before staff build new activity on it; correct ownership, classification, and active state now rather than after transactions accumulate.

Common mistakes and troubleshooting

Core Records

Themes

Themes

Purpose and when to use this record

Control a storefront’s visual theme, brand assets, colors, typography, and active presentation.

At a glance

Before you begin

You need the Brisk permission for the action you are taking on themes. If a Create, Edit, or Delete control is absent, do not work around it with another user’s account; ask an administrator to review your role.

Have valid Store records ready first. Those selections determine where this Theme belongs and which later screens can find it.

Create a Theme

Create a Theme only when the existing choices do not represent the policy or classification you need. Near-duplicate setup values split reporting and make later selection harder.

  1. Select the business context first: Store.

  2. Enter the required identifying and operational values: Store, and Name.

  3. Review Is Active, Preset, Theme Pack, Hero Layout, Product Card Style, and Script Type deliberately; these choices control availability or workflow rather than merely describing the record.

  4. Save the Theme, then confirm Name on its detail page before continuing.

After saving: Open the screen that uses this choice and confirm the Theme appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Delete a Theme

Delete this Theme only if it is an unused duplicate or setup mistake. Once other records refer to it, preserve that history and make the value inactive when the screen provides that option.

If the record is merely obsolete, use Is Active to remove it from future use while preserving existing references.

On the confirmation page, verify Name. After confirmation, return to the Themes list and make sure only the intended Theme was removed.

Review Theme details

Use the detail page as the shared record of what this Theme currently means. Verify Is Active, Preset, Theme Pack, Hero Layout, Product Card Style, and Script Type before relying on it for a decision.

Follow Store to determine whether the issue is on this Theme or on one of those linked records.

Next check: Open the screen that uses this choice and confirm the Theme appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Edit an existing Theme

Edit this Theme when the underlying policy or classification changed. First determine whether historical transactions should retain the old value; if so, deactivate the old choice and create a new one.

  1. Open the detail page. Compare Store with the supporting document or approved request.

  2. Recheck Is Active, Preset, Theme Pack, Hero Layout, Product Card Style, and Script Type. These values are most likely to change storefront visibility, customer communication, payment, or fulfillment.

  3. Save the change, return to the list, and confirm that the Theme now appears under the expected Is Active, Preset, Theme Pack, Hero Layout, Product Card Style, and Script Type.

After the change: Open the screen that uses this choice and confirm the Theme appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Find and review themes

Brisk Themes list screen displayed with fictional documentation-demo data.
The Themes list screen in the Brisk documentation demo.

Use the Themes list to find the correct record before opening or changing it. Compare Name. Records with similar names or numbers can still belong to different Store.

Open the Theme whose Name match the task. If it is missing, clear the list filters and recheck Store, Is Active, Preset, Theme Pack, Hero Layout, and Product Card Style, plus the remaining screen fields rather than creating a replacement immediately.

Fields and business rules

Brisk stores 39 user-relevant fields for this Theme, including 1 linked-record selection and 5 controlled-choice fields. Create and edit screens may hide calculated or workflow-managed values from this full reference.

Field Required What it controls
Store Yes The store associated with this theme.
Name Yes Human-readable name for this theme.
Is Active No Whether this theme is active.
Preset No The preset recorded for this theme. Available values: Atelier, Monochrome, Coastal, Forest, Paper.
Theme Pack No Select a full-layout Brisk storefront theme pack. Available values: Storefront Classic, Modern, Minimal.
Section Config No Section-level content configuration used by Brisk theme packs.
Primary Color No The primary color recorded for this theme.
Accent Color No The accent color recorded for this theme.
Background Color No The background color recorded for this theme.
Heading Font No The heading font recorded for this theme.
Body Font No The body font recorded for this theme.
Hero Title No The hero title recorded for this theme.
Hero Subtitle No The hero subtitle recorded for this theme.
Custom Css No The custom CSS recorded for this theme.
Announcement Text No The announcement text recorded for this theme.
Hero Layout No The hero layout recorded for this theme. Available values: Split, Centered, Minimal.
Product Card Style No The product card style recorded for this theme. Available values: Soft, Outline, Minimal.
Favicon Image No Optional site favicon image for this storefront theme.
Site Background Image No Optional full-width storefront background graphic shown across pages while users scroll.
Shared Head Html No The shared head HTML recorded for this theme.
Shared Header Html No The shared header HTML recorded for this theme.
Shared Footer Html No The shared footer HTML recorded for this theme.
Script Type No Choose ES module scripts for modern import/export support or classic scripts for legacy snippets. Available values: ES Module, Classic Script.
Javascript Assets No Optional script URLs, one per line. Prefix with "module:" to force ES module loading.
Shared Javascript No The shared javascript recorded for this theme.
Home Template Html No The home template HTML recorded for this theme.
Home Template Javascript No The home template javascript recorded for this theme.
Product Template Html No The product template HTML recorded for this theme.
Product Template Javascript No The product template javascript recorded for this theme.
Page Template Html No The page template HTML recorded for this theme.
Page Template Javascript No The page template javascript recorded for this theme.
Collection Template Html No The collection template HTML recorded for this theme.
Collection Template Javascript No The collection template javascript recorded for this theme.
Blog Index Template Html No The blog index template HTML recorded for this theme.
Blog Index Template Javascript No The blog index template javascript recorded for this theme.
Blog Post Template Html No The blog post template HTML recorded for this theme.
Blog Post Template Javascript No The blog post template javascript recorded for this theme.
Contact Template Html No The contact template HTML recorded for this theme.
Contact Template Javascript No The contact template javascript recorded for this theme.

What happens next

Open the screen that uses this choice and confirm the Theme appears with the intended label and availability. Keep the old value for historical records when changing it would split or relabel prior reporting.

Common mistakes and troubleshooting

Start Here

Start Here

Ecommerce

Ecommerce

Ecommerce overview

Brisk ecommerce module workspace displayed with fictional documentation-demo data.
The Ecommerce workspace related to this reference article.

Ecommerce presents Brisk products and content to online shoppers, captures orders and payment events, and supports consent-based customer communication. Storefront publication changes what customers can see; order and payment changes affect fulfillment and customer service. Treat those as separate but connected responsibilities.

Build and publish the storefront

Operate orders and payments

Use Orders to follow checkout through payment and fulfillment. Verify customer, addresses, item quantities, totals, payment state, shipment, and tracking before advancing status. Use Payment Events as the processor audit trail when a payment is pending, declined, retried, or uncertain; do not infer success from the order screen alone.

Communicate with customers responsibly

Mailing Lists, subscribers, segments, campaigns, and delivery records preserve consent, audience selection, scheduling, and send outcomes. Discount codes have date, eligibility, and usage limits that must be tested before promotion. Keep API credentials narrowly scoped and expiring where possible, and never place private integration secrets in public page content.