> ## Documentation Index
> Fetch the complete documentation index at: https://docs.erp.arukz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create package type

> Create a new package type



## OpenAPI

````yaml /api-reference/openapi.json post /admin/api/v1/inventories/package-types
openapi: 3.0.3
info:
  title: ARUKZ ERP API
  version: v1
  description: >-
    The REST API of ARUKZ ERP: sales, purchases, inventory, products, partners,
    accounts, projects and reference data. Every call acts as the user whose
    token it carries and sees only that user's company.
servers:
  - url: https://erp.arukz.com
    description: ARUKZ ERP (hosted)
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Sign in for a token and sign out.
  - name: Sales
    description: Quotations, sales orders and their lines, deliveries and invoices.
  - name: Purchases
    description: Purchase orders, receipts, bills, agreements and vendor price lists.
  - name: Inventory
    description: >-
      Warehouses, locations, lots, stock quantities, receipts, deliveries,
      transfers and scrap.
  - name: Products
    description: 'The product catalogue: categories, attributes, variants and packaging.'
  - name: Partners
    description: Customers, vendors, contacts, addresses and bank accounts.
  - name: Accounts
    description: >-
      Invoices, bills, credit notes, refunds, taxes, journals and the chart of
      accounts.
  - name: Projects
    description: Projects, tasks, stages and milestones.
  - name: Reference data
    description: Currencies and rates, banks, countries, states and units of measure.
paths:
  /admin/api/v1/inventories/package-types:
    post:
      tags:
        - Inventory
      summary: Create package type
      description: Create a new package type
      operationId: inventory-package-types-create-package-type
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Package type name. Must not be greater than 255 characters.
                  example: Box L
                length:
                  type: number
                  description: >-
                    Length. Must be at least 0. Must not be greater than
                    99999999999.
                  example: 40
                width:
                  type: number
                  description: >-
                    Width. Must be at least 0. Must not be greater than
                    99999999999.
                  example: 30
                height:
                  type: number
                  description: >-
                    Height. Must be at least 0. Must not be greater than
                    99999999999.
                  example: 20
                base_weight:
                  type: number
                  description: >-
                    Base package weight. Must be at least 0. Must not be greater
                    than 99999999999.
                  example: 1.5
                max_weight:
                  type: number
                  description: >-
                    Maximum package weight. Must be at least 0. Must not be
                    greater than 99999999999.
                  example: 25
                barcode:
                  type: string
                  description: >-
                    Package type barcode. Must not be greater than 255
                    characters.
                  nullable: true
                  example: PKG-TYPE-001
                company_id:
                  type: integer
                  description: >-
                    Company ID. The `id` of an existing record in the companies
                    table.
                  nullable: true
                  example: 1
              required:
                - base_weight
                - height
                - length
                - max_weight
                - name
                - width
      responses:
        '201':
          description: Created
          content:
            application/json:
              example:
                data:
                  id: 1
                  name: Box
                  sort: 1
                  barcode: BOX-0001
                  height: '10.0000'
                  width: '10.0000'
                  length: '10.0000'
                  base_weight: '0.5000'
                  max_weight: '1.0000'
                  shipper_package_code: null
                  package_carrier_type: null
                  created_at: '2025-04-10T12:09:26.000000Z'
                  updated_at: '2025-04-10T12:09:26.000000Z'
                message: Package type created successfully.
        '401':
          description: Unauthenticated
          content:
            application/json:
              example:
                message: Unauthenticated.
        '422':
          description: Validation error
          content:
            application/json:
              example:
                message: The given data was invalid.
                errors:
                  name:
                    - The name field is required.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API token from [Sign in](/api-reference/authentication), sent as
        `Authorization: Bearer <token>`. Tokens last 30 days.

````

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