# Changelog

Notable documented changes to Sales Layer REST API references are listed on this page.

This changelog follows Semantic Versioning and is intended for API consumers.

## Current documented references

- DAM REST API v2.0
- Catalog REST API v2.0


## [0.7.0] - 2026-06-04

### Current API surface

- The DAM and Catalog REST APIs are documented against the current OpenAPI specifications.
- The supported DAM image endpoints are:
  - `GET /image`
  - `DELETE /image/{id}`


### Changed

- **DAM:** `POST /image` and `PATCH /image/{id}` have been temporarily removed from the documentation and the OpenAPI specification. These endpoints will return in a future version. Until then, image import and image update are not available through the documented API surface.


### Documentation

- Grouped the Catalog endpoint reference in the sidebar by resource (Metadata, Products, Variants, Categories, Custom Entities) using OpenAPI tags. The DAM endpoint reference is grouped under Image.
- Aligned guides, overviews, and examples with the current OpenAPI specifications.


### Postman

- Expanded the Postman collection to include at least one ready-to-run example of every endpoint in the current specifications (DAM and Catalog).
- Organized requests to match the API reference, labeled write operations, and added scripts that capture created identifiers for full create-read-update-delete lifecycles.
- Updated the environment template: added `attributeSetIdentifier` and removed `sampleImageUrl`.


## [0.6.0] - 2026-05-23

### Current API surface

- The DAM REST API is documented against the current OpenAPI specification.
- The supported DAM image endpoints are:
  - `GET /image`
  - `POST /image`
  - `PATCH /image/{id}`
  - `DELETE /image/{id}`


### Documentation

- Updated endpoint references so the changelog matches the published OpenAPI specification.
- Consolidated image operations under the current DAM paths.


## [0.4.0] - 2026-04-09

### Added

- Added the **DELETE** endpoint for removing images:
  - `DELETE /image/{id}`


### Behavior

- Successful deletion returns **204 No Content**
- The request is rejected if the image is currently being processed


### Validation

- **401 Unauthorized** — missing API key
- **400 Bad Request** — invalid request or invalid identifier
- **404 Not Found** — image not found
- **409 Conflict** — image is currently being processed


### Improved

- Improved API documentation for DELETE and PATCH operations
- Removed incorrect fields from the PATCH request body schema in the API documentation


## [0.3.0] - 2026-04-09

### Added

- Added the **PATCH** endpoint for partially updating images:
  - `PATCH /image/{id}`


### Supported operations

- Rename an image using `reference`
- Replace tags using `tags`
- Replace the image source using `url`


### Behavior

- Successful update returns **204 No Content**
- `reference` and `tags` can be combined in the same request
- The request is rejected if the image is currently being processed


### Validation

- **401 Unauthorized** — missing API key
- **400 Bad Request** — invalid request body or invalid field combinations
- **404 Not Found** — image not found
- **409 Conflict** — image is currently being processed


## [0.2.0] - 2026-04-02

### Added

- Added the **POST** endpoint for creating images from public URLs:
  - `POST /image`


### Behavior

- Supports image creation from a public HTTP or HTTPS URL
- Supports optional tags
- Validates image format, size, dimensions, and request payload


### Supported formats

- JPEG
- PNG
- GIF
- TIFF
- WebP
- PSD


### Validation

- **400 Bad Request** — invalid URL, unsupported format, invalid tags, or invalid image constraints
- **401 Unauthorized** — missing API key
- **500 Internal Server Error** — unexpected processing error


## [0.1.0] - 2026-03-04

### Added

- Added the **GET** endpoint for listing and filtering images:
  - `GET /image`


### Behavior

- Supports filtering
- Supports sorting
- Supports pagination
- Supports OData-style query parameters documented in the API reference


### Validation

- **400 Bad Request** — invalid query parameters
- **401 Unauthorized** — missing API key