Create new product.

post

https://api-us.bluestonepim.com/pim/products

Creates a single new product and returns its generated internal ID in the resource-id response header. Fails
if a product with the given number already exists, or if the organization's product quota would be exceeded.
When creating a product of type GROUP, any variant-defining, locked or mandatory attribute must be configured
to propagate to variants (copy = true); otherwise creation fails and lists the offending attribute definition
IDs. To create a product by copying an existing one, use the copy endpoints instead.

For more detailed information on how to work with new products in Bluestone PIM, refer to our help pages Create
new products.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

validation

string

enum

Validation is used for specifying whether NUMBER, or NUMBER and NAME must be
unique. NUMBER is the default validation. If NAME is specified, both NUMBER and NAME must be
unique. If no number parameter is supplied in the body of the request, the assigned id will be
used as the number.

Allowed:

Body Params

assets

array of strings | null

A value specifying the list of product assets id.

attributes

array of objects | null

A value specifying the list of product attributes.

categories

array of strings | null

A value specifying the list of product categories id.

description

string | null

labels

array of strings | null

A value specifying the list of product labels id.

name

string

required

number

string | null

relatedProductsRelationSortingOrderSource

string | null

enum

Allowed:

type

string | null

enum

Allowed:

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.

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 The new product's ID is included in the response headers under resource-id. See the example below: 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.