Create Product Group

Create a product group.

Use this to create a reusable product group in your account. Inspect the returned record before continuing the synchronization.

Behaviour

Only the name and type (SHARED or EMBED) are required; you may also pass the general fields (status, manualSort), connected products and — for SHARED groups — companies to build the whole group in one call.

Extras are applied by a follow-up update after the group exists; if that step fails the group is still created and the response shows it without them.

Companies apply to SHARED groups only: a non-empty companyIds on an EMBED group is rejected with 400 product_group_not_shareable before anything is created, and every company must already have an API key — one that does not is simply not connected, so check companyIds in the response; the dedicated companies endpoint reports which and why.

New groups default to inactive.

Requires the productGroups:write scope.

post

Authorizations

AuthorizationstringRequired

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

Body

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

namestring · min: 1 · max: 255Required

Product group name.

Example: Chairs

typestring · enumRequired

SHARED (shareable with companies) or EMBED.

Example: EMBEDPossible values:

statusstring · enumOptionalPossible values:

manualSortbooleanOptional

productIdsstring[]Optional

Product identifier (PROD-).

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

companyIdsstring[]Optional

Company identifier (COMP-).

Example: COMP-123e4567-e89b-12d3-a456-426614174000

Responses

201

Created.

application/json

400

Invalid request data.

application/json

401

Missing or invalid API key.

application/json

403

The API key lacks the required scope (scope_denied), or the operation is not permitted for this account (operation_not_permitted).

application/json

429

The API key exceeded its request rate (rate_limit_exceeded) or its monthly quota (quota_exceeded). Both carry Retry-After; the RateLimit-* headers accompany rate_limit_exceeded only, since a spent quota says nothing about the bucket.

application/json

500

Internal server error.

application/json

post/v1/product-groups

POST /v1/product-groups HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "name": "Chairs",
  "type": "EMBED",
  "status": "ACTIVE",
  "manualSort": true,
  "productIds": [
    "PROD-123e4567-e89b-12d3-a456-426614174000"
  ],
  "companyIds": [
    "COMP-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"
      }
    ]
  }
}