Cognis
Commerce Google Shopping

Provision Gmc

POST
/brands/{brandId}/ecom/google-shopping-settings/provision

Public API endpoint: ecomGoogleShopping.provisionGmc

Required scopes: brand:settings:write

Authorization

bearerAuth
AuthorizationBearer <token>

API key (prefix: cogn_) from Account → Developer

In: header

Path Parameters

brandId*string

Brand ID (prefix: br_)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/v1/brands/string/ecom/google-shopping-settings/provision" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "data": {
    "brandId": "1",
    "orgId": "2",
    "orgMerchantCenterIntegrationId": "3",
    "gmcSubAccountId": "987654321",
    "dataSourceId": null,
    "syncStatus": "pending",
    "orgGmcConnected": true,
    "orgMcaAccountId": "123456789",
    "orgMcaAccountType": "advanced",
    "orgGcpRegistered": true,
    "freeListingsStatus": "enabled",
    "shoppingAdsProgramState": "eligible",
    "productRatingsProgramState": "unknown",
    "ga4LinkedToGmc": false,
    "ga4LinkPending": false,
    "ga4PropertyId": null,
    "storeRatingsOptInEnabled": false,
    "markets": [
      {
        "feedLabel": "US",
        "currencyCode": "USD",
        "contentLanguage": "en",
        "source": "main",
        "dataSourceId": null,
        "hasDataSource": false,
        "shippingAttached": false,
        "skipReason": "missing_data_source"
      }
    ],
    "updatedAt": "2026-06-18T12:00:00.000Z"
  },
  "message": "Success",
  "traceId": "req_abc123"
}
{
  "success": false,
  "message": "Invalid data",
  "errors": [
    {
      "code": 400,
      "message": "Invalid data"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unauthorized",
  "errors": [
    {
      "code": 401,
      "message": "Unauthorized"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Forbidden",
  "errors": [
    {
      "code": 403,
      "message": "Forbidden"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Not found",
  "errors": [
    {
      "code": 404,
      "message": "Not found"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Conflict",
  "errors": [
    {
      "code": 409,
      "message": "Conflict"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "string",
  "errors": [
    {
      "code": 0,
      "message": "string",
      "details": {}
    }
  ],
  "traceId": "string",
  "params": {},
  "readableMessage": "string"
}
{
  "success": false,
  "message": "Rate limit exceeded",
  "errors": [],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unexpected error",
  "errors": [
    {
      "code": 500,
      "message": "Unexpected error"
    }
  ],
  "traceId": "req_xxx"
}