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

# List Product Profile condition fields

> Returns the server-owned Product condition catalogue for editor clients. Load this catalogue
when opening an editor; it is not repeated in each Product Profile response. Fields with a
`value_source` use the advertised bounded search endpoint instead of an inline option list.



## OpenAPI

````yaml GET /v1/inventory/product-profiles/condition-fields
openapi: 3.0.3
info:
  title: ShipStream
  version: '1.0'
  license:
    name: Commercial (Copyright 2025 - All Rights Reserved)
    url: https://shipstream.io
  contact:
    name: ShipStream Support
    email: help@shipstream.io
  termsOfService: https://shipstream.io/legal/api-terms/
servers:
  - url: https://{base_url_domain}/api/global
    description: Direct API Url
    variables:
      base_url_domain:
        default: example.shipstream.app
        description: >-
          The fully qualified domain name for your ShipStream WMS instance. This
          is either a custom domain, or a subdomain of shipstream.app,

          and will be the same as the domain name for the page which you use to
          login to ShipStream WMS.
security:
  - ShipStream_bearerAuth: []
tags:
  - name: Warehouses
    x-displayName: Warehouses
  - name: Products
    x-displayName: Products
  - name: ProductProfiles
    x-displayName: ProductProfiles
  - name: HandlingClasses
    x-displayName: HandlingClasses
  - name: Locations
    x-displayName: Locations
  - name: LocationTags
    x-displayName: LocationTags
  - name: SlotTypes
    x-displayName: SlotTypes
  - name: Levels
    x-displayName: Levels
  - name: HoldReasons
    x-displayName: HoldReasons
  - name: Holds
    x-displayName: Holds
  - name: Replenishment
    x-displayName: Replenishment
  - name: LocationProfiles
    x-displayName: LocationProfiles
  - name: SlottingRules
    x-displayName: SlottingRules
  - name: Deliveries
    description: Every thing about a Delivery Receiving
    x-displayName: Deliveries
  - name: Shipments
    x-displayName: Shipments
  - name: Orders
    x-displayName: Orders
  - name: Retailers
    x-displayName: Retailers
  - name: Users
    x-displayName: Users
  - name: User Roles
    x-displayName: User Roles
  - name: Merchants
    x-displayName: Merchants
  - name: Healthcheck
    x-displayName: Healthcheck
paths:
  /v1/inventory/product-profiles/condition-fields:
    get:
      tags:
        - ProductProfiles
      summary: List Product Profile condition fields
      description: >-
        Returns the server-owned Product condition catalogue for editor clients.
        Load this catalogue

        when opening an editor; it is not repeated in each Product Profile
        response. Fields with a

        `value_source` use the advertised bounded search endpoint instead of an
        inline option list.
      operationId: getProductProfileConditionFields
      responses:
        '200':
          description: Product condition field catalogue.
          content:
            application/json:
              schema:
                type: object
                properties:
                  groups:
                    type: array
                    description: Product condition fields grouped in editor display order.
                    items:
                      $ref: >-
                        #/components/schemas/Inventory_API_v1_ConditionFieldGroup
                  expression:
                    $ref: '#/components/schemas/Inventory_API_v1_ConditionExpression'
                  meta:
                    $ref: '#/components/schemas/Inventory_API_v1_meta'
                required:
                  - groups
                  - expression
                  - meta
                additionalProperties: false
              example:
                groups:
                  - code: general
                    label: General
                    fields:
                      - code: sku
                        label: SKU
                        type: select
                        operators:
                          - in
                          - not_in
                        value_cast: string
                        value_source:
                          mode: search
                          endpoint: /api/global/v1/inventory/product-condition-values
                          field: sku
                          minimum_query_length: 2
                          maximum_results: 50
                      - code: weight
                        label: Weight
                        type: measurement
                        operators:
                          - <
                          - <=
                          - '=='
                          - '!='
                          - '>'
                          - '>='
                        unit_family: weight
                        units:
                          - lb
                          - kg
                        base_unit: lb
                expression:
                  code: expr
                  label: Expression is true
                  help_url: >-
                    https://help.shipstream.io/scripting/common-expression-language
                meta:
                  processing_time: 0.0081
        '500':
          $ref: '#/components/responses/Inventory_API_v1_500-internal-server-error'
