Skip to main content
This page tracks changes to the API surface described in this reference. Entries are dated and listed newest first.

​
How to read this page

Each entry groups its changes into up to four sections — only the sections with something to report for that date appear: Each line is a one-sentence, plain-language summary naming the affected operation.

​
2026-08-17

This entry adds a large batch of new API surface and refreshes how the shared response and error envelopes are described. The consumer-facing highlights are below.

​
Added

  • Twelve new entities now appear in the reference — Barcodes, Care Instruction Icons, Measurement Charts, Organizations (integration access), Sample Requests, Style Care Instructions, Style Contacts, Style Files, Style Prices, Style Relations, Style SKUs, and Style Supplier Facilities — 42 operations in all, each with a task-based guide.
  • Partial-update endpoints accepting an RFC 6902 JSON Patch document (application/json-patch+json): PATCH /api/brands/{id}, PATCH /api/compliance-categories/{id}, PATCH /api/groups/{id}, PATCH /api/sample-types/{id}, PATCH /api/size-ranges/{id}, PATCH /api/style-custom-fields/{id}, and PATCH /api/styles/{id}.
  • PUT /api/brands — bulk full-replace of brands in a single transaction.
  • PUT /api/styles/{id} — full-replace update of a single style; and GET /api/styles/{styleId}/size-range and GET /api/styles/{styleId}/sizes — read a style’s size range and its sizes.
  • PUT /api/brands, PATCH /api/brands/{id} — brand writes now accept an optional logo file reference.

​
Changed

  • Response envelopes are now named schemas. Success responses use ApiResponseOf… / ApiPaginatedResponseOf… wrappers and errors use ApiErrorResponse / ProblemDetails; the documented envelope shape ({ status, code, data } for success, { status, code, error } for errors) is unchanged.
  • Error responses are application/json only. The text/json and text/plain media types were dropped from the 401 and 500 responses across all endpoints.

​
2026-07-07

​
Added

  • PATCH /api/seasons/{id} — partially update a season with an RFC 6902 JSON Patch document (application/json-patch+json).
  • PATCH /api/compliance-custom-fields/{id} — partially update a compliance custom field with a JSON Patch document.
  • DELETE /api/item-categories and PATCH /api/item-categories/{id} — bulk-delete item categories via repeated ids, and partially update a single category with a JSON Patch document.
  • DELETE /api/style-categories and PATCH /api/style-categories/{id} — bulk-delete style categories via repeated ids, and partially update a single category with a JSON Patch document.
  • PUT /api/item-categories, PUT /api/item-categories/{id} — the request state now accepts the enum values active, inactive, and deleted.
  • POST /api/items, PUT /api/items, PUT /api/items/{itemId} — item customFields entries accept a new optional values array for multi-select allowed-value fields and an object for value.
  • GET/POST/PUT/DELETE /api/brands — brand responses include a new optional associatedDesignerOrganizations on the logo file’s createdBy user.

​
Changed

  • GET /api/styles — added the optional StyleInfoUpdatedOn date-range query parameter to filter styles by when their style info last changed.
  • Breaking: PUT /api/compliance-custom-fields, PUT /api/compliance-custom-fields/{id} — the request booleans internalOnly, isMandatory, isMultiLine, and isSortByAllowedValueId are no longer nullable; on the full-replace PUT, omitting one writes false.
  • Breaking: PUT /api/item-categories, PUT /api/item-categories/{id} — the request state was restricted to the active/inactive/deleted enum and no longer accepts null.
  • Breaking: PUT /api/items, PUT /api/items/{itemId} — the item customFields entry id (the custom-field definition id) is now required (non-nullable).
  • Breaking: GET /api/styles — the ReadyForExport query parameter changed from an array of integers to a boolean.

​
Removed

  • POST /api/items, PUT /api/items, PUT /api/items/{itemId} — removed the item customFields request properties customFieldId, itemCustomFieldAllowedValueId, and customFieldAllowedValueUserDefinedID (replaced by id and the value/values objects).
  • POST /api/brands, PUT /api/brands/{id} — removed the logo request property; these endpoints no longer accept a brand logo in the request body.

​
2026-07-02 — Baseline

The first entry on this page. It describes the reference as it stands today rather than a single change — every entry from here forward describes what changed since the previous one. Documented in this reference: 134 operations across 50 endpoint paths, covering 20 entities: Brands, Care Instructions, Care Instruction Layers, Care Instruction Materials, Color Groups, Colors, Compliance Categories, Compliance Custom Fields, Facilities, Groups, Item Categories, Items, Sample Types, Seasons, Size Ranges, Style Categories, Style Custom Fields, Style Items, Styles, and Sub-Suppliers.