POST 3dCartWebAPI/v1/CustomerGroups

Adds a new customer group to the system

Request Information

URI Parameters

None.

Body Parameters

A Json or XML object containing the new customer group

Name	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.

Request Formats

application/json, text/json

Sample:

{
  "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

Sample:

<CustomerGroup xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <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>

Sample Request

PHP

Python

Ruby

Please click here to download the C# Rest API Client project from GitHub.

not yet available

Response Information

application/json, text/json

Sample:

[
  {
    "Key":"CustomerGroupID",
    "Value":"29",
    "Status":"201",
    "Message":"Created successfully",
  }
]

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.