Replace Inventory Location Filters

Replaces the merchant's inventory location filters. Only meaningful for Shopify merchants.

Replace Merchant Inventory Location Filters

put

Replaces the full set of enabled Shopify location IDs. The filter_inventory_by_locations platform flag is derived automatically (enabled when the list is non-empty). Only supported for Shopify merchants; returns 400 otherwise. The filtering_enabled field is read-only and ignored on write.

Path parameters

merchant_idinteger · int32Required

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

application/json

The set of Shopify inventory location IDs used to filter stock availability. Only applicable to Shopify merchants.

location_idsstring[] · nullableOptional

The enabled Shopify location IDs (numeric strings).

Example: 12345678

filtering_enabledboolean · nullableRead-onlyOptional

Read-only. Derived from location_ids: true when at least one location ID is configured. To change it, add or remove location IDs.

Example: true

Responses

200

The updated inventory location filters.

application/json

The set of Shopify inventory location IDs used to filter stock availability. Only applicable to Shopify merchants.

location_idsstring[] · nullableOptional

The enabled Shopify location IDs (numeric strings).

Example: 12345678

filtering_enabledboolean · nullableRead-onlyOptional

Read-only. Derived from location_ids: true when at least one location ID is configured. To change it, add or remove location IDs.

Example: true

put/merchants/{merchant_id}/inventory-location-filters

HTTPcURLJavaScriptPython

PUT /v1/merchants/{merchant_id}/inventory-location-filters HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "location_ids": [
    "12345678",
    "87654321"
  ]
}

200

The updated inventory location filters.

{
  "location_ids": [
    "12345678",
    "87654321"
  ],
  "filtering_enabled": true
}