Manage style custom fields

When to use this. Style custom fields are the extra data points your brand defines in Admin and then fills in on each style: fabric composition, fit, sustainability score, and so on. They are set up once at the organisation level and then appear on every style that matches the field’s brand/group/category restrictions. Use these endpoints to create and manage that field catalogue and to bulk-update lifecycle states.

The workflow

Custom fields are admin data: a CompanyAdmin defines the fields, optionally restricts them to certain brands, groups, or categories, and then users fill them in on individual styles. The usual path is to create the field, verify it is visible on styles, and retire it when no longer needed.

Create the field

POST /api/style-custom-fields with the field name, type, and position. The body is an array: one or many fields are created in a single all-or-nothing transaction.

Add allowed values (dropdown fields only)

For allowedValue and nestedAllowedValue fields, include allowedValues in the create body, or add them later via PUT /api/style-custom-fields/{id} (full replacement) or PATCH /api/style-custom-fields/{id} (partial update).

Browse and filter

GET /api/style-custom-fields to list fields by type, state, brand, group, or category. Use cursor-based pagination for large catalogues. GET /api/style-custom-fields/{id} returns one field with its allowed values and brand, group, and style category associations embedded.

Retire fields

PUT /api/style-custom-fields (bulk) to flip states across multiple fields in one call: an item sent with state: "deleted" is soft-deleted. DELETE /api/style-custom-fields/{id} to soft-delete a single field (sets state to deleted). A field’s position is set on create and cannot be changed through these endpoints.

Walkthrough

Create a mandatory text field called “Fabric Composition” that suppliers can edit. The body is an array so you can create several fields in one request.

curl -X POST "https://service.my.delogue.com/api/style-custom-fields" \
  -H "Accept: application/json" \
  -H "X-Auth-Token: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "name": "Fabric Composition",
    "userDefinedId": "FAB-01",
    "type": "text",
    "position": 5,
    "state": "active",
    "internalOnly": false,
    "isMandatory": true,
    "isSupplierEditable": true,
    "isMultiLine": false,
    "isSortByAllowedValueId": false,
    "diffPerColor": false,
    "diffPerSize": false,
    "useInThumbnailViewGroupBy": false,
    "maxChar": 200,
    "allowedDecimals": 0,
    "numericVariantCalculationFormula": "none",
    "parentCustomFieldId": null,
    "allowedValues": null,
    "associatedBrands": null,
    "associatedGroups": null,
    "associatedStyleCategories": null
  }
]'

const res = await fetch("https://service.my.delogue.com/api/style-custom-fields", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "X-Auth-Token": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify([
  {
    "name": "Fabric Composition",
    "userDefinedId": "FAB-01",
    "type": "text",
    "position": 5,
    "state": "active",
    "internalOnly": false,
    "isMandatory": true,
    "isSupplierEditable": true,
    "isMultiLine": false,
    "isSortByAllowedValueId": false,
    "diffPerColor": false,
    "diffPerSize": false,
    "useInThumbnailViewGroupBy": false,
    "maxChar": 200,
    "allowedDecimals": 0,
    "numericVariantCalculationFormula": "none",
    "parentCustomFieldId": null,
    "allowedValues": null,
    "associatedBrands": null,
    "associatedGroups": null,
    "associatedStyleCategories": null
  }
]),
});
const { data } = await res.json();

{
  "status": "success",
  "code": "style_custom_fields_created",
  "data": [
    {
      "id": 30100,
      "name": "Fabric Composition",
      "userDefinedId": "FAB-01",
      "type": "text",
      "state": "active",
      "position": 5,
      "maxChar": 200,
      "allowedDecimals": 0,
      "numericVariantCalculationFormula": "none",
      "parentCustomFieldId": null,
      "parentCustomFieldName": null,
      "allowedValues": [],
      "associatedBrands": [],
      "associatedGroups": [],
      "associatedStyleCategories": [],
      "properties": [
        "mandatory",
        "supplierEditable"
      ]
    }
  ]
}

The response wraps the created fields in the standard envelope. Hold onto each id: updates and deletes reference fields by it.

Field reference

The fields that matter most when creating or updating a style custom field:

