Products

List VTEX stores available to the products dashboard

GET
/v1/products/integrations

Lists the organization's stores with the identifier the other Products endpoints expect as integrationId. Use each store's sourceIntegrationId — never the VTEX App Key, which can be rotated and can be linked to more than one store. Stores are ordered from the most recent sale to the oldest.

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string
Formatuuid
gtmMotionId?string

GTM motion of the organization (UUID), as listed by GET /v1/gtm-motions. Optional: without it, the response covers the organization's default GTM motion. The default motion is answered with the organization's data, the same numbers as when the parameter is omitted. Another GTM motion of the organization only sees its own stores (V4MOS-2707): a store belongs to a motion whole, so GET /v1/products/integrations lists only the motion's stores (none for a motion without a store) and a route that reads one store answers exactly as for the organization when integrationId is a store of the motion, and 404 GTM_MOTION_STORE_NOT_IN_MOTION otherwise. Not a UUID: 400. Not a live GTM motion of the organization: 403 GTM_MOTION_NOT_IN_ORGANIZATION.

Formatuuid

Response Body

Stores of the organization, most recent sale first

application/json
  1. response
data*array<>
curl -X GET "https://example.com/v1/products/integrations?organizationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&gtmMotionId=019a5b2e-7c4d-7abc-8def-0123456789ab"
{  "data": [    {      "sourceIntegrationId": "string",      "integrationId": "string",      "integrationName": "string",      "lastSaleDate": "2019-08-24T14:15:22Z"    }  ]}