Bootic Product Types API

openapi: 3.2.0
info:
  title: Bolder API v2 Product Types API
  version: '2.0'
  description: '## Getting Started


    The Bolder API provides programmatic access to your Bolder Shop data through a

    hypermedia-driven REST interface.'
  contact:
    name: Bolder API Support
    url: https://www.onbolder.com
servers:
- url: https://api.onbolder.com/v2
  description: Production
security:
- bearerAuth: []
tags:
- name: Product Types
  description: Product type definitions used to group and filter catalog products.
paths:
  /product_types:
    get:
      tags:
      - Product Types
      summary: List product types
      description: Returns product types for a shop. `shop_id` is required.
      operationId: listProductTypes
      parameters:
      - name: shop_id
        in: query
        required: true
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: Product types list
          content:
            application/json:
              example:
                _class:
                - results
                - productTypes
                total_items: 3
                _embedded:
                  items:
                  - id: 1
                    name: Clothing
                    slug: clothing
    post:
      tags:
      - Product Types
      summary: Create a product type
      operationId: createProductType
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - shop_id
              properties:
                shop_id:
                  type: integer
                name:
                  type: string
                slug:
                  type: string
                description:
                  type: string
                cart_quantity_multiple:
                  type: integer
                unit_of_measure:
                  type: string
                unit_display_quantity:
                  type: integer
            example:
              shop_id: 1
              name: Electronics
              slug: electronics
      responses:
        '201':
          description: Product type created
          content:
            application/json:
              example:
                id: 2
                slug: electronics
                name: Electronics
                cart_max_quantity_per_product: null
                cart_quantity_multiple: null
  /product_types/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: integer
      example: 1
    put:
      tags:
      - Product Types
      summary: Update or upsert a product type
      description: If no product type with this `id` exists for the account's seller, one is created instead (upsert), returning 201.
      operationId: updateProductType
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                slug:
                  type: string
                cart_quantity_multiple:
                  type: integer
                unit_of_measure:
                  type: string
            example:
              name: Electronics Updated
      responses:
        '200':
          description: Product type updated
        '201':
          description: Product type did not exist — created instead
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.onbolder.com/oauth/token
          scopes:
            products.read: View products, variants and collections
            products.write: Create and update products
            orders.read: View orders
            orders.write: Create and update orders
            customers.read: View customer profiles
            customers.write: Update customer profiles
            shops.read: View shop configuration
            shops.write: Update shop configuration
            hub.read: View content (posts, pages)
            hub.write: Create and update content
            store.read: View themes and assets
            store.write: Manage themes and assets
            sellers.read: View seller information
            batches.read: View batch job status
            batches.write: Create and run batch jobs
        authorizationCode:
          authorizationUrl: https://auth.onbolder.com/oauth/authorize
          tokenUrl: https://auth.onbolder.com/oauth/token
          scopes:
            products.read: View products, variants and collections
            products.write: Create and update products
            orders.read: View orders
            orders.write: Create and update orders
            customers.read: View customer profiles
            customers.write: Update customer profiles
            shops.read: View shop configuration
            shops.write: Update shop configuration
            hub.read: View content (posts, pages)
            hub.write: Create and update content
            store.read: View themes and assets
            store.write: Manage themes and assets
            sellers.read: View seller information
            batches.read: View batch job status
            batches.write: Create and run batch jobs