跳到主要内容

其他

其他 API 返回前台需要的基础数据:电话区号、货币、国家/地区、省/州、访客所在的国家/地区、店铺已开通的货币、商品可领取的优惠券,以及主题的语言包。

获取国际电话区号列表

GET /{locale}/api/phone

获取电话相关信息数据。

请求示例

Example request using Fetch
fetch(window.SHOPLAZZA.routes.root + '/api/phone')
.then((response) => response.json())
.then((data) => {
// Do something...
});

响应

  • Array [
  • cn_namestring

    国家的中文名称。

    flagstring

    国旗图片地址。

    iso_code_2string

    ISO 3166-1 alpha-2 国家代码。

    iso_code_3string

    ISO 3166-1 alpha-3 国家代码。

    namestring

    国家的英文名称。

    phone_codestring

    国家的国际电话区号。

    phone_keystring

    由国家代码与电话区号组成的键,例如 AF_93

  • ]

获取平台支持的货币列表

GET /{locale}/api/currency

获取货币相关信息数据。

请求示例

Example request using Fetch
fetch(window.SHOPLAZZA.routes.root + '/api/currency')
.then((response) => response.json())
.then((data) => {
// Do something...
});

响应

  • Array [
  • cn_namestring

    货币的中文名称。

    codestring

    货币代码,例如 USD

    currency_idnumber

    货币 ID。

    flagstring

    国旗图片地址。

    symbol_leftstring

    显示在金额左侧的符号。

    symbol_rightstring

    显示在金额右侧的符号。

    titlestring

    按前台语言展示的货币名称。

    valuenumber
  • ]

获取国家/地区列表

GET /{locale}/api/country

获取国家/地区相关信息数据。

请求示例

Example request using Fetch
fetch(window.SHOPLAZZA.routes.root + '/api/country')
.then((response) => response.json())
.then((data) => {
// Do something...
});

响应

  • Array [
  • cn_namestring

    国家的中文名称。

    continentstring

    国家所属的大洲。

    country_idnumber

    国家 ID。

    flagstring

    国旗图片地址。

    iso_code_2string

    ISO 3166-1 alpha-2 国家代码。

    iso_code_3string

    ISO 3166-1 alpha-3 国家代码。

    namestring

    国家的英文名称。

    phone_codestring

    国家的国际电话区号。

  • ]

获取国家/地区的省/州列表

GET /{locale}/api/country/{country_code}/province

通过国家/地区代码 Alpha-2 获取省/州相关信息数据。

请求示例

Example request using Fetch
fetch(window.SHOPLAZZA.routes.root + '/api/country/CN/province')
.then((response) => response.json())
.then((data) => {
// Do something...
});

请求参数

    country_codestring

    两位国家/地区代码,例如 CN

响应

  • Array [
  • cn_namestring

    省份的中文名称。

    codestring

    省份代码。

    country_code2string

    省份所属国家的代码。

    namestring

    省份的英文名称。

    old_codestring

    省份的旧代码。

    province_idnumber

    省份 ID。

  • ]

获取访客 IP 和所属国家/地区

GET /{locale}/api/ip-info

获取访客的 IP 地址及其解析出的国家/地区。没有参数。

请求示例

Example request using Fetch
fetch(window.SHOPLAZZA.routes.root + '/api/ip-info')
.then((response) => response.json())
.then((data) => {
// Do something...
});

响应

    countrystring

    根据访客 IP 解析出的两位国家代码。

    ipstring

    访客的 IP 地址。

获取店铺已开通的货币

GET /{locale}/api/multi-currency/finance-list

获取店铺已开通的货币列表和其中的默认货币。没有参数。

请求示例

请求示例
fetch(window.SHOPLAZZA.routes.root + '/api/multi-currency/finance-list')
.then((response) => response.json())
.then((data) => {
// do something...
});

响应

示例中的列表只保留了 3 种货币。

    statenumber

    请求结果标识,success0 表示请求成功。

    msgstring

    响应返回的结果说明。

    data object

    响应数据主体。

    default_codestring

    店铺默认货币的代码。

    open_statenumber
    list object[]

    店铺已开启的货币列表。

  • Array [
  • codestring

    货币代码,例如 USD

    titlestring

    按前台语言展示的货币名称。

    namestring

    货币的英文名称。

    symbolstring

    货币符号。

    flagstring

    国旗图片地址。

    defaultnumber

    是否为默认货币,1 是,0 否。

    formatstring
    currency_symbol_posstring

    货币符号的位置,leftright

    financenumber
  • ]

获取商品可领取的优惠券

GET /{locale}/api/discount-code/coupons

获取某个商品可以领取的优惠券。

请求示例

请求示例
fetch(window.SHOPLAZZA.routes.root + '/api/discount-code/coupons?product_id=14a309ec-b966-4cf9-a9bb-33baa821fdbc')
.then((response) => response.json())
.then((data) => {
// do something...
});

请求参数

    product_idstring

    商品的 id。

响应

示例所用店铺没有可领券的活动,所以列表为空。

    dataundefined[]

    响应数据主体。

获取主题语言包

GET /{locale}/api/front/themes/languages

获取主题的语言包,也就是前台渲染用的文案翻译,按文案分组组织。

请求示例

请求示例
fetch(window.SHOPLAZZA.routes.root + '/api/front/themes/languages?catalogues=all&theme_id=1709a232-7dc7-4412-9209-be8baf14b66f')
.then((response) => response.json())
.then((data) => {
// do something...
});

请求参数

    cataloguesstring

    要返回的文案分组。传 all 返回全部分组。

    theme_idstring

    主题的 id。

响应

示例省略了大部分文案键。

    data object

    响应数据主体。

    config object

    按板块分组的前台文案翻译。

    bag object

    购物袋板块的文案翻译。

    object
    blog object

    博客板块的文案翻译。

    object
    cart object

    购物车板块的文案翻译。

    object
    languagestring

    返回内容的语言代码,例如 en-US

    msgstring

    响应返回的结果说明。

    statenumber

    请求结果标识,success0 表示请求成功。