{"components":{"examples":{},"headers":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"ProductType":{"enum":["BUNDLE","GROUP","SINGLE","VARIANT","FAMILY"],"type":"string"},"ColumnAttribute":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"required":["id"],"type":"object","additionalProperties":false},"MatrixAttributeRow":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"required":["id"],"type":"object","additionalProperties":false},"MatrixAttributeColumn":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"rows":{"items":{"$ref":"#/components/schemas/MatrixAttributeRow"},"type":"array"}},"required":["id"],"type":"object","additionalProperties":false},"SelectValue":{"properties":{"id":{"type":"string"},"number":{"type":"string"},"value":{"type":"string"},"metadata":{"type":"string"}},"required":["id"],"type":"object","additionalProperties":false},"DictionaryValue":{"properties":{"id":{"type":"string"},"number":{"type":"string"},"value":{"type":"string"},"metadata":{"type":"string"}},"required":["id"],"type":"object","additionalProperties":false},"Attribute":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"string"},"unit":{"type":"string"},"groupName":{"type":"string"},"groupNumber":{"type":"string"},"dataType":{"type":"string"},"contentType":{"type":"string"},"valueType":{"type":"string"},"values":{"items":{"type":"string"},"type":"array"},"select":{"items":{"$ref":"#/components/schemas/SelectValue"},"type":"array"},"dictionary":{"items":{"$ref":"#/components/schemas/DictionaryValue"},"type":"array"},"isCompound":{"type":"boolean"},"definingAttribute":{"type":"boolean"},"column":{"items":{"$ref":"#/components/schemas/ColumnAttribute"},"type":"array"},"matrix":{"items":{"$ref":"#/components/schemas/MatrixAttributeColumn"},"type":"array"}},"required":["id","values"],"type":"object","additionalProperties":false},"AssetAttribute":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"string"},"unit":{"type":"string"},"groupName":{"type":"string"},"groupNumber":{"type":"string"},"dataType":{"type":"string"},"contentType":{"type":"string"},"valueType":{"type":"string"},"values":{"items":{"type":"string"},"type":"array"},"select":{"items":{"$ref":"#/components/schemas/SelectValue"},"type":"array"},"dictionary":{"items":{"$ref":"#/components/schemas/DictionaryValue"},"type":"array"},"definingAttribute":{"type":"boolean"}},"required":["id","values"],"type":"object","additionalProperties":false},"ProductMediaAsset":{"properties":{"id":{"type":"string"},"downloadUri":{"type":"string"},"previewUri":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"fileName":{"type":"string"},"contentType":{"type":"string"},"labels":{"items":{"type":"string"},"type":"array"},"createdAt":{"type":"number","format":"double"},"updatedAt":{"type":"number","format":"double"},"number":{"type":"string"},"attributes":{"items":{"$ref":"#/components/schemas/AssetAttribute"},"type":"array"}},"required":["downloadUri","previewUri","name","contentType","labels"],"type":"object","additionalProperties":false},"RelationDirection":{"enum":["ONE_WAY","TWO_WAY"],"type":"string"},"ProductRelation":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"string"},"productId":{"type":"string"},"reverse":{"type":"boolean"},"direction":{"$ref":"#/components/schemas/RelationDirection"}},"required":["id","productId"],"type":"object","additionalProperties":false},"MetaData":{"properties":{"id":{"type":"string"},"value":{}},"required":["id","value"],"type":"object","additionalProperties":false},"ProductBundle":{"properties":{"productId":{"type":"string"},"quantity":{"type":"number","format":"double"}},"required":["productId","quantity"],"type":"object","additionalProperties":false},"RelatedProductsRelationSortingOrderSource":{"enum":["RELATION_DEFINITION","PRODUCT"],"type":"string"},"Product":{"properties":{"id":{"type":"string","description":"An identifier randomly generated by PIM. ID is unique across all products."},"type":{"$ref":"#/components/schemas/ProductType","description":"Product type describe what kind of product we are working with."},"name":{"type":"string","description":"Name describe the product. It is not unique across all products."},"number":{"type":"string","description":"Number is another type of product identifier. It is unique across all products."},"description":{"type":"string","description":"Description is a field where we put more information about product."},"attributes":{"items":{"$ref":"#/components/schemas/Attribute"},"type":"array","description":"This field inform which attributes have been selected for a product."},"media":{"items":{"$ref":"#/components/schemas/ProductMediaAsset"},"type":"array","description":"This field inform which media assets have been assigned for a product."},"labels":{"items":{"type":"string"},"type":"array","description":"This field inform which labels have been added for a product."},"categories":{"items":{"type":"string"},"type":"array","description":"This field inform to which categories, product has been assigned."},"relations":{"items":{"$ref":"#/components/schemas/ProductRelation"},"type":"array","description":"This field inform about relations between products."},"metadata":{"items":{"$ref":"#/components/schemas/MetaData"},"type":"array","description":"This field describe product's metadata."},"lastUpdate":{"type":"number","format":"double","description":"Inform when product was last time updated."},"createDate":{"type":"number","format":"double","description":"Inform when product was created."},"bundles":{"items":{"$ref":"#/components/schemas/ProductBundle"},"type":"array","description":"This field inform bundles assigned to product."},"variants":{"items":{"type":"string"},"type":"array","description":"This field inform about variants added to product."},"groups":{"items":{"type":"string"},"type":"array","description":"This field inform about groups added to product."},"variantParentId":{"type":"string","description":"This field inform about variant parent identifier for product."},"groupParentId":{"type":"string","description":"This field inform about group parent identifier for product."},"relatedProductsRelationSortingOrderSource":{"$ref":"#/components/schemas/RelatedProductsRelationSortingOrderSource","description":"Inform about sorting order source."},"publishInfoId":{"type":"string","description":"Describe identifier of publish information."},"contextId":{"type":"string","description":"Inform about context identifier for published product."}},"required":["id","type","name","number"],"type":"object","additionalProperties":false},"PaginatedProduct":{"properties":{"totalCount":{"type":"number","format":"double"},"results":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"required":["totalCount","results"],"type":"object","additionalProperties":false},"AttributeFilter":{"properties":{"number":{"type":"string","description":"Attribute number the product must have."},"value":{"type":"string","description":"Attribute value the product must have."}},"type":"object","additionalProperties":false},"FilteringCriteriaRequest":{"properties":{"ids":{"items":{"type":"string"},"type":"array","description":"Product ids returned entries must be matched to."},"names":{"items":{"type":"string"},"type":"array","description":"Product names products must contain."},"numbers":{"items":{"type":"string"},"type":"array","description":"Product numbers products must be equal to."},"labels":{"items":{"type":"string"},"type":"array","description":"A set of labels products must contain."},"categories":{"items":{"type":"string"},"type":"array","description":"A set of category ids the product must be in."},"attributes":{"items":{"type":"string"},"type":"array","description":"A set of attribute ids the product must be in."},"attributeFilters":{"items":{"$ref":"#/components/schemas/AttributeFilter"},"type":"array","description":"Attribute filters."},"relations":{"items":{"type":"string"},"type":"array","description":"A set of relation ids the product must be in."},"productTypes":{"items":{"$ref":"#/components/schemas/ProductType"},"type":"array","description":"A products must be of provided types"},"bundles":{"items":{"type":"string"},"type":"array","description":"Product ids that should be assign to bundles."}},"type":"object","additionalProperties":false},"ProductResults":{"properties":{"results":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"required":["results"],"type":"object","additionalProperties":false},"ProductsByIdsRequest":{"properties":{"ids":{"items":{"type":"string"},"type":"array","description":"Product ids returned entries must be matched to."}},"required":["ids"],"type":"object","additionalProperties":false},"ProductsByNumbersRequest":{"properties":{"numbers":{"items":{"type":"string"},"type":"array","description":"Product numbers to be returned."}},"required":["numbers"],"type":"object","additionalProperties":false},"CursorPageProduct":{"properties":{"nextCursor":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"required":["nextCursor","results"],"type":"object","additionalProperties":false},"CursorQuery":{"properties":{"cursor":{"type":"string"},"limit":{"type":"number","format":"double","default":"10","maximum":100}},"type":"object","additionalProperties":false},"StatusPapiError":{"properties":{"status":{"type":"number","format":"double"},"message":{"type":"string"}},"required":["status","message"],"type":"object"},"EntitiesPapiError":{"allOf":[{"properties":{"entityIds":{"items":{"type":"string"},"type":"array"}},"required":["entityIds"],"type":"object"},{"$ref":"#/components/schemas/StatusPapiError"}]},"EntityPapiError":{"allOf":[{"properties":{"entityId":{"type":"string"}},"required":["entityId"],"type":"object"},{"$ref":"#/components/schemas/StatusPapiError"}]},"PapiError":{"anyOf":[{"$ref":"#/components/schemas/StatusPapiError"},{"$ref":"#/components/schemas/EntitiesPapiError"},{"$ref":"#/components/schemas/EntityPapiError"}]},"CategoryMediaAsset":{"properties":{"id":{"type":"string"},"downloadUri":{"type":"string"},"previewUri":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"fileName":{"type":"string"},"contentType":{"type":"string"},"labels":{"items":{"type":"string"},"type":"array"},"createdAt":{"type":"number","format":"double"},"updatedAt":{"type":"number","format":"double"},"number":{"type":"string"},"attributes":{"items":{"$ref":"#/components/schemas/AssetAttribute"},"type":"array"}},"required":["downloadUri","previewUri","name","contentType","labels"],"type":"object","additionalProperties":false},"CategoryAttribute":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"string"},"unit":{"type":"string"},"groupName":{"type":"string"},"groupNumber":{"type":"string"},"dataType":{"type":"string"},"contentType":{"type":"string"},"valueType":{"type":"string"},"values":{"items":{"type":"string"},"type":"array"},"select":{"items":{"$ref":"#/components/schemas/SelectValue"},"type":"array"},"dictionary":{"items":{"$ref":"#/components/schemas/DictionaryValue"},"type":"array"}},"required":["id","values"],"type":"object","additionalProperties":false},"SimplifiedCategory":{"description":"The category.","properties":{"id":{"type":"string","description":"id of the category."},"parentId":{"type":"string","description":"id of parent category."},"order":{"type":"number","format":"double","description":"order of category in parent category."},"name":{"type":"string","description":"Category name."},"number":{"type":"string","description":"Category number."},"description":{"type":"string","description":"Category description."},"media":{"items":{"$ref":"#/components/schemas/CategoryMediaAsset"},"type":"array","description":"Category media assets."},"attributes":{"items":{"$ref":"#/components/schemas/Attribute"},"type":"array","description":"Category level attributes."},"categoryAttributes":{"items":{"$ref":"#/components/schemas/CategoryAttribute"},"type":"array","description":"Local category attributes."},"metaData":{"items":{"$ref":"#/components/schemas/MetaData"},"type":"array","description":"Any metadata."}},"required":["id","name"],"type":"object","additionalProperties":false},"PaginatedSimplifiedCategory":{"properties":{"totalCount":{"type":"number","format":"double"},"results":{"items":{"$ref":"#/components/schemas/SimplifiedCategory"},"type":"array"}},"required":["totalCount","results"],"type":"object","additionalProperties":false},"Category":{"description":"The category with fetched sub categories.","properties":{"id":{"type":"string","description":"id of the category."},"parentId":{"type":"string","description":"id of parent category."},"order":{"type":"number","format":"double","description":"order of category in parent category."},"name":{"type":"string","description":"Category name."},"number":{"type":"string","description":"Category number."},"description":{"type":"string","description":"Category description."},"media":{"items":{"$ref":"#/components/schemas/CategoryMediaAsset"},"type":"array","description":"Category media assets."},"attributes":{"items":{"$ref":"#/components/schemas/Attribute"},"type":"array","description":"Category level attributes."},"categoryAttributes":{"items":{"$ref":"#/components/schemas/CategoryAttribute"},"type":"array","description":"Local category attributes."},"metaData":{"items":{"$ref":"#/components/schemas/MetaData"},"type":"array","description":"Any metadata."},"subCategories":{"items":{"$ref":"#/components/schemas/Category"},"type":"array","description":"A set of sub categories."}},"required":["id","name"],"type":"object","additionalProperties":false},"CategoriesByNumbersRequest":{"properties":{"numbers":{"items":{"type":"string"},"type":"array","description":"Categories numbers to be returned."}},"required":["numbers"],"type":"object","additionalProperties":false},"PublishStateValues":{"type":"string","enum":["INITIALIZING","PENDING","PUBLISH","PUBLISH_CLEANUP","CLOSED","CANCELLED"]},"PublishInfo":{"properties":{"id":{"type":"string","description":"mongo identifier of the collection."},"state":{"$ref":"#/components/schemas/PublishStateValues"},"createdAt":{"type":"number","format":"double"},"syncSessionId":{"type":"string"},"disposedAt":{"type":"number","format":"double"},"cleanedAt":{"type":"number","format":"double"},"contextId":{"type":"string"},"contextName":{"type":"string"}},"required":["id","state","createdAt","contextId","contextName"],"type":"object","additionalProperties":false},"DiffType":{"enum":["ADD","DELETE","CHANGE"],"type":"string"},"DiffResponse":{"properties":{"id":{"type":"string"},"number":{"type":"string"},"diffType":{"$ref":"#/components/schemas/DiffType"}},"required":["id","diffType"],"type":"object","additionalProperties":false},"SegmentContextRequest":{"properties":{"context":{"type":"string","description":"Context id, or 'en' if id is not specified."},"contextName":{"type":"string","description":"Context name, or 'default' if name is not specified."},"syncSessionId":{"type":"string","description":"Papi-Sync session ID."}},"type":"object","additionalProperties":false},"RelationDefinitionDto":{"properties":{"id":{"type":"string"},"number":{"type":"string"},"name":{"type":"string"},"reverseName":{"type":"string"},"order":{"type":"number","format":"double"}},"required":["id","name"],"type":"object","additionalProperties":false},"RelationDefinition":{"properties":{"id":{"type":"string"},"number":{"type":"string"},"name":{"type":"string"},"reverseName":{"type":"string"},"order":{"type":"number","format":"double"},"direction":{"$ref":"#/components/schemas/RelationDirection"}},"required":["id","name"],"type":"object","additionalProperties":false},"ColumnAttributeDefinitionValue":{"properties":{"valueId":{"type":"string"},"value":{"type":"string"}},"required":["valueId"],"type":"object","additionalProperties":false},"RowAttributeDefinitionValue":{"properties":{"valueId":{"type":"string"},"value":{"type":"string"}},"required":["valueId"],"type":"object","additionalProperties":false},"CompoundAttributeSubDefinition":{"properties":{"id":{"type":"string"},"isCompound":{"type":"boolean"}},"required":["id"],"type":"object","additionalProperties":false},"GroupedAttributeDefinition":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"string"},"unit":{"type":"string"},"dataType":{"type":"string"},"sortingOrder":{"type":"number","format":"double"},"groupId":{"type":"string"},"groupName":{"type":"string"},"groupNumber":{"type":"string"},"columns":{"items":{"$ref":"#/components/schemas/ColumnAttributeDefinitionValue"},"type":"array"},"rows":{"items":{"$ref":"#/components/schemas/RowAttributeDefinitionValue"},"type":"array"},"isCompound":{"type":"boolean"},"subDefinitions":{"items":{"$ref":"#/components/schemas/CompoundAttributeSubDefinition"},"type":"array"},"format":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"contentType":{"type":"string"},"valueType":{"type":"string"},"contextAware":{"type":"boolean"},"order":{"type":"number","format":"double"},"groupOrder":{"type":"number","format":"double"}},"required":["id","name","sortingOrder","groupId","groupName","order","groupOrder"],"type":"object","additionalProperties":false},"PaginatedAttribute":{"properties":{"totalCount":{"type":"number","format":"double"},"results":{"items":{"$ref":"#/components/schemas/GroupedAttributeDefinition"},"type":"array"}},"required":["totalCount","results"],"type":"object","additionalProperties":false},"AttributeResults":{"properties":{"results":{"items":{"$ref":"#/components/schemas/GroupedAttributeDefinition"},"type":"array"}},"required":["results"],"type":"object","additionalProperties":false},"AttributesByNumbersRequest":{"properties":{"numbers":{"items":{"type":"string"},"type":"array","description":"Attributes numbers to be returned."}},"required":["numbers"],"type":"object","additionalProperties":false},"DictionaryValueDefinition":{"properties":{"id":{"type":"string"},"definitionId":{"type":"string"},"number":{"type":"string"},"value":{"type":"string"},"metadata":{"type":"string"}},"required":["id","definitionId"],"type":"object","additionalProperties":false},"DictionaryAttributeCursorResponse":{"properties":{"nextCursor":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/DictionaryValueDefinition"},"type":"array"}},"required":["results"],"type":"object","additionalProperties":false}},"securitySchemes":{"secured":{"type":"apiKey","name":"x-api-key","in":"header"}}},"info":{"title":"Bluestone Public API","version":"1-core","description":"Bluestone Public API\n

Deprecated endpoints:

Uri

Method

Since

End of life

/categories/{categoryId}GET2026-04-152027-01-15
"},"openapi":"3.0.0","paths":{"/products/list":{"post":{"operationId":"FindProducts","responses":{"200":{"description":"Information about the product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProduct"}}}}},"description":"Find products in PAPI.\nNote: For large-scale operations please use the '/products/cursor/all' endpoint.","tags":["Products"],"security":[{"secured":[]}],"parameters":[{"description":"Sort by name, number. Examples: sort ascending by number 'number', sort descending by name 'name:desc'","in":"query","name":"sort","required":false,"schema":{"default":null,"type":"string"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilteringCriteriaRequest"}}}}}},"/products/by-ids":{"post":{"operationId":"FindProductsByIds","responses":{"200":{"description":"Information about the products.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResults"}}}}},"summary":"Show list of products filtered by ids.","tags":["Products"],"security":[{"secured":[]}],"parameters":[{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductsByIdsRequest"}}}}}},"/products/by-numbers":{"post":{"operationId":"FindProductsByNumbers","responses":{"200":{"description":"Information about the products.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResults"}}}}},"summary":"Show list of products filtered by numbers.","tags":["Products"],"security":[{"secured":[]}],"parameters":[{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductsByNumbersRequest"}}}}}},"/products/cursor/all":{"post":{"operationId":"FindProductsByCursor","responses":{"200":{"description":"Information about products, paging by cursor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorPageProduct"}}}}},"tags":["Products"],"security":[{"secured":[]}],"parameters":[{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorQuery"}}}}}},"/products/{id}":{"get":{"operationId":"GetProduct","responses":{"200":{"description":"Information about the product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiError"}}}}},"description":"Get the product with given id","tags":["Products"],"security":[{"secured":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/categories":{"get":{"operationId":"GetCategories","responses":{"200":{"description":"Information about categories.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSimplifiedCategory"}}}}},"description":"Describe the root categories available in the system.\n
name - category contains a name\n
itemsOnPage - items to be displayed on page.\n
pageNo - page number to display.","tags":["Categories"],"security":[{"secured":[]}],"parameters":[{"in":"query","name":"name","required":false,"schema":{"type":"string"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/categories/{categoryId}/ancestors":{"get":{"operationId":"GetAncestors","responses":{"200":{"description":"Information about the category.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SimplifiedCategory"},"type":"array"}}}},"404":{"description":"Category not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiError"}}}}},"description":"Describe categories associated with given category.\n
deep - deepness of sub categories to be retrieved. default 10.","tags":["Categories"],"security":[{"secured":[]}],"parameters":[{"in":"path","name":"categoryId","required":true,"schema":{"type":"string"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/categories/scan":{"get":{"operationId":"Scan","responses":{"200":{"description":"Information about the category.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSimplifiedCategory"}}}},"404":{"description":"Category not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiError"}}}}},"description":"Get paginated flat list of categories: given category and its descendants.\nCategoryId is optional, if not provided all catalogs are listed.","tags":["Categories"],"security":[{"secured":[]}],"parameters":[{"in":"query","name":"categoryId","required":false,"schema":{"default":null,"type":"string"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/categories/{categoryId}":{"get":{"operationId":"GetCategoryById","responses":{"200":{"description":"Information about the category.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"404":{"description":"Category not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiError"}}}}},"description":"Describe categories associated with given category.\n
deep - deepness of sub categories to be retrieved. default 10.\n
This endpoint is deprecated and will be removed soon. Instead, please use this endpoint: GET /categories/scan","tags":["Categories"],"deprecated":true,"security":[{"secured":[]}],"parameters":[{"in":"path","name":"categoryId","required":true,"schema":{"type":"string"}},{"in":"query","name":"deep","required":false,"schema":{"default":10,"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}],"x-bluestone-deprecated-since":"2026.04.15","summary":"[DEPRECATED; EOL 2027-01-15] undefined"}},"/categories/{categoryId}/products":{"get":{"operationId":"GetProducts","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProduct"}}}}},"description":"Get a list of products for given category.\n
subCategories - default false. Set to true provides products for all sub categories.\n
withLabels - format \"label1;label2\" a set of labels products should contain.\n
name - part of the name contained by the product\n
itemsOnPage - items to be displayed on page.\n
pageNo - page number to display.","tags":["Categories","Products"],"security":[{"secured":[]}],"parameters":[{"in":"path","name":"categoryId","required":true,"schema":{"type":"string"}},{"in":"query","name":"subCategories","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"labels","required":false,"schema":{"type":"string"}},{"in":"query","name":"name","required":false,"schema":{"type":"string"}},{"in":"query","name":"number","required":false,"schema":{"type":"string"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/categories/by-numbers":{"post":{"operationId":"FindCategoriesByNumbers","responses":{"200":{"description":"Information about the categories.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SimplifiedCategory"},"type":"array"}}}}},"summary":"Show list of categories filtered by numbers.","tags":["Categories"],"security":[{"secured":[]}],"parameters":[{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesByNumbersRequest"}}}}}},"/syncs":{"get":{"operationId":"GetPublishInfos","responses":{"200":{"description":"Collection of existing PublishInfo environments","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PublishInfo"},"type":"array"}}}}},"summary":"Retrieves a collection of publish info for given tenant.","tags":["Syncs"],"security":[{"secured":[]}],"parameters":[{"in":"query","name":"context","required":false,"schema":{"type":"string"}},{"description":"Sort by createdAt. Examples: sort descending by createdAt 'createdAt:desc'","in":"query","name":"sort","required":false,"schema":{"default":null,"type":"string"}},{"description":"Filter by publish states passed as comma-separated, capital lettered strings with no whitespaces, ie: 'CLOSED,PUBLISH', or 'CLOSED'","in":"query","name":"publishStates","required":false,"schema":{"default":null,"type":"string"}},{"description":"Filter by \"createdAt\" field","in":"query","name":"createdAfter","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"default":20,"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}}]}},"/syncs/{id}":{"get":{"operationId":"GetPublishInfo","responses":{"201":{"description":"New publish environment created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishInfo"}}}},"404":{"description":"If publish environment with given id does not exists."}},"summary":"Retrieves the information about given PublishInfo environment.","tags":["Syncs"],"security":[{"secured":[]}],"parameters":[{"description":"publish id.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}},"/differences/products":{"get":{"operationId":"GetProductDifferences","responses":{"200":{"description":"Information about products.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiffResponse"},"type":"array"}}}}},"description":"Return a set of differences done during last sync operation.\n
diffType - filter returned values on difference type.\n
itemsOnPage - items to be displayed on page.\n
pageNo - page number to display.","tags":["Differences"],"security":[{"secured":[]}],"parameters":[{"in":"query","name":"diffType","required":false,"schema":{"$ref":"#/components/schemas/DiffType"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/differences/sync/{id}/products":{"get":{"operationId":"GetProductDifferencesOnSyncDeletes","responses":{"200":{"description":"Information about products.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiffResponse"},"type":"array"}}}},"404":{"description":"Sync not found (historical sync sessions are removed after some time)"}},"description":"Return a set of changed products with given sync\n
id - sync id for which differences should be retrieved.\n
diffType - filter returned values on difference type.\n
itemsOnPage - amount of items to be retrieved.\n
pageNo - page number.","tags":["Differences"],"security":[{"secured":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"diffType","required":false,"schema":{"$ref":"#/components/schemas/DiffType"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}}]}},"/differences/categories":{"get":{"operationId":"GetCategoryDifferences","responses":{"200":{"description":"Information about categories.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiffResponse"},"type":"array"}}}}},"description":"Return a set of changed categories during last publish\n
diffType - filter returned values on difference type.\n
itemsOnPage - amount of items to be retrieved.\n
pageNo - page number.","tags":["Differences"],"security":[{"secured":[]}],"parameters":[{"in":"query","name":"diffType","required":false,"schema":{"$ref":"#/components/schemas/DiffType"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/differences/sync/{id}/categories":{"get":{"operationId":"GetCategoryDifferencesOnSyncDeletes","responses":{"200":{"description":"Information about categories.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiffResponse"},"type":"array"}}}},"404":{"description":"Sync not found (historical sync sessions are removed after some time)"}},"description":"Return a set of differences done with a given sync.\n
id - sync id for which differences should be retrieved.\n
itemsOnPage - items to be displayed on page.\n
pageNo - page number to display.","tags":["Differences"],"security":[{"secured":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"diffType","required":false,"schema":{"$ref":"#/components/schemas/DiffType"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}}]}},"/differences/attributes":{"get":{"operationId":"GetAttributeDifferences","responses":{"200":{"description":"Information about attributes.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiffResponse"},"type":"array"}}}}},"description":"Return a set of differences done during last sync operation.\n
diffType - filter returned values on difference type.\n
itemsOnPage - items to be displayed on page.\n
pageNo - page number to display.","tags":["Differences"],"security":[{"secured":[]}],"parameters":[{"in":"query","name":"diffType","required":false,"schema":{"$ref":"#/components/schemas/DiffType"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/differences/sync/{id}/attributes":{"get":{"operationId":"GetAttributeDifferencesOnSyncDeletes","responses":{"200":{"description":"Information about attributes.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiffResponse"},"type":"array"}}}},"404":{"description":"Sync not found (historical sync sessions are removed after some time)"}},"description":"Return a set of changed attributes with given sync\n
id - sync id for which differences should be retrieved.\n
diffType - filter returned values on difference type.\n
itemsOnPage - amount of items to be retrieved.\n
pageNo - page number.","tags":["Differences"],"security":[{"secured":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"diffType","required":false,"schema":{"$ref":"#/components/schemas/DiffType"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}}]}},"/differences/relations":{"get":{"operationId":"GetRelationDifferences","responses":{"200":{"description":"Information about relations.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiffResponse"},"type":"array"}}}}},"description":"Return a set of differences done during last sync operation.\n
diffType - filter returned values on difference type.\n
itemsOnPage - items to be displayed on page.\n
pageNo - page number to display.","tags":["Differences"],"security":[{"secured":[]}],"parameters":[{"in":"query","name":"diffType","required":false,"schema":{"$ref":"#/components/schemas/DiffType"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/differences/sync/{id}/relations":{"get":{"operationId":"GetRelationDifferencesOnSyncDeletes","responses":{"200":{"description":"Information about relations.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DiffResponse"},"type":"array"}}}},"404":{"description":"Sync not found (historical sync sessions are removed after some time)"}},"description":"Return a set of changed relations with given sync\n
id - sync id for which differences should be retrieved.\n
diffType - filter returned values on difference type.\n
itemsOnPage - amount of items to be retrieved.\n
pageNo - page number.","tags":["Differences"],"security":[{"secured":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"diffType","required":false,"schema":{"$ref":"#/components/schemas/DiffType"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}}]}},"/contexts":{"get":{"operationId":"GetSegmentInfo","responses":{"200":{"description":"Information about available contexts.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SegmentContextRequest"},"type":"array"}}}}},"summary":"lists currently available publications","tags":["Contexts"],"security":[{"secured":[]}],"parameters":[]}},"/health":{"get":{"operationId":"GetHealth","responses":{"204":{"description":"Service is Healthy"},"503":{"description":"Service is NOT Healthy"}},"description":"A Health check for PAPI service.","tags":["Health"],"security":[],"parameters":[]}},"/relations":{"get":{"operationId":"GetRelations","responses":{"200":{"description":"Information about relations.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RelationDefinitionDto"},"type":"array"}}}}},"description":"Describe the relations available in the system.","tags":["Relations"],"security":[{"secured":[]}],"parameters":[{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/attributes":{"get":{"operationId":"GetAttributes","responses":{"200":{"description":"Information about attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAttribute"}}}}},"description":"Describe the attributes available in the system.\n
id - attribute id.\n
itemsOnPage - items to be displayed on page.\n
pageNo - page number to display.","tags":["Attributes"],"security":[{"secured":[]}],"parameters":[{"in":"query","name":"id","required":false,"schema":{"type":"string"}},{"in":"query","name":"itemsOnPage","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"pageNo","required":false,"schema":{"format":"double","type":"number"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}]}},"/attributes/by-numbers":{"post":{"operationId":"FindPAttributesByNumbers","responses":{"200":{"description":"Information about the attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeResults"}}}}},"tags":["Attributes"],"security":[{"secured":[]}],"parameters":[{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributesByNumbersRequest"}}}}}},"/attributes/dictionary/{attributeDefinitionId}/values/cursor/all":{"post":{"operationId":"FindDictionaryValuesByCursor","responses":{"200":{"description":"Information about dictionary values for attribute definition, paging by cursor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryAttributeCursorResponse"}}}}},"tags":["Attributes"],"security":[{"secured":[]}],"parameters":[{"in":"path","name":"attributeDefinitionId","required":true,"schema":{"type":"string"}},{"in":"header","name":"context","required":false,"schema":{"default":"en","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CursorQuery"}}}}}}},"servers":[{"url":"api.test.bluestonepim.com/v1"}]}