input CreateWarehouseProductInput

Fields

FieldTypeDescription
warehouse_idString!

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

on_handInt!

On hand as a whole-unit count.

inventory_binString

Inventory bin for this warehouse product.

inventory_overstock_binString

Inventory overstock bin for this warehouse product.

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_levelInt

Reorder level as a numeric value.

reorder_amountInt

Reorder amount as a numeric value.

priceString

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

customBoolean

Whether this warehouse product uses custom configuration.

warehouseString

Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference.

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.

Referenced By

Example

{
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "on_hand": 2,
  "inventory_bin": "A01-01-01",
  "inventory_overstock_bin": "OVR-01",
  "reserve_inventory": 2,
  "replenishment_level": 2,
  "replenishment_max_level": 2,
  "replenishment_increment": 2,
  "reorder_level": 2,
  "reorder_amount": 2,
  "price": "19.99",
  "custom": true,
  "warehouse": "Primary Warehouse",
  "value": "19.99",
  "value_currency": "19.99"
}