Location

You can use this PATCH API request to update the following fields for an existing location on the Location UI.

URL

PATCH.../wms/lgfapi/v10/entity/location/{id}/

Request Parameters/Fields

Parameter/Field Name	Type	Format/Comments
cust_field_1	String	Custom pass-through attribute. This field supports up to a maximum of 30 characters.
cust_field_2	String	Custom pass-through attribute. This field supports up to a maximum of 30 characters.
cust_field_3	String	Custom pass-through attribute. This field supports up to a maximum of 30 characters.
cust_field_4	String	Custom pass-through attribute. This field supports up to a maximum of 30 characters.
cust_field_5	String	Custom pass-through attribute. This field supports up to a maximum of 30 characters.
to_be_counted_flg	Boolean	TRUE: Enables the “To be counted flg” for the location. When “to_be_counted_flg” is “TRUE”, “to be counted ts” is used as selection criteria in task creation template to create cycle count tasks. FALSE: Disables the “To be counted flg” for the location. But the API does not cancel the existing cycle count tasks for the location.
to_be_counted_ts	Datetime	Format: YYYY-MM-DDTHH:MM:SS It should be greater than current date and time. Also, “to_be_counted_ts” can be sent only if “to_be_counted_flg” = true. All Date-time objects are assumed to be in the time zone of the user's facility context. JSON: {"field_ts": "2018-01-30T18:30:00"}} XML: <field_ts>2018-01-30T18:30:00</field_ts>
cc_threshold_uom_id	Integer	The following values are supported: 1 – for units 2 – for lpns Opportunistic summary count functionality triggers based on each location's threshold. This field is to provide unit of measure to be considered for location threshold. For example, if cc_threshold_uom is 'UNITS' and cc_threshold_value is 5, the location's threshold for opportunistic summary count is 5 units. Valid values are LPNS/UNITS. If the location is active, then the cc threshold uom can't be “LPNS”.
cc_threshold_value	Number	Passed number must be ≥ 0.
ranking	Integer	This field supports up to a maximum of a 5-digit integer.
lock_for_putaway_flg	Boolean	If true, enables the “Put Lockout ” for the location. If false, disables the “Put Lockout ” for the location.

Request Body

{
    "fields": 
        {
			"cust_field_1": "Custom 1",
			"cust_field_2": "Custom 2",
			"cust_field_3": "Custom 3",
			"cust_field_4": "Custom 4",
			"cust_field_5": "Custom 5",
			"to_be_counted_flg": true,
			"to_be_counted_ts" : "2026-09-11T13:30:30",
			"cc_threshold_uom_id" : 1,			
			"cc_threshold_value" : 10,
			"ranking" : 1,			
			"lock_for_putaway_flg" : true			
		
        }
}

Sample Response

200 OK