Menu
Feedback
Start here
Tutorials


Tutorials
Assembly Options
Assembly Options App
4 min read

This app is only available for stores developed using VTEX IO. Before proceeding, you need to install and configure Product Customizer in your store.

Product customization options are available at VTEX when using Assembly Options. This solution helps create attachments for complex scenarios in which you need to manage different product combinations, quantities, additional items and costs.

As an alternative to implementing Assembly Options through Catalog attachments, the Assembly Options app provides an interface to configure and manage customization options in stores using VTEX IO.

Installation

You can install the app for free from the VTEX App Store or via VTEX IO CLI by following the steps in the Assembly Options guide for developers.

If you install the Assembly Options app in a seller account, the product customization options will be displayed to your customers at checkout. If you want the options to be displayed in the product page, you need to install the app in a marketplace account.

After installation, the Catalog > Assembly Options page will become available in the VTEX Admin. Below, you will find the app’s available features.

List of Assembly Options

In the VTEX Admin, go to Catalog > Assembly Options to access a list with all the assembly options available in your store.

{"base64":"  ","img":{"width":1898,"height":494,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":36980,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/apps/assembly-options/assembly-options-app_1.PNG"}}

Below, you will find the information displayed in the list:

  • ID: Shows the assembly option ID, which is the same as the attachment ID in the Catalog.
  • Name: Indicates the name of the assembly option's attachment.
  • Required: If it is marked with a , this column indicates that the assembly option attachment is required. If this field is empty, no action is needed.
  • Status: It indicates the assembly option status, which can be either:
    • Active: It means that the customization options are active; therefore, they’ll appear in your store if they’re associated with a SKU.
    • Inactive: The customization options are inactive; therefore, they cannot be chosen.
  • Menu : It shows the options available:
    • Edit: Provides access to the edit page of the assembly option.
    • Delete: Deletes an assembly option.

Use the search field to look for an assembly option by name. You can also filter the results in the list by Status (Active or Inactive).

To set up a new assembly option, click the Create assembly option button in the upper right corner of the page.

Creating or Editing Assembly Options

The Products > Assembly Options > New Assembly Options page contains a form with all the information needed to create or edit an assembly option. Follow the steps below to create an assembly option.

  1. Fill in the Basic information fields:
    • Name: Name of the assembly option, e.g., Ingredients.
    • Active: Defines whether the assembly option will remain active, i. e., available to be used in the store.
    • Required: Defines whether it is necessary for your customers to choose one of the options available.
  2. In SKU Groups, click Add new group. A group with no name will be created. Each group will have the SKU options available for your customers to choose from.
  3. Fill in the information required to create the group:
    • Name: Name of the group that will be displayed on the product page, e.g., Extra ingredients.
    • Minimum quantity: Defines the lowest number of group items the customer can choose.
    • Maximum quantity: Defines the highest number of group items the customer can choose.
  4. Click Add SKU to add an existing SKU to the group.
  5. Complete the following information about the SKU:
    • SKU ID: SKU identifier.
    • Linked price table name: Name of the price table in which the chosen SKU is listed. If this field is empty, the SKU takes the price of the trade policy.
    • Minimum quantity: Lowest number of items that the customer can choose.
    • Maximum quantity: Highest number of items that the customer can choose.
    • Initial quantity: Quantity selected by default.
  6. Click Add. The information about the added SKU will be shown in a table, and you will be able to edit it or delete the SKU from the group. If necessary, you can add other SKUs to the group by repeating step 4 onwards. You can also create other groups by repeating step 2 onwards.
  7. Once all groups have been configured, click Save.

When you save an assembly option, an attachment is automatically created in Catalog > Attachments with the prefix vtex.assembly-option. added to the name of the assembly option created. For example: vtex.assembly-option.Ingredients.

For the customization options created in Assembly Options to appear in the storefront, you will need to associate the attachment created with a SKU in Catalog > Products and SKUs > Advanced settings > Attachments. To do so, follow the steps described in Associating the attachment with a SKU.

Learn more

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Canceling payment for the service of an app installed in my store
« Previous
Customer Credit - Overview
Next »
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX Community
Join our community
Request VTEX support
For personalized assistance, contact our experts
Open a support ticket
GitHubDeveloper PortalCommunityFeedback