> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Creates a product or a bundle in the item catalog.

> <b>Required:</b>
`TypeId` (`1` Product or `2` Bundle) and `Name`.
            
<b>Product only:</b>`Sku`, `PartNumber`, `Manufacturer`, `UnitCost`.
            
<b>Bundle only:</b>`SubItems` (required for a bundle, at least one),
            `ShowSubItemsOnInvoice`, `ShowSubItemDescriptionsOnInvoice`. A bundle's
            `UnitCost` is calculated from its sub-items and can't be sent directly.
            
<b>Optional for either type:</b>`Number`, `Description`, `CategoryId`,
            `SubcategoryId`, `ClientId`, `LocationId`, `Vendor`, `UnitPrice`,
            `TaxId`, `ExternalProductId`.
            

            Sending a Product-only field on a Bundle, or a Bundle-only field on a Product, is a 400.
            A `SubItems` entry can't itself be a bundle — bundles can't nest.
            



## OpenAPI

````yaml /api-reference/openapi.json post /v1/items
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/items:
    post:
      tags:
        - Billing
      summary: Creates a product or a bundle in the item catalog.
      description: "<b>Required:</b>\r\n`TypeId` (`1` Product or `2` Bundle) and `Name`.\r\n            \n<b>Product only:</b>`Sku`, `PartNumber`, `Manufacturer`, `UnitCost`.\r\n            \n<b>Bundle only:</b>`SubItems` (required for a bundle, at least one),\r\n            `ShowSubItemsOnInvoice`, `ShowSubItemDescriptionsOnInvoice`. A bundle's\r\n            `UnitCost` is calculated from its sub-items and can't be sent directly.\r\n            \n<b>Optional for either type:</b>`Number`, `Description`, `CategoryId`,\r\n            `SubcategoryId`, `ClientId`, `LocationId`, `Vendor`, `UnitPrice`,\r\n            `TaxId`, `ExternalProductId`.\r\n            \n\r\n            Sending a Product-only field on a Bundle, or a Bundle-only field on a Product, is a 400.\r\n            A `SubItems` entry can't itself be a bundle — bundles can't nest.\r\n            "
      operationId: post_v1_items
      requestBody:
        description: The item to create.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CreateItemCommand'
          application/json:
            schema:
              $ref: '#/components/schemas/CreateItemCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateItemCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateItemCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateItemResultBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateItemResultBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateItemResultBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    CreateItemCommand:
      type: object
      properties:
        TypeId:
          type: integer
          description: >-
            Whether this is a product (1) or a bundle (2). Required; cannot be
            changed once created.
          format: int32
          example: 1
        Name:
          type: string
          description: Display name of the item. Required.
          example: Managed Workstation - Standard
        Number:
          type: string
          description: The item's product number, free text.
          nullable: true
        Description:
          type: string
          description: Free-text description.
          nullable: true
        CategoryId:
          type: integer
          description: >-
            Category to file the item under, from GET /v1/items/categories.
            Validated for existence and tenant ownership.
          format: int64
          nullable: true
        SubcategoryId:
          type: integer
          description: Subcategory to file the item under; must belong to CategoryId.
          format: int64
          nullable: true
        ClientId:
          type: integer
          description: >-
            Client this item is scoped to, when it is client-specific rather
            than catalog-wide.
          format: int64
          nullable: true
        LocationId:
          type: integer
          description: Client location this item is scoped to; must belong to ClientId.
          format: int64
          nullable: true
        Sku:
          type: string
          description: Product-only. Rejected (400) if sent while TypeId is Bundle.
          nullable: true
        PartNumber:
          type: string
          description: Product-only. Rejected (400) if sent while TypeId is Bundle.
          nullable: true
        Manufacturer:
          type: string
          description: Product-only. Rejected (400) if sent while TypeId is Bundle.
          nullable: true
        Vendor:
          type: string
          description: Vendor the item is sourced from.
          nullable: true
        UnitCost:
          type: number
          description: "Product-only. Rejected (400) if sent while TypeId is Bundle — a bundle's cost is derived\r\nserver-side from its sub-items, never supplied directly."
          format: double
          nullable: true
          example: 42.5
        UnitPrice:
          type: number
          description: >-
            Unit price charged to the client. May be negative, for a discount or
            credit line.
          format: double
          nullable: true
          example: 89
        TaxId:
          type: integer
          description: Tax rate to apply, from GET /v1/taxes.
          format: int64
          nullable: true
        ExternalProductId:
          type: string
          description: Identifier of this item in an external accounting system.
          nullable: true
        SubItems:
          type: array
          items:
            $ref: '#/components/schemas/CreateItemSubItemModel'
          description: "Bundle-only, required for a bundle (at least one entry) — rejected (400) if sent while\r\nTypeId is Product. Every ItemId must resolve to an existing, active product (not a bundle\r\n— bundles cannot nest) owned by this service provider."
          nullable: true
        ShowSubItemsOnInvoice:
          type: boolean
          description: Bundle-only. Rejected (400) if sent while TypeId is Product.
          nullable: true
        ShowSubItemDescriptionsOnInvoice:
          type: boolean
          description: Bundle-only. Rejected (400) if sent while TypeId is Product.
          nullable: true
      additionalProperties: false
      description: "Creates a product or a bundle in the catalog. `TypeId` decides which, and which of the\r\ntype-conditional fields below are accepted."
    CreateItemResultBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          $ref: '#/components/schemas/CreateItemResult'
        DataContext:
          type: object
          additionalProperties: false
          nullable: true
          example: null
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    CreateItemSubItemModel:
      type: object
      properties:
        ItemId:
          type: string
          description: >-
            Identifier of the product this sub-item refers to. Must not itself
            be a bundle.
          format: uuid
        Quantity:
          type: number
          description: >-
            How many of this product the bundle includes. Must be greater than
            0.
          format: double
          example: 2
      additionalProperties: false
      description: One sub-item on a bundle create/update request.
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    CreateItemResult:
      type: object
      properties:
        Id:
          type: string
          description: Identifier of the newly created item.
          format: uuid
      additionalProperties: false
      description: "Result of a create-item request. Matches the minimal shape returned by create-ticket,\r\ncreate-time-entry and create-invoice, rather than returning the full item."
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.