Introduction

Overview

Cisco offers a wide range of products and networking solutions designed for enterprises and small businesses across a variety of industries. Cisco strives to provide partners and customers with the ability to more effectively integrate and manage evolving Cisco products in their network and business operations.

The Cisco Product Information API removes barriers to enterprise automation and can help end users shorten sales cycles and reduce operating expenses. This new way of delivering product information empowers customers and partners to use the Cisco data in a new and innovative way to increase their productivity and add new values to their business. This approach allows customers and partners the flexibility to use Cisco’s intellectual capital in a way that meets their specific needs and to leverage Cisco's strength in delivering rich knowledge while giving them the choice in how they want to consume it.

Features

The Cisco Product Information API provides the following features:

Supports RESTful interface
Supports JSON data format
Includes the following web services:

API Reference

This topic describes the methods provided by this API.

Notes:

Pagination is supported; see Pagination Response Record for details on paging.
You can download the WADL for this API by clicking the following link: Cisco Production Information API WADL
For information on error codes returned by these methods, see Error Codes.

GET Product Information by Serial Number(s)

Returns product information associated with the specified serial number or numbers.

Request Parameters

Parameter	Required	Type	Length	Description
page_index	No	integer	2	Index number of the page to return. A maximum of 500 records per page are returned. If the page_index value is not specified, the first page is returned by default.
serial_numbers	Yes	string	40	Device serial number or numbers for which to return results. At least one serial number shall be required; you can enter up to 5 serial numbers separated by commas. Note: For the 1.0 release, only hardware products are supported.

Response Parameters

Parameter	Type	Length	Description
pagination_response_record	object	-	See Pagination Response Record for details.
product_list	array	-	Array of information returned for each identified product; this array includes the parameters listed below.
base_pid	string	40	Manufacturing (or base) product ID for a given serial number.
dimensions	string	300	Product dimensions (dimension format and dimension value).
form_factor	string	100	Form factor of the product if it exists.
id	integer	5	Record number in a result set.
orderable_pid	string	40	Orderable product ID for a given serial number.
orderable_status	string	3	Represents the orderable status of a product. One of the following values: O = ORDERABLE N = NON_ORDERABLE EOX = End of Life
product_category	string	100	Category of the product.
product_name	string	100	Title or description of the product.
product_series	string	100	Series to which the product belongs.
product_subcategory	string	100	Subcategory of the product if it exists.
product_support_page	string	1024	URL of the Cisco.com support product model (or series) page.
product_type	string	100	Type of product. Note: For the 1.0 release, only hardware products are supported.
release_date	string	10	Product release date in the following format: YYYY-MM-DD.
rich_media_urls	list	2048	List of small and large image URLs for a given product if they exist. If multiple URLs exist, the URLs in the list will be separated by commas.
sr_no	string	40	Serial number submitted in the request.
visio_stencil_url	string	1024	URL from which the .zip file of the Visio stencils for a given product can be downloaded if it exists.
weight	string	20	Product weight with unit of measurement.

Sample Request

https://apix.cisco.com/product/v1/information/serial_numbers/SPE181700LN,REF_CSJ07306405

Sample Response

{
    "pagination_response_record": {
        "title": "Product Info API - Get Product Information by Serial Number(s)",
        "page_index": 1,
        "last_index": 1,
        "total_records": 2
        "page_records": 2,
        "self_link": "https://apix.cisco.com/product/v1/information/serial_numbers/SPE181700LN,REF_CSJ07306405?page_index=1",
    },
    "product_list": [{
        "id": "1",
        "sr_no": "SPE181700LN",
        "base_pid": "UBR10012",
        "orderable_pid": "UBR10012",
        "product_name": "Cisco PA-8T: Eight Serial Port Adapter 
        for Cisco 7000 Series Routers",
        "product_type": “ROUTER",
        "product_series": "Cisco uBR10000 Series Universal Broadband Routers",
        "product_category": "Video",
        "product_subcategory": "10012 SERIES",
        "release_date": “2005-05-02",
        "orderable_status": “O",
        "dimensions": {
            "dimensions_format": "Dimensions (HxWxD)",
            "dimensions_value": "31.25 x 17.2 x 22.75 in. (79.4 x 43.7 x 57.8 cm)"
        },
        "weight": "235 lb. (106.6 kg) fully-configured chassis"
        "form_factor": "18 rack units (RU) Mounting: 19 in. rack mountable\n(front or rear); 2 units per 7 ft. rack. \nNote: Mounting in 23 in. racks is possible with optional third-party hardware",
        "product_support_page": "",
        "visio_stencil_url": "http://www.cisco.com/content/dam/assets/prod/visio/visio/product_visio_icon0900aecd8009b9c8.zip",
        "rich_media_urls": {
            "large_image_url": "",
            "small_image_url": ""
        }
    },{
        "id": "2",
        "sr_no": "REF_CSJ07306405",
        "base_pid": "UBR10-MC5X20U-D=",
        "orderable_pid": "UBR10-MC5X20U-D=",
        "product_name": "Cisco uBR10012 Universal Broadband Router",
        "product_type": "BOARD",
        "product_series": "Cisco uBR10000 Series Universal Broadband Routers",
        "product_category": “Video",
        "product_subcategory": "SPARE",
        "release_date": “2005-05-05",
        "orderable_status": "",
        "dimensions": {
            "dimensions_format": "Dimensions (HxWxD)",
            "dimensions_value": "31.25 x 17.2 x 22.75 in. (79.4 x 43.7 x 57.8 cm)"
        },
        "form_factor": "18 rack units (RU) Mounting: 19 in. rack mountable (front or rear); 2 units per 7 ft. rack. Note: Mounting in 23 in. racks is possible with optional third-party hardware",
        "weight": "235 lb. (106.6 kg) fully-configured chassis"
        "product_support_page": "",
        "visio_stencil_url": “http://www.cisco.com/content/dam/assets/prod/visio/visio/product_visio_icon0900aecd8009b9c8.zip",
        "rich_media_urls": {
            "large_image_url": "",
            "small_image_url": ""
        }
    }]
}

