Kibo Commerce Product Properties API

openapi: 3.2.0
info:
  title: Kibo Commerce Product Properties API
  version: '1.0'
  description: 'Operations tagged ProductProperties 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: ProductProperties
paths:
  /commerce/catalog/admin/products/{productCode}/Properties:
    get:
      description: Get properties for a product. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the previous 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".
      parameters:
      - description: ''
        in: path
        name: productCode
        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:
                items:
                  $ref: '#/components/schemas/CatalogAdminsProductProperty'
                type: array
            text/json:
              schema:
                items:
                  $ref: '#/components/schemas/CatalogAdminsProductProperty'
                type: array
            text/plain:
              schema:
                items:
                  $ref: '#/components/schemas/CatalogAdminsProductProperty'
                type: array
          description: OK
      summary: Get Product Properties
      tags:
      - ProductProperties
      operationId: getCommerceCatalogAdminProductsByProductCodeProperties
      x-operation-id-source: derived
    post:
      description: Add a property to a product. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the previous 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".
      parameters:
      - description: ''
        in: path
        name: productCode
        required: true
        schema:
          type: string
      - in: query
        name: batchJobCode
        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/CatalogAdminsProductProperty'
        description: ''
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogAdminsProductProperty'
            text/json:
              schema:
                $ref: '#/components/schemas/CatalogAdminsProductProperty'
            text/plain:
              schema:
                $ref: '#/components/schemas/CatalogAdminsProductProperty'
          description: OK
      summary: Add Product Property
      tags:
      - ProductProperties
      operationId: postCommerceCatalogAdminProductsByProductCodeProperties
      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/catalog/admin/products/{productCode}/Properties/{attributeFQN}:
    delete:
      description: Delete a specific product property.
      parameters:
      - description: ''
        in: path
        name: productCode
        required: true
        schema:
          type: string
      - description: ''
        in: path
        name: attributeFQN
        required: true
        schema:
          type: string
      - in: query
        name: batchJobCode
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Delete Product Property
      tags:
      - ProductProperties
      operationId: deleteCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQN
      x-operation-id-source: derived
    get:
      description: Get a specific product property. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the previous 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".
      parameters:
      - description: ''
        in: path
        name: productCode
        required: true
        schema:
          type: string
      - description: ''
        in: path
        name: attributeFQN
        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/CatalogAdminsProductProperty'
            text/json:
              schema:
                $ref: '#/components/schemas/CatalogAdminsProductProperty'
            text/plain:
              schema:
                $ref: '#/components/schemas/CatalogAdminsProductProperty'
          description: OK
      summary: Get Product Property
      tags:
      - ProductProperties
      operationId: getCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQN
      x-operation-id-source: derived
    put:
      description: Update a specific product property. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the previous 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".
      parameters:
      - description: ''
        in: path
        name: productCode
        required: true
        schema:
          type: string
      - description: ''
        in: path
        name: attributeFQN
        required: true
        schema:
          type: string
      - in: query
        name: batchJobCode
        schema:
          type: string
      - in: query
        name: allowSyscalcValueUpdates
        schema:
          default: false
          type: boolean
      - 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/CatalogAdminsProductProperty'
        description: ''
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogAdminsProductProperty'
            text/json:
              schema:
                $ref: '#/components/schemas/CatalogAdminsProductProperty'
            text/plain:
              schema:
                $ref: '#/components/schemas/CatalogAdminsProductProperty'
          description: OK
      summary: Update Product Property
      tags:
      - ProductProperties
      operationId: putCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQN
      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/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}:
    delete:
      description: Delete property value localized content by locale code.
      parameters:
      - in: path
        name: productCode
        required: true
        schema:
          type: string
      - in: path
        name: attributeFQN
        required: true
        schema:
          type: string
      - in: path
        name: value
        required: true
        schema:
          type: string
      - in: path
        name: localeCode
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Delete Product Property Localized Content by Locale
      tags:
      - ProductProperties
      operationId: deleteCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQNValuesByValueLocalizedContentByLocaleCode
      x-operation-id-source: derived
    get:
      description: Get property value localized content.
      parameters:
      - in: path
        name: productCode
        required: true
        schema:
          type: string
      - in: path
        name: attributeFQN
        required: true
        schema:
          type: string
      - in: path
        name: value
        required: true
        schema:
          type: string
      - in: path
        name: localeCode
        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/ProductPropertyValueLocalizedContent'
            text/json:
              schema:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
          description: OK
      summary: Get Product Property Localized Content by Locale
      tags:
      - ProductProperties
      operationId: getCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQNValuesByValueLocalizedContentByLocaleCode
      x-operation-id-source: derived
    put:
      description: Update property value localized content by locale code.
      parameters:
      - in: path
        name: productCode
        required: true
        schema:
          type: string
      - in: path
        name: attributeFQN
        required: true
        schema:
          type: string
      - in: path
        name: value
        required: true
        schema:
          type: string
      - in: path
        name: localeCode
        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/ProductPropertyValueLocalizedContent'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
            text/json:
              schema:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
          description: OK
      summary: Update Product Property Localized Content by Locale
      tags:
      - ProductProperties
      operationId: putCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQNValuesByValueLocalizedContentByLocaleCode
      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/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent:
    get:
      description: Get property value localized content.
      parameters:
      - in: path
        name: productCode
        required: true
        schema:
          type: string
      - in: path
        name: attributeFQN
        required: true
        schema:
          type: string
      - in: path
        name: value
        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:
                items:
                  $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
                type: array
            text/json:
              schema:
                items:
                  $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
                type: array
            text/plain:
              schema:
                items:
                  $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
                type: array
          description: OK
      summary: Get Product Property Localized Contents
      tags:
      - ProductProperties
      operationId: getCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQNValuesByValueLocalizedContent
      x-operation-id-source: derived
    post:
      description: Add property value localized content.
      parameters:
      - in: path
        name: productCode
        required: true
        schema:
          type: string
      - in: path
        name: attributeFQN
        required: true
        schema:
          type: string
      - in: path
        name: value
        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/ProductPropertyValueLocalizedContent'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
            text/json:
              schema:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
          description: OK
      summary: Add Product Property Localized Content
      tags:
      - ProductProperties
      operationId: postCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQNValuesByValueLocalizedContent
      x-operation-id-source: derived
    put:
      description: Update property value localized content.
      parameters:
      - in: path
        name: productCode
        required: true
        schema:
          type: string
      - in: path
        name: attributeFQN
        required: true
        schema:
          type: string
      - in: path
        name: value
        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:
              items:
                $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
              type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
                type: array
            text/json:
              schema:
                items:
                  $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
                type: array
            text/plain:
              schema:
                items:
                  $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
                type: array
          description: OK
      summary: Update Product Property Localized Content
      tags:
      - ProductProperties
      operationId: putCommerceCatalogAdminProductsByProductCodePropertiesByAttributeFQNValuesByValueLocalizedContent
      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:
    ProductPropertyValueLocalizedContent:
      description: Attribute Value Localized Resource
      properties:
        localeCode:
          description: Language used for the string attribute value.
          type:
          - string
          - 'null'
        stringValue:
          description: Localized Value in the language of the locale code
          type:
          - string
          - 'null'
      type: object
    CatalogAdminsProductProperty:
      description: "Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, \nthe color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram."
      properties:
        attributeFQN:
          description: Unique identifier of the Attribute.
          type:
          - string
          - 'null'
        forceOrder:
          type:
          - boolean
          - 'null'
        values:
          items:
            $ref: '#/components/schemas/CatalogAdminsProductPropertyValue'
          type:
          - array
          - 'null'
      type: object
    CatalogAdminsProductPropertyValue:
      description: A value of a product option for this product. For example, a computer product may have an option called "Memory" that can have the values "6GB,"8GB," and "12GB."
      properties:
        attributeVocabularyValueDetail:
          $ref: '#/components/schemas/CatalogAdminsAttributeVocabularyValue'
        content:
          $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
        localizedContent:
          items:
            $ref: '#/components/schemas/ProductPropertyValueLocalizedContent'
          type:
          - array
          - 'null'
        value: {}
      type: object
    AttributeVocabularyValueLocalizedContent:
      description: Attribute Value Localized Resource
      properties:
        localeCode:
          description: Language used for the string attribute value. Currently, only en_US is supported.
          type:
          - string
          - 'null'
        stringValue:
          description: Localized Value in the language of the locale code
          minLength: 1
          type: string
      type: object
    CatalogAdminsAttributeVocabularyValue:
      description: Value of an attribute
      properties:
        content:
          $ref: '#/components/schemas/AttributeVocabularyValueLocalizedContent'
        displayOrder:
          description: The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list.
          format: int32
          type:
          - integer
          - 'null'
        localizedContent:
          description: The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType.
          items:
            $ref: '#/components/schemas/AttributeVocabularyValueLocalizedContent'
          type:
          - array
          - 'null'
        mappedGenericValues:
          description: "The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist \nwithin the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time."
          items: {}
          maxItems: 200
          type:
          - array
          - 'null'
        productName:
          description: The ProductName when the Attribute DataType is ProductCode.
          type:
          - string
          - 'null'
        value:
          description: "The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. \nString data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. \nString values require content to be present.\nOnce this value is set it cannot be changed."
          maxLength: 50
          pattern: ^[A-Za-z0-9-_\.()]*[A-Za-z0-9-_()]
        valueSequence:
          description: Read only System generated monotonically increasing unique sequence.
          format: int32
          type:
          - integer
          - 'null'
      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)