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

# Get call-off release rules

> Gets a paged collection of call-off release rules according to any specified filter criteria and sort options.



## OpenAPI

````yaml /openapi/openapi_catalog_admin.json get /commerce/rules/calloffrelease
openapi: 3.0.1
info:
  description: |-
    <div id="overview_CATALOG_ADMIN">
                <h2>CATALOG ADMINISTRATION</h2>
                <p>The Catalog Administration APIs are a collection of resources for configuring the catalogs and products offered to your shoppers, including
                    discounts and coupon sets, faceting, price lists, and different types or variations of products. See the
                    <a href="/concept-guides/catalog">Catalog user guides</a>
                    for information about the related features in the Unified Commerce Admin.</p>
                <p>Use the <strong>Attributes</strong> resource to manage localization and attribute configurations for your catalogs. This current version of the Attributes API includes localizedContent to
                    support <a href="/pages/catalog-structure#multi-locale-catalogs">multi-locale catalogs</a>, which was not present in the legacy API model. If
                    you were a client prior to May 2024 and have upgraded your implementation to support this feature,
                    you can still access attribute data that has not yet been rewritten to the new model by providing
                    an x-api-version header set to "1". </p>
                <p>Use the <strong>Categories</strong> resource to organize products and control where they appear on the storefront. Create
                    and maintain a hierarchy of categories and subcategories where the site will store properties. This current version of the Categories API includes localizedContent to
                    support <a href="/pages/catalog-structure#multi-locale-catalogs">multi-locale catalogs</a>, which was not present in the legacy API model. If
                    you were a client prior to May 2024 and have upgraded your implementation to support this feature,
                    you can still access category data that has not yet been rewritten to the new model by providing
                    an x-api-version header set to "1". </p>
                <p>Use the <strong>Coupon Sets</strong> resource to view and create coupon sets. You can use coupon sets to group multiple
                    coupon codes together and associate them with one or more discounts.</p>
                <p>Use the <strong>Currency</strong> resource to manage the currency localization rules and exchange rates for any of the
                    currencies that are supported for placing orders in.</p>
                <p>Use the <strong>Discounts</strong> and <strong>Discount Settings</strong> resources to define and manage discounts to apply to products, product categories, or
                    orders. This current version of the Discounts API includes localizedContent to
                    support <a href="/pages/catalog-structure#multi-locale-catalogs">multi-locale catalogs</a>, which was not present in the legacy Products API model. If
                    you were a client prior to May 2024 and have upgraded your implementation to support this feature,
                    you can still access discount data that has not yet been rewritten to the new model by providing
                    an x-api-version header set to "1". </p>
                <p>Use the <strong>Facets</strong> resource to manage the facets shoppers use to filter product display results on a
                    storefront. Facets can include categories, product attributes, or prices, and use either a range of
                    values or discrete values.</p>
                <p>Use the <strong>Master Catalog</strong> resource to view details of the master catalogs associated with a tenant and to
                    manage the product publishing mode for each master catalog.</p>
                <p>Use the <strong>Price Lists</strong> resources to view and create price lists. You can use price lists to override the
                    catalog pricing of products for specific customer segments and/or sites.</p>
                <p>Use the <strong>Products</strong>, <strong>Product Types/Extras/Options/Properties</strong>, and <strong>Product Sort Definitions</strong> resources to create new product definitions in the master catalog and determine which
                    catalogs will feature products. This current version of the Products API includes localizedContent to
                    support <a href="/pages/catalog-structure#multi-locale-catalogs">multi-locale catalogs</a>, which was not present in the legacy Products API model. If
                    you were a client prior to May 2024 and have upgraded your implementation to support this feature,
                    you can still access product data that has not yet been rewritten to the new model by providing
                    an x-api-version header set to "1".</p>
                <p>Use the <strong>Publishing</strong> resource to publish pending product updates together as part of a set.</p>
                <p>Use the <strong>Search</strong> resource to manage all settings and options for providing product search on your site, as
                    well as search tuning rules.</p>
            </div>
  title: Catalog Admin
  version: 0.0.1
servers:
  - description: Kibo Base URL
    url: '{baseUrl}/api'
    variables:
      baseUrl:
        default: https://t1000000.sb.usc1.gcp.kibocommerce.com
        description: Base URL
security:
  - bearerAuth: []