GET Product Information by Product Identifier(s)

Returns product information associated with the specified product identifier or identifiers.

Request Parameters

Parameter	Required	Type	Length	Description
page_index	No	integer	2	Index number of the page to return. A maximum of 500 records per page are returned. If the page_index value is not specified, the first page is returned by default.
product_ids	Yes	string	40	Product identifier or identifiers for which to return results. At least one product identifier shall be required; you can enter up to 5 product IDs separated by commas. Note: For the 1.0 release, only hardware products are supported.

Response Parameters

Parameter	Type	Length	Description
pagination_response_record	object	-	See Pagination Response Record for details.
product_list	array	-	Array of information returned for each identified product; this array includes the parameters listed below.
dimensions	string	300	Product dimensions (dimension format and dimension value).
form_factor	string	100	Form factor of the product if it exists.
id	integer	5	Record number in a result set.
orderable_status	string	3	Represents the orderable status of a product. One of the following values: O = ORDERABLE N = NON_ORDERABLE EOX = End of Life
product_category	string	100	Category of the product.
product_id	string	40	Product identifier submitted in the request.
product_name	string	100	Title or description of the product.
product_series	string	100	Series to which the product belongs.
product_subcategory	string	100	Subcategory of the product if it exists.
product_support_page	string	1024	URL of the Cisco.com support product model (or series) page.
product_type	string	100	Type of product. Note: For the 1.0 release, only hardware products are supported.
release_date	string	10	Product release date in the following format: YYYY-MM-DD.
rich_media_urls	list	2048	List of small and large image URLs for a given product if they exist. If multiple URLs exist, the URLs in the list will be separated by commas.
visio_stencil_url	string	1024	URL from which the .zip file of the Visio stencils for a given product can be downloaded if it exists.
weight	string	20	Product weight with unit of measurement.

Sample Request

https://apix.cisco.com/product/v1/information/product_ids/UBR10012,ASR1001

Sample Response

{
    "pagination_response_record": {
        "title": "Product Info API - Get Product Information by Product Id(s)",
        "page_index": 1,
        "last_index": 1,
        "total_records": 3
        "page_records": 3,
        "self_link": "https://apix.cisco.com/product/v1/information/product_ids/UBR10012,ASR1001?page_index=1",
    },
    "product_list": [{
        "id": "1",
        "product_id": "UBR10012",
        "product_name": "Cisco uBR10012 Universal Broadband Router”,
        "product_type": "ROUTER",
        "product_series": "Cisco uBR10000 Series Universal Broadband Routers",
        "product_category": "Video",
        "product_subcategory": "10012 SERIES",
        "release_date": "2005-05-02",
        "orderable_status": "O",
        "dimensions": {
            "dimensions_format": "Rack Units",
            "dimensions_value": "18 rack units (RU) Mounting: 19 in. rack mountable \n(front or rear); 2 units per 7 ft. rack. \nNote: Mounting in 23 in. racks is possible with optional third-party hardware"
        },
        "weight": "235 lb. (106.6 kg) fully-configured chassis"
        "form_factor": "18 rack units (RU) Mounting: 19 in. rack mountable \n(front or rear); 2 units per 7 ft. rack. \nNote: Mounting in 23 in. racks is possible with optional third-party hardware",
        "product_support_page": "",
        "visio_stencil_url": "http://www.cisco.com/content/dam/assets/prod/visio/visio/product_visio_icon0900aecd8009b9c8.zip",
        "rich_media_urls": {
            "large_image_url": "",
            "small_image_url": "http://www.cisco.com/c/dam/en/us/products/video/ps8806/ps5684/ps2209/prod_small_photo0900aecd800620a1.jpg"
        }
    },{
        "id": "2",
        "product_id": "UBR10012",
        "product_name": "Cisco uBR10012 Universal Broadband Router”,
        "product_type": "ROUTER",
        "product_series": "Cisco uBR10000 Series Universal Broadband Routers",
        "product_category": "Video",
        "product_subcategory": "10012 SERIES",
        "release_date": "2005-05-02",
        "orderable_status": "O",
        "dimensions": {
            "dimensions_format": "Dimensions (HxWxD)",
            "dimensions_value": "31.25 x 17.2 x 22.75 in. (79.4 x 43.7 x 57.8 cm)"
         },
        "weight": "235 lb. (106.6 kg) fully-configured chassis"
        "form_factor": "18 rack units (RU) Mounting: 19 in. rack mountable \n(front or rear); 2 units per 7 ft. rack. \nNote: Mounting in 23 in. racks is possible with optional third-party hardware",
        "product_support_page": "",
        "visio_stencil_url": "http://www.cisco.com/content/dam/assets/prod/visio/visio/product_visio_icon0900aecd8009b9c8.zip",
        "rich_media_urls": {
            "large_image_url": "",
            "small_image_url": "http://www.cisco.com/c/dam/en/us/products/video/ps8806/ps5684/ps2209/prod_small_photo0900aecd800620a1.jpg"
        }
    },{
        "id": "3",
        "product_id": "ASR1001",
        "product_name": "Cisco ASR 1001 Router",
        "product_type": "ROUTER",
        "product_series": "Cisco ASR 1000 Series Aggregation Services Routers",
        "product_category": "Routers",
        "product_subcategory": "ASR 1001 SER",
        "release_date": "2010-10-04",
        "orderable_status": "O",
        "dimensions": {
            "dimensions_format": "Dimensions (HxWxD)",
            "dimensions_value": "22.8 x 17.2 x 22 in"
        },
        "weight": ""
        "form_factor": "13 RU",
        "product_support_page": "",
        "visio_stencil_url": "http://www.cisco.com/content/dam/assets/prod/visio/visio/Routers_Cisco_ASR_1000_11_08.zip",
        "rich_media_urls": {
            "large_image_url": "",
            "small_image_url": "http://www.cisco.com/c/dam/en/us/products/routers/ps9343/prod_small_photo.jpg"
        }
    }]
}

