[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 setting up white label seller as pickup point 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/setting-up-white-label-seller-as-pickup-point/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/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/setting-up-white-label-seller-as-pickup-point/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-shipping-network)

[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-tracking)

[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-pick-and-pack)

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/multilevel-omnichannel-inventory)

[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point)

[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/delivery-promise)

---

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/setting-up-white-label-seller-as-pickup-point/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-shipping-network)

[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-tracking)

[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-pick-and-pack)

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/multilevel-omnichannel-inventory)

[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point)

[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/delivery-promise)

---

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/setting-up-white-label-seller-as-pickup-point/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides)

Logistics

[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point)

Setting up white label seller as pickup point

Every [franchise account](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-franchise-account--kWQC6RkFSCUFGgY5gSjdl) created in VTEX is also automatically a [white label seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/white-label-seller--5orlGHyDHGAYciQ64oEgKa) of the main account. So any [pickup points](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configured in the franchise account will be available options for shoppers who place orders in the main account.

> Items will only be displayed for shoppers at Checkout with the pickup point option if the SKU is available in the [inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/inventory-management--tutorials%5F139) of the main account and also in the inventory of the franchise account.

## Initial setup

To set up a white label seller as a pickup point, you have to make the following configurations in the franchise account:

* [Pickup point](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-pickup-points--2R5ClQiwe4KoSQgsuiOw4E): create the pickup point with the franchise account address. You can use the [Create/Update Pickup Point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/configuration/pickuppoints/-pickupPointId-) endpoint.
* [Shipping policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/shipping-policy--tutorials%5F140): set up a shipping policy and link it to a registered pickup point. You can use the [Create shipping policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/shipping-policies) endpoint.
* [Loading dock](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-loading-docks--7K3FultD8I2cuuA6iyGEiW): configure a loading dock and link it to the shipping policy associated with the pickup point. You can use the [Create/update dock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/docks) endpoint.
* [Warehouse](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-warehouses--tutorials%5F137): you must configure a warehouse and link it to the shipping policy associated with the pickup point. You can use the [Create/update warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23post-/api/logistics/pvt/configuration/warehouses) endpoint.

## Fill in inventory level

After setting the pickup point, the shipping policy, the loading dock, and the warehouse, fill in the quantity of the items in inventory. You can also use the [Update inventory by SKU and warehouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api%23put-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-) endpoint.

The franchise account does not have its own catalog, it inherits products and SKU information from the main account, so it is necessary to update quantity through the [import and export of the inventory spreadsheet](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/importing-and-exporting-an-inventory-spreadsheet--tutorials%5F2034).

## Validate settings

Once you've made the pickup point settings correctly in the franchise account, SKUs with inventory levels and price values configured can be sold on the main account. The franchise account will work as a white label seller and the main account will work as marketplace.

> Make sure your white label seller is active. In your VTEX Admin, go to **Marketplace > Sellers > Management**, and in the seller row in column _Status_, click `Active`.

### White label seller and franchise account

To check if the white label seller, which is the franchise account, is delivering a SKU through the registered pickup point, use the [Cart simulation endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation).

**POST** \- `https://{accountName}.{environment}.com.br/api/checkout/pub/orderForms/simulation`

#### Request body example

`1

{

2

 "items": [

3

 {

4

 "id": "1",

5

 "quantity": 1,

6

 "seller": "1"

7

 }

8

 ],

9

 "country": "BRA",

10

 "postalCode": "12345-000",

11

 "geoCoordinates": [

12

 -47.924747467041016

13

 ]

14

}

`

#### Response body example

`1

{

2

 "items": [

3

 {

4

 "id": "1",

5

 "requestIndex": 0,

6

 "quantity": 1,

7

 "seller": "1",

8

 "sellerChain": [

9

 "1"

10

 ],

11

 "tax": 0,

12

 "priceValidUntil": "2023-07-12T11:49:01Z",

13

 "price": 9999,

14

 "listPrice": 9999,

15

 "rewardValue": 0,

16

 "sellingPrice": 2999700,

17

 "offerings": [],

18

 "priceTags": [

19

 {

20

 "name": "DISCOUNT@MANUALPRICE",

21

 "value": -5000,

22

 "rawValue": -50,

23

 "isPercentual": false,

24

 "identifier": "1234abc-5678b-1234c"

25

 }

26

 ],

27

 "measurementUnit": "un",

28

 "unitMultiplier": 300,

29

 "parentItemIndex": null,

30

 "parentAssemblyBinding": null,

31

 "availability": "available",

32

 "priceDefinition": {

33

 "calculatedSellingPrice": 2999700,

34

 "total": 2999700,

35

 "sellingPrices": [

36

 {

37

 "value": 2999700,

38

 "quantity": 1

39

 }

40

 ]

41

 }

42

 }

43

 ],

44

 "ratesAndBenefitsData": {

45

 "rateAndBenefitsIdentifiers": [],

46

 "teaser": []

47

 },

48

 "paymentData": {

49

 "installmentOptions": [

50

 {

51

 "paymentSystem": "2",

52

 "bin": null,

53

 "paymentName": "Visa",

54

 "paymentGroupName": "creditCardPaymentGroup",

55

 "value": 2999700,

56

 "installments": [

57

 {

58

 "count": 1,

59

 "hasInterestRate": false,

60

 "interestRate": 0,

61

 "value": 2999700,

62

 "total": 2999700,

63

 "sellerMerchantInstallments": [

64

 {

65

 "id": "brenoStore",

66

 "count": 1,

67

 "hasInterestRate": false,

68

 "interestRate": 0,

69

 "value": 2999700,

70

 "total": 2999700

71

 }

72

 ]

73

 }

74

 ]

75

 }

76

 ],

77

 "paymentSystems": [

78

 {

79

 "id": 2,

80

 "name": "Visa",

81

 "groupName": "creditCardPaymentGroup",

82

 "validator": null,

83

 "stringId": "2",

84

 "template": "creditCardPaymentGroup-template",

85

 "requiresDocument": false,

86

 "displayDocument": false,

87

 "isCustom": false,

88

 "description": "",

89

 "requiresAuthentication": false,

90

 "dueDate": "2022-07-19T11:39:36.37197Z",

91

 "availablePayments": null

92

 }

93

 ],

94

 "payments": [],

95

 "giftCards": [],

96

 "giftCardMessages": [],

97

 "availableAccounts": [],

98

 "availableTokens": [],

99

 "availableAssociations": {}

100

 },

101

 "selectableGifts": [],

102

 "marketingData": {

103

 "utmSource": "app",

104

 "utmMedium": "CPC",

105

 "utmCampaign": "Black friday",

106

 "utmipage": "true",

107

 "utmiPart": "true",

108

 "utmiCampaign": "true",

109

 "coupon": null,

110

 "marketingTags": [

111

 "tag1",

112

 "tag2"

113

 ]

114

 },

115

 "country": "BRA",

116

 "postalCode": "12345-000",

117

 "geoCoordinates": [

118

 -47.924747467041016,

119

 -15.832582473754883

120

 ],

121

 "logisticsInfo": [

122

 {

123

 "itemIndex": 0,

124

 "addressId": null,

125

 "selectedSla": null,

126

 "selectedDeliveryChannel": null,

127

 "quantity": 1,

128

 "shipsTo": [

129

 "BRA"

130

 ],

131

 "slas": [],

132

 "deliveryChannels": [

133

 {

134

 "id": "pickup-in-point"

135

 }

136

 ]

137

 }

138

 ],

139

 "messages": [],

140

 "purchaseConditions": {

141

 "itemPurchaseConditions": [

142

 {

143

 "id": "1",

144

 "seller": "1",

145

 "sellerChain": [

146

 "1"

147

 ],

148

 "slas": [

149

 {

150

 "id": "Normal",

151

 "deliveryChannel": "delivery",

152

 "name": "Normal",

153

 "deliveryIds": [

154

 {

155

 "courierId": "1",

156

 "warehouseId": "1_1",

157

 "dockId": "1",

158

 "courierName": "Transportadora",

159

 "quantity": 1,

160

 "kitItemDetails": []

161

 }

162

 ],

163

 "shippingEstimate": "3bd",

164

 "shippingEstimateDate": null,

165

 "lockTTL": "10d",

166

 "availableDeliveryWindows": {

167

 "startDateUtc": "2017-03-27T00:00:00+00:00",

168

 "endDateUtc": "2017-03-27T00:00:00+00:00",

169

 "price": 0,

170

 "lisPrice": 0,

171

 "tax": 0

172

 },

173

 "deliveryWindow": {

174

 "startDateUtc": "2014-04-21T09:00:00+00:00",

175

 "endDateUtc": "2014-04-21T12:00:00+00:00",

176

 "price": 0,

177

 "listprice": 1000,

178

 "tax": 0

179

 },

180

 "price": 1500,

181

 "listPrice": 1500,

182

 "tax": 0,

183

 "pickupStoreInfo": {

184

 "isPickupStore": false,

185

 "friendlyName": null,

186

 "address": null,

187

 "additionalInfo": null,

188

 "dockId": null

189

 },

190

 "pickupPointId": null,

191

 "pickupDistance": 0,

192

 "polygonName": null,

193

 "transitTime": "3bd"

194

 }

195

 ],

196

 "price": 9999,

197

 "listPrice": 9999

198

 }

199

 ]

200

 },

201

 "pickupPoints": [

202

 {

203

 "friendlyName": "Locker Arizona",

204

 "address": {

205

 "addressType": "pickup",

206

 "receiverName": null,

207

 "addressId": "1cc6116",

208

 "postalCode": "85004",

209

 "city": "Phoenix",

210

 "state": "AZ",

211

 "country": "USA",

212

 "street": "North 3rd Street",

213

 "number": "752",

214

 "neighborhood": "Downtown",

215

 "complement": "",

216

 "reference": null,

217

 "geoCoordinates": [

218

 3345.231544494628906,

219

 -11206.918148040771484

220

 ]

221

 },

222

 "additionalInfo": "Bring your ID",

223

 "id": "1cc6116",

224

 "businessHours": []

225

 }

226

 ],

227

 "subscriptionData": null,

228

 "totals": [

229

 {

230

 "id": "Items",

231

 "name": "Total dos Itens",

232

 "value": 2999700

233

 }

234

 ],

235

 "itemMetadata": {

236

 "items": []

237

 }

`

When the configuration was made correctly, the call will return the shipping information of a given SKU. That is enough to check if the shipping is occurring by the registered pickup point.

### Marketplace and main account

To check if the main account, which is the marketplace, is including the SKU of the white label seller in the shopping cart, use the same [Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation) endpoint mentioned in the previous section.

Fill in the `id` field of the [request body](#request-body-example) with the SKU ID sold by the white label seller and make sure to use a shipping address covered by your logistic operation. The [response body](#response-body-example) you will get should display valid shopping cart information, which shows that the SKU is been sold by the main account as well.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77300325%3Fv%3D4%26w=64%26q=75)](https://github.com/Isabella-Veloso)

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/Fulfillment/setting-up-white-label-seller-as-pickup-point.md)

[Change chain orders in external marketplaces« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point//docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)[Delivery PromiseNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point//docs/guides/delivery-promise)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77300325%3Fv%3D4%26w=64%26q=75)](https://github.com/Isabella-Veloso)

ON THIS PAGE

[Initial setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23initial-setup)

[Fill in inventory level](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23fill-in-inventory-level)

[Validate settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23validate-settings)

[White label seller and franchise account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23white-label-seller-and-franchise-account)[Marketplace and main account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23marketplace-and-main-account)

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/Fulfillment/setting-up-white-label-seller-as-pickup-point.md)

Copy page

On this page

ON THIS PAGE

[Initial setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23initial-setup)

[Fill in inventory level](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23fill-in-inventory-level)

[Validate settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23validate-settings)

[White label seller and franchise account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23white-label-seller-and-franchise-account)[Marketplace and main account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-white-label-seller-as-pickup-point/docs/guides/setting-up-white-label-seller-as-pickup-point%23marketplace-and-main-account)

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] Provide a guide on guides vtex powerreviews 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-powerreviews/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/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-powerreviews/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/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-powerreviews/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/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-powerreviews/updates/release-notes)

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides)

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

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

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

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/troubleshooting)

