Get Inventory Location Filters
Returns the enabled Shopify inventory location IDs and whether location filtering is active. Only meaningful for Shopify merchants.
Returns the enabled Shopify inventory location IDs and whether location filtering is active. Only meaningful for Shopify merchants.
Path parameters
merchant_idinteger · int32Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Responses
200
The merchant's inventory location filters.
application/json
The set of Shopify inventory location IDs used to filter stock availability. Only applicable to Shopify merchants.
location_idsstring[] · nullableOptionalExample:
The enabled Shopify location IDs (numeric strings).
12345678filtering_enabledboolean · nullableRead-onlyOptionalExample:
Read-only. Derived from location_ids: true when at least one location ID is configured. To change it, add or remove location IDs.
trueget/merchants/{merchant_id}/inventory-location-filters
GET /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
Accept: */*
200
The merchant's inventory location filters.
{
"location_ids": [
"12345678",
"87654321"
],
"filtering_enabled": true
}Last updated
Was this helpful?