---
agentTools:
  projectIndex: https://developers.9spokes.io/llms.txt
---

# Product

This is the specification for Product Items. It is in JSON format. Following is the data specification for products as extracted from accounting apps

[block:api-header]
{
  "title": "Data"
}
[/block]

Below is the content of the `data` object used with `product`.

[block:parameters]
{
  "data": {
    "0-0": "**Field**",
    "0-1": "**Data Type**",
    "0-2": "Description",
    "1-0": "**product_name**",
    "1-1": "*string*",
    "1-2": "The specific product name retrieved",
    "2-0": "**product_group**",
    "2-1": "*string*",
    "2-2": "Specific group related to the product",
    "3-0": "**product_variant**",
    "3-1": "*string[]*",
    "3-2": "Specific variant related to the product",
    "4-0": "**product_cost**",
    "4-1": "*number*",
    "4-2": "The unit cost of the product",
    "5-0": "**product_net_price**",
    "5-1": "*number*",
    "5-2": "The unit net price of the product",
    "6-0": "**inventory_product_quantity**",
    "6-1": "*inventory_product_quantity*",
    "6-2": "The units of product available for sale",
    "7-0": "**product_cost_value**",
    "7-1": "*number*",
    "7-2": "The total cost value of the product (product cost x quantity)",
    "8-0": "**product_sale_value**",
    "8-1": "*number*",
    "8-2": "The total sale value of the product (product net price x quantity)"
  },
  "cols": 3,
  "rows": 9
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "9Spokes Open API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.9spokes.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/companies/{company}/connections/{connection}/data/products": {
      "get": {
        "summary": "Product",
        "description": "",
        "operationId": "product",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"results\": [\n    {\n      \"data\": {\n        \"inventory_product_quantity\": 70,\n        \"product_cost\": 50,\n        \"product_cost_value\": 3500,\n        \"product_group\": \"Gaming\",\n        \"product_id\": \"7683bc1e9ad34b099220bdc895bbc2c4\",\n        \"product_name\": \"S70 Mouse\",\n        \"product_variant\": [\"white\", \"black\"],\n        \"product_net_price\": 70,\n        \"product_sale_value\": 4900\n      }\n    },\n    ...\n  ]\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6212eca2c5390f001b300d73:62c3adca651ec30086c1968d"
}
```