Skip to main content
The Settings API lets you read and update the operational preferences for your tenant. These settings govern how Synq behaves across inventory allocation, purchase order automation, and cost accounting. Changes take effect immediately and are applied to all future transactions. Every update is written to the audit log with the identity of the user who made the change.
All requests require three headers: Authorization: Bearer YOUR_TOKEN, X-Tenant-ID: YOUR_TENANT_ID, and X-Org-ID: YOUR_ORG_ID. Updating settings requires the Admin role.

​
Get tenant settings

Retrieve the current operational settings for your tenant. GET /api/v1/settings/tenant

​
Headers

​
string
required
Bearer token from your authentication provider.
​
string
required
UUID of your tenant.
​
string
required
UUID of your organization.

​
Response

​
string
UUID of the settings record.
​
string
UUID of the organization.
​
string
UUID of the tenant.
​
string
How inventory is reserved for orders. HARD allocates stock at order time; SOFT reserves without a hard deduction until fulfillment.
​
boolean
Whether Synq automatically creates purchase orders when stock falls below the low stock threshold.
​
integer
Number of units below which Synq flags a variant as low stock (and triggers auto-PO if enabled).
​
string
Inventory valuation method. WAC uses weighted average cost; FIFO uses first-in, first-out.
​
string
UUID of the user who last updated these settings.
​
string
ISO 8601 creation timestamp.
​
string
ISO 8601 last-updated timestamp.

​
Update tenant settings

Update the operational settings for your tenant. You must have the Admin role to call this endpoint. All fields are replaced with the values you provide — send the full settings object to avoid unintentional resets. PUT /api/v1/settings/tenant
Only users with the Admin role can update settings. All other roles receive 403 Forbidden.

​
Headers

​
string
required
Bearer token from your authentication provider. The calling user must have the Admin role.
​
string
required
UUID of your tenant.
​
string
required
UUID of your organization.

​
Body

​
string
required
Inventory reservation strategy. Must be HARD or SOFT.
  • HARD — stock is immediately decremented when an order is placed. Overselling is prevented.
  • SOFT — stock is earmarked but not decremented until the order is fulfilled. Useful for high-volume flash sales.
Defaults to HARD.
​
boolean
required
Set to true to have Synq automatically create a draft purchase order whenever a variant’s available stock falls at or below default_low_stock_threshold.
​
integer
required
The unit count at which a variant is considered low stock. Must be 0 or greater. For example, a value of 10 means any variant with 10 or fewer units on hand is flagged.
​
string
required
How Synq calculates the cost of goods sold. Must be WAC (Weighted Average Cost) or FIFO (First In, First Out).Defaults to WAC.

​
Response

Returns the updated settings object.