input UpdateWarehouseProductInput

Fields

FieldTypeDescription
customer_account_idString

Use this when you are a 3PL acting on behalf of one of your customers.

skuString!

SKU. SKU matching is case-insensitive and ignores surrounding whitespace.

warehouse_idString!

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

on_handIntDEPRECATED Deprecated: on_hand is derived from product locations quantities and cannot be set directly

On hand as a whole-unit count.

priceDecimal

Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value.

valueString

Declared or purchase value as a decimal monetary amount; distinct from customer-facing price.

value_currencyString

ISO 4217 currency code for the monetary values on this warehouse product.

inventory_binStringDEPRECATED Deprecated: inventory bins cannot be changed directly. Use inventory mutations instead

Inventory bin for this warehouse product. Deprecated; see the deprecation reason for current behavior.

inventory_overstock_binStringDEPRECATED Deprecated: inventory bins cannot be changed directly. Use inventory mutations instead

Inventory overstock bin for this warehouse product. Deprecated; see the deprecation reason for current behavior.

reserve_inventoryInt

Whole-unit quantity reserved from sellable availability for this warehouse product.

replenishment_levelInt

Available only for accounts that use Dynamic Slotting and used specifically for replenishment reports. SKUs will appear on the replenishment report if inventory allocated and not enough in pickable bins, or if the pickable bin inventory is less than the replenishment level.

replenishment_max_levelInt

The maximum inventory level in the pickable bin. Replenishment quantities are capped so that stock in the pickable bin does not exceed this value.

replenishment_incrementInt

The increment used when replenishing inventory. The replenishment quantity is rounded up to the nearest multiple of this value.

reorder_amountInt

Reorder amount as a numeric value.

reorder_levelInt

Reorder level as a numeric value.

customs_valueDecimal

Declared or customs value as a decimal monetary amount; distinct from price, which is the customer-facing sale or charge amount.

activeBoolean

Whether this warehouse product is active.

Referenced By

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "sku": "BLUE-TEE-M",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "on_hand": 2,
  "price": 19.99,
  "value": "19.99",
  "value_currency": "19.99",
  "inventory_bin": "A01-01-01",
  "inventory_overstock_bin": "OVR-01",
  "reserve_inventory": 2,
  "replenishment_level": 2,
  "replenishment_max_level": 2,
  "replenishment_increment": 2,
  "reorder_amount": 2,
  "reorder_level": 2,
  "customs_value": 19.99,
  "active": true
}