> ## 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.

# Update location

> Update an existing location

Also accepts `PATCH` with the same body.



## OpenAPI

````yaml /api-reference/openapi.json put /admin/api/v1/inventories/locations/{id}
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/locations/{id}:
    put:
      tags:
        - Inventory
      summary: Update location
      description: |-
        Update an existing location

        Also accepts `PATCH` with the same body.
      operationId: inventory-locations-update-location
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            description: The location ID
            example: 1
          description: The location ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Location name. Must not be greater than 255 characters.
                  example: Aisle A / Shelf 1
                parent_id:
                  type: integer
                  description: >-
                    Parent location ID. The `id` of an existing record in the
                    inventories_locations table.
                  nullable: true
                  example: 5
                description:
                  type: string
                  description: Location notes.
                  nullable: true
                  example: Reserved for raw materials.
                type:
                  type: string
                  description: Location type.
                  enum:
                    - supplier
                    - view
                    - internal
                    - customer
                    - inventory
                    - production
                    - transit
                  example: internal
                company_id:
                  type: integer
                  description: >-
                    Company ID. The `id` of an existing record in the companies
                    table.
                  nullable: true
                  example: 1
                storage_category_id:
                  type: integer
                  description: >-
                    Storage category ID. The `id` of an existing record in the
                    inventories_storage_categories table.
                  nullable: true
                  example: 3
                is_scrap:
                  type: boolean
                  description: Mark as scrap location.
                  nullable: true
                  example: false
                is_dock:
                  type: boolean
                  description: Mark as dock location.
                  nullable: true
                  example: false
                is_replenish:
                  type: boolean
                  description: Mark as replenish location.
                  nullable: true
                  example: false
                cyclic_inventory_frequency:
                  type: integer
                  description: Cycle counting frequency in days. Must be at least 0.
                  nullable: true
                  example: 30
                barcode:
                  type: string
                  description: >-
                    Barcode for the location. Must not be greater than 255
                    characters.
                  nullable: true
                  example: LOC-A1
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  id: 1
                  name: Physical Locations
                  full_name: Physical Locations
                  description: null
                  parent_path: 1/
                  barcode: null
                  type: view
                  position_x: 0
                  position_y: 0
                  position_z: 0
                  removal_strategy: null
                  cyclic_inventory_frequency: 0
                  last_inventory_date: null
                  next_inventory_date: null
                  is_scrap: false
                  is_replenish: false
                  is_dock: false
                  created_at: '2025-04-07T13:12:33.000000Z'
                  updated_at: '2025-04-07T13:12:33.000000Z'
                  deleted_at: null
                message: Location updated successfully.
        '401':
          description: Unauthenticated
          content:
            application/json:
              example:
                message: Unauthenticated.
        '404':
          description: Location not found
        '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.