Skip to main content
POST
Batch Update Location Tags

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the referenced Warehouse.

Required range: x >= 1

Body

application/json
operation
enum<string>
required
  • add: Assign the tags to each location, keeping its existing tags
  • remove: Unassign the tags from each location, keeping its other tags
  • replace: Replace each location's whole tag set with the submitted tags
Available options:
add,
remove,
replace
tags
LocationTagRef · object[]
required

The LocationTag references to add, remove or assign. May only be empty for the replace operation, which then clears every tag from the locations.

Maximum array length: 100
locations
integer[]
required

The ids of the Location objects to update. The whole batch is applied in one transaction that holds a row lock on each location, so the limit is well below that of a read endpoint; split larger sets into successive requests.

Required array length: 1 - 1000 elements
Required range: x >= 1

Response

The tag update was applied to every referenced location.

updated
integer

The number of locations the operation was applied to. This counts every referenced location, including any whose tag set the operation left unchanged.

Example:

42

meta
object

Additional metadata pertaining to the response.