Customer

A person or a business the retailer sells to, with their group, contact details and loyalty.

Area: Customers and groups · Why it is here: openapi.yaml; contract fields; recipe customer_code_check; recipe customer_history_page; recipe loyalty_provider; recipe optical_prescriptions; recipe print_pack; sample S22; sample S25; sample S39; sample S42; sample S43; sample S49; sample S52; the MCP server; the request collection; retail core · Fields: 60

iVendNext's own description: Buyer of Goods and Services.

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?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/⟨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" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"customer_name": …, "customer_type": …}'

Change one with PUT /api/resource/Customer/⟨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 · s16_pick_route · s18_rule_guard · s22_customer_loyalty · s24_price_checker · s25_gift_on_spend · s28_merge_and_history · s29_print_pack · s32_coupon_rules · s33_click_and_collect · s39_pharmacy_counter · s40_expiry_recall · s41_regulated_register · s42_optical_prescriptions · s43_third_party_payer · s44_lucky_draw · s46_payment_method_rules · s47_customers_by_store · s48_customer_code_check · s49_post_sale_feedback · s50_required_sale_details · s52_phone_plans

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.

Table: Allowed To Transact With

The rows of companies. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Customer Credit Limit

The rows of credit_limits. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Party Account

The rows of accounts. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Portal User

The rows of portal_users. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Sales Team

The rows of sales_team. Each row also has idx (its place), parent, parentfield and parenttype.

All record types · What you can use

This record type in the kit