{ "tools": [ { "name": "add_asset_attribute", "description": "Assign attribute to asset.\n\nAttaches the attribute definition to the asset without setting a value; use the /simple, /select or /dictionary endpoints afterwards to set the value. Fails if the attribute is already assigned to the asset.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset." }, "definitionId": { "type": "string", "description": "Attribute definition identifier." } }, "required": [ "assetId", "definitionId" ], "additionalProperties": false } }, { "name": "add_product_asset_by_id", "description": "Attach a single existing asset to a product, identified by asset ID in the path.\n\nThe asset must already exist in the media bank; this only links it to the product. Existing associations on the\nproduct are kept, and the asset is appended to the end. Fails if the product or the asset does not exist. To\nattach several assets in one call, or to replace the whole set, use the request-body variants that post to\n`{id}/assets` instead.\n\nFor more information on assets in Bluestone PIM, refer to our help pages [Assets\noverview](https://help.bluestonepim.com/assets-panel).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product to which you want to attach the asset.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "assetId": { "type": "string", "description": "The internal ID of the existing media-bank asset to attach.\n\n**Example:** `fe5ad93b-35a5-4731-9eab-9d2cc9934f09`" } }, "required": [ "productId", "assetId" ], "additionalProperties": false } }, { "name": "add_product_assets", "description": "Attach several existing assets to a product in one call.\n\nEach asset must already exist in the media bank; this only links them to the product. Existing associations on\nthe product are preserved, and the new assets are added on top rather than replacing them; IDs already\nassociated are ignored. Fails if the product does not exist or if any listed asset ID is not found. To attach\nexactly one asset, the single-asset variant that posts to `{id}/assets/{assetId}` is simpler; to replace the\nproduct's entire asset set with a new list, use the PUT on `{id}/assets` instead.\n\nFor more information on assets in Bluestone PIM, refer to our help pages [Assets\noverview](https://help.bluestonepim.com/assets-panel).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product to attach the assets to.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "body": { "type": "object", "properties": { "assets": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the existing media-bank assets to attach to the product. Must contain 1 to 100 IDs, and each asset\nmust already exist. These are added to any assets the product already has, not replacing them." } } } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "add_product_categories", "description": "Assigns an existing product to one or more existing catalog categories.\n\nThis links the product to each listed category; it does not create categories or\nmodify their contents, and categories not listed here keep their current products.\nA category the product already belongs to is left unchanged.\n\nFor more details on working with products and categories, refer to the [Product details\npanel>Categories](https://help.bluestonepim.com/product-details-overview#Categoriestab).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product to assign.\n\n**Example:** `88y3566b5c77c1325edexx8f`" }, "body": { "type": "object", "properties": { "categoryIds": { "type": "array", "items": { "type": "string" }, "description": "The internal IDs of the existing catalog categories to assign the product to. Must be non-empty." } }, "required": [ "categoryIds" ] } }, "required": [ "productId", "body" ], "additionalProperties": false } }, { "name": "add_product_labels", "description": "Add product labels to a product.\n\nAppends the given labels to the product's existing labels; labels already assigned are left\nunchanged, so this never removes or replaces the current set. Fails if the product or any of\nthe given labels does not exist. To remove labels from a single product use\ndelete_product_labels; to assign one label across many products use add_label_to_products.", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The ID of the product to add the labels to." }, "body": { "type": "object", "properties": { "labelIds": { "type": "array", "items": { "type": "string", "description": "IDs of existing product labels to add to the product. At least one is required." }, "description": "IDs of existing product labels to add to the product. At least one is required." } } } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "add_product_variant", "description": "Assign product variant.\n\nAttaches an existing product to a variant group as one of its variants, and propagates the group's variant level\nattributes (VLAs) down to the newly assigned variant. The target group must already be a variant group — use\ncreate_product_variant_group first to promote a product to a group.\n\nFails if the target is not a variant group, if the product being added is not a SINGLE product, or if that\nproduct is already a variant of another group.\n\nFor more detailed information on how to work with the data model in Bluestone PIM, refer to our help\npages [The data model](https://help.bluestonepim.com/the-data-model).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID of the variant group to assign the product to.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "variantProductId": { "type": "string", "description": "The internal ID of the product to attach as a variant.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "forceVla": { "type": "boolean", "default": false, "description": "Controls how the group's variant level attributes are applied to the newly assigned variant when\nthe variant already has a value for one of them:\n\n`false` = keep the variant's existing value, only fill in empty ones\n\n`true` = overwrite the variant's existing value with the group's\n\nIf omitted, defaults to `false`." } }, "required": [ "productId", "variantProductId" ], "additionalProperties": false } }, { "name": "add_products_to_publish_session", "description": "Add products to session.\n\nQueues products to be synced once the session is closed with complete_publish_session. Call this as many times as needed (each call holds at most 100 products) while the session is still CREATED; it fails once the session has been closed, cancelled, or has finished.", "inputSchema": { "type": "object", "properties": { "sessionId": { "type": "string" }, "body": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "description": "The PIM product id to sync." }, "lastUpdate": { "type": "integer", "format": "int64", "description": "Optional: the product's lastUpdate timestamp (epoch millis) as last read from PIM. If given and PIM's current value is newer, this product is skipped and reported as a version-conflict issue instead of being synced with stale data. Omit to skip this check." } }, "description": "Products to add to the session, 1 to 100 per call." }, "description": "Products to add to the session, 1 to 100 per call." } } } }, "required": [ "sessionId" ], "additionalProperties": false } }, { "name": "add_task_comment", "description": "Add a comment for given task\n\nCreates a new top-level comment on the task; use POST /comments/{taskId}/{commentId} instead to reply to an existing comment. Fails with the same permission-denied error whether the task does not exist or you simply lack comment access to it. Returns the created comment's id, which can be used as the commentId when replying to it.", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Id of the task to add the comment." }, "body": { "type": "object", "properties": { "message": { "type": "string", "description": "Task comment's message." } } } }, "required": [ "taskId" ], "additionalProperties": false } }, { "name": "add_task_products", "description": "Assign products to task.\n\nAssociates one or more existing products with the task so they show up in its product scope; products already associated with the task are silently skipped rather than causing an error. Fails entirely, with no partial assignment, if any requested product id does not exist in the organization's product catalog. To remove a product from the task instead, use DELETE /tasks/{taskId}/products/{productId}; to mark a product done or not done within the task without removing it, use the complete/revoke endpoints.", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Id of the task to which product is to be assigned." }, "body": { "type": "object", "properties": { "productIds": { "type": "array", "items": { "type": "string", "description": "Array of Ids of products to assign to the task." }, "description": "Array of Ids of products to assign to the task." } }, "required": [ "productIds" ] } }, "required": [ "taskId", "body" ], "additionalProperties": false } }, { "name": "change_asset_publish_status", "description": "Update asset published flag.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset to update asset published flag." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." }, "body": { "type": "object", "properties": { "value": { "type": "boolean", "description": "Value to be applied on given attribute." } }, "required": [ "value" ] } }, "required": [ "assetId", "body" ], "additionalProperties": false } }, { "name": "change_products_archive_status", "description": "Archive products by IDs.\n\nArchives the products with the given IDs, moving them to the archived state so they no longer appear as active.\nThis endpoint only archives; to restore previously archived products use the separate unarchive-by-ids endpoint.\nBetween 1 and 100 IDs can be archived per call.\n\nArchiving runs asynchronously: the request returns `202 Accepted` with the scheduled task id in the\n`Resource-Id` header and a `Location` pointing at `/async/status/{taskId}`. Products being archived carry\n`toBeRemoved: true` until the background job completes and flips them to the archived state.", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "description": "The internal IDs of the products to archive; 1 to 100 IDs." }, "description": "The internal IDs of the products to archive; 1 to 100 IDs." } } } }, "required": [], "additionalProperties": false } }, { "name": "change_products_publish_state", "description": "Change product states.\n\nRecords the target publish state (PUBLISH or UNPUBLISH) for a batch of products in one context; it does not push anything live by itself. To actually publish or unpublish the products, create a session with create_publish_session, add the same product ids with add_products_to_publish_session, and start it with complete_publish_session. Product ids that do not resolve to an active product in this organization are silently ignored rather than causing a failure.", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "productIds": { "type": "array", "items": { "type": "string", "description": "PIM product ids to change, 1 to 100 per call." }, "description": "PIM product ids to change, 1 to 100 per call." }, "context": { "type": "string", "minLength": 1, "description": "The single publication context (e.g. a language code) the state change applies to. Must be an existing, non-archived context for this organization, otherwise the call fails." }, "action": { "type": "string", "enum": [ "PUBLISH", "UNPUBLISH" ], "description": "PUBLISH schedules the products to go live; UNPUBLISH schedules them to be taken down (or cancels a pending PUBLISH that hasn't been synced yet). Either way, the change only takes effect once pushed through a sync session." } }, "required": [ "context" ] } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "complete_asset_upload", "description": "Complete asset creation. The asset will be moved to \\assets path.\n\nSecond step of the two-step upload: finalizes a draft asset (from POST /upload) once its file has been uploaded, making it visible in the asset library. Returns 204 No Content.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset to complete creation." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." } }, "required": [ "assetId" ], "additionalProperties": false } }, { "name": "complete_publish_session", "description": "Close session.\n\nDespite the name, this is what actually starts the sync — it does not just close the session for bookkeeping. Call it once all products have been added with add_products_to_publish_session; it stops accepting further additions and schedules the session to be processed asynchronously. The session must currently be CREATED (i.e. not already closed, cancelled or finished). Poll get_publish_session for progress and get_publish_session_report once it reaches a terminal status.", "inputSchema": { "type": "object", "properties": { "sessionId": { "type": "string" } }, "required": [ "sessionId" ], "additionalProperties": false } }, { "name": "complete_task", "description": "Complete task by id of logged in user.\n\nMarks the entire task as done. This differs from PUT /tasks/{taskId}/products/{productId}/complete, which completes a single product within the task's scope — the task itself stays open until this endpoint is called directly, regardless of how many of its products are done. Use PUT /userTasks/{taskId}/revoke to undo. Fails if the task does not exist, or if you are neither its creator nor its assignee and lack the complete permission.", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Id of the task to complete." } }, "required": [ "taskId" ], "additionalProperties": false } }, { "name": "complete_task_product", "description": "Complete product in scope of a task.\n\nMarks a product that is already assigned to the task as completed; use PUT /tasks/{taskId}/products/{productId}/revoke to undo this. Fails if the product is not currently associated with the task — assign it first via POST /tasks/{taskId}/products. Callable by the task's creator, its assignee, or a user holding the complete permission.", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Id of the task to update product state." }, "productId": { "type": "string", "description": "Id of the product to mark as completed." } }, "required": [ "taskId", "productId" ], "additionalProperties": false } }, { "name": "count_asset_labels", "description": "Get number of asset labels for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to AssetLabelQueryGroup omitted" }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } } }, "required": [ "matchRule", "children" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "count_attribute_definitions", "description": "Get number of attribute definitions for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to AttributeDefinitionQueryGroup omitted" }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } } }, "required": [ "matchRule", "children" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "count_categories", "description": "Get number of categories or catalogs for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to CategoryQueryGroup omitted" }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "categoryId" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "filterType", "value" ] } ] } ] } } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "categoryId" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "filterType", "value" ] } ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "count_dictionary_attribute_definition_values", "description": "Get number of dictionary values for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to DictionaryValueQueryGroup omitted" }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "definitionId" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "number" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] } ] } ] } } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "definitionId" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "number" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] } ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "count_product_labels", "description": "Get number of labels for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to LabelQueryGroup omitted" }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } } }, "required": [ "matchRule", "children" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "count_products", "description": "Get number of products for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]},\"paging\":{\"page\":0,\"pageSize\":10}}", "inputSchema": { "type": "object", "properties": { "archiveState": { "type": "string", "enum": [ "ARCHIVED", "ACTIVE" ] }, "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "all", "any" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "all", "any" ] }, "children": { "type": "array", "items": { "type": "object", "description": "Circular reference to QueryGroupChild omitted" } }, "not": { "type": "boolean" } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "id" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is", "in" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name", "description" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "number" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "publishState" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "in" ] }, "value": { "type": "array", "items": { "type": "string", "enum": [ "TO_BE_PUBLISHED", "PUBLISHED", "TO_BE_UNPUBLISHED", "DRAFT" ] } } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "state" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "in" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "termType", "context", "filterType", "value" ], "deprecated": true }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "type" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "in" ] }, "value": { "type": "array", "items": { "type": "string", "enum": [ "BUNDLE", "SINGLE", "VARIANT", "GROUP", "FAMILY" ] } } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "validation_status" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string", "enum": [ "VALID", "INVALID" ] } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "papi_out_of_sync" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "boolean" } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "last_sync_state" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string", "enum": [ "SUCCESSFUL", "FAILED" ] } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "last_modified_by" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is", "is_current_user" ] }, "value": { "type": "string", "description": "Present only when filterType='is'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "assigned_assets" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "have_some", "have_all", "have_none", "greater_than", "smaller_than" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "number", "format": "double" } ] } }, "required": [ "termType", "filterType" ], "description": "With a value the term filters by asset id: 'have_some' matches a product assigned to any of the\ngiven assets, 'have_all' only a product assigned to every one of them. Without a value the term\nkeeps its counter meaning: has any, has none, more than, less than." }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "assigned_variant", "assigned_family", "bundle" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "have_some", "have_none", "greater_than", "smaller_than" ] }, "value": { "type": "number", "format": "double", "description": "Present only on greater_than / smaller_than" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "created_date", "updated_date" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "date_relative", "date_between" ] }, "unit": { "type": "string", "enum": [ "days_ago", "days_from_now" ] }, "value": { "type": "number", "format": "double", "description": "Present on filterType='date_relative'" }, "from": { "type": "number", "format": "double", "description": "Present on filterType='date_between'" }, "to": { "type": "number", "format": "double", "description": "Present on filterType='date_between'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "labels" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "have_some", "have_all", "have_none" ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Omitted when filterType='have_none'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "asset_labels" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "contains" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "category" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "have_some", "have_all", "have_none" ] }, { "type": "string", "enum": [ "have_some_with_children", "have_all_with_children" ] } ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Omitted when filterType='have_none'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "relations" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is", "is_with_products", "have_none" ] }, "reverse": { "type": "boolean", "description": "Required when filterType in {is, is_with_products}" }, "value": { "type": "string", "description": "Required when filterType in {is, is_with_products}" }, "productIds": { "type": "array", "items": { "type": "string" }, "description": "Required when filterType='is_with_products'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "completeness_requirements" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "not_meet_all" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "completeness_score" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "between" ] }, "from": { "type": "number", "format": "double" }, "to": { "type": "number", "format": "double" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "parent_family" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "in" ] }, { "type": "string", "enum": [ "have_none" ] } ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Variant family ids. Present only when filterType='in'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "parent_group" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "in" ] }, { "type": "string", "enum": [ "have_none" ] } ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Variant group ids. Present only when filterType='in'" } }, "required": [ "termType", "filterType" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "text", "multiline" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "formatted_text" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "string", "description": "Omitted for {assigned, defined}" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "pattern" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "contains", "is" ] } ] }, "value": { "type": "string", "description": "Omitted for {assigned, defined}" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "integer", "decimal" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "smaller_or_equal_than", "smaller_than", "greater_than", "greater_or_equal_than" ] }, { "type": "string", "enum": [ "between" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] }, { "type": "string", "enum": [ "have_some" ] } ] }, "value": { "anyOf": [ { "type": "number", "format": "double" }, { "type": "string" }, { "type": "array", "items": { "type": "number", "format": "double" } }, { "type": "array", "items": { "type": "string" } } ] }, "from": { "anyOf": [ { "type": "number", "format": "double" }, { "type": "string" } ] }, "to": { "anyOf": [ { "type": "number", "format": "double" }, { "type": "string" } ] } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "boolean" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "boolean", "description": "Omitted for {assigned, defined}" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "matrix", "column" ] }, "filterType": { "type": "string", "enum": [ "assigned" ] } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "dictionary", "multi_select" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "have_some", "have_all", "have_none" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Omitted for {assigned, defined}" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "single_select" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "have_some" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "date", "date_time" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "date_relative", "date_between" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "number", "format": "double", "description": "Present on {is, date_relative}" }, "unit": { "type": "string", "enum": [ "days_ago", "days_from_now" ] }, "from": { "type": "number", "format": "double", "description": "Present on 'date_between'" }, "to": { "type": "number", "format": "double", "description": "Present on 'date_between'" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "time" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "between" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "string", "description": "Present on 'is'" }, "from": { "type": "string", "description": "Present on 'between'" }, "to": { "type": "string", "description": "Present on 'between'" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] } ] } ] }, { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "all", "any" ] }, "children": { "type": "array", "items": { "type": "object", "description": "Circular reference to QueryGroupChild omitted" } }, "not": { "type": "boolean" }, "association": { "type": "string", "enum": [ "variant_group", "variant", "bundle", "product_in_bundle" ] } }, "required": [ "matchRule", "children", "association" ] } ] } }, "not": { "type": "boolean" }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter or by using the context-fallback header. The value from the header will override this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "anyOf": [ { "type": "object", "properties": { "context": { "type": "string", "description": "Context id" }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "termType": { "type": "string", "enum": [ "attribute" ] }, "attributeType": { "type": "string", "enum": [ "time", "date", "date_time", "text", "integer", "decimal", "formatted_text", "pattern", "multiline", "boolean", "multi_select", "single_select", "dictionary", "matrix", "column" ] }, "attributeId": { "type": "string" } }, "required": [ "context", "direction", "termType", "attributeType", "attributeId" ] }, { "type": "object", "properties": { "context": { "type": "string", "description": "Context id" }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "termType": { "type": "string", "enum": [ "name", "number", "type", "created_date", "updated_date" ] } }, "required": [ "context", "direction", "termType" ] } ] }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] }, "paging": { "page": 0, "pageSize": 10 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "count_relations", "description": "Get number of relations for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to RelationQueryGroup omitted" }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "reverseName" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } ] } } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "reverseName" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "count_select_attribute_definition_values", "description": "Get number of select values for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to SelectValueQueryGroup omitted" }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "definitionId" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] } ] } ] } } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "definitionId" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] } ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "create_asset_upload", "description": "Create new empty asset. The asset will not be available for other users until done operation is completed.\n\nFirst step of the two-step upload: creates a draft asset and returns its id plus an actionUrl (and form parameters) to POST the file to. The asset stays invisible until the file is uploaded and you call POST /upload/{id}/done.", "inputSchema": { "type": "object", "properties": { "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "fileName": { "type": "string", "pattern": "[\\w\\W]+\\.[^\\/\\n\\r\\t\\f`\\?\\*\\<\\>\\|\\\"\\:\\\\]+$", "description": "File name of the asset including its extension, e.g. photo.jpg. Must follow the . format; the extension may not contain slashes, colons, quotes or other reserved characters." }, "contentType": { "type": "string", "description": "MIME content type of the file to be uploaded, e.g. image/jpeg. Optional." } }, "required": [ "fileName" ] } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "create_attribute_definition", "description": "Create a new simple attribute definition.\n\nCreates a basic (single-value) attribute definition and returns its generated ID in the `resource-id` response\nheader (for example `664cc80da825236207fe01a7`). This endpoint handles simple attributes only — use the\ntype-specific endpoints for other kinds: `/definitions/column`, `/definitions/matrix`, `/definitions/dictionary`\nand `/compoundDefinitions`. A name is required. Fails if `number` is not unique, if `validation` is `NAME` and\nanother definition already has the same name, if a referenced attribute group does not exist, or if the\nattribute-definition quota is exceeded.\n\nFor more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help\npages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api)\nand [Attribute types](https://help.bluestonepim.com/attribute-types-1).", "inputSchema": { "type": "object", "properties": { "validation": { "type": "string", "default": "NAME", "enum": [ "NONE", "NAME" ], "description": "`NAME` (the default) rejects the request if another attribute definition already has the same\nname; `NONE` allows a duplicate name. The `number` must always be unique regardless of this setting." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "charset": { "type": "string", "description": "The character set used for the attribute definition. Must be a valid charset name such as UTF-8; the request fails if the charset is not supported." }, "contentType": { "type": "string", "description": "Content type of the value's text. Allowed values: text/markdown (the default) or text/html; any other value is rejected. Applies only when the dataType is FORMATTED_TEXT; ignored for other data types." }, "contextAware": { "type": "boolean", "description": "Indicates whether the attribute is context aware." }, "dataType": { "type": "string", "enum": [ "boolean", "integer", "decimal", "date", "time", "date_time", "location", "single_select", "multi_select", "text", "formatted_text", "pattern", "multiline", "column", "matrix", "dictionary" ], "description": "The data type of the attribute definition." }, "description": { "type": "string", "description": "Details of the attribute definition." }, "externalSource": { "type": "boolean" }, "groupId": { "type": "string" }, "internal": { "type": "boolean" }, "name": { "type": "string" }, "number": { "type": "string" }, "restrictions": { "type": "object", "properties": { "column": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The internal ID of the column or row. An identifier randomly generated by PIM (so you must not include any `id`\nproperty when creating columns or rows). ID is unique across all columns and rows.\n\n**Example**: `652d80e4bd32755ca11da69b`" }, "value": { "type": "string", "description": "Name of the column or row." } }, "description": "Matrix row values." }, "description": "Column attribute definition restrictions.\n\n**Examples**:\n\nExample for a new column attribute definition with three columns:\n```json\n\"columns\": [\n { \"value\": \"Column 1\" },\n { \"value\": \"Column 2\" },\n { \"value\": \"Column 3\" }\n]\n```\n\nExample for updating an existing column attribute definition (adding a fourth column):\n```json\n\"columns\": [\n { \"id\": \"67f5579936016948acd8da8f\", \"value\": \"Column 1\" },\n { \"id\": \"67f5579936016948acd8da90\", \"value\": \"Column 2\" },\n { \"id\": \"67f5579936016948acd8da91\", \"value\": \"Column 3\" },\n { \"value\": \"Column 4\" }\n]\n```" } }, "description": "Allowed values for the column data type; used by the create-column definition endpoint (/definitions/column), not by this simple-attribute endpoint." }, "enum": { "type": "object", "properties": { "type": { "type": "string", "minLength": 0, "maxLength": 100, "description": "Optional free-form custom type label for the value set (max 100 characters). Stored as-is and does not affect value validation." }, "values": { "type": "array", "items": { "type": "object", "properties": { "metadata": { "type": "string", "minLength": 0, "maxLength": 500, "description": "Custom metadata for select attribute." }, "number": { "type": "string", "minLength": 0, "maxLength": 500, "description": "Number of select attribute." }, "value": { "type": "string", "description": "Value of select attribute." }, "valueId": { "type": "string", "description": "Identifier of the select value, unique across all select attribute values. Leave empty when creating a definition — PIM generates it; supply it only to reference an existing value on update." } }, "description": "The list of allowed select values; must be non-empty for the single_select and multi_select data types." }, "description": "The list of allowed select values; must be non-empty for the single_select and multi_select data types." } }, "description": "Allowed values for the select data types single_select and multi_select." }, "matrix": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The internal ID of the column or row. An identifier randomly generated by PIM (so you must not include any `id`\nproperty when creating columns or rows). ID is unique across all columns and rows.\n\n**Example**: `652d80e4bd32755ca11da69b`" }, "value": { "type": "string", "description": "Name of the column or row." } }, "description": "Matrix row values." }, "description": "Matrix column values." }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The internal ID of the column or row. An identifier randomly generated by PIM (so you must not include any `id`\nproperty when creating columns or rows). ID is unique across all columns and rows.\n\n**Example**: `652d80e4bd32755ca11da69b`" }, "value": { "type": "string", "description": "Name of the column or row." } }, "description": "Matrix row values." }, "description": "Matrix row values." } }, "description": "Allowed values for the matrix data type; used by the create-matrix definition endpoint (/definitions/matrix), not by this simple-attribute endpoint." }, "range": { "type": "object", "properties": { "max": { "type": "string", "description": "Defines maximum allowed value." }, "min": { "type": "string", "description": "Defines minimum allowed value." }, "step": { "type": "string", "description": "Defines incremental step between minimum and maximum value." } }, "description": "Min/max/step range of allowed values. Applies to the scalar data types: integer, decimal, date, time and date_time." }, "text": { "type": "object", "properties": { "maxLength": { "type": "integer", "format": "int32", "description": "Defines the maximum length of text." }, "pattern": { "type": "string", "description": "Defines allowed regular expression pattern for values." }, "whitespaces": { "type": "boolean", "description": "Defines whether whitespaces are allowed or not." } }, "description": "Constraints for textual values (max length, whitespace, regex pattern). Applies to text, multiline, formatted_text and pattern data types; for the pattern data type the regex in `pattern` defines the accepted format." } }, "description": "Type-specific constraints on the attribute's values. The applicable sub-object depends on the data type — e.g. select values for the select types, a numeric or date range for scalar types, or a text pattern for the PATTERN type (optional at creation, but if provided it must be non-empty; without it no value can pass validation)." }, "unit": { "type": "string", "description": "The unit of measurement for the attribute definition." } } } }, "required": [], "additionalProperties": false } }, { "name": "create_catalog_node", "description": "Create a catalog node (category) or a top-level catalog.\n\nCreates a node in the catalog tree and returns its generated ID in the `resource-id` response header. Set the\nrequest body `parentId` to place the node under an existing node; omit `parentId` to create a new top-level\ncatalog (the root of its own tree). Fails if `validation` is `NAME` and any catalog or category with the same\nname already exists (the check is not limited to siblings). Also fails if `number` is not unique.\n\nFor more detailed information on how to work with catalogs and categories in Bluestone PIM, refer to our help\npages [Create and manage catalogs and categories](https://help.bluestonepim.com/catalogs-categories).", "inputSchema": { "type": "object", "properties": { "validation": { "type": "string", "enum": [ "NAME" ], "description": "When set to `NAME`, the request fails if another node with the same name already exists.\nOmit it to allow duplicate names. The `number` must always be unique regardless of this setting." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1000, "description": "Specifies the name of the category (catalog node)." }, "number": { "type": "string", "minLength": 0, "maxLength": 1000, "description": "Specifies the number of the category (catalog node). This value must be unique across all catalogs and categories in Bluestone PIM. If not specified, the system will use the category ID, which is a unique identifier generated by the system, as the default category number." }, "parentId": { "type": "string", "description": "Specifies the ID of the parent category (catalog node) to which this category belongs.\n\n**Example:** `634c26e14cedfd0001775e9f`" } }, "required": [ "name" ] } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "create_catalog_node_attribute", "description": "Create a simple Category Level Attribute (CLA) and schedule propagation task.\n\nHandles simple attribute definitions - text, date, numeric, boolean, single-select and multi-select. For the\nother definition types use the `/column`, `/matrix`, `/dictionary` or `/compound` variants of this endpoint; a\ndefinition of the wrong type, one that does not exist or one marked for removal is reported as not found.\nFails when the category already has this attribute definition as a CLA - change the existing one with\n`PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}` instead. An attribute inherited from a parent\ncategory does not count as assigned here, so the call succeeds and creates an assignment on this category\nthat overrides the inherited one.\n\nThe attribute is stored on the category immediately, while copying its value onto products runs as a background\ntask. That task covers the products in this category; the products in its sub-categories are reached only once\npropagation is switched on for this attribute, which is off on a newly created CLA - switch it on, as well as\nlock and mandatory, with `PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}`. The task ID is\nreturned in the `Resource-Id` response header and `Location` points at `GET /async/status/{taskId}`, which\nreports whether the propagation has finished.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID of the catalog node/category where the Category Level Attribute (CLA) will be created.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID of the attribute definition to be used for the Category Level Attribute\n(CLA).\n\n**Example:** `634c26e14cedfd0001775e9e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "value": { "type": "string", "description": "Value to set on the Category Level Attribute (CLA), given as text - for example `Some text`, `2025-04-25` for a\ndate or `true` for a boolean. For single-select and multi-select definitions pass select value IDs instead,\nseparated by commas for multi-select. Leave it out to attach the attribute without a value." } } } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "create_catalog_node_column_attribute", "description": "Create column Category Level Attribute (CLA) and schedule propagation task.\n\nHandles column attribute definitions only - for simple definitions use `POST\n/catalogs/nodes/{id}/attributes/{attributeDefinitionId}` - and fails when the category already has this\nattribute definition as a CLA; change the existing values with `PUT\n/catalogs/nodes/{id}/attributes/{attributeDefinitionId}/column` instead. An attribute inherited from a parent\ncategory does not count as assigned here, so the call succeeds and creates an assignment on this category that\noverrides the inherited one.\n\nThe attribute is stored on the category immediately, while copying its values onto products runs as a background\ntask. That task covers the products in this category; the products in its sub-categories are reached only once\npropagation is switched on for this attribute, which is off on a newly created CLA - switch it on, as well as\nmandatory, with `PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}`; the lock flag is not supported\nfor column definitions. The task ID is returned in the `Resource-Id` response header and `Location` points at\n`GET /async/status/{taskId}`, which reports whether the propagation has finished.\n\nA request body is always required, including when the attribute is attached with no values set - send\n`{\"column\": {}}` in that case. The keys inside `column` are the column value IDs taken from the definition's\nrestriction, read with `GET /definitions/{attributeDefinitionId}`; column names are rejected.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID for the catalog node/category.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID for the attribute definition.\n\n**Example:** `634c26e14cedfd0001775e9e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "column": { "type": "object", "properties": {}, "description": "Value per column, keyed by the column value ID taken from the attribute definition's restriction. Keys that are\nnot columns of the definition are rejected; columns left out stay empty. The `column` key itself must always be\npresent - send an empty object `{}` to attach the attribute with every column left empty." } } } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "create_catalog_node_compound_attribute", "description": "Create compound Category Level Attribute (CLA) and schedule propagation task.\n\nAttaches a compound attribute definition together with all of its sub-attributes in one call; sub-attributes the\ncategory already has are left untouched. No value and no flags are set here - set each sub-attribute afterwards\nwith the operation matching its type: `PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}` for the\nsimple types, and the `/column`, `/matrix` or `/dictionary/values` variants of that path for the rest. Handles\ncompound definitions only and fails when the category already has this definition as a CLA. An attribute\ninherited from a parent category does not count as assigned here, so the call succeeds and creates an assignment\non this category that overrides the inherited one.\n\nThis operation takes no `forceCla`, because a compound attribute carries no value of its own, and\n`PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}` rejects `forceCla` for a compound definition -\nsend it on the individual sub-attributes instead.\n\nThe attributes are stored on the category immediately, while adding them to products runs as a background task.\nThat task covers the products in this category; the products in its sub-categories are reached only once\npropagation is switched on for the attribute, which is off on a newly created CLA. The task ID is returned in\nthe `Resource-Id` response header and `Location` points at `GET /async/status/{taskId}`, which reports whether\nthe propagation has finished.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID for the catalog node/category.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID for the attribute definition.\n\n**Example:** `634c26e14cedfd0001775e9e`" } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "create_catalog_node_dictionary_attribute", "description": "Create dictionary Category Level Attribute (CLA) and schedule propagation task.\n\nAttaches a dictionary attribute definition to the category with no values selected yet. Values are selected\nwith `POST /catalogs/nodes/{id}/attributes/{attributeDefinitionId}/dictionary/values`, which attaches the\nattribute itself when it is missing - so this call is only needed when the attribute should be in place\nbefore any value is chosen. Handles dictionary definitions only and fails when the category already has this\ndefinition as a CLA. An attribute inherited from a parent\ncategory does not count as assigned here, so the call succeeds and creates an assignment on this category\nthat overrides the inherited one.\n\nThe attribute is stored on the category immediately, while adding it to products runs as a background task. That\ntask covers the products in this category; the products in its sub-categories are reached only once propagation\nis switched on for this attribute, which is off on a newly created CLA - switch it on, as well as mandatory,\nwith `PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}`. The task ID is returned in the\n`Resource-Id` response header and `Location` points at `GET /async/status/{taskId}`, which reports whether the\npropagation has finished.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID for the catalog node/category.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID for the attribute definition.\n\n**Example:** `634c26e14cedfd0001775e9e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "create_catalog_node_matrix_attribute", "description": "Create matrix Category Level Attribute (CLA) and schedule propagation task.\n\nHandles matrix attribute definitions only - for simple definitions use `POST\n/catalogs/nodes/{id}/attributes/{attributeDefinitionId}` - and fails when the category already has this\nattribute definition as a CLA; change the existing values with `PUT\n/catalogs/nodes/{id}/attributes/{attributeDefinitionId}/matrix` instead. An attribute inherited from a parent\ncategory does not count as assigned here, so the call succeeds and creates an assignment on this category that\noverrides the inherited one.\n\nThe attribute is stored on the category immediately, while copying its values onto products runs as a background\ntask. That task covers the products in this category; the products in its sub-categories are reached only once\npropagation is switched on for this attribute, which is off on a newly created CLA - switch it on, as well as\nmandatory, with `PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}`; the lock flag is not supported\nfor matrix definitions. The task ID is returned in the `Resource-Id` response header and `Location` points at\n`GET /async/status/{taskId}`, which reports whether the propagation has finished.\n\nA request body is always required, including when the attribute is attached with no values set - send\n`{\"matrix\": {}}` in that case. The keys inside `matrix` are the column value IDs and, one level deeper, the\nrow value IDs taken from the definition's restriction, read with `GET /definitions/{attributeDefinitionId}`;\ncolumn and row names are rejected.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID for the catalog node/category.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID for the attribute definition.\n\n**Example:** `634c26e14cedfd0001775e9e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "matrix": { "type": "object", "properties": {}, "description": "Value per cell, keyed first by the column value ID and then by the row value ID, both taken from the attribute\ndefinition's restriction. IDs that do not belong to the definition are rejected; cells left out stay empty. The\n`matrix` key itself must always be present - send an empty object `{}` to attach the attribute with every cell\nleft empty." } } } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "create_label", "description": "Create a new label.\n\nCreates a label in the current organization; the created label's id is returned via resourceId, with no response body otherwise. The name is stored only for the context given by the context header, or your default context if omitted - other context are left unset until updated separately. Fails if a label with the same name already exists for that context.", "inputSchema": { "type": "object", "properties": { "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Text for the label in the context given by the context header, or your default context if omitted. Must be 3-1000 characters and unique among labels in that context." } }, "required": [ "name" ] } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "create_media_label", "description": "Create a custom type of media label.\n\nThe created label is always of type CUSTOM; the type cannot be chosen.", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Name of label." }, "mediaType": { "type": "string", "enum": [ "IMAGE", "VIDEO", "AUDIO", "TEXT", "DOCUMENT", "OTHER" ], "description": "Media type." } }, "required": [ "name" ] } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "create_product", "description": "Create new product.\n\nCreates a single new product and returns its generated internal ID in the `resource-id` response header. Fails\nif a product with the given number already exists, or if the organization's product quota would be exceeded.\nWhen creating a product of type `GROUP`, any variant-defining, locked or mandatory attribute must be configured\nto propagate to variants (`copy = true`); otherwise creation fails and lists the offending attribute definition\nIDs. To create a product by copying an existing one, use the copy endpoints instead.\n\nFor more detailed information on how to work with new products in Bluestone PIM, refer to our help pages [Create\nnew products](https://help.bluestonepim.com/add-new-products).", "inputSchema": { "type": "object", "properties": { "validation": { "type": "string", "enum": [ "NAME", "NUMBER" ], "description": "Validation is used for specifying whether `NUMBER`, or `NUMBER` and `NAME` must be\n unique. `NUMBER` is the default validation. If `NAME` is specified, both `NUMBER` and `NAME` must be\n unique. If no `number` parameter is supplied in the `body` of the request, the assigned `id` will be\n used as the `number`." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "assets": { "type": "array", "items": { "type": "string", "description": "A value specifying the list of product assets id." }, "description": "A value specifying the list of product assets id." }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "column": { "type": "object", "properties": {}, "description": "Column attribute values for product." }, "copy": { "type": "boolean", "description": "Variant copy flag." }, "definingAttributes": { "type": "boolean", "description": "Variant defining attributes flag." }, "definitionId": { "type": "string", "minLength": 1, "description": "Attribute definition ID for given value." }, "dictionary": { "type": "array", "items": { "type": "string", "description": "Dictionary attribute values for product." }, "description": "Dictionary attribute values for product." }, "locked": { "type": "boolean", "description": "Variant lock flag." }, "mandatory": { "type": "boolean", "description": "Variant mandatory flag." }, "matrix": { "type": "object", "properties": {}, "description": "Matrix attribute values for product." }, "values": { "type": "array", "items": { "type": "string", "description": "Attribute values for product." }, "description": "Attribute values for product." } }, "required": [ "definitionId" ], "description": "A value specifying the list of product attributes." }, "description": "A value specifying the list of product attributes." }, "categories": { "type": "array", "items": { "type": "string", "description": "A value specifying the list of product categories id." }, "description": "A value specifying the list of product categories id." }, "description": { "type": "string", "description": "A value specifying the product description." }, "labels": { "type": "array", "items": { "type": "string", "description": "A value specifying the list of product labels id." }, "description": "A value specifying the list of product labels id." }, "name": { "type": "string", "description": "A value specifying the product name." }, "number": { "type": "string", "description": "The product number. If omitted, the generated product ID is used as the number." }, "relatedProductsRelationSortingOrderSource": { "type": "string", "enum": [ "RELATION_DEFINITION", "PRODUCT" ], "description": "A value specifying selected sorting order source for related product relations." }, "type": { "type": "string", "enum": [ "SINGLE", "BUNDLE", "GROUP", "FAMILY" ], "description": "The product type. GROUP creates a product that holds variants; when GROUP is used, variant-defining attributes must be configured to propagate to variants (copy = true) or creation fails." } }, "required": [ "name" ] } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "create_product_connection", "description": "Relate a product to another product under a relation definition.\n\nCreates a single relation from the source product `id` to another product, using the relation\ndefinition (relation type) given in the request body. Fails if the source product, the target\nproduct, or the relation definition does not exist, or if the two products are already related\nunder that relation definition.\n\nFor more details on working with products and relations, refer to the [Add product\nrelations](https://help.bluestonepim.com/add-a-relation-to-a-product).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID of the source product the relation starts from.\n\n**Example:** `78y3566b5c65c1325edexx8f`" }, "body": { "type": "object", "properties": { "quantity": { "type": "number", "description": "Optional quantity to associate with the relation." }, "relationId": { "type": "string", "description": "The internal ID of the relation definition (the relation type) to create the relation under." }, "to": { "type": "string", "description": "The internal ID of the product to relate the source product to." } } } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "create_product_variant_group", "description": "Create variant group.\n\nPromotes the specified product to a variant group (changes its type from SINGLE to GROUP) so other products can\nlater be assigned to it as variants. This only turns the product into a group; it does not add any variants — use\nadd_product_variant to attach a product as a variant afterwards.\n\nFails if the product is not currently a SINGLE product (e.g. it is already a group or already a variant).\n\nFor more detailed information on how to work with variants and variant groups in Bluestone PIM, refer to our\nhelp pages [Create and connect variants](https://help.bluestonepim.com/create-and-connect-variants).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID of the product to turn into a variant group.\n\n**Example:** `634c26e14cedfd0001775e9f`" } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "create_publish_session", "description": "Create a new sync session.\n\nCreates an empty session that acts as a container for one publish/unpublish run, scoped to the given contexts. It does not accept product ids or start syncing by itself: add products with add_products_to_publish_session, then call complete_publish_session (PUT /session/{id}/done) to start processing them. Fails if the organization already has too many sessions pending at once — finish or cancel older sessions before creating new ones.", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "contexts": { "type": "array", "items": { "type": "string", "description": "Publication contexts (e.g. language codes) this session will sync, such as ['en', 'de']. Each must be an existing, non-archived context for this organization." }, "description": "Publication contexts (e.g. language codes) this session will sync, such as ['en', 'de']. Each must be an existing, non-archived context for this organization." } } } }, "required": [], "additionalProperties": false } }, { "name": "create_task", "description": "Create new task.\n\nUse to create a brand-new task. To modify an existing task's title, description, due date, or context use PUT /tasks/{taskId}; to reassign it use PUT /tasks/{taskId}/assign instead.", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "description": "Task title." }, "description": { "type": "string", "description": "Task description." }, "assignee": { "type": "string", "minLength": 1, "description": "Id of the user or user group to assign the task to." }, "assigneeType": { "type": "string", "enum": [ "user", "userGroup" ], "description": "Type of the assignee id above (default: user)." }, "dueDate": { "type": "string", "minLength": 1, "description": "Task due date, as an ISO-8601 offset date-time, e.g. 2026-07-06T10:00:00+02:00." }, "context": { "type": "string", "description": "Id of an existing organization translation context (language) to associate the task with; fails if the id does not match a known context." }, "isPrivate": { "type": "boolean", "description": "When true, the task is visible and editable only by its creator, assignee, and users holding the *_PRIVATE permission variant, instead of the standard permission holders." }, "assigneeReminderTime": { "type": "integer", "format": "int32", "minimum": 1, "description": "Hours before the due date to send a reminder notification to the assignee; omit for no reminder." }, "creatorReminderTime": { "type": "integer", "format": "int32", "minimum": 1, "description": "Hours before the due date to send a reminder notification to the creator; omit for no reminder." } }, "required": [ "title", "assignee", "dueDate" ] } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "delete_asset", "description": "Mark current asset as deleted.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset to delete." } }, "required": [ "assetId" ], "additionalProperties": false } }, { "name": "delete_asset_label", "description": "Removes given label from the asset's labels.\n\nRemoves only this one label; the asset's other labels are kept. To replace the whole set at once, use PUT /assets/{id}/labels.\n\n Deprecated. Sunset planned for 2026.09.11.\n\n Use DELETE /assets/labels/by-ids instead — pass a single-element `assetIds` list to\n remove the label from one asset. It returns 204 No Content.\n ", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset." }, "labelId": { "type": "string", "description": "Internal identifier for a label." } }, "required": [ "assetId", "labelId" ], "additionalProperties": false } }, { "name": "delete_catalog_node", "description": "Delete a catalog node (category) and its entire subtree.\n\nDeletes the node identified by `id` together with all of its descendant nodes, and unassigns every product from\nthe deleted node and its descendants (the products themselves are not deleted). Deleting a top-level node\nremoves the whole catalog tree. This cannot be undone.\n\nThe deletion runs as a background task: the call returns as soon as the task is scheduled, so the nodes may\nstill be readable for a moment afterwards. The task ID is returned in the `Resource-Id` response header and\n`Location` points at `GET /async/status/{taskId}`, which reports whether the deletion has finished.", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The internal ID for the catalog node/category you want to delete.\n\n**Example:** `634c26e14cedfd0001775e9f`" } }, "required": [ "catalogNodeId" ], "additionalProperties": false } }, { "name": "delete_catalog_node_attribute", "description": "Delete Category Level Attribute (CLA) from catalog node/category.\n\nRemoves the assignment from this category only: the attribute definition itself is untouched, products keep the\nvalues already propagated to them, and subcategories stop inheriting the attribute. An attribute inherited from\na parent category cannot be removed here - call this on the category it is assigned on, which\n`GET /catalogs/nodes/{id}/attributes` reports as `assignedOn`. Nothing is propagated, and the call also\nsucceeds when the category has no such attribute; it fails only when the attribute definition itself does not\nexist.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID of the catalog node/category from which the Category Level Attribute (CLA) will be deleted.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID of the attribute definition to be deleted from the catalog node/category.\n\n**Example:** `634c26e14cedfd0001775e9e`" } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "delete_label", "description": "Delete a label.\n\nPermanently deletes a label by id. Fails if the label id does not exist.", "inputSchema": { "type": "object", "properties": { "labelId": { "type": "string", "description": "Internal identifier for a label to delete." } }, "required": [ "labelId" ], "additionalProperties": false } }, { "name": "delete_product_asset", "description": "Detach an asset from a product, removing only the link between them.\n\nThe asset itself is not deleted and remains in the media bank; only its association with this product is\nremoved. Fails if the product does not exist or the asset is not associated with it.\n\nFor more information on assets in Bluestone PIM, refer to our help pages [Assets\noverview](https://help.bluestonepim.com/assets-panel).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product to detach the asset from.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "assetId": { "type": "string", "description": "The internal ID of the asset to detach from the product.\n\n**Example:** `fe5ad93b-35a5-4731-9eab-9d2cc9934f09`" } }, "required": [ "productId", "assetId" ], "additionalProperties": false } }, { "name": "delete_product_category", "description": "Unassigns a product from a single catalog category.\n\nThis removes only the link between the product and that one category; the product,\nthe category, and the product's other category assignments are left intact.\nFails if the product is not currently assigned to that category (it is not a silent no-op).\n\nFor more details on working with products and categories, refer to the [Product details\npanel>Categories](https://help.bluestonepim.com/product-details-overview#Categoriestab).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product to unassign.\n\n**Example:** `78y3566b5c65c1325edexx8f`" }, "categoryId": { "type": "string", "description": "The internal ID of the category to remove the product from.\n\n**Example:** `6226ba6acaa47e000czza91e`" } }, "required": [ "productId", "categoryId" ], "additionalProperties": false } }, { "name": "delete_product_connections", "description": "Remove every relation of one relation definition from a product.\n\nDeletes all relations that link the product `id` to other products under the relation definition `relationId`,\nin a single call. Use this to clear a whole relation type at once. To remove only specific related products,\ndelete a single pair with `DELETE /products/{id}/connections/products/{relationId}/{connectedProductId}`, or a\nselected subset with `DELETE /products/{id}/connections/products/{relationId}/bulk`.\n\nFor more details on working with products and\nrelations, refer to the [Add product relations](https://help.bluestonepim.com/add-a-relation-to-a-product).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID of the product whose relations are removed.\n\n**Example:** `78y3566b5c65c1325edexx8f`" }, "relationId": { "type": "string", "description": "The internal ID of the relation definition whose relations are all removed.\n\n**Example:** `78y3566b5c65c1325edexx8e`" } }, "required": [ "productId", "relationId" ], "additionalProperties": false } }, { "name": "delete_product_labels", "description": "Remove a set of labels from a product.\n\nDetaches the given labels from the product in one call; any listed label that is not currently\nassigned is ignored (it does not fail). Other labels on the product are left in place. Fails if\nthe product does not exist. To remove one label at a time use the single-label delete endpoint;\nto remove one label from many products at once use remove_label_from_products.\n\nFor more detailed information on how to work with product labels in Bluestone PIM,\nrefer to our help pages [Add/remove product labels](https://help.bluestonepim.com/bulk-actions#add-product-labels).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The ID of the product to remove the labels from." }, "body": { "type": "object", "properties": { "labelIds": { "type": "array", "items": { "type": "string", "description": "IDs of the labels to detach from the product; IDs not currently assigned are ignored. Between 1 and 100." }, "description": "IDs of the labels to detach from the product; IDs not currently assigned are ignored. Between 1 and 100." } }, "required": [ "labelIds" ] } }, "required": [ "productId", "body" ], "additionalProperties": false } }, { "name": "delete_product_variant", "description": "Unassign product variant.\n\nDetaches a variant from its variant group. The product is not deleted — it is disconnected from the group and\nreverts to a standalone SINGLE product.\n\nFails if the group product is not a variant group, or if the given product is not currently a variant of that\ngroup.\n\nFor more detailed information on how to work with the data model in Bluestone PIM, refer to our help\npages [The data model](https://help.bluestonepim.com/the-data-model).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID of the variant group the product is currently assigned to.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "variantProductId": { "type": "string", "description": "The internal ID of the variant to detach from the group.\n\n**Example:** `634c26e14cedfd0001775e9e`" } }, "required": [ "productId", "variantProductId" ], "additionalProperties": false } }, { "name": "delete_task_product", "description": "Delete product from task scope.\n\nRemoves the product-task association entirely, dropping the product out of the task's scope; use the complete/revoke endpoints instead if you only want to change its completion status without removing it. Fails if the product is not currently associated with the task, or if you are neither the task's creator nor hold the update permission — note that, unlike completing a product, the task's assignee alone cannot remove products.", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Id of the task to remove product from." }, "productId": { "type": "string", "description": "Id of the product to remove from task." } }, "required": [ "taskId", "productId" ], "additionalProperties": false } }, { "name": "find_asset_labels", "description": "Search for asset labels for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"contextFallback\":true,\"children\":[{\"termType\":\"name\",\"filterType\":\"contains\",\"context\":\"en\",\"value\":\"Hero image\"}]},\"sorting\":[{\"field\":\"name\",\"order\":\"asc\",\"context\":\"en\"}],\"paging\":{\"page\":0,\"pageSize\":20}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to AssetLabelQueryGroup omitted" }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } } }, "required": [ "matchRule", "children" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "context": { "type": "string" } }, "required": [ "field", "order" ] } }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "contextFallback": true, "children": [ { "termType": "name", "filterType": "contains", "context": "en", "value": "Hero image" } ] }, "sorting": [ { "field": "name", "order": "asc", "context": "en" } ], "paging": { "page": 0, "pageSize": 20 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "find_attribute_definition_ids", "description": "Search for attribute definitions for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"contextFallback\":true,\"children\":[{\"termType\":\"name\",\"filterType\":\"contains\",\"context\":\"en\",\"value\":\"Color\"}]},\"sorting\":[{\"field\":\"name\",\"order\":\"asc\",\"context\":\"en\"}],\"paging\":{\"page\":0,\"pageSize\":20}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to AttributeDefinitionQueryGroup omitted" }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } } }, "required": [ "matchRule", "children" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "context": { "type": "string" } }, "required": [ "field", "order" ] } }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "contextFallback": true, "children": [ { "termType": "name", "filterType": "contains", "context": "en", "value": "Color" } ] }, "sorting": [ { "field": "name", "order": "asc", "context": "en" } ], "paging": { "page": 0, "pageSize": 20 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "find_attribute_definitions", "description": "Search attribute definitions by a filter and return the matching ones as a paged list.\n\nEach filter in the\nrequest body selects definitions whose number matches one of the given values (`NUMBER_IN`) or whose ID matches\none of the given values (`ID_IN`); an empty or omitted filter list returns all definitions. Use this to look up\nspecific definitions by known numbers or IDs; to page through every definition without a filter, use the plain\nlist endpoint instead.\n\nFor more detailed information on managing attributes, refer to our help pages [Attribute\ntypes](https://help.bluestonepim.com/attribute-types-1).", "inputSchema": { "type": "object", "properties": { "excludeToBeRemoved": { "type": "boolean", "default": false, "description": "When `true`, definitions that are marked for removal (an async delete is in progress)\nare omitted from the result. Defaults to `false`, which keeps them." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." }, "body": { "type": "object", "properties": { "filters": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "NUMBER_IN", "ID_IN" ], "description": "Specifies the type of attribute definition filter. Available values are `NUMBER_IN`, `ID_IN`." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Specifies the set of values. The input of this field is used for filtering attribute definitions based on the\nselected filter type." } } }, "description": "Specifies the list of attribute definition filters. This field is used for filtering attribute definitions based\non various criteria." }, "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of items to return in each block. If omitted, the default value `1000` will be used. This parameter\nworks with the `page` parameter to paginate the result set, allowing you to control the size of each page of\nresults. The value must be between 1 and 1000.\n\n**Default value:** `1000`" }, "pageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "description": "A number sequence representing a block of items to return as a result set. If omitted, the default value `0`\nwill be used. This parameter is used for pagination to specify which page of the results to retrieve.\n\n**Default value:** `0`" } } } }, "required": [], "additionalProperties": false } }, { "name": "find_catalog_node_attributes", "description": "List Category Level Attributes (CLA) across all catalog nodes/categories.\n\nReturns one paginated entry per assignment - the category it is assigned on, the attribute definition and the\ncurrent value - so shared values can be reviewed catalog-wide without opening one category at a time. Only\ncategories the attribute is actually assigned on are listed: the ones that merely inherit it through\npropagation are not. Attribute definitions the caller has no access to are left out.\n\nTo see everything that applies to a single category, inherited attributes included, use\n`GET /catalogs/nodes/{id}/attributes` for that category. To find the categories using one particular attribute\ndefinition, use `GET /catalogs/nodes/attributeDefinition/{attributeDefinitionId}`.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "value": { "type": "string", "description": "Returns only attributes whose value contains this text, matched case-insensitively in the current\ncontext. Only simple attribute values are matched - column, matrix and dictionary values are ignored by this\nfilter." }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set. If omitted, the default value `0` will be used. This parameter is used for pagination to specify which page of the results to retrieve.\n\n**Default value:** `0`" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of items to return in each block. If omitted, the default value `1000` will be used. This parameter works with the `page` parameter to paginate the result set, allowing you to control the size of each page of results.\n\n**Default value:** `1000`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [], "additionalProperties": false } }, { "name": "find_catalog_node_children", "description": "List the direct child nodes (categories) of a catalog node.\n\nReturns a paginated list of the immediate children of the node identified by `id` (one level down, not the full\nsubtree). To list top-level catalogs instead of a node's children, use find_catalogs.", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The internal ID for the catalog node/category whose child nodes/categories you want to retrieve.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set. If omitted, the default value `0` will be used. This parameter is used for pagination to specify which page of the results to retrieve.\n\n**Default value:** `0`" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of items to return in each block. If omitted, the default value `1000` will be used. This parameter works with the `page` parameter to paginate the result set, allowing you to control the size of each page of results.\n\n**Default value:** `1000`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [ "catalogNodeId" ], "additionalProperties": false } }, { "name": "find_catalog_nodes_by_attribute_definition", "description": "List all catalog nodes/categories that use the attribute definition in a Category Level Attribute (CLA).\n\nReturns the paginated basic data of the categories the attribute definition is assigned on - not the CLA values,\nand not the categories that merely inherit it through propagation. Use it to see where a shared value is\ncontrolled from and how far a change or removal would reach. To read the values and flags of one category, use\n`GET /catalogs/nodes/{id}/attributes`; to list the assignments of every attribute definition at once, use\n`GET /catalogs/nodes/attributes`.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "attributeDefinitionId": { "type": "string", "description": "The internal ID for the attribute definition whose associated catalog\nnodes/categories you want to retrieve.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set. If omitted, the default value `0` will be used. This parameter is used for pagination to specify which page of the results to retrieve.\n\n**Default value:** `0`" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of items to return in each block. If omitted, the default value `1000` will be used. This parameter works with the `page` parameter to paginate the result set, allowing you to control the size of each page of results.\n\n**Default value:** `1000`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [ "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "find_catalogs", "description": "List top-level catalogs.\n\nReturns a paginated list of the catalogs (the root of each catalog tree), not the nodes inside them. To list a\nnode's child nodes use find_catalog_node_children; to get a whole catalog's category tree use the catalog's\nnodes endpoint.\n\nFor more detailed information on managing catalogs in Bluestone PIM, refer to the [Create and manage catalogs\nand categories](https://help.bluestonepim.com/catalogs-categories) article.", "inputSchema": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set. If omitted, the default value `0` will be used. This parameter is used for pagination to specify which page of the results to retrieve.\n\n**Default value:** `0`" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of items to return in each block. If omitted, the default value `1000` will be used. This parameter works with the `page` parameter to paginate the result set, allowing you to control the size of each page of results.\n\n**Default value:** `1000`" }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [], "additionalProperties": false } }, { "name": "find_categories", "description": "Search categories or catalogs for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"contextFallback\":true,\"children\":[{\"termType\":\"name\",\"filterType\":\"contains\",\"context\":\"en\",\"value\":\"Electronics\"}]},\"sorting\":[{\"field\":\"name\",\"order\":\"asc\",\"context\":\"en\"}],\"paging\":{\"page\":0,\"pageSize\":20}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to CategoryQueryGroup omitted" }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "categoryId" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "filterType", "value" ] } ] } ] } } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "categoryId" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "filterType", "value" ] } ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "context": { "type": "string" } }, "required": [ "field", "order" ] } }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "contextFallback": true, "children": [ { "termType": "name", "filterType": "contains", "context": "en", "value": "Electronics" } ] }, "sorting": [ { "field": "name", "order": "asc", "context": "en" } ], "paging": { "page": 0, "pageSize": 20 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "find_completeness_score_requirements", "description": "List requirements.\n\nReturns a paged list of requirement definitions configured for the organization, optionally filtered by id and/or requirement type. Each result includes the requirement's weight, its type-specific evaluation params, and its included/excluded category and product-type scoping. Use requirements/count instead if only the total count is needed.", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "sort": { "type": "object", "properties": { "sortDirection": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "Sort direction." }, "sortField": { "type": "string", "enum": [ "REQUIREMENT_TYPE", "WEIGHT" ], "description": "Sort field." } } }, "ids": { "type": "array", "items": { "type": "string", "description": "Ids of requirements to include. Combined with types (AND) when both are given; when omitted, no id filter is applied. If given, must contain at least one id." }, "description": "Ids of requirements to include. Combined with types (AND) when both are given; when omitted, no id filter is applied. If given, must contain at least one id." }, "types": { "type": "array", "items": { "type": "string", "enum": [ "ATTRIBUTE_HAS_VALUE", "MINIMUM_MEDIA_WITH_LABEL", "PERCENTAGE_OF_ATTRIBUTES_IN_GROUP_HAVE_VALUE", "IMAGE_WITH_LABEL_HAS_MINIMUM_RESOLUTION", "PERCENTAGE_OF_ATTRIBUTES_HAVE_VALUE", "MINIMUM_RELATION_CONNECTIONS", "IMAGE_WITH_LABEL_HAS_MINIMUM_DENSITY", "IMAGE_WITH_LABEL_HAS_DEEP_ETCH", "PRODUCT_ADDED_TO_CATEGORY" ], "description": "Types of requirements to include. Combined with ids (AND) when both are given; when omitted, no type filter is applied. If given, must contain at least one type." }, "description": "Types of requirements to include. Combined with ids (AND) when both are given; when omitted, no type filter is applied. If given, must contain at least one type." }, "pageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "description": "Size of a block of items to return. It corresponds with the page parameter. Defaults to 10 if omitted.", "example": 10 }, "page": { "type": "integer", "format": "int64", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set. Defaults to 0 (first page) if omitted.", "example": 0 } } } }, "required": [], "additionalProperties": false } }, { "name": "find_completeness_scores", "description": "Get scores.\n\nReturns a paged list of computed completeness scores (score value, validation status, last update dates), optionally filtered by context and/or entity id. Use for bulk retrieval across entities; for a single entity's per-requirement pass/fail breakdown use GET /scores/{entityId}/{context} instead. Entities with no computed score yet for the given filters are simply omitted from the results, not reported as an error.", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "contexts": { "type": "array", "items": { "type": "string", "description": "List of contexts to filter by, e.g. ['en']. When omitted, scores for all contexts are returned." }, "description": "List of contexts to filter by, e.g. ['en']. When omitted, scores for all contexts are returned." }, "entityIds": { "type": "array", "items": { "type": "string", "description": "List of entity ids to filter by. When omitted, scores for all entities are returned." }, "description": "List of entity ids to filter by. When omitted, scores for all entities are returned." }, "pageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "description": "Size of a block of items to return. It corresponds with the page parameter. Defaults to 10 if omitted.", "example": 10 }, "page": { "type": "integer", "format": "int64", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set. Defaults to 0 (first page) if omitted.", "example": 0 } } } }, "required": [], "additionalProperties": false } }, { "name": "find_context_definitions", "description": "List context definitions for the current organization.\n\nActive contexts are returned by default; pass contextState=ARCHIVE to list archived ones instead. To look up contexts by known names rather than by state, use \"List context definitions by names\" (POST /context/list/by-names).", "inputSchema": { "type": "object", "properties": { "contextState": { "type": "string", "default": "ACTIVE", "enum": [ "ACTIVE", "ARCHIVE" ], "description": "Filters by lifecycle state: ACTIVE (default) excludes archived contexts, ARCHIVE returns only archived ones." } }, "required": [], "additionalProperties": false } }, { "name": "find_context_definitions_by_names", "description": "List context definitions by names.", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string", "description": "Context names" }, "description": "Context names" } } } }, "required": [], "additionalProperties": false } }, { "name": "find_dictionary_attribute_definition_values", "description": "Search for dictionary values for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"contextFallback\":true,\"children\":[{\"termType\":\"name\",\"filterType\":\"contains\",\"context\":\"en\",\"value\":\"Red\"}]},\"sorting\":[{\"field\":\"name\",\"order\":\"asc\",\"context\":\"en\"}],\"paging\":{\"page\":0,\"pageSize\":20}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to DictionaryValueQueryGroup omitted" }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "definitionId" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "number" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] } ] } ] } } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "definitionId" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "number" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] } ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "context": { "type": "string" } }, "required": [ "field", "order" ] } }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "contextFallback": true, "children": [ { "termType": "name", "filterType": "contains", "context": "en", "value": "Red" } ] }, "sorting": [ { "field": "name", "order": "asc", "context": "en" } ], "paging": { "page": 0, "pageSize": 20 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "find_history_entries", "description": "Retrieve the history (audit log) events recorded for one specific entity instance.\n\nReturns a paginated list of history events for the entity identified by entityType and id, optionally narrowed with the query parameters below.\nUse GET /history/{entityType} to list events for all entities of that type instead of one id, or GET /history/{entityType}/{id}/count to get just the number of matching events.\nAn entityType or id that doesn't exist isn't an error: the result is simply an empty list.\nFor restricted users, only entityType PRODUCT, CATEGORY, or RULES_ENGINE can be queried, and only for entities within the user's assigned policies; anything else fails with no access to the entity.\n", "inputSchema": { "type": "object", "properties": { "entityType": { "type": "string", "minLength": 1, "description": "The type of the entity to retrieve history for, e.g. PRODUCT, CATEGORY, or ORGANIZATION, as recorded by the service that produced the event." }, "entityId": { "type": "string", "minLength": 1, "description": "The id of the specific entity instance to retrieve history for (the product, category, etc. whose changes are being looked up)." }, "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set." }, "pageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "description": "Size of a block of items to return. It corresponds with the page parameter." }, "eventType": { "type": "string", "description": "Filters to events of this type, e.g. CREATE, UPDATE, DELETE, ASSOCIATE, or DISASSOCIATE depending on the service that produced the event; not validated against a fixed list." }, "field": { "type": "string", "description": "Filters to events that changed this specific attribute/field of the entity, matching the field name shown in the event's metadata." }, "origin": { "type": "string", "description": "Filters to events produced by this originating service, e.g. bluestone-pim, bluestone-tasks, or bluestone-labels." }, "userId": { "type": "string", "description": "Filters to events performed by this user id." }, "fromTime": { "type": "integer", "format": "int64", "description": "Only includes events at or after this time, in epoch milliseconds." }, "toTime": { "type": "integer", "format": "int64", "description": "Only includes events at or before this time, in epoch milliseconds." }, "eventId": { "type": "string", "description": "Accepted but currently has no effect on the results - do not rely on it to fetch a single event." }, "metadataEntityId": { "type": "string", "description": "Filters to events whose metadata references this related entity id (e.g. a category or attribute referenced by a product change), distinct from the entity identified by the id path parameter." }, "contextId": { "type": "string", "description": "Filters to events in this context, e.g. 'en'; matches the context field on the event." } }, "required": [ "entityType", "entityId" ], "additionalProperties": false } }, { "name": "find_labels", "description": "List labels.\n\nLists labels for the current organization, paginated. Each label's name is resolved to the context given by the context header, or your default context if omitted; if no translation exists in that context, the organization's fallback context is used when context-fallback is enabled, otherwise name is null.", "inputSchema": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32", "minimum": 0, "default": 0, "description": "A number sequence representing a block of items to return as a result set." }, "pageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 1000, "description": "Size of a block of items to return. It corresponds with the page parameter." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [], "additionalProperties": false } }, { "name": "find_media_labels", "description": "Lists labels.", "inputSchema": { "type": "object", "properties": { "labelType": { "type": "string", "default": "CUSTOM", "enum": [ "CUSTOM", "TAG" ], "description": "Media label type to filter by; defaults to CUSTOM when omitted." }, "mediaType": { "type": "string", "enum": [ "IMAGE", "VIDEO", "AUDIO", "TEXT", "DOCUMENT", "OTHER" ], "description": "Assets media type." }, "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "Page to be returned.", "example": 0 }, "pageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "description": "Number of items to be returned.", "example": 100 } }, "required": [], "additionalProperties": false } }, { "name": "find_product_labels", "description": "Search for labels for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"contextFallback\":true,\"children\":[{\"termType\":\"name\",\"filterType\":\"contains\",\"context\":\"en\",\"value\":\"Summer\"}]},\"sorting\":[{\"field\":\"name\",\"order\":\"asc\",\"context\":\"en\"}],\"paging\":{\"page\":0,\"pageSize\":20}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to LabelQueryGroup omitted" }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } } }, "required": [ "matchRule", "children" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "context": { "type": "string" } }, "required": [ "field", "order" ] } }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "contextFallback": true, "children": [ { "termType": "name", "filterType": "contains", "context": "en", "value": "Summer" } ] }, "sorting": [ { "field": "name", "order": "asc", "context": "en" } ], "paging": { "page": 0, "pageSize": 20 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "find_products", "description": "Search for products for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"children\":[]},\"paging\":{\"page\":0,\"pageSize\":10}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "all", "any" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "all", "any" ] }, "children": { "type": "array", "items": { "type": "object", "description": "Circular reference to QueryGroupChild omitted" } }, "not": { "type": "boolean" } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "id" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is", "in" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name", "description" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "number" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "publishState" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "in" ] }, "value": { "type": "array", "items": { "type": "string", "enum": [ "TO_BE_PUBLISHED", "PUBLISHED", "TO_BE_UNPUBLISHED", "DRAFT" ] } } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "state" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "in" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "termType", "context", "filterType", "value" ], "deprecated": true }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "type" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "in" ] }, "value": { "type": "array", "items": { "type": "string", "enum": [ "BUNDLE", "SINGLE", "VARIANT", "GROUP", "FAMILY" ] } } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "validation_status" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string", "enum": [ "VALID", "INVALID" ] } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "papi_out_of_sync" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "boolean" } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "last_sync_state" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string", "enum": [ "SUCCESSFUL", "FAILED" ] } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "last_modified_by" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is", "is_current_user" ] }, "value": { "type": "string", "description": "Present only when filterType='is'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "assigned_assets" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "have_some", "have_all", "have_none", "greater_than", "smaller_than" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "number", "format": "double" } ] } }, "required": [ "termType", "filterType" ], "description": "With a value the term filters by asset id: 'have_some' matches a product assigned to any of the\ngiven assets, 'have_all' only a product assigned to every one of them. Without a value the term\nkeeps its counter meaning: has any, has none, more than, less than." }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "assigned_variant", "assigned_family", "bundle" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "have_some", "have_none", "greater_than", "smaller_than" ] }, "value": { "type": "number", "format": "double", "description": "Present only on greater_than / smaller_than" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "created_date", "updated_date" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "date_relative", "date_between" ] }, "unit": { "type": "string", "enum": [ "days_ago", "days_from_now" ] }, "value": { "type": "number", "format": "double", "description": "Present on filterType='date_relative'" }, "from": { "type": "number", "format": "double", "description": "Present on filterType='date_between'" }, "to": { "type": "number", "format": "double", "description": "Present on filterType='date_between'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "labels" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "have_some", "have_all", "have_none" ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Omitted when filterType='have_none'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "asset_labels" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "contains" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "termType", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "category" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "have_some", "have_all", "have_none" ] }, { "type": "string", "enum": [ "have_some_with_children", "have_all_with_children" ] } ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Omitted when filterType='have_none'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "relations" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is", "is_with_products", "have_none" ] }, "reverse": { "type": "boolean", "description": "Required when filterType in {is, is_with_products}" }, "value": { "type": "string", "description": "Required when filterType in {is, is_with_products}" }, "productIds": { "type": "array", "items": { "type": "string" }, "description": "Required when filterType='is_with_products'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "completeness_requirements" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "not_meet_all" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "required": [ "termType", "context", "filterType", "value" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "completeness_score" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "type": "string", "enum": [ "between" ] }, "from": { "type": "number", "format": "double" }, "to": { "type": "number", "format": "double" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "parent_family" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "in" ] }, { "type": "string", "enum": [ "have_none" ] } ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Variant family ids. Present only when filterType='in'" } }, "required": [ "termType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "parent_group" ] }, "not": { "type": "boolean" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "in" ] }, { "type": "string", "enum": [ "have_none" ] } ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Variant group ids. Present only when filterType='in'" } }, "required": [ "termType", "filterType" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "text", "multiline" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "formatted_text" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "string", "description": "Omitted for {assigned, defined}" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "pattern" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "contains", "is" ] } ] }, "value": { "type": "string", "description": "Omitted for {assigned, defined}" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "integer", "decimal" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "smaller_or_equal_than", "smaller_than", "greater_than", "greater_or_equal_than" ] }, { "type": "string", "enum": [ "between" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "in" ] }, { "type": "string", "enum": [ "have_some" ] } ] }, "value": { "anyOf": [ { "type": "number", "format": "double" }, { "type": "string" }, { "type": "array", "items": { "type": "number", "format": "double" } }, { "type": "array", "items": { "type": "string" } } ] }, "from": { "anyOf": [ { "type": "number", "format": "double" }, { "type": "string" } ] }, "to": { "anyOf": [ { "type": "number", "format": "double" }, { "type": "string" } ] } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "boolean" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "boolean", "description": "Omitted for {assigned, defined}" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "matrix", "column" ] }, "filterType": { "type": "string", "enum": [ "assigned" ] } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "dictionary", "multi_select" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "have_some", "have_all", "have_none" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Omitted for {assigned, defined}" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "single_select" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "have_some" ] } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "date", "date_time" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "date_relative", "date_between" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "number", "format": "double", "description": "Present on {is, date_relative}" }, "unit": { "type": "string", "enum": [ "days_ago", "days_from_now" ] }, "from": { "type": "number", "format": "double", "description": "Present on 'date_between'" }, "to": { "type": "number", "format": "double", "description": "Present on 'date_between'" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "attribute" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "attributeId": { "type": "string" }, "attributeType": { "type": "string", "enum": [ "time" ] }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "assigned" ] }, { "type": "string", "enum": [ "defined" ] }, { "type": "string", "enum": [ "between" ] }, { "type": "string", "enum": [ "is" ] } ] }, "value": { "type": "string", "description": "Present on 'is'" }, "from": { "type": "string", "description": "Present on 'between'" }, "to": { "type": "string", "description": "Present on 'between'" } }, "required": [ "termType", "context", "attributeId", "attributeType", "filterType" ] } ] } ] }, { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "all", "any" ] }, "children": { "type": "array", "items": { "type": "object", "description": "Circular reference to QueryGroupChild omitted" } }, "not": { "type": "boolean" }, "association": { "type": "string", "enum": [ "variant_group", "variant", "bundle", "product_in_bundle" ] } }, "required": [ "matchRule", "children", "association" ] } ] } }, "not": { "type": "boolean" }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter or by using the context-fallback header. The value from the header will override this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "anyOf": [ { "type": "object", "properties": { "context": { "type": "string", "description": "Context id" }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "termType": { "type": "string", "enum": [ "attribute" ] }, "attributeType": { "type": "string", "enum": [ "time", "date", "date_time", "text", "integer", "decimal", "formatted_text", "pattern", "multiline", "boolean", "multi_select", "single_select", "dictionary", "matrix", "column" ] }, "attributeId": { "type": "string" } }, "required": [ "context", "direction", "termType", "attributeType", "attributeId" ] }, { "type": "object", "properties": { "context": { "type": "string", "description": "Context id" }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "termType": { "type": "string", "enum": [ "name", "number", "type", "created_date", "updated_date" ] } }, "required": [ "context", "direction", "termType" ] } ] }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "children": [] }, "paging": { "page": 0, "pageSize": 10 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "find_relations", "description": "Search for relations for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"contextFallback\":true,\"children\":[{\"termType\":\"name\",\"filterType\":\"contains\",\"context\":\"en\",\"value\":\"Accessory\"}]},\"sorting\":[{\"field\":\"name\",\"order\":\"asc\",\"context\":\"en\"}],\"paging\":{\"page\":0,\"pageSize\":20}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to RelationQueryGroup omitted" }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "reverseName" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } ] } } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "reverseName" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] } ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "context": { "type": "string" } }, "required": [ "field", "order" ] } }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "contextFallback": true, "children": [ { "termType": "name", "filterType": "contains", "context": "en", "value": "Accessory" } ] }, "sorting": [ { "field": "name", "order": "asc", "context": "en" } ], "paging": { "page": 0, "pageSize": 20 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "find_select_attribute_definition_values", "description": "Search for select values for given query.\n\nBody example:\n{\"query\":{\"matchRule\":\"all\",\"contextFallback\":true,\"children\":[{\"termType\":\"name\",\"filterType\":\"contains\",\"context\":\"en\",\"value\":\"XL\"}]},\"sorting\":[{\"field\":\"name\",\"order\":\"asc\",\"context\":\"en\"}],\"paging\":{\"page\":0,\"pageSize\":20}}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "matchRule": { "type": "string", "enum": [ "any", "all" ] }, "not": { "type": "boolean" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "description": "Circular reference to SelectValueQueryGroup omitted" }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "definitionId" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] } ] } ] } } }, "required": [ "matchRule", "children" ] }, { "anyOf": [ { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "name" ] }, "not": { "type": "boolean" }, "context": { "type": "string", "description": "Context id" }, "filterType": { "anyOf": [ { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, { "type": "string", "enum": [ "is" ] }, { "type": "string", "enum": [ "defined" ] } ] }, "value": { "type": "string", "description": "Omitted when filterType='defined'" } }, "required": [ "termType", "context", "filterType" ] }, { "type": "object", "properties": { "termType": { "type": "string", "enum": [ "definitionId" ] }, "not": { "type": "boolean" }, "filterType": { "type": "string", "enum": [ "is" ] }, "value": { "type": "string" } }, "required": [ "termType", "filterType", "value" ] } ] } ] } }, "contextFallback": { "type": "boolean", "description": "The context fallback functionality is true by default and can be disabled using this parameter." } }, "required": [ "matchRule", "children" ] }, "sorting": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "name" ] }, "order": { "type": "string", "enum": [ "asc", "desc" ] }, "context": { "type": "string" } }, "required": [ "field", "order" ] } }, "paging": { "type": "object", "properties": { "pageSize": { "type": "number", "format": "double", "description": "Number of results per page, max 10000" }, "page": { "type": "number", "format": "double", "description": "Page number, starting from 0" } } } }, "required": [ "query" ], "example": { "query": { "matchRule": "all", "contextFallback": true, "children": [ { "termType": "name", "filterType": "contains", "context": "en", "value": "XL" } ] }, "sorting": [ { "field": "name", "order": "asc", "context": "en" } ], "paging": { "page": 0, "pageSize": 20 } } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "find_task_comments", "description": "List all comments with replies for given task.\n\nFails with the same permission-denied error whether the task does not exist or you simply lack comment access to it — the response does not distinguish the two. To add a new comment use POST /comments/{taskId}; to reply to a specific comment use POST /comments/{taskId}/{commentId}.", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Id of the task to list all its comments." } }, "required": [ "taskId" ], "additionalProperties": false } }, { "name": "find_users", "description": "Returns the list of users in the caller's organization.", "inputSchema": { "type": "object", "properties": { "fetchInactive": { "type": "boolean", "default": false, "description": "If this parameter is true endpoint will return only inactive users." }, "page": { "type": "number", "format": "double", "default": 0, "description": "Number of page. Default 0." }, "pageSize": { "type": "number", "format": "double", "default": 1000, "description": "Size of page. Default 1000." } }, "required": [], "additionalProperties": false } }, { "name": "get_asset_attributes", "description": "Get list of attributes associated to asset.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset." }, "page": { "type": "integer", "format": "int32", "minimum": 0, "default": 0 }, "pageSize": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 100 }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [ "assetId" ], "additionalProperties": false } }, { "name": "get_asset_views", "description": "Retrieve a single asset together with the requested views.\n\nTo fetch several assets at once, use POST /assets/views/by-ids.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset to describe." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." }, "body": { "type": "object", "properties": { "views": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string" }, "definitionIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] } ] } } } } }, "required": [ "assetId" ], "additionalProperties": false } }, { "name": "get_assets_views_by_ids", "description": "Show list of assets filtered by ids with details from given views.\n\nTo fetch a single asset, use POST /assets/{id}/views.", "inputSchema": { "type": "object", "properties": { "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." }, "body": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "description": "Ids of the assets to return (1–100 per request)." }, "description": "Ids of the assets to return (1–100 per request)." }, "views": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string" }, "definitionIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] }, { "type": "object", "properties": { "type": { "type": "string" } }, "required": [ "type" ] } ] } }, "order": { "type": "string", "enum": [ "NATURAL", "SPECIFIED" ], "description": "Order in which assets are presented. Default is NATURAL.\nNATURAL(order by mongo)\nSPECIFIED(order based on ids list order)." } } } }, "required": [], "additionalProperties": false } }, { "name": "get_async_task_status", "description": "Read the status of a background task.\n\nReturns the task's `status`, the number of items it has processed so far in `count`, and `errorMessage` when it\nended in an error. `status` is `WAITING` before the task starts and `EXECUTING` while it runs - both mean the\nwork is not finished yet - then `COMPLETED` on success or `ERROR` on failure; `TO_CANCEL`, `CANCELLED` and\n`EXPIRED` mean the task will not finish its work. Poll until the status is no longer `WAITING` or `EXECUTING`.\n\nUse it for every operation that answers with a task ID instead of doing the work in the request: archiving\nproducts in bulk, deleting a catalog node with its subtree, and the Category Level Attribute (CLA) operations\nunder `/catalogs/nodes/{id}/attributes`, which propagate values onto products in the background. Those\noperations return the ID in the `Resource-Id` response header and point `Location` at this path. Fails when no\ntask with that ID exists.\n\nFor more detailed information on how to work with product bulk actions in Bluestone PIM, refer to our help pages\n[Use product bulk actions](https://help.bluestonepim.com/bulk-actions).", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "The ID of the task, as returned in the `Resource-Id` response header of the operation that\nscheduled it.\n\n**Example:** `634c26e14cedfd0001775e9f`" } }, "required": [ "taskId" ], "additionalProperties": false } }, { "name": "get_attribute_definition", "description": "Show details of attribute definition.\n\nThis operation allows users to access metadata associated with an\nattribute definition such as its name and description. Fails if no attribute definition with the specified ID\nexists.\n\nFor more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the [Create,\nedit or remove attributes](https://help.bluestonepim.com/edit-attributes) article.", "inputSchema": { "type": "object", "properties": { "attributeDefinitionId": { "type": "string", "description": "The internal ID for the attribute definition you want to retrieve.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [ "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "get_catalog_node", "description": "Describe catalog node/category.\n\nThis endpoint allows you to retrieve details of a specific catalog node/category identified by its internal ID.\n\nFor more detailed information on how to work with catalog nodes/categories in Bluestone PIM, refer to our help\npages [Catalogs and categories](https://help.bluestonepim.com/catalogs-categories).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The internal ID for the catalog node you want to retrieve.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [ "catalogNodeId" ], "additionalProperties": false } }, { "name": "get_catalog_node_attributes", "description": "List the Category Level Attributes (CLA) of one catalog node/category.\n\nReturns every attribute that applies to the category: the ones assigned on it, plus the ones assigned on a\nparent category with propagation switched on. An attribute assigned on a parent without propagation stays on\nthat parent and is not listed, and when the same attribute is assigned both here and on a parent, the value of\nthis category is the one returned. Values come back in the requested context, in the field matching the\ndefinition type - `attributeValue` for the simple types, `column`, `matrix` or `dictionary` for the rest.\n\n`assignedOn` is the category the returned value is stored on; anything other than this category means the\nattribute is inherited and can only be removed on the category named there. `copySetOn`, `lockedSetOn` and\n`mandatorySetOn` are the categories that switched propagation, lock and mandatory on, and are empty while the\nflag is off - a flag switched on by a parent can only be switched off on that parent, and a parent's lock also\nblocks changing the value here.\n\nTo review CLA assignments across the whole catalog instead of one category, use\n`GET /catalogs/nodes/attributes`.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID of the catalog node/category for which attributes are being listed.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [ "catalogNodeId" ], "additionalProperties": false } }, { "name": "get_completeness_score", "description": "Get detailed scores for single entity.\n\nReturns the computed completeness score for one entity in one context, plus the pass/fail/invalid result for every requirement evaluated. Use for a single entity; for many entities at once use get_scores (POST /scores/list), which returns summary scores without the per-requirement breakdown. Returns the same payload as GET /requirements/entity/{entityId}/{context} — either can be used. Fails if no score has been computed yet for this entityId/context combination, which can also occur if the entity itself doesn't exist.", "inputSchema": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Id of the entity (product) to get the score for." }, "contextId": { "type": "string", "description": "Context the score was computed for, e.g. 'en'." } }, "required": [ "entityId", "contextId" ], "additionalProperties": false } }, { "name": "get_completeness_score_requirements", "description": "Get requirements for single entity.\n\nReturns the computed completeness score for one entity in one context, plus the pass/fail/invalid result for every requirement evaluated — the same payload as GET /scores/{entityId}/{context}, not the requirement definitions returned by POST /requirements/list. Fails if no score has been computed yet for this entityId/context combination, which can also occur if the entity itself doesn't exist.", "inputSchema": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Id of the entity (product) to get requirement results for." }, "contextId": { "type": "string", "description": "Context the score was computed for, e.g. 'en'." } }, "required": [ "entityId", "contextId" ], "additionalProperties": false } }, { "name": "get_context_definition", "description": "Get a single context definition by id.\n\nReturns the context whether it's active or archived — unlike the list endpoint, no state filter is applied here. Fails if no context with the given id exists in the caller's organization.", "inputSchema": { "type": "object", "properties": { "contextId": { "type": "string", "description": "The context's id (e.g. \"en\"), as returned in the id field of the list/get response — not its internalId." } }, "required": [ "contextId" ], "additionalProperties": false } }, { "name": "get_latest_platform_guidance_content", "description": "Retrieve the most recently updated indexed pages.\n\nRetrieve the most recently updated indexed pages.\nUse for \"what's new\" summaries, especially for release_notes, with optional source/content-type filters and optional since date.\n\nBody example:\n{\"limit\":10,\"sources\":[\"docs\"],\"contentTypes\":[\"release_notes\"],\"since\":\"2025-01-01\"}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "limit": { "type": "number", "format": "double", "minimum": 1, "maximum": 100, "description": "Maximum number of results to return.\nIf omitted, service default is used." }, "sources": { "type": "array", "items": { "type": "string" }, "description": "Optional source filter.\nUse source IDs configured in service config (for example: \"docs\")." }, "contentTypes": { "type": "array", "items": { "type": "string" }, "description": "Optional content type filter (for example: \"documentation\", \"release_notes\")." }, "since": { "type": "string", "description": "Optional lower bound for content update date/time.\nAccepts ISO date/time string." } }, "description": "Request payload for latest content retrieval without semantic search.", "example": { "limit": 10, "sources": [ "docs" ], "contentTypes": [ "release_notes" ], "since": "2025-01-01" } } }, "required": [], "additionalProperties": false } }, { "name": "get_platform_guidance_content_details", "description": "Retrieve full content by its ID.", "inputSchema": { "type": "object", "properties": { "contentId": { "type": "string", "description": "Id of the content you want to read details of." } }, "required": [ "contentId" ], "additionalProperties": false } }, { "name": "get_product", "description": "Show product details.\n\nReturns the full details of a single product by its internal ID, including its metadata, attributes,\ncategories, relations and assets. Fails if no product with the specified ID exists. For a lighter summary of a\nproduct without the full data set, use the product overview endpoint (`GET /products/{id}/overview`) instead.\n\nFor more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help\npages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product you want to retrieve.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "get_product_assets", "description": "Retrieve the IDs of the assets associated with a product, in their display order and paginated.\n\nReturns the asset IDs currently attached to the product; the asset content itself lives in the media bank and\nis not included. Fails if the product does not exist.\n\nFor more information on assets in Bluestone PIM, refer to our help pages [Assets\noverview](https://help.bluestonepim.com/assets-panel).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product whose assets you want to retrieve.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set. If omitted, the default value `0` will be used. This parameter is used for pagination to specify which page of the results to retrieve.\n\n**Default value:** `0`" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of items to return in each block. If omitted, the default value `1000` will be used. This parameter works with the `page` parameter to paginate the result set, allowing you to control the size of each page of results.\n\n**Default value:** `1000`" } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "get_product_attributes", "description": "Retrieve the attributes associated with a product.\n\nReturns the attribute values set on a single product, each keyed by its attribute definition ID. Fails if no\nproduct with the given ID exists.", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product whose attributes you want to retrieve.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "archiveState": { "type": "string", "description": "Specifies the archive state of the entity. The default value is `active`." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "contextFallback": { "type": "boolean", "description": "Specifies whether to enable the fallback mechanism for the context. If omitted, the default value `true` will be used. When set to `true`, the system will provide a default translation or relevant information if the requested context's specific translation is missing.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** Setting the `context-fallback` parameter to `false` disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing." } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "get_product_connections", "description": "List the relation definitions a product participates in, each with its direction(s).\n\nReturns one entry per relation definition attached to the product, each carrying the relation definition ID and\nthe direction(s) it applies in (`DIRECT`, `REVERSE`, or both). This lists which relation types the product uses,\nnot the products it is related to; to get the actual related products for a given relation definition and\ndirection, use `GET /products/{id}/connections/products/{relationId}`.\n\nFor more details on working with products and relations, refer to the [Add product\nrelations](https://help.bluestonepim.com/add-a-relation-to-a-product).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID of the product whose relation definitions are listed.\n\n**Example:** `78y3566b5c65c1325edexx8f`" }, "page": { "type": "integer", "format": "int32", "minimum": 0, "description": "A number sequence representing a block of items to return as a result set. If omitted, the default value `0` will be used. This parameter is used for pagination to specify which page of the results to retrieve.\n\n**Default value:** `0`" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of items to return in each block. If omitted, the default value `1000` will be used. This parameter works with the `page` parameter to paginate the result set, allowing you to control the size of each page of results.\n\n**Default value:** `1000`" } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "get_publish_session", "description": "Get sync session.\n\nUse this to poll a session's progress after closing it. A session moves through CREATED (open for adding products) -> INITIALIZED -> IN_PROGRESS -> a terminal status: PUBLISHED, PUBLISHED_WITH_ISSUES (finished, but see get_publish_session_report and the issue tools for what failed), CANCELLED, or FAILED. errorReports tracks the background generation of downloadable issue files and is unrelated to the summary counts returned by get_publish_session_report.", "inputSchema": { "type": "object", "properties": { "sessionId": { "type": "string" } }, "required": [ "sessionId" ], "additionalProperties": false } }, { "name": "get_publish_session_asset_issues", "description": "Get assets issues for the session.\n\nLists the individual assets (e.g. images or files) that failed while syncing this session, grouped by issue type. Use it to explain a PUBLISHED_WITH_ISSUES result at the asset level, once get_publish_session_report shows the session reached a terminal status. For product- or entity-level failures use get_publish_session_product_issues or get_publish_session_entity_issues instead.", "inputSchema": { "type": "object", "properties": { "sessionId": { "type": "string" } }, "required": [ "sessionId" ], "additionalProperties": false } }, { "name": "get_publish_session_entity_issues", "description": "Get entities issues for the session.\n\nLists the per-entity problems (e.g. categories or other non-product/asset entities) that went wrong while syncing this session, grouped by issue type. Use it to explain a PUBLISHED_WITH_ISSUES result at the entity level, once get_publish_session_report shows the session reached a terminal status. For product- or asset-specific failures use get_publish_session_product_issues or get_publish_session_asset_issues instead.", "inputSchema": { "type": "object", "properties": { "sessionId": { "type": "string" } }, "required": [ "sessionId" ], "additionalProperties": false } }, { "name": "get_publish_session_product_issues", "description": "Get products issues for the session.\n\nLists the individual products that failed or were skipped while syncing this session, grouped by issue type (e.g. version conflicts from a stale lastUpdate, or products that could not be published). Use it to explain a PUBLISHED_WITH_ISSUES result at the product level, once get_publish_session_report shows the session reached a terminal status. For asset- or entity-level failures use get_publish_session_asset_issues or get_publish_session_entity_issues instead.", "inputSchema": { "type": "object", "properties": { "sessionId": { "type": "string" } }, "required": [ "sessionId" ], "additionalProperties": false } }, { "name": "get_publish_session_report", "description": "Get a session report.\n\nReturns running totals for the session and can be called at any time, including while it is still IN_PROGRESS — counts simply reflect what has been processed so far. metrics/categoriesMetrics stay empty until the session starts pushing data for a context, and break the totals down per context. For the underlying per-product/asset/entity issues, use get_publish_session_product_issues, get_publish_session_asset_issues or get_publish_session_entity_issues instead.", "inputSchema": { "type": "object", "properties": { "sessionId": { "type": "string" } }, "required": [ "sessionId" ], "additionalProperties": false } }, { "name": "get_user", "description": "Returns the user. Fails if no user with that id exists in the caller's organization.", "inputSchema": { "type": "object", "properties": { "userId": { "type": "string", "description": "User id." } }, "required": [ "userId" ], "additionalProperties": false } }, { "name": "search_platform_guidance", "description": "Search indexed documentation by semantic meaning and keywords.\n\nSearch indexed documentation by semantic meaning and keywords.\nUse for targeted questions where you need the most relevant pages, with optional filtering by source and content type.\n\nBody example:\n{\"query\":\"Products\",\"limit\":10,\"sources\":[\"docs\"],\"contentTypes\":[\"documentation\"]}", "inputSchema": { "type": "object", "properties": { "body": { "type": "object", "properties": { "query": { "type": "string", "description": "Natural language query used to retrieve relevant documents." }, "limit": { "type": "number", "format": "double", "minimum": 1, "maximum": 100, "description": "Maximum number of results to return.\nIf omitted, service default is used." }, "sources": { "type": "array", "items": { "type": "string" }, "description": "Optional source filter.\nUse source IDs configured in service config (for example: \"docs\")." }, "contentTypes": { "type": "array", "items": { "type": "string" }, "description": "Optional content type filter (for example: \"documentation\", \"release_notes\")." } }, "required": [ "query" ], "description": "Request payload for semantic search.", "example": { "query": "Products", "limit": 10, "sources": [ "docs" ], "contentTypes": [ "documentation" ] } } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "update_asset_description", "description": "Update asset description.\n\n\n Deprecated. Sunset planned for 2026.09.11.\n\n Use PATCH /assets/{id} instead — it updates name, number, description, alpha-channel\n and clipping-path in a single atomic request and returns 204 No Content. Read the\n asset back via GET /assets/{id}.\n ", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset to update asset description." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "value": { "type": "string", "description": "Value to be applied on given attribute." } }, "required": [ "value" ] } }, "required": [ "assetId", "body" ], "additionalProperties": false } }, { "name": "update_asset_dictionary_attribute", "description": "Set values to dictionary asset's attribute\n\nFor a simple attribute use the /simple endpoint; for a select attribute use the /select endpoint.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset." }, "definitionId": { "type": "string", "description": "Dictionary attribute definition identifier." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "dictionaryIds": { "type": "array", "items": { "type": "string", "description": "Identifiers of the dictionary values to set (dictionary value ids, not their labels)." }, "description": "Identifiers of the dictionary values to set (dictionary value ids, not their labels)." } }, "required": [ "dictionaryIds" ] } }, "required": [ "assetId", "definitionId", "body" ], "additionalProperties": false } }, { "name": "update_asset_labels", "description": "Sets the assets labels attribute.\n\nReplaces the whole label set — this is not an append. To remove a single label instead, use DELETE /assets/{id}/labels/{labelId}.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset to set the assets labels." }, "body": { "type": "object", "properties": { "labelIds": { "type": "array", "items": { "type": "string", "description": "The complete set of label ids the asset should have; an empty list removes all labels." }, "description": "The complete set of label ids the asset should have; an empty list removes all labels." } }, "required": [ "labelIds" ] } }, "required": [ "assetId", "body" ], "additionalProperties": false } }, { "name": "update_asset_name", "description": "Update asset name.\n\n\n Deprecated. Sunset planned for 2026.09.11.\n\n Use PATCH /assets/{id} instead — it updates name, number, description, alpha-channel\n and clipping-path in a single atomic request and returns 204 No Content. Read the\n asset back via GET /assets/{id}.\n ", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset to update asset name." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "value": { "type": "string", "description": "Value to be applied on given attribute." } }, "required": [ "value" ] } }, "required": [ "assetId", "body" ], "additionalProperties": false } }, { "name": "update_asset_select_attribute", "description": "Set values to select asset's attribute\n\nFor a simple attribute use the /simple endpoint; for a dictionary attribute use the /dictionary endpoint.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset." }, "definitionId": { "type": "string", "description": "Select attribute definition identifier." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "selectIds": { "type": "array", "items": { "type": "string", "description": "Identifiers of the select attribute's options to set (option ids, not their labels)." }, "description": "Identifiers of the select attribute's options to set (option ids, not their labels)." } }, "required": [ "selectIds" ] } }, "required": [ "assetId", "definitionId", "body" ], "additionalProperties": false } }, { "name": "update_asset_simple_attribute", "description": "Set value to simple asset's attribute\n\nFor a select attribute use the /select endpoint; for a dictionary attribute use the /dictionary endpoint.", "inputSchema": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Internal identifier for an asset." }, "definitionId": { "type": "string", "description": "Simple attribute definition identifier." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "value": { "type": "string", "description": "Simple asset's attribute value." } }, "required": [ "value" ] } }, "required": [ "assetId", "definitionId", "body" ], "additionalProperties": false } }, { "name": "update_catalog_node", "description": "Partially update a catalog node's (category's) main details.\n\nUpdates only the fields present in the request body (name, number, description); omitted fields are left\nunchanged. Use this for a partial edit. To replace all of a node's details in one call, use the full-update PUT\non the same path instead.", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The internal ID for the catalog node/category you want to update.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "description": { "type": "object", "properties": { "value": { "type": "string", "description": "Nullable value for partial update." } } }, "name": { "type": "object", "properties": { "value": { "type": "string", "description": "Nullable value for partial update." } } }, "number": { "type": "string", "description": "Category number value." } } } }, "required": [ "catalogNodeId" ], "additionalProperties": false } }, { "name": "update_catalog_node_attribute", "description": "Update the value or the propagation, lock and mandatory flags of a Category Level Attribute (CLA) and schedule\npropagation task.\n\nAt least one of `attributeValue`, `copyAttribute`, `locked` and `mandatory` must be sent. This is the only\noperation that sets the three flags, whatever the definition type: `copyAttribute` switches propagation on, so\nthat the attribute and its value travel down to the sub-categories and their products; `locked` requires the\nproducts in the category to keep the CLA value; `mandatory` requires them to have a value at all.\n\nWorks both on an attribute assigned to this category and on one inherited from a parent category - updating an\ninherited attribute creates an assignment on this category that overrides it. Column, matrix and dictionary\nvalues cannot be changed here; use the `/column`, `/matrix` or `/dictionary/values` variants of this path for\nthose.\n\nFails when the attribute definition is assigned neither on this category nor on any of its parents, when a flag\nbeing sent was switched on by a parent category, when `locked` is sent for a column, matrix or compound\ndefinition, or when `forceCla` is combined with a compound definition. When a parent category has locked the\nattribute, a sent value is ignored without an error.\n\nThe change is stored on the category immediately, while applying it to products runs as a background task. That\ntask covers the products in this category, and the products in its sub-categories only while propagation is on\nfor this attribute. The task ID is returned in the `Resource-Id` response header and `Location` points at\n`GET /async/status/{taskId}`, which reports whether the propagation has finished.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID of the catalog node/category where the attribute value will be updated.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID of the attribute definition whose value will be updated.\n\n**Example:** `634c26e14cedfd0001775e9e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "attributeValue": { "type": "object", "properties": { "value": { "type": "string", "description": "Nullable value for partial update." } } }, "copyAttribute": { "type": "boolean", "description": "Propagation: when true, this attribute and its value are inherited by the subcategories of this category and\nby their products. Only the category that switched propagation on can change it." }, "locked": { "type": "boolean", "description": "Lock attribute value: when true, the attribute on products in the category must keep the CLA value for those\nproducts to be valid for synchronization. Not supported for column, matrix and compound definitions, which\nreject this field." }, "mandatory": { "type": "boolean", "description": "Make attribute value mandatory: when true, the attribute on products in the category must have a value for\nthose products to be valid for synchronization." } } } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "update_catalog_node_column_attribute", "description": "Update column Category Level Attribute (CLA) and schedule propagation task.\n\nExpects the complete set of column values: columns left out of `column` are cleared, so send every column that\nshould keep its value. Works both on a column attribute assigned to this category and on one inherited from a\nparent category, in which case a CLA overriding it is created on this category. The propagation and mandatory\nflags can be set here or with `PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}`, which handles\nthem for every definition type; `locked` is rejected because the lock flag is not supported for column\ndefinitions.\n\nFails when the attribute definition is assigned neither on this category nor on any of its parents, or when it\nis not a column definition. When a parent category has locked the attribute, the sent values are ignored without\nan error.\n\nThe change is stored on the category immediately, while applying it to products runs as a background task. That\ntask covers the products in this category, and the products in its sub-categories only while propagation is on\nfor this attribute. The task ID is returned in the `Resource-Id` response header and `Location` points at\n`GET /async/status/{taskId}`, which reports whether the propagation has finished.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID of the catalog node/category where the attribute value will be updated.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID of the attribute definition whose value will be updated.\n\n**Example:** `634c26e14cedfd0001775e9e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "column": { "type": "object", "properties": {}, "description": "New value per column, keyed by the column value ID taken from the attribute definition's restriction. This\nis the complete set to keep - columns left out are cleared." }, "copyAttribute": { "type": "boolean", "description": "Propagation: when true, this attribute and its value are inherited by the subcategories of this category and\nby their products. Only the category that switched propagation on can change it." }, "locked": { "type": "boolean", "description": "Not supported for column definitions - sending this field fails the request." }, "mandatory": { "type": "boolean", "description": "Make attribute value mandatory: when true, the attribute on products in the category must have a value for\nthose products to be valid for synchronization." } } } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "update_catalog_node_dictionary_attribute", "description": "Set values for dictionary Category Level Attribute (CLA) and schedule propagation task.\n\nReplaces the selected dictionary values with exactly the set sent in the body: values left out are unselected\nand an empty list clears the selection. The attribute is attached to the category first when it is not there\nyet, which makes `POST /catalogs/nodes/{id}/attributes/{attributeDefinitionId}/dictionary` optional. Fails\nwhen a value ID does not belong to this attribute definition or when the definition's limit on the number of\nselected values would be exceeded.\n\nThe selection is stored on the category immediately, while copying it onto products runs as a background task.\nThat task covers the products in this category, and the products in its sub-categories only while propagation is\non for this attribute. The task ID is returned in the `Resource-Id` response header and `Location` points at\n`GET /async/status/{taskId}`, which reports whether the propagation has finished.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID for the catalog node/category.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID for the attribute definition.\n\n**Example:** `634c26e14cedfd0001775e9e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "valueIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of the dictionary values to select. This is the complete set to keep - values not listed are unselected\nand an empty list clears the selection. Every ID must be a value of this attribute definition, and the\ndefinition's limit on the number of selected values applies." } } } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "update_catalog_node_matrix_attribute", "description": "Update matrix Category Level Attribute (CLA) and schedule propagation task.\n\nExpects the complete set of matrix values: cells left out of `matrix` are cleared, so send every cell that\nshould keep its value. Works both on a matrix attribute assigned to this category and on one inherited from a\nparent category, in which case a CLA overriding it is created on this category. The propagation and mandatory\nflags can be set here or with `PATCH /catalogs/nodes/{id}/attributes/{attributeDefinitionId}`, which handles\nthem for every definition type; `locked` is rejected because the lock flag is not supported for matrix\ndefinitions.\n\nFails when the attribute definition is assigned neither on this category nor on any of its parents, or when it\nis not a matrix definition. When a parent category has locked the attribute, the sent values are ignored without\nan error.\n\nThe change is stored on the category immediately, while applying it to products runs as a background task. That\ntask covers the products in this category, and the products in its sub-categories only while propagation is on\nfor this attribute. The task ID is returned in the `Resource-Id` response header and `Location` points at\n`GET /async/status/{taskId}`, which reports whether the propagation has finished.\n\nFor more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help\npages [Category Level Attributes (CLA)](https://help.bluestonepim.com/category-level-attributes).", "inputSchema": { "type": "object", "properties": { "catalogNodeId": { "type": "string", "description": "The ID of the catalog node/category where the attribute value will be updated.\n\n**Example:** `634c26e14cedfd0001775e9f`" }, "attributeDefinitionId": { "type": "string", "description": "The ID of the attribute definition whose value will be updated.\n\n**Example:** `634c26e14cedfd0001775e9e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "copyAttribute": { "type": "boolean", "description": "Propagation: when true, this attribute and its value are inherited by the subcategories of this category and\nby their products. Only the category that switched propagation on can change it." }, "locked": { "type": "boolean", "description": "Not supported for matrix definitions - sending this field fails the request." }, "mandatory": { "type": "boolean", "description": "Make attribute value mandatory: when true, the attribute on products in the category must have a value for\nthose products to be valid for synchronization." }, "matrix": { "type": "object", "properties": {}, "description": "New value per cell, keyed first by the column value ID and then by the row value ID, both taken from the\nattribute definition's restriction. This is the complete set to keep - cells left out are cleared." } } } }, "required": [ "catalogNodeId", "attributeDefinitionId" ], "additionalProperties": false } }, { "name": "update_label", "description": "Update a label.\n\nReplaces a label's name for one context only - the context given by the context header, or your default context if omitted - leaving that label's names in other contexts unchanged. Fails if the label id does not exist, or if another label already has the same name for that context.", "inputSchema": { "type": "object", "properties": { "labelId": { "type": "string", "description": "Internal identifier for a label to update." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "Text for the label in the context given by the context header, or your default context if omitted. Must be 3-1000 characters and unique among labels in that context." } }, "required": [ "name" ] } }, "required": [ "labelId", "body" ], "additionalProperties": false } }, { "name": "update_product", "description": "Update product main details, supports partial update.\n\nThis endpoint allows you to modify the name, number and/or the description of a product. Supports partial\nupdates.\n\nFor more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help\npages [Get started with Management API](https://help.bluestonepim.com/get-started-with-management-api).", "inputSchema": { "type": "object", "properties": { "productId": { "type": "string", "description": "The internal ID for the product you want to update.\n\n**Example:** `66159308bfa3207886a9d45e`" }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "description": { "type": "object", "properties": { "value": { "type": "string", "description": "Nullable value for partial update." } } }, "name": { "type": "object", "properties": { "value": { "type": "string", "description": "Nullable value for partial update." } } }, "number": { "type": "string", "description": "New product number. Omit to leave the current number unchanged." } } } }, "required": [ "productId" ], "additionalProperties": false } }, { "name": "update_products_attributes", "description": "Upsert the values of one attribute across many products in a single bulk operation.\n\nFor every product listed in the request (selected by ID, max 100) this sets the given values for the one\nattribute definition: products that already have the attribute get their values updated, products that do not\nhave it get the value inserted. Applies to a single attribute definition per call. Runs synchronously and\ncompletes before responding; it returns no body and no job to poll. Fails if any listed product ID does not\nexist.\n\nUse this to set attribute values in bulk, including on products that may not yet have the attribute assigned.\nThe sibling PUT on this same path only updates products that already have the attribute (and can be told to fail\nwhen it is missing); it never inserts. Prefer this upsert unless you specifically want that update-only behavior.", "inputSchema": { "type": "object", "properties": { "forceVla": { "type": "boolean", "default": false, "description": "Specifies whether to force the update of a variant level attribute (VLA) value down from a\n`VARIANT GROUP` product to all child `VARIANT` products.\n\nThis flag is only taken into consideration for `VARIANT GROUP` products and only where the attribute is\ncurrently set as a VLA on the `VARIANT GROUP` product.\n\nIf omitted, the default value `false` will be used which means that possible VLA values on a `VARIANT GROUP`\nproduct will not be enforced down to child `VARIANT` products.\n\nNote that `forceVla` flag is only taken into consideration when the attribute change will be an update operation\nbut not an add value (insert) operation on a `VARIANT` product.\n\nThis means that a child `VARIANT` product will get the new value if it does not have the attribute assigned or\nan attribute value defined even if `forceVla` is `false` while other child `VARIANT` products that already have\nan attribute value defined will be left unchanged.\n\nThis is because a `VARIANT` product without the attribute or without an attribute value defined is treated as an\nadd value (insert) operation while the other `VARIANT` products are treated as update operations.\n\nFor more detailed information on working with VLAs in Bluestone PIM, refer to our help pages [The data model -\nVariant Level Attribute (VLA)](https://help.bluestonepim.com/the-data-model#VLA)." }, "contextId": { "type": "string", "description": "Specifies the context in which to operate. If omitted, the default context `en` is used.\n\nIn Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.\n\nFor more detailed information on how context relates to language settings in Bluestone PIM, refer to the [Languages and Context documentation](https://help.bluestonepim.com/languages-and-context).\n\n**Note:** The default context is identified by the ID `\"en\"`. IDs for additional contexts begin with a lowercase `\"L\"`, **not** with the digit `\"1\"`, followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM." }, "body": { "type": "object", "properties": { "attributeDefinitionId": { "type": "string", "description": "Internal ID of the single attribute definition whose value is being set on the selected products." }, "attributeValues": { "type": "array", "items": { "type": "string", "description": "New values to set for the attribute on the selected products. Omit or pass an empty list to clear the value." }, "description": "New values to set for the attribute on the selected products. Omit or pass an empty list to clear the value." }, "productIds": { "type": "array", "items": { "type": "string", "description": "Internal IDs of the products to apply the change to; 1 to 100 IDs. The operation fails if any of them does not exist." }, "description": "Internal IDs of the products to apply the change to; 1 to 100 IDs. The operation fails if any of them does not exist." } }, "required": [ "attributeDefinitionId" ] } }, "required": [ "body" ], "additionalProperties": false } }, { "name": "update_task", "description": "Update task data.\n\nModifies an existing task's title, description, due date, or context. This is a partial update: any field left blank or omitted keeps its current value rather than being cleared. Fails if the task does not exist, or if you are neither its creator nor hold the update permission — the task's assignee alone cannot update it; use PUT /tasks/{taskId}/assign to reassign it, or the product/complete endpoints to progress it instead.", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Id of the task to update." }, "body": { "type": "object", "properties": { "title": { "type": "string", "description": "New title for the task." }, "description": { "type": "string", "description": "New description for the task." }, "dueDate": { "type": "string", "description": "New due date for the task, as an ISO-8601 offset date-time, e.g. 2026-07-06T10:00:00+02:00; values that fail to parse are silently ignored rather than failing the request." }, "context": { "type": "string", "description": "Id of the translation context (language) to associate the task with." } } } }, "required": [ "taskId" ], "additionalProperties": false } }, { "name": "update_task_assignee", "description": "Assign task.\n\nReassigns an existing task to a different user or user group; use POST /tasks to set the initial assignee when creating a task. Callable by the task's creator, its current assignee, or a user holding the assign permission. Fails if the target assignee (or user group) does not exist in the organization, or if the task itself does not exist.", "inputSchema": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Id of the task to assign." }, "body": { "type": "object", "properties": { "assignee": { "type": "string", "description": "Id of the user (or user group, if assigneeType is 'userGroup') to assign the task to." }, "assigneeType": { "type": "string", "enum": [ "user", "userGroup" ], "description": "Type of the assignee id above (default: user)." } } } }, "required": [ "taskId" ], "additionalProperties": false } } ] }