Kibo Commerce Reservation Steal From Rules API

openapi: 3.2.0
info:
  title: Kibo Commerce Reservation Steal From Rules API
  version: '1.0'
  description: 'Operations tagged ReservationStealFromRules across 2 of this provider''s published API definitions: openapi_openapi_catalog_admin.json, kibo-commerce-catalog-admin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Kibo Base URL
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: https://t1000000.sb.usc1.gcp.kibocommerce.com
      description: Base URL
security:
- bearerAuth: []
tags:
- name: ReservationStealFromRules
paths:
  /commerce/rules/reservationstealfrom/{code}:
    delete:
      description: Permanently deletes a reservation steal-from rule (FR-013 hard delete).
      parameters:
      - in: path
        name: code
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Delete reservation steal-from rule
      tags:
      - ReservationStealFromRules
      operationId: deleteCommerceRulesReservationstealfromByCode
      x-operation-id-source: derived
    get:
      description: Gets a reservation steal-from rule by its unique code.
      parameters:
      - in: path
        name: code
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
            text/json:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
            text/plain:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
          description: OK
      summary: Get reservation steal-from rule by code
      tags:
      - ReservationStealFromRules
      operationId: getCommerceRulesReservationstealfromByCode
      x-operation-id-source: derived
    put:
      description: Updates an existing reservation steal-from rule with full replacement semantics (FR-009).
      parameters:
      - in: path
        name: code
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReservationStealFromRule'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
            text/json:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
            text/plain:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
          description: OK
      summary: Update reservation steal-from rule
      tags:
      - ReservationStealFromRules
      operationId: putCommerceRulesReservationstealfromByCode
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/rules/reservationstealfrom:
    get:
      description: Gets a collection of reservation steal-from 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: responseGroups
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRuleCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRuleCollection'
            text/plain:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRuleCollection'
          description: OK
      summary: Get reservation steal-from rules
      tags:
      - ReservationStealFromRules
      operationId: getCommerceRulesReservationstealfrom
      x-operation-id-source: derived
    post:
      description: Creates a new reservation steal-from rule.
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReservationStealFromRule'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
            text/json:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
            text/plain:
              schema:
                $ref: '#/components/schemas/ReservationStealFromRule'
          description: OK
      summary: Create reservation steal-from rule
      tags:
      - ReservationStealFromRules
      operationId: postCommerceRulesReservationstealfrom
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/rules/reservationstealfrom/{code}/rank:
    put:
      description: Updates the rank for a reservation steal-from rule and atomically reorders all other rules of this type in the current master catalog.
      parameters:
      - in: path
        name: code
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRankRequest'
      responses:
        '200':
          description: OK
      summary: Update reservation steal-from rule rank
      tags:
      - ReservationStealFromRules
      operationId: putCommerceRulesReservationstealfromByCodeRank
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
components:
  schemas:
    ReservationStealFromRuleCollection:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReservationStealFromRule'
          type:
          - array
          - 'null'
        pageCount:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        startIndex:
          format: int32
          type: integer
        totalCount:
          format: int32
          type: integer
      type: object
    ReservationStealFromRule:
      description: 'Reservation Steal-From Rule contract (CAT-7911). Structurally identical to

        Mozu.ProductAdmin.Contracts.ReservationRules.ReservationRule except it does not

        have `TimeFenceDays`; instead it adds an explicit Mozu.ProductAdmin.Contracts.ReservationStealFromRules.ReservationStealFromRule.StartDate/Mozu.ProductAdmin.Contracts.ReservationStealFromRules.ReservationStealFromRule.EndDate

        window during which the rule is enabled — the same effective-date-window concept used by

        Discounts and Price Lists, not a reworded time fence. Fully independent of the sibling

        Mozu.ProductAdmin.Contracts.ReservationStealForRules.ReservationStealForRule.'
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        callOffOrderRules:
          description: Referenced call-off-order rule codes. Max 1 entry.
          items:
            type: string
          type:
          - array
          - 'null'
        code:
          description: Unique identifier. Auto-generated when omitted on create.
          type:
          - string
          - 'null'
        customerRules:
          description: Referenced customer rule codes. Max 1 entry.
          items:
            type: string
          type:
          - array
          - 'null'
        description:
          description: Optional description, max 500 chars.
          type:
          - string
          - 'null'
        enabled:
          description: Whether the rule is active. Defaults to true when omitted/null on create or update.
          type:
          - boolean
          - 'null'
        endDate:
          description: End of the rule's effective window. Null = never expires. Must be >= StartDate when both supplied.
          format: date-time
          type:
          - string
          - 'null'
        isActive:
          description: 'Read-only. Computed server-side: true when the current UTC instant is inside the effective window

            (StartDate null/≤now AND EndDate null/≥now), false otherwise. A rule with no dates is always active.

            This reflects the effective window alone and does not incorporate the enabled flag.'
          type:
          - boolean
          - 'null'
        metaData:
          description: Opaque JSON metadata. Passed through unchanged.
        name:
          description: Display name. Required, max 200 chars.
          type:
          - string
          - 'null'
        productRules:
          description: Referenced product rules. Max 1 entry.
          items:
            $ref: '#/components/schemas/ProductRuleCode'
          type:
          - array
          - 'null'
        rank:
          description: Priority rank, unique per master catalog within the tenant. Auto-assigned on create when omitted or ≤0. Rejected (not auto-assigned) on update when omitted or ≤0.
          format: int32
          type: integer
        sortAttribute:
          description: Optional tiebreaker attribute name used by the reservation-stealing engine when two candidates match. Max 50 chars.
          type:
          - string
          - 'null'
        startDate:
          description: Start of the rule's effective window. Null = no lower bound.
          format: date-time
          type:
          - string
          - 'null'
        validForAllSites:
          description: "When true the rule applies to all sites; ValidSites is ignored. When false/omitted and\n            ValidSites is also omitted, ValidSites auto-populates with the calling site from the request\n            context (FR-022); the save is rejected if no site context is available."
          type:
          - boolean
          - 'null'
        validSites:
          description: Site IDs this rule applies to.
          items:
            format: int32
            type: integer
          type:
          - array
          - 'null'
      type: object
    ProductRuleCode:
      properties:
        code:
          description: Unique identifier of the ProductRule. System-supplied and read-only.
          type:
          - string
          - 'null'
        masterCatalogId:
          description: Master Catalog Id of the ProductRule.
          format: int32
          type: integer
      type: object
    AuditInfo:
      properties:
        createBy:
          type:
          - string
          - 'null'
        createDate:
          format: date-time
          type:
          - string
          - 'null'
        updateBy:
          type:
          - string
          - 'null'
        updateDate:
          format: date-time
          type:
          - string
          - 'null'
      type: object
    UpdateRankRequest:
      description: Represents a request to update the rank of a SafetyStock, PurchaseLimit and Return Rule.
      properties:
        code:
          description: 'Gets or sets the code of the rule to be updated.

            It can be SafetyStock Code , PurchaseLimit Code or Return Rule Code'
          type:
          - string
          - 'null'
        newRank:
          description: Gets or sets the new rank of the rule.
          format: int32
          type: integer
        oldRank:
          description: Gets or sets the old rank of the rule.
          format: int32
          type: integer
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http
x-refined-from:
- openapi_openapi_catalog_admin.json
- kibo-commerce-catalog-admin-openapi.yml
x-provenance:
  method: harvested
  publisher: Kibo Commerce
  source: https://docs.kibocommerce.com/openapi/openapi_catalog_admin.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)