VTEX Developer Portal

Checking your store's binding id

If your store is a Multistore or a Cross-border one, it's important to know the id values of its related bindings's.

Hence, for a step by step on how to access this information, check the following section.

Step by step

  1. Install the [email protected] app using your terminal.

  2. Access the GraphQL admin IDE section of the desired account. You may find it in the admin's side-bar menu:

adminsidebarmenuadminsidebarmenu

  1. From the dropdown list, choose the vtex.tenant app.
  2. Write the following query command in the text box that is displayed:
query{
  tenantInfo{
    bindings {
      id,
      canonicalBaseAddress,
     defaultLocale
    }
  }
}

The expected response is a JSON object, as in:

{
  "data": {
    "tenantInfo": {
      "bindings": [
        {
          "id": "706e9126-d0fc-46de-b12d-5f9649e61877",
          "canonicalBaseAddress": "{account}.myvtex.com/admin",
          "defaultLocale": "en-US"
        },
        {
          "id": "706e9126-d0fc-47de-9o2d-5f9649e61877",
          "canonicalBaseAddress": "{account}.myvtex.com/es",
          "defaultLocale": "es-AR"
        },
        {
          "id": "748aafcf-1674-456d-9ffc-7ddb3f26e43f",
          "canonicalBaseAddress": "{account}.myvtex.com/en",
          "defaultLocale": "en-US"
        }
      ]
    }
  }
}

That's all! Save the returned response as this information might be useful when managing your VTEX account.

Updated about a month ago


Checking your store's binding id


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.