Account
This page documents the new Vitrin account functions and shows the old Zid equivalents.
window.zid.account.Get Account
zid.account.get()Update Account
zid.account.update(payload)Arguments
payload (object, required) — The customer data to update:name (string, required) — Customer's full name.email (string, required) — Customer's email address.is_newsletter_subscriber (boolean, required) — Newsletter subscription preference.gender (string | null, optional) — Customer's gender.birth_date (string | null, optional) — Customer's birth date.List Addresses
zid.account.addresses()Old:
zid.store.customer.fetchAddresses()Usage
Add Address
zid.account.addAddress(payload)Parameters
payload (object, required) — Address creation details.Payload Structure
Required Fields:
address_district (string, required) — District/neighborhood name.address_city_id (number, required) — City ID.address_country_id (number, required) — Country ID.Optional Fields:
address_type (string, optional) — Address type (defaults to "GENERAL").name (string, optional) — Address nickname/label.mobile (string, optional) — Mobile phone number.address_street (string, optional) — Street address.address_formatted (string, optional) — Formatted full address.short_address (string, optional) — Short address label.address_lat (string, optional) — Latitude coordinate.address_lng (string, optional) — Longitude coordinate.is_default (boolean, optional) — Whether this is the default address.meta (object, optional) — Additional metadata containing:city_name (string, optional) — City name.postcode (string, optional) — Postal code.building_number (string, optional) — Building number.additional_number (string, optional) — Additional/unit number.Example Payload
{
"address_district": "Downtown",
"address_city_id": 123,
"address_country_id": 456,
"address_type": "HOME",
"name": "My Home Address",
"mobile": "+1234567890",
"address_street": "123 Main Street",
"address_formatted": "123 Main Street, Downtown, City",
"short_address": "123 Main St",
"address_lat": "40.7128",
"address_lng": "-74.0060",
"is_default": true,
"meta": {
"city_name": "New York",
"postcode": "10001",
"building_number": "123",
"additional_number": "Apt 4B"
}
}Minimal Required Payload
{
"address_district": "Downtown",
"address_city_id": 123,
"address_country_id": 456
}Usage
address_district, address_city_id, and address_country_id are requiredaddress_lat and address_lng are strings, not numberspostcode, building_number, additional_number, and city_name go inside the meta objectEdit Address
zid.account.editAddress(address_id, payload)Old: (Likely
zid.store.customer.updateAddress() or similar)Parameters
address_id (number, required) — The ID of the address to update.payload (object, required) — Address update details.Payload Structure
Required Fields:
address_district (string, required) — District/neighborhood name.address_city_id (number, required) — City ID.address_country_id (number, required) — Country ID.Optional Fields:
address_type (string, optional) — Address type (defaults to "GENERAL").name (string, optional) — Address nickname/label.mobile (string, optional) — Mobile phone number.address_street (string, optional) — Street address.address_formatted (string, optional) — Formatted full address.short_address (string, optional) — Short address label.address_lat (string, optional) — Latitude coordinate.address_lng (string, optional) — Longitude coordinate.is_default (boolean, optional) — Whether this is the default address.meta (object, optional) — Additional metadata containing:city_name (string, optional) — City name.postcode (string, optional) — Postal code.building_number (string, optional) — Building number.additional_number (string, optional) — Additional/unit number.Example Payload
{
"address_district": "Downtown",
"address_city_id": 123,
"address_country_id": 456,
"address_type": "HOME",
"name": "My Home Address",
"mobile": "+1234567890",
"address_street": "123 Main Street",
"address_formatted": "123 Main Street, Downtown, City",
"short_address": "123 Main St",
"address_lat": "40.7128",
"address_lng": "-74.0060",
"is_default": true,
"meta": {
"city_name": "New York",
"postcode": "10001",
"building_number": "123",
"additional_number": "Apt 4B"
}
}Minimal Required Payload
{
"address_district": "Downtown",
"address_city_id": 123,
"address_country_id": 456
}address_district, address_city_id, and address_country_id are requiredaddress_lat and address_lng are strings, not numberspostcode, building_number, additional_number, and city_name go inside the meta objectDelete Address
zid.account.deleteAddress(address_id)Arguments
address_id (number, required) — The ID of the address to delete.Get Wishlists
zid.account.wishlists(params?)Arguments
params (object, optional) — Optional parameters:share_token (string) — Token to view a shared wishlist.page (number) — Page number for pagination.page_size (number) — Number of items per page.Add to Wishlist
zid.account.addToWishlists(payload)Arguments
payload (object, required) — { product_ids: string[] }Usage
Share Wishlist
zid.account.shareWishlist()Usage
Remove from Wishlist
zid.account.removeFromWishlist(product_id)Old:
zid.store.customer.removeFromWishlist(product_id)Arguments
product_id (string, required) — The product IDUsage
Get Orders
zid.account.orders(params?)Arguments
params (object, optional) — Optional pagination parameters:page (number) — Page number for pagination.page_size (number) — Number of orders per page.Modified at 2026-02-17 07:02:10