MarketSDK Categories API

openapi: 3.2.0
info:
  title: Marketsdk Categories API
  version: 1.0.0
  contact: {}
  description: 'Operations tagged Categories across 2 of this provider''s published API definitions: marketsdk-openapi.json, marketsdk-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.marketsdk.com
tags:
- name: Categories
paths:
  /v1/categories:
    post:
      operationId: createCategory
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCategoryDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryObject'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No API key, or not a valid one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: No object with that id in this marketplace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: The object is not in a state that allows this.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited. See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - bearer: []
      summary: Create a category
      tags:
      - Categories
    get:
      operationId: listCategories
      parameters:
      - name: limit
        required: false
        in: query
        schema:
          minimum: 1
          maximum: 100
          default: 20
          type: number
      - name: starting_after
        required: false
        in: query
        description: The `next_cursor` of the previous page.
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryList'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No API key, or not a valid one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited. See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - bearer: []
      summary: List categories
      tags:
      - Categories
    servers:
    - url: https://api.marketsdk.com
  /v1/categories/{id}:
    get:
      operationId: getCategory
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryObject'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No API key, or not a valid one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: No object with that id in this marketplace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited. See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - bearer: []
      summary: Retrieve a category
      tags:
      - Categories
    patch:
      operationId: updateCategory
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCategoryDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryObject'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No API key, or not a valid one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: No object with that id in this marketplace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited. See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - bearer: []
      summary: Update a category
      tags:
      - Categories
    servers:
    - url: https://api.marketsdk.com
  /v1/categories/{id}/attribute_schema:
    get:
      operationId: getAttributeSchema
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeSchemaObject'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No API key, or not a valid one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: No object with that id in this marketplace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited. See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - bearer: []
      summary: A category's attribute schema
      tags:
      - Categories
    put:
      description: Refused if a listing already in the category would no longer fit.
      operationId: putAttributeSchema
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttributeSchemaObject'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeSchemaObject'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No API key, or not a valid one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: No object with that id in this marketplace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: The object is not in a state that allows this.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited. See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - bearer: []
      summary: Replace a category's attribute schema
      tags:
      - Categories
    servers:
    - url: https://api.marketsdk.com
components:
  schemas:
    CategoryObject:
      type: object
      properties:
        object:
          type: string
          enum:
          - category
        id:
          type: string
          example: cat_034XtPDs7UJ0TXzTsdaHZa
        key:
          type: string
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        parent:
          type:
          - string
          - 'null'
        attribute_schema:
          $ref: '#/components/schemas/AttributeSchemaObject'
        fee:
          anyOf:
          - $ref: '#/components/schemas/CategoryFeeDto'
          - type: 'null'
        prohibited:
          type: boolean
          description: Listings in a prohibited category cannot be published.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - object
      - id
      - key
      - name
      - description
      - parent
      - attribute_schema
      - fee
      - prohibited
      - created_at
      - updated_at
    AttributeDefinitionObject:
      type: object
      properties:
        key:
          type: string
          example: format
        label:
          type: string
        type:
          type: string
          enum:
          - string
          - number
          - integer
          - boolean
          - enum
        required:
          type: boolean
        options:
          type: array
          items:
            type: string
        min:
          type: number
        max:
          type: number
        max_length:
          type: number
      required:
      - key
      - type
    CreateCategoryDto:
      type: object
      properties:
        key:
          type: string
          description: Your key for the category. Unique per marketplace.
          example: ui-kits
        name:
          type: string
          maxLength: 120
        description:
          type:
          - string
          - 'null'
          maxLength: 2000
        parent:
          type:
          - string
          - 'null'
          description: Another category of this marketplace.
        attribute_schema:
          $ref: '#/components/schemas/AttributeSchemaObject'
        fee:
          description: Overrides the marketplace's platform fee for listings in this category. Null uses the marketplace fee.
          anyOf:
          - $ref: '#/components/schemas/CategoryFeeDto'
          - type: 'null'
        prohibited:
          type: boolean
          default: false
          description: Listings in a prohibited category cannot be published (section 9.4).
      required:
      - key
      - name
    ErrorEnvelope:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
      - error
    CategoryList:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/CategoryObject'
        has_more:
          type: boolean
          description: Whether another page follows.
        next_cursor:
          type:
          - string
          - 'null'
          description: Pass as `starting_after` (or `cursor` for search) to get the next page.
      required:
      - object
      - data
      - has_more
      - next_cursor
    UpdateCategoryDto:
      type: object
      properties:
        name:
          type: string
          maxLength: 120
        description:
          type:
          - string
          - 'null'
        parent:
          type:
          - string
          - 'null'
        fee:
          anyOf:
          - $ref: '#/components/schemas/CategoryFeeDto'
          - type: 'null'
        prohibited:
          type: boolean
          description: Listings in a prohibited category cannot be published. Listings already published stay until moderated.
    AttributeSchemaObject:
      type: object
      properties:
        attributes:
          maxItems: 50
          type: array
          items:
            $ref: '#/components/schemas/AttributeDefinitionObject'
      required:
      - attributes
    CategoryFeeDto:
      type: object
      properties:
        percent_bps:
          type:
          - number
          - 'null'
          minimum: 0
          maximum: 10000
          description: 'Basis points: 250 is 2.5 percent.'
        fixed_amount:
          type:
          - number
          - 'null'
          minimum: 0
          description: Minor units, in the marketplace currency.
    ErrorBody:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable. Never changes once published.
          example: resource_missing
        message:
          type: string
          description: For people.
          example: No seller has that id.
        param:
          type: string
          description: The request field at fault.
          example: seller
        request_id:
          type: string
          example: req_7Gq0mR2s9xVbN4kT1pLc
      required:
      - code
      - message
      - request_id
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: 'An API key: msk_test_sk_…, msk_live_sk_…, or a publishable msk_…_pk_… key where allowed.'
x-refined-from:
- marketsdk-openapi.json
- marketsdk-openapi.json
x-stripe-permissions:
- permission: accounts
  category: Core
  resource: Accounts
  level: Write
  used_for: Create sellers' connected accounts and read their status
- permission: account_links
  category: Connect
  resource: Account Links
  level: Write
  used_for: Onboarding links for sellers
- permission: transfers
  category: Connect
  resource: Transfers
  level: Write
  used_for: Release funds to a seller, and reverse them on a refund
- permission: payment_intents
  category: Core
  resource: Payment Intents
  level: Write
  used_for: Buyer payments, and cancelling unpaid ones
- permission: charges_and_refunds
  category: Core
  resource: Charges and Refunds
  level: Write
  used_for: Refunds, full and partial
- permission: checkout_sessions
  category: Checkout
  resource: Checkout Sessions
  level: Write
  used_for: Hosted checkout, and expiring unpaid sessions
- permission: identity_verification_sessions
  category: Identity
  resource: Verification Sessions and Reports
  level: Write
  used_for: Seller identity verification
- permission: disputes
  category: Core
  resource: Disputes
  level: Read
  used_for: Reading card disputes, to link them to orders
- permission: webhook_endpoints
  category: Webhook Endpoints
  resource: Webhook Endpoints
  level: Write
  used_for: Registering our endpoint on your account