{"openapi":"3.0.1","info":{"title":"Algolia sync","description":"WebOn Search API\n <b><h1>Deprecated endpoints:</h1></b><table border=\"1px;\"><tr><th style=\"text-align: center; vertical-align: middle;\"><b><h3>Uri</b></h3></th><th><b>Method</b></th><th><b><h3>Since</h3></b></th><th><b><h3>End of life</h3></b></th></tr></table>","version":"1-apps"},"servers":[{"url":"api.test.bluestonepim.com/algolia-sync"}],"tags":[{"name":"Technical","description":"To get technical information."}],"paths":{"/technical/version":{"get":{"tags":["Technical"],"summary":"Show service version.","operationId":"presentVersion","responses":{"200":{"description":"Show service version."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/settings/attributes":{"post":{"tags":["Configuration"],"summary":"Add Attribute definitions to setting.","operationId":"addAttribute","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","default":"en"}}],"requestBody":{"description":"definitionRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDefinitionRequest"}}}},"responses":{"200":{"description":"Attribute definitions were added"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Attribute not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Configuration"],"summary":"Delete multiple attribute definitions from setting.","operationId":"removeMultipleAttributes","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","default":"en"}}],"requestBody":{"description":"attributeIds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAttributesRequest"}}}},"responses":{"200":{"description":"Attribute definition were deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/settings/metadata":{"post":{"tags":["Configuration"],"summary":"Add Metadata to setting.","operationId":"addMetaData","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","default":"en"}}],"requestBody":{"description":"Metadata request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaDataRequest"}}}},"responses":{"200":{"description":"Metadata were added"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Metadata not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/settings/copy":{"post":{"tags":["Configuration"],"summary":"Copy setting from provided context.","operationId":"copyConfiguration","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","default":"en"}}],"requestBody":{"description":"Copy configuration request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyConfigurationRequest"}}}},"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Can not find configuration"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/settings":{"get":{"tags":["Configuration"],"summary":"Get configuration.","operationId":"getConfiguration","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","default":"en"}}],"responses":{"200":{"description":"Configuration described","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]},"post":{"tags":["Configuration"],"summary":"Create new configurations.","operationId":"createConfiguration","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","default":"en"}}],"requestBody":{"description":"configuration request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationRequest"}}}},"responses":{"201":{"description":"Configuration setting created.","headers":{"Location":{"description":" Location URI (Uniform Resource Identifier). This field is the URI of the newly created resource.\n","schema":{"type":"string"}},"Resource-Id":{"description":"  Entity ID. The unique ID of the newly created resource.\n","schema":{"type":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Configuration"],"summary":"Delete configuration setting.","operationId":"deleteConfiguration","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","default":"en"}}],"responses":{"200":{"description":"Configuration setting deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Cannot delete Configuration setting"}},"security":[{"oauth2":[]}]},"patch":{"tags":["Configuration"],"summary":"Update configuration.","operationId":"updateConfiguration","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","default":"en"}}],"requestBody":{"description":"update configuration request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationRequest"}}}},"responses":{"200":{"description":"Update configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/settings/fix":{"post":{"tags":["Configuration"],"summary":"Cleanup non-existing categories.","operationId":"fixConfiguration","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","default":"en"}}],"responses":{"200":{"description":"Operation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/settings/attributes/{attributeDefinitionId}":{"delete":{"tags":["Configuration"],"summary":"Remove attribute definition from setting.","operationId":"removeAttribute","parameters":[{"name":"attributeDefinitionId","in":"path","description":"Attribute definition 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","default":"en"}}],"responses":{"200":{"description":"Attribute definition was removed"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/settings/metadata/{type}/{providerId}":{"delete":{"tags":["Configuration"],"summary":"Remove metadata from setting.","operationId":"removeMetadataProvider","parameters":[{"name":"providerId","in":"path","description":"Provider id.","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"Metadata type.","required":true,"schema":{"type":"string","enum":["PRODUCT","CATEGORY"]}},{"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","default":"en"}}],"responses":{"200":{"description":"Metadata was removed"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/differences/syncs/{syncId}/{entityType}":{"get":{"tags":["Difference"],"summary":"Get difference products.","operationId":"getDifferences","parameters":[{"name":"syncId","in":"path","description":"Sync id.","required":true,"schema":{"type":"string"}},{"name":"entityType","in":"path","description":"Entity type.","required":true,"schema":{"type":"string","default":"products"}},{"name":"diffType","in":"query","description":"Diff type.","schema":{"type":"string","enum":["ADD","CHANGE","DELETE"]}},{"name":"invalid","in":"query","schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Number of page.","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Size of page.","schema":{"type":"integer","format":"int32","default":10}},{"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","default":"en"}}],"responses":{"200":{"description":"Get difference entities successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Cannot get difference entities"}},"security":[{"oauth2":[]}]}},"/metadata/category":{"get":{"tags":["metadata"],"summary":"Retrieve all category's metadata providers of an organization.","operationId":"getCategoryMetadataProvider","responses":{"200":{"description":"Retrieve all category's metadata providers successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MetadataProviderApi"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/metadata":{"get":{"tags":["metadata"],"summary":"Retrieve all product's metadata providers of an organization.","operationId":"getMetadataProvider","responses":{"200":{"description":"Retrieve all product's metadata providers successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MetadataProviderApi"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/statistic/countries":{"get":{"tags":["Statistic"],"summary":"Get countries.","operationId":"getCountries","parameters":[{"name":"type","in":"query","description":"Type.","schema":{"type":"string","enum":["product","category","cms"]}},{"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","default":"en"}}],"responses":{"200":{"description":"Get countries successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountriesResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/statistic/noResultRate":{"get":{"tags":["Statistic"],"summary":"Get no result search rate.","operationId":"getNoResultRate","parameters":[{"name":"type","in":"query","description":"Type.","schema":{"type":"string","enum":["product","category","cms"]}},{"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","default":"en"}}],"responses":{"200":{"description":"Get no result search rate successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoResultRateResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/statistic/noResults":{"get":{"tags":["Statistic"],"summary":"Get Searches with 0 Results.","operationId":"getNoResultSearch","parameters":[{"name":"type","in":"query","description":"Type.","schema":{"type":"string","enum":["product","category","cms"]}},{"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","default":"en"}}],"responses":{"200":{"description":"Get Searches with 0 Results successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoResultSearchResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/statistic/popular":{"get":{"tags":["Statistic"],"summary":"Get Popular Searches.","operationId":"getPopularSearch","parameters":[{"name":"type","in":"query","description":"Type.","schema":{"type":"string","enum":["product","category","cms"]}},{"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","default":"en"}}],"responses":{"200":{"description":"Get Popular Searches successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PopularSearchResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/syncs/{id}":{"get":{"tags":["Syncs"],"summary":"Get sync.","operationId":"getSyncById","parameters":[{"name":"id","in":"path","description":"Sync 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","default":"en"}}],"responses":{"200":{"description":"Get sync data successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Cannot get sync data"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Syncs"],"summary":"Cancel sync.","operationId":"cancelSync","parameters":[{"name":"id","in":"path","description":"Sync id.","required":true,"schema":{"type":"string"}},{"name":"forceCancel","in":"query","schema":{"type":"boolean"}},{"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","default":"en"}}],"responses":{"200":{"description":"Cancel sync successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Cannot cancel sync"}},"security":[{"oauth2":[]}]}},"/syncs/state":{"get":{"tags":["Syncs"],"summary":"Get sync state.","operationId":"getSyncState","parameters":[{"name":"type","in":"query","description":"Type of sync.","schema":{"type":"string","default":"PIM","enum":["PIM","CMS"]}},{"name":"lastN","in":"query","description":"The last number of results.","schema":{"type":"integer","format":"int32","default":1}},{"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","default":"en"}}],"responses":{"200":{"description":"Get sync state successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSyncStateResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Cannot get sync state"}},"security":[{"oauth2":[]}]}},"/syncs":{"get":{"tags":["Syncs"],"summary":"List syncs.","operationId":"listSync","parameters":[{"name":"page","in":"query","description":"Number of page.","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Size of page.","schema":{"type":"integer","format":"int32","default":20}},{"name":"type","in":"query","description":"Type of sync.","schema":{"type":"string","enum":["PIM","CMS"]}},{"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","default":"en"}}],"responses":{"200":{"description":"List syncs successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Cannot list syncs"}},"security":[{"oauth2":[]}]},"post":{"tags":["Syncs"],"summary":"Generate sync report.","operationId":"syncGenerateReport","parameters":[{"name":"isForceClear","in":"query","description":"Force clear data flag.","schema":{"type":"boolean","default":false}},{"name":"type","in":"query","description":"Type of sync.","schema":{"type":"string","default":"PIM","enum":["PIM","CMS"]}},{"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","default":"en"}}],"responses":{"200":{"description":"Sync attributes from catalog successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden"},"500":{"description":"Cannot sync attributes from catalog"}},"security":[{"oauth2":[]}]}},"/syncs/{id}/publish":{"post":{"tags":["Syncs"],"summary":"Publish sync.","operationId":"publishSync","parameters":[{"name":"id","in":"path","description":"Sync 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","default":"en"}}],"responses":{"200":{"description":"Publish sync successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Cannot publish sync"}},"security":[{"oauth2":[]}]}}},"components":{"schemas":{"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"},"quotaLimitExceededDetails":{"title":"Additional entity id list related to error","type":"array","items":{"$ref":"#/components/schemas/QuotaLimitExceededDetails"}}}},"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"}}},"QuotaLimitExceededDetails":{"type":"object","properties":{"quota":{"title":"Quota name.","type":"string"},"message":{"title":"Quota limit message.","type":"string"},"limit":{"title":"Quota limit.","type":"integer","format":"int32"},"entityId":{"title":"Id of the entity that caused the quota limit to be exceeded.","type":"string","nullable":true},"entityType":{"title":"Type of the entity that caused the quota limit to be exceeded.","type":"string","nullable":true}}},"UpdateDefinitionRequest":{"type":"object","properties":{"attributeIds":{"title":"List of attribute Id.","type":"array","items":{"type":"string"}}}},"MetaDataRequest":{"type":"object","properties":{"metadata":{"title":"List of meta data Id.","type":"array","items":{"title":"List of meta data Id.","type":"string"}},"type":{"title":"Meta data type.","type":"string","enum":["PRODUCT","CATEGORY"]}}},"ConfigurationResponse":{"type":"object","properties":{"id":{"title":"Configuration Id.","type":"string"},"catalogs":{"title":"List of category Id.","type":"array","items":{"type":"string"}},"attributeIds":{"title":"List of attribute Id.","type":"array","items":{"type":"string"}},"metadataProviderIds":{"title":"List of meta data Id.","type":"array","items":{"type":"string"}},"categoryMetadataProviderIds":{"title":"List of category meta data Id.","type":"array","items":{"type":"string"}},"mediaType":{"type":"string"},"recordSizeLimit":{"type":"integer","format":"int32"},"attributeIdentifier":{"title":"Attribute identifier","type":"string","enum":["NUMBER","NAME"]},"syncRelationProducts":{"type":"boolean"},"automaticSync":{"type":"boolean"},"AlgoliaApplicationId":{"title":"Algolia application Id","type":"string"},"AlgoliaAdminAPIKey":{"title":"Algolia admin API key.","type":"string"},"AlgoliaAnalyticsAPIKey":{"title":"Algolia analytics API key","type":"string"},"AlgoliaIndexName":{"title":"Algolia index name.","type":"string"},"AlgoliaCategoryIndexName":{"title":"Algolia category index name.","type":"string"},"AlgoliaCmsIndexName":{"title":"Algolia CMS index name","type":"string"}}},"CopyConfigurationRequest":{"required":["contextId"],"type":"object","properties":{"contextId":{"title":"Copy from contextId.","type":"string"}}},"AttributeIdentifier":{"title":"Attribute Identifier.","type":"string","example":"NAME, NUMBER","enum":["NUMBER","NAME"]},"ConfigurationRequest":{"type":"object","properties":{"catalogs":{"title":"List of category Id.","type":"array","items":{"title":"List of category Id.","type":"string"}},"automaticSync":{"title":"Automatic sync.","type":"boolean"},"recordSizeLimit":{"title":"Limitation of sync data size in byte per a record.","maximum":2147483647,"minimum":10000,"type":"integer","format":"int32","example":10000},"mediaType":{"title":"Media type.","type":"string","example":"image,pdf,other"},"attributeIdentifier":{"$ref":"#/components/schemas/AttributeIdentifier"},"syncRelationProducts":{"type":"boolean"},"AlgoliaApplicationId":{"title":"Algolia application Id.","type":"string"},"AlgoliaAdminAPIKey":{"title":"Algolia admin API key.","type":"string"},"AlgoliaAnalyticsAPIKey":{"title":"Algolia analytics API key.","type":"string"},"AlgoliaIndexName":{"title":"Algolia index name.","type":"string"},"AlgoliaCategoryIndexName":{"title":"Algolia category index name.","type":"string"},"AlgoliaCmsIndexName":{"title":"Algolia CMS index name.","type":"string"}}},"DeleteAttributesRequest":{"type":"object","properties":{"attributeIds":{"title":"List of attribute Id.","type":"array","items":{"type":"string"}}}},"MetadataProviderApi":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["PRODUCT","CATEGORY"]},"host":{"type":"string"},"path":{"type":"string"},"alias":{"type":"string"}}},"CountriesResponse":{"type":"object","properties":{"countries":{"title":"List of country.","type":"array","items":{"$ref":"#/components/schemas/CountryResponse"}}}},"CountryResponse":{"title":"Country.","type":"object","properties":{"country":{"title":"Country.","type":"string"},"count":{"title":"Count.","type":"integer","format":"int32"}}},"NoResultRateResponse":{"type":"object","properties":{"rate":{"type":"number","format":"double"},"count":{"type":"integer","format":"int32"},"noResultCount":{"type":"integer","format":"int32"}}},"NoResultSearchResponse":{"type":"object","properties":{"searches":{"title":"List of top no result of search.","type":"array","items":{"$ref":"#/components/schemas/TopNoResultSearchResponse"}}}},"TopNoResultSearchResponse":{"title":"Top of no result of search.","type":"object","properties":{"search":{"title":"Search text.","type":"string"},"count":{"title":"Hit count.","type":"integer","format":"int32"},"withFilterCount":{"title":"Hit Count with filter.","type":"integer","format":"int32"}}},"PopularSearchResponse":{"type":"object","properties":{"searches":{"title":"List of top search.","type":"array","items":{"$ref":"#/components/schemas/TopSearchResponse"}}}},"TopSearchResponse":{"title":"Top search.","type":"object","properties":{"search":{"title":"Search text.","type":"string"},"count":{"title":"Hit count.","type":"integer","format":"int32"},"nbHits":{"title":"The total number of hits matching the search state.","type":"integer","format":"int32"}}},"GetSyncStateResponse":{"type":"object","properties":{"state":{"title":"Sync state.","type":"string","enum":["IDLE","INIT","REPORT_IN_PROGRESS","REPORT_READY","REPORT_FAILED","REPORT_CANCELED","PUBLISH_IN_PROGRESS","PUBLISH_FAILED","PUBLISH_DONE"]},"numberOfSyncedProduct":{"title":"Number of synced product.","type":"integer","format":"int64"},"numberOfSyncedCategory":{"title":"Number of synced category.","type":"integer","format":"int64"},"numberOfSyncedContent":{"title":"Number of synced content.","type":"integer","format":"int64"},"syncs":{"title":"List of sync.","type":"array","items":{"$ref":"#/components/schemas/SyncDb"}}}},"ObjectId":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date-time"}}},"SettingDb":{"type":"object","properties":{"catalogs":{"type":"array","items":{"type":"string"}},"algoliaChecksum":{"type":"string"},"attributeIds":{"type":"array","items":{"type":"string"}},"metadataProviderIds":{"type":"array","items":{"type":"string"}},"contextId":{"type":"string"},"syncRelationProducts":{"type":"boolean"}}},"SyncDb":{"title":"List of sync.","type":"object","properties":{"id":{"$ref":"#/components/schemas/ObjectId"},"type":{"type":"string","enum":["PIM","CMS"]},"state":{"type":"string","enum":["IDLE","INIT","REPORT_IN_PROGRESS","REPORT_READY","REPORT_FAILED","REPORT_CANCELED","PUBLISH_IN_PROGRESS","PUBLISH_FAILED","PUBLISH_DONE"]},"settings":{"$ref":"#/components/schemas/SettingDb"},"report":{"type":"array","items":{"$ref":"#/components/schemas/SyncReport"}},"messages":{"type":"array","items":{"type":"string"}},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"publishStartTime":{"type":"string","format":"date-time"},"publishEndTime":{"type":"string","format":"date-time"},"organizationId":{"type":"string"},"contextId":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"}}},"SyncReport":{"type":"object","properties":{"entityType":{"type":"string","enum":["PRODUCT","CATEGORY","CONTENT"]},"add":{"type":"integer","format":"int32"},"change":{"type":"integer","format":"int32"},"delete":{"type":"integer","format":"int32"},"ignore":{"type":"integer","format":"int32"}}}},"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"}