GET api/MarketPlace/Customer/Customers
Request Information
URI Parameters
None.
Body Parameters
CustomersRequestParams| Name | Description | Type | Additional information |
|---|---|---|---|
| AuthInfo | AuthenticationInfo |
None. |
|
| CustomerID | integer |
None. |
|
| AccountNumber | string |
None. |
|
| TypeID | integer |
None. |
|
| StatusID | integer |
None. |
|
| RAClientID | globally unique identifier |
None. |
|
| IsInactive | boolean |
None. |
|
| CreatedOnFrom | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"AuthInfo": {
"KeyGuid": "8b73e26a-eaf5-4bf7-bd3e-d0b57c6dc015",
"Token": "sample string 2"
},
"CustomerID": 1,
"AccountNumber": "sample string 1",
"TypeID": 1,
"StatusID": 1,
"RAClientID": "bcfdee38-251d-4073-893c-3289ae604ae3",
"IsInactive": true,
"CreatedOnFrom": "2025-11-04T20:54:37.093Z"
}
application/xml, text/xml
Sample:
<CustomerModel.CustomersRequestParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/appsvc.rapidappsinc.com.Areas.MarketPlace.Models">
<AccountNumber>sample string 1</AccountNumber>
<AuthInfo>
<KeyGuid>8b73e26a-eaf5-4bf7-bd3e-d0b57c6dc015</KeyGuid>
<Token>sample string 2</Token>
</AuthInfo>
<CreatedOnFrom>2025-11-04T20:54:37.0935024+00:00</CreatedOnFrom>
<CustomerID>1</CustomerID>
<IsInactive>true</IsInactive>
<RAClientID>bcfdee38-251d-4073-893c-3289ae604ae3</RAClientID>
<StatusID>1</StatusID>
<TypeID>1</TypeID>
</CustomerModel.CustomersRequestParams>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of CustomerInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerID | integer |
None. |
|
| AccountNumber | integer |
None. |
|
| UTCCreatedOn | date |
None. |
|
| CreatedByID | integer |
None. |
|
| CreatedByRefID | string |
None. |
|
| TypeID | integer |
None. |
|
| TypeName | string |
None. |
|
| CustomerName | string |
None. |
|
| PrimaryAddressID | integer |
None. |
|
| PrimaryAddressRefID | string |
None. |
|
| PrimaryAddress | string |
None. |
|
| PrimaryCity | string |
None. |
|
| PrimaryState | string |
None. |
|
| PrimaryPostalCode | string |
None. |
|
| PrimaryCountry | string |
None. |
|
| MailingAddressID | integer |
None. |
|
| MailingAddressRefID | string |
None. |
|
| MailingAddress | string |
None. |
|
| MailingCity | string |
None. |
|
| MailingState | string |
None. |
|
| MailingPostalCode | string |
None. |
|
| MailingCountry | string |
None. |
|
| BillingAddressID | integer |
None. |
|
| BillingAddressRefID | string |
None. |
|
| BillingAddress | string |
None. |
|
| BillingCity | string |
None. |
|
| BillingState | string |
None. |
|
| BillingPostalCode | string |
None. |
|
| BillingCountry | string |
None. |
|
| ShippingMethodID | integer |
None. |
|
| ShippingMethodRefID | string |
None. |
|
| ShippingMethodName | string |
None. |
|
| AdminContactID | integer |
None. |
|
| AdminContactRefID | string |
None. |
|
| AdminContactFullName | string |
None. |
|
| BillingContactID | integer |
None. |
|
| BillingContactRefID | string |
None. |
|
| BillingContactFullName | string |
None. |
|
| PrimaryContactID | integer |
None. |
|
| PrimaryContactRefID | string |
None. |
|
| PrimaryContactFullName | string |
None. |
|
| PrimaryPhoneID | integer |
None. |
|
| PrimaryPhoneRefID | string |
None. |
|
| PrimaryPhoneNumber | string |
None. |
|
| PrimaryFaxID | integer |
None. |
|
| PrimaryFaxRefID | string |
None. |
|
| PrimaryFaxNumber | string |
None. |
|
| PrimaryEmailID | integer |
None. |
|
| PrimaryEmailRefID | string |
None. |
|
| PrimaryEmailAddress | string |
None. |
|
| EmailInvoices | boolean |
None. |
|
| RAClientID | globally unique identifier |
None. |
|
| PrimaryWebsiteID | integer |
None. |
|
| PrimaryWebsiteRefID | string |
None. |
|
| PrimaryWebSiteAddress | string |
None. |
|
| SalesAgentID | integer |
None. |
|
| SalesAgentRefID | string |
None. |
|
| SalesAgentFullName | string |
None. |
|
| DiscountValue | decimal number |
None. |
|
| SalesCommissionValue | decimal number |
None. |
|
| BillingTermID | integer |
None. |
|
| BillingTermRefID | string |
None. |
|
| BillingTermName | string |
None. |
|
| SalesRegionID | integer |
None. |
|
| SalesRegionRefID | string |
None. |
|
| SalesRegionFullName | string |
None. |
|
| CreditLimit | decimal number |
None. |
|
| CurrentBalance | decimal number |
None. |
|
| IsNonTaxable | boolean |
None. |
|
| Notes | string |
None. |
|
| StatusID | integer |
None. |
|
| StatusRefID | string |
None. |
|
| StatusName | string |
None. |
|
| UTCUpdatedOn | date |
None. |
|
| UpdatedByID | integer |
None. |
|
| UpdatedByRefID | string |
None. |
|
| CustomerGUID | globally unique identifier |
None. |
|
| IsInactive | boolean |
None. |
|
| CustomRefID1 | string |
None. |
|
| CustomRefID2 | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"CustomerID": 1,
"AccountNumber": 2,
"UTCCreatedOn": "2025-11-04T20:54:37.109Z",
"CreatedByID": 4,
"CreatedByRefID": "sample string 5",
"TypeID": 6,
"TypeName": "sample string 7",
"CustomerName": "sample string 8",
"PrimaryAddressID": 9,
"PrimaryAddressRefID": "sample string 10",
"PrimaryAddress": "sample string 11",
"PrimaryCity": "sample string 12",
"PrimaryState": "sample string 13",
"PrimaryPostalCode": "sample string 14",
"PrimaryCountry": "sample string 15",
"MailingAddressID": 16,
"MailingAddressRefID": "sample string 17",
"MailingAddress": "sample string 18",
"MailingCity": "sample string 19",
"MailingState": "sample string 20",
"MailingPostalCode": "sample string 21",
"MailingCountry": "sample string 22",
"BillingAddressID": 23,
"BillingAddressRefID": "sample string 24",
"BillingAddress": "sample string 25",
"BillingCity": "sample string 26",
"BillingState": "sample string 27",
"BillingPostalCode": "sample string 28",
"BillingCountry": "sample string 29",
"ShippingMethodID": 30,
"ShippingMethodRefID": "sample string 31",
"ShippingMethodName": "sample string 32",
"AdminContactID": 33,
"AdminContactRefID": "sample string 34",
"AdminContactFullName": "sample string 35",
"BillingContactID": 36,
"BillingContactRefID": "sample string 37",
"BillingContactFullName": "sample string 38",
"PrimaryContactID": 39,
"PrimaryContactRefID": "sample string 40",
"PrimaryContactFullName": "sample string 41",
"PrimaryPhoneID": 42,
"PrimaryPhoneRefID": "sample string 43",
"PrimaryPhoneNumber": "sample string 44",
"PrimaryFaxID": 45,
"PrimaryFaxRefID": "sample string 46",
"PrimaryFaxNumber": "sample string 47",
"PrimaryEmailID": 48,
"PrimaryEmailRefID": "sample string 49",
"PrimaryEmailAddress": "sample string 50",
"EmailInvoices": true,
"RAClientID": "3e4f6c35-652f-4bba-8a73-d06cfeec4309",
"PrimaryWebsiteID": 53,
"PrimaryWebsiteRefID": "sample string 54",
"PrimaryWebSiteAddress": "sample string 55",
"SalesAgentID": 56,
"SalesAgentRefID": "sample string 57",
"SalesAgentFullName": "sample string 58",
"DiscountValue": 59.0,
"SalesCommissionValue": 60.0,
"BillingTermID": 61,
"BillingTermRefID": "sample string 62",
"BillingTermName": "sample string 63",
"SalesRegionID": 64,
"SalesRegionRefID": "sample string 65",
"SalesRegionFullName": "sample string 66",
"CreditLimit": 67.0,
"CurrentBalance": 68.0,
"IsNonTaxable": true,
"Notes": "sample string 70",
"StatusID": 71,
"StatusRefID": "sample string 72",
"StatusName": "sample string 73",
"UTCUpdatedOn": "2025-11-04T20:54:37.109Z",
"UpdatedByID": 75,
"UpdatedByRefID": "sample string 76",
"CustomerGUID": "27cf889f-7f89-4a1d-b5ae-5b62de53a5ef",
"IsInactive": true,
"CustomRefID1": "sample string 79",
"CustomRefID2": "sample string 80"
},
{
"CustomerID": 1,
"AccountNumber": 2,
"UTCCreatedOn": "2025-11-04T20:54:37.109Z",
"CreatedByID": 4,
"CreatedByRefID": "sample string 5",
"TypeID": 6,
"TypeName": "sample string 7",
"CustomerName": "sample string 8",
"PrimaryAddressID": 9,
"PrimaryAddressRefID": "sample string 10",
"PrimaryAddress": "sample string 11",
"PrimaryCity": "sample string 12",
"PrimaryState": "sample string 13",
"PrimaryPostalCode": "sample string 14",
"PrimaryCountry": "sample string 15",
"MailingAddressID": 16,
"MailingAddressRefID": "sample string 17",
"MailingAddress": "sample string 18",
"MailingCity": "sample string 19",
"MailingState": "sample string 20",
"MailingPostalCode": "sample string 21",
"MailingCountry": "sample string 22",
"BillingAddressID": 23,
"BillingAddressRefID": "sample string 24",
"BillingAddress": "sample string 25",
"BillingCity": "sample string 26",
"BillingState": "sample string 27",
"BillingPostalCode": "sample string 28",
"BillingCountry": "sample string 29",
"ShippingMethodID": 30,
"ShippingMethodRefID": "sample string 31",
"ShippingMethodName": "sample string 32",
"AdminContactID": 33,
"AdminContactRefID": "sample string 34",
"AdminContactFullName": "sample string 35",
"BillingContactID": 36,
"BillingContactRefID": "sample string 37",
"BillingContactFullName": "sample string 38",
"PrimaryContactID": 39,
"PrimaryContactRefID": "sample string 40",
"PrimaryContactFullName": "sample string 41",
"PrimaryPhoneID": 42,
"PrimaryPhoneRefID": "sample string 43",
"PrimaryPhoneNumber": "sample string 44",
"PrimaryFaxID": 45,
"PrimaryFaxRefID": "sample string 46",
"PrimaryFaxNumber": "sample string 47",
"PrimaryEmailID": 48,
"PrimaryEmailRefID": "sample string 49",
"PrimaryEmailAddress": "sample string 50",
"EmailInvoices": true,
"RAClientID": "3e4f6c35-652f-4bba-8a73-d06cfeec4309",
"PrimaryWebsiteID": 53,
"PrimaryWebsiteRefID": "sample string 54",
"PrimaryWebSiteAddress": "sample string 55",
"SalesAgentID": 56,
"SalesAgentRefID": "sample string 57",
"SalesAgentFullName": "sample string 58",
"DiscountValue": 59.0,
"SalesCommissionValue": 60.0,
"BillingTermID": 61,
"BillingTermRefID": "sample string 62",
"BillingTermName": "sample string 63",
"SalesRegionID": 64,
"SalesRegionRefID": "sample string 65",
"SalesRegionFullName": "sample string 66",
"CreditLimit": 67.0,
"CurrentBalance": 68.0,
"IsNonTaxable": true,
"Notes": "sample string 70",
"StatusID": 71,
"StatusRefID": "sample string 72",
"StatusName": "sample string 73",
"UTCUpdatedOn": "2025-11-04T20:54:37.109Z",
"UpdatedByID": 75,
"UpdatedByRefID": "sample string 76",
"CustomerGUID": "27cf889f-7f89-4a1d-b5ae-5b62de53a5ef",
"IsInactive": true,
"CustomRefID1": "sample string 79",
"CustomRefID2": "sample string 80"
}
]
application/xml, text/xml
Sample:
<ArrayOfCustomerModel.CustomerInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/appsvc.rapidappsinc.com.Areas.MarketPlace.Models">
<CustomerModel.CustomerInfo>
<AccountNumber>2</AccountNumber>
<AdminContactFullName>sample string 35</AdminContactFullName>
<AdminContactID>33</AdminContactID>
<AdminContactRefID>sample string 34</AdminContactRefID>
<BillingAddress>sample string 25</BillingAddress>
<BillingAddressID>23</BillingAddressID>
<BillingAddressRefID>sample string 24</BillingAddressRefID>
<BillingCity>sample string 26</BillingCity>
<BillingContactFullName>sample string 38</BillingContactFullName>
<BillingContactID>36</BillingContactID>
<BillingContactRefID>sample string 37</BillingContactRefID>
<BillingCountry>sample string 29</BillingCountry>
<BillingPostalCode>sample string 28</BillingPostalCode>
<BillingState>sample string 27</BillingState>
<BillingTermID>61</BillingTermID>
<BillingTermName>sample string 63</BillingTermName>
<BillingTermRefID>sample string 62</BillingTermRefID>
<CreatedByID>4</CreatedByID>
<CreatedByRefID>sample string 5</CreatedByRefID>
<CreditLimit>67</CreditLimit>
<CurrentBalance>68</CurrentBalance>
<CustomRefID1>sample string 79</CustomRefID1>
<CustomRefID2>sample string 80</CustomRefID2>
<CustomerGUID>27cf889f-7f89-4a1d-b5ae-5b62de53a5ef</CustomerGUID>
<CustomerID>1</CustomerID>
<CustomerName>sample string 8</CustomerName>
<DiscountValue>59</DiscountValue>
<EmailInvoices>true</EmailInvoices>
<IsInactive>true</IsInactive>
<IsNonTaxable>true</IsNonTaxable>
<MailingAddress>sample string 18</MailingAddress>
<MailingAddressID>16</MailingAddressID>
<MailingAddressRefID>sample string 17</MailingAddressRefID>
<MailingCity>sample string 19</MailingCity>
<MailingCountry>sample string 22</MailingCountry>
<MailingPostalCode>sample string 21</MailingPostalCode>
<MailingState>sample string 20</MailingState>
<Notes>sample string 70</Notes>
<PrimaryAddress>sample string 11</PrimaryAddress>
<PrimaryAddressID>9</PrimaryAddressID>
<PrimaryAddressRefID>sample string 10</PrimaryAddressRefID>
<PrimaryCity>sample string 12</PrimaryCity>
<PrimaryContactFullName>sample string 41</PrimaryContactFullName>
<PrimaryContactID>39</PrimaryContactID>
<PrimaryContactRefID>sample string 40</PrimaryContactRefID>
<PrimaryCountry>sample string 15</PrimaryCountry>
<PrimaryEmailAddress>sample string 50</PrimaryEmailAddress>
<PrimaryEmailID>48</PrimaryEmailID>
<PrimaryEmailRefID>sample string 49</PrimaryEmailRefID>
<PrimaryFaxID>45</PrimaryFaxID>
<PrimaryFaxNumber>sample string 47</PrimaryFaxNumber>
<PrimaryFaxRefID>sample string 46</PrimaryFaxRefID>
<PrimaryPhoneID>42</PrimaryPhoneID>
<PrimaryPhoneNumber>sample string 44</PrimaryPhoneNumber>
<PrimaryPhoneRefID>sample string 43</PrimaryPhoneRefID>
<PrimaryPostalCode>sample string 14</PrimaryPostalCode>
<PrimaryState>sample string 13</PrimaryState>
<PrimaryWebSiteAddress>sample string 55</PrimaryWebSiteAddress>
<PrimaryWebsiteID>53</PrimaryWebsiteID>
<PrimaryWebsiteRefID>sample string 54</PrimaryWebsiteRefID>
<RAClientID>3e4f6c35-652f-4bba-8a73-d06cfeec4309</RAClientID>
<SalesAgentFullName>sample string 58</SalesAgentFullName>
<SalesAgentID>56</SalesAgentID>
<SalesAgentRefID>sample string 57</SalesAgentRefID>
<SalesCommissionValue>60</SalesCommissionValue>
<SalesRegionFullName>sample string 66</SalesRegionFullName>
<SalesRegionID>64</SalesRegionID>
<SalesRegionRefID>sample string 65</SalesRegionRefID>
<ShippingMethodID>30</ShippingMethodID>
<ShippingMethodName>sample string 32</ShippingMethodName>
<ShippingMethodRefID>sample string 31</ShippingMethodRefID>
<StatusID>71</StatusID>
<StatusName>sample string 73</StatusName>
<StatusRefID>sample string 72</StatusRefID>
<TypeID>6</TypeID>
<TypeName>sample string 7</TypeName>
<UTCCreatedOn>2025-11-04T20:54:37.1091761+00:00</UTCCreatedOn>
<UTCUpdatedOn>2025-11-04T20:54:37.1091761+00:00</UTCUpdatedOn>
<UpdatedByID>75</UpdatedByID>
<UpdatedByRefID>sample string 76</UpdatedByRefID>
</CustomerModel.CustomerInfo>
<CustomerModel.CustomerInfo>
<AccountNumber>2</AccountNumber>
<AdminContactFullName>sample string 35</AdminContactFullName>
<AdminContactID>33</AdminContactID>
<AdminContactRefID>sample string 34</AdminContactRefID>
<BillingAddress>sample string 25</BillingAddress>
<BillingAddressID>23</BillingAddressID>
<BillingAddressRefID>sample string 24</BillingAddressRefID>
<BillingCity>sample string 26</BillingCity>
<BillingContactFullName>sample string 38</BillingContactFullName>
<BillingContactID>36</BillingContactID>
<BillingContactRefID>sample string 37</BillingContactRefID>
<BillingCountry>sample string 29</BillingCountry>
<BillingPostalCode>sample string 28</BillingPostalCode>
<BillingState>sample string 27</BillingState>
<BillingTermID>61</BillingTermID>
<BillingTermName>sample string 63</BillingTermName>
<BillingTermRefID>sample string 62</BillingTermRefID>
<CreatedByID>4</CreatedByID>
<CreatedByRefID>sample string 5</CreatedByRefID>
<CreditLimit>67</CreditLimit>
<CurrentBalance>68</CurrentBalance>
<CustomRefID1>sample string 79</CustomRefID1>
<CustomRefID2>sample string 80</CustomRefID2>
<CustomerGUID>27cf889f-7f89-4a1d-b5ae-5b62de53a5ef</CustomerGUID>
<CustomerID>1</CustomerID>
<CustomerName>sample string 8</CustomerName>
<DiscountValue>59</DiscountValue>
<EmailInvoices>true</EmailInvoices>
<IsInactive>true</IsInactive>
<IsNonTaxable>true</IsNonTaxable>
<MailingAddress>sample string 18</MailingAddress>
<MailingAddressID>16</MailingAddressID>
<MailingAddressRefID>sample string 17</MailingAddressRefID>
<MailingCity>sample string 19</MailingCity>
<MailingCountry>sample string 22</MailingCountry>
<MailingPostalCode>sample string 21</MailingPostalCode>
<MailingState>sample string 20</MailingState>
<Notes>sample string 70</Notes>
<PrimaryAddress>sample string 11</PrimaryAddress>
<PrimaryAddressID>9</PrimaryAddressID>
<PrimaryAddressRefID>sample string 10</PrimaryAddressRefID>
<PrimaryCity>sample string 12</PrimaryCity>
<PrimaryContactFullName>sample string 41</PrimaryContactFullName>
<PrimaryContactID>39</PrimaryContactID>
<PrimaryContactRefID>sample string 40</PrimaryContactRefID>
<PrimaryCountry>sample string 15</PrimaryCountry>
<PrimaryEmailAddress>sample string 50</PrimaryEmailAddress>
<PrimaryEmailID>48</PrimaryEmailID>
<PrimaryEmailRefID>sample string 49</PrimaryEmailRefID>
<PrimaryFaxID>45</PrimaryFaxID>
<PrimaryFaxNumber>sample string 47</PrimaryFaxNumber>
<PrimaryFaxRefID>sample string 46</PrimaryFaxRefID>
<PrimaryPhoneID>42</PrimaryPhoneID>
<PrimaryPhoneNumber>sample string 44</PrimaryPhoneNumber>
<PrimaryPhoneRefID>sample string 43</PrimaryPhoneRefID>
<PrimaryPostalCode>sample string 14</PrimaryPostalCode>
<PrimaryState>sample string 13</PrimaryState>
<PrimaryWebSiteAddress>sample string 55</PrimaryWebSiteAddress>
<PrimaryWebsiteID>53</PrimaryWebsiteID>
<PrimaryWebsiteRefID>sample string 54</PrimaryWebsiteRefID>
<RAClientID>3e4f6c35-652f-4bba-8a73-d06cfeec4309</RAClientID>
<SalesAgentFullName>sample string 58</SalesAgentFullName>
<SalesAgentID>56</SalesAgentID>
<SalesAgentRefID>sample string 57</SalesAgentRefID>
<SalesCommissionValue>60</SalesCommissionValue>
<SalesRegionFullName>sample string 66</SalesRegionFullName>
<SalesRegionID>64</SalesRegionID>
<SalesRegionRefID>sample string 65</SalesRegionRefID>
<ShippingMethodID>30</ShippingMethodID>
<ShippingMethodName>sample string 32</ShippingMethodName>
<ShippingMethodRefID>sample string 31</ShippingMethodRefID>
<StatusID>71</StatusID>
<StatusName>sample string 73</StatusName>
<StatusRefID>sample string 72</StatusRefID>
<TypeID>6</TypeID>
<TypeName>sample string 7</TypeName>
<UTCCreatedOn>2025-11-04T20:54:37.1091761+00:00</UTCCreatedOn>
<UTCUpdatedOn>2025-11-04T20:54:37.1091761+00:00</UTCUpdatedOn>
<UpdatedByID>75</UpdatedByID>
<UpdatedByRefID>sample string 76</UpdatedByRefID>
</CustomerModel.CustomerInfo>
</ArrayOfCustomerModel.CustomerInfo>