POST v1/items/search

Gets list of available items using the search filters passed in the request body

Request Information

URI Parameters

None.

Body Parameters

ItemSearchParameters
NameDescriptionTypeAdditional information
Name

string

None.

ItemNumber

Number associated with an Item. This will do a like search on item number.

string

None.

ItemTypes

Collection of integer

None.

BarcodeValue

string

None.

Active

boolean

None.

DateCreatedRange

The date and time (in company time zone) when the item was created.

DateRange

None.

LastUpdatedDateRange

The date and time (in company time zone) when the item was last updated.

DateRange

None.

PageIndex

zero-based page number

integer

None.

PageSize

Default value is 100

integer

Range: inclusive between 1 and 1000

SortExpression

Specify the field name to sort the result set by. It can be one of the fields returned by the search.

string

None.

SortOrder

Specify Sort Order. Ascending=1, Descending=2. Default value is 1 (Ascending)

integer

Range: inclusive between 1 and 2

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "itemNumber": "sample string 2",
  "itemTypes": [
    1,
    2
  ],
  "barcodeValue": "sample string 3",
  "active": true,
  "dateCreatedRange": null,
  "lastUpdatedDateRange": null,
  "pageIndex": 4,
  "pageSize": 5,
  "sortExpression": "sample string 6",
  "sortOrder": 7
}

application/xml, text/xml

Sample:
<ItemSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">4</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">5</PageSize>
  <SortExpression xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">sample string 6</SortExpression>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">7</SortOrder>
  <Active>true</Active>
  <BarcodeValue>sample string 3</BarcodeValue>
  <DateCreatedRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <ItemNumber>sample string 2</ItemNumber>
  <ItemTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ItemTypes>
  <LastUpdatedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <Name>sample string 1</Name>
</ItemSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfItemSearchResult
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Data

Collection of ItemSearchResult

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "name": "sample string 2",
      "itemNumber": "sample string 3",
      "itemType": {
        "id": 1,
        "name": "sample string 2"
      },
      "description": "sample string 4",
      "price": 5.0,
      "cost": 6.0,
      "taxable": true,
      "isShippingRequired": true,
      "shippingPrice": 9.0,
      "shippingPerc": 10.1,
      "glCategory": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "maxQuantity": 1.0,
      "active": true,
      "dateCreated": "2022-07-01T16:30:18.2856968-04:00",
      "lastUpdatedDate": "2022-07-01T16:30:18.2856968-04:00"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "itemNumber": "sample string 3",
      "itemType": {
        "id": 1,
        "name": "sample string 2"
      },
      "description": "sample string 4",
      "price": 5.0,
      "cost": 6.0,
      "taxable": true,
      "isShippingRequired": true,
      "shippingPrice": 9.0,
      "shippingPerc": 10.1,
      "glCategory": {
        "id": 1,
        "name": "sample string 2"
      },
      "inventoryLocation": {
        "id": 1,
        "name": "sample string 2"
      },
      "maxQuantity": 1.0,
      "active": true,
      "dateCreated": "2022-07-01T16:30:18.2856968-04:00",
      "lastUpdatedDate": "2022-07-01T16:30:18.2856968-04:00"
    }
  ]
}

application/xml, text/xml

Sample:
<SearchResultOfItemSearchResult9X4wrT_Pq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
    <d2p1:ItemSearchResult>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Cost>6</d2p1:Cost>
      <d2p1:DateCreated>2022-07-01T16:30:18.2856968-04:00</d2p1:DateCreated>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:GLCategory xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:GLCategory>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:InventoryLocation>
      <d2p1:IsShippingRequired>true</d2p1:IsShippingRequired>
      <d2p1:ItemNumber>sample string 3</d2p1:ItemNumber>
      <d2p1:ItemType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:ItemType>
      <d2p1:LastUpdatedDate>2022-07-01T16:30:18.2856968-04:00</d2p1:LastUpdatedDate>
      <d2p1:MaxQuantity>1</d2p1:MaxQuantity>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Price>5</d2p1:Price>
      <d2p1:ShippingPerc>10.1</d2p1:ShippingPerc>
      <d2p1:ShippingPrice>9</d2p1:ShippingPrice>
      <d2p1:Taxable>true</d2p1:Taxable>
    </d2p1:ItemSearchResult>
    <d2p1:ItemSearchResult>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Cost>6</d2p1:Cost>
      <d2p1:DateCreated>2022-07-01T16:30:18.2856968-04:00</d2p1:DateCreated>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:GLCategory xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:GLCategory>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InventoryLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:InventoryLocation>
      <d2p1:IsShippingRequired>true</d2p1:IsShippingRequired>
      <d2p1:ItemNumber>sample string 3</d2p1:ItemNumber>
      <d2p1:ItemType xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:ItemType>
      <d2p1:LastUpdatedDate>2022-07-01T16:30:18.2856968-04:00</d2p1:LastUpdatedDate>
      <d2p1:MaxQuantity>1</d2p1:MaxQuantity>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Price>5</d2p1:Price>
      <d2p1:ShippingPerc>10.1</d2p1:ShippingPerc>
      <d2p1:ShippingPrice>9</d2p1:ShippingPrice>
      <d2p1:Taxable>true</d2p1:Taxable>
    </d2p1:ItemSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfItemSearchResult9X4wrT_Pq>