VTEX

https://help.vtex.com/en

Admin

VTEX is a modular e-commerce platform offering solutions for catalog management, order processing,...

Tokens:1,743,348

Snippets:32,084

Trust Score:10

Update:1 month ago

Show doc for...

Tokens:

Raw

### List installed applications

Source: https://help.vtex.com/en/docs/tutorials/writing-an-effective-ticket-to-vtex-support

View all applications currently installed in the store.

```bash
vtex list
```

--------------------------------

### Mutation response example

Source: https://help.vtex.com/en/troubleshooting/i-cant-view-the-product-in-the-search-results

The expected JSON response confirming the successful update of the internal route configuration.

```json
{

  "data": {

    "internal": {

      "save": {

        "from": "/Pendleton",

        "declarer": "vtex.store@2.x",

        "type": "fullText",

        "id": "2000307",

        "query": {

          "map": "ft"

        },

        "endDate": null,

        "binding": "0be568e5-52f5-44f0-9308-3ea701a9f847",

        "resolveAs": null,

        "origin": "user-canonical",

        "disableSitemapEntry": null

      }

    }

  }

}
```

--------------------------------

### Expected output for get redirect query

Source: https://help.vtex.com/en/troubleshooting/admin-redirect-search-returns-no-results

The JSON structure returned when fetching a specific redirect.

```json
{  

  "data": {  

    "redirect": {  

      "get": {  

        "from": "/hello",  

        "to": "hola",  

        "endDate": null,  

        "type": "PERMANENT",  

        "binding": "56bc9434-7b8a-4ab1-a693-36271595a27d"  

      }  

    }  

  }  

}  
```

--------------------------------

### Example Redirect Response JSON

Source: https://help.vtex.com/en/known-issues/shopper-is-redirect-to-gatewaycallbackordergroupsuccess-instead-of-placeorder-page

This JSON structure represents the response received when a transaction is not yet approved.

```json
{ "RedirectResponseCollection": [], "paymentAuthorizationAppCollection": [{ "appName": "vtex.example-payment-auth-app", "appPayload": "{\"approvePaymentUrl\":\"https://account.vtexpayments.com.br/api/pvt/payment-provider/transactions/transactionId/payments/paymentId/callback?accountName=Account&X-VTEX-signature=signature\"}" }]}
```

Tokens:

Raw