Get Inventory Location Filters

Returns the enabled Shopify inventory location IDs and whether location filtering is active. Only meaningful for Shopify merchants.

Get Merchant Inventory Location Filters

get

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[] · 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

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

HTTPcURLJavaScriptPython

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
}