### Start Session Response Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Recommendations/integrating-product-recommendations-in-headless-or-faststore-web-stores.md This is an example of the JSON response from the 'Start session' endpoint. It contains the `recommendationsUserId` which should be used in subsequent recommendation and event requests. ```json { "recommendationsUserId": "198e0f50-acf8-42f7-998a-5cd125464749" } ``` -------------------------------- ### GET Request Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/readme-api-md/Logistics API/scheduled-delivery/retrieveblockeddeliverywindows.md Use this example to make a GET request to retrieve blocked delivery windows. Ensure you replace placeholders like {{accountName}}, {{environment}}, and authentication headers with your specific values. ```text curl --location --request GET 'https://{accountName}.{environment}.com.br/api/logistics/pvt/configuration/carriers/carrierId/getdayofweekblocked' \ --header 'Content-Type: application/json; charset=utf-8' \ --header 'Accept: application/json' \ --header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' \ --header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' ``` -------------------------------- ### GET Request Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/readme-api-md/Logistics API/polygons/pagedpolygons.md Use this example to make a GET request to list polygons. Ensure you replace placeholder values like {{X-VTEX-API-AppKey}} and {{X-VTEX-API-AppToken}} with your actual credentials. ```text curl --location --request GET 'https://{accountName}.{environment}.com.br/api/logistics/pvt/configuration/geoshape' \ --header 'Content-Type: application/json; charset=utf-8' \ --header 'Accept: application/json' \ --header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' \ --header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' ``` -------------------------------- ### Start local development server Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/faststore/docs/troubleshooting/tracing-the-error-source.mdx Run this command to start your FastStore development server after checking out a previous version. Ensure all dependencies are installed first. ```bash yarn && yarn develop ``` -------------------------------- ### Get Task Request Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/readme-api-md/VTEX Do API/task/gettask.md Use this example to make a GET request to retrieve a specific task by its ID. Ensure you replace placeholders like {{accountName}}, {{environment}}, and {{taskId}} with your actual values. Authentication headers are required. ```text curl --location --request GET 'https://{{accountName}}.{{environment}}.com.br/api/do/tasks/{{taskId}}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \ --header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' ``` -------------------------------- ### Faststore.json Configuration Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/faststore/docs/monorepo/overview.mdx This example demonstrates a `faststore.json` file setup for a single store utilizing multiple modules: discovery, checkout, and sales-app. It specifies the path and port for each module. ```json { "$schema": "https://unpkg.com/@vtex/fsp-config/faststore.schema.json", "stores": { "account1": { "discovery": { "path": "packages/store1", "port": 3000 }, "checkout": { "path": "packages/checkout", "port": 3001 }, "sales-app": { "path": "packages/sales-app", "port": 3002 } } } } ``` -------------------------------- ### Example Output of `vtex list` Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-listing-an-accounts-apps.md This is an example of the output you can expect when running the `vtex list` command, showing apps categorized by Edition, Installed, and Linked. ```terminal $ vtex list Edition Apps in mystore at workspace master vtex.admin 4.56.3 vtex.admin-account-details 1.0.3 vtex.admin-apps 4.3.1 vtex.admin-audit 2.13.5 ... vtex.workspace-analytics 0.1.7 Installed Apps in mystore at workspace master vtex.affiliates 1.8.0 vtex.app-store-seller 0.12.9 vtex.availability-notify 1.12.1 ... vtex.social-selling 0.8.0 Linked Apps in mystore at workspace master You have no linked apps ``` -------------------------------- ### Install VTEX Developer MCP Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/AI-Assisted-Development/ai-assisted-development-overview.md Run this command to install and start the VTEX Developer MCP locally. No API key or authentication is required. ```bash npx -y @vtex/developer-mcp ``` -------------------------------- ### Get Note Request Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/readme-api-md/VTEX Do API/note/getnote.md Use this example to make a GET request to retrieve a specific note. Ensure you replace placeholders like `{{accountName}}`, `{{environment}}`, and `{{noteId}}` with your actual values. Authentication headers `X-VTEX-API-AppToken` and `X-VTEX-API-AppKey` are required. ```text curl --location --request GET 'https://{{accountName}}.{{environment}}.com.br/api/do/notes/{{noteId}}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \ --header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' ``` -------------------------------- ### App Version Specification Examples Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-installing-an-app.md Examples of valid version specifiers for app installations. VTEX IO CLI interprets ranges by majors, so minors and patches require specific formats. ```bash @8.0.10 ``` ```bash @8.0.10-beta.3 ``` ```bash @8.x ``` ```bash @^8.0.10 ``` ```bash @^8.0.10-beta.1 ``` -------------------------------- ### Start Development Server Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Checkout/fastcheckout-setting-up.md Launch your storefront development environment using the FastStore CLI. This command starts the server and makes your Checkout extensions accessible. ```bash yarn fsp dev store-a ``` ```bash npx fsp dev store-a ``` -------------------------------- ### GET Banks Endpoint Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Integration-Guides/payments-integration-guide/pse-payment-method.md Example of a GET request to retrieve bank information. Ensure to include any additional information required for the auth-token. ```json curl --request GET \ --url https://{{providerPSEEndpoint}}/ \ --header 'Application: application/json' \ --header 'Content-type: application/json' \ --header 'auth-token: token' ``` -------------------------------- ### Session Configuration Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-collecting-user-session-data.md This example demonstrates monitoring `authentication.storeUserEmail` and `checkout.orderFormId` and setting a `public.demo` property. ```json { "session-watcher-demo": { "input": { "authentication": ["storeUserEmail"], "checkout": ["orderFormId"] }, "output": { "public": ["demo"] } } } ``` -------------------------------- ### Build Documentation with Poetry Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/VTEX-CX-Platform/CLI/using-the-weni-by-vtex-cli.md Serve the documentation locally for preview during development. ```bash # Build documentation poetry run mkdocs serve ``` -------------------------------- ### GET Banks Endpoint Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Integration-Guides/payments-integration-guide/pse-payment-method.md Example of the GET Banks endpoint that VTEX will use to list available banks for the customer. This includes the request structure and expected response body. ```APIDOC ## GET Banks Endpoint Example ### Description This example shows the `curl` command VTEX will use to retrieve the list of banks from the payment provider. ### Method GET ### Endpoint `https://{{providerPSEEndpoint}}/` ### Headers - `Application`: `application/json` - `Content-type`: `application/json` - `auth-token`: `token` ### Request Example ```json curl --request GET \ --url https://{{providerPSEEndpoint}}/ \ --header 'Application: application/json' \ --header 'Content-type: application/json' \ --header 'auth-token: token' ``` ### Response #### Success Response (200) - `banks` (array) - An array of bank objects, each containing `name` and `code`. #### Response Example ```json { "banks": [ { "name": "XXXX BANK", "code": "1111" }, { "name": "YYYY BANK", "code": "2000" }, { "name": "ZZZZ BANK", "code": "5555" } ] } ``` ``` -------------------------------- ### Start FastStore Project Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/faststore/docs/developer-tools/faststore-cli.mdx Executes the FastStore project in the root directory, serving it on http://localhost:3000. This command is typically used after building the project. ```bash yarn start ``` ```bash faststore start ``` -------------------------------- ### Get Cart Installments Source: https://github.com/vtexdocs/dev-portal-content/blob/main/readme-api-md/Checkout API/shopping-cart/getcartinstallments.md Retrieves installment options for a given cart and payment method. ```APIDOC ## GET /checkout/வ1/carts/{orderFormId}/installments ### Description Retrieves possible amount of installments and respective values for a given cart with a given payment method. The [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. This endpoint can be used to get the installment options for only one payment method at a time. This endpoint should be called only after the selected `orderForm` already has a `paymentData`. ### Method GET ### Endpoint /checkout/வ1/carts/{orderFormId}/installments ### Parameters #### Query Parameters - **paymentMethod** (string) - Required - The payment method for which to retrieve installments. #### Request Body This endpoint does not accept a request body. ### Response #### Success Response (200) - **installments** (array) - A list of available installment options. - **count** (integer) - The number of installments. - **value** (integer) - The value of each installment. - **interestRate** (number) - The interest rate for the installment plan. - **total** (integer) - The total value of the purchase with this installment plan. - **discount** (integer) - The discount applied for this installment plan. - **bin** (string) - The BIN (Bank Identification Number) associated with the payment method. - **paymentMethod** (string) - The payment method used. - **countWithInterest** (integer) - The number of installments including interest. - **totalWithInterest** (integer) - The total value including interest. - **renderedValue** (string) - The formatted value of each installment. - **totalWithInterestFormatted** (string) - The formatted total value including interest. - **totalFormatted** (string) - The formatted total value. - **interestRateFormatted** (string) - The formatted interest rate. - **discountFormatted** (string) - The formatted discount. ### Request Example ```bash GET https://{{accountName}}.{{environment}}.com.br/checkout/வ1/carts/1234567890abcdef1234567890abcdef/installments?paymentMethod=creditCard ``` ### Response Example ```json { "installments": [ { "count": 1, "value": 10000, "interestRate": 0, "total": 10000, "discount": 0, "bin": "", "paymentMethod": "creditCard", "countWithInterest": 1, "totalWithInterest": 10000, "renderedValue": "R$ 100,00", "totalWithInterestFormatted": "R$ 100,0", "totalFormatted": "R$ 100,0", "interestRateFormatted": "0%", "discountFormatted": "R$ 0,0" }, { "count": 2, "value": 5000, "interestRate": 0, "total": 10000, "discount": 0, "bin": "", "paymentMethod": "creditCard", "countWithInterest": 2, "totalWithInterest": 10000, "renderedValue": "R$ 50,0", "totalWithInterestFormatted": "R$ 100,0", "totalFormatted": "R$ 100,0", "interestRateFormatted": "0%", "discountFormatted": "R$ 0,0" } ] } ``` ``` -------------------------------- ### Basic discovery.config.js Setup Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/faststore/docs/developer-tools/config-options.mdx This is a foundational example of the discovery.config.js file, demonstrating common configurations for SEO, theme, platform, and API settings. ```javascript module.exports = { seo: { title: "FastStore Starter", description: "Fast Demo Store", titleTemplate: "%s | FastStore", author: "FastStore", }, theme: "custom-theme", platform: "vtex", api: { storeId: "storeframework", workspace: "master", environment: "vtexcommercestable", hideUnavailableItems: false, incrementAddress: false, }, }; ``` -------------------------------- ### Get Holiday by ID Request Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/readme-api-md/Logistics API/holidays/holidaybyid.md This example shows how to make a GET request to retrieve holiday information by its ID. Ensure you replace placeholders like {accountName}, {environment}, and authentication headers with your actual values. ```text curl --location --request GET 'https://{accountName}.{environment}.com.br/api/logistics/pvt/configuration/holidays/holidayId' \ --header 'Content-Type: application/json; charset=utf-8' \ --header 'Accept: application/json' \ --header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' \ --header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' ``` -------------------------------- ### Create Tool Directory and Navigate Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/VTEX-CX-Platform/CLI/using-the-weni-by-vtex-cli.md Use these commands to create the necessary directory structure for your tool and navigate into it. ```bash mkdir -p tools/get_address cd tools/get_address ``` -------------------------------- ### Start Authentication Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Getting-Started/authentication/refresh-token-flow-for-headless-implementations.md Initiate the authentication flow to obtain an authenticationToken by sending a GET request to the Start authentication endpoint. ```APIDOC ## GET /api/vtexid/pub/authentication/start ### Description Initiates the authentication flow and obtains an `authenticationToken`. ### Method GET ### Endpoint `/api/vtexid/pub/authentication/start` ### Query Parameters - **scope** (string) - Required - Your account name. - **fingerprint** (string) - Required - A unique identifier for the user's session. ### Request Example ```curl curl --location 'https://{{storeDomain}}/api/vtexid/pub/authentication/start?scope={{accountName}}&fingerprint={{fingerprint}}' ``` ``` -------------------------------- ### Example Product Search by Slug Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Integration-Guides/headless-commerce/headless-catalog.md An example of how to query for a product using its slug with the Intelligent Search API. ```txt https://{accountName}.myvtex.com/api/io/_v/api/intelligent-search/product_search?q=product.link:apple-magic-mouse ``` -------------------------------- ### Get Order Example with NT 2025.001 Fields Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/release-notes/2025-08-29-orders-api-support-for-nt-2025-001-fields.md This example shows how to retrieve order data including the new NT 2025.001 fields from the `customApps` object using the Get order endpoint. Values may vary between marketplaces. ```shell "customData": { { "customApps": [ { "id": "integration-marketplace-[marketplace name]", "major": 1, "fields": { "marketplacePaymentCnpjAcquirers": "11.222.333/0001-44", "marketplacePaymentAuthorizationCodes": "XYZ", "marketplacePaymentCreditCardBrands": "", "marketplacePaymentMethods": "Pix" } } ] } } ``` -------------------------------- ### Get Cart Installments Information Response Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/get-cart-installments-information.md This JSON represents the successful response from the Cart installments endpoint, detailing available installment options for a given payment system. ```json { "paymentSystem": "2", "bin": null, "paymentName": null, "paymentGroupName": null, "value": 6940, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 6940, "total": 6940, "sellerMerchantInstallments": [ { "id": "COSMETICS2", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 6940, "total": 6940 } ] } ] } ``` -------------------------------- ### Facets Response Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Search/delivery-promise-for-headless-stores.md Example response from the Get facets API, showing available shipping methods and pickup locations with their quantities. ```json { "facets": [ { "name": "Shipping Method", "values": [ { "id": "delivery", "name": "Delivery", "quantity": 142 }, { "id": "pickup-in-point", "name": "Pickup in Store", "quantity": 37 } ] }, { "name": "Pickup Location", "values": [ { "id": "vtex-botafogo", "name": "VTEX Botafogo", "quantity": 12 }, { "id": "vtex-sp", "name": "VTEX Sao Paulo", "quantity": 8 } ] } ] } ``` -------------------------------- ### Development Server Output Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/faststore/docs/getting-started/3-running-the-project-locally.mdx This is an example of the output you will see in your terminal once the development server is ready. It indicates the server address where you can access your project. ```bash ready - started server on 0.0.0.0:3000, url: http://localhost:3000 event - compiled client and server successfully in 333 ms (951 modules) ``` -------------------------------- ### Python Tool Implementation Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/VTEX-CX-Platform/CLI/working-with-weni-by-vtex-agents.md Demonstrates the structure for implementing a custom tool using the VTEX CX Platform (Weni) SDK. The tool must inherit from 'Tool' and implement the 'execute' method. ```python from weni import Tool from weni.context import Context from weni.responses import TextResponse class ToolName(Tool): def execute(self, context: Context) -> TextResponse: # Extract parameters parameters = context.parameters param_value = parameters.get("param_name", "") # Process the request result = self.process_request(param_value) # Return response return TextResponse(data=result) def process_request(self, param_value): # Your business logic here return {"key": "value"} ``` -------------------------------- ### Example Request URL Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Checkout/fulfillment-checkout-section-api-quick-start-guides/get-address-by-postal-code.md Construct the URL by including your account name, environment, country code, and postal code. ```url https://{accountname}.{environment.com.br}/api/checkout/pub/postal-code/BRA/22250040 ``` -------------------------------- ### GET - Retrieve Invoice by ID Response Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Integration-Guides/customer-credit-integration-guide/managing-a-customer-credit-invoice.md This is an example of the JSON response body when retrieving details for a specific Customer Credit invoice. ```json { "id": "7583E36F101C461094AB6CA68FA8EE2C-01", "friendlyId": "IBjuAsrJ-1", "status": "Opened", "value": 9.63, "accountId": "11111111111_CPF", "creditValue": 0.0, "createdAt": "2024-03-03T06:52:53.1314379Z", "updatedAt": "2024-04-05T06:52:56.2329924Z", "originalDueDate": "2024-04-02T06:52:53.1314379Z", "dueDate": "2024-04-02T06:52:53.1314379Z", "installment": 1, "orderId": "1413870513134-01", "transactionId": "7583E36F101C461094AB6CA68FA8EE2C", "numberOfInstallments": 1, "creditAccountId": "11111111111_CPF" } ``` -------------------------------- ### Get Unmasked Address Response Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Integration-Guides/data-privacy/profile-system.md An example of the response when retrieving an unmasked address. It includes the address ID, document details, and metadata. ```json { "id": "bf82180e-cf9e-4089-9af6-ae1518555992", "document": { "postalCode": "20200-000", "countryName": "Brasil", "countryCode": "BR", "administrativeAreaLevel1": "RJ", "locality": "Locality", "localityAreaLevel1": "locality area", "route": "51", "streetNumber": "999", "profileId": "70caf394-8534-447e-a0ca-1803c669c771" }, "meta": { "version": "c9c44895-4589-4d0d-a28d-e0e656ca1926", "author": "80aa79a3-aa89-4912-a20e-8ef69af19a6c", "creationDate": "2022-01-18T18:51:34.1293829+00:00", "lastUpdateDate": "2022-01-18T18:51:34.1293829+00:00" } } ``` -------------------------------- ### Navigate to Theme Directory Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/Storefront-Guides/store-framework.md Move into the cloned minimum-boilerplate-theme directory to start development. ```sh cd minimum-boilerplate-theme ``` -------------------------------- ### Create Dock Request Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/readme-api-md/Logistics API/docks/createupdatedock.md Use this example to create a new dock. Ensure you replace placeholder values like {accountName} and {environment} with your specific account details. The request includes details such as dock ID, name, priority, sales channels, and address information. ```text curl --location --request POST 'https://{accountName}.{environment}.com.br/api/logistics/pvt/configuration/docks' \ --header 'Content-Type: application/json; charset=utf-8' \ --header 'Accept: application/json' \ --header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' \ --header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \ --data-raw '{ "id": "catete", "name": "Loja Catete", "priority": 0, "dockTimeFake": "00:00:00", "timeFakeOverhead": "00:00:00", "salesChannels": [ "1" ], "salesChannel": null, "freightTableIds": [], "wmsEndPoint": "", "address": { "postalCode": "22220070", "country": { "acronym": "BRA", "name": "Brazil" }, "city": "Rio de Janeiro", "state": "RJ", "neighborhood": "Catete", "street": "Artur Bernardes Street", "number": "100", "complement": "", "coordinates": [[-43.18228090000002, -22.9460398 ]] } }' ``` -------------------------------- ### FastStore Price Component - Installment Variant Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/faststore/components/atoms/price.mdx Example of using the Price component specifically for displaying installment information. Import the component and its styles before use. ```tsx import { Price } from '@faststore/ui' export function PriceExample() { return ( ) } ``` -------------------------------- ### Install App in Production Workspace Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-1-developnativeintegrationswithpixelapps/vtex-io-documentation-8-makingyourpixelapppubliclyavailable.md Installs the specified app version into the current workspace. Replace `{vendorAccount}`, `{appName}`, and `{appVersion}` with your app's details. ```sh vtex install {vendorAccount}.{appName}@{appVersion} ``` -------------------------------- ### Get SKU Specifications Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Integration-Guides/payments-integration-guide/updating-sku-specifications-with-catalog-api.md This JSON shows an example response when retrieving specifications for an SKU. Note that updates must be performed one specification at a time. ```json [ { "Id": 472, "SkuId": 17784, "FieldId": 271, "FieldValueId": null, "Text": "" }, { "Id": 528, "SkuId": 17784, "FieldId": 40, "FieldValueId": 147, "Text": "L" } ] ``` -------------------------------- ### Get Order API Request (Node.js) Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Checkout/creating-a-regular-order-with-the-checkout-api.mdx This Node.js example shows how to make a GET request to the Get Order API. It uses the built-in `https` module and requires your account name, order ID, and API credentials. ```Node.js const http = require("https"); const options = { "method": "get", "hostname": "{accountName}.vtexcommercestable.com.br", "port": null, "path": "/api/oms/pvt/orders/{orderId}", "headers": { "Accept": "application/json", "Content-Type": "application/json", "X-VTEX-API-AppKey": "{appKey}", "X-VTEX-API-AppToken": "{appToken}" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); ``` -------------------------------- ### Create a Development Workspace Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/App-Guides/vtex-app-store/vtex-io-documentation-developing-an-app.md Use this command to create a new development workspace or switch to an existing one. Replace `{exampleName}` with your desired workspace name. ```bash vtex use {exampleName} ``` -------------------------------- ### Initialize FastStore Monorepo Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/faststore/docs/monorepo/overview.mdx Run this command in your monorepo project folder to initialize the FastStore monorepo configuration files. ```bash npx @vtex/fsp-cli init --from-discovery ``` -------------------------------- ### API Validation Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/release-notes/2025-12-23-granular-permissions-seller-marketplace-api.md This example demonstrates how to make a GET request to the Seller Register API. If the response is '403 Forbidden', it indicates that the appKey lacks the necessary permissions. ```bash curl --request GET \ --url https://{accountName}.vtexcommercestable.com.br/api/seller-register/pvt/sellers \ --header 'Accept: application/json' \ --header 'X-VTEX-API-AppKey: {appKey}' \ --header 'X-VTEX-API-AppToken: {appToken}' ``` -------------------------------- ### Example Range Object Structure Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-billing-options.md Demonstrates the structure of a range object used for calculating billing fees. This example shows how to define the start of a range and its corresponding multiplier. ```json "ranges": [{ "exclusiveFrom": 0, "multiplier": 0.08 }] ``` -------------------------------- ### Initialize CMS Structure with Content Plugin Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/CMS/Integrations/FastStore/content-plugin.md Use the `init` command to create the default CMS folder structure and sample files in your project. ```shell vtex content init ``` -------------------------------- ### Configure recommendation-shelf Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/Store-Framework-Apps/advanced-components/vtex-recommendation-shelf.md Example of configuring the `recommendation-shelf` block, including its children like `default-shelf` and product list contexts. ```json "store.home": { "blocks": [ "flex-layout.row#recommendation-shelf" ] }, "flex-layout.row#recommendation-shelf": { "children": ["recommendation-shelf"] }, "recommendation-shelf": { "blocks": ["default-shelf"] }, "default-shelf": { "blocks": ["list-context.product-list", "list-context.product-list-static"] }, "list-context.product-list": { "blocks": ["product-summary.shelf#demo1"], "children": ["slider-layout#demo-products"] }, "list-context.product-list-static": { "blocks": ["product-summary.shelf#demo1"], "children": ["slider-layout#demo-products"] }, "product-summary.shelf#demo1": { "children": [ "stack-layout#prodsum", "product-summary-name", "product-rating-inline", "product-summary-space", "product-summary-price", "product-summary-buy-button" ] }, "slider-layout#demo-products": { "props": { "itemsPerPage": { "desktop": 5, "tablet": 3, "phone": 1 }, "infinite": true, "fullWidth": false } } ``` -------------------------------- ### Get Most Searched Terms Response Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Search/consult-store-search-terms-information.md This JSON structure represents the response from the Get list of the 10 most searched terms endpoint. It lists terms and their search counts. ```json { "searches": [ { "term": "home", "count": 14 }, { "term": "shirt", "count": 10 }, { "term": "top", "count": 9 }, { "term": "tops", "count": 6 }, { "term": "camera", "count": 5 }, { "term": "kit", "count": 5 }, { "term": "work shirt", "count": 2 }, { "term": "shirts", "count": 2 }, { "term": "clothing", "count": 2 }, { "term": "classic shoes", "count": 1 } ] } ``` -------------------------------- ### App Installation Command Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-docs-guidelines.md This command installs a VTEX app in your account. Ensure you replace `{appVendor}` and `{appName}` with the correct values. ```bash vtex install {appVendor}.{appName} ``` -------------------------------- ### Get Cart Information (Node.js) Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Checkout/creating-a-regular-order-from-an-existing-cart.mdx This Node.js example shows how to make a GET request to retrieve cart information, including the orderFormId. It utilizes the built-in 'https' module. ```javascript const http = require("https"); const options = { "method": "get", "hostname": "apiexamples.vtexcommercestable.com.br", "port": null, "path": "/api/checkout/pub/orderForm", "headers": { "Accept": "application/json", "Content-Type": "application/json" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end(); ``` -------------------------------- ### Install Your App in a Workspace Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-10-making-your-app-publicly-available.md Install your published app into a specific workspace. Replace placeholders with your app's vendor, name, and desired version. ```sh vtex install {appVendor}.{apNname}@{appVersion} ``` -------------------------------- ### Get Order Request Example Source: https://github.com/vtexdocs/dev-portal-content/blob/main/readme-api-md/Orders API/orders/getorder.md Use this cURL command to make a GET request to retrieve order details. Replace placeholders with your account name, environment, and API credentials. ```json curl --location --request GET 'https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/v5195004lux-01' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \ --header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' ``` -------------------------------- ### Get document without schema in Master Data v2 Source: https://github.com/vtexdocs/dev-portal-content/blob/main/docs/guides/Master-Data/master-data-v2/creating-relationships-between-data-entities-using-master-data-v2.md Example of a GET request for a document without using a schema. The `address` field will contain only the ID of the related document. ```http GET /api/dataentities/client/documents/{id}?_fields={fields} ``` ```json { "clientEmail": "vtext@mail.com", "address": "1" } ```