POST v1/Customer/CustomerList

Request Information

URI Parameters

None.

Body Parameters

CustomerListRequest
NameDescriptionTypeAdditional information
CustomerID

integer

None.
CustomerCode

string

None.
CustomerName

string

None.
CustomerTypeID

integer

None.
EmailAddress

string

None.
Active

string

None.
UDFList

StandardUDFList

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerID": 1,
  "CustomerCode": "sample string 1",
  "CustomerName": "sample string 2",
  "CustomerTypeID": 1,
  "EmailAddress": "sample string 3",
  "Active": "sample string 4",
  "UDFList": {
    "UDF1": "sample string 21",
    "UDF2": "sample string 22",
    "UDF3": "sample string 23",
    "UDF4": "sample string 24",
    "UDF5": "sample string 25",
    "UDF6": "sample string 26",
    "UDF7": "sample string 27",
    "UDF8": "sample string 28",
    "UDF9": "sample string 29",
    "UDF10": "sample string 30",
    "UDF11": "sample string 1",
    "UDF12": "sample string 2",
    "UDF13": "sample string 3",
    "UDF14": "sample string 4",
    "UDF15": "sample string 5",
    "UDF16": "sample string 6",
    "UDF17": "sample string 7",
    "UDF18": "sample string 8",
    "UDF19": "sample string 9",
    "UDF20": "sample string 10",
    "UDF21": "sample string 11",
    "UDF22": "sample string 12",
    "UDF23": "sample string 13",
    "UDF24": "sample string 14",
    "UDF25": "sample string 15",
    "UDF26": "sample string 16",
    "UDF27": "sample string 17",
    "UDF28": "sample string 18",
    "UDF29": "sample string 19",
    "UDF30": "sample string 20"
  }
}

application/xml, text/xml

Sample: 
<CustomerListRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerID>1</CustomerID>
  <CustomerCode>sample string 1</CustomerCode>
  <CustomerName>sample string 2</CustomerName>
  <CustomerTypeID>1</CustomerTypeID>
  <EmailAddress>sample string 3</EmailAddress>
  <Active>sample string 4</Active>
  <UDFList>
    <UDF1>sample string 21</UDF1>
    <UDF2>sample string 22</UDF2>
    <UDF3>sample string 23</UDF3>
    <UDF4>sample string 24</UDF4>
    <UDF5>sample string 25</UDF5>
    <UDF6>sample string 26</UDF6>
    <UDF7>sample string 27</UDF7>
    <UDF8>sample string 28</UDF8>
    <UDF9>sample string 29</UDF9>
    <UDF10>sample string 30</UDF10>
    <UDF11>sample string 1</UDF11>
    <UDF12>sample string 2</UDF12>
    <UDF13>sample string 3</UDF13>
    <UDF14>sample string 4</UDF14>
    <UDF15>sample string 5</UDF15>
    <UDF16>sample string 6</UDF16>
    <UDF17>sample string 7</UDF17>
    <UDF18>sample string 8</UDF18>
    <UDF19>sample string 9</UDF19>
    <UDF20>sample string 10</UDF20>
    <UDF21>sample string 11</UDF21>
    <UDF22>sample string 12</UDF22>
    <UDF23>sample string 13</UDF23>
    <UDF24>sample string 14</UDF24>
    <UDF25>sample string 15</UDF25>
    <UDF26>sample string 16</UDF26>
    <UDF27>sample string 17</UDF27>
    <UDF28>sample string 18</UDF28>
    <UDF29>sample string 19</UDF29>
    <UDF30>sample string 20</UDF30>
  </UDFList>
</CustomerListRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerListRequest'.

Response Information

Resource Description

Collection of CustomerListResponse
NameDescriptionTypeAdditional information
CustomerID

integer

None.
CustomerCode

string

None.
CustomerName

string

None.
CustomerTypeID

integer

None.
EmailAddress

string

None.
Active

string

None.
ParentCustomerID

integer

None.
LicenseeID

string

None.
LicenseeName

string

