Jump to Content
Environment: Test
Environment: Production
Environment: Production US
Home
Guides
API Reference
v1-apps
v1-core
Environment: Test
Environment: Production
Environment: Production US
API Reference
v1-core
Home
Guides
API Reference
lists currently available publications
Search
JUMP TO
Get bearer token
Generate token
post
PIM
Catalog nodes
Create new catalog or category.
post
List all catalog nodes/categories that use the attribute definition in a Category Level Attribute (CLA).
get
Describe catalog nodes/categories.
post
Delete catalog node/category structure.
delete
Describe catalog node/category.
get
Update catalog node/category.
put
List catalog node/category child nodes/categories.
get
Move catalog node/category to new parent.
put
Change category order.
put
List catalog node/category path to root.
get
List catalog node/category products.
get
Add product to the catalog node/category.
post
Remove product from the catalog node/category.
delete
Product policy
Get policy by category node id.
get
Add policy to products for category node id.
post
Delete policy from products for category node id.
delete
Get policy by category id.
get
Add policy to products for category id.
post
Delete policy from products for category id.
delete
Get catalog node by policy id.
get
Get categories by policy id.
get
Catalog node attributes
List all Category Level Attributes (CLA).
get
List only Category Level Attributes (CLA) attached to given catalog node/category.
get
Delete Category Level Attribute (CLA) from catalog node/category.
delete
Update Category Level Attribute (CLA) and schedule propagation task.
patch
Create a Category Level Attribute (CLA) and schedule propagation task.
post
Create column Category Level Attribute (CLA) and schedule propagation task.
post
Update column Category Level Attribute (CLA) and schedule propagation task.
put
Create compound Category Level Attribute (CLA) and schedule propagation task.
post
Create dictionary Category Level Attribute (CLA) and schedule propagation task.
post
Set values for dictionary Category Level Attribute (CLA) and schedule propagation task.
post
Create matrix Category Level Attribute (CLA) and schedule propagation task.
post
Update matrix Category Level Attribute (CLA) and schedule propagation task.
put
Bulk
Get async task status.
get
Delete products attributes.
delete
Attribute groups
List all attribute groups.
get
Create new attribute group.
post
List definitions that are not in any group.
get
Change order strategy for definitions without group.
put
Change attribute's order.
put
Get attribute root group.
get
Delete attribute group.
delete
Change group's order.
put
List definitions in attribute group.
get
Change order strategy for definitions in group.
put
Change attribute's order in group.
put
Rename attribute group.
put
Change attribute group number.
put
Attribute definition policies
Get policies by attribute definition ID.
get
Add policy to attribute definition.
post
Delete policy for attribute definition.
delete
Get attribute definitions by policy ID.
get
Products categories
Adds products as a children of category.
post
List of category id the product is a child of.
get
Adds product as a child of categories.
post
Removes product as a child of category.
delete
Validation
Validates attribute definitions.
post
Validates list of products.
post
Validates attribute value.
post
Catalogs
List catalogs.
get
Archive catalog.
delete
Unarchive catalog.
put
List all nodes/categories from catalog.
get
Products bundles
Create product bundle.
post
Delete product from bundle.
delete
Add complementary product to bundle.
post
Update product bundle quantity.
put
Change products's order in the bundle.
put
Products
[DEPRECATED; EOL 2025-06-03] Show details of product.
get
Create new product.
post
Archive products by IDs.
put
Create a copy of product.
post
Get products using cursor with details from given views.
post
Show list of products filtered by type with details from given views.
post
Show list of products filtered by asset ids with details from given views.
post
Show list of products filtered by ids with details from given views.
post
Show list of products filtered by numbers with details from given views.
post
Change products state by ids.
post
Unarchive products by ids.
put
Show product details.
get
Update product main details, supports partial update.
patch
[DEPRECATED; EOL 2025-06-03] Update product details.
put
Create a copy of product.
post
Show product filtered by id with view.
post
Change products state.
post
Products templates
List all product templates.
get
Delete product template.
delete
Show details of product template.
get
Create product template.
post
Update product template.
put
Products assets
Retrieve the assets associated with a product.
get
Associate assets with a product.
post
Set assets for a product.
put
Disassociate an asset from a product.
delete
Associate an asset with a product.
post
Move an asset within a product.
put
Products attributes
Add attribute values in given set of products.
post
Upsert attribute values in given set of products.
post
Update attribute values in given set of products.
put
Append dictionary value to products.
post
Deduct dictionary value from products.
post
Append select/multiselect values to products.
post
Deduct select/multiselect values from products.
post
Retrieve the attributes associated with a product.
get
Add an attribute to a product.
post
Update or set many attributes on product.
put
Add column attribute to product.
post
Update column attribute of product.
put
Add dictionary attribute to product.
post
Set values for dictionary attribute of product.
post
Add matrix attribute to product.
post
Update matrix attribute of product.
put
Delete product attribute.
delete
Update product attribute.
put
Get grouped product attributes.
get
Products connections
Show all relations with directions for product.
get
[DEPRECATED; EOL 2025-10-20] Show all connections for categories.
get
[DEPRECATED; EOL 2025-10-20] Create new connection between products and categories.
post
[DEPRECATED; EOL 2025-10-20] Delete connection between products and categories.
delete
Create new connection between products.
post
Update related products relation sorting order source.
put
Delete all connections between products based on a given relation.
delete
Retrieve related products for given product and relation.
get
Create new connections between products.
post
Remove multiple connections from the given product.
delete
Update order product relations.
put
Delete connection between products.
delete
Update order product connections.
put
Update connection quantity.
put
Category policy
Get policies by category node id.
get
Add policy to category node.
post
Delete policy by category node and policy id.
delete
Get policies by category id.
get
Add policy to category.
post
Delete policy by category and policy id.
delete
Get categories by policy id.
get
Get categories node by policy id.
get
Compound attribute definitions
Lists details of compound attribute definition.
get
Create compound attribute definition.
post
List all compound attributes that use the attribute definition.
get
Delete compound attribute definition.
delete
Show details of compound attribute definition.
get
Update compound attribute definition.
put
Products labels
Remove label from the set of products.
delete
Add label to the set of products.
post
Remove labels from the product.
delete
Show list of associated product's label ids.
get
Associate given labels with product.
post
Remove associated labels from product.
delete
Attribute definitions
List all attribute definitions.
get
Create attribute definition.
post
Create column attribute definition.
post
Update column attribute definition.
put
Show number of elements affected by the column attribute definition update operation.
put
Create dictionary attribute definition.
post
Update selected items limit for dictionary attribute definition.
patch
Update dictionary attribute definition.
put
Delete dictionary parent from dictionary definition.
delete
Set dictionary parent for filtering dictionary values.
post
Create dictionary attribute value.
post
Count dictionary attribute values for given dictionary attribute definition.
post
List filtered dictionary attribute definitions.
post
List filtered dictionary attribute values.
post
Delete dictionary attribute value.
delete
Show details of dictionary attribute value.
get
Update dictionary attribute.
patch
Delete dictionary attribute value parent/child filter.
delete
Create dictionary attribute value parent/child filter.
post
List filtered attribute definitions.
post
Create matrix attribute definition.
post
Update matrix attribute definition.
put
Show number of elements affected by the matrix attribute definition update operation.
put
List simple attribute definitions.
get
Delete simple attribute definition.
delete
Show details of attribute definition.
get
Update attribute definition.
patch
Update simple attribute definition.
put
Show number of elements affected by the attribute definition delete operation.
delete
Show number of elements affected by the attribute definition update operation.
put
List all products that use the simple attribute definition.
get
Relation policy
Get relation by policy id.
get
Get relation policies.
get
Add policy to the relation.
post
Delete policy.
delete
Relations
Show all relation definitions.
get
Create new relation definition.
post
Filter relation definitions.
post
Delete relation definition.
delete
Show relation definition details.
get
Update relation definition.
put
[DEPRECATED; EOL 2025-10-20] Show all categories connections using relation.
get
Update relation definition order.
put
Show all product relations using relation definition.
get
Product variants
Create variant group.
post
Retrieve variant level attribute (VLA).
get
Update variant level attribute (VLA).
put
Unassign product variant.
delete
Assign product variant.
put
Update product variant order.
put
Catalog node assets
List categories associated with asset.
get
List assets associated with category.
get
Disassociate asset from category.
delete
Associate asset with category.
post
Change asset's order.
put
Technical
Show service version.
get
Media bank
Technical
Show service version.
get
Health checks.
get
Labels
Lists labels.
get
Create a custom type of media label.
post
Create a specified type of media label.
post
Get label with given id.
get
Update a custom type of media label.
put
Delete a custom type of media label.
delete
Update a specified type of media label.
put
Delete a specified type of media label.
delete
List specified type of media labels.
post
Upload
Complete asset creation. The asset will be moved to \assets path.
post
Lists assets in upload phase for current user.
get
Create new empty asset. The asset will not be available for other users until done operation is completed.
post
Update the asset's information to be uploaded.
put
Create new version for existing asset. The new asset version will not be available for other users until done operation is completed.
post
Cancel asset's creation. Any uploaded file and asset will be removed.
delete
Asset attributes
Assign attribute to asset.
post
Unassign attribute from asset.
delete
Get list of attributes associated to asset.
get
Set values to dictionary asset's attribute
put
Set values to select asset's attribute
put
Set value to simple asset's attribute
put
Assets
Sets the assets labels attribute.
put
Adds labels to asset's labels.
post
Bulk add assets label.
post
Bulk delete assets label.
delete
Bulk update of asset published flag.
put
Describe asset.
get
Mark current asset as deleted.
delete
Describe working asset versions.
get
Duplicate the asset.
post
Generate fixed link for latest version of asset. Full url follows the scheme: [pms-host]/latest/{url}
put
Describe working assets. Search enabled by assetIds with paging.
post
Describe working assets. Search enabled with query parameters.
post
List working asset using cursor.
post
Removes given label from the asset's labels.
delete
Bulk delete operation for list of assets.
delete
Revert version of asset.
post
Update asset alpha channel flag.
put
Update asset clipping path.
put
Update asset description.
put
Update asset internal flag.
put
Update asset name.
put
Update asset number.
put
Update asset published flag.
put
Search
Full-text search
Execute the search query.
get
Search
Search for products using an Elasticsearch query.
post
Search for products using an Elasticsearch query and scroll.
post
Count for products using an Elasticsearch query.
post
Search for assets using an Elasticsearch query.
post
Count for assets using an Elasticsearch query.
post
Labels
Labels
Get a label.
get
Update a label.
put
Delete a label.
delete
List labels.
get
Create a new label.
post
List labels by ids.
post
Global settings
Filters
Grant or update filter permission to user.
put
Revoke filter permission from user.
delete
List public and private filters using filtering criteria.
post
List filters using filtering criteria.
post
Create new filter.
post
Get filter by using id.
get
Delete filter using id.
delete
Update filter using id.
patch
Delete filter of any user.
delete
Update public and private filter
patch
Lists users with filter permission.
get
Contexts
Get context definition.
get
Update context definition.
put
Archive context definition.
delete
List all context definitions.
get
Create context definition.
post
History
History
Retrieve history events.
get
Retrieve history events for given entity type.
get
Retrieve history events for given entity.
get
Retrieve history events for given entity type with cursor. Recommended for retrieving large sets of results.
get
Retrieving the history of events for a given type of entities that have a value from the query.
get
Retrieve history events for given entity that have a value from the query.
get
Sync
Technical
[DEPRECATED; EOL 2025-05-01] Show service version.
get
Diff
[DEPRECATED; EOL 2025-05-01] Get difference for product from requested sync.
get
Metadata
[DEPRECATED; EOL 2025-05-01] List metadata providers.
get
[DEPRECATED; EOL 2025-05-01] Add metadata provider.
post
[DEPRECATED; EOL 2025-05-01] Get metadata provider.
get
[DEPRECATED; EOL 2025-05-01] Update metadata provider.
put
[DEPRECATED; EOL 2025-05-01] Remove metadata provider.
delete
Report
[DEPRECATED; EOL 2025-05-01] Get reports of analysing product states in PIM and PAPI.
get
[DEPRECATED; EOL 2025-05-01] Get attribute groups.
get
[DEPRECATED; EOL 2025-05-01] Get category details.
get
[DEPRECATED; EOL 2025-05-01] Get categories.
get
[DEPRECATED; EOL 2025-05-01] Exclude all products.
post
[DEPRECATED; EOL 2025-05-01] Exclude category.
post
[DEPRECATED; EOL 2025-05-01] Exclude product.
post
[DEPRECATED; EOL 2025-05-01] Get attribute group details.
get
[DEPRECATED; EOL 2025-05-01] Include all products. Does not apply to invalid products.
post
[DEPRECATED; EOL 2025-05-01] Include category.
post
[DEPRECATED; EOL 2025-05-01] Include product.
post
[DEPRECATED; EOL 2025-05-01] Get product details.
get
[DEPRECATED; EOL 2025-05-01] Get products.
get
[DEPRECATED; EOL 2025-05-01] Get relation details.
get
[DEPRECATED; EOL 2025-05-01] Get Relations.
get
[DEPRECATED; EOL 2025-05-01] Get report summary.
get
State
[DEPRECATED; EOL 2025-05-01] Get service state.
get
Sync
[DEPRECATED; EOL 2025-05-01] Get sync.
get
[DEPRECATED; EOL 2025-05-01] Cancel sync process.
delete
[DEPRECATED; EOL 2025-05-01] Get sync processes in chronological order.
get
[DEPRECATED; EOL 2025-05-01] Initiate sync process. If successful report creation is started.
post
[DEPRECATED; EOL 2025-05-01] Get sync affected products.
get
[DEPRECATED; EOL 2025-05-01] Get sync metrics.
get
[DEPRECATED; EOL 2025-05-01] Publish data to public API.
post
Asset states
[DEPRECATED; EOL 2025-05-01] Search asset state.
post
[DEPRECATED; EOL 2025-05-01] Synchronise asset state during next sync.
post
Product states
[DEPRECATED; EOL 2025-05-01] Search product state.
post
[DEPRECATED; EOL 2025-05-01] Synchronise product state during next sync.
post
[DEPRECATED; EOL 2025-05-01] Allows to republish product without making in it any changes. It triesto update the product state last update date. If product is not found, it's justskipped.
put
Tasks
Technical
Show service version.
get
Task comments
List all comments with replies for given task.
get
Add a comment for given task
post
Add a comment reply for given task comment.
post
Tasks reminders
Get reminders for task.
get
Create reminder for task (max 5 allowed per task).
post
Update reminder config.
put
Delete reminder config.
delete
Tasks
Assign products to task.
post
Assign task.
put
Complete product in scope of a task.
put
List all tasks for organization.
get
Create new task.
post
Delete product from task scope.
delete
List all/archived/assigned/created tasks for user.
get
List all/archived/assigned tasks for user group.
get
Get single task by id.
get
Update task data.
put
List archived tasks for organization.
get
List folders of tasks for user.
get
Mark product as incomplete in scope of a task.
put
User tasks
Complete task by id of logged in user.
put
Get tasks of logged in user.
get
Get tasks assigned to logged in user.
get
Get task by id of logged in user.
get
Set task as important by id of logged in user.
put
Set task as unimportant by id of logged in user.
put
Revoke task by id of logged in user.
put
Query builder
Organization
/organization
delete
Products
Search for products for given query.
post
Get number of products for given query.
post
Scroll products for given query.
post
Create a new persisted product query.
post
Update persisted product query.
put
Delete persisted product query.
delete
List persisted product queries.
post
Search for persisted queries for given product.
post
savedView
Validate passed view
post
Public API sync
Products
List product states.
post
Change product states.
post
Session sync
Close session.
put
Cancel session.
put
Add products to session.
post
Create a new sync session.
post
Get sync session.
get
Categories
Resync category states.
post
List category states.
post
Session report
Create products report file.
post
Get products by issue type for the session.
post
Get assets by issue type for the session.
post
Create entities report file.
post
Create assets report file.
post
Get products report link.
get
Get products issues for the session.
get
Get entities issues for the session.
get
Get assets issues for the session.
get
Get entities report link.
get
Get assets report link.
get
Get a session report.
get
Public API
Products
/products/list
post
Show list of products filtered by ids.
post
Show list of products filtered by numbers.
post
/products/cursor/all
post
/products/{id}
get
Categories
/categories
get
/categories/{categoryId}/ancestors
get
/categories/scan
get
/categories/{categoryId}
get
/categories/{categoryId}/products
get
Syncs
Retrieves a collection of publish info for given tenant.
get
Retrieves the information about given PublishInfo environment.
get
Differences
/differences/products
get
/differences/sync/{id}/products
get
/differences/categories
get
/differences/sync/{id}/categories
get
/differences/attributes
get
/differences/sync/{id}/attributes
get
/differences/relations
get
/differences/sync/{id}/relations
get
Contexts
lists currently available publications
get
Health
/health
get
Relations
/relations
get
Attributes
/attributes
get
IDP
Additional user properties
Returns list of additional user properties.
get
Consents
Returns the latest agreement.
get
Check if user has approved latest agreement.
get
Accept agreement with given id.
post
API Clients
Returns list of registered API Clients.
get
Returns list of registered API Clients names and ids.
get
Dependent permissions
Returns list of all dependent permissions for a permissions.
get
Managed roles
Returns list of managed roles.
get
Returns managed role.
get
Me
Returns simplified list of UI permissions in account from token.
get
Organizations
Returns list of user organizations.
get
Return organization.
get
Permissions
Returns list of permissions.
get
Return permission.
get
Plugins
Returns ids of assigned plugins for organization from token.
get
Return permissions for specific plugin in organization.
get
Policies
Returns list of policies.
get
Create new policy.
post
Return policy.
get
Update policy.
put
Archive policy.
delete
Roles
Returns list of roles.
get
Create new role.
post
Returns role.
get
Archive role.
delete
Edit role.
put
Assign permissions by ids to role by id.
post
Revoke permissions by ids of role by id.
post
Get permissions for plugin.
get
Update permissions for plugin.
put
Assign plugin permissions to plugin.
post
Revoke plugin permissions from plugin.
post
Get default role.
get
Set default role.
post
Clear default role.
delete
Services
Returns list of registered API Clients names and ids.
post
UserGroups
Create new user group.
post
Returns list of user groups.
get
Returns total number of user groups.
get
Returns user group.
get
Update user group.
patch
Delete user group.
delete
/userGroups/{id}/duplicate
post
Add role to user group.
put
Remove role from user group.
put
Assign policy to user group
put
Unassign policy from user group
put
Add managed role to user group.
put
Remove managed role from user group.
put
Users
Returns list of users.
get
Create new user.
post
Returns user.
get
Update user.
put
Upload user picture.
put
Change user password.
put
Resend join email.
put
Set user status.
put
Update user type.
put
Grant role.
put
Revoke role.
put
Grant policy.
put
Revoke policy.
delete
Grant managed role.
put
Revoke managed role.
delete
Grant additional properties.
put
Revoke additional properties.
put
Assign user group to user.
put
Unassign user group from user.
delete
External notifications
Subscriptions webhook
Unsubscribe for given events for given webhook.
delete
Get all events subscriptions enabled for given webhook.
get
Subscribe for given events for given webhook.
put
Webhooks
Create webhook.
post
Search webhook.
post
Delete webhook.
delete
Get webhook.
get
[ASYNCHRONOUS ENDPOINT] Update webhook.
put
Subscriptions email
Get user aggregation configuration for given entity type.
get
Modify user aggregation configuration for given entity type.
put
Unsubscribe for given events for email channel.
delete
Get all events subscriptions enabled for email channel.
get
Subscribe for given events for email channel.
put
Subscriptions in-app
Unsubscribe for given events for in-app channel.
delete
Get all events subscriptions enabled for in-app channel.
get
Subscribe for given events for in-app channel.
put
Webhook messages
Ping webhook.
post
Get messages for a given webhook.
post
Messages in-app
Get in-app messages.
post
Get in-app user messages.
post
Mark all messages as read.
put
Mark message as read.
put
Mark message as unread.
put
Email messages
Get email messages.
post
Get email message.
get
Subscriptions apps queue webhook
Get info about apps queue webhook.
get
Update apps queue for the given webhook.
put
Subscriptions watch
Unsubscribe watch for given entities.
delete
Get all entities watched for given eventType.
get
Subscribe watch for given entities.
put
User configuration
Get general user configuration.
get
Modify general user configuration.
patch
Completeness score
Requirements
Update requirement.
put
Delete requirement.
delete
Add included category to requirement.
put
Remove included category to requirement.
delete
Add excluded category to requirement.
put
Remove excluded category to requirement.
delete
Create requirement.
post
List requirements.
post
Count requirements.
post
Get requirements for single entity.
get
Scores
Get scores.
post
Get category scores.
post
Stop ongoing calculation.
post
Start new calculation.
post
Recalculate score for entities.
post
Invalidate scores.
post
Get detailed scores for single entity.
get
Get calculation status.
get
Validation
Validate product attribute.
post
Validate definition value.
post
Get validation issues for product.
get
Powered by
lists currently available publications
get
https://api-us.bluestonepim.com/v1/contexts
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
