For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Product Group Products

Replace the full list of connected products.

Read the existing product group first. Check the replacement rules below before sending a partial list or localized value.

Behaviour

Send the product ids in the desired manual-sort order (array position becomes the sort position); products omitted from the list are disconnected.

Products that are not yours are ignored.

Requires the productGroups:write scope.

put
Authorizations
AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Path parameters
productGroupIdstringRequired

Product group identifier (PG-).

Example: PG-123e4567-e89b-12d3-a456-426614174000Pattern: ^PG-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Body

Data schema used by Update Product Group Products (PUT /v1/product-groups/{productGroupId}/products). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.

productIdsstring[]Required

Product identifier (PROD-).

Example: PROD-123e4567-e89b-12d3-a456-426614174000
Responses
200

Successful response.

application/json
put/v1/product-groups/{productGroupId}/products
PUT /v1/product-groups/{productGroupId}/products HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "productIds": [
    "PROD-123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "data": {
    "productGroupId": "PG-123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "SHARED",
    "status": "ACTIVE",
    "numberOfProducts": 1,
    "numberOfCompanies": 1,
    "manualSort": true,
    "companyIds": [
      "text"
    ],
    "connectedProducts": [
      {
        "productId": "text",
        "name": "text",
        "status": "text"
      }
    ]
  }
}

Last updated

Was this helpful?