Creates a new catalog
POST/catalogs
Before you create a catalog, you must define the following resources:
- Hierarchies - hierarchies and nodes to categorize the products.
- Products - product information, associated assets, and links to hierarchy nodes.
- Price Books - prices for the products associated with the hierarchies. You can create multiple price books for different scenarios, such as seasonal sales, business versus retail customer pricing, and reward programs. When creating a catalog, you can specify up to five price books. You must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books. Priority is a number and the price book with the highest number has the highest priority.
Request
- application/json
Body
required
Creates a catalog with the following attributes.
- Array [
- ]
data objectrequired
attributes objectrequired
Possible values: non-empty
The name of the catalog.
A brief description of the catalog.
The unique identifiers of the hierarchies to associate with a catalog.
The unique identifier of the price book to associate with this catalog. You can specify either a pricebook_id or pricebook_ids but not both. If you specify both a pricebook_id and pricebook_ids, a 422 Unprocessable Entity error is displayed.
pricebook_ids object[]
Possible values: <= 5
If you want multiple price books for different scenarios, such as seasonal sales, business versus retail pricing, and reward programs, when creating a catalog, you can specify up to five price books. You must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books.
A unique identifier of a price book.
Priority is a number and the price book with the highest number has the highest priority.
locales object
Product Experience Manager supports localization of products and hierarchies. If you store supports multiple languages, you can localize product names and descriptions.
property name* object
A three-letter language code that represents the name of language you have used.
A three-letter language code that represents the name of language you have used.
Possible values: [catalog]
Represents the type of object being returned. Always Catalog.
Responses
- 201
- default
The created catalog
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data objectrequired
Creates a catalog with the following attributes.
A unique identifier of a catalog.
attributes objectrequired
The name of a catalog.
A brief description of the catalog, such as the purpose of the catalog.
The unique identifiers of the hierarchies associated with a catalog.
The unique identifier of a price book associated with a catalog. If no price book is selected, the catalog is displayed without prices.
pricebook_ids object[]
Possible values: <= 5
If you want multiple price books for different scenarios, such as seasonal sales, business versus retail pricing, and reward programs, when creating a catalog, you can specify up to five price books. You must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books.
A unique identifier of a price book.
Priority is a number and the price book with the highest number has the highest priority.
locales object
Product Experience Manager supports localization of products and hierarchies. If you store supports multiple languages, you can localize product names and descriptions.
property name* object
A three-letter language code that represents the name of language you have used.
A three-letter language code that represents the name of language you have used.
The date and time a catalog is created.
The date and time a catalog was updated.
Possible values: [store, organization]
Default value: store
The owner of this resource, can be either organization or store.
relationships object
Relationships are established between different catalog entities. For example, a catalog rule and a price book are related to a catalog, as both are associated with it.
rules object
The catalog rules related to a catalog.
links object
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
releases object
When a catalog is published, a catalog release is created. This is a URL to all catalog published releases available for this catalog.
links object
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.
meta object
The number releases available for a catalog.
Possible values: [catalog]
links object
Links allow you to move between requests.
Single entities use a self parameter with a link the specific resource.
Always the first page.
This is null if there is only one page.
This is null if there is only one page.
This is null if there is only one page.
{
"data": {
"id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
"attributes": {
"name": "catalog-123",
"description": "Catalog for Store 123",
"hierarchy_ids": [
"string"
],
"pricebook_id": "string",
"pricebook_ids": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": 0
}
],
"locales": {},
"created_at": "2020-09-22T09:00:00",
"updated_at": "2020-09-22T09:00:00",
"owner": "store"
},
"relationships": {
"rules": {
"links": {
"related": "string"
}
},
"releases": {
"links": {
"related": "string"
},
"meta": {
"count": 0
}
}
},
"type": "catalog"
},
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
Unexpected error.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]
{
"errors": [
{
"detail": "not processable",
"status": "422",
"title": "There was a problem processing your request."
}
]
}