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

Add or Update Global Option Set Options

Add or update a subset of options without sending the whole list.

Use this to add the supplied members without submitting the entire existing list. Review how matching IDs are handled below.

Behaviour

An option whose id matches a stored one replaces it (the whole option, not a field patch); a new id is appended.

Options you do not send are left untouched.

Requires the globalOptionSets:write scope.

post
Authorizations
AuthorizationstringRequired

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

Path parameters
optionSetIdstringRequired

Global option set identifier (OPT-).

Example: OPT-123e4567-e89b-12d3-a456-426614174000Pattern: ^OPT-[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 Add or Update Global Option Set Options (POST /v1/global-option-sets/{optionSetId}/options). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.

Responses
200

Successful response.

application/json
post/v1/global-option-sets/{optionSetId}/options
POST /v1/global-option-sets/{optionSetId}/options HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 414

{
  "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"
      }
    ]
  }
}

Last updated

Was this helpful?