---
title: "Get product"
method: GET
path: "/inventory/product/{productId}"
tags: ["Inventory"]
---

# Get product

`GET /inventory/product/{productId}`

## Request

- Base URL: `https://core.hivelocity.net/api/v2`
- URL: `https://core.hivelocity.net/api/v2/inventory/product/{productId}`
- Auth: API key in header `X-API-KEY`

## Headers

- `X-Fields` string, mask

## Response `200`

Product data was found

- Stock
  - `annually_location_premium` number: Additional annual fee for this `product_id` in this `data_center`.
  - `biennial_location_premium` number: Additional biennial fee for this `product_id` in this `data_center`.
  - `core` boolean: true|false if core site.
  - `data_center` string: A facility code. For example `NYC1`.
  - `edge` boolean: true|false if edge site.
  - `hourly_location_premium` number: Additional hourly fee for this `product_id` in this `data_center`.
  - `is_disk_upgradable` boolean: true|false. If product has multiple disk upgrade options available
  - `is_sps` boolean: true|false. If product is SPS
  - `is_vds` boolean: true|false. If VPS product is VDS type
  - `is_vps` boolean: true|false. If SPS product is VPS type
  - `location_option_id` integer: Location option ID for datacenter
  - `monthly_location_premium` number: Additional monthly fee for this `product_id` in this `data_center`.
  - `oos_lead_time_days` integer: Lead time in days for out-of-stock ordering at this location. None if not configured.
  - `oos_ordering_available` boolean: true if out-of-stock ordering is available for this product at this location.
  - `processor_info` object: JSON CPU info for cores, threads, sockets, and vCPUs.
  - `product_annually_price` number: Price per year (12 months).
  - `product_bandwidth` string: Human readable networking specs in the format: Free Outbound Transfer / NIC Size
  - `product_biennial_price` number: Price per 2 year period (24 months).
  - `product_cpu` string: Human readable CPU specs.
  - `product_cpu_cores` string: Human readable CPU core and thread info in HTML format.
  - `product_defaults` object: The default options of the product.
  - `product_disabled_billing_periods` string[]: Orders for the periods in the array will fail. Possible values: hourly|monthly|quarterly|semi-annually|biennial|triennial
  - `product_display_price` number: *DEPRECATED*.
  - `product_drive` string: Human readable drive specs. Can include multiple drives.
  - `product_drive_info` object: Structured drive info parsed from defaults
  - `product_gpu` string: Human readable GPU specs.
  - `product_hourly_price` number: Price per hour.
  - `product_id` integer: The unique ID of this product.
  - `product_memory` string: Human readable memory specs.
  - `product_monthly_price` number: Price per month.
  - `product_name` string: The unique name of this product.
  - `product_new` boolean: true|false. If product is newly released.
  - `product_on_sale` boolean: true|false. Use with `product_original_price`.
  - `product_original_price` number: Retail price of product. Use with `product_on_sale`.
  - `product_quarterly_price` number: Price per quarter (3 months).
  - `product_semi_annually_price` number: Price per half year (6 months).
  - `product_triennial_price` number: Price per 3 year period (36 months).
  - `quarterly_location_premium` number: Additional quarterly fee for this `product_id` in this `data_center`.
  - `semi_annually_location_premium` number: Additional semi-annual fee for this `product_id` in this `data_center`.
  - `stock` string: available|limited|unavailable. Limited denotes minimal stock.
  - `triennial_location_premium` number: Additional triennial fee for this `product_id` in this `data_center`.

## Other responses

- `403`: You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.
- `404`: Product with given id not found

---

[API](https://skmtc.dev/hivelocity/apis/hivelocity-api.md) - [All operations](https://skmtc.dev/hivelocity/apis/hivelocity-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hivelocity/apis/hivelocity-api/revisions/ee6b717b5015?raw)