Breeze DataServer

Items

/items? {filter}

Returns items information.

The item request returns information about the specified item.

GET

Returns information about the specified item.

Sample
Parameters
Response
Try It

→ Request

/items?filter~ItemNumber='late'

← Response

JSON
XML

[
	{
		"basestockid": "12",
		"itemcode": "late",
		"itemname": "Late Payment Fee - 5%",
		"notes": "",
		"price": 0,
		"taxcode": "GST",
		"taxrate": 0,
		"stockonhand": 0,
		"stockonorder": 0,
		"stockonhold": 0,
		"stockcommitted": 0,
		"stockonshelf": 0,
		"isactive": false,
		"minimumreorderlevel": 0,
		"defaultreorderquantity": 0,
		"primarysuppliercardid": 0,
		"primarysupplieritemcode": "",
		"customfield1": "",
		"customfield2": "",
		"customlist1": "Notes",
		"customlist2": null,
		"customlist3": null,
		"customfield6": null,
		"udf1": "",
		"udf2": "",
		"udf3": "",
		"udf4": "",
		"udf5": "0",
		"udf6": "",
		"udf7": "",
		"udf8": "",
		"buyingunitofmeasure": "",
		"buyingunit": 1,
		"sellingunitofmeasure": "",
		"sellingunit": "1",
		"isbought": false,
		"issold": true,
		"isinventoried": false,
		"isbatchtracked": false,
		"lastcost": 0,
		"averagecost": 0,
		"standardcost": 0,
		"stocklocationlist": [
			{
				"location": "GENERAL",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			},
			{
				"location": "RETAIL",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			},
			{
				"location": "RENO",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			},
			{
				"location": "COM",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			},
			{
				"location": "CC",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			},
			{
				"location": "LHS",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			},
			{
				"location": "NBC",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			},
			{
				"location": "NRA",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			},
			{
				"location": "APPLIED",
				"quantity": 1073741823,
				"brn": "~",
				"lot": 0,
				"bin": null,
				"expirydate": "2000-01-01T00:00:00"
			}
		],
		"stockattachmentlist": null,
		"exception": null
	}
]

<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfItem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <item>
    <basestockid>12</basestockid>
    <itemcode>late</itemcode>
    <itemname>Late Payment Fee - 5%</itemname>
    <notes/>
    <price>0</price>
    <taxcode>GST</taxcode>
    <taxrate>0</taxrate>
    <stockonhand>0</stockonhand>
    <stockonorder>0</stockonorder>
    <stockonhold>0</stockonhold>
    <stockcommitted>0</stockcommitted>
    <stockonshelf>0</stockonshelf>
    <isactive>false</isactive>
    <minimumreorderlevel>0</minimumreorderlevel>
    <defaultreorderquantity>0</defaultreorderquantity>
    <primarysuppliercardid>0</primarysuppliercardid>
    <primarysupplieritemcode/>
    <customfield1/>
    <customfield2/>
    <customlist1>Notes</customlist1>
    <udf1/>
    <udf2/>
    <udf3/>
    <udf4/>
    <udf5>0</udf5>
    <udf6/>
    <udf7/>
    <udf8/>
    <buyingunitofmeasure/>
    <buyingunit>1</buyingunit>
    <sellingunitofmeasure/>
    <sellingunit>1</sellingunit>
    <isbought>false</isbought>
    <issold>true</issold>
    <isinventoried>false</isinventoried>
    <isbatchtracked>false</isbatchtracked>
    <lastcost>0</lastcost>
    <averagecost>0</averagecost>
    <standardcost>0</standardcost>
    <stocklocationlist>
      <stocklocation>
        <location>GENERAL</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
      <stocklocation>
        <location>RETAIL</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
      <stocklocation>
        <location>RENO</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
      <stocklocation>
        <location>COM</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
      <stocklocation>
        <location>CC</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
      <stocklocation>
        <location>LHS</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
      <stocklocation>
        <location>NBC</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
      <stocklocation>
        <location>NRA</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
      <stocklocation>
        <location>APPLIED</location>
        <quantity>1073741823</quantity>
        <brn>~</brn>
        <lot>0</lot>
        <expirydate>2000-01-01T00:00:00</expirydate>
      </stocklocation>
    </stocklocationlist>
  </item>
