Set variant location opening quantities

PUT /api/v1/inventory/products/variants/{id}/location-quantities

Set absolute on-hand quantities for this variant at each location without creating inventory adjustment journal entries.

Operation ID: set_variant_location_quantities_api_v1_inventory_products_variants__id__location_quantities_put · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

id string · uuid required

Request body

Schema: SetVariantLocationQuantitiesRequest

location_quantities array · VariantLocationQuantityInput requiredVariantLocationQuantityInput

List of per-location absolute quantities.

2 fields

location_id string required: Location UUID.
on_hand number required: Absolute on-hand quantity to set at this location.

effective_at string · date-time

Timestamp for inventory records (ISO 8601). Defaults to now.

Responses

200 Successful Response

Schema: VariantResponse

id string required: Variant UUID.
product_id string required: Parent product UUID.
business_id string required: Business UUID.
created_at string · date-time required: Creation timestamp.
updated_at string · date-time required: Last update timestamp.
name string required: Variant name.
sku string: Stock Keeping Unit.
manufacturer_sku string: Manufacturer's SKU.
archived boolean: Whether variant is archived.
price number: Unit price in dollars (legacy field, prefer unit_price).
cost number: Unit cost in dollars (legacy field, prefer unit_cost).
inventory_quantity integer: Current inventory quantity (legacy, prefer inventory.on_hand).
shopify_variant_id string: Shopify variant ID if synced from Shopify.
stripe_price_id string: Stripe price ID if synced to Stripe.
stripe_product_id string: Stripe product ID if synced to Stripe.
unit_price integer: Sale price in cents.
unit_cost integer: Cost price in cents.
unit_cost_precise number: Precise unit cost in dollars with sub-cent precision.
uom string: Unit of measure: EA, LB, G, KG, OZ, etc.
default_vendor_id string: Preferred vendor UUID.
inventory InventorySummary: Detailed inventory breakdown.
product_name string: Parent product name (resolved).
margin_cents integer required: Profit margin in cents (unit_price - unit_cost).
margin_percentage number required: Profit margin as percentage of sale price.

400 Bad Request - Invalid input

404 Not Found - Resource does not exist

422 Validation Error - Invalid data format

Code samples

PUT /api/v1/inventory/products/variants/{id}/location-quantities

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/inventory/products/variants/{id}/location-quantities' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "location_quantities": []
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/inventory/products/variants/{id}/location-quantities', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "location_quantities": []
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "location_quantities": []
}

response = httpx.put("https://api.ondayzero.com/api/v1/inventory/products/variants/{id}/location-quantities", headers=headers, json=payload)
data = response.json()