Update Location

Beta

PATCH/v1/operations/locations/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates a location.

Permissions requiredValues:locations:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Location ID.

include[]optional arrayenumValues:parentchildren

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

nameoptional string

Display name of the location.

Maximum 255 characters.

typeoptional object

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — the parent is not required to be the next level up.

parent_idoptional stringnullable

The location this one sits under in the storage hierarchy.

Must be an existing location in your account, and cannot be the location being updated. Send null to detach it from its parent and make it a top-level location. Send null to clear.

child_idsoptional array of stringnullable

The locations that sit directly beneath this one.

This replaces the full set of children: current children that are not listed are detached and become top-level locations, and listed locations are reparented onto this location. Send null to detach every child. Omit the field to leave the existing children untouched. Send null to clear.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

parentlocationExpandablenullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

Always returned as null in this endpoint.

parentlocationExpandablenullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

Always returned as null in this endpoint.

childrenlistExpandablenullable

The locations directly below this one in the storage hierarchy.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenlistExpandablenullable

The locations directly below this one in the storage hierarchy.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of location

Resources in this page.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

Always returned as null in this endpoint.

parentlocationnullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

Always returned as null in this endpoint.

childrenlistnullable

The locations directly below this one in the storage hierarchy.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for Update Location

Update Location

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const location = await client.operations.locations.update('lc_yonnys0hx3ju', {
  child_ids: ['lc_yonnys0hx3ju'],
  name: 'Warehouse B',
  parent_id: 'lc_yonnys0hx3ju',
  type: 'section',
});

console.log(location.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const location = await client.operations.locations.update('lc_yonnys0hx3ju', {
  child_ids: ['lc_yonnys0hx3ju'],
  name: 'Warehouse B',
  parent_id: 'lc_yonnys0hx3ju',
  type: 'section',
});

console.log(location.id);

200 example

{
  "id": "lc_yonnys0hx3ju",
  "object": "location",
  "name": "Warehouse A",
  "type": "building",
  "parent": null,
  "children": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "lc_huci6mict6ys",
        "object": "location",
        "name": "Shelf A1",
        "type": null,
        "parent": null,
        "children": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "lc_yonnys0hx3ju",
  "object": "location",
  "name": "Warehouse A",
  "type": "building",
  "parent": null,
  "children": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "lc_huci6mict6ys",
        "object": "location",
        "name": "Shelf A1",
        "type": null,
        "parent": null,
        "children": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Location

Authorization

Path Parameters

Query Parameters

Request Body

Returns

Responses