[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides creating a regular order with the checkout api in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/orders-2)

[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api)

[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-from-an-existing-cart)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/orders-2)

[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api)

[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-from-an-existing-cart)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/checkout-api-overview)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/orders-2)

[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api)

Creating a regular order with the Checkout API

Learn how to use VTEX APIs to efficiently handle the placement, payment, and delivery aspects of a regular order.

This step-by-step guide will walk you through the process of using the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) for handling the placement, payment, and delivery aspects of a regular order, with all responsibilities managed within the scope of a single account. It is divided into the following steps:

1. **Assess cart requirements:** Begin by simulating a cart to assess available delivery and payment options. This step also involves checking whether the provided email address is already associated with an existing customer, which is required to place an order.
2. **Assemble the cart:** Continue by building the cart, ensuring that all essential order details are properly structured according to the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) data structure.
3. **Handle the order:** Place the order on the VTEX platform and send all required payment data to process the payment for the order.
4. **Process and validate the order:** The process concludes with the processing of order details and a verification procedure to confirm the order's successful placement.

## Before you begin

Before proceeding any further, ensure that you have a valid `appKey` and `appToken` with the necessary permissions to access the [Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) APIs. For more information, refer to the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) article.

> Click the steps below to navigate through this article and explore specific topics. Relevant code for each phase or parameter is highlighted on the right side of the screen.

## Step 1 - Assessing cart requirements

In this step, we will verify that your store can fulfill the cart requirements and collect the essential order details necessary to ensure a smooth order placement process in the subsequent steps.

### Simulating a cart

Use the [Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation) endpoint to obtain the available delivery and payment options for the current cart configuration. In this request, you must provide the following information in the request body:

* `items.id`: SKU ID.
* `items.quantity`: The number of items in the cart.
* `items.seller`: Seller's ID.
* `country`: Three-letter ISO code of the country of the shipping address.
* `postalCode` or `geoCoordinates`: Shipping address's postal code or geocoordinates.

Upon receiving a `200 OK` response, the request will provide a response body containing all information about the cart. Take note of the following information, as it will be used in the following steps:

* `items`
* `paymentData`
* `logisticsInfo`

### Checking for existing customer

Send a request to the [Get client by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/profiles) endpoint to ensure a customer profile exists in your database associated with the email to be used in the order.

Upon receiving a `200 OK` response, the request will provide a response body containing all information about the customer profile. Take note of the following information, as it will be used in the following steps:

* `availableAddresses`
* `userProfile`

> If the response body fields are empty in this request, it may indicate that no customer is registered under this email, or that the customer profile is invalid or incomplete. In this case, you can use a different email address or enter data for a new customer when assembling the cart.

## Step 2 - Assembling the cart

In this step, we will arrange the order details into the specified data format, following the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) data structure. This formatted cart data will be used as the request body in the following steps.

Below, we will briefly examine the key elements that make up the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields), which include:

* `items`
* `clientProfileData`
* `shippingData.address`
* `shippingData.logisticsInfo`
* `paymentData`

> While an `orderForm` may include various elements, a standard order generally comprises the key components described above.

### `items`

