Docs
Documentation
API reference
Changelog
Open menu
Close menu
Documentation
Changelog
API
Sign up
Existing customer?
Sign in
Close sidebar
Close sidebar
All Issues
My Issues
Assigned
Closed
Recent
Projects
GraphQL API
iOS App
Marketing Site Redesign
Customer Portal
Version 3
Version 2
Version 1
Introduction
Assets
put
/assets
post
/assets
delete
/assets
get
/assets/{id}
put
/assets/{id}
delete
/assets/{id}
put
/assets/{id}/data
get
/assets/{id}/references
post
/assets/batch
post
/assets/batch/data
put
/assets/folders
post
/assets/folders
delete
/assets/folders
get
/assets/folders/{id}
put
/assets/folders/{id}
delete
/assets/folders/{id}
get
/assets/folders/{id}/assets
get
/assets/folders/{id}/assets/{filename}
get
/assets/folders/{id}/subfolders
post
/assets/folders/batch
get
/assets/ids
AttributeGroups
get
/attributegroups
put
/attributegroups
post
/attributegroups
delete
/attributegroups
get
/attributegroups/{id}
Attributes
get
/attributes
put
/attributes
post
/attributes
delete
/attributes
get
/attributes/{uid}
get
/attributes/{uid}/references
post
/attributes/batch
post
/attributes/batch/references
AttributeScopes
get
/attributescopes
put
/attributescopes
post
/attributescopes
delete
/attributescopes
get
/attributescopes/{uid}
post
/attributescopes/batch/attributes
Browse
get
/browse/categories
get
/browse/products
get
/browse/variantgroups
get
/browse/variants
Catalogues
get
/catalogues
post
/catalogues
delete
/catalogues
patch
/catalogues
get
/catalogues/{uid}
get
/catalogues/{uid}/children
get
/catalogues/{uid}/descendants
get
/catalogues/uids
Categories
get
/categories
post
/categories
delete
/categories
patch
/categories
get
/categories/{id}
delete
/categories/{id}
patch
/categories/{id}
get
/categories/{id}/attributevalues
patch
/categories/{id}/attributevalues
get
/categories/{id}/children
get
/categories/{id}/enrichmentinsights
patch
/categories/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}
get
/categories/{id}/products
get
/categories/{id}/products/count
get
/categories/{id}/references
patch
/categories/attributevalues
post
/categories/batch
post
/categories/batch/attributevalues
post
/categories/batch/children
post
/categories/batch/enrichmentinsights
patch
/categories/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}
post
/categories/batch/enrichmentinsights/{enrichmentInsightUid}
post
/categories/batch/identifiers
post
/categories/batch/products
post
/categories/batch/products/count
post
/categories/batch/references
get
/categories/identifiers/{identifierAlias}
get
/categories/identifiers/{identifierAlias}/{identifier}
get
/categories/ids
get
/categories/productattributes
post
/categories/productattributes
delete
/categories/productattributes
patch
/categories/productattributes
get
/categories/queryablefields
post
/categories/search
post
/categories/search/paged
Collections
get
/collections
put
/collections
post
/collections
delete
/collections
get
/collections/{uid}
get
/collections/{uid}/entities
get
/collections/{uid}/references
post
/collections/batch
post
/collections/batch/entities
post
/collections/batch/references
get
/collections/folders
put
/collections/folders
post
/collections/folders
delete
/collections/folders
get
/collections/folders/{uid}
get
/collections/folders/{uid}/collections
get
/collections/folders/{uid}/subfolders
Dimensions
get
/Dimensions
put
/Dimensions
post
/Dimensions
delete
/Dimensions
get
/Dimensions/{uid}
EnrichmentInsightSetups
get
/enrichmentinsightsetups
put
/enrichmentinsightsetups
post
/enrichmentinsightsetups
delete
/enrichmentinsightsetups
get
/enrichmentinsightsetups/{entityType}/availabledatareferences
get
/enrichmentinsightsetups/{uid}
Exports
post
/exports/buildexport
get
/exports/fields/{entityType}
GlobalLists
get
/GlobalLists
put
/GlobalLists
post
/GlobalLists
delete
/GlobalLists
get
/GlobalLists/{uid}
get
/GlobalLists/{uid}/values
put
/GlobalLists/{uid}/values
post
/GlobalLists/{uid}/values
post
/GlobalLists/batch
get
/GlobalLists/ByAlias/{alias}
post
/GlobalLists/ByAlias/batch
get
/GlobalLists/folders
put
/GlobalLists/folders
post
/GlobalLists/folders
delete
/GlobalLists/folders
get
/GlobalLists/folders/{uid}
get
/GlobalLists/queryablefields/{uid}
post
/GlobalLists/search/{uid}
delete
/GlobalLists/values
get
/GlobalLists/values/{uid}
get
/GlobalLists/values/{uid}/references
post
/GlobalLists/values/batch
post
/GlobalLists/values/batch/references
Languages
get
/Languages
put
/Languages
post
/Languages
delete
/Languages
get
/Languages/{id}
Maintenance
get
/maintenance/{uid}
post
/maintenance/rebuildcategoryenrichmentinsights
post
/maintenance/rebuildcategoryidentifiers
post
/maintenance/rebuildcategoryindex
post
/maintenance/rebuilddynamiccategories
post
/maintenance/rebuildentityworkflowstates
post
/maintenance/rebuildgloballistindex
post
/maintenance/rebuildpimreferences
post
/maintenance/rebuildproductenrichmentinsights
post
/maintenance/rebuildproductidentifiers
post
/maintenance/rebuildproductindex
post
/maintenance/rebuildvariantenrichmentinsights
post
/maintenance/rebuildvariantgroupenrichmentinsights
post
/maintenance/rebuildvariantgroupidentifiers
post
/maintenance/rebuildvariantgroupindex
post
/maintenance/rebuildvariantidentifiers
post
/maintenance/rebuildvariantindex
Messaging
get
/messagequeues
put
/messagequeues
post
/messagequeues
get
/messagequeues/{uid}
delete
/messagequeues/{uid}
Miscellaneous
get
/Heartbeat
get
/misc/archivereasons
put
/misc/archivereasons
post
/misc/archivereasons
get
/misc/archivereasons/{uid}
delete
/misc/archivereasons/{uid}
get
/misc/models
get
/Version
Products
get
/products
post
/products
delete
/products
patch
/products
get
/products/{id}
delete
/products/{id}
patch
/products/{id}
get
/products/{id}/attributevalues
get
/products/{id}/classifications
post
/products/{id}/classifications
delete
/products/{id}/classifications
get
/products/{id}/enrichmentinsights
patch
/products/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}
get
/products/{id}/references
get
/products/{id}/variantgroups
get
/products/{id}/variants
post
/products/batch
post
/products/batch/attributevalues
post
/products/batch/classifications
post
/products/batch/enrichmentinsights
patch
/products/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}
post
/products/batch/enrichmentinsights/{enrichmentInsightUid}
post
/products/batch/identifiers
post
/products/batch/references
post
/products/batch/variantgroups
post
/products/batch/variants
post
/products/classifications
delete
/products/classifications
get
/products/identifiers/{identifierAlias}
get
/products/identifiers/{identifierAlias}/{identifier}
get
/products/ids
get
/products/queryablefields
post
/products/search
post
/products/search/paged
ProductStructures
get
/productstructures
put
/productstructures
post
/productstructures
get
/productstructures/{uid}
delete
/productstructures/{uid}
Publications
get
/publications/{templateExternalRef}/{id}/{languageId}
get
/publications/buildresult/{taskGuid}
get
/publications/buildstatus/{taskGuid}
post
/publications/dataonly
get
/publications/enqueue/{templateExternalRef}/{id}/{languageId}
post
/publications/enqueue/dataonly
post
/publications/enqueue/multipage
post
/publications/enqueue/pdf
get
/publications/enqueue/prints/{uid}/produce
post
/publications/enqueue/singlepage
post
/publications/multipage
post
/publications/pdf
get
/publications/prints
get
/publications/prints/{uid}/produce
post
/publications/singlepage
Security
get
/security/permissiongroups
put
/security/permissiongroups
post
/security/permissiongroups
get
/security/permissiongroups/{uid}
delete
/security/permissiongroups/{uid}
get
/security/permissions
put
/security/permissions
post
/security/permissions
get
/security/permissions/{uid}
delete
/security/permissions/{uid}
get
/security/usergroups
put
/security/usergroups
post
/security/usergroups
get
/security/usergroups/{id}
delete
/security/usergroups/{id}
get
/security/users
put
/security/users
post
/security/users
get
/security/users/{id}
delete
/security/users/{id}
Transactions
get
/transactions/{entityType}/{entityId}/revisiondata
get
/transactions/{uid}
get
/transactions/{uid}/changedentities
post
/transactions/batch
post
/transactions/batch/changedentities
get
/transactions/changes/{entityType}/{entityId}/{revisionNo}
post
/transactions/changes/batch
get
/transactions/search
UserTasks
get
/usertasks
put
/usertasks
post
/usertasks
delete
/usertasks
get
/usertasks/{uid}
put
/usertasks/{uid}/comments
post
/usertasks/{uid}/comments
delete
/usertasks/{uid}/comments
post
/usertasks/batch
VariantGroups
get
/variantgroups
post
/variantgroups
delete
/variantgroups
patch
/variantgroups
get
/variantgroups/{id}
delete
/variantgroups/{id}
patch
/variantgroups/{id}
get
/variantgroups/{id}/attributevalues
get
/variantgroups/{id}/classifications
post
/variantgroups/{id}/classifications
delete
/variantgroups/{id}/classifications
get
/variantgroups/{id}/enrichmentinsights
patch
/variantgroups/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}
get
/variantgroups/{id}/references
get
/variantgroups/{id}/variants
post
/variantgroups/batch
post
/variantgroups/batch/attributevalues
post
/variantgroups/batch/classifications
post
/variantgroups/batch/enrichmentinsights
patch
/variantgroups/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}
post
/variantgroups/batch/enrichmentinsights/{enrichmentInsightUid}
post
/variantgroups/batch/identifiers
post
/variantgroups/batch/references
post
/variantgroups/batch/variants
post
/variantgroups/classifications
delete
/variantgroups/classifications
get
/variantgroups/identifiers/{identifierAlias}
get
/variantgroups/identifiers/{identifierAlias}/{identifier}
get
/variantgroups/ids
get
/variantgroups/queryablefields
post
/variantgroups/search
post
/variantgroups/search/paged
Variants
get
/variants
post
/variants
delete
/variants
patch
/variants
get
/variants/{id}
delete
/variants/{id}
patch
/variants/{id}
get
/variants/{id}/attributevalues
get
/variants/{id}/enrichmentinsights
patch
/variants/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}
get
/variants/{id}/references
post
/variants/batch
post
/variants/batch/attributevalues
post
/variants/batch/enrichmentinsights
patch
/variants/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}
post
/variants/batch/enrichmentinsights/{enrichmentInsightUid}
post
/variants/batch/identifiers
post
/variants/batch/references
get
/variants/identifiers/{identifierAlias}
get
/variants/identifiers/{identifierAlias}/{identifier}
get
/variants/ids
post
/variants/inheritedAttributeValues
get
/variants/queryfields
post
/variants/search
post
/variants/search/paged
Webhooks
get
/webhooks
put
/webhooks
post
/webhooks
get
/webhooks/{uid}
delete
/webhooks/{uid}
get
/webhooks/{webhookUid}/requests
get
/webhooks/{webhookUid}/requests/{requestUid}
Workflows
get
/workflows
put
/workflows
post
/workflows
get
/workflows/{uid}
delete
/workflows/{uid}
Open sidebar
v2
Introduction
Go to article
Languages & misc
Go to article
Attributes
Go to article
Collections
Go to article
Global lists
Go to article
Products
Go to article
Variants
Go to article
Product groups
Go to article
Media
Go to article
