Customer Group
A branch of the retailer's customer tree, such as Members under All Customer Groups, which prices and rules use.
Area: Customers and groups · Why it is here: guide chapter 04; recipe configure_no_code; recipe coupon_rules; recipe customer_code_check; recipe customer_owned_loyalty; recipe customers_by_store; recipe gift_card_on_spend; recipe lucky_draw; recipe payment_method_rules; recipe required_sale_details; recipe rule_guard; sample S46; sample S47; sample S48; sample S50; retail core · Fields: 10
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Customer%20Group?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Customer%20Group/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one (the required fields first), if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Customer%20Group" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"customer_group_name": …}'
Change one with PUT /api/resource/Customer%20Group/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
s5_config_pack · s18_rule_guard · s22_customer_loyalty · s25_gift_on_spend · s31_parent_groups · s32_coupon_rules · s44_lucky_draw · s46_payment_method_rules · s47_customers_by_store · s48_customer_code_check · s50_required_sale_details
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Customer Group Name | customer_group_name |
Data | yes | |||
| Parent Customer Group | parent_customer_group |
Link | Customer Group | |||
| Is Group | is_group |
Check | ||||
| Default Price List | default_price_list |
Link | Price List | |||
| Default Payment Terms Template | payment_terms |
Link | Payment Terms Template | |||
| lft | lft |
Int | yes | |||
| rgt | rgt |
Int | yes | |||
| old_parent | old_parent |
Link | yes | Customer Group | ||
| Accounts | accounts |
Table | Party Account | |||
| Credit Limit | credit_limits |
Table | Customer Credit Limit |
Table: Customer Credit Limit
The rows of credit_limits. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Company | company |
Link | Company | |||
| Credit Limit | credit_limit |
Currency | ||||
| Bypass Credit Limit Check at Sales Order | bypass_credit_limit_check |
Check |
Table: Party Account
The rows of accounts. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Company | company |
Link | yes | Company | ||
| Default Account | account |
Link | Account | |||
| Advance Account | advance_account |
Link | Account |