Menu
Feedback
Start here
Tutorials


Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Catalog
Attachments
Adding an attachment

Attachments can be used to complement a product with custom information. To add an attachment, go to VTEX Admin and follow the step-by-step instructions below.

  1. In the VTEX Admin, go to Catalog , or type Catalog in the search bar at the top of the page.
  2. Click Custom product attributes.
  3. Click on New Attachment.
  4. Fill in the following fields:
    • Name: name of the attachment you want to add. The name must be unique in the system and must contain only letters, numbers, or periods. This field is required.
    • Attachment Required: defines whether the attachment will be required or optional when the customer purchases the product.
    • Status: enables or disables the attachment in your store.
  5. Click on Save.

Adding keys and permitted values

After adding the attachment, you need to add the keys and permitted values related to it. You can add as many keys as you wish. To add the keys and permitted values, follow the steps below.

  1. On the Custom product attributes page, find the row of the attachment you have created and click Modify, as illustrated in the image below.
    {"base64":"  ","img":{"width":1773,"height":776,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":92906,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Catalog/Attachments/adding-an-attachment_1.PNG"}}
  2. Fill in the fields listed below.
    • Key Name: name of the custom information. This field is required and must contain only letters, numbers, or periods. For example, if the customizable product is a U.S. soccer jersey, its key names can be Name and Number.
    • Maximum Number of Characters: the maximum number of characters the customer can type to add custom information to the product. For example, in this field you could set the character limit for the name that will be printed on a shirt. This field is required. If you do not fill it in, the attachment will not be displayed to your customer as a selection option in the cart.
    • Permitted values: the values that your customer can select for customization, separated by commas. For example, by populating this field with 5,7,9,10, you allow your customer to include one of these numbers on a shirt.
  3. Click Add New. You can add other keys by repeating this process.
  4. Click on Save.

The Maximum Number of Characters field is required. If you do not fill it in, the attachment will not be displayed to your customer as a selection option in the cart.

Associating the attachment with a SKU

After creating the SKU attachment and configuring its keys and permitted values, you must associate it with one or more existing SKUs. To do this in the VTEX Admin, follow the steps below.

  1. In the VTEX Admin, go to Catalog , or type Catalog in the search bar at the top of the page.
  2. Click on All products.
  3. Select the SKU you want to associate the attachment with.
  4. Click on the Advanced Settings tab.
  5. Associate the SKU with the attachment you have created by clicking the check box next to it.
  6. Click on Save.

You can also associate an attachment to an SKU by using the Catalog API.

VTEX does not control the inventory of the attachment. This is the responsibility of the Marketplace or the Seller.

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
What is an Attachment?
« Previous
Assembly Options
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 support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback