Haravan — Cửa hàng

Xem thông tin shop (Get shop) — haravan.get_shop

Shop name, domain, contact details, currency and timezone.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	com.read_shop

Input

Không có input.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
shop	Shop	object	The shop.
shop.id		integer	Shop id.
shop.name		string	Shop name.
shop.shop_owner		string	Username of the shop owner.
shop.email		string	Contact email of the shop.
shop.customer_email		string	Email shown to customers.
shop.phone		string | null	Contact phone number.
shop.domain		string	Shop domain, as a URL.
shop.myharavan_domain		string	The shop's myharavan.com domain, as a URL.
shop.address1		string	Street address.
shop.city		string | null	City.
shop.province		string	Province or city name.
shop.province_code		string	Province code.
shop.country		string	Country code.
shop.country_code		string	Two-letter country code.
shop.country_name		string	Country name.
shop.zip		string	Postal code.
shop.latitude		number	Latitude.
shop.longitude		number	Longitude.
shop.currency		string	Currency code, e.g. VND.
shop.money_format		string	How amounts are formatted without a currency.
shop.money_with_currency_format		string	How amounts are formatted with a currency.
shop.timezone		string	Shop timezone, e.g. (GMT+07:00) Hanoi.
shop.primary_locale		string	Primary locale.
shop.created_at		string	When the shop was created (ISO 8601).
shop.plan_name		string | null	Haravan plan name.
shop.display_plan_name		string | null	Haravan plan display name.
shop.shop_plan_id		integer	Haravan plan id.
shop.password_enabled		boolean	Whether storefront password protection is on.
shop.has_storefront		boolean	Whether the shop has a web storefront.
shop.tax_shipping		boolean	Whether shipping is taxed.
shop.taxes_included		boolean | null	Whether tax is included in prices.
shop.county_taxes		boolean | null	Whether taxes apply per county.
shop.source		string | null	Partner that referred the merchant.
shop.google_apps_domain		string | null	Google Apps domain, if set.
shop.google_apps_login_enabled		boolean | null	Whether Google Apps login is on.
shop.inventory_method		string	Inventory method of the shop.
shop.fullname_checkout_behavior		string	Full name field at checkout: required, optional or disabled.
shop.email_checkout_behavior		string	Email field at checkout: required, optional or disabled.
shop.phone_checkout_behavior		string	Phone field at checkout: required, optional or disabled.
shop.address_checkout_behavior		string	Address field at checkout: required, optional or disabled.
shop.district_checkout_behavior		string	District or ward field at checkout: required, optional or disabled.
shop.ward_checkout_behavior		string	Ward field at checkout: required, optional or disabled.

Danh sách chi nhánh, kho (List locations) — haravan.list_locations

Stores and warehouses of the shop, with their ids.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	com.read_shop

Input

Không có input.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
locations	Chi nhánh, kho	array of object	Stores and warehouses.
locations[].id		integer	Location id.
locations[].name		string	Location name.
locations[].type		string | null	default for the main warehouse, ontheroad for transit.
locations[].location_type		string | null	Same as type; null on some shops.
locations[].is_primary		boolean	True for the primary location.
locations[].is_unavailable_quantity		boolean	True when stock here is not sellable.
locations[].email		string | null	Contact email.
locations[].phone		string | null	Phone number.
locations[].address1		string | null	Street address.
locations[].address2		string | null	Second address line.
locations[].zip		string | null	Postal code.
locations[].city		string | null	City.
locations[].province		string | null	Province or city name.
locations[].province_code		string | null	Province code.
locations[].district		string | null	Ward name (two-level model).
locations[].district_code		string | null	Ward code (two-level model).
locations[].ward		string | null	Ward name (three-level model).
locations[].ward_code		string | null	Ward code (three-level model).
locations[].country		string | null	Country.
locations[].country_name		string | null	Country name.
locations[].country_code		string | null	Two-letter country code.
locations[].created_at		string	When it was created (ISO 8601).
locations[].updated_at		string	When it was last updated (ISO 8601).

Danh sách nhân viên (List staff) — haravan.list_staff

Staff accounts of the shop, with their ids.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	com.read_shop

Input

Không có input.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
users	Nhân viên	array of object	Staff accounts.
users[].id		integer	Staff account id.
users[].first_name		string	First name.
users[].last_name		string	Last name.
users[].email		string	Email.
users[].phone		string | null	Phone number.
users[].im		string | null	Instant-messaging address.
users[].bio		string | null	Self-written description.
users[].url		string | null	Personal URL.
users[].account_owner		boolean	True for the owner of the shop account.
users[].user_type		string	Kind of account, e.g. invited.
users[].receive_announcements		integer	1 when the user gets announcements.
users[].permissions		array of string	Permissions: full or limited, with the areas a limited user can reach (orders, products, customers...).

Nhật ký hoạt động shop (List shop activity) — haravan.list_activity_events

Recent activity across the shop, e.g. created or deleted products and orders.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	com.read_shop

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
filter	Loại đối tượng	string	không	Resource type, e.g. Product or Order.
verb	Hành động	string	không	Action, e.g. create, update, destroy.
since_id	Sau mã sự kiện	integer	không	Only events after this id. Min 1.
page	Trang	integer	không	Page number, from 1. Min 1.
limit	Số kết quả mỗi trang	integer	không	Items per page (1-50, default 50). Min 1. Max 50.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
events	Sự kiện	array of object	Recent activity of the shop.
events[].id		integer	Event id.
events[].subject_id		integer	Id of the resource that produced the event.
events[].subject_type		string	Type of that resource: Article, Blog, Collection, Comment, Order, Page or Product.
events[].verb		string	What happened, e.g. create, update, destroy or confirmed.
events[].message		string	Human-readable text of the event; may contain HTML links.
events[].description		string | null	Plain-text description.
events[].body		string | null	Extra text about the event.
events[].arguments		array of string	Values the message was built from.
events[].author		string	Who caused the event.
events[].path		string | null	Relative admin URL of the resource.
events[].created_at		string	When it happened (ISO 8601).

Danh sách tỉnh/thành (List Vietnam provinces) — haravan.list_provinces

Vietnam provinces and cities with their codes, for addresses.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	com.read_shop

Input

Không có input.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
provinces	Tỉnh/thành	array of object	Provinces and cities of Vietnam.
provinces[].id		integer	Province id; use as province_id.
provinces[].code		string	Province code; use as province_code in an address.
provinces[].name		string	Province or city name.
provinces[].country_id		integer	Country id, 704 for Vietnam.
provinces[].tax		number | null	Sales tax rate.
provinces[].tax_name		string | null	Tax name.
provinces[].tax_type		string | null	Tax type.
provinces[].tax_percentage		string | null	Tax in percent format.

Danh sách phường/xã (List wards of a province) — haravan.list_wards

Wards of a province (two-level model since 2025). Put the ward code in district_code of an address.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	com.read_shop

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
province_id	Tỉnh/thành	integer	có	Province id from list_provinces. Min 1.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
districts	Phường/xã	array of object	Wards of the province.
districts[].id		integer	Ward id.
districts[].code		string	Ward code; use as district_code in an address.
districts[].name		string	Ward name.
districts[].province_id		integer	Province the ward belongs to.