8.12
8.12
API Changelog — v8.12
Release Date: 23 September 2026
Improved
GET /clients/clients,POST /clients/clients,PUT /clients/clients,PUT /orders/ordersupdated. 22 new schema(s) added.
New Endpoints
| Method | Path | Description |
|---|---|---|
POST | /icons/list | List of icons assigned to product. |
POST | /pictures/list | List of pictures assigned to product. |
POST | /pictures/recovery | Picture recover from trash. |
PUT | /products/groups/groupProducts | All products must be of compatible types, and must not exceed the variant limit. |
PUT | /products/groups/ungroupProducts | Results are returned in the original request order. When the operation does not fully succeed for every product, the HTTP status is downgraded to 207 Multi-S... |
POST /icons/list
POST /icons/listRequest body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
request | ProductIconsViewRequest | No | Product icons list request |
request.productId | integer | No | |
request.shopId | integer | No | |
request.iconsMacroType | string | No | Values: small, large. |
request.inTrash | boolean | No | |
request.langId | string | No | |
request.pagination | PaginationFilter | No | Pagination settings. |
request.pagination.page | integer | No | Page index (starting from 0) |
request.pagination.perPage | integer | No | Number of records per page. |
Responses: 200, 207, 401, 403, 404, 422, 429, 500
POST /pictures/list
POST /pictures/listRequest body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
request | ProductPicturesViewRequest | No | Product pictures list request |
request.productId | integer | No | |
request.shopId | integer | No | |
request.inTrash | boolean | No | |
request.picturesMacroType | string | No | Values: small, medium, large. |
request.pagination | PaginationFilter | No | Pagination settings. |
request.pagination.page | integer | No | Page index (starting from 0) |
request.pagination.perPage | integer | No | Number of records per page. |
Responses: 200, 207, 401, 403, 404, 422, 429, 500
POST /pictures/recovery
POST /pictures/recoveryRequest body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
request | ProductPicturesRecoverRequest | No | Product pictures recover request |
request.pictures | array | No | Product picture recover data |
request.pictures[] | ProductPictureRecoverData | — | Product picture recover data |
request.pictures[].productId | integer | No | |
request.pictures[].pictureName | string | No | Picture name |
request.pictures[].originalCephKey | string | No | Picture cephKey, unique hash for picture |
Responses: 200, 207, 401, 403, 404, 422, 429, 500
PUT /products/groups/groupProducts
PUT /products/groups/groupProductsRequest body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
request | GroupProductsRequest | ✅ Yes | Request for grouping products into a variant group |
request.products | array | ✅ Yes | List of products to group (minimum 2). Each product carries its own identifier, optional isMain flag and per-paramete... |
request.products[] | ProductToGroup | — | Product to be added to a variant group, with optional grouping metadata |
request.products[].identType | string | No | Product identifier type. Values: id, index, codeExtern, codeProducer. |
request.products[].identValue | string | ✅ Yes | Product identifier value |
request.products[].isMain | boolean | No | Marks this product as the main variant of the group. At most one product in the request may be set as main; if none i... |
request.products[].parameterValues | array | No | Distinguishing parameter value assignments for this product. Each entry pairs a parameter ID with its value names. |
request.products[].parameterValues[] | ParameterValueAssignment | — | Distinguishing values of a single parameter assigned to a product |
request.products[].parameterValues[].parameterId | integer | ✅ Yes | ID of the parameter (must be a parameter of type "Distinguishing variants"). |
request.products[].parameterValues[].valueNames | array | ✅ Yes | Value names for the parameter. Resolved by name in the current panel language; missing values are created automatically. |
request.products[].parameterValues[].valueNames[] | string | — | |
request.groupDistinctionParameterIds | array | No | IDs of parameters distinguishing products within the group (e.g. size, colour). |
request.groupDistinctionParameterIds[] | integer | — |
Responses: 200, 207, 401, 403, 404, 422, 429, 500
PUT /products/groups/ungroupProducts
PUT /products/groups/ungroupProductsRequest body (application/json):
| Field | Type | Required | Description |
|---|---|---|---|
request | UngroupProductsRequest | ✅ Yes | Request for ungrouping products from their variant group |
request.products | array | ✅ Yes | List of products to ungroup |
request.products[] | ProductIdentifier | — | |
request.products[].identType | string | No | Product identifier type. Values: id, index, codeExtern, codeProducer. |
request.products[].identValue | string | ✅ Yes | Product identifier value |
Responses: 200, 207, 401, 403, 404, 422, 429, 500
Modified Endpoints
GET /clients/clients (CRM)
GET /clients/clients (CRM)Changes:
- Response
200: added fieldresults[].clientPreferences.isLocalGovernmentUnit(string) — Is local government unit code for Podmiot3 in KSeF. Values:yes,no. - Response
207: added fieldresults[].clientPreferences.isLocalGovernmentUnit(string) — Is local government unit code for Podmiot3 in KSeF. Values:yes,no.
POST /clients/clients (CRM)
POST /clients/clients (CRM)Changes:
- Request body: added field
params.clients[].local_government_unit(string) — Is local government unit code for Podmiot3 in KSeF. Values:yes,no. - Request body: added field
params.clients[].affiliate_program(string) — Customer participation in the loyalty program: - no - customer does not participate in the loyalty program, - yes_voucher - customer participates, payouts only in vouchers, - yes_voucher_cash - customer participates, payouts in vouchers or cash, - banned - customer is blocked in the loyalty program. Values:no,yes_voucher,yes_voucher_cash,banned.
PUT /clients/clients (CRM)
PUT /clients/clients (CRM)Changes:
- Request body: added field
params.clients[].isLocalGovernmentUnit(string) — Is local government unit code for Podmiot3 in KSeF. Values:yes,no. - Request body: added field
params.clients[].clientAffiliateProgram(string) — Customer participation in the loyalty program: - no - customer does not participate in the loyalty program, - yes_voucher - customer participates, payouts only in vouchers, - yes_voucher_cash - customer participates, payouts in vouchers or cash, - banned - customer is blocked in the loyalty program. Values:no,yes_voucher,yes_voucher_cash,banned.
PUT /orders/orders (OMS)
PUT /orders/orders (OMS)Changes:
- Request body: added field
params.orders[].stockId(integer) — Order stock ID (stock handling the order). 0 - dropshipping (external stock), value greater than 0 - own stock. - Request body: added field
params.orders[].delivererId(integer) — Deliverer ID. Used (and required) only when stockId = 0 (dropshipping).
Schema Changes
Added schemas (22):
AddPictureRequest, BackgroundRemoveRequest, BackgroundRemoveResponse, GroupProductsRequest, GroupProductsResponse, ParameterValueAssignment, ProductGroupOperationResult, ProductIconView, ProductIconsViewRequest, ProductIconsViewResponse, ProductIdentifier, ProductParameterValues, ProductPictureRecoverData, ProductPictureViewResponse, ProductPicturesRecoverRequest, ProductPicturesRecoverResponse, ProductPicturesViewRequest, ProductPicturesViewResponse, ProductToGroup, ReplacePictureRequest, UngroupProductsRequest, UngroupProductsResponse
Generated from OpenAPI diff: v8.7 → v8.12
Updated about 13 hours ago
Did this page help you?