POST api/salesanalysistool/getItems

Request Information

URI Parameters

None.

Body Parameters

SATCriteria
NameDescriptionTypeAdditional information
LOCNCODE

string

None.

Segment

string

None.

ReportGroup

string

None.

RepID

string

None.

Partnership

string

None.

Customer

string

None.

Category

string

None.

Item

string

None.

Class

string

None.

Vendor

string

None.

Type

string

None.

ExcludeZZs

boolean

None.

BeginDate

date

None.

EndDate

date

None.

GroupByField

string

None.

SearchFor

string

None.

PagingStart

integer

None.

NumRecs

integer

None.

SortFieldName

string

None.

SortDirection

string

None.

UserName

string

None.

SATView

string

None.

Request Formats

application/json, text/json

Sample:
{
  "LOCNCODE": "sample string 1",
  "Segment": "sample string 2",
  "ReportGroup": "sample string 3",
  "RepID": "sample string 4",
  "Partnership": "sample string 5",
  "Customer": "sample string 6",
  "Category": "sample string 7",
  "Item": "sample string 8",
  "Class": "sample string 9",
  "Vendor": "sample string 10",
  "Type": "sample string 11",
  "ExcludeZZs": true,
  "BeginDate": "2026-11-21T14:53:41.2179879+00:00",
  "EndDate": "2026-11-21T14:53:41.2179879+00:00",
  "GroupByField": "sample string 15",
  "SearchFor": "sample string 16",
  "PagingStart": 1,
  "NumRecs": 1,
  "SortFieldName": "sample string 17",
  "SortDirection": "sample string 18",
  "UserName": "sample string 19",
  "SATView": "sample string 20"
}

application/xml, text/xml

Sample:
<SATCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <BeginDate>2026-11-21T14:53:41.2179879+00:00</BeginDate>
  <Category>sample string 7</Category>
  <Class>sample string 9</Class>
  <Customer>sample string 6</Customer>
  <EndDate>2026-11-21T14:53:41.2179879+00:00</EndDate>
  <ExcludeZZs>true</ExcludeZZs>
  <GroupByField>sample string 15</GroupByField>
  <Item>sample string 8</Item>
  <LOCNCODE>sample string 1</LOCNCODE>
  <NumRecs>1</NumRecs>
  <PagingStart>1</PagingStart>
  <Partnership>sample string 5</Partnership>
  <RepID>sample string 4</RepID>
  <ReportGroup>sample string 3</ReportGroup>
  <SATView>sample string 20</SATView>
  <SearchFor>sample string 16</SearchFor>
  <Segment>sample string 2</Segment>
  <SortDirection>sample string 18</SortDirection>
  <SortFieldName>sample string 17</SortFieldName>
  <Type>sample string 11</Type>
  <UserName>sample string 19</UserName>
  <Vendor>sample string 10</Vendor>
</SATCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DropDown
NameDescriptionTypeAdditional information
Name

string

None.

Value

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Value": "sample string 2"
  },
  {
    "Name": "sample string 1",
    "Value": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDropDown xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <DropDown>
    <Name>sample string 1</Name>
    <Value>sample string 2</Value>
  </DropDown>
  <DropDown>
    <Name>sample string 1</Name>
    <Value>sample string 2</Value>
  </DropDown>
</ArrayOfDropDown>