Create Global Option Set

Create a global option set.

Use this to create a reusable global option set in your account. Inspect the returned record before continuing the synchronization.

Behaviour

Only the name and localized display name are required; you may also pass the general fields (description, status, tags) and the options to build the whole set in one call.

Extras are applied by follow-up update(s) after the set exists; if a step fails the set is still created and the response shows it without them, so compare the response with what you sent.

Send description: null to leave it empty.

Requires the globalOptionSets:write scope.

post

Authorizations

AuthorizationstringRequired

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

Body

Data schema used by Create Global Option Set (POST /v1/global-option-sets). 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

Option set name (internal, not localized).

Example: Colour

statusstring · enumOptionalPossible values:

tagsstring[]Optional

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/global-option-sets

POST /v1/global-option-sets HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 569

{
  "name": "Colour",
  "displayName": {
    "en": "Colour",
    "de": "Farbe"
  },
  "description": {
    "en": "Pick a colour",
    "de": "Wähle eine Farbe"
  },
  "status": "ACTIVE",
  "tags": [
    "text"
  ],
  "options": [
    {
      "id": "af77627b-54d7-4039-86dc-599019320634",
      "code": "RED",
      "name": {
        "en": "Red",
        "de": "Rot"
      },
      "comment": {
        "en": "Warm tone",
        "de": "Warmer Ton"
      },
      "priceCode": "text",
      "fbPriceCode": "text",
      "additionalPriceCode": "text",
      "material3dId": "text",
      "arMaterial3dId": "text",
      "additionalPriceCodeQuantity": 1,
      "filters": {
        "<parameterId>": [
          "<valueId>"
        ]
      },
      "metafields": {
        "lead-time-weeks": 10,
        "care-label": "Wipe clean"
      },
      "src": "text"
    }
  ]
}

{
  "data": {
    "optionSetId": "OPT-123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "displayName": "Chair",
    "description": "Chair",
    "status": "ACTIVE",
    "numberOfOptions": 1,
    "createdAt": "text",
    "modifiedAt": "text",
    "tags": [
      "text"
    ],
    "options": [
      {
        "id": "text",
        "code": "text",
        "name": "Chair",
        "comment": "Chair",
        "priceCode": "text",
        "fbPriceCode": "text",
        "additionalPriceCode": "text",
        "material3dId": "text",
        "arMaterial3dId": "text",
        "additionalPriceCodeQuantity": 1,
        "filters": {
          "<parameterId>": [
            "<valueId>"
          ]
        },
        "metafields": {
          "lead-time-weeks": 10,
          "care-label": "Wipe clean"
        },
        "src": "text"
      }
    ]
  }
}