`items` is an array that contains all data pertinent to the SKUs being purchased. Build the `items` array using the `items` array obtained from the [Simulating a cart](#simulating-a-cart) step. For more complex examples, see the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) API reference.

### `clientProfileData`: New customers

`clientProfileData` is an object that contains information about the customer. If you noted the customer does not exist in your database during the [Checking for existing customer](#checking-for-existing-customer) step, build the `clientProfileData` object with the data of the new customer willing to place the order.

### `clientProfileData`: Existing customers

If the customer already exists in your database, use the `userProfile.email` obtained in the [Checking for existing customer](#checking-for-existing-customer) step to build the `clientProfileData` object. The email address is enough to register the order to the shopper’s existing account.

### `shippingData.address`: New customers

`shippingData.address` is an object that contains information about the shipping address. If you noted the customer does not exist in your database during the [Checking for existing customer](#checking-for-existing-customer) step, build the `shippingData.address` object with the data of the new customer willing to place the order.

### `shippingData.address`: Existing customers

If the customer already exists in your database, use the desired `availableAddresses[i].addressId` obtained from the [Checking for existing customer](#checking-for-existing-customer) step to build the `shippingData.address` block.

### `shippingData.logisticsInfo`

`logisticsInfo` is an array that contains logistics information, such as the desired delivery option and freight cost for each item in the `items` array.

* Create the `logisticsInfo` array with the same number of objects as in the `items` array. For each object within the `logisticsInfo` array, define the following elements:
   * `itemIndex` \- index of the corresponding item in the `items` array. For example, the object referring to the first item in the `items` array has an `itemIndex` of `0`.
   * `selectedSla` \- desired delivery option. You can find the `id` value of the available options in the `slas` array obtained from the [Simulating a cart](#simulating-a-cart) step.
   * `price` \- price of the item. You can retrieve this value from the [Simulating a cart](#simulating-a-cart) step.
   * (Optional) If the delivery method is pickup point, add the information `"selectedDeliveryChannel": "pickup-in-point"`.

### `paymentData.payments`

`paymentData.payments` is an array that contains information regarding the chosen payment method and installment preferences for the order. Build the `paymentData.payments` array considering the response obtained from the [Simulating a cart](#simulating-a-cart) step. For each payment option, define the following elements:

* `paymentSystem` \- ID of the desired payment system.
* `referenceValue` \- reference value used to calculate interest rates. If no interest applies to the order, the `value` and `referenceValue` should be the same.
* `value` \- total amount to be paid by the shopper.
* `installments` \- number of installments.

For more complex examples, see the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) API reference.

## Step 3 - Handling the order

Before creating the new order, it is necessary to verify that the `orderForm` created in the previous steps has the appropriate structure in a valid JSON format.

### New customer `orderForm`

If the `orderForm` was created for a new customer (not yet registered in the store's database), it should follow this structure.

### Existing customer `orderForm`

If the `orderForm` was created for an existing customer who already has a customer profile registered in the store's database, it should follow this structure.

### Placing the order

Place a new order via the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) endpoint using the `orderForm` you built as the request body.

Upon receiving a `201 Created` response, take note of these five pieces of information:

* `transactionId` \- ID of the transaction, which can be found within an object contained in the `merchantTransactions` array.
* `orderId` \- ID of the order within VTEX’s Order Management System (OMS). You can find the `orderId` within each object in the `orders` array.
* `orderGroup` \- ID that groups all orders related to the same purchase. For example, when an order is fulfilled by multiple sellers, each seller has its own order ID (`v71021570str-01` and `v71021570str-02`), but they share the same order group ID (`v71021570str`).
* `addressId` \- ID of the customer address. If you plan to use the same address for both shipping and billing, get the `addressId` from the `orders[].shippingData.address` object.
* `Vtex_CHKO_Auth` \- authentication cookie provided in the response.

> If you are using an email from an existing customer, ensure that the corresponding customer account is logged into your store. Otherwise, the process will fail.

### Resolving the order payment

Now, we will communicate the necessary payment data to VTEX to finalize the order payment.

> Starting from the moment the order is placed, you have 5 minutes to submit the payment information and process the order (Step 4). If the payment information and order are not submitted and processed within 5 minutes, the order will be automatically canceled.

* Send a request to the [Send payments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api%23post-/api/payments/transactions/-transactionId-/payments) endpoint, considering the following:
   * Use the `transactionId` value from the previous step as both the path parameter and the value for the `id` field within the `transaction` object.
   * Set the `merchantName` field within the `transaction` object to your account name.
   * Use the `orderId` value from the previous step as a query string parameter.
   * Ensure that the request body is based on the `paymentData` section of your `orderForm`.
   * In the `fields` object, you can:
         * Fill in the credit or debit card information (when applicable).
         * Use the `addressId` field to reference an existing address, or provide a new `address` object for an entirely new address. This type of information is only required if the shopper's address was not previously entered during checkout.

> This request does not return any data in the response body, only a `201 Created` success confirmation message.

## Step 4 - Processing and validating the order

In this final step, we will process the order.

* Send a request to the [Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/gatewayCallback/-orderGroup-) endpoint, using the `orderGroup` value as a path parameter.

> If the payment is processed without any issues, the order should be successfully placed (`204 No Content` status). Otherwise, a `500 Internal Server Error` message might occur.

> Note that this process uses the gateway connectors configured in your VTEX environment. Be careful to prevent any unwanted charges or unexpected payment denials.

### Verifying the order placement

Finally, you can confirm if your order was correctly placed by checking the [Order management](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/all-orders) in VTEX Admin. Alternatively, you can use the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) and [List orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders) endpoints for this purpose.

Shell

Python

Node.js

`1

curl --request post \

2

 --url 'https://{accountName}.{environment}.com.br/api/checkout/pub/orderForms/simulation?RnbBehavior=0' \

3

 --header 'Accept: application/json' \

4

 --header 'Content-Type: application/json' \

5

 --header 'X-VTEX-API-AppKey: {appKey}' \

6

 --header 'X-VTEX-API-AppToken: {appToken}' \

7

 --data '{"items":[{"id":"1","quantity":1,"seller":"1"}],"country":"BRA","postalCode":"12345-000","geoCoordinates":[-47.924747467041016]}'

`

Response

`1

{

2

 "items": [],

3

 "ratesAndBenefitsData": {},

4

 "paymentData": {},

5

 "selectableGifts": [],

6

 "marketingData": {},

7

 "postalCode": string,

8

 "country": string,

9

 "logisticsInfo": [],

10

 "messages": [],

11

 "purchaseConditions": {},

12

 "pickupPoints": [],

13

 "subscriptionData": string,

14

 "totals": [],

15

 "itemMetadata": {},

16

 "sellers": [],

17

 "allowMultipleDeliveries": boolean,

18

 "minimumOrderValue": number

19

}

`

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/creating-a-regular-order-with-the-checkout-api.mdx)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/creating-a-regular-order-with-the-checkout-api.mdx)

[Order Placement« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api//docs/guides/orders-2)[Creating a regular order from an existing cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api//docs/guides/creating-a-regular-order-from-an-existing-cart)

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23before-you-begin)

[Step 1 - Assessing cart requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-1-assessing-cart-requirements)

[Simulating a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23simulating-a-cart)[Checking for existing customer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23checking-for-existing-customer)

[Step 2 - Assembling the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-2-assembling-the-cart)

[items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23items)[clientProfileData: New customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23clientprofiledata-new-customers)[clientProfileData: Existing customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23clientprofiledata-existing-customers)[shippingData.address: New customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdataaddress-new-customers)[shippingData.address: Existing customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdataaddress-existing-customers)[shippingData.logisticsInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdatalogisticsinfo)[paymentData.payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23paymentdatapayments)

[Step 3 - Handling the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-3-handling-the-order)

[New customer orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23new-customer-orderform)[Existing customer orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23existing-customer-orderform)[Placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23placing-the-order)[Resolving the order payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23resolving-the-order-payment)

[Step 4 - Processing and validating the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-4-processing-and-validating-the-order)

[Verifying the order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-a-regular-order-with-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23verifying-the-order-placement)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] How do I use the VTEX product summary 2.91.0 ProductSummaryAttachmentList app? Provide documentation and configuration details.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/vtex-io-apps)

Product Summary Attachment List

[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)

Version: 2.91.0

Latest version: 2.91.0

Product Summary Attachment is the block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the [attachment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-um-anexo--aGICk0RVbqKg6GYmQcWUm) options available for a product.

![{"base64":"  ","img":{"width":1164,"height":751,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":722236,"url":"https://user-images.githubusercontent.com/67270558/156370029-833f68ce-a270-4e01-ae20-5d63061f0a03.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/67270558/156370029-833f68ce-a270-4e01-ae20-5d63061f0a03.png)

## Configuration

1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:

`1

 "dependencies": {

2

 "vtex.product-summary": "2.x"

3

 }

`

1. Add the `product-summary-attachment-list` block to a store template of your choice as a child of the `product-summary.shelf` block. For example:

`1

 "product-summary.shelf": {

2

 "children": [

3

 "product-summary-image",

4

 "product-summary-name",

5

 "product-summary-sku-name",

6

+ "product-summary-attachment-list",

7

 "product-summary-space",

8

 "product-summary-column#1"

9

 ]

10

 },

`

After adding the `product-summary-attachment-list` block to your store theme, use the VTEX Admin to add attachments to your products to display the component in your store correctly. For more information, please refer to [Adding an attachment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/cadastrar-um-anexo--7zHMUpuoQE4cAskqEUWScU).

## Customization

To apply CSS customizations in this and other blocks, follow the [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.

| CSS Handles               |
| ------------------------- |
| attachmentListContainer   |
| attachmentItemContainer   |
| attachmentItem            |
| attachmentItemProductText |

See also

[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.product-summary)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList%23configuration)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList/docs/apps/vtex.product-summary@2.91.0/ProductSummaryAttachmentList%23customization)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] How do I use the VTEX store components 3.178.5 SKUSelector app? Provide documentation and configuration details.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/guides/vtex-io-deprecated-apps)

---

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/vtex-io-apps)

SKU Selector

[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)

Version: 3.178.5

Latest version: 3.178.5

The `sku-selector` block is mainly used in Product Details Pages (PDPs) to display all the SKUs available for a product.

![{"base64":"  ","img":{"width":1860,"height":664,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":348509,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-components-skuselector-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-components-skuselector-0.png)

## Configuration

1. Import the `vtex.store-components` app to your theme dependencies in the `manifest.json` file as in the following example:

`1

 "dependencies": {

2

 "vtex.store-components": "3.x"

3

 }

`

1. Add the `sku-selector` block to any child of the `store.product` template (product page). For example:

`1

 "store.product": {

2

 "children": [

3

 "flex-layout.row#product",

4

 ]

5

 },

6

 "flex-layout.row#product": {

7

 "children": [

8

+ "sku-selector"

9

 ]

10

 },

`

1. Then, declare the `sku-selector` block using the props stated in the [Props](#props) table. For example:

`1

 "sku-selector": {

2

 "props": {

3

 "hideImpossibleCombinations": false

4

 }

5

 },

`

### Props

| Prop name                       | Type             | Description                                                                                | Default value                                                                                |
| ------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| classes                         | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, please refer to [this documentation](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Please note that this is only helpful if you're using this block as a React component.                                                                                | undefined                                                                                |
| disableUnavailableSelectOptions | boolean          | Whether a product variation that leads to an impossible product combination should be displayed with the disabled attribute when displayMode is set to select. By default, all select options are configured without the disabled attribute set based on the type of variation                                                                                | false                                                                                |
| displayMode                     | enum             | Defines how the product variation names will be displayed (it does not apply to product variation images). Possible values are: default (displays all variation names), select (only displays the selected variation name), or slider (displays all variation names in a slider when the number of available options is greater than the value defined in the sliderDisplayThreshold prop). Please note that this prop is _responsive_, so you can declare an object as its value, specifying a value for each breakpoint (desktop and mobile).        | default                                                                                |
| hideImpossibleCombinations      | boolean          | Defines whether a product variation should be clickable (true) or (false). The variation will not be displayed if true. If false, the variation will be displayed with less opacity. For example, there are two colors for a pair of sneakers: pink and white. If the pink sneaker is only available in one size, the other sizes will not be displayed (true).                                                                                | true                                                                                |
| sortVariationsByLabel           | boolean          | Defines if the variations are to be sorted in alphabetical order.                                                                                | false                                                                                |
| imageHeight                     | number           | object                                                                                | Height (in px) of the product thumbnail image. You can declare an object as its value in case you want to define a height for each device (desktop and mobile). |
| imageWidth                      | number           | object                                                                                | Width (in px) of the product thumbnail image. You can declare an object as its value in case you want to define a width for each device (desktop and mobile).   |
| initialSelection                | enum             | Controls the user's initial selection for available variations when the product page is fully loaded. Possible values are: complete (selects the first available SKU variation values), image (selects the first available image variation), or empty (no variations will be selected when the page is loaded).                                                                                | complete                                                                                |
| maxItems                        | number           | The maximum number of variation items to be displayed in the SKU selector before the See more button. The button will always be displayed 2 items before the number set in maxItems.                                                                                | 10                                                                                |
| showValueForVariation           | enum             | Displays a value for the selected variation. This prop replaces the former showValueNameForImageVariation (deprecated). Possible values are: none (no values are displayed when the variation is selected), image (displays only the image value for the selected variation, if any), or all (all variation values are displayed).                                                                                | none                                                                                |
| sliderArrowSize                 | number           | Controls the size (height and width) in pixels of the navigation arrows rendered when displayMode is set as slider.                                                                                | 12                                                                                |
| sliderDisplayThreshold          | number           | The minimum number of product variation names that should be displayed using slider display mode. This prop only works properly when displayMode is set as slider.                                                                                | 3                                                                                |
| sliderItemsPerPage              | object           | Controls how many slides should be displayed on each type of device when displayMode is set as slider. There is more information regarding this prop structure below this table.                                                                                | {desktop: 3, tablet: 2, phone: 1}                                                                                |
| showVariationsErrorMessage      | boolean          | Whether an error message should be displayed when the BuyButton is clicked but no available variation was selected (true) or (false).                                                                                | true                                                                                |
| showVariationsLabels            | enum             | Where variation names should be displayed. Possible values are: none (does not display the variation names). Replaces the previous false behavior), variation (displays the variation name as a header of the items. Replaces the previous true behavior), itemValue (displays the variation name before each item's value), and variationAndItemValue (behaves as variation and itemValue at the same time).                                                                                | variation                                                                                |
| thumbnailImage                  | string           | The first image to be displayed. This prop value must be the same text string defined in the desired product image imageLabel field (from the Catalog module). If you use this prop and no image declaring the same text string in its imageLabel field is found, any product image will be randomly rendered. To apply the thumbnailImage configuration, please read the [Configuring custom images for the SKU Selector documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector) | undefined                                                                                |
| variationsSpacing               | number           | Defines the margin-bottom size to be applied in the rendered product variations. Possible values range from 0 to 11 (the prop value is not in px; every value represents a tachyon class).                                                                                | 7                                                                                |
| visibility                      | enum             | Defines the scenarios in which the SKU selector should be displayed. Possible values are: always (it will always be displayed, even if the product has only one SKU option) or more-than-one (the SKU selector is only displayed when the product has more than one SKU option).                                                                                | always                                                                                |
| visibleVariations               | array            | Specifies which product variations should be displayed on the product details page. Please note that no variations will be displayed if you declare a name that does not represent a real product variation or an empty array. There is more information regarding this prop structure below this table.                                                                                | undefined                                                                                |

* **`visibleVariations` props**

| Prop name | Type   | Description             | Default value |
| --------- | ------ | ----------------------- | ------------- |
| name      | string | Product variation name. | undefined     |

* **`sliderItemsPerPage` props**

| Prop name | Type   | Description                                                                                | Default value |
| --------- | ------ | ------------------------------------------------------------------------------------------ | ------------- |
| desktop   | number | The number of slides to be displayed on desktop devices when displayMode is set as slider. | 3             |
| tablet    | number | The number of slides to be displayed on tablet devices when displayMode is set as slider.  | 2             |
| phone     | number | The number of slides to be displayed on phone devices when displayMode is set as slider.   | 1             |

## Customization

To apply CSS customizations to this and other blocks, please see the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.

| CSS Handles                   |
| ----------------------------- |
| frameAround                   |
| seeMoreButton                 |
| skuSelectorContainer          |
| skuSelectorInternalBox        |
| skuSelectorItemImageValue     |
| skuSelectorItemImage          |
| skuSelectorItemTextValue      |
| skuSelectorItem               |
| skuSelectorNameContainer      |
| skuSelectorNameSeparator      |
| skuSelectorName               |
| skuSelectorOptionsList        |
| skuSelectorSelectorImageValue |
| skuSelectorSubcontainer       |
| skuSelectorTextContainer      |
| valueWrapper                  |

See also

[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.store-components@3.178.5/SKUSelector%23configuration)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.store-components@3.178.5/SKUSelector%23props)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/SKUSelector/docs/apps/vtex.store-components@3.178.5/SKUSelector%23customization)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides vtex io documentation installing an app in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app)

[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-listing-an-accounts-apps)

[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-linking-an-app)

[Deprecating an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-deprecating-an-app)

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app)

[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-listing-an-accounts-apps)

[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-linking-an-app)

[Deprecating an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-deprecating-an-app)

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/app-development)

Managing apps

[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app)

Installing an app

In the VTEX IO platform, all code configuration is bundled in what we call _apps_.

Therefore, when using the VTEX Store Framework, you will need to install several applications to your VTEX account in order to properly build the desired storefront.

In addition to that, if you are developing a new project, installing an app is a fundamental step for testing the reliability of your new code settings. Once your app is already [published](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app), you are able to install it in any workspace you may be working on.

> Remember the following: private apps (apps without the `billingOptions` field in its `manifest.json` file) can only be installed in the VTEX account where it was published. Public apps with free `billingOptions` can be installed in any VTEX account by any admin user. Lastly, public apps with billable `billingOptions` can only be installed by admin users with the License Manager's `BuyApp` permission. Once this installation takes place, the app will be charged by the end of every month in the accounts that installed it.

## Instructions

1. Using your terminal and the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference), make sure you are logged into the desired account and using the desired workspace.
2. Then, run one of the following commands according to your needs and scenario:
* `vtex install {appVendor}.{appName}` or `vtex install {appVendor}.{appName}@x` \- To install the **latest stable version** of the app;
* `vtex install {appVendor}.{appName}@{appVersion}` \- To install a **specific version** of the app;
* `vtex install {appVendor}.{appName}@ˆ{appVersion}` \- To install any available version from the `{appVersion}` onwards.

When specifying the `{appVersion}`, bear in mind the permitted structures:

* `@8.0.10`
* `@8.0.10-beta.3`
* `@8.x`
* `@^8.0.10`
* `@^8.0.10-beta.1`

> VTEX IO CLI only interprets installation commands with ranges by majors. This means minors and patches can only be specified in scenarios where one of the structures stated above is being used. App versions as `@8.0.x` or `@8.2` are no longer allowed.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-installing-an-app.md)

[Best practices on workspaces management« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app//docs/guides/vtex-io-documentation-workspaces-best-practices)[Listing an account’s appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app//docs/guides/vtex-io-documentation-listing-an-accounts-apps)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app%23instructions)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-installing-an-app.md)

Copy page

On this page

ON THIS PAGE

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app/docs/guides/vtex-io-documentation-installing-an-app%23instructions)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)