{"openapi":"3.0.1","info":{"title":"Bundle configurator","description":"Bluestone bundle configurator API - Manage bundle configurator rules to the organization\n Deprecated endpoints:
Uri | Method | Since | End of life |
|---|
","version":"1-apps"},"servers":[{"url":"api.test.bluestonepim.com/pre-config","description":"Default Server URL"}],"tags":[{"name":"Metadata","description":"Read metadata for PAPI sync."},{"name":"Settings","description":"Manage bundle configurator settings."},{"name":"Rules","description":"Manage bundle configurator rules."}],"paths":{"/settings":{"get":{"tags":["Settings"],"summary":"Get setting for org.","description":"Predefine in config for available accept keys.","operationId":"get","responses":{"200":{"description":"OK\n\nGet setting success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigSettingResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nNot found setting","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"put":{"tags":["Settings"],"summary":"Update setting for org.","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigSettingRequest"}}},"required":true},"responses":{"201":{"description":"Created\n\nUpdate setting success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigSettingResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules":{"get":{"tags":["Rules"],"summary":"Get rules for org.","description":"This endpoint is delivered in two versions simplified with accept header set to application/json and descriptive where accept header set to application/full+json.","operationId":"getRules","parameters":[{"name":"page","in":"query","description":"Page to be returned.","required":false,"allowEmptyValue":true,"schema":{"minimum":0,"type":"integer","format":"int32","nullable":true,"example":0,"default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","required":false,"allowEmptyValue":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","nullable":true,"example":10,"default":10}},{"name":"sortField","in":"query","description":"Sort field for retrieving the result.","required":false,"allowEmptyValue":true,"schema":{"type":"string","nullable":true,"default":"id","enum":["id","name","active"]},"example":"id"},{"name":"sortDirection","in":"query","description":"Number of items to be returned.","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":"desc","enum":["asc","desc"]},"example":"desc"},{"name":"active","in":"query","description":"Filter if rule is active.","required":false,"allowEmptyValue":true,"schema":{"type":"boolean","nullable":true,"default":true}},{"name":"name","in":"query","description":"Rule name.","required":false,"allowEmptyValue":true,"schema":{"type":"string","nullable":true}},{"name":"product","in":"query","description":"Linked product ids.","required":false,"allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"category","in":"query","description":"Linked category ids.","required":false,"allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"mainProduct","in":"query","description":"Linked main product ids.","required":false,"allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"mainCategory","in":"query","description":"Linked main category ids.","required":false,"allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"serviceProduct","in":"query","description":"Linked service product ids.","required":false,"allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"customerGroup","in":"query","description":"Linked customer group ids.","required":false,"allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"customerProfile","in":"query","description":"Linked customer profile ids.","required":false,"allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"context","in":"header","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.","schema":{"type":"string"}},{"name":"context-fallback","in":"header","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.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK\n\nList rules success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleListResponse"}},"application/full+json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Create rule for org.","operationId":"create_1","parameters":[{"name":"context","in":"header","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.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleRequest"}}},"required":true},"responses":{"201":{"description":"Created\n\nCreate rule success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/refresh":{"post":{"tags":["Rules"],"summary":"Refresh categories in rule for org.","operationId":"refreshCategory","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Specify category type to rule","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK\n\nRefresh categories in rule success"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/products":{"get":{"tags":["Rules"],"summary":"Get products link with rules for org.","operationId":"getProduct","parameters":[{"name":"id","in":"path","description":"Rules Id.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to be returned.","required":false,"allowEmptyValue":true,"schema":{"minimum":0,"type":"integer","format":"int32","nullable":true,"example":0,"default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","required":false,"allowEmptyValue":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","nullable":true,"example":10,"default":10}},{"name":"type","in":"query","description":"Specify product type to rule.","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":"main"}},{"name":"active","in":"query","description":"Provide active filter to main/linked entity to rule.","required":false,"schema":{"type":"boolean","nullable":true}}],"responses":{"200":{"description":"OK\n\nList product success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleProductDisOrAssociateListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Link any products to rule for org.","operationId":"linkProduct","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Specify product type to rule.","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":"main"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleProductRequest"}}},"required":true},"responses":{"201":{"description":"Created\n\nLink product to rule success"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rules"],"summary":"Unlink any products from rule for org.","operationId":"unlinkProduct","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Specify product type to rule.","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":"main"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleProductRequest"}}},"required":true},"responses":{"204":{"description":"No Content\n\nUnlink product to rule success"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/customerProfiles":{"get":{"tags":["Rules"],"summary":"Get customer profiles link with rules for org.","operationId":"getCustomerProfile","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to be returned.","required":false,"allowEmptyValue":true,"schema":{"minimum":0,"type":"integer","format":"int32","nullable":true,"example":0,"default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","required":false,"allowEmptyValue":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","nullable":true,"example":10,"default":10}},{"name":"active","in":"query","description":"Provide active filter to main/linked entity to rule.","required":false,"schema":{"type":"boolean","nullable":true}},{"name":"context","in":"header","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.","schema":{"type":"string"}},{"name":"context-fallback","in":"header","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.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK\n\nList customer profile success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleDisOrAssociateWithAttributesListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Link any customer profile to rule for org.","operationId":"linkCustomerProfile","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleCustomerProfileRequest"}}},"required":true},"responses":{"201":{"description":"Created\n\nLink customer profile to rule success","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/customerProfiles/{profileId}/attributes":{"get":{"tags":["Rules"],"summary":"Get customer profile attributes.","operationId":"getCustomerProfileAttributes","parameters":[{"name":"id","in":"path","description":"Id of the rule.","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Id of customer profile.","required":true,"schema":{"minLength":1,"type":"string"}},{"name":"context","in":"header","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.","schema":{"type":"string"}},{"name":"context-fallback","in":"header","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.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK\n\nSuccessfully retrieved customer profile attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleAttributesResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule or profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Upsert customer profile attributes.","operationId":"upsertCustomerProfileAttributes","parameters":[{"name":"id","in":"path","description":"Id of the rule.","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Id of customer profile.","required":true,"schema":{"minLength":1,"type":"string"}},{"name":"context","in":"header","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.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertAttributesRequest"}}},"required":true},"responses":{"200":{"description":"OK\n\nSuccessfully upsert customer profile attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleAttributesResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleProfileAttributesResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule or profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rules"],"summary":"Delete customer profile attributes.","operationId":"deleteCustomerProfileAttributes","parameters":[{"name":"id","in":"path","description":"Id of the rule.","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Id of customer profile.","required":true,"schema":{"minLength":1,"type":"string"}},{"name":"context","in":"header","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.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAttributesRequest"}}},"required":true},"responses":{"204":{"description":"No Content\n\nSuccessfully deleted customer profile attributes"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule or profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/customerGroups":{"get":{"tags":["Rules"],"summary":"Get customer groups link with rules for org.","operationId":"getCustomerGroup","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to be returned.","required":false,"allowEmptyValue":true,"schema":{"minimum":0,"type":"integer","format":"int32","nullable":true,"example":0,"default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","required":false,"allowEmptyValue":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","nullable":true,"example":10,"default":10}},{"name":"active","in":"query","description":"Provide active filter to main/linked entity to rule.","required":false,"schema":{"type":"boolean","nullable":true}},{"name":"context","in":"header","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.","schema":{"type":"string"}},{"name":"context-fallback","in":"header","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.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK\n\nList customer group success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleDisOrAssociateWithAttributesListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Link any customer group to rule for org.","operationId":"linkCustomerGroup","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleCustomerGroupRequest"}}},"required":true},"responses":{"201":{"description":"Created\n\nLink customer group to rule success","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/customerGroups/{groupId}/attributes":{"get":{"tags":["Rules"],"summary":"Get customer group attributes.","operationId":"getCustomerGroupAttributes","parameters":[{"name":"id","in":"path","description":"Id of the rule.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Id of customer group.","required":true,"schema":{"minLength":1,"type":"string"}},{"name":"context","in":"header","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.","schema":{"type":"string"}},{"name":"context-fallback","in":"header","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.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK\n\nSuccessfully retrieved customer group attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleAttributesResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule or group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Upsert customer group attributes.","operationId":"upsertCustomerGroupAttributes","parameters":[{"name":"id","in":"path","description":"Id of the rule.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Id of customer group.","required":true,"schema":{"minLength":1,"type":"string"}},{"name":"context","in":"header","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.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertAttributesRequest"}}},"required":true},"responses":{"200":{"description":"OK\n\nSuccessfully upsert customer group attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleAttributesResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleGroupAttributesResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule or group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rules"],"summary":"Delete customer group attributes.","operationId":"deleteCustomerGroupAttributes","parameters":[{"name":"id","in":"path","description":"Id of the rule.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Id of customer group.","required":true,"schema":{"minLength":1,"type":"string"}},{"name":"context","in":"header","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.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAttributesRequest"}}},"required":true},"responses":{"204":{"description":"No Content\n\nSuccessfully deleted customer group attributes"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule or group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/categories":{"get":{"tags":["Rules"],"summary":"Get categories link with rules for org.","operationId":"getCategory","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to be returned.","required":false,"allowEmptyValue":true,"schema":{"minimum":0,"type":"integer","format":"int32","nullable":true,"example":0,"default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","required":false,"allowEmptyValue":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","nullable":true,"example":10,"default":10}},{"name":"type","in":"query","description":"Specify category type to rule","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","description":"Provide active filter to main/linked entity to rule.","required":false,"schema":{"type":"boolean","nullable":true}}],"responses":{"200":{"description":"OK\n\nList category success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleCategoryDisOrAssociateListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Link any categories to rule for org.","operationId":"linkCategory","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Specify category type to rule","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleCategoryRequest"}}},"required":true},"responses":{"200":{"description":"OK"},"201":{"description":"Created\n\nLink category to rule success"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rules"],"summary":"Unlink any categories from rule for org.","operationId":"unlinkCategory","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Specify category type to rule","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleCategoryRequest"}}},"required":true},"responses":{"204":{"description":"No Content\n\nUnlink category to rule success"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/attributes":{"get":{"tags":["Rules"],"summary":"Retrieves all attributes associated with the specified rule.","operationId":"getRuleAttributes","parameters":[{"name":"id","in":"path","description":"ID of the rule.","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","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":false,"schema":{"type":"string","default":"en"}},{"name":"context-fallback","in":"header","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":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK\n\nSuccessfully retrieved rule attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleAttributesResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Upsert rule's attributes for the specified rule.","operationId":"upsertRuleAttributes","parameters":[{"name":"id","in":"path","description":"ID of the rule.","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","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":false,"schema":{"type":"string","default":"en"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertAttributesRequest"}}},"required":true},"responses":{"200":{"description":"OK\n\nSuccessfully updated rule attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleAttributesResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rules"],"summary":"Deletes specified attributes from the rule.","operationId":"deleteRuleAttributes","parameters":[{"name":"id","in":"path","description":"ID of the rule.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAttributesRequest"}}},"required":true},"responses":{"204":{"description":"No Content\n\nSuccessfully deleted rule attributes"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/refresh":{"post":{"tags":["Rules"],"summary":"Refresh categories in all rules for org.","operationId":"refreshCategories","responses":{"200":{"description":"OK\n\nRefresh categories in all rules success"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/predefined-attributes":{"get":{"tags":["Rules"],"summary":"Get predefined attributes for organization.","operationId":"getPredefinedAttributes","parameters":[{"name":"scope","in":"query","description":"Scope of attributes","required":false,"schema":{"type":"string","default":"RULE","enum":["RULE","PROFILE","GROUP"]}}],"responses":{"200":{"description":"OK\n\nGet predefined attributes success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedAttributeResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]},"post":{"tags":["Rules"],"summary":"Upsert predefined attributes for organization.","operationId":"upsertPredefinedAttributes","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedAttributeRequest"}}},"required":true},"responses":{"200":{"description":"OK\n\nUpsert predefined attributes success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedAttribute"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}":{"get":{"tags":["Rules"],"summary":"Get rule for org by id.","description":"This endpoint is delivered in two versions simplified with accept header set to application/json and descriptive where accept header set to application/full+json.","operationId":"getById","parameters":[{"name":"id","in":"path","description":"Rules Id.","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","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.","schema":{"type":"string"}},{"name":"context-fallback","in":"header","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.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK\n\nGet rule success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleResponse"}},"application/full+json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}},"application/full+json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"delete":{"tags":["Rules"],"summary":"Remove rule for org by id.","operationId":"removeById","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content\n\nRemove rule success"},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]},"patch":{"tags":["Rules"],"summary":"Update rule for org by id.","operationId":"update","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"context","in":"header","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.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleRequest"}}},"required":true},"responses":{"200":{"description":"OK\n\nUpdate rule success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigRuleResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/metadata/product":{"get":{"tags":["Metadata"],"summary":"Get product metadata by timestamp to be published.","operationId":"getProduct_1","parameters":[{"name":"page","in":"query","description":"Page to be returned.","required":false,"allowEmptyValue":true,"schema":{"minimum":0,"type":"integer","format":"int32","nullable":true,"example":0,"default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","required":false,"allowEmptyValue":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","nullable":true,"example":10,"default":10}},{"name":"updatedAfter","in":"query","description":"Time in milliseconds.","required":false,"allowEmptyValue":true,"schema":{"type":"integer","format":"int64","nullable":true}}],"responses":{"200":{"description":"OK\n\nGet metadata success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigProductMetadataListResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/metadata/product/{productId}":{"get":{"tags":["Metadata"],"summary":"Get product metadata by id to be published.","operationId":"getProductById","parameters":[{"name":"productId","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK\n\nGet metadata by product id success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigProductMetadataSectionResponse"}}}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/customerProfiles/{profileId}":{"delete":{"tags":["Rules"],"summary":"Unlink any customer profiles from rule for org.","operationId":"unlinkCustomerProfile","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile Id.","required":true,"schema":{"minLength":1,"type":"string"}}],"responses":{"204":{"description":"No Content\n\nUnlink customer profiles to rule success","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/rules/{id}/customerGroups/{groupId}":{"delete":{"tags":["Rules"],"summary":"Unlink any customer groups from rule for org.","operationId":"unlinkCustomerGroup","parameters":[{"name":"id","in":"path","description":"Rule Id.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Group Id.","required":true,"schema":{"minLength":1,"type":"string"}}],"responses":{"204":{"description":"No Content\n\nUnlink customer groups to rule success","content":{}},"400":{"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found\n\nRule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreConfigErrorResponse"}}}}},"security":[{"oauth2":[]}]}}},"components":{"schemas":{"PreConfigSettingResponse":{"type":"object","properties":{"settings":{"title":"Unique identifier of the setting.","type":"object","additionalProperties":{"title":"Unique identifier of the setting.","type":"string","example":"{\"SERVICE_PRODUCT_CATALOG_ID\":\"catalogId\"}"},"example":{"SERVICE_PRODUCT_CATALOG_ID":"catalogId"}},"createdBy":{"title":"Created setting user.","type":"string"},"createdAt":{"title":"Created setting timestamp.","type":"string","format":"date-time"},"modifiedBy":{"title":"Latest modified setting user.","type":"string"},"modifiedAt":{"title":"Latest modified setting timestamp.","type":"string","format":"date-time"}}},"PreConfigSettingRequest":{"type":"object","properties":{"settings":{"title":"Unique identifier of the setting.","type":"object","additionalProperties":{"title":"Unique identifier of the setting.","type":"string","example":"{\"SERVICE_PRODUCT_CATALOG_ID\":\"catalogId\"}"},"nullable":true,"example":{"SERVICE_PRODUCT_CATALOG_ID":"catalogId"}}}},"LinkedCategory":{"title":"Accessory Category.","type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"}}},"LinkedCustomerGroupAttributes":{"title":"Customer group.","type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}}},"LinkedCustomerProfileAttributes":{"title":"Customer profile.","type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"},"attributes":{"type":"object","additionalProperties":{"type":"string"}}}},"LinkedProduct":{"title":"Accessory Product.","type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"}}},"LinkedServiceProduct":{"title":"Service Product.","type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"}}},"MainCategory":{"title":"Main Category.","type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"}}},"MainProduct":{"title":"Main Product.","type":"object","properties":{"id":{"type":"string"},"active":{"type":"boolean"}}},"PreConfigRuleResponse":{"type":"object","properties":{"id":{"title":"Rule id.","type":"string"},"name":{"title":"Rule name.","type":"string"},"description":{"title":"Rule description.","type":"string","nullable":true},"active":{"title":"Rule active status.","type":"boolean","nullable":true},"customIconAssetId":{"title":"Custom icon asset ID.","type":"string","nullable":true},"linkedServiceProducts":{"title":"List of service products link to rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkedServiceProduct"}},"linkedProducts":{"title":"List of accessory products link to rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkedProduct"}},"mainProducts":{"title":"List of main products link to rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/MainProduct"}},"mainCategories":{"title":"List of main categories link to rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/MainCategory"}},"linkedCategories":{"title":"List of accessory categories link to rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkedCategory"}},"customerProfiles":{"title":"List of customer profile link to rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkedCustomerProfileAttributes"}},"customerGroups":{"title":"List of customer group link to rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkedCustomerGroupAttributes"}},"createdBy":{"title":"Created rule user.","type":"string"},"createdAt":{"title":"Created rule timestamp.","type":"string","format":"date-time"},"modifiedBy":{"title":"Latest modified user.","type":"string"},"modifiedAt":{"title":"Latest modified rule timestamp.","type":"string","format":"date-time"},"priority":{"title":"Priority.","type":"integer","format":"int32"}}},"PreConfigRuleRequest":{"type":"object","properties":{"name":{"title":"Rule name.","type":"string","nullable":true},"description":{"title":"Rule description.","type":"string","nullable":true},"active":{"title":"Rule active status.","type":"boolean","nullable":true,"default":true},"customIconAssetId":{"title":"Custom icon asset ID.","type":"string","nullable":true},"priority":{"type":"integer","format":"int32","nullable":true}}},"PreConfigErrorResponse":{"type":"object","properties":{"message":{"type":"string"}}},"PreConfigRuleProductRequest":{"type":"object","properties":{"ids":{"title":"Product Ids.","type":"array","items":{"title":"Product Ids.","type":"string"}}}},"PreConfigRuleCustomerProfileRequest":{"type":"object","properties":{"ids":{"title":"List of customer profile association request","type":"array","items":{"$ref":"#/components/schemas/PreConfigRuleDisOrAssociateRequest"}}}},"PreConfigRuleDisOrAssociateRequest":{"type":"object","properties":{"id":{"title":"Customer group or profile id.","type":"string"}}},"PreConfigRuleAttributesResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"createdBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64","nullable":true},"modifiedBy":{"type":"string","nullable":true},"organizationId":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}}},"UpsertAttributesRequest":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}}},"description":"Attributes to upsert."},"PreConfigRuleProfileAttributesResponse":{"type":"object","properties":{"id":{"type":"string"},"profileId":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"createdBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64","nullable":true},"modifiedBy":{"type":"string","nullable":true},"organizationId":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}}},"PreConfigRuleCustomerGroupRequest":{"type":"object","properties":{"ids":{"title":"List of customer group association request","type":"array","items":{"$ref":"#/components/schemas/PreConfigRuleDisOrAssociateRequest"}}}},"PreConfigRuleGroupAttributesResponse":{"type":"object","properties":{"id":{"type":"string"},"groupId":{"type":"string"},"createdAt":{"type":"integer","format":"int64","nullable":true},"createdBy":{"type":"string","nullable":true},"modifiedAt":{"type":"integer","format":"int64","nullable":true},"modifiedBy":{"type":"string","nullable":true},"organizationId":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}}},"PreConfigRuleCategoryRequest":{"type":"object","properties":{"ids":{"title":"Category Ids.","type":"array","items":{"title":"Category Ids.","type":"string"}}}},"Attribute":{"type":"object","properties":{"type":{"type":"string","enum":["TEXT","BOOLEAN","MARKDOWN","NUMBER","DATETIME","SINGLE_SELECT","MEDIA"]},"name":{"type":"string"},"title":{"type":"string"},"defaultValue":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"selectOptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SelectOption"}},"helpText":{"type":"string","nullable":true},"readonly":{"type":"boolean"},"required":{"type":"boolean"},"section":{"type":"string","nullable":true}}},"PredefinedAttribute":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"scope":{"type":"string","enum":["RULE","PROFILE","GROUP"]},"createdAt":{"type":"integer","format":"int64"},"createdBy":{"type":"string"},"modifiedAt":{"type":"integer","format":"int64"},"modifiedBy":{"type":"string"},"organizationId":{"type":"string"}}},"SelectOption":{"type":"object","properties":{"text":{"type":"string"},"value":{"type":"object","additionalProperties":{"type":"string"}}}},"PredefinedAttributeRequest":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"scope":{"type":"string","enum":["RULE","PROFILE","GROUP"]}}},"PreConfigRuleListResponse":{"type":"object","properties":{"data":{"title":"List of rules","type":"array","items":{"$ref":"#/components/schemas/PreConfigRuleResponse"}},"total":{"title":"Total number of response.","type":"integer","format":"int64"}}},"PreConfigRuleProductDisOrAssociateListResponse":{"type":"object","properties":{"data":{"title":"List of rules which product disassociate/associate response.","type":"array","items":{"$ref":"#/components/schemas/PreConfigRuleProductDisOrAssociateResponse"}},"total":{"title":"Total number of rules which product disassociate/associate response.","type":"integer","format":"int64"}}},"PreConfigRuleProductDisOrAssociateResponse":{"type":"object","properties":{"id":{"title":"Product Id.","type":"string"},"active":{"title":"Product active status.","type":"boolean"},"type":{"$ref":"#/components/schemas/PreConfigRuleProductType"}}},"PreConfigRuleProductType":{"title":"Specify product type to rule.","type":"string","default":"main","enum":["main","linked","serviceproduct"]},"PreConfigRuleDisOrAssociateWithAttributesListResponse":{"type":"object","properties":{"data":{"title":"List of rules which disassociate/associate response for profile or group.","type":"array","items":{"$ref":"#/components/schemas/PreConfigRuleDisOrAssociateWithAttributesResponse"}},"total":{"title":"Total number of response for profile or group.","type":"integer","format":"int64"}}},"PreConfigRuleDisOrAssociateWithAttributesResponse":{"type":"object","properties":{"id":{"title":"Customer profile or group id.","type":"string"},"active":{"title":"Active flag.","type":"boolean"},"attributes":{"title":"Map of rule profile or group attributes with string keys and values","type":"object","additionalProperties":{"title":"Map of rule profile or group attributes with string keys and values","type":"string","example":"{\"additionalProp1\":\"attr-val-2\"}"},"nullable":true,"example":{"additionalProp1":"attr-val-2"}}}},"PreConfigRuleCategoryDisOrAssociateListResponse":{"type":"object","properties":{"data":{"title":"List of rules which category disassociate/associate response.","type":"array","items":{"$ref":"#/components/schemas/PreConfigRuleCategoryDisOrAssociateResponse"}},"total":{"title":"Total number of rules which category disassociate/associate response.","type":"integer","format":"int64"}}},"PreConfigRuleCategoryDisOrAssociateResponse":{"type":"object","properties":{"id":{"title":"Category Id.","type":"string"},"active":{"title":"Category active status.","type":"boolean"},"type":{"$ref":"#/components/schemas/PreConfigRuleCategoryType"}}},"PreConfigRuleCategoryType":{"title":"Specify category type to rule.","type":"string","default":"main","enum":["main","linked"]},"AttributeResponse":{"type":"object","properties":{"type":{"type":"string","enum":["TEXT","BOOLEAN","MARKDOWN","NUMBER","DATETIME","SINGLE_SELECT","MEDIA"]},"name":{"type":"string"},"title":{"type":"string"},"defaultValue":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"selectOptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SelectOptionResponse"}},"helpText":{"type":"string","nullable":true},"readonly":{"type":"boolean"},"required":{"type":"boolean"},"section":{"type":"string","nullable":true}}},"PredefinedAttributeResponse":{"type":"object","properties":{"attributes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/AttributeResponse"}},"scope":{"type":"string","nullable":true,"enum":["RULE","PROFILE","GROUP"]},"createdAt":{"type":"integer","format":"int64","nullable":true},"createdBy":{"type":"string","nullable":true},"modifiedAt":{"type":"integer","format":"int64","nullable":true},"modifiedBy":{"type":"string","nullable":true}}},"SelectOptionResponse":{"type":"object","properties":{"text":{"type":"string"},"value":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}}},"PreConfigDisOrAssociateMetadataResponse":{"type":"object","properties":{"id":{"title":"Customer profile or group id.","type":"string"}}},"PreConfigMetadata":{"type":"object","properties":{"id":{"title":"Rule id.","type":"string"},"name":{"title":"Rule name.","type":"string"},"description":{"title":"Rule description.","type":"string","nullable":true},"customIconAssetId":{"title":"Custom icon asset ID of the rule.","type":"string","nullable":true},"priority":{"title":"Rule display priority.","type":"integer","format":"int32","nullable":true},"serviceProducts":{"title":"Service product ids assigned to the rule.","type":"array","nullable":true,"items":{"type":"string"}},"linkedProducts":{"title":"Accessory product ids assigned to the rule.","type":"array","nullable":true,"items":{"type":"string"}},"linkedCategories":{"title":"Accessory category ids assigned to the rule.","type":"array","nullable":true,"items":{"type":"string"}},"customerProfiles":{"title":"Customer profiles assigned to the rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/PreConfigDisOrAssociateMetadataResponse"}},"customerGroups":{"title":"Customer groups assigned to the rule.","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/PreConfigDisOrAssociateMetadataResponse"}}}},"PreConfigProductMetadataListResponse":{"type":"object","properties":{"data":{"title":"List of entities which rules attached","type":"array","items":{"$ref":"#/components/schemas/PreConfigProductMetadataResponse"}}}},"PreConfigProductMetadataResponse":{"type":"object","properties":{"id":{"title":"Product Id.","type":"string","description":"Main product id that link to the rule."},"metadata":{"$ref":"#/components/schemas/PreConfigProductMetadataSectionResponse"}}},"PreConfigProductMetadataSectionResponse":{"type":"object","properties":{"preConfig":{"title":"List of rules.","type":"array","items":{"$ref":"#/components/schemas/PreConfigMetadata"}}}},"DeleteAttributesRequest":{"type":"object","properties":{"attributeKeys":{"type":"array","items":{"type":"string"}}},"description":"Keys of attributes to delete."},"ErrorResponse":{"type":"object","properties":{"status":{"title":"Error status code.","type":"integer","format":"int32"},"error":{"title":"General error description.","type":"string"},"errorDetails":{"title":"List of errors details.","type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}},"requestId":{"title":"Request ID used for logging.","type":"string"},"timestamp":{"title":"Error timestamp.","type":"integer","format":"int64"},"conflictingEntities":{"title":"Additional entity id list related to error","type":"array","items":{"$ref":"#/components/schemas/ConflictingEntity"}},"quotaLimitExceededDetails":{"title":"Additional details related to quota limit exceeded errors","type":"array","items":{"$ref":"#/components/schemas/LimitExceededDetails"}}}},"ErrorDetails":{"type":"object","properties":{"message":{"title":"Error message.","type":"string"},"field":{"title":"Error related field.","type":"string"},"rejectedValue":{"title":"Invalid value causing error.","type":"string"},"entityId":{"title":"Identifier of the entity related to the error.","type":"string"},"entityType":{"title":"Type of the entity related to the error.","type":"string"}}},"ConflictingEntity":{"type":"object","properties":{"entityId":{"title":"Identifier of the related entity causing the conflict","type":"string"},"entityType":{"title":"Type of the related entity causing the conflict","type":"string"}}},"LimitExceededDetails":{"type":"object","properties":{"message":{"title":"Detailed quota error message","type":"string"},"quota":{"title":"Unique quota identifier","type":"string"},"limit":{"title":"Allowed limit","type":"integer","format":"int32"},"entityId":{"title":"ID of the entity that violated the quota","type":"string","nullable":true},"entityType":{"title":"Type of the entity that violated the quota","type":"string","nullable":true}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://idp.test.bluestonepim.com/op/token","scopes":{"openid profile systemRoles permissions organization email name nickname":"All needed scopes."}}}}}},"x-amazon-apigateway-api-key-source":"AUTHORIZER"}