Get item type configuration

Retrieves the complete configuration for an item type including schema settings and destination connections.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Unconfigured item types

Item types without configuration return empty arrays for the following:

  • Schema identifiers
  • Schema attributes
  • Destinations

Destination configuration

Each destination configuration includes three top-level properties: name, type, and target. The shape of target depends on the destination type.

Search target

Search destinations use the following target properties:

  • discovery_account_name
  • discovery_catalog_name
  • discovery_environment_name

Marketing target

Marketing destinations use a single target property:

  • engagement_project_id

Destination limits

The current implementation allows, per item type within a collection:

  • At most one Search destination
  • At most one Marketing destination

The schema remains open to future expansion beyond this limit.

Identifier mapping defaults

Default failure handling for identifier mappings can be represented in any of the following ways:

  • An omitted policies property
  • An empty policies object
  • An explicit strategy value of 'default'

Attribute mapping defaults

System attribute inheritance

System attributes inherit their accepted names and effective data types from the global meta configuration endpoint.

Policy defaults

Attribute policies and source-mapping policies can be omitted or sent as empty objects to apply the current system default behavior: 'skip_attribute'.

The deprecated strategy values 'default' and 'error' are treated the same as 'skip_attribute'.

category_paths builder mapping

The system attribute category_paths supports mapping_type: 'builder'. This uses the category builder to assemble CategoryPaths from either:

  • source_fields
  • level_fields
Path Params
uuid
required
length between 36 and 36

Unique identifier for the workspace

string
required
length ≤ 128

Name of the collection

string
required
length between 1 and 64

Type of the item. Currently only 'product' is supported.

string
required
length ≤ 64

Configuration identifier to retrieve (latest alias or configuration etag)

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© Bloomreach, Inc. All rights reserved.