{"openapi":"3.0.1","info":{"title":"Relation attributes","description":"To manage relation attributes\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/relation"}],"tags":[{"name":"Technical","description":"To get technical information."},{"name":"Exports","description":"To manage export."},{"name":"Imports","description":"To manage import."},{"name":"Metadata","description":"To expose data to PAPI."},{"name":"Migration","description":"Internal data migrations."},{"name":"Product relations","description":"To manage product relation attributes."},{"name":"Relation definitions","description":"To manage relation definitions."},{"name":"Sessions","description":"To manage session."},{"name":"Settings","description":"To manage settings."},{"name":"Syncs","description":"To manage sync jobs."},{"name":"Test API","description":"To test purpose."}],"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":[]}]}},"/exports/{sessionId}/download":{"post":{"tags":["Exports"],"summary":"Generate presigned url for export report file.","operationId":"downloadExportFile","parameters":[{"name":"sessionId","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Generate presigned url for download export file successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/exports":{"post":{"tags":["Exports"],"summary":"Export product relation report.","operationId":"exportProductRelationReport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}}},"responses":{"200":{"description":"Initial export product relation report successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/imports/{sessionId}/download":{"post":{"tags":["Imports"],"summary":"Generate presigned url download for report file.","operationId":"downloadImportFile","parameters":[{"name":"sessionId","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}},{"name":"errorReport","in":"query","description":"Use an error report flag.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Generate presigned url for download successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadReportResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/imports/limit":{"get":{"tags":["Imports"],"summary":"Get import file limit.","operationId":"getImportLimit","responses":{"200":{"description":"Get import file limit successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportFileLimitResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/imports/{sessionId}/report":{"get":{"tags":["Imports"],"summary":"Get import report.","operationId":"getImportReport","parameters":[{"name":"sessionId","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get import report successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportReportResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/imports/{sessionId}/upload/done":{"post":{"tags":["Imports"],"summary":"Import upload file done.","operationId":"importUploadFileDone","parameters":[{"name":"sessionId","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Update session status successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/imports":{"post":{"tags":["Imports"],"summary":"Init import session.","operationId":"initImportSession","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitImportSessionRequest"}}}},"responses":{"200":{"description":"Init import session successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitSessionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/imports/{sessionId}/upload/read":{"post":{"tags":["Imports"],"summary":"Read import file.","operationId":"readImportFile","parameters":[{"name":"sessionId","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadImportFileRequest"}}}},"responses":{"200":{"description":"Read import file successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/imports/{sessionId}/import":{"post":{"tags":["Imports"],"summary":"Trigger import.","operationId":"triggerImport","parameters":[{"name":"sessionId","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Trigger import successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/imports/{sessionId}/update":{"patch":{"tags":["Imports"],"summary":"Update import session.","operationId":"updateImportSession","parameters":[{"name":"sessionId","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchImportSession"}}}},"responses":{"200":{"description":"Update import session successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/metadata/papiSync/{jobId}":{"get":{"tags":["Metadata"],"summary":"To get metadata job by id","operationId":"getMetadataJobyById","parameters":[{"name":"jobId","in":"path","description":"Metadata job id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get metadata job by id successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataJob"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Get metadata job by id error"}},"security":[{"oauth2":[]}]}},"/metadata/products/{id}":{"get":{"tags":["Metadata"],"summary":"Get products metadata by ID.","operationId":"getProductMetadataById","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"}},{"name":"id","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get products metadata by id successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductMetadata"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/metadata/papiSync/jobs":{"get":{"tags":["Metadata"],"summary":"To list metadata jobs","operationId":"listMetadataJobs","parameters":[{"name":"page","in":"query","description":"Page.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Page size.","schema":{"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"status","in":"query","description":"Status.","schema":{"$ref":"#/components/schemas/JobStatus"}},{"name":"sortDirection","in":"query","description":"Sort direction.","schema":{"type":"string","default":"desc"}}],"responses":{"200":{"description":"Metadata job listed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMetadataJobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Metadata job listed error"}},"security":[{"oauth2":[]}]}},"/metadata/products":{"get":{"tags":["Metadata"],"summary":"Get products metadata.","operationId":"listProductMetadata","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"}},{"name":"updatedAfter","in":"query","description":"Products updated after given date.(epoch time)","schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","schema":{"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Get products metadata successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductMetadataResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/metadata/papiSync":{"post":{"tags":["Metadata"],"summary":"To sync all data as metadata to PAPI Sync","operationId":"syncMetadata","responses":{"200":{"description":"Sync data successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataJob"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Sync data error"}},"security":[{"oauth2":[]}]}},"/products/{id}/attributes/bulk":{"post":{"tags":["Product relations"],"summary":"Bulk update relation attributes","operationId":"bulkUpdateRelationAttributes","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"}},{"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"}},{"name":"id","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateAttributesRequest"}}}},"responses":{"204":{"description":"Bulk update relation attributes successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/products/{id}/relatedProducts/count":{"post":{"tags":["Product relations"],"summary":"Count related products of a product by the given relation ids.","operationId":"countRelatedProducts","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"}},{"name":"id","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountRelatedProductsRequest"}}}},"responses":{"200":{"description":"Count related products successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/products/{id}/relations/{relationId}/attributes":{"get":{"tags":["Product relations"],"summary":"Get attributes of a product on relation level.","operationId":"listAttributeOfProductOnRelationLevel","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"}},{"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"}},{"name":"id","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}},{"name":"relationId","in":"path","description":"Relation Id.","required":true,"schema":{"type":"string"}},{"name":"reverse","in":"query","description":"Is relation in reverse to related object.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Get attributes of a product on relation level successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductRelationAttributeResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/products/{id}/relations":{"get":{"tags":["Product relations"],"summary":"List product relations.","operationId":"listProductRelations","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"}},{"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"}},{"name":"id","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to be returned.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","required":true,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"List product relations successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductRelationResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/products/{id}/relatedProducts/list":{"post":{"tags":["Product relations"],"summary":"Search related products of the given product id - default sort by product name asc.","operationId":"listRelatedProducts","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"}},{"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"}},{"name":"id","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRelatedProductsRequest"}}}},"responses":{"200":{"description":"List related products successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRelatedProductResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/products/{id}/relations/{relationId}/attributes/{attrDefId}":{"put":{"tags":["Product relations"],"summary":"Update attributes value for relation level.","operationId":"updateRelationAttributes","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"}},{"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"}},{"name":"id","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}},{"name":"relationId","in":"path","description":"Relation Id.","required":true,"schema":{"type":"string"}},{"name":"attrDefId","in":"path","description":"Attribute definition Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRelationAttributeRequest"}}}},"responses":{"204":{"description":"Update attributes value for relation level successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/products/{id}/relations/{relationId}/relatedProducts/{relatedProductId}/attributes/{attrDefId}":{"put":{"tags":["Product relations"],"summary":"Update attributes value for relation product level","operationId":"updateRelationProductAttributes","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"}},{"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"}},{"name":"id","in":"path","description":"Product Id.","required":true,"schema":{"type":"string"}},{"name":"relationId","in":"path","description":"Relation Id.","required":true,"schema":{"type":"string"}},{"name":"relatedProductId","in":"path","description":"Relation product Id.","required":true,"schema":{"type":"string"}},{"name":"attrDefId","in":"path","description":"Attribute definition Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRelationProductAttributeRequest"}}}},"responses":{"204":{"description":"Update attributes value for relation product level successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/relationDefinitions/relations/{id}/attributes":{"post":{"tags":["Relation definitions"],"summary":"Assign an attribute to relation on relation level or product level.","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"}},{"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"}},{"name":"id","in":"path","description":"Relation Id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignAttributeRequest"}}}},"responses":{"201":{"description":"Assign an attribute successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Relation not found or attribute definition not found/already assigned"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/relationDefinitions/relations/{id}":{"get":{"tags":["Relation definitions"],"summary":"Get relation definition by PIM relation id.","operationId":"getByRelationId","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"}},{"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"}},{"name":"id","in":"path","description":"Relation Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get relation definition successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationDefinitionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/relationDefinitions":{"get":{"tags":["Relation definitions"],"summary":"Get relation definitions.","operationId":"listRelationDefinitions","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"}},{"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"}},{"name":"page","in":"query","description":"Page to be returned.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Get relation definitions successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRelationDefinitionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/relationDefinitions/relations/{id}/attributes/{attrDefId}":{"put":{"tags":["Relation definitions"],"summary":"Update attribute value for relation attribute or product relation attribute.","operationId":"updateAttributeValue","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"}},{"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"}},{"name":"id","in":"path","description":"Relation Id.","required":true,"schema":{"type":"string"}},{"name":"attrDefId","in":"path","description":"Attribute definition Id.","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"Force update attribute value flag.","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAttributeRequest"}}}},"responses":{"204":{"description":"Update an attribute to relation or product relation successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Relation or attribute definition not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Relation definitions"],"summary":"Remove an attribute from relation on relation level or product level.","operationId":"removeAttribute","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"}},{"name":"id","in":"path","description":"Relation Id.","required":true,"schema":{"type":"string"}},{"name":"attrDefId","in":"path","description":"Attribute definition Id.","required":true,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Relation level.","schema":{"$ref":"#/components/schemas/RelationLevel"}}],"responses":{"204":{"description":"Remove an attribute successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/sessions/count":{"post":{"tags":["Sessions"],"summary":"Count session.","operationId":"countSession","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountSearchSessionRequest"}}}},"responses":{"200":{"description":"Count session successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountDataResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/sessions/{id}":{"get":{"tags":["Sessions"],"summary":"Get session by id.","operationId":"getSessionById","parameters":[{"name":"id","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get session by id successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]},"delete":{"tags":["Sessions"],"summary":"Delete session by id.","operationId":"deleteSession","parameters":[{"name":"id","in":"path","description":"Session Id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete session by id successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/sessions/list":{"post":{"tags":["Sessions"],"summary":"List session.","operationId":"listSessions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSearchSessionRequest"}}}},"responses":{"200":{"description":"List session successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSessionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/settings":{"get":{"tags":["Settings"],"summary":"Get settings","operationId":"getSettings","responses":{"200":{"description":"Get settings successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]},"post":{"tags":["Settings"],"summary":"Upsert settings","operationId":"upsertSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingRequest"}}}},"responses":{"200":{"description":"Upsert settings successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation errors"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/syncs":{"get":{"tags":["Syncs"],"summary":"List sync jobs sorted by newest.","operationId":"listSyncs","parameters":[{"name":"page","in":"query","description":"Page to be returned.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"pageSize","in":"query","description":"Number of items to be returned.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"List sync jobs successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSyncResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]},"post":{"tags":["Syncs"],"summary":"Create a sync job to add data for the existing relations, it can be used for fixing data when something are missing. Do not specify productIds to trigger full-sync.","operationId":"createSyncJob","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":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}}},"responses":{"201":{"description":"Create sync job successfully"},"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 status.","operationId":"findBySyncId","parameters":[{"name":"id","in":"path","description":"Sync Id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get sync status successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"security":[{"oauth2":[]}]}},"/test/products/{id}/attributes/bulk":{"get":{"tags":["Test API"],"summary":"Get all product relations (for testing with bulk update).","operationId":"getProductRelationsForTesting","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"}},{"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"}},{"name":"id","in":"path","description":"Internal identifier for a product.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get product relations successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductRelationsBulkTestResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error"}},"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}}},"AssetFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["HAVE_NONE","HAVE_ANY","HAVE_MORE_THAN","HAVE_LESS_THAN","ASSIGNED_TO_ANY","ASSIGNED_TO_ALL","NOT_HAVE_LABEL","HAVE_LABEL"]},"labelsIds":{"type":"array","items":{"type":"string"}},"assetCount":{"type":"integer","format":"int32"},"assetIds":{"type":"array","items":{"type":"string"}}}},"AttributeFilter":{"required":["attributeDefinitionId","type"],"type":"object","properties":{"type":{"type":"string","enum":["CONTAINS","NOT_CONTAINS","EQUALS","NOT_EQUALS","EMPTY","NOT_EMPTY","BETWEEN","NOT_BETWEEN","GREATER_THAN","GREATER_OR_EQUALS_TO","SMALLER_THAN","SMALLER_OR_EQUALS_TO","DOES_HAVE_SOME","DOESNT_HAVE_ANY","DOES_HAVE_ALL","DOESNT_HAVE_ALL","ASSOCIATED","NOT_ASSOCIATED","IN","DATE_RELATIVE"]},"attributeDefinitionId":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"unit":{"type":"string","enum":["DAYS_AGO","DAYS_FROM_NOW"]}}},"BaseFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["NAME_IS","NAME_CONTAINS","NAME_NOT_CONTAINS","NAME_STARTS_WITH","NAME_ENDS_WITH","NAME_EMPTY","NAME_NOT_EMPTY","NUMBER_IS","NUMBER_CONTAINS","NUMBER_NOT_CONTAINS","NUMBER_STARTS_WITH","NUMBER_ENDS_WITH","NUMBER_IN","DESCRIPTION_IS","DESCRIPTION_CONTAINS","DESCRIPTION_NOT_CONTAINS","DESCRIPTION_STARTS_WITH","DESCRIPTION_ENDS_WITH","DESCRIPTION_EMPTY","DESCRIPTION_NOT_EMPTY","ID_IN","NUMBER_NOT_IN","LAST_MODIFIED_BY_IS","LAST_MODIFIED_BY_CURRENT_USER"]},"values":{"type":"array","items":{"type":"string"}}}},"CategoryFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["IN_ANY_CHILD","IN_CATEGORY","WITHOUT_CATEGORY"]},"categoryId":{"type":"string"}}},"ColumnEnum":{"title":"Export column.","type":"string","enum":["PRODUCT_NAME","PRODUCT_NUMBER","PRODUCT_TYPE","ATTRIBUTE","LAST_UPDATE","CREATE_DATE"]},"CreateDateFilter":{"required":["dateMilis","type"],"type":"object","properties":{"type":{"type":"string","enum":["GREATER_EQUAL","LESS_EQUAL"]},"dateMilis":{"type":"integer","format":"int64"}}},"CreateDateRelativeFilter":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["DAYS_AGO"]},"value":{"type":"integer","format":"int64"}}},"ExportRequest":{"type":"object","properties":{"context":{"title":"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.","type":"string"},"fileName":{"title":"Export filename.","type":"string"},"criteria":{"$ref":"#/components/schemas/ExportRequestCriteria"}}},"ExportRequestCriteria":{"type":"object","properties":{"assetFilters":{"title":"List of asset filters.","type":"array","items":{"$ref":"#/components/schemas/AssetFilter"}},"attributeFilters":{"title":"List of attribute filters.","type":"array","items":{"$ref":"#/components/schemas/AttributeFilter"}},"baseFilters":{"title":"List of base filters.","type":"array","items":{"$ref":"#/components/schemas/BaseFilter"}},"attributeIdToSortBy":{"title":"Attribute id to sort by.","type":"string"},"categoryFilters":{"title":"List of category filters.","type":"array","items":{"$ref":"#/components/schemas/CategoryFilter"}},"column":{"$ref":"#/components/schemas/ColumnEnum"},"labelFilters":{"title":"List of label filters.","type":"array","items":{"$ref":"#/components/schemas/LabelFilter"}},"page":{"title":"Number of page.","type":"integer","format":"int32"},"pageSize":{"title":"Size of page.","type":"integer","format":"int32"},"productCreateDateFilter":{"title":"List of create date filters.","type":"array","items":{"$ref":"#/components/schemas/CreateDateFilter"}},"productCreateDateRelativeFilter":{"title":"List of create date relative filters.","type":"array","items":{"$ref":"#/components/schemas/CreateDateRelativeFilter"}},"productLastUpdateFilter":{"title":"List of last update filters.","type":"array","items":{"$ref":"#/components/schemas/LastUpdateFilter"}},"productLastUpdateRelativeFilter":{"title":"List of last update relative filters.","type":"array","items":{"$ref":"#/components/schemas/LastUpdateRelativeFilter"}},"publishStateFilter":{"$ref":"#/components/schemas/PublishStateFilter"},"relationsFilter":{"$ref":"#/components/schemas/RelationsFilter"},"scoreFilter":{"$ref":"#/components/schemas/ScoreFilter"},"scoreRequirementResultFilters":{"title":"List of score requirement result filters.","type":"array","items":{"$ref":"#/components/schemas/ScoreRequirementResultFilter"}},"sortDirection":{"$ref":"#/components/schemas/SortDirectionEnum"},"typeFilter":{"$ref":"#/components/schemas/TypeFilter"},"typesFilter":{"$ref":"#/components/schemas/TypesFilter"}}},"LabelFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["ALL","SOME","NOT","EMPTY"]},"labelsIds":{"type":"array","items":{"type":"string"}}}},"LastUpdateFilter":{"required":["dateMilis","type"],"type":"object","properties":{"type":{"type":"string","enum":["GREATER_EQUAL","LESS_EQUAL"]},"dateMilis":{"type":"integer","format":"int64"}}},"LastUpdateRelativeFilter":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["DAYS_AGO"]},"value":{"type":"integer","format":"int64"}}},"PublishStateFilter":{"required":["publishStates","type"],"type":"object","properties":{"type":{"type":"string","enum":["IN"]},"publishStates":{"type":"array","items":{"type":"string","enum":["PLAYGROUND_ONLY","TO_BE_PUBLISHED","CONNECTED","TO_BE_UNPUBLISHED","NOT_CONNECTED","TO_BE_ARCHIVED","ARCHIVED"]}}}},"RelationsFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["EMPTY","HAVE","NOT"]},"relationId":{"type":"string"},"productIds":{"type":"array","items":{"type":"string"}},"reverse":{"type":"boolean"}}},"ScoreFilter":{"required":["scores","type"],"type":"object","properties":{"type":{"type":"string","enum":["BETWEEN"]},"scores":{"type":"array","items":{"type":"number"}}}},"ScoreRequirementResultFilter":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["NOT_MEET_ALL"]},"requirementIds":{"type":"array","items":{"type":"string"}}}},"SortDirectionEnum":{"title":"Sort direction.","type":"string","enum":["ASC","DESC"]},"TypeFilter":{"required":["type"],"type":"object","properties":{"groupIds":{"type":"array","items":{"type":"string"}},"familyIds":{"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["BUNDLE","GROUP","VARIANT","SINGLE","FAMILY"]}}},"TypesFilter":{"required":["productTypes","type"],"type":"object","properties":{"productTypes":{"type":"array","items":{"type":"string","enum":["BUNDLE","GROUP","VARIANT","SINGLE","FAMILY"]}},"type":{"type":"string","enum":["IN"]}}},"DownloadReportResponse":{"type":"object","properties":{"id":{"title":"Session Id.","type":"string"},"actionUrl":{"title":"Presigned URL for upload the download file.","type":"string"}}},"ImportFileLimitResponse":{"type":"object","properties":{"fileSizeMb":{"title":"Limit import file size.","type":"integer","format":"int32"},"presignedUrlTimeout":{"title":"The pre-signed URL expiration time.","type":"integer","format":"int32"},"formats":{"title":"Import file format.","type":"array","items":{"type":"string"}}}},"ImportReportResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SessionStatus"},"preview":{"$ref":"#/components/schemas/Preview"}}},"Preview":{"type":"object","properties":{"mainProduct":{"title":"Number of main products in report.","type":"integer","format":"int32"},"relations":{"title":"Number of relations in report.","type":"integer","format":"int32"},"newRelation":{"title":"Number of new relations in report.","type":"integer","format":"int32"},"removeRelation":{"title":"Number of remove relations in report.","type":"integer","format":"int32"},"swapRelation":{"title":"Number of swap relations in report.","type":"integer","format":"int32"},"attributeChanged":{"title":"Number of attribute changed in report.","type":"integer","format":"int32"}}},"SessionStatus":{"title":"Session status.","type":"string","enum":["FILE_NOT_UPLOADED","FILE_UPLOADED","PREPARING","PREVIEW","EXECUTING","FAILED","COMPLETED","COMPLETED_WITH_ISSUES"]},"InitSessionResponse":{"type":"object","properties":{"id":{"title":"Session Id.","type":"string"},"actionUrl":{"title":"Presigned URL for upload the import file.","type":"string"}}},"InitImportSessionRequest":{"required":["context","fileName"],"type":"object","properties":{"context":{"title":"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.","type":"string"},"fileName":{"title":"Import filename.","type":"string"}}},"File":{"type":"object","properties":{"key":{"title":"File key.","type":"string"},"name":{"title":"File name.","type":"string"},"errorReportKey":{"title":"Error report file key.","type":"string"},"sizeBytes":{"title":"Size of file in bytes.","type":"integer","format":"int64"}}},"Options":{"type":"object","properties":{"allowAddingRelatedProducts":{"title":"Allow adding related products option.","type":"boolean"},"allowSwappingRelatedProducts":{"title":"Allow swapping related products option.","type":"boolean"},"allowDeletingRelatedProducts":{"title":"Allow deleting related products option.","type":"boolean"}}},"Session":{"title":"Session.","type":"object","properties":{"id":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"organizationId":{"type":"string"},"context":{"title":"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.","type":"string"},"type":{"$ref":"#/components/schemas/SessionType"},"status":{"$ref":"#/components/schemas/SessionStatus"},"file":{"$ref":"#/components/schemas/File"},"preview":{"$ref":"#/components/schemas/Preview"},"options":{"$ref":"#/components/schemas/Options"},"log":{"title":"Logs of session.","type":"array","items":{"type":"string"}},"createdByUserId":{"title":"Created by user id.","type":"string"}}},"SessionType":{"title":"Session type.","type":"string","enum":["IMPORT","EXPORT"]},"ReadImportFileRequest":{"type":"object","properties":{"allowAddingRelatedProducts":{"title":"Allow adding related products.","type":"boolean"},"allowSwappingRelatedProducts":{"title":"Allow swapping related products.","type":"boolean"},"allowDeletingRelatedProducts":{"title":"Allow deleting related products.","type":"boolean"}}},"PatchImportSession":{"type":"object","properties":{"context":{"title":"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.","type":"string"}}},"MetadataJob":{"type":"object","properties":{"id":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"organizationId":{"type":"string"},"totalProducts":{"type":"integer","format":"int32"},"status":{"type":"string","enum":["PROCESSING","DONE","FAILED"]}}},"MetadataAttributeResponse":{"type":"object","properties":{"id":{"title":"Attribute Id.","type":"string"},"name":{"title":"Attribute name.","type":"string"},"number":{"title":"Attribute number.","type":"string"},"unit":{"title":"Attribute unit.","type":"string"},"dataType":{"title":"Attribute data type.","type":"string"},"values":{"title":"Attribute values.","type":"array","items":{"type":"string"}}}},"MetadataRelatedProduct":{"title":"Metadata related product.","type":"object","properties":{"productId":{"title":"Product Id.","type":"string"},"productName":{"title":"Product name.","type":"string"},"productNumber":{"title":"Product number.","type":"string"},"reverse":{"title":"Is relation in reverse to related object.","type":"boolean"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/MetadataAttributeResponse"}}}},"ProductMetadata":{"title":"Product metadata.","type":"object","properties":{"relationId":{"title":"Relation Id.","type":"string"},"reverse":{"title":"Is relation in reverse to related object.","type":"boolean"},"attributes":{"title":"List of metadata attribute.","type":"array","items":{"$ref":"#/components/schemas/MetadataAttributeResponse"}},"relatedProducts":{"title":"List of metadata related product.","type":"array","items":{"$ref":"#/components/schemas/MetadataRelatedProduct"}}}},"ListMetadataJobResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetadataJob"}},"total":{"type":"integer","format":"int64"}}},"JobStatus":{"type":"string","enum":["PROCESSING","DONE","FAILED"]},"ListProductMetadata":{"title":"List product metadata.","type":"object","properties":{"id":{"title":"Product id.","type":"string"},"metadata":{"title":"List of product metadata.","type":"array","items":{"$ref":"#/components/schemas/ProductMetadata"}}}},"ListProductMetadataResponse":{"type":"object","properties":{"data":{"title":"List of list product metadata.","type":"array","items":{"$ref":"#/components/schemas/ListProductMetadata"}}}},"AttributeRequest":{"required":["definitionId"],"type":"object","properties":{"definitionId":{"title":"Definition id.","type":"string"},"values":{"title":"Attribute values.","type":"array","items":{"type":"string"}}}},"BulkUpdateAttributesRequest":{"required":["relations"],"type":"object","properties":{"relations":{"title":"List of relations.","type":"array","items":{"$ref":"#/components/schemas/RelationRequest"}}}},"RelatedProductRequest":{"title":"Related product.","required":["id"],"type":"object","properties":{"id":{"type":"string"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/AttributeRequest"}}}},"RelationRequest":{"required":["relationId"],"type":"object","properties":{"relationId":{"title":"Relation id.","type":"string"},"reverse":{"title":"Direction of relation.","type":"boolean"},"attributes":{"title":"List of attributes.","type":"array","items":{"$ref":"#/components/schemas/AttributeRequest"}},"relatedProducts":{"title":"List of related products.","type":"array","items":{"$ref":"#/components/schemas/RelatedProductRequest"}}}},"BaseFilterType":{"title":"Base filter type.","type":"string","enum":["RELATION_NAME_CONTAINS","PRODUCT_NAME_CONTAINS","PRODUCT_NUMBER_CONTAINS"]},"CountRelatedProductsRequest":{"type":"object","properties":{"relationIds":{"title":"Relation ids.","type":"array","items":{"type":"string"}},"baseFilters":{"title":"List of base filters.","type":"array","items":{"$ref":"#/components/schemas/RelationBaseFilter"}},"reverse":{"title":"Direction of relation.","type":"boolean"}}},"RelationBaseFilter":{"title":"Base filter.","type":"object","properties":{"type":{"$ref":"#/components/schemas/BaseFilterType"},"values":{"title":"Filter values.","type":"array","items":{"type":"string"}}}},"AttributeResponse":{"title":"Attribute response.","type":"object","properties":{"definitionId":{"title":"Attribute definition Id.","type":"string"},"values":{"title":"Attribute values.","type":"array","items":{"type":"string"}}}},"ListProductRelationAttributeResponse":{"type":"object","properties":{"data":{"title":"List of product relation attributes.","type":"array","items":{"$ref":"#/components/schemas/AttributeResponse"}}}},"ListProductRelationResponse":{"type":"object","properties":{"data":{"title":"List of product relation.","type":"array","items":{"$ref":"#/components/schemas/ProductRelationResponse"}}}},"ProductRelationResponse":{"title":"Product relation response.","type":"object","properties":{"relationId":{"title":"Relation Id.","type":"string"},"reverse":{"title":"Is relation in reverse to related object.","type":"boolean"},"attributes":{"title":"List of product relation attributes.","type":"array","items":{"$ref":"#/components/schemas/AttributeResponse"}}}},"ListRelatedProductResponse":{"type":"object","properties":{"data":{"title":"Related product.","type":"array","items":{"$ref":"#/components/schemas/RelatedProductResponse"}}}},"RelatedProductResponse":{"type":"object","properties":{"id":{"title":"Relation product id.","type":"string"},"relationId":{"title":"Relation id.","type":"string"},"productId":{"title":"Product id.","type":"string"},"productName":{"title":"Product name.","type":"string"},"productNumber":{"title":"Product number.","type":"string"},"relatedProductId":{"title":"Related product id.","type":"string"},"relatedProductName":{"title":"Relation product name.","type":"string"},"relatedProductNumber":{"title":"Relation product number.","type":"string"},"reverse":{"title":"Direction of relation.","type":"boolean"},"attributes":{"title":"List of related product attributes.","type":"array","items":{"$ref":"#/components/schemas/AttributeResponse"}},"createdAt":{"title":"Created at.","type":"string","format":"date-time"},"createdBy":{"title":"Created by.","type":"string"},"modifiedAt":{"title":"Modified at.","type":"string","format":"date-time"},"modifiedBy":{"title":"Modified by.","type":"string"}}},"ListRelatedProductSort":{"title":"Sort by.","type":"string","enum":["PRODUCT_NAME","PRODUCT_NUMBER"]},"ListRelatedProductsRequest":{"required":["page","pageSize"],"type":"object","properties":{"relationIds":{"title":"Relation ids.","type":"array","items":{"type":"string"}},"baseFilters":{"title":"List of base filters.","type":"array","items":{"$ref":"#/components/schemas/RelationBaseFilter"}},"reverse":{"title":"Direction of relation.","type":"boolean"},"sort":{"$ref":"#/components/schemas/ListRelatedProductSort"},"sortDirection":{"$ref":"#/components/schemas/SortDirection"},"page":{"title":"Number of page.","minimum":0,"type":"integer","format":"int32"},"pageSize":{"title":"Size of page.","maximum":1000,"minimum":1,"type":"integer","format":"int32"}}},"SortDirection":{"title":"Sorting direction.","type":"string","enum":["ASC","DESC"]},"UpdateRelationAttributeRequest":{"type":"object","properties":{"reverse":{"title":"Direction of relation.","type":"boolean"},"values":{"title":"Attribute values.","type":"array","items":{"type":"string"}}}},"UpdateRelationProductAttributeRequest":{"type":"object","properties":{"reverse":{"title":"Is relation in reverse to related object.","type":"boolean"},"values":{"title":"Relation product attribute values.","type":"array","items":{"type":"string"}}}},"AssignAttributeRequest":{"required":["attributeDefinitionId","level"],"type":"object","properties":{"level":{"$ref":"#/components/schemas/RelationLevel"},"attributeDefinitionId":{"title":"Attribute definition Id.","type":"string"}}},"RelationLevel":{"title":"Relation level.","type":"string","enum":["relation","product"]},"RelationDefinitionResponse":{"title":"Relation definition response.","type":"object","properties":{"id":{"title":"Relation definition id.","type":"string"},"relationId":{"title":"Relation id.","type":"string"},"relationAttributes":{"title":"List of relation attributes.","type":"array","items":{"$ref":"#/components/schemas/AttributeResponse"}},"productAttributes":{"title":"List of product attributes.","type":"array","items":{"$ref":"#/components/schemas/AttributeResponse"}},"organizationId":{"title":"Organization id.","type":"string"},"createdAt":{"title":"Created at.","type":"string","format":"date-time"},"createdBy":{"title":"Created by.","type":"string"},"modifiedAt":{"title":"Modified at.","type":"string","format":"date-time"},"modifiedBy":{"title":"Modified by.","type":"string"}}},"ListRelationDefinitionResponse":{"type":"object","properties":{"data":{"title":"List of relation definitions.","type":"array","items":{"$ref":"#/components/schemas/RelationDefinitionResponse"}}}},"UpdateAttributeRequest":{"required":["level"],"type":"object","properties":{"level":{"$ref":"#/components/schemas/RelationLevel"},"values":{"title":"Attribute values.","type":"array","items":{"type":"string"}}}},"CountDataResponse":{"type":"object","properties":{"count":{"title":"Count.","type":"integer","format":"int64"}}},"CountSearchSessionRequest":{"type":"object","properties":{"context":{"title":"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.","type":"string"},"types":{"title":"Session type.","type":"array","items":{"type":"string","enum":["IMPORT","EXPORT"]}},"statuses":{"title":"Session status.","type":"array","items":{"type":"string","enum":["FILE_NOT_UPLOADED","FILE_UPLOADED","PREPARING","PREVIEW","EXECUTING","FAILED","COMPLETED","COMPLETED_WITH_ISSUES"]}},"createdByUserId":{"title":"Created by user id.","type":"string"},"createdAtFrom":{"title":"Created at from.","type":"integer","format":"int64"},"createdAtTo":{"title":"Created at to.","type":"integer","format":"int64"}}},"ListSessionResponse":{"type":"object","properties":{"data":{"title":"List of sessions.","type":"array","items":{"$ref":"#/components/schemas/Session"}}}},"ListSearchSessionRequest":{"type":"object","properties":{"context":{"title":"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.","type":"string"},"types":{"title":"Session type.","type":"array","items":{"type":"string","enum":["IMPORT","EXPORT"]}},"statuses":{"title":"Session status.","type":"array","items":{"type":"string","enum":["FILE_NOT_UPLOADED","FILE_UPLOADED","PREPARING","PREVIEW","EXECUTING","FAILED","COMPLETED","COMPLETED_WITH_ISSUES"]}},"createdByUserId":{"title":"Created by user id.","type":"string"},"createdAtFrom":{"title":"Created at from.","type":"integer","format":"int64"},"createdAtTo":{"title":"Created at to.","type":"integer","format":"int64"},"page":{"title":"Page to be returned.","minimum":0,"type":"integer","format":"int32"},"pageSize":{"title":"Number of items to be returned.","maximum":100,"minimum":1,"type":"integer","format":"int32"},"sortBy":{"$ref":"#/components/schemas/SortBy"},"sortDirection":{"$ref":"#/components/schemas/SortDirection"}}},"SortBy":{"title":"Allows to sort by field.","type":"string","enum":["CREATED_AT"]},"MetadataSetting":{"title":"Metadata settings.","type":"object","properties":{"excludeReverseRelation":{"title":"Exclude reverse relation.","type":"boolean"}}},"SettingResponse":{"required":["metadata"],"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/MetadataSetting"}}},"SettingRequest":{"required":["metadata"],"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/MetadataSetting"}}},"SyncRequest":{"type":"object","properties":{"productIds":{"title":"List of product ids.","type":"array","items":{"type":"string"}}}},"SyncResponse":{"title":"Sync.","type":"object","properties":{"id":{"title":"Sync id.","type":"string"},"status":{"$ref":"#/components/schemas/SyncStatus"},"report":{"title":"Sync report.","type":"array","items":{"type":"string"}},"context":{"title":"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.","type":"string"},"parameters":{"title":"Sync parameters.","type":"object","additionalProperties":{"title":"Sync parameters.","type":"object"}},"createdAt":{"title":"Sync created at time.","type":"string"},"createdBy":{"title":"Sync created by user.","type":"string"},"modifiedAt":{"title":"Sync modified at time.","type":"string"},"modifiedBy":{"title":"Sync modified at user.","type":"string"}}},"SyncStatus":{"title":"Sync status.","type":"string","enum":["START","FAILED","COMPLETED"]},"ListSyncResponse":{"type":"object","properties":{"data":{"title":"List of syncs.","type":"array","items":{"$ref":"#/components/schemas/SyncResponse"}},"total":{"title":"Total of syncs.","type":"integer","format":"int64"}}},"ProductRelationsBulkTestResponse":{"type":"object","properties":{"relations":{"type":"array","items":{"$ref":"#/components/schemas/RelationRequest"}}}}},"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"}