Search for Items

This service retrieves items applicable for inventory transfer. Items can be searched by either Item or VPN. To search the item, enter an item number, a partial item description, or a VPN in the search string.

• When the search type is ITEM, the search string can be an item number, a partial item number, an item description, or partial item description. In this case, the query returns all items which match the item description or partial description, or which match the item number entered.

• When the search type is VPN, the search string can be a VPN or partial VPN, the API should return all items with that VPN.

• The items returned are constrained by the following criteria:

  • Approved status

  • Transaction-level items

  • Inventory items

• When From Location is sent as an input, only the following items are returned:

  • With available inventory at the From Location.

  • Packs with Receive as Type as "Each" are filtered out when, from location is a virtual warehouse.

• If the System Option for Department Level Transfers is set to "Yes" (checked), and a department is sent as an input, only items associated with the input department are returned.

Example URL

Here is an example of the resource URL:

GET

/Transfer/item?itemSearchType={itemSearchType}&searchString={searchString}&dept={dept}&fromLocation={fromLocation}&pageSize={pageSize}&pageNumber={pageNumber}

Example Response

Here is an example of the response body in JSON format:

{
    ""links"": [
        {
            ""href"": ""/Transfer/item?itemSearchType=ITEM&searchString=Black&fromLocation=363640301&pageSize=1&pageNumber=3"",
            ""rel"": ""next"",
            ""type"": ""GET"",
            ""methodType"": null
        },
        {
            ""href"": ""/Transfer/item?itemSearchType=ITEM&searchString=Black&fromLocation=363640301&pageSize=1&pageNumber=1"",
            ""rel"": ""prev"",
            ""type"": ""GET"",
            ""methodType"": null
        }
    ],
    ""totalRecordCount"": 51,
    ""results"": [
        {
            ""links"": [],
            ""item"": ""100001406"",
            ""itemDesc"": ""Basic T-Shirt:Black:Extra Small"",
            ""dept"": 1102,
            ""availQty"": 100,
            ""averageCost"": 5,
            ""unitRetail"": 7.26,
            ""currencyCode"": ""USD"",
            ""standardlUnitOfMeasure"": ""EA"",
            ""suppPackSize"": 1,
            ""innerPackSize"": 1,
            ""itemImageUrl"": null,
            ""hyperMediaContent"": {
                ""linkRDO"": []
            }
        }
    ],
    ""hyperMediaContent"": {
        ""linkRDO"": [
            {
                ""href"": ""/Transfer/item?itemSearchType=ITEM&searchString=Black&fromLocation=363640301&pageSize=1&pageNumber=3"",
                ""rel"": ""next"",
                ""type"": ""GET"",
                ""methodType"": null
            },
            {
                ""href"": ""/Transfer/item?itemSearchType=ITEM&searchString=Black&fromLocation=363640301&pageSize=1&pageNumber=1"",
                ""rel"": ""prev"",
                ""type"": ""GET"",
                ""methodType"": null
            }
        ]
    }
}