POST api/Customer/GetCustomersForGrid

Request Information

URI Parameters

None.

Body Parameters

CustomerGridRequestData
NameDescriptionTypeAdditional information
GroupId

string

None.

SegmentId

string

None.

RepId

string

None.

IncludeOnlyCustomersWithPendingUsers

boolean

None.

City

string

None.

State

string

None.

Zip

string

None.

Category

string

None.

SearchTerm

string

None.

NoSalesActive

boolean

None.

NoSalesDays

integer

None.

ActiveLastActive

boolean

None.

ActiveLastMonths

integer

None.

NewCustomersActive

boolean

None.

InventoryOnly

boolean

None.

PaginatedGridData

StandardPaginatedGridData

None.

Request Formats

application/json, text/json

Sample:
{
  "GroupId": "sample string 1",
  "SegmentId": "sample string 2",
  "RepId": "sample string 3",
  "IncludeOnlyCustomersWithPendingUsers": true,
  "City": "sample string 5",
  "State": "sample string 6",
  "Zip": "sample string 7",
  "Category": "sample string 8",
  "SearchTerm": "sample string 9",
  "NoSalesActive": true,
  "NoSalesDays": 11,
  "ActiveLastActive": true,
  "ActiveLastMonths": 13,
  "NewCustomersActive": true,
  "InventoryOnly": true,
  "PaginatedGridData": {
    "PageSize": 1,
    "CurrentPage": 2,
    "SortColumn": "sample string 3",
    "SortDirection": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<CustomerGridRequestData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <ActiveLastActive>true</ActiveLastActive>
  <ActiveLastMonths>13</ActiveLastMonths>
  <Category>sample string 8</Category>
  <City>sample string 5</City>
  <GroupId>sample string 1</GroupId>
  <IncludeOnlyCustomersWithPendingUsers>true</IncludeOnlyCustomersWithPendingUsers>
  <InventoryOnly>true</InventoryOnly>
  <NewCustomersActive>true</NewCustomersActive>
  <NoSalesActive>true</NoSalesActive>
  <NoSalesDays>11</NoSalesDays>
  <PaginatedGridData>
    <CurrentPage>2</CurrentPage>
    <PageSize>1</PageSize>
    <SortColumn>sample string 3</SortColumn>
    <SortDirection>sample string 4</SortDirection>
  </PaginatedGridData>
  <RepId>sample string 3</RepId>
  <SearchTerm>sample string 9</SearchTerm>
  <SegmentId>sample string 2</SegmentId>
  <State>sample string 6</State>
  <Zip>sample string 7</Zip>
</CustomerGridRequestData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Customers
NameDescriptionTypeAdditional information
CustId

string

None.

Customer

string

None.

RepId

string

None.

RecType

string

None.

DefaultLocation

boolean

None.

PORequired

boolean

None.

Partnership

string

None.

State

string

None.

BTADRSCode

string

None.

STADRSCode

string

None.

EOPRewardsEmailAddress

string

None.

BillandHoldAgreementEmailAddress

string

None.

LOCNCODE

string

None.

Prospect

boolean

None.

PendingUserCount

integer

None.

TotalUserCount

integer

None.

ShipToCode

string

None.

ShipToAddress1

string

None.

ShipToCity

string

None.

ShipToState

string

None.

ShipToZip

string

None.

AccountOpenedDate

date

None.

LastOrderDate

date

None.

PendingFlagCount

integer

None.

NoSalesFlagCount

integer

None.

ActiveFlagCount

integer

None.

NewCustomersFlagCount

integer

None.

TotalRowCount

integer

None.

TotalPageCount

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CustId": "sample string 1",
    "Customer": "sample string 2",
    "RepId": "sample string 3",
    "RecType": "sample string 4",
    "DefaultLocation": true,
    "PORequired": true,
    "Partnership": "sample string 7",
    "State": "sample string 8",
    "BTADRSCode": "sample string 9",
    "STADRSCode": "sample string 10",
    "EOPRewardsEmailAddress": "sample string 11",
    "BillandHoldAgreementEmailAddress": "sample string 12",
    "LOCNCODE": "sample string 13",
    "Prospect": true,
    "PendingUserCount": 15,
    "TotalUserCount": 16,
    "ShipToCode": "sample string 17",
    "ShipToAddress1": "sample string 18",
    "ShipToCity": "sample string 19",
    "ShipToState": "sample string 20",
    "ShipToZip": "sample string 21",
    "AccountOpenedDate": "2026-11-21T14:52:50.8425643+00:00",
    "LastOrderDate": "2026-11-21T14:52:50.8425643+00:00",
    "PendingFlagCount": 22,
    "NoSalesFlagCount": 23,
    "ActiveFlagCount": 24,
    "NewCustomersFlagCount": 25,
    "TotalRowCount": 26,
    "TotalPageCount": 27
  },
  {
    "CustId": "sample string 1",
    "Customer": "sample string 2",
    "RepId": "sample string 3",
    "RecType": "sample string 4",
    "DefaultLocation": true,
    "PORequired": true,
    "Partnership": "sample string 7",
    "State": "sample string 8",
    "BTADRSCode": "sample string 9",
    "STADRSCode": "sample string 10",
    "EOPRewardsEmailAddress": "sample string 11",
    "BillandHoldAgreementEmailAddress": "sample string 12",
    "LOCNCODE": "sample string 13",
    "Prospect": true,
    "PendingUserCount": 15,
    "TotalUserCount": 16,
    "ShipToCode": "sample string 17",
    "ShipToAddress1": "sample string 18",
    "ShipToCity": "sample string 19",
    "ShipToState": "sample string 20",
    "ShipToZip": "sample string 21",
    "AccountOpenedDate": "2026-11-21T14:52:50.8425643+00:00",
    "LastOrderDate": "2026-11-21T14:52:50.8425643+00:00",
    "PendingFlagCount": 22,
    "NoSalesFlagCount": 23,
    "ActiveFlagCount": 24,
    "NewCustomersFlagCount": 25,
    "TotalRowCount": 26,
    "TotalPageCount": 27
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <Customers>
    <AccountOpenedDate>2026-11-21T14:52:50.8425643+00:00</AccountOpenedDate>
    <ActiveFlagCount>24</ActiveFlagCount>
    <BTADRSCode>sample string 9</BTADRSCode>
    <BillandHoldAgreementEmailAddress>sample string 12</BillandHoldAgreementEmailAddress>
    <CustId>sample string 1</CustId>
    <Customer>sample string 2</Customer>
    <DefaultLocation>true</DefaultLocation>
    <EOPRewardsEmailAddress>sample string 11</EOPRewardsEmailAddress>
    <LOCNCODE>sample string 13</LOCNCODE>
    <LastOrderDate>2026-11-21T14:52:50.8425643+00:00</LastOrderDate>
    <NewCustomersFlagCount>25</NewCustomersFlagCount>
    <NoSalesFlagCount>23</NoSalesFlagCount>
    <PORequired>true</PORequired>
    <Partnership>sample string 7</Partnership>
    <PendingFlagCount>22</PendingFlagCount>
    <PendingUserCount>15</PendingUserCount>
    <Prospect>true</Prospect>
    <RecType>sample string 4</RecType>
    <RepId>sample string 3</RepId>
    <STADRSCode>sample string 10</STADRSCode>
    <ShipToAddress1>sample string 18</ShipToAddress1>
    <ShipToCity>sample string 19</ShipToCity>
    <ShipToCode>sample string 17</ShipToCode>
    <ShipToState>sample string 20</ShipToState>
    <ShipToZip>sample string 21</ShipToZip>
    <State>sample string 8</State>
    <TotalPageCount>27</TotalPageCount>
    <TotalRowCount>26</TotalRowCount>
    <TotalUserCount>16</TotalUserCount>
  </Customers>
  <Customers>
    <AccountOpenedDate>2026-11-21T14:52:50.8425643+00:00</AccountOpenedDate>
    <ActiveFlagCount>24</ActiveFlagCount>
    <BTADRSCode>sample string 9</BTADRSCode>
    <BillandHoldAgreementEmailAddress>sample string 12</BillandHoldAgreementEmailAddress>
    <CustId>sample string 1</CustId>
    <Customer>sample string 2</Customer>
    <DefaultLocation>true</DefaultLocation>
    <EOPRewardsEmailAddress>sample string 11</EOPRewardsEmailAddress>
    <LOCNCODE>sample string 13</LOCNCODE>
    <LastOrderDate>2026-11-21T14:52:50.8425643+00:00</LastOrderDate>
    <NewCustomersFlagCount>25</NewCustomersFlagCount>
    <NoSalesFlagCount>23</NoSalesFlagCount>
    <PORequired>true</PORequired>
    <Partnership>sample string 7</Partnership>
    <PendingFlagCount>22</PendingFlagCount>
    <PendingUserCount>15</PendingUserCount>
    <Prospect>true</Prospect>
    <RecType>sample string 4</RecType>
    <RepId>sample string 3</RepId>
    <STADRSCode>sample string 10</STADRSCode>
    <ShipToAddress1>sample string 18</ShipToAddress1>
    <ShipToCity>sample string 19</ShipToCity>
    <ShipToCode>sample string 17</ShipToCode>
    <ShipToState>sample string 20</ShipToState>
    <ShipToZip>sample string 21</ShipToZip>
    <State>sample string 8</State>
    <TotalPageCount>27</TotalPageCount>
    <TotalRowCount>26</TotalRowCount>
    <TotalUserCount>16</TotalUserCount>
  </Customers>
</ArrayOfCustomers>