Create a catalog node (category) or a top-level catalog.

post

https://api-us.bluestonepim.com/pim/catalogs/nodes

Creates a node in the catalog tree and returns its generated ID in the resource-id response header. Set the
request body parentId to place the node under an existing node; omit parentId to create a new top-level
catalog (the root of its own tree). Fails if validation is NAME and any catalog or category with the same
name already exists (the check is not limited to siblings). Also fails if number is not unique.

For more detailed information on how to work with catalogs and categories in Bluestone PIM, refer to our help
pages Create and manage catalogs and categories.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

validation

string

enum

required

When set to NAME, the request fails if another node with the same name already exists.
Omit it to allow duplicate names. The number must always be unique regardless of this setting.

Allowed:

Body Params

name

string

required

length between 1 and 1000

Specifies the name of the category (catalog node).

number

string | null

Specifies the number of the category (catalog node). This value must be unique across all catalogs and categories in Bluestone PIM. If not specified, the system will use the category ID, which is a unique identifier generated by the system, as the default category number.

parentId

string | null

Specifies the ID of the parent category (catalog node) to which this category belongs.

Example: 634c26e14cedfd0001775e9f

Headers

context

string

Specifies the context in which to operate. If omitted, the default context en is used.

In 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.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

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.

context-fallback

boolean

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.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

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.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

201Created This response indicates that the request was successful and a new catalog or category has been created. The new ID is included in the response headers under resource-id. Example: resource-id: 664cc80da825236207fe01a7

400Bad Request This response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.

409Conflict This response indicates that the request could not be completed due to a conflict with the current state of the target resource. This typically occurs when there are duplicate entries or other data conflicts.