---

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

PowerReviews

The PowerReviews app provides a way to bring your PowerReviews content into your VTEX store. The app also implements the PowerReviews Checkout Beacon during checkout, sending customer purchase data to the PowerReviews platform.

## Configuration

Before you can start using the app, you will need an existing [PowerReviews](https://read.calvincode.net/reader?url=https://www.powerreviews.com/) account and API key.

### Step 1 - Defining the app settings

In your VTEX account's admin, perform the following actions:

1. Access the **Apps** section and then **My Apps**.
2. Select the **PowerReviews** app box.
3. Complete the following required fields in the Settings section:
* `App Key` \- The API Key provided by PowerReviews.
* `Merchant ID` \- Your unique PowerReviews merchant ID.
* `Merchant Group ID` \- Your PowerReviews merchant group ID.
* `Client ID` \- Your PowerReviews Client ID
* `Client Secret` \- Your PowerReviews Client Secret
* `Send Email After Invoicing` \- Instead of sending email after checkout, we can send email after an order has been invoiced. Enabling this disables purchase pixel's ability to track checkout
* `API Unique Id` \- The product field used as the identifier (or pageId) on PowerReviews.

Optionally, the `Use Legacy Review Display Component` checkbox allows you to use the PowerReviews Review Display component instead of the VTEX Reviews component.

If needed, provide a URL path to a CSS stylesheet to override the styles of the PowerReviews Write-a-Review, Questions & Answers, or Review Display components.

### Step 2 - Update your store theme

1. Add the `powerreviews` app as a `peerDependency` in your theme's `manifest.json` file:

`1

 "peerDependencies": {

2

+ "vtex.powerreviews": "2.x"

3

 }

`

1. If not already present, add the following to your theme's `dependencies`:

`1

 "vtex.product-review-interfaces": "1.x",

2

 "vtex.product-summary-context": "0.x",

3

 "vtex.product-context": "0.x",

4

 "vtex.store-header": "2.x",

5

 "vtex.pixel-interfaces": "1.x",

6

 "vtex.store-image": "0.x",

`

### Step 3 - Defining the app's blocks

The PowerReviews app integrates with the following store framework blocks.

| Block name                    | Description                                                                                |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| product-reviews               | Display a paginated list of reviews for the product being viewed. This must be placed on the store.product page. |
| product-rating-summary        | Display the average rating for the product being viewed. This must be placed on the store.product page.          |
| product-rating-inline         | Display the average rating for the product being viewed, intended for use on the product shelf.                  |
| product-review-form           | Display the PowerReviews Write-a-Review form component. This must be placed on the product-review-form page.     |
| product-questions-and-answers | Display the PowerReviews Questions & Answers component for the product being viewed.                             |

An example of the blocks above in use:

`1

 "store.product": {

2

 "blocks": [

3

 "product-rating-summary",

4

 "product-reviews",

5

 "product-questions-and-answers"

6

 ]

7

 }

`

`1

 "store.product-review-form": {

2

 "blocks": [

3

 "product-review-form"

4

 ]

5

 }

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/_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/Store-Framework-Apps/pixel-apps/vtex-powerreviews.md)

Contributors

1

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

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23configuration)

[Step 1 - Defining the app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-1-defining-the-app-settings)[Step 2 - Update your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-2-update-your-store-theme)[Step 3 - Defining the app's blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-3-defining-the-apps-blocks)

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/Store-Framework-Apps/pixel-apps/vtex-powerreviews.md)

Copy page

On this page

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23configuration)

[Step 1 - Defining the app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-1-defining-the-app-settings)[Step 2 - Update your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-2-update-your-store-theme)[Step 3 - Defining the app's blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-powerreviews/docs/guides/vtex-powerreviews%23step-3-defining-the-apps-blocks)

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] Provide a guide on guides faststore analytics overview 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/faststore/analytics-overview/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/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/faststore/analytics-overview/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/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/faststore/analytics-overview/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/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/faststore/analytics-overview/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/sdk-overview)

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview)

[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-send-analytics-event)

[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-use-analytics-event)

[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-sending-custom-events)

[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-extending-and-customizing-native-types)

[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/cart-overview)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/search-overview)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/session-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/sdk-overview)

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview)

[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-send-analytics-event)

[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-use-analytics-event)

[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-sending-custom-events)

[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-extending-and-customizing-native-types)

[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/cart-overview)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/search-overview)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/session-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/sdk-overview)

Analytics

The Analytics module manages events on a website. The module is composed of two main functions:

* [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event): Fires events in the browser. Events fired using this function are shared only with the website's origin. The event is wrapped and sent to the [Window object](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/API/Window) via standard `postMessage` calls.
* [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event): Intercepts fired events and usually communicates with an analytics provider.

![{"base64":"  ","img":{"width":1487,"height":1109,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":349388,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/analyticsmodule___37ad6fdb1e969835206b6d4b91461529.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/analyticsmodule___37ad6fdb1e969835206b6d4b91461529.png)

> Events sent via the Analytics module are not automatically sent to any analytics provider (e.g., Google Analytics). To connect with a provider, configure the [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) hook.

The Analytics module supports sending and receiving different events, allowing you to implement custom event types and override default ones.

Additionally, the Analytics module offers built-in [ecommerce event](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14434488?hl=en) types based on the [Google Analytics 4 (GA4) data model](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events).

## List of native event types

The Analytics module comes with native types based on [ecommerce events](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14434488?hl=en). All event types are available for use and extension. Here is a list of events natively supported by the Analytics module:

| Type                | Parameters                                                                      |
| ------------------- | ------------------------------------------------------------------------------- |
| add\_payment\_info  | currency, value, coupon, payment\_type, and items                               |
| add\_shipping\_info | currency, value, coupon, shipping\_tier, and items                              |
| add\_to\_cart       | currency, value, and items                                                      |
| add\_to\_wishlist   | currency, value, and items                                                      |
| begin\_checkout     | currency, value, coupon, and items                                              |
| login               | method                                                                          |
| page\_view          | page\_title, page\_location, and send\_page\_view                               |
| purchase            | currency, transaction\_id, value, affiliation, coupon, shipping, tax, and items |
| refund              | currency, transaction\_id, value, affiliation, coupon, shipping, tax, and items |
| remove\_from\_cart  | currency, value, and items                                                      |
| search              | search\_term                                                                    |
| select\_item        | item\_list\_id, item\_list\_name, and items                                     |
| select\_promotion   | item\_list\_id, item\_list\_name, and items                                     |
| share               | method, content\_type, and item\_id                                             |
| signup              | method, content\_type, and item\_id                                             |
| view\_cart          | currency, value, and items                                                      |
| view\_item          | currency, value, and items                                                      |
| view\_item\_list    | item\_list\_id, item\_list\_name, and items                                     |
| view\_promotion     | items                                                                           |

Each event exports at least two types: one for the event parameters and one for the event type itself. For example, the `add_to_cart` event has two exported types: `AddToCartParams<T extends Item = Item>` and `AddToCartEvent<T extends Item = Item>`.

Some types are [common](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/blob/main/packages/sdk/src/analytics/events/common.ts) to all events, such as the `Item` type. These types are particularly useful when overriding `Item` properties or a whole `Item` itself.

## Google Analytics 4

Google Analytics is the industry-leading analytics solution that most ecommerce websites use, and the Analytics module was designed with this in mind. All the helper functions and hooks in the module use the [Google Analytics 4 (GA4) data model](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events) by default. This allows you to use [code hinting](#code-hinting) tools to receive suggestions of GA4 events and their recommended properties while coding.

To send the events to Google Analytics, use the [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) hook. The hook must listen to events from [sendAnalyticsEvents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event) and add them to the `dataLayer` (recommended for Google Tag Manager) or call the `gtag` function directly (for `gtag` script implementations).

## Code hinting

By leveraging the type definitions in the Analytics module, you can use [IntelliSense](https://read.calvincode.net/reader?url=https://code.visualstudio.com/docs/editor/intellisense) suggestions for code hinting.

![{"base64":"  ","img":{"width":1999,"height":1085,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":367153,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/intellisense___44c8c3c8f2687f88e787ce38f867901c.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/intellisense___44c8c3c8f2687f88e787ce38f867901c.png)

## Next steps

[sendAnalyticsEventLearn how to trigger and manage analytics events in your store using the sendAnalyticsEvent function, which follows the Google Analytics 4 (GA4) data model.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event)[useAnalyticsEventLearn how to use the useAnalyticsEvent hook to intercept and respond to both native and custom analytics events triggered by the sendAnalyticsEvent function.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/overview.mdx)

[FastStore SDK« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/sdk-overview)[sendAnalyticsEventNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-send-analytics-event)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

ON THIS PAGE

[List of native event types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23list-of-native-event-types)

[Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23google-analytics-4)

[Code hinting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23code-hinting)

[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23next-steps)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/overview.mdx)

Copy page

On this page

ON THIS PAGE

[List of native event types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23list-of-native-event-types)

[Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23google-analytics-4)

[Code hinting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23code-hinting)

[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview/docs/guides/faststore/analytics-overview%23next-steps)

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] Provide a guide on guides checkout customization guide 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/checkout-customization-guide/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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/checkout-customization-guide/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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/checkout-customization-guide/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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/checkout-customization-guide/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customization)

[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide)

[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customize-checkout-confirmation-pages)

[Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/change-payment-method-names-in-checkout)

[Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/enable-an-observation-field-on-the-checkout-page)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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/checkout-customization-guide/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customization)

[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide)

[Customize checkout confirmation pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customize-checkout-confirmation-pages)

[Change payment method names in Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/change-payment-method-names-in-checkout)

[Enable an Observation field on the Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/enable-an-observation-field-on-the-checkout-page)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/shopping-cart-section-api-quick-start-guides)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/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/checkout-customization-guide/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-api-overview)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/customization)

[Checkout customization guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide)

Checkout customization guide

All VTEX stores have a native Checkout UI ready to be used from the beginning of their operations on the platform. However, if the merchant wants to change some features on this UI, VTEX also offers the option of customizing the Checkout. This functionality can be performed in two ways: by Admin VTEX or Apps.

## Customizing Checkout UI - Admin VTEX

In the Checkout section, located in the Admin VTEX side menu, you can access one or more websites (stores) registered in your account and perform checkout settings, including UI customization.

By clicking on the `blue gear` button of the chosen website, and selecting the **Code** tab, you will have access to a list of files and templates, where you can edit or import the HTML information.

> The same files shown in the Code tab are publicly available in the route `https://{accountName}.myvtex.com/files/`.

### Edit Information

To edit Checkout UI information, access the following files/templates:

* HTML Header: _template_ _checkout-header_
* HTML Footer: _template_ _checkout-footer_
* CSS: _file checkout6-custom.css_
* JS: _file checkout6-custom.js_

> It is not possible to edit information in HTML body of the page.

### Import Information

You can import additional information and files by clicking on the `New` button and then on **File upload**, located in the **Code** tab.

> The action of importing information is not recommended for CSS files and it is prohibited for JS files. Using non-standard files can cause side effects, such as your store breaking or stopping your sales.

For more information, access [configuring template in the SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configurar-template-no-smartcheckout--frequentlyAskedQuestions%5F599%23).

![{"base64":"  ","img":{"width":1132,"height":559,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":104522,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/checkout-customization-guide-0.PNG"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/checkout-customization-guide-0.PNG)

### Legacy CMS Portal

In stores using the Legacy CMS Portal, files are managed by the **Files Manager**. The CMS and JS files are located in the route `https://{accountName}.myvtex.com/arquivos/`, and named respectively as _checkout-custom.css_ and _checkout-custom.js_.

> Modifications made to Legacy CMS Portal files will be applied to all websites (stores) of your account at the same time.

For more information, access [View the contents of the store's CSS files](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/view-the-contents-of-the-stores-css-files--U5v7DXpRSee86uqiKQUQi%23).

![{"base64":"  ","img":{"width":710,"height":490,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":38319,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/checkout-customization-guide-1.PNG"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/checkout-customization-guide-1.PNG)

> VTEX does not support the use of custom scripts and is not responsible for any damages that their use may cause. Using custom scripts can break your store or stop sales.

## Customizing Checkout UI - Apps

In addition to Admin VTEX, you can use two apps to customize your store’s Checkout UI: _Checkout UI Settings_ and _Checkout UI Custom_.

> If you want to use the Checkout UI Settings app, any script changes made through it will override HTML, CSS, and JS information made through [Admin VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings).

### Checkout UI Settings app

The Checkout UI Settings app allows you to customize your store's through the terminal and the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install). This app, if compared to the [Admin VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings) method, offers the possibility to:

* Perform A/B Testing
* Easily track all changes made to the UI (through app versions)
* Apply quick rollbacks to a previous version, if needed.

> It is highly recommended that you have prior experience using IO apps (VTEX Store Framework) before choosing this checkout UI configuration option.

For more information, access the [Checkout UI Settings Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings).

### Checkout UI Custom app

The Checkout UI Custom app can be used to quickly apply pre-defined customization options (e.g. show items unit price, text size, colors) that have already been approved by VTEX. For more information, access the [Checkout UI Custom Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0).

![{"base64":"  ","img":{"width":715,"height":696,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":121925,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/checkout-customization-guide-2.PNG"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/checkout-customization-guide-2.PNG)

Contributors

3

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

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

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/customization/checkout-customization-guide.md)

[Customization« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide//docs/guides/customization)[Customize checkout confirmation pagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide//docs/guides/customize-checkout-confirmation-pages)

Contributors

3

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

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

ON THIS PAGE

[Customizing Checkout UI - Admin VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23customizing-checkout-ui-admin-vtex)

[Edit Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23edit-information)[Import Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23import-information)[Legacy CMS Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23legacy-cms-portal)

[Customizing Checkout UI - Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23customizing-checkout-ui-apps)

[Checkout UI Settings app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23checkout-ui-settings-app)[Checkout UI Custom app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23checkout-ui-custom-app)

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/Checkout/customization/checkout-customization-guide.md)

Copy page

On this page

ON THIS PAGE

[Customizing Checkout UI - Admin VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23customizing-checkout-ui-admin-vtex)

[Edit Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23edit-information)[Import Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23import-information)[Legacy CMS Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23legacy-cms-portal)

[Customizing Checkout UI - Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23customizing-checkout-ui-apps)

[Checkout UI Settings app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23checkout-ui-settings-app)[Checkout UI Custom app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-customization-guide/docs/guides/checkout-customization-guide%23checkout-ui-custom-app)

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=)