Field	What it means at Delogue
`allowedDecimals`	For numeric fields: number of decimal places permitted (0 = integers only). Defaults to 0.
`allowedValues`	Initial allowed value options for allowedValue and nestedAllowedValue fields. Omit or null to start with no options.
`associatedBrands`	Brands to restrict this field to. Omit or null to show the field on all styles regardless of brand.
`associatedGroups`	Style groups to restrict this field to. Omit or null to show the field on all styles regardless of group.
`associatedStyleCategories`	Style categories to restrict this field to. Omit or null to show the field on all styles regardless of category.
`diffPerColor`	When true, the field stores a separate value for each colour variant of a style.
`diffPerSize`	When true, the field stores a separate value for each size of a style.
`internalOnly`	When true, the field is hidden from supplier users.
`isMandatory`	When true, the style cannot be set to ‘Ready for Export’ until this field is filled in.
`isMultiLine`	For text fields: when true, a multi-row text box is shown instead of a single-line input.
`isSortByAllowedValueId`	For allowedValue and nestedAllowedValue fields: when true, the dropdown is sorted by user-defined ID rather than value text.
`isSupplierEditable`	When true, supplier users may edit this field’s value on a style.
`maxChar`	Maximum character limit for text or allowed-value fields. Null means no limit.
`name`	Display name of the custom field. Required.
`numericVariantCalculationFormula`	For numeric fields with diffPerColor or diffPerSize: how values are aggregated in reports. none, average, or sum.
`parentCustomFieldId`	For nestedAllowedValue child fields: the ID of the parent custom field. Null for top-level fields.
`position`	Display order position, set on create. Defaults to 0 and must be zero or greater. Lower values appear first in the Custom Fields tab. Cannot be changed with PUT.
`state`	Initial lifecycle state. active or inactive. Defaults to active. Cannot be deleted on create; use DELETE after creation.
`type`	Field type. One of: allowedValue, date, text, nestedAllowedValue, numeric, divider. Cannot be changed after create.
`useInThumbnailViewGroupBy`	When true, styles can be grouped by this field’s value in the Thumbnail View.
`userDefinedId`	Optional customer-assigned identifier. Used for ERP integrations and data imports/exports.

For a partial update, PATCH /api/style-custom-fields/{id} accepts an RFC 6902 JSON Patch document (Content-Type: application/json-patch+json). Only the paths you send are written; every other field keeps its current value. A replace to null on userDefinedId or maxChar clears it. When a patch touches allowedValues, associatedBrands, associatedGroups, or associatedStyleCategories, the resulting array is the complete new set (an empty array clears it), while a collection the patch does not touch is left as it is. position is read-only, a patch that targets /id is rejected, and state: "deleted" is rejected: use DELETE so the delete-time checks run.

Roles & permissions

Managing style custom fields requires the custom_fields permission on a designer (brand) CompanyAdmin account. CompanyUser accounts can read the field catalogue but cannot create, update, or delete fields. Supplier accounts have no access to the admin catalogue.

diffPerColor and diffPerSize depend on your organisation’s per-colour and per-size custom field modules. Setting either without the matching module returns a 400, and a field cannot differ per colour and per size at the same time.

When things go wrong

Errors use the standard envelope (status: "error", a code, and error.details[]). See Errors & responses for the full list of codes and how to resolve them. Common cases:

400: name was omitted on create.
400 validation_error.not_allowed: position was supplied on a PUT (single or bulk); it cannot be changed after create.
400 business_rule_error.business_rule_failed: state=deleted supplied on PUT {id} or PATCH {id} (use DELETE instead).
400 / 422: a PATCH operation targets /position or a path the field does not have.
403: the {id} on GET, PUT, or PATCH /api/style-custom-fields/{id} belongs to a different organisation.
404 resource_error.style_custom_field_not_found: the {id} does not exist (on GET and PATCH, also when the field has been deleted; on DELETE, also when it belongs to a different organisation).
409: a test operation in a PATCH document failed.
422: any other PATCH operation that cannot be applied to the field.

What to call next

Style categories

Scope custom fields to specific style categories for cleaner per-product-type layouts.

Size ranges

Set up the sizes used with diffPerSize custom fields.

Colours

Manage the colour library used with diffPerColor custom fields.

API reference

Full parameter reference for all style custom field endpoints.

Getting Started

Concepts

Guides

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next

Style categories

Size ranges

Colours

API reference

​The workflow

​Walkthrough

​Field reference

​Roles & permissions

​When things go wrong

​What to call next

Style categories

Size ranges

Colours

API reference

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next