paths:
  /commerce/rules/calloffrelease:
    get:
      tags:
        - CallOffReleaseRules
      summary: Get call-off release rules
      description: >-
        Gets a paged collection of call-off release rules according to any
        specified filter criteria and sort options.
      parameters:
        - in: query
          name: startIndex
          schema:
            default: 0
            format: int32
            type: integer
        - in: query
          name: pageSize
          schema:
            default: 0
            format: int32
            type: integer
        - in: query
          name: sortBy
          schema:
            type: string
        - in: query
          name: filter
          schema:
            type: string
        - in: query
          name: responseFields
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallOffReleaseRuleCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/CallOffReleaseRuleCollection'
            text/plain:
              schema:
                $ref: '#/components/schemas/CallOffReleaseRuleCollection'
          description: OK
components:
  schemas:
    CallOffReleaseRuleCollection:
      properties:
        items:
          items:
            $ref: '#/components/schemas/CallOffReleaseRule'
          nullable: true
          type: array
        pageCount:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        startIndex:
          format: int32
          type: integer
        totalCount:
          format: int32
          type: integer
      type: object
    CallOffReleaseRule:
      description: |-
        Call-Off Release Rule contract (CAT-7736).
        Tenant-owned, internally master-catalog-scoped ranked admin rule for the
        B2B Supply Chain OMS call-off order release pipeline.
      properties:
        auditInfo:
          $ref: '#/components/schemas/AdminUserAuditInfo'
        callOffOrderRules:
          description: >-
            Referenced Call-Off-Order Rule codes. Max 1 entry. At least one of
            ProductRules,

            CustomerRules, or CallOffOrderRules must be non-empty (FR-007,
            FR-008).
          items:
            type: string
          nullable: true
          type: array
        code:
          description: >-
            Unique identifier. Auto-generated on create if not supplied.
            Immutable after creation.

            Max 30 characters; must match GeneralAlphaNumericCharactersRegex
            (FR-005, FR-016).
          nullable: true
          type: string
        customerRules:
          description: Referenced Customer Rule codes. Max 1 entry (FR-007, FR-008).
          items:
            type: string
          nullable: true
          type: array
        daysBeforeShipDate:
          description: >-
            Days before the ship date within which this rule applies. Inclusive
            [0, 365] (FR-015).
          format: int32
          type: integer
        description:
          description: Optional description. Max 500 characters (FR-003).
          nullable: true
          type: string
        enabled:
          description: >-
            Whether the rule is active. Defaults to true on insert (FR-003,
            FR-011).
          nullable: true
          type: boolean
        metaData:
          description: >-
            Opaque JSON metadata passthrough. Persisted as nvarchar(MAX).
            Cleared on PUT if omitted (FR-023).
          nullable: true
        minimumFillRate:
          description: >-
            Minimum fill rate threshold [0, 100] (integer percentage). 0 is
            valid (FR-027).
          format: int32
          type: integer
        name:
          description: Display name. Required. Max 200 characters (FR-003).
          nullable: true
          type: string
        productRules:
          description: >-
            Referenced Product Rule criteria. Max 1 entry. Each entry requires
            both code and

            masterCatalogId; the (code, masterCatalogId) pair must resolve to an
            existing

            ProductRule with RuleType=CallOffRelease (FR-007, FR-008).
          items:
            $ref: '#/components/schemas/ProductRuleCode'
          nullable: true
          type: array
        rank:
          description: >-
            Priority rank, unique per (TenantId, MasterCatalogId). Auto-assigned
            to MAX(Rank)+1

            when omitted or ≤0 on create (FR-006, FR-017).
          format: int32
          type: integer
        sortAttribute:
          description: >-
            Optional tiebreaker attribute name used by the downstream call-off
            release engine.

            Max 50 characters. null, absent, and empty are all accepted
            (FR-026).
          nullable: true
          type: string
        validForAllSites:
          description: >-
            When true the rule applies to all tenant sites; ValidSites is
            ignored (FR-022).
          nullable: true
          type: boolean
        validSites:
          description: >-
            Site IDs this rule applies to. Each must be tenant-owned (FR-007,
            FR-022).
          items:
            format: int32
            type: integer
          nullable: true
          type: array
      type: object
    AdminUserAuditInfo:
      properties:
        createBy:
          nullable: true
          type: string
        createDate:
          format: date-time
          nullable: true
          type: string
        updateBy:
          nullable: true
          type: string
        updateDate:
          format: date-time
          nullable: true
          type: string
      type: object
    ProductRuleCode:
      properties:
        code:
          description: Unique identifier of the ProductRule. System-supplied and read-only.
          nullable: true
          type: string
        masterCatalogId:
          description: Master Catalog Id of the ProductRule.
          format: int32
          type: integer
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http

````