Shop
Only the shop owner can edit this information from inside their shop admin dashboard by navigating to the "Settings" tab and selecting the "General" tab. The API doesn't let you do anything other than retrieving information about a shop.
Authenticated access scopes: com.read_shop
What you can do with Shop
The haravan API lets you do the following with the Shop resource.
- GET
https://apis.haravan.com/com/shop.json
Shop properties
address1: string
{"address1": "1 Infinite"}
The shop's street address.
city: string
{"city": "Hồ Chí Minh"}
The date and time (ISO 8601 format) when the shop was created.
city: string
{"city": "Hồ Chí Minh"}
The shop's country (by default equal to the two-letter country code).
country: string
{"country": "VN"}
The shop's country (by default equal to the two-letter country code).
country_code: string
{"country_code":"VN"}
The two-letter country code corresponding to the shop's country.
country_name: string
{"country_name": "Vietnam"}
The shop's normalized country name.
created_at: string
{"created_at": "2021-05-13T07:29:20.1Z"}
The date and time when the shop was created. The API returns this value in (ISO 8601 format).
customer_email: string
{"customer_email": "[email protected]"}
The customer's email.
currency: string
{"currency": "VND"}
The three-letter code for the currency that the shop accepts.
domain: string
{"domain":"https://shop.com"}
The shop's domain.
email: string
{"email" : "[email protected]" }
The contact email address for the shop.
google_apps_domain: string
{"google_apps_domain": null}
Feature is present when a shop has a google app domain. It will be returned as a URL. If the shop does not have this feature enabled it will default to "null.".
google_apps_login_enabled: string
{"google_apps_login_enabled":null}
Feature is present if a shop has google apps enabled. Those shops with this feature will be able to login to the google apps login. Shops without this feature enabled will default to "null".
total_cost: number
{"total_cost": 150000000000.00}
Total amount cost product of the inventory adjustment.
id: number
{"id": 690933842}
A unique numeric identifier for the shop.
latitude: string
{"latitude": "45.427408"}
Geographic coordinate specifying the north/south location of a shop.
longitude: string
{"longitude": "690933842"}
Geographic coordinate specifying the east/west location of a shop.
money_format: string
{"money_format": "đ"}
A string representing the way currency is formatted when the currency isn't specified.
money_with_currency_format: string
{"money_with_currency_format": "-n $;n $"}
A string representing the way currency is formatted when the currency is specified.
longitude: string
{"longitude": "690933842"}
Geographic coordinate specifying the east/west location of a shop.
myharavan_domain: string
{"myharavan_domain": "https:shop.myharavan.com"}
The shop's 'myharavan.com' domain.
name: string
{"name": "shop"}
The name of the shop.
plan_name: string
{"plan_name": "enterprise"}
The name of the haravan plan the shop is on.
display_plan_name: string
{"display_plan_name": "enterprise"}
The display name of the haravan plan the shop is on.
password_enabled: boolean
{"password_enabled": false}
Indicates whether the Storefront password protection is enabled.
phone: string
{"phone": null}
Geographic coordinate specifying the east/west location of a shop.
longitude: string
{"longitude": "690933842"}
The contact phone number for the shop.
primary_locale: string
{"primary_locale": "fr"}
The shop's primary locale.
province: string
{"province": "Hồ Chí Minh"}
The shop's normalized province or state name.
province_code: string
{"province_code": "HC"}
The two-letter code for the shop's province or state.
shop_owner: string
{"shop_owner": "steve"}
The username of the shop owner.
source: string
{"source": null}
The handle of the partner account that referred the merchant to Haravan, if applicable.
tax_shipping: boolean
{"tax_shipping": false}
Whether taxes are charged for shipping. Valid values: true or false.
taxes_included: string
{"taxes_included": null}
Whether applicable taxes are included in product prices. Valid values: true or null.
county_taxes: boolean
{"county_taxes": null}
The setting for whether the shop is applying taxes on a per-county basis or not (US-only). Valid values are: "true" or "null.".
timezone: string
{"timezone": "(GMT+07:00) Hanoi"}
The name of the timezone the shop is in.
timezone: number
{"zip": 7000}
The zip or postal code of the shop's address.
has_storefront: boolean
{"has_storefront": true}
Indicates whether the shop has a web-based storefront or not.
Endpoints
Retrieves a single shop.
Retrieve a single shop.
- GET
https://apis.haravan.com/com/shop.json
Details
HTTP/1.1 200 OK
{
"shop": {
"address1": "123 Nguyễn Dình Chiểu",
"city": null,
"country": "VN",
"country_code": "VN",
"country_name": "Vietnam",
"created_at": "2020-10-22T03:35:37.455Z",
"customer_email": "[email protected]",
"currency": "VND",
"domain": "https://shop-2.myharavan.com/",
"email": "[email protected]",
"google_apps_domain": null,
"google_apps_login_enabled": null,
"id": 200000244883,
"latitude": 0.0,
"longitude": 0.0,
"money_format": "₫",
"money_with_currency_format": "-n $;n $",
"myharavan_domain": "https://shop-2.myharavan.com",
"name": "shop-2",
"plan_name": null,
"display_plan_name": null,
"password_enabled": true,
"phone": "0332456789",
"province": "Hồ Chí Minh",
"province_code": "HC",
"public": null,
"shop_owner": "shop-2",
"source": null,
"tax_shipping": false,
"taxes_included": null,
"county_taxes": null,
"timezone": "(GMT+07:00) Hanoi",
"zip": "700000",
"has_storefront": false,
"shop_plan_id": -1,
"inventory_method": "default",
"fullname_checkout_behavior": "optional",
"email_checkout_behavior": "optional",
"phone_checkout_behavior": "required",
"address_checkout_behavior": "optional",
"district_checkout_behavior": "optional",
"ward_checkout_behavior": "disabled",
"primary_locale": ""
}
}