Cognis
Commerce Products

Put Commerce Catalog

PUT
/org/{orgId}/ecom/products/{productId}/commerce-catalog

Public API endpoint: ecomProduct.putCommerceCatalog

Required scopes: org:ecom:collections:write

Authorization

bearerAuth
AuthorizationBearer <token>

API key (prefix: cogn_) from Account → Developer

In: header

Path Parameters

orgId*string

Organization ID (prefix: org_)

productId*string

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 PUT "http://localhost:3013/api/v1/org/string/ecom/products/string/commerce-catalog" \  -H "Content-Type: application/json" \  -d '{    "variants": [      {}    ]  }'
{
  "success": true,
  "data": {
    "catalogProduct": {
      "id": "4dtYvFotyxXQlSwSIZOaYi",
      "orgId": "30xai4apis3cuAPoFPp1u",
      "brandId": null,
      "title": "Example",
      "slug": "example",
      "description": null,
      "vendor": null,
      "productType": null,
      "tags": [],
      "status": "draft",
      "isPublishedAtStorefront": true,
      "omitFromStorefrontCollectionListings": false,
      "defaultImageUrl": null,
      "seoTitle": null,
      "seoDescription": null,
      "linkedMarketingProductId": "4dtYvFotyxXQlSwSIZOaYk",
      "shopifyProductId": null,
      "createdAt": "1970-01-01T00:00:00.000Z",
      "updatedAt": "1970-01-01T00:00:00.000Z"
    },
    "options": [],
    "variants": [
      {
        "id": "4dtYvFotyxXQlSwSIZOaYm",
        "title": "Default",
        "sku": "SKU-1",
        "option1": null,
        "option2": null,
        "option3": null,
        "position": 0,
        "isDefault": true,
        "allowNegativeInventory": true,
        "imageUrl": null,
        "prices": [
          {
            "id": "4dtYvFotyxXQlSwSIZOaYn",
            "variantId": "4dtYvFotyxXQlSwSIZOaYm",
            "currency": "usd",
            "unitAmountMinor": "1999",
            "compareAtAmountMinor": null,
            "kind": "default",
            "tierKey": null,
            "isActive": true,
            "activeFrom": null,
            "activeUntil": null,
            "autoConvertUnitFromFx": false
          }
        ]
      }
    ],
    "fxValuation": {
      "dayISO": "2026-01-01",
      "usdToQuote": {
        "EUR": "0.92"
      },
      "ratesRefreshed": false
    }
  },
  "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"
}