Get Product MDF Information by Product Id(s)

Returns metadata framework (MDF) identifiers associated with the specified product identifier or identifiers.

Request Parameters

Parameter	Required	Type	Length	Description
page_index	No	integer	2	Index number of the page to return. A maximum of 500 records per page are returned. If the page_index value is not specified, the first page is returned by default.
product_ids	Yes	string	40	Product identifier or identifiers for which to return results. At least one product identifier shall be required; you can enter up to 5 product IDs separated by commas. Note: For the 1.0 release, only hardware products are supported.

Response Parameters

Parameter	Type	Length	Description
pagination_response_record	object	-	See Pagination Response Record for details.
product_list	array	-	Array of information returned for each identified product; this array includes the parameters listed below.
id	integer	5	Record number in a result set.
product_id	string	40	Product identifier submitted in the request.
product_name	string	100	Title or description of the product.
product_name_mdf	string	100	MDF ID of the product.
product_series	string	100	Series to which the product belongs.
product_series_mdf	string	100	MDF ID of the series.

Sample Request

https://apix.cisco.com/product/v1/information/product_ids_mdf/ASA5505-50-BUN-K9?page_index=1

Sample Response

{
  "pagination_response_record": {
    "last_index": 1,
    "page_index": 1,
    "page_records": 1,
    "self_link": "https://apix.cisco.com/product/v1/information/product_ids_mdf/ASA5505-50-BUN-K9?page_index=1",
    "title": "Product Info API - Get Product MDF Information by Product Id(s)",
    "total_records": 1
  },
  "product_list": [
    {
      "id": "1",
      "product_id": "ASA5505-50-BUN-K9",
      "product_name": "Cisco ASA 5505 Adaptive Security Appliance",
      "product_name_mdf": "280582808",
      "product_series": "Cisco ASA 5500-X Series Firewalls",
      "product_series_mdf": "279513386"
    }
  ]
}

Pagination Response Record

Provides information about the page requested and the total number of pages available to return.

Parameters

Parameter	Type	Length	Description
last_index	integer	5	Total number of pages available.
page_index	integer	5	Index number of the requested page.
page_records	integer	5	Total results for this page.
self_link	char	120	Self reference link.
title	char	120	Name of the method called.
total_records	integer	5	Total results for this query.

Sample JSON Response

{
  "pagination_response_record": {
    "last_index": 1,
    "page_index": 1,
    "page_records": 1,
    "self_link": "https://apix.cisco.com/product/v1/information/product_ids_mdf/ASA5505-50-BUN-K9?page_index=1",
    "title": "Product Info API - Get Product MDF Information by Product Id(s)",
    "total_records": 1
  },

Error Codes

This table describes the error codes returned by the Cisco Product Information API.

Code	Message	Description
403	Forbidden	You have not been granted permission to access the requested method or object.
403	Not Authorized	The API key associated with your request was not recognized or the signature was incorrect.
403	Account Inactive	The API key you are using to access the Mashery API has not been approved or has been disabled.
403	Account Over Queries Per Second Limit	The API key you are using has attempted to access the api too many times in one second.
403	Account Over Rate Limit	The API key you are using has attempted to access the api too many times in the rate limiting period.
403	Rate Limit Exceeded	The service you have requested is over-capacity.