API Endpoint: Get Stock Item List Data

This endpoint retrieves a list of stock items along with their associated details from the inventory. It allows clients to paginate through the stock items and specify which fields to return in the response.

Request

• Method: GET

• URL: {{url}}/api/method/emotive_app.inventory.doctype.stock_no.stock_no.get_stock_item_list_data

Query Parameters:

• page_length (integer): The number of stock items to return per page. In this case, it is set to 20.

• start (integer): The starting index for pagination. Here, it is set to 0, indicating the first page.

• fields (array of strings): A JSON array specifying the fields to include in the response. The following fields can be requested:

  • stock_no.name

  • vehicle_item.main_image

  • stock_no.alternate_stock_no

  • vehicle_item.vin

  • stock_no.inventory_stage

  • serial_no.status

  • stock_no.sales_status

  • vehicle_title_history.title_status

  • vehicle_title_history.title_type

  • vehicle_item.current_mileage

  • stock_no.company_branch

  • stock_no.acquisition_cost

  • serial_no.company

  • stock_no.modified

  • stock_no.acquisition_type

  • stock_no.acquisition_date

  • stock_no.item

Response

The response will be a JSON object containing the following structure:

• message (object): Contains the data returned from the request.

  • rowData (array of objects): An array of stock item objects, each containing the requested fields. Example structure of each object:

    • stock_no.name: (string) The name of the stock item.

    • vehicle_item.main_image: (string) URL of the main image for the vehicle item.

    • stock_no.alternate_stock_no: (string) The alternate stock number.

    • vehicle_item.vin: (string) The Vehicle Identification Number.

    • stock_no.inventory_stage: (string) The current inventory stage of the stock item.

    • serial_no.status: (string) The status of the serial number.

    • stock_no.sales_status: (string) The sales status of the stock item.

    • vehicle_title_history.title_status: (string) The title status of the vehicle.

    • vehicle_title_history.title_type: (string) The title type of the vehicle.

    • vehicle_item.current_mileage: (string) The current mileage of the vehicle.

    • stock_no.company_branch: (string) The branch of the company associated with the stock item.

    • stock_no.acquisition_cost: (number) The cost of acquiring the stock item.

    • serial_no.company: (string) The company associated with the serial number.

    • stock_no.modified: (string) The date and time when the stock item was last modified.

    • stock_no.acquisition_type: (string) The type of acquisition for the stock item.

    • stock_no.acquisition_date: (string) The date when the stock item was acquired.

    • stock_no.item: (string) The item identifier.

  • user_info (object): Contains user-specific information related to the request.

Example Response

{
  "message": {
    "rowData": [
      {
        "stock_no.name": "",
        "vehicle_item.main_image": "",
        "stock_no.alternate_stock_no": "",
        "vehicle_item.vin": "",
        "stock_no.inventory_stage": "",
        "serial_no.status": "",
        "stock_no.sales_status": "",
        "vehicle_title_history.title_status": "",
        "vehicle_title_history.title_type": "",
        "vehicle_item.current_mileage": "",
        "stock_no.company_branch": "",
        "stock_no.acquisition_cost": 0,
        "serial_no.company": "",
        "stock_no.modified": "",
        "stock_no.acquisition_type": "",
        "stock_no.acquisition_date": "",
        "stock_no.item": ""
      }
    ],
    "user_info": {}
  }
}