</ArrayOfItem>

Param	Summary	Values
ItemNumber Type: string Style: template Required	The ItemNumber.	A valid value is the valid `ItemNumber`, that you used for the REST call.
MYOBItemID Type: integer Style: template Required	MYOBItemID	A valid value is the valid `MYOBItemID`, that you used for the REST call.
ItemName Type: string Style: template Required	Name of Item	A valid value is the valid `ItemName`, that you used for the REST call.
ItemNotes Type: string Style: template Required	Notes regarding Item	A valid value is the valid `ItemNotes`, that you used for the REST call.
BaseCost Type: integer Style: template Required	Base Cost of Item	A valid value is the valid `BaseCost`, that you used for the REST call.
BaseSell Type: integer Style: template Required	BaseSell	A valid value is the valid `BaseSell`, that you used for the REST call.
BaseSellIncTax Type: integer Style: template Required	BaseSellIncTax.	A valid value is the valid `BaseSellIncTax`, that you used for the REST call.
QtyOnHand Type: integer Style: template Required	The ItemNumber.	A valid value is the valid `ItemNumber`, that you used for the REST call.
QtyOnOrder Type: integer Style: template Required	QtyOnOrder	A valid value is the valid `QtyOnOrder`, that you used for the REST call.
MYOBQty Type: integer Style: template Required	MYOBQty	A valid value is the valid `MYOBQty`, that you used for the REST call.
CustomField1 Type: string Style: template Required	The Custom Field1.	A valid value is the valid `CustomField1`, that you used for the REST call.
CustomField2 Type: string Style: template Required	The Custom Field2.	A valid value is the valid `CustomField2`, that you used for the REST call.
CustomField3 Type: string Style: template Required	The Custom Field3	A valid value is the valid `CustomField3`, that you used for the REST call.

item	root element
Top level element

basestockid	child of item
BaseStockID of the item

itemcode	child of item
ItemCode of item

itemname	child of item
Description of Item

notes	child of item
notes regarding item

price	child of item
price of item

taxcode	child of item
tax code used for the item

taxrate	child of item
Rate of Tax for Item

stockonhand	child of item
In Hand Stock of the item

stockonorder	child of item
Stock on order of item

stockonhold	child of item
Stock On Hold

stockcommitted	child of item
Committed Stock

stockonshelf	child of item
Stock On Shelf

isactive	child of item
Whether item is active

minimumreorderlevel	child of item
Minimum Reorder Level

defaultreorderquantity	child of item
Default Reorder Quantity

primarysuppliercardid	child of item
Primary Supplier CardID

primarysupplieritemcode	child of item
Primary Supplier ItemCode

customfield1	child of item
Custom Field 1

customfield2	child of item
Custom Field 2

customlist1	child of item
Custom list 1

udf1	child of item
User Defined Field 1

udf2	child of item
User Defined Field 2

udf3	child of item
User Defined Field 3

udf4	child of item
User Defined Field 4

udf5	child of item
User Defined Field 5

udf6	child of item
User Defined Field 6

udf7	child of item
User Defined Field 7

udf8	child of item
User Defined Field 8

buyingunitofmeasure	child of item
Buying Unit of Measure

buyingunit	child of item
Buying Unit

sellingunitofmeasure	child of item
Selling Unit of Measure

sellingunit	child of item
Selling Unit

isbought	child of item
Is Bought

issold	child of item
Is Sold

isinventoried	child of item
Is Inventoried

isbatchtracked	child of item
Is Batch Tracked

lastcost	child of item
Last Cost

averagecost	child of item
Average Cost

standardcost	child of item
Standard Cost

stocklocationlist	child of item
Stock Location List

stocklocation	child of stocklocationlist
Stock Location

location	child of stocklocation
Location

quantity	child of stocklocation
Quantity

brn	child of stocklocation
BRN

lot	child of stocklocation
Lot

expirydate	child of stocklocation
Expiry Date

→ Request

/items?filter~

GET Reset