GET inventory/{apiKey}/inventoryreport

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

None.

Body Parameters

InventoryRportParams
NameDescriptionTypeAdditional information
year

integer

None.
is_active

boolean

None.
part_type

string

None.
displayed_on

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "year": 1,
  "is_active": true,
  "part_type": "sample string 1",
  "displayed_on": "sample string 2"
}

text/xml

Sample: 
<InventoryRportParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">
  <displayed_on>sample string 2</displayed_on>
  <is_active>true</is_active>
  <part_type>sample string 1</part_type>
  <year>1</year>
</InventoryRportParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InventoryRportParams'.

Response Information

Resource Description

Collection of InventoryReportModel
NameDescriptionTypeAdditional information
part_id

integer

None.
category_id

integer

None.
category_name

string

None.
stock_number

string

None.
lot_number

string

None.
date_created

date

None.
date_modified

date

None.
date_deleted

date

None.
condition

string

None.
price

decimal number

None.
price_notes

string

None.
display_price

boolean

None.
wholesale_price

decimal number

None.
internal_price

decimal number

None.
cost

decimal number

None.
description

string

None.
private_notes

string

None.
quantity

integer

None.
quantity_on_hand

integer

None.
reorderable

string

None.
min_quantity

integer

None.
max_quantity

integer

None.
labels

string

None.
locations

string

None.
display_on

string

None.
images

string

None.
last_ordered_from

string

None.
last_ordered_date

date

None.
last_received_from

string

None.
last_received_date

date

None.
entered_by

string

None.
department

string

None.
part_views

integer

None.
other_fields

Collection of OtherField

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "part_id": 1,
    "category_id": 1,
    "category_name": "sample string 1",
    "stock_number": "sample string 2",
    "lot_number": "sample string 3",
    "date_created": "2025-04-03T18:06:40.2336988-06:00",
    "date_modified": "2025-04-03T18:06:40.2336988-06:00",
    "date_deleted": "2025-04-03T18:06:40.2336988-06:00",
    "condition": "sample string 6",
    "price": 7.0,
    "price_notes": "sample string 8",
    "display_price": true,
    "wholesale_price": 10.0,
    "internal_price": 11.0,
    "cost": 12.0,
    "description": "sample string 13",
    "private_notes": "sample string 14",
    "quantity": 15,
    "quantity_on_hand": 16,
    "reorderable": "sample string 17",
    "min_quantity": 18,
    "max_quantity": 19,
    "labels": "sample string 20",
    "locations": "sample string 21",
    "display_on": "sample string 22",
    "images": "sample string 23",
    "last_ordered_from": "sample string 24",
    "last_ordered_date": "2025-04-03T18:06:40.2336988-06:00",
    "last_received_from": "sample string 26",
    "last_received_date": "2025-04-03T18:06:40.2336988-06:00",
    "entered_by": "sample string 28",
    "department": "sample string 29",
    "part_views": 30,
    "other_fields": [
      {
        "FieldName": "sample string 1",
        "FieldValue": "sample string 2"
      },
      {
        "FieldName": "sample string 1",
        "FieldValue": "sample string 2"
      }
    ]
  },
  {
    "part_id": 1,
    "category_id": 1,
    "category_name": "sample string 1",
    "stock_number": "sample string 2",
    "lot_number": "sample string 3",
    "date_created": "2025-04-03T18:06:40.2336988-06:00",
    "date_modified": "2025-04-03T18:06:40.2336988-06:00",
    "date_deleted": "2025-04-03T18:06:40.2336988-06:00",
    "condition": "sample string 6",
    "price": 7.0,
    "price_notes": "sample string 8",
    "display_price": true,
    "wholesale_price": 10.0,
    "internal_price": 11.0,
    "cost": 12.0,
    "description": "sample string 13",
    "private_notes": "sample string 14",
    "quantity": 15,
    "quantity_on_hand": 16,
    "reorderable": "sample string 17",
    "min_quantity": 18,
    "max_quantity": 19,
    "labels": "sample string 20",
    "locations": "sample string 21",
    "display_on": "sample string 22",
    "images": "sample string 23",
    "last_ordered_from": "sample string 24",
    "last_ordered_date": "2025-04-03T18:06:40.2336988-06:00",
    "last_received_from": "sample string 26",
    "last_received_date": "2025-04-03T18:06:40.2336988-06:00",
    "entered_by": "sample string 28",
    "department": "sample string 29",
    "part_views": 30,
    "other_fields": [
      {
        "FieldName": "sample string 1",
        "FieldValue": "sample string 2"
      },
      {
        "FieldName": "sample string 1",
        "FieldValue": "sample string 2"
      }
    ]
  }
]

