Skip to main content
PUT
Update warehouse group

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

id
integer
required

Warehouse group ID

Body

application/json
name
string

Warehouse group name

Maximum string length: 255
description
string | null

Warehouse group description

warehouse_ids
integer[] | null

IDs of warehouses to assign to this group (replaces existing assignments)

default_warehouse_id
integer | null

ID of the default warehouse for this group

externally_managed
boolean | null

Toggle whether this group is managed by an external WMS. Sending true makes externally_managed_app_integration_account_id, pull_stocks, and pull_shipments required in the same request.

externally_managed_app_integration_account_id
integer | null

ID of the app integration account that owns this group. Required when externally_managed is true.

externally_managed_warehouse
string | null

External WMS-side warehouse identifier.

app_integration_account_inventory_location_id
integer | null

ID of the inventory location within the app integration account that this group maps to.

pull_stocks
boolean | null

Whether to pull stock levels from the external WMS. Required when externally_managed is true.

pull_shipments
boolean | null

Whether to pull shipments from the external WMS. Required when externally_managed is true.

Response

Warehouse group updated

data
object