> ## Documentation Index
> Fetch the complete documentation index at: https://integration.delogue.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lists style items across the organization.

> Org-wide list, filterable by styleId, itemId, state, and properties=mainItem. Supply filter + sort + pageSize + pageNumber for page-based results, or a cursor for cursor-based results; cursor is mutually exclusive with filter/sort/pageSize/pageNumber.



## OpenAPI

````yaml https://service.my.delogue.com/openapi/external.json get /api/style-items
openapi: 3.1.1
info:
  title: Delogue External API - (Production)
  description: Integration endpoints for Delogue API
  version: 1.0.0
servers:
  - url: /
    description: The Delogue environment serving this document.
  - url: https://{host}
    description: Per-customer Delogue API host.
    variables:
      host:
        default: service.my.delogue.com
        description: >-
          The API host for your Delogue environment, e.g.
          service.<customer>.delogue.com.
security: []
tags:
  - name: Barcodes
  - name: Brands
  - name: CareInstructionIcons
  - name: CareInstructionLayers
  - name: CareInstructionMaterials
  - name: CareInstructions
  - name: Color Groups
  - name: Colors
  - name: ComplianceCategories
  - name: ComplianceCustomFields
  - name: Facilities
  - name: Groups
  - name: ItemCategories
  - name: Items
  - name: MeasurementCharts
  - name: MigrationApproval
  - name: MigrationVerification
  - name: OrganizationMigration
  - name: Organizations
  - name: SampleRequests
  - name: SampleTypes
  - name: Seasons
  - name: SizeRanges
  - name: Style Prices
  - name: StyleCareInstructions
  - name: StyleCategories
  - name: StyleColors
  - name: StyleContacts
  - name: StyleCustomFields
  - name: StyleFiles
  - name: StyleItems
  - name: StyleRelations
  - name: Styles
  - name: StyleSkus
  - name: StyleSupplierFacilities
  - name: SubSuppliers
  - name: Suppliers
paths:
  /api/style-items:
    get:
      tags:
        - StyleItems
      summary: Lists style items across the organization.
      description: >-
        Org-wide list, filterable by styleId, itemId, state, and
        properties=mainItem. Supply filter + sort + pageSize + pageNumber for
        page-based results, or a cursor for cursor-based results; cursor is
        mutually exclusive with filter/sort/pageSize/pageNumber.
      operationId: StyleItemsFiltering_Get
      parameters:
        - name: StyleId
          in: query
          description: Filters results to style items belonging to this style.
          schema:
            type: integer
            format: int64
        - name: ItemId
          in: query
          description: >-
            Filters results to style items referencing this item from the item
            library.
          schema:
            type: integer
            format: int64
        - name: State
          in: query
          description: Filters results to style items in this lifecycle state.
          schema:
            $ref: '#/components/schemas/StyleItemState'
        - name: Properties
          in: query
          description: >-
            Filters results to style items carrying the given property flags.
            Only mainItem is currently supported.
          schema:
            type: array
            items:
              type: string
        - name: sort
          in: query
          description: >-
            Repeat the parameter per sort column:
            `sort[0].property=<column>&sort[0].order=Ascending|Descending`,
            `sort[1]....` for a secondary column. `order` accepts asc, desc,
            ascending or descending (case-insensitive) and may also be spelled
            `direction`. Mutually exclusive with `cursor`. Sortable columns
            include: Id.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/SortDescriptorDto'
        - name: pageSize
          in: query
          description: >-
            Number of style items to return per page. Defaults to 30, maximum
            100.
          schema:
            pattern: ^-?(?:0|[1-9]\d*)$
            type:
              - integer
              - string
            format: int32
        - name: pageNumber
          in: query
          description: The 1-based page number to return. Defaults to 1.
          schema:
            pattern: ^-?(?:0|[1-9]\d*)$
            type:
              - integer
              - string
            format: int32
        - name: cursor
          in: query
          description: >-
            Opaque keyset pagination token for the next page. Mutually exclusive
            with the filter, sort, pageSize and pageNumber parameters.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiPaginatedResponseOfStyleItemDto'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPaginatedResponseOfStyleItemDto'
            text/json:
              schema:
                $ref: '#/components/schemas/ApiPaginatedResponseOfStyleItemDto'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
        - {}
components:
  schemas:
    StyleItemState:
      enum:
        - active
        - inactive
        - deleted
      type: string
      description: Lifecycle state of the item's placement on the style.
    SortDescriptorDto:
      type: object
      properties:
        property:
          type: string
          description: >-
            Property to sort by. Must be one of the entity's sortable
            properties.
        order:
          $ref: '#/components/schemas/SortOrderDto'
          description: >-
            Sort direction. Accepts asc, desc, ascending or descending
            (case-insensitive).
      additionalProperties: false
    ApiPaginatedResponseOfStyleItemDto:
      required:
        - status
        - code
        - data
        - pagination
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
          description: >-
            The coarse outcome of the request, indicating whether it succeeded
            or failed.
        code:
          type: string
          description: >-
            The specific machine-readable outcome code, such as ok on success or
            the most specific error code on failure. Always lowercase on the
            wire.
        data:
          type: array
          items:
            $ref: '#/components/schemas/StyleItemDto'
          description: >-
            The page of results, always an array. An empty page is an empty
            array rather than null or an omitted field.
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
          description: >-
            Paging metadata for this response, carrying whether more rows remain
            and the cursor used to request the next page.
      additionalProperties: false
    ApiErrorResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
          description: >-
            The coarse outcome of the request, indicating whether it succeeded
            or failed.
        code:
          type: string
          description: >-
            The specific machine-readable outcome code, such as ok on success or
            the most specific error code on failure. Always lowercase on the
            wire.
        error:
          $ref: '#/components/schemas/ErrorWrapper'
          description: >-
            The error payload, present instead of data on a failed response. It
            wraps the list of detail rows describing what went wrong.
      additionalProperties: false
    SortOrderDto:
      enum:
        - ascending
        - descending
      type: string
      description: >-
        Sort direction. Accepts asc, desc, ascending or descending
        (case-insensitive).
    ApiResponseStatus:
      enum:
        - success
        - error
      type: string
      description: >-
        The coarse outcome of the request, indicating whether it succeeded or
        failed.
    StyleItemDto:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the style item linking an item to the style.
          format: int64
        styleId:
          type: integer
          description: Identifier of the style this item belongs to.
          format: int64
        description:
          type:
            - 'null'
            - string
          description: >-
            Placement or usage note for the item on the style, or null when none
            is given.
        position:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: One-based display order of this item within the style's item list.
          format: int32
        quantity:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          description: Number of units of this item required per unit of the style.
          format: double
        dateAdded:
          type:
            - 'null'
            - string
          description: >-
            Timestamp when the item was added to the style, or null when it was
            not recorded.
          format: date-time
        state:
          $ref: '#/components/schemas/StyleItemState'
          description: Lifecycle state of the item's placement on the style.
        itemSize:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemSizeDto'
              description: >-
                The specific item size selected for this style item, or null
                when no size is selected.
          description: >-
            The specific item size selected for this style item, or null when no
            size is selected.
        item:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemDetailDto'
              description: Full detail of the linked item from the item library.
          description: Full detail of the linked item from the item library.
        properties:
          type: array
          items:
            type: string
          description: >-
            Active boolean flags for the style item, encoded as strings.
            mainItem marks the style's main composition item; includedCostPrice
            includes the item in the style cost price.
      additionalProperties: false
    PaginationInfo:
      required:
        - hasMore
        - cursor
      type: object
      properties:
        hasMore:
          type: boolean
          description: Whether at least one further row exists beyond the current page.
        cursor:
          type: string
          description: >-
            The opaque keyset position used to request the next page. It is an
            empty string when hasMore is false.
      additionalProperties: false
      description: >-
        Paging metadata for this response, carrying whether more rows remain and
        the cursor used to request the next page.
    ErrorWrapper:
      type: object
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailDto'
          description: >-
            The list of individual error detail rows for this failure, one per
            field or rule that failed.
      additionalProperties: false
      description: >-
        The error payload, present instead of data on a failed response. It
        wraps the list of detail rows describing what went wrong.
    StyleItemSizeDto:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the item size.
          format: int64
        name:
          type:
            - 'null'
            - string
          description: Display name of the size.
        state:
          $ref: '#/components/schemas/StyleItemState'
          description: Lifecycle state of the item size.
        deadline:
          type:
            - 'null'
            - string
          description: Target deadline for this size, or null when none is set.
          format: date-time
        etd:
          type:
            - 'null'
            - string
          description: Estimated time of delivery for this size, or null when none is set.
          format: date-time
        position:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Display order of this size within the item's size list.
          format: int32
        physicalReferenceNumber:
          type:
            - 'null'
            - string
          description: >-
            Physical sample reference number for this size, or null when none is
            set.
        erpSizeId:
          type:
            - 'null'
            - string
          description: >-
            External identifier for this size in a connected ERP system, or null
            when no ERP integration is active.
        properties:
          type: array
          items:
            type: string
          description: >-
            Active boolean flags for the size, encoded as strings. default marks
            the item's default size; approved marks the size approved; commented
            indicates comments exist.
      additionalProperties: false
      description: >-
        The specific item size selected for this style item, or null when no
        size is selected.
    StyleItemDetailDto:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the item in the item library.
          format: int64
        name:
          type:
            - 'null'
            - string
          description: Display name of the item.
        customId:
          type:
            - 'null'
            - string
          description: Customer-defined identifier for the item.
        state:
          $ref: '#/components/schemas/StyleItemState'
          description: >-
            Lifecycle state of the item, reflecting whether it is active or
            inactive in the item library.
        description:
          type:
            - 'null'
            - string
          description: Free-text description of the item.
        brand:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemBrandDto'
              description: The brand this item belongs to.
          description: The brand this item belongs to.
        organization:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemOrganizationDto'
              description: The designer organization that owns the item.
          description: The designer organization that owns the item.
        supplier:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemSupplierDto'
              description: >-
                The primary supplier for this item, or null when none is
                assigned.
          description: The primary supplier for this item, or null when none is assigned.
        companyContactPerson:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemContactPersonDto'
              description: >-
                The brand-side contact person for this item, or null when none
                is set.
          description: >-
            The brand-side contact person for this item, or null when none is
            set.
        supplierContactPerson:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemContactPersonDto'
              description: >-
                The supplier-side contact person for this item, or null when
                none is set.
          description: >-
            The supplier-side contact person for this item, or null when none is
            set.
        categories:
          type: array
          items:
            $ref: '#/components/schemas/StyleItemCategoryDto'
          description: Item categories this item is classified under.
        parts:
          type: array
          items:
            $ref: '#/components/schemas/StyleItemPartDto'
          description: >-
            Quality card parts of the item, each describing a material layer
            with its value, unit, and composition.
        adminUnit:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemAdminUnitDto'
              description: >-
                The measurement unit configured for this item, or null when none
                is set.
          description: >-
            The measurement unit configured for this item, or null when none is
            set.
        logo:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/StyleItemLogoDto'
              description: >-
                Thumbnail image for the item, or null when no image has been
                uploaded.
          description: >-
            Thumbnail image for the item, or null when no image has been
            uploaded.
        lastUpdated:
          type: string
          description: Timestamp of the most recent change to the item.
          format: date-time
        deadline:
          type:
            - 'null'
            - string
          description: Target completion deadline for the item, or null when none is set.
          format: date-time
        etd:
          type:
            - 'null'
            - string
          description: Estimated time of delivery for the item, or null when none is set.
          format: date-time
        erpItemId:
          type:
            - 'null'
            - string
          description: >-
            External identifier for this item in a connected ERP system, or null
            when no ERP integration is configured.
        defaultQty:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          description: Default quantity suggested when this item is added to a style.
          format: double
        nameGeneratorExtraText:
          type:
            - 'null'
            - string
          description: >-
            Extra text appended by the organization's item name generator, or
            null when the generator is not in use.
        physicalReferenceNumber:
          type:
            - 'null'
            - string
          description: >-
            Physical sample reference number for the item, or null when none is
            set.
        properties:
          type: array
          items:
            type: string
          description: >-
            Active boolean flags for the item, encoded as strings.
            readyForExport marks it ready for ERP export; updatedAfterLastExport
            marks changes since the last export; commented indicates comments
            exist.
      additionalProperties: false
      description: Full detail of the linked item from the item library.
    ErrorDetailDto:
      required:
        - type
        - field
        - value
      type: object
      properties:
        type:
          type: string
          description: >-
            The hierarchical error code identifying the specific failure, such
            as validation_error.required_field. Consumers branch on this rather
            than on the message text.
        field:
          type:
            - 'null'
            - string
          description: >-
            The input field that caused the failure. Omitted when no specific
            field is at fault, such as an authorization denial or a server
            error.
        value:
          type:
            - 'null'
            - string
          description: >-
            A human-readable message describing the failure, or the offending
            value or limit that triggered it.
      additionalProperties: false
    StyleItemBrandDto:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the brand.
          format: int64
        name:
          type:
            - 'null'
            - string
          description: Display name of the brand.
      additionalProperties: false
      description: The brand this item belongs to.
    StyleItemOrganizationDto:
      required:
        - id
        - name
      type: object
      properties:
        id:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Unique identifier of the designer organization.
          format: int32
        name:
          type:
            - 'null'
            - string
          description: Display name of the organization.
      additionalProperties: false
      description: The designer organization that owns the item.
    StyleItemSupplierDto:
      type: object
      properties:
        id:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Unique identifier of the supplier.
          format: int32
        name:
          type:
            - 'null'
            - string
          description: Display name of the supplier.
        customId:
          type:
            - 'null'
            - string
          description: >-
            Customer-defined identifier for the supplier, or null when none is
            set.
      additionalProperties: false
      description: The primary supplier for this item, or null when none is assigned.
    StyleItemContactPersonDto:
      type: object
      properties:
        id:
          type:
            - 'null'
            - string
          description: Unique identifier of the contact person's user account.
        name:
          type:
            - 'null'
            - string
          description: Full display name of the contact person.
      additionalProperties: false
      description: The brand-side contact person for this item, or null when none is set.
    StyleItemCategoryDto:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the item category.
          format: int64
        name:
          type:
            - 'null'
            - string
          description: Display name of the item category, such as Fabric, Button, or Label.
      additionalProperties: false
    StyleItemPartDto:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the item part.
          format: int64
        name:
          type:
            - 'null'
            - string
          description: Name of the item part, such as Shell or Lining.
        value:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          description: Numeric measurement of the part expressed in the associated unit.
          format: double
        unit:
          type:
            - 'null'
            - string
          description: >-
            Name of the measurement unit for the part value, or null when no
            unit is assigned.
        materials:
          type: array
          items:
            $ref: '#/components/schemas/StyleItemMaterialDto'
          description: >-
            Material composition of the part, each entry naming a material and
            its percentage.
      additionalProperties: false
    StyleItemAdminUnitDto:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the measurement unit.
          format: int64
        name:
          type:
            - 'null'
            - string
          description: Display name of the measurement unit, such as Metres or Pieces.
        customId:
          type:
            - 'null'
            - string
          description: Customer-defined identifier for the measurement unit.
        properties:
          type: array
          items:
            type: string
          description: >-
            Active boolean flags for the measurement unit, encoded as strings.
            fraction indicates the unit accepts fractional quantities.
      additionalProperties: false
      description: The measurement unit configured for this item, or null when none is set.
    StyleItemLogoDto:
      type: object
      properties:
        id:
          type:
            - 'null'
            - string
          description: Unique identifier of the logo image file.
        url:
          type:
            - 'null'
            - string
          description: URL from which the item logo image can be downloaded.
      additionalProperties: false
      description: Thumbnail image for the item, or null when no image has been uploaded.
    StyleItemMaterialDto:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the material.
          format: int64
        name:
          type:
            - 'null'
            - string
          description: Name of the material, such as Cotton or Polyester.
        percentage:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
          type:
            - number
            - string
          description: Percentage weight of this material within the part composition.
          format: double
      additionalProperties: false

````