None.
AccountingCode

string

None.
CustomerTypeName

string

None.
TermsCode

string

None.
SalesRepID

string

None.
SalesRepName

string

None.
CSRID

string

None.
CSRName

string

None.
EnterDate

string

None.
Taxable

string

None.
PermitNumber

string

None.
DeliveryMethodID

string

None.
DeliveryMethodName

string

None.
URL

string

None.
TaxJurisdictionID

string

None.
TaxJurisdictionName

string

None.
TaxExemptionID

string

None.
TaxExemptionName

string

None.
AccountStatusID

string

None.
AccountStatusName

string

None.
PORequired

string

None.
Notification

string

None.
NotificationText

string

None.
ShippingAddress

ShippingAddress

None.
BillingAddress

BillingAddress

None.
CustomerAddress

CustomerAddress

None.
UDFList

StandardUDFList

None.
MODProviderID

string

None.
PostageMarkupType

string

None.
PostageMarkupValue

decimal number

None.
UnpaidBalanceLimit

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CustomerID": 1,
    "CustomerCode": "sample string 2",
    "CustomerName": "sample string 3",
    "CustomerTypeID": 4,
    "EmailAddress": "sample string 5",
    "Active": "sample string 6",
    "ParentCustomerID": 7,
    "LicenseeID": "sample string 8",
    "LicenseeName": "sample string 9",
    "AccountingCode": "sample string 10",
    "CustomerTypeName": "sample string 11",
    "TermsCode": "sample string 12",
    "SalesRepID": "sample string 13",
    "SalesRepName": "sample string 14",
    "CSRID": "sample string 15",
    "CSRName": "sample string 16",
    "EnterDate": "sample string 17",
    "Taxable": "sample string 18",
    "PermitNumber": "sample string 19",
    "DeliveryMethodID": "sample string 20",
    "DeliveryMethodName": "sample string 21",
    "URL": "sample string 22",
    "TaxJurisdictionID": "sample string 23",
    "TaxJurisdictionName": "sample string 24",
    "TaxExemptionID": "sample string 25",
    "TaxExemptionName": "sample string 26",
    "AccountStatusID": "sample string 27",
    "AccountStatusName": "sample string 28",
    "PORequired": "sample string 29",
    "Notification": "sample string 30",
    "NotificationText": "sample string 31",
    "ShippingAddress": {
      "ShippingAddressName": "sample string 1",
      "ShippingAddressLine1": "sample string 2",
      "ShippingAddressLine2": "sample string 3",
      "ShippingAddressLine3": "sample string 4",
      "ShippingAddressCity": "sample string 5",
      "ShippingAddressState": "sample string 6",
      "ShippingAddressZip": "sample string 7",
      "ShippingAddressCountry": "sample string 8",
      "ShippingMethod": "sample string 9"
    },
    "BillingAddress": {
      "BillingAddressName": "sample string 1",
      "BillingAddressLine1": "sample string 2",
      "BillingAddressLine2": "sample string 3",
      "BillingAddressLine3": "sample string 4",
      "BillingAddressCity": "sample string 5",
      "BillingAddressState": "sample string 6",
      "BillingAddressZip": "sample string 7",
      "BillingAddressCountry": "sample string 8"
    },
    "CustomerAddress": {
      "CustomerAddressLine1": "sample string 1",
      "CustomerAddressLine2": "sample string 2",
      "CustomerAddressLine3": "sample string 3",
      "CustomerAddressCity": "sample string 4",
      "CustomerAddressState": "sample string 5",
      "CustomerAddressZip": "sample string 6",
      "CustomerAddressCountry": "sample string 7"
    },
    "UDFList": {
      "UDF1": "sample string 21",
      "UDF2": "sample string 22",
      "UDF3": "sample string 23",
      "UDF4": "sample string 24",
      "UDF5": "sample string 25",
      "UDF6": "sample string 26",
      "UDF7": "sample string 27",
      "UDF8": "sample string 28",
      "UDF9": "sample string 29",
      "UDF10": "sample string 30",
      "UDF11": "sample string 1",
      "UDF12": "sample string 2",
      "UDF13": "sample string 3",
      "UDF14": "sample string 4",
      "UDF15": "sample string 5",
      "UDF16": "sample string 6",
      "UDF17": "sample string 7",
      "UDF18": "sample string 8",
      "UDF19": "sample string 9",
      "UDF20": "sample string 10",
      "UDF21": "sample string 11",
      "UDF22": "sample string 12",
      "UDF23": "sample string 13",
      "UDF24": "sample string 14",
      "UDF25": "sample string 15",
      "UDF26": "sample string 16",
      "UDF27": "sample string 17",
      "UDF28": "sample string 18",
      "UDF29": "sample string 19",
      "UDF30": "sample string 20"
    },
    "MODProviderID": "sample string 32",
    "PostageMarkupType": "sample string 33",
    "PostageMarkupValue": 34.0,
    "UnpaidBalanceLimit": 1.0
  },
  {
    "CustomerID": 1,
    "CustomerCode": "sample string 2",
    "CustomerName": "sample string 3",
    "CustomerTypeID": 4,
    "EmailAddress": "sample string 5",
    "Active": "sample string 6",
    "ParentCustomerID": 7,
    "LicenseeID": "sample string 8",
    "LicenseeName": "sample string 9",
    "AccountingCode": "sample string 10",
    "CustomerTypeName": "sample string 11",
    "TermsCode": "sample string 12",
    "SalesRepID": "sample string 13",
    "SalesRepName": "sample string 14",
    "CSRID": "sample string 15",
    "CSRName": "sample string 16",
    "EnterDate": "sample string 17",
    "Taxable": "sample string 18",
    "PermitNumber": "sample string 19",
    "DeliveryMethodID": "sample string 20",
    "DeliveryMethodName": "sample string 21",
    "URL": "sample string 22",
    "TaxJurisdictionID": "sample string 23",
    "TaxJurisdictionName": "sample string 24",
    "TaxExemptionID": "sample string 25",
    "TaxExemptionName": "sample string 26",
    "AccountStatusID": "sample string 27",
    "AccountStatusName": "sample string 28",
    "PORequired": "sample string 29",
    "Notification": "sample string 30",
    "NotificationText": "sample string 31",
    "ShippingAddress": {
      "ShippingAddressName": "sample string 1",
      "ShippingAddressLine1": "sample string 2",
      "ShippingAddressLine2": "sample string 3",
      "ShippingAddressLine3": "sample string 4",
      "ShippingAddressCity": "sample string 5",
      "ShippingAddressState": "sample string 6",
      "ShippingAddressZip": "sample string 7",
      "ShippingAddressCountry": "sample string 8",
      "ShippingMethod": "sample string 9"
    },
    "BillingAddress": {
      "BillingAddressName": "sample string 1",
      "BillingAddressLine1": "sample string 2",
      "BillingAddressLine2": "sample string 3",
      "BillingAddressLine3": "sample string 4",
      "BillingAddressCity": "sample string 5",
      "BillingAddressState": "sample string 6",
      "BillingAddressZip": "sample string 7",
      "BillingAddressCountry": "sample string 8"
    },
    "CustomerAddress": {
      "CustomerAddressLine1": "sample string 1",
      "CustomerAddressLine2": "sample string 2",
      "CustomerAddressLine3": "sample string 3",
      "CustomerAddressCity": "sample string 4",
      "CustomerAddressState": "sample string 5",
      "CustomerAddressZip": "sample string 6",
      "CustomerAddressCountry": "sample string 7"
    },
    "UDFList": {
      "UDF1": "sample string 21",
      "UDF2": "sample string 22",
      "UDF3": "sample string 23",
      "UDF4": "sample string 24",
      "UDF5": "sample string 25",
      "UDF6": "sample string 26",
      "UDF7": "sample string 27",
      "UDF8": "sample string 28",
      "UDF9": "sample string 29",
      "UDF10": "sample string 30",
      "UDF11": "sample string 1",
      "UDF12": "sample string 2",
      "UDF13": "sample string 3",
      "UDF14": "sample string 4",
      "UDF15": "sample string 5",
      "UDF16": "sample string 6",
      "UDF17": "sample string 7",
      "UDF18": "sample string 8",
      "UDF19": "sample string 9",
      "UDF20": "sample string 10",
      "UDF21": "sample string 11",
      "UDF22": "sample string 12",
      "UDF23": "sample string 13",
      "UDF24": "sample string 14",
      "UDF25": "sample string 15",
      "UDF26": "sample string 16",
      "UDF27": "sample string 17",
      "UDF28": "sample string 18",
      "UDF29": "sample string 19",
      "UDF30": "sample string 20"
    },
    "MODProviderID": "sample string 32",
    "PostageMarkupType": "sample string 33",
    "PostageMarkupValue": 34.0,
    "UnpaidBalanceLimit": 1.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCustomerListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerListResponse>
    <CustomerID>1</CustomerID>
    <CustomerCode>sample string 2</CustomerCode>
    <CustomerName>sample string 3</CustomerName>
    <CustomerTypeID>4</CustomerTypeID>
    <EmailAddress>sample string 5</EmailAddress>
    <Active>sample string 6</Active>
    <ParentCustomerID>7</ParentCustomerID>
    <LicenseeID>sample string 8</LicenseeID>
    <LicenseeName>sample string 9</LicenseeName>
    <AccountingCode>sample string 10</AccountingCode>
    <CustomerTypeName>sample string 11</CustomerTypeName>
    <TermsCode>sample string 12</TermsCode>
    <SalesRepID>sample string 13</SalesRepID>
    <SalesRepName>sample string 14</SalesRepName>
    <CSRID>sample string 15</CSRID>
    <CSRName>sample string 16</CSRName>
    <EnterDate>sample string 17</EnterDate>
    <Taxable>sample string 18</Taxable>
    <PermitNumber>sample string 19</PermitNumber>
    <DeliveryMethodID>sample string 20</DeliveryMethodID>
    <DeliveryMethodName>sample string 21</DeliveryMethodName>
    <URL>sample string 22</URL>
    <TaxJurisdictionID>sample string 23</TaxJurisdictionID>
    <TaxJurisdictionName>sample string 24</TaxJurisdictionName>
    <TaxExemptionID>sample string 25</TaxExemptionID>
    <TaxExemptionName>sample string 26</TaxExemptionName>
    <AccountStatusID>sample string 27</AccountStatusID>
    <AccountStatusName>sample string 28</AccountStatusName>
    <PORequired>sample string 29</PORequired>
    <Notification>sample string 30</Notification>
    <NotificationText>sample string 31</NotificationText>
    <ShippingAddress>
      <ShippingAddressName>sample string 1</ShippingAddressName>
      <ShippingAddressLine1>sample string 2</ShippingAddressLine1>
      <ShippingAddressLine2>sample string 3</ShippingAddressLine2>
      <ShippingAddressLine3>sample string 4</ShippingAddressLine3>
      <ShippingAddressCity>sample string 5</ShippingAddressCity>
      <ShippingAddressState>sample string 6</ShippingAddressState>
      <ShippingAddressZip>sample string 7</ShippingAddressZip>
      <ShippingAddressCountry>sample string 8</ShippingAddressCountry>
      <ShippingMethod>sample string 9</ShippingMethod>
    </ShippingAddress>
    <BillingAddress>
      <BillingAddressName>sample string 1</BillingAddressName>
      <BillingAddressLine1>sample string 2</BillingAddressLine1>
      <BillingAddressLine2>sample string 3</BillingAddressLine2>
      <BillingAddressLine3>sample string 4</BillingAddressLine3>
      <BillingAddressCity>sample string 5</BillingAddressCity>
      <BillingAddressState>sample string 6</BillingAddressState>
      <BillingAddressZip>sample string 7</BillingAddressZip>
      <BillingAddressCountry>sample string 8</BillingAddressCountry>
    </BillingAddress>
    <CustomerAddress>
      <CustomerAddressLine1>sample string 1</CustomerAddressLine1>
      <CustomerAddressLine2>sample string 2</CustomerAddressLine2>
      <CustomerAddressLine3>sample string 3</CustomerAddressLine3>
      <CustomerAddressCity>sample string 4</CustomerAddressCity>
      <CustomerAddressState>sample string 5</CustomerAddressState>
      <CustomerAddressZip>sample string 6</CustomerAddressZip>
      <CustomerAddressCountry>sample string 7</CustomerAddressCountry>
    </CustomerAddress>
    <UDFList>
      <UDF1>sample string 21</UDF1>
      <UDF2>sample string 22</UDF2>
      <UDF3>sample string 23</UDF3>
      <UDF4>sample string 24</UDF4>
      <UDF5>sample string 25</UDF5>
      <UDF6>sample string 26</UDF6>
      <UDF7>sample string 27</UDF7>
      <UDF8>sample string 28</UDF8>
      <UDF9>sample string 29</UDF9>
      <UDF10>sample string 30</UDF10>
      <UDF11>sample string 1</UDF11>
      <UDF12>sample string 2</UDF12>
      <UDF13>sample string 3</UDF13>
      <UDF14>sample string 4</UDF14>
      <UDF15>sample string 5</UDF15>
      <UDF16>sample string 6</UDF16>
      <UDF17>sample string 7</UDF17>
      <UDF18>sample string 8</UDF18>
      <UDF19>sample string 9</UDF19>
      <UDF20>sample string 10</UDF20>
      <UDF21>sample string 11</UDF21>
      <UDF22>sample string 12</UDF22>
      <UDF23>sample string 13</UDF23>
      <UDF24>sample string 14</UDF24>
      <UDF25>sample string 15</UDF25>
      <UDF26>sample string 16</UDF26>
      <UDF27>sample string 17</UDF27>
      <UDF28>sample string 18</UDF28>
      <UDF29>sample string 19</UDF29>
      <UDF30>sample string 20</UDF30>
    </UDFList>
    <MODProviderID>sample string 32</MODProviderID>
    <PostageMarkupType>sample string 33</PostageMarkupType>
    <PostageMarkupValue>34</PostageMarkupValue>
    <UnpaidBalanceLimit>1</UnpaidBalanceLimit>
  </CustomerListResponse>
  <CustomerListResponse>
    <CustomerID>1</CustomerID>
    <CustomerCode>sample string 2</CustomerCode>
    <CustomerName>sample string 3</CustomerName>
    <CustomerTypeID>4</CustomerTypeID>
    <EmailAddress>sample string 5</EmailAddress>
    <Active>sample string 6</Active>
    <ParentCustomerID>7</ParentCustomerID>
    <LicenseeID>sample string 8</LicenseeID>
    <LicenseeName>sample string 9</LicenseeName>
    <AccountingCode>sample string 10</AccountingCode>
    <CustomerTypeName>sample string 11</CustomerTypeName>
    <TermsCode>sample string 12</TermsCode>
    <SalesRepID>sample string 13</SalesRepID>
    <SalesRepName>sample string 14</SalesRepName>
    <CSRID>sample string 15</CSRID>
    <CSRName>sample string 16</CSRName>
    <EnterDate>sample string 17</EnterDate>
    <Taxable>sample string 18</Taxable>
    <PermitNumber>sample string 19</PermitNumber>
    <DeliveryMethodID>sample string 20</DeliveryMethodID>
    <DeliveryMethodName>sample string 21</DeliveryMethodName>
    <URL>sample string 22</URL>
    <TaxJurisdictionID>sample string 23</TaxJurisdictionID>
    <TaxJurisdictionName>sample string 24</TaxJurisdictionName>
    <TaxExemptionID>sample string 25</TaxExemptionID>
    <TaxExemptionName>sample string 26</TaxExemptionName>
    <AccountStatusID>sample string 27</AccountStatusID>
    <AccountStatusName>sample string 28</AccountStatusName>
    <PORequired>sample string 29</PORequired>
    <Notification>sample string 30</Notification>
    <NotificationText>sample string 31</NotificationText>
    <ShippingAddress>
      <ShippingAddressName>sample string 1</ShippingAddressName>
      <ShippingAddressLine1>sample string 2</ShippingAddressLine1>
      <ShippingAddressLine2>sample string 3</ShippingAddressLine2>
      <ShippingAddressLine3>sample string 4</ShippingAddressLine3>
      <ShippingAddressCity>sample string 5</ShippingAddressCity>
      <ShippingAddressState>sample string 6</ShippingAddressState>
      <ShippingAddressZip>sample string 7</ShippingAddressZip>
      <ShippingAddressCountry>sample string 8</ShippingAddressCountry>
      <ShippingMethod>sample string 9</ShippingMethod>
    </ShippingAddress>
    <BillingAddress>
      <BillingAddressName>sample string 1</BillingAddressName>
      <BillingAddressLine1>sample string 2</BillingAddressLine1>
      <BillingAddressLine2>sample string 3</BillingAddressLine2>
      <BillingAddressLine3>sample string 4</BillingAddressLine3>
      <BillingAddressCity>sample string 5</BillingAddressCity>
      <BillingAddressState>sample string 6</BillingAddressState>
      <BillingAddressZip>sample string 7</BillingAddressZip>
      <BillingAddressCountry>sample string 8</BillingAddressCountry>
    </BillingAddress>
    <CustomerAddress>
      <CustomerAddressLine1>sample string 1</CustomerAddressLine1>
      <CustomerAddressLine2>sample string 2</CustomerAddressLine2>
      <CustomerAddressLine3>sample string 3</CustomerAddressLine3>
      <CustomerAddressCity>sample string 4</CustomerAddressCity>
      <CustomerAddressState>sample string 5</CustomerAddressState>
      <CustomerAddressZip>sample string 6</CustomerAddressZip>
      <CustomerAddressCountry>sample string 7</CustomerAddressCountry>
    </CustomerAddress>
    <UDFList>
      <UDF1>sample string 21</UDF1>
      <UDF2>sample string 22</UDF2>
      <UDF3>sample string 23</UDF3>
      <UDF4>sample string 24</UDF4>
      <UDF5>sample string 25</UDF5>
      <UDF6>sample string 26</UDF6>
      <UDF7>sample string 27</UDF7>
      <UDF8>sample string 28</UDF8>
      <UDF9>sample string 29</UDF9>
      <UDF10>sample string 30</UDF10>
      <UDF11>sample string 1</UDF11>
      <UDF12>sample string 2</UDF12>
      <UDF13>sample string 3</UDF13>
      <UDF14>sample string 4</UDF14>
      <UDF15>sample string 5</UDF15>
      <UDF16>sample string 6</UDF16>
      <UDF17>sample string 7</UDF17>
      <UDF18>sample string 8</UDF18>
      <UDF19>sample string 9</UDF19>
      <UDF20>sample string 10</UDF20>
      <UDF21>sample string 11</UDF21>
      <UDF22>sample string 12</UDF22>
      <UDF23>sample string 13</UDF23>
      <UDF24>sample string 14</UDF24>
      <UDF25>sample string 15</UDF25>
      <UDF26>sample string 16</UDF26>
      <UDF27>sample string 17</UDF27>
      <UDF28>sample string 18</UDF28>
      <UDF29>sample string 19</UDF29>
      <UDF30>sample string 20</UDF30>
    </UDFList>
    <MODProviderID>sample string 32</MODProviderID>
    <PostageMarkupType>sample string 33</PostageMarkupType>
    <PostageMarkupValue>34</PostageMarkupValue>
    <UnpaidBalanceLimit>1</UnpaidBalanceLimit>
  </CustomerListResponse>
</ArrayOfCustomerListResponse>