text/xml

Sample: 
<ArrayOfinventoryreport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">
  <inventoryreport>
    <category_id>1</category_id>
    <category_name>sample string 1</category_name>
    <condition>sample string 6</condition>
    <cost>12</cost>
    <date_created>2025-04-03T18:06:40.2336988-06:00</date_created>
    <date_deleted>2025-04-03T18:06:40.2336988-06:00</date_deleted>
    <date_modified>2025-04-03T18:06:40.2336988-06:00</date_modified>
    <department>sample string 29</department>
    <description>sample string 13</description>
    <display_on>sample string 22</display_on>
    <display_price>true</display_price>
    <entered_by>sample string 28</entered_by>
    <images>sample string 23</images>
    <internal_price>11</internal_price>
    <labels>sample string 20</labels>
    <last_ordered_date>2025-04-03T18:06:40.2336988-06:00</last_ordered_date>
    <last_ordered_from>sample string 24</last_ordered_from>
    <last_received_date>2025-04-03T18:06:40.2336988-06:00</last_received_date>
    <last_received_from>sample string 26</last_received_from>
    <locations>sample string 21</locations>
    <lot_number>sample string 3</lot_number>
    <max_quantity>19</max_quantity>
    <min_quantity>18</min_quantity>
    <other_fields>
      <OtherField>
        <FieldName>sample string 1</FieldName>
        <FieldValue>sample string 2</FieldValue>
      </OtherField>
      <OtherField>
        <FieldName>sample string 1</FieldName>
        <FieldValue>sample string 2</FieldValue>
      </OtherField>
    </other_fields>
    <part_id>1</part_id>
    <part_views>30</part_views>
    <price>7</price>
    <price_notes>sample string 8</price_notes>
    <private_notes>sample string 14</private_notes>
    <quantity>15</quantity>
    <quantity_on_hand>16</quantity_on_hand>
    <reorderable>sample string 17</reorderable>
    <stock_number>sample string 2</stock_number>
    <wholesale_price>10</wholesale_price>
  </inventoryreport>
  <inventoryreport>
    <category_id>1</category_id>
    <category_name>sample string 1</category_name>
    <condition>sample string 6</condition>
    <cost>12</cost>
    <date_created>2025-04-03T18:06:40.2336988-06:00</date_created>
    <date_deleted>2025-04-03T18:06:40.2336988-06:00</date_deleted>
    <date_modified>2025-04-03T18:06:40.2336988-06:00</date_modified>
    <department>sample string 29</department>
    <description>sample string 13</description>
    <display_on>sample string 22</display_on>
    <display_price>true</display_price>
    <entered_by>sample string 28</entered_by>
    <images>sample string 23</images>
    <internal_price>11</internal_price>
    <labels>sample string 20</labels>
    <last_ordered_date>2025-04-03T18:06:40.2336988-06:00</last_ordered_date>
    <last_ordered_from>sample string 24</last_ordered_from>
    <last_received_date>2025-04-03T18:06:40.2336988-06:00</last_received_date>
    <last_received_from>sample string 26</last_received_from>
    <locations>sample string 21</locations>
    <lot_number>sample string 3</lot_number>
    <max_quantity>19</max_quantity>
    <min_quantity>18</min_quantity>
    <other_fields>
      <OtherField>
        <FieldName>sample string 1</FieldName>
        <FieldValue>sample string 2</FieldValue>
      </OtherField>
      <OtherField>
        <FieldName>sample string 1</FieldName>
        <FieldValue>sample string 2</FieldValue>
      </OtherField>
    </other_fields>
    <part_id>1</part_id>
    <part_views>30</part_views>
    <price>7</price>
    <price_notes>sample string 8</price_notes>
    <private_notes>sample string 14</private_notes>
    <quantity>15</quantity>
    <quantity_on_hand>16</quantity_on_hand>
    <reorderable>sample string 17</reorderable>
    <stock_number>sample string 2</stock_number>
    <wholesale_price>10</wholesale_price>
  </inventoryreport>
</ArrayOfinventoryreport>