Updates a catalog
PUThttps://euwest.api.elasticpath.com/catalogs/:catalog_id
Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog is not updated.
Request
Path Parameters
catalog_id stringrequired
The catalog ID.
- application/json
Body
required
Updated catalog.
data objectrequired
Responses
- 200
- default
An updated catalog with the following attributes.
- application/json
- Schema
- Example (from schema)
Schema
data objectrequired
links object
{
"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
errors object[]
{
"errors": [
{
"detail": "not processable",
"status": "422",
"title": "There was a problem processing your request."
}
]
}
Authorization: Authorization
name: Authorizationtype: httpin: headerscheme: bearer
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X PUT 'https://euwest.api.elasticpath.com/catalogs/:catalog_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"data": {
"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": {}
},
"id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
"type": "catalog"
}
}'
ResponseClear