Solvimon productItems API

openapi: 3.1.0
info:
  title: Configuration alertRules productItems API
  version: 1.0.0
servers:
- url: https://test.api.solvimon.com
  description: The TEST environment for our API
- url: https://api.solvimon.com
  description: The live environment for our API
tags:
- name: productItems
paths:
  /v{version}/product-items:
    get:
      operationId: getProductItems
      summary: Get a list of all product items
      description: Requires the PRODUCT_ITEM.VIEW permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: product_id
        in: query
        description: Filter products items based on product id.
        required: false
        schema:
          type: string
      - name: customer_id
        in: query
        description: The resource id of the customer.
        required: false
        schema:
          type: string
      - name: custom_field
        in: query
        description: Filter product items based on a custom field, formatted as reference:value.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItemResponseWrapper'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    post:
      operationId: postProductItems
      summary: Create a product item
      description: Requires the PRODUCT_ITEM.CREATE permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItem'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductItemCreateRequest'
    put:
      operationId: putProductItems
      summary: Update or create a product item (upsert)
      description: Requires the PRODUCT_ITEM.CREATE or PRODUCT_ITEM.UPDATE permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: identifier_field
        in: query
        description: Which field to use to identify whether the resource exists or not
        required: false
        schema:
          type: string
      - name: custom_field_reference
        in: query
        description: Which custom field to use to identify whether the resource exists or not
        required: false
        schema:
          type: string
      - name: field_actions
        in: query
        description: The list of actions for specific fields.
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItem'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductItemCreateRequest'
  /v{version}/product-items/{resourceIdOrReference}:
    get:
      operationId: getProductItemsByResourceIdOrReference
      summary: Get a product item
      description: Requires the PRODUCT_ITEM.VIEW permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItem'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    delete:
      operationId: deleteProductItemsByResourceIdOrReference
      summary: Delete a product item
      description: Requires the PRODUCT_ITEM.DELETE permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItem'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    patch:
      operationId: patchProductItemsByResourceIdOrReference
      summary: Update a product item
      description: Requires the PRODUCT_ITEM.UPDATE permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItem'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductItemUpdateRequest'
  /v{version}/product-items/{resourceIdOrReference}/activate:
    post:
      operationId: postProductItemsByResourceIdOrReferenceActivate
      summary: Activate a product item
      description: Requires the PRODUCT_ITEM.ACTIVATE permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItem'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/product-items/{resourceIdOrReference}/deprecate:
    post:
      operationId: postProductItemsByResourceIdOrReferenceDeprecate
      summary: Deprecate a product item
      description: Requires the PRODUCT_ITEM.DEPRECATE permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItem'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/product-items/{resourceIdOrReference}/archive:
    post:
      operationId: postProductItemsByResourceIdOrReferenceArchive
      summary: Archive a product item
      description: Requires the PRODUCT_ITEM.ARCHIVE permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItem'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/product-items/search:
    post:
      operationId: postProductItemsSearch
      summary: Search product items.
      description: Requires the PRODUCT_ITEM.VIEW permission.
      tags:
      - productItems
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered. default = name
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The parameter for the response ordering direction (asc, desc) default asc
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductItemResponseWrapper'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCreateRequest'
components:
  schemas:
    UnitNameUpdateRequest:
      type: object
      properties:
        singular:
          type: string
        plural:
          type:
          - string
          - 'null'
      title: UnitNameUpdateRequest
    MeterPropertyUpdateRequestType:
      type: string
      enum:
      - NUMBER
      - ENUM
      - STRING
      description: The type of the meter property.
      title: MeterPropertyUpdateRequestType
    ProductItemUsageBasedUpdateRequest:
      type: object
      properties:
        meter_value_calculation_id:
          type:
          - string
          - 'null'
          description: The linked meter value calculation
        meter_value_calculation:
          oneOf:
          - $ref: '#/components/schemas/MeterValueCalculation'
          - type: 'null'
        tiering_meter_value_calculation_id:
          type:
          - string
          - 'null'
          description: The optional alternative linked meter value calculation for tiering
        tiering_meter_value_calculation:
          oneOf:
          - $ref: '#/components/schemas/MeterValueCalculation'
          - type: 'null'
        report_meter_value_calculation_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Optional reporting meter value calculations.
        conditions:
          $ref: '#/components/schemas/MeterConditions'
          description: Optional conditions.
      title: ProductItemUsageBasedUpdateRequest
    MeterPropertyConditionComparator:
      type: string
      enum:
      - EQUALS
      - NOT_EQUALS
      - IN
      - NOT_IN
      - GREATER_THAN
      - GREATER_THAN_OR_EQUALS
      - LESS_THAN
      - LESS_THAN_OR_EQUALS
      - EMPTY
      - NOT_EMPTY
      - CONTAINS
      - NOT_CONTAINS
      title: MeterPropertyConditionComparator
    LinkedIntegration:
      type: object
      properties:
        id:
          type: string
        link_details:
          type: array
          items:
            $ref: '#/components/schemas/LinkDetail'
      title: LinkedIntegration
    IntegrationDetails:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
        payment_gateway_variant:
          $ref: '#/components/schemas/IntegrationDetailsPaymentGatewayVariant'
        adyen:
          $ref: '#/components/schemas/AdyenIntegrationDetails'
        stripe:
          $ref: '#/components/schemas/StripeIntegrationDetails'
      title: IntegrationDetails
    MeterValueCreateRequestStatus:
      type: string
      enum:
      - DRAFT
      - ACTIVE
      - ARCHIVED
      - DEPRECATED
      description: The status of the meter value indicating the activity and the ability to update properties.
      title: MeterValueCreateRequestStatus
    MeterStatus:
      type: string
      enum:
      - DRAFT
      - ACTIVE
      - ARCHIVED
      - DEPRECATED
      description: The status of the meter indicating the activity of the meter and the ability to update properties.
      title: MeterStatus
    MeterMeterValueCreateRequest:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Resource ID of type METER_VALUE
        object:
          oneOf:
          - $ref: '#/components/schemas/MeterValue'
          - type: 'null'
        reference:
          type:
          - string
          - 'null'
        required:
          type:
          - boolean
          - 'null'
      title: MeterMeterValueCreateRequest
    ProductStatus:
      type: string
      enum:
      - DRAFT
      - ACTIVE
      - ARCHIVED
      - DEPRECATED
      description: The status of the product.
      title: ProductStatus
    ProductItemModelType:
      type: string
      enum:
      - USAGE_BASED
      - USAGE_BASED_CONVERSION
      - RECURRING
      - ONE_OFF
      - PER_SEAT
      - CREDITS
      title: ProductItemModelType
    MeterCreateRequestStatus:
      type: string
      enum:
      - DRAFT
      - ACTIVE
      - ARCHIVED
      - DEPRECATED
      description: The status of the meter indicating the activity of the meter and the ability to update properties.
      title: MeterCreateRequestStatus
    ProductItemCredits:
      type: object
      properties:
        credit_type_id:
          type:
          - string
          - 'null'
          description: The linked meter value calculation
        credit_type:
          oneOf:
          - $ref: '#/components/schemas/CreditType'
          - type: 'null'
      title: ProductItemCredits
    ApiErrorType:
      type: string
      enum:
      - API_ERROR
      - INVALID_REQUEST
      title: ApiErrorType
    ApiError:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ApiErrorType'
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        field:
          type:
          - string
          - 'null'
        message:
          type: string
        resource_id:
          type:
          - string
          - 'null'
        resource_type:
          oneOf:
          - $ref: '#/components/schemas/ApiErrorResourceType'
          - type: 'null'
      required:
      - type
      - code
      - message
      title: ApiError
    SelectionRuleFieldCreateRequest:
      type: object
      properties:
        name:
          type: string
        value:
          type:
          - string
          - 'null'
      title: SelectionRuleFieldCreateRequest
    CreditType:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        reference:
          type: string
        status:
          oneOf:
          - $ref: '#/components/schemas/CreditTypeStatus'
          - type: 'null'
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        unit_name:
          $ref: '#/components/schemas/UnitName'
        created_at:
          type:
          - string
          - 'null'
        updated_at:
          type:
          - string
          - 'null'
      title: CreditType
    ProductCreateRequestStatus:
      type: string
      enum:
      - DRAFT
      - ACTIVE
      - ARCHIVED
      - DEPRECATED
      description: The status of the product.
      title: ProductCreateRequestStatus
    ProductTaxCategory:
      type: string
      enum:
      - STANDARD
      - NO_TAX
      - EXEMPT
      description: The default tax category applied to the product.
      title: ProductTaxCategory
    Product:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        category_id:
          type: string
          description: The resource ID of the product category, that belongs to the product.
        category:
          oneOf:
          - $ref: '#/components/schemas/ProductCategory'
          - type: 'null'
        parent_product_id:
          type:
          - string
          - 'null'
          description: The resource ID of the original product, to which the product will belong to.
        name:
          type: string
        reference:
          type: string
        description:
          type:
          - string
          - 'null'
        status:
          oneOf:
          - $ref: '#/components/schemas/ProductStatus'
          - type: 'null'
          description: The status of the product.
        product_type:
          $ref: '#/components/schemas/ProductProductType'
        tax_category:
          oneOf:
          - $ref: '#/components/schemas/ProductTaxCategory'
          - type: 'null'
          description: The default tax category applied to the product.
        features:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FeatureResourceReference'
          description: The features associated with the product.
        custom_fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomFieldValue'
        display_order:
          type:
          - integer
          - 'null'
          description: Determines the order in which products are displayed on overview pages and invoices. The lowest number gets the highest priority.
        linked_integrations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LinkedIntegration'
        billing_entity_id:
          type:
          - string
          - 'null'
          description: The resource ID of the billing entity linked to this product.
        customer_id:
          type:
          - string
          - 'null'
      title: Product
    MeterPropertyUpdateRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        reference:
          type: string
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        status:
          $ref: '#/components/schemas/MeterPropertyUpdateRequestStatus'
          description: The status of the meter property indicating the activity and the ability to update properties.
        type:
          oneOf:
          - $ref: '#/components/schemas/MeterPropertyUpdateRequestType'
          - type: 'null'
          description: The type of the meter property.
        enum_values:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The list of available ENUM values.
      title: MeterPropertyUpdateRequest
    ProductUpdateRequestStatus:
      type: string
      enum:
      - DRAFT
      - ACTIVE
      - ARCHIVED
      - DEPRECATED
      description: The status of the product.
      title: ProductUpdateRequestStatus
    ProductCategoryTaxCategory:
      type: string
      enum:
      - STANDARD
      - NO_TAX
      - EXEMPT
      description: The default tax category applied to the products in the product category.
      title: ProductCategoryTaxCategory
    ProductCreateRequestProductType:
      type: string
      enum:
      - DEFAULT
      - ADDON
      title: ProductCreateRequestProductType
    CustomFieldValue:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Resource ID of type CUSTOM_FIELD
        reference:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        values:
          type:
          - array
          - 'null'
          items:
            type: string
        integration_details:
          oneOf:
          - $ref: '#/components/schemas/IntegrationDetails'
          - type: 'null'
        integration_id:
          type: string
          description: The resource ID of the integration linked to the custom field
      title: CustomFieldValue
    MeterValueCalculationUpdateRequestCalculationType:
      type: string
      enum:
      - SUM
      - MAX
      - MIN
      - AVERAGE
      - UNIQUE
      description: The type of calculation used for this billable metric.
      title: MeterValueCalculationUpdateRequestCalculationType
    UnitNameCreateRequest:
      type: obje

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-productitems-api-openapi.yml