Response Structure

The root key in every response is:

data

Depending on the request, this key contains:

• A single stock item object (detailed response), or
• An array of stock item objects (list response)

When a Single Stock Item Is Returned

• name – Unique identifier of the stock item record
• owner – User who created the stock record
• creation – Timestamp of when the record was created
• modified – Timestamp of the last update
• modified_by – User who last modified the record
• docstatus – Document status (0 = Draft, 1 = Submitted, 2 = Cancelled)
• idx – Internal index value
• naming_series – Naming series used to generate the stock number
• serial_no – Serial number associated with the stock item
• alternate_stock_no – Alternative or secondary stock number

Cost-Related Fields

• auto_loaded_costs – Automatically calculated loaded costs
• acquisition_cost – Cost incurred to acquire the item
• capitalized_cost – Cost capitalized as an asset
• non_capitalized_cost – Cost expensed immediately
• soft_cost – Non-tangible costs (transport, handling, etc.)
• hard_pack_cost – Costs related to physical add-ons
• total_cost – Final total cost including all components

Valuation & Pricing Fields

• valuation_mileage – Mileage used for valuation (often for vehicles)
• trade_value – Trade-in value
• retail_value – Retail market value
• wholesale_value – Wholesale market value

Detailed Pricing Information

• offer_price – Selling offer price
• bid_price – Value offered by a buyer
• pricing_msrp – Manufacturer’s Suggested Retail Price (MSRP)
• asking_price_1 – Primary asking price
• asking_price_2 – Secondary asking price

Other Fields

• doctype – Document type (e.g., Stock No)

When Multiple Stock Items Are Returned

Each object in the data array includes:

• serial_no – Serial number for the stock item
• item – Linked item/product
• company – Company associated with the stock item
• company_branch – Branch of the company managing the stock item

Example Response:

{
  "data": {
    "name": "",
    "owner": "",
    "creation": "",
    "modified": "",
    "modified_by": "",
    "docstatus": 0,
    "idx": 0,
    "naming_series": "",
    "serial_no": "",
    "alternate_stock_no": "",
    "auto_loaded_costs": 0,
    "is_converted": 0,
    "item": "",
    "vin": "",
    "vehicle": "",
    "company": "",
    "inventory_stage": "",
    "company_branch": "",
    "sales_status": "",
    "acquisition_type": "",
    "acquired_from": "",
    "acquisition_buyer": "",
    "acquisition_date": "",
    "purchase_document_type": "",
    "purchase_document": "",
    "acquisition_cost": 0,
    "capitalized_cost": 0,
    "non_capitalized_cost": 0,
    "soft_cost": 0,
    "hard_pack_cost": 0,
    "total_without_pack": 0,
    "total_pack_cost": 0,
    "total_cost": 0,
    "valuation_mileage": 0,
    "trade_value": 0,
    "retail_value": 0,
    "wholesale_value": 0,
    "offer_price": 0,
    "bid_price": 0,
    "pricing_msrp": 0,
    "asking_price_1": 0,
    "asking_price_2": 0,
    "pricing_condition": "",
    "price_tier": "",
    "req_down_payment": 0,
    "estimated_frequency": "",
    "estimated_term": "",
    "is_published": 0,
    "doctype": ""
  }
}