Add a new CustomerGroup

post https://api-sandbox-revel.revelup.com/resources/CustomerGroup/

Body Params

CustomerGroup object that needs to be added.

active

boolean

Defaults to true

CustomerGroup can be used only if active is true.

auto_apply_discounts

boolean

If active discount will be auto applied when Order is made bycustomer from this CustomerGroup.

created_by

uri

required

URI of the user that created CustomerGroup resource.

created_date

date-time

Date and time when CustomerGroup resource was created.

discounts

array of uris

List of discounts that are applicable on this CustomerGroup.

discounts

name

string

required

length ≤ 100

Defaults to Name of this CustomerGroup object.

sorting

int64

required

≥ 0

Numerical value that represents the sorting order for the resources displayed in the UI. Lower values appear higher on the list.

tax_codes

array of strings

List of URI of TaxCode API objects representing tax codes related to the product

tax_codes

tax_free

boolean

Defaults to false

If true, discounts on this CustomerGroup are not taxed.

tax_free_taxes

array of uris

Only applicable if tax_free is true. If list is empty all taxes are excluded on this CustomerGroup. If not empty, only those taxes would be excluded from this CustomerGroup.

tax_free_taxes

updated_by

integer

required

URI of the User that updated this object.

updated_date

date-time

Date and time when object was last updated.

Responses

201

Successful operation

400

Bad request

401

Authorization required

Language

Credentials


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api-sandbox-revel.revelup.com/resources/CustomerGroup/ \
3
     --header 'content-type: application/json' \
4
     --data '
5
{
6
  "active": true,
7
  "name": "Name of this CustomerGroup object.",
8
  "tax_free": false
9
}
10
'

Click Try It! to start a request and see the response here!