GET 3dCartWebAPI/v1/CustomerGroups
Get all CustomerGroups
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
limit |
Maximum number of items that can be returned |
integer |
Default value is 10 |
offset |
Starting point for the return data |
integer |
Default value is 1 |
countonly |
Count the number of rows only |
integer |
Default value is 0 |
Body Parameters
None.
Sample Request |
|
Response Information
Resource Description
Collection of CustomerGroupName | Description | Type | Additional information |
---|---|---|---|
CustomerGroupID |
Primary key. database reference = discount_groups.id |
integer |
None. |
Name |
database reference = discount_groups.GroupName |
string |
Required String length: inclusive between 0 and 150 |
Description |
database reference = discount_groups.Description |
string |
String length: inclusive between 0 and 65535 |
MinimumOrder |
database reference = discount_groups.minimumorder |
decimal number |
None. |
NonTaxable |
database reference = discount_groups.nontaxable |
boolean |
None. |
AllowRegistration |
database reference = discount_groups.allow_registration |
boolean |
None. |
DisableRewardPoints |
database reference = discount_groups.disable_reward_points |
boolean |
None. |
AutoApprove |
database reference = discount_groups.autoapprove |
boolean |
None. |
RegistrationMessage |
database reference = discount_groups.registration_message |
string |
String length: inclusive between 0 and 65535 |
PriceLevel |
database reference = discount_groups.price_level |
integer |
None. |
Response Formats
application/json, text/json
[ { "CustomerGroupID": 1, "Name": "sample string 1", "Description": "sample string 2", "MinimumOrder": 1.0, "NonTaxable": true, "AllowRegistration": true, "DisableRewardPoints": true, "AutoApprove": true, "RegistrationMessage": "sample string 3", "PriceLevel": 1 }, { "CustomerGroupID": 1, "Name": "sample string 1", "Description": "sample string 2", "MinimumOrder": 1.0, "NonTaxable": true, "AllowRegistration": true, "DisableRewardPoints": true, "AutoApprove": true, "RegistrationMessage": "sample string 3", "PriceLevel": 1 } ]
application/xml, text/xml
<ArrayOfCustomerGroup xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CustomerGroup> <CustomerGroupID>1</CustomerGroupID> <Name>sample string 1</Name> <Description>sample string 2</Description> <MinimumOrder>1</MinimumOrder> <NonTaxable>true</NonTaxable> <AllowRegistration>true</AllowRegistration> <DisableRewardPoints>true</DisableRewardPoints> <AutoApprove>true</AutoApprove> <RegistrationMessage>sample string 3</RegistrationMessage> <PriceLevel>1</PriceLevel> </CustomerGroup> <CustomerGroup> <CustomerGroupID>1</CustomerGroupID> <Name>sample string 1</Name> <Description>sample string 2</Description> <MinimumOrder>1</MinimumOrder> <NonTaxable>true</NonTaxable> <AllowRegistration>true</AllowRegistration> <DisableRewardPoints>true</DisableRewardPoints> <AutoApprove>true</AutoApprove> <RegistrationMessage>sample string 3</RegistrationMessage> <PriceLevel>1</PriceLevel> </CustomerGroup> </ArrayOfCustomerGroup>