components:
  schemas:
    Inventory_API_v1_ConditionFieldGroup:
      type: object
      description: A labeled group of related condition fields.
      properties:
        code:
          type: string
          minLength: 1
          description: Stable group code.
          example: general
        label:
          type: string
          minLength: 1
          description: Display label for the group.
          example: General
        fields:
          type: array
          description: Available condition fields in display order.
          items:
            $ref: '#/components/schemas/Inventory_API_v1_ConditionField'
      required:
        - code
        - label
        - fields
      additionalProperties: false
    Inventory_API_v1_ConditionExpression:
      type: object
      description: Metadata for a raw CEL expression condition row.
      properties:
        code:
          type: string
          minLength: 1
          description: Stable expression-row code.
          example: expr
        label:
          type: string
          minLength: 1
          description: Display label for a raw expression row.
          example: Expression is true
        help_url:
          type: string
          format: uri
          description: CEL reference for condition authors.
          example: https://help.shipstream.io/scripting/common-expression-language
      required:
        - code
        - label
        - help_url
      additionalProperties: false
    Inventory_API_v1_meta:
      type: object
      properties:
        processing_time:
          type: number
          description: Total time in which request is processed and response is sent back.
          example: 0.2525252525
        cursor_start:
          type: integer
          description: >-
            A cursor for use in pagination which defines the starting `id` of
            the next page of results.

            See [paging parameters](/global-api/paging-parameters) for more
            information on paging.
          nullable: true
        cursor_end:
          type: integer
          description: >-
            A cursor for use in pagination which defines the last `id` of the
            next page of results, non-inclusive.

            See [paging parameters](/global-api/paging-parameters) for more
            information on paging.
          nullable: true
        count:
          type: integer
          description: >-
            The total number of items matching the query before applying paging
            parameters.

            This field is only present if the query parameter `count=1` is
            present in the request.
      description: Additional metadata pertaining to the response.
    Inventory_API_v1_ConditionField:
      type: object
      description: Public validation and editor metadata for one condition field.
      properties:
        code:
          type: string
          minLength: 1
          description: Field code stored in condition variable operands.
          example: weight
        label:
          type: string
          minLength: 1
          description: Display label for the field.
          example: Weight
        type:
          type: string
          description: Value and editor-control type.
          enum:
            - numeric
            - measurement
            - boolean
            - date
            - string
            - select
            - enum
            - multiselect
        operators:
          type: array
          minItems: 1
          description: Operators accepted for this field.
          items:
            type: string
            enum:
              - <
              - <=
              - '=='
              - '!='
              - '>'
              - '>='
              - contains
              - not_contains
              - matches
              - not_matches
              - in
              - not_in
              - contains_any
              - contains_none
        value_cast:
          type: string
          description: Scalar cast applied by the condition normalizer.
          enum:
            - int
            - float
            - string
        options:
          type: object
          description: Finite accepted values mapped to their display labels.
          additionalProperties:
            type: string
        unit_family:
          type: string
          description: Measurement family used for unit conversion.
          enum:
            - weight
            - length
            - volume
        units:
          type: array
          minItems: 1
          description: Unit codes accepted for a measurement field.
          items:
            type: string
            minLength: 1
        base_unit:
          type: string
          minLength: 1
          description: Unit used for normalized comparison values.
          example: lb
        value_source:
          $ref: '#/components/schemas/Inventory_API_v1_ConditionValueSource'
      required:
        - code
        - label
        - type
        - operators
      additionalProperties: false
    Inventory_API_v1_ConditionValueSource:
      type: object
      description: Bounded endpoint used to search a field's non-finite values.
      properties:
        mode:
          type: string
          description: Value loading mode.
          enum:
            - search
        endpoint:
          type: string
          description: Global API endpoint path for value search.
          enum:
            - /api/global/v1/inventory/product-condition-values
        field:
          type: string
          description: Field query parameter to send to the endpoint.
          enum:
            - sku
            - name
            - vendor_sku
            - manufacturer_part_number
            - external_id
            - barcode
        minimum_query_length:
          type: integer
          minimum: 1
          description: Minimum number of characters required before searching.
          example: 2
        maximum_results:
          type: integer
          minimum: 1
          description: Maximum number of returned value options.
          example: 50
      required:
        - mode
        - endpoint
        - field
        - minimum_query_length
        - maximum_results
      additionalProperties: false
  responses:
    Inventory_API_v1_500-internal-server-error:
      description: >-
        Internal Server Error - Something wrong happened at server side. Contact
        server administrator for more details.
  securitySchemes:
    ShipStream_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Generate a JWT access token through a Custom Global Integration and
        provide it with each request in the `Authorization` header prefixed with
        "Bearer" and then a single space.

````