Commerce Google Shopping
Get Organic Status
Public API endpoint: ecomGoogleShopping.getOrganicStatus
Required scopes: brand:settings:read
Authorization
bearerAuth AuthorizationBearer <token>
API key (prefix: cogn_) from Account → Developer
In: header
Path Parameters
brandId*string
Brand ID (prefix: br_)
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:3013/api/v1/brands/string/ecom/organic-status"{
"success": true,
"data": {
"brandId": "2",
"orgId": "1",
"completeCount": 3,
"totalCount": 6,
"ready": false,
"checkedAt": "2026-06-23T12:00:00.000Z",
"checks": [
{
"id": "gsc_connect",
"status": "complete",
"labelKey": "ecom.automation.organicLaunch.steps.gscConnect.label"
},
{
"id": "gsc_verify",
"status": "incomplete",
"labelKey": "ecom.automation.organicLaunch.steps.gscVerify.label",
"detailKey": "ecom.brand.organicStatus.checks.gscVerify.incomplete"
},
{
"id": "gsc_sitemap",
"status": "not_applicable",
"labelKey": "ecom.automation.organicLaunch.steps.gscSitemap.label"
},
{
"id": "brand_trust_assets",
"status": "warning",
"labelKey": "ecom.brand.organicStatus.checks.brandTrustAssets.label"
},
{
"id": "gmc_sub_account",
"status": "incomplete",
"labelKey": "ecom.brand.organicStatus.checks.gmcSubAccount.label"
},
{
"id": "ga4_tag",
"status": "warning",
"labelKey": "ecom.brand.organicStatus.checks.ga4Tag.label",
"detailKey": "ecom.brand.organicStatus.checks.ga4Tag.pending"
},
{
"id": "collection_seo",
"status": "incomplete",
"labelKey": "ecom.brand.organicStatus.checks.collectionSeo.label"
}
]
},
"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"
}