Candbox前端模板数据手册

规范
首页数据

首页目录
首页产品
首页评价
首页展示

数据AJAX查询帮助
产品数据

产品细节数据

产品添加到购物车
定制菜单数据
展示数据

展示分类

购物车数据
搜索数据

Candbox软件模版设计

本文为Candbox购物车官方文档. 随时会保持更新或变更细节. 为保障用户权益, 禁止第三方网站全文引用. 转载须注明原文出处.

本文档以在线方式提供给用户. 仅适用于Candbox购物车软件使用参考用途.

责任声明: 文档中所描述的使用方法或涉及第三方软件不兼容问题或由第三方软件潜在技术问题,版权及其他问题.Candbox购物车不负任何责任.

特别提示: 文档中尽可能详尽地描述电商网络应用中关联的基础技术以帮助入门用户作额外参考,用户仍可基于互联网搜索查询相关问题获得更多帮助.

由于Candbox购物车是基于N年外贸+电商经验而开发, 文档中会含有技术和外贸业务相关的描述. 所描述观点或见解也仅供参考.

文档所述用语词法及第三方引用内容仅作参考.

数据规范

Candbox购物车设计的每个部分及细节均完全基于用户及数据安全为主. Candbox购物车的接口数据格式和命名以自有规范风格向开发者或用户提供服务.

Candbox购物车接口数据格式和命名在版本升级和兼容方面能保持一致.

首页数据

网站首页面包含四组数据,分别为首页目录数据,首页产品数据,首页评论数据,首页展示数据

首页目录数据

首页目录数据变量名为: showcatg,数据类型为: 数组,参考例子数据如下:

[{
"cid":"1",
"cname":"Integrated Circuits - ICs",
"cpath":"integrated-circuits-ics",
"cimg":"qyem.jpg",
"sorts":"2"
},
{
"cid":"3",
"cname":"Sensors",
"cpath":"sensors",
"cimg":"m3lm.jpg",
"sorts":"2"
},
{
"cid":"6",
"cname":"Memory ICs",
"cpath":"memory-ics",
"cimg":"21xm.jpg",
"sorts":"0"
},
{
"cid":"13",
"cname":"Display Devices",
"cpath":"display-devices",
"cimg":"mn32.jpg",
"sorts":"11"
}]

变量名称解释:

cid:目录编号, 仅用于参考. 类型为:字符串

cname:目录名称内容, 类型为:字符串

cpath:目录路径, 类型为:字符串

cimg:目录图片内容. 类型为:字符串

sorts:目录排序id, 仅用于参考. 类型为:整数

使用提示

多语言环境时,变量名cname会显示不同语言的目录名称内容

目录图片保存在网站根目录的模板资源目录下的catg目录中.

首页产品数据

首页产品数据变量名为: showcase,数据类型为: 数组, 参考例子数据如下:

[
{
"cid":"23",
"pid":"38100",
"sku":"15932",
"sname":"390K 0 Resistor,100E,SMD ",
"pn":"3yvMNp2RLFjsd5",
"opt":"8",
"price":[0.04,0.11],
"pimg":"14kwt/191115/abcde2370.jpg",
"simg":"14kwt/191115/abcde0710.jpg",
"sorts":"0"
},
{
"cid":"160",
"pid":"42659",
"sku":"12604",
"sname":"CONN 0.010 Receptacle, ",
"pn":"fmSS0AH81vcs6xE",
"opt":"8",
"price":[1.21,3.62],
"pimg":"14kwt/191115/abcde1130.jpg",
"simg":"14kwt/191115/abcde2210.jpg",
"sorts":"0"
},
{
"cid":"273",
"pid":"50053",
"sku":"60162",
"sname":"Color Red Copper DC5V2 Red 12mm",
"pn":"SDDFSDFS",
"opt":"3",
"price":["2.25","2.59"],
"pimg":"14kwt/191115/abcde0080.jpg",
"simg":"14kwt/191118/4h6u54g31.jpg",
"sorts":"0"
}
]

变量名称解释:

cid:目录编号, 仅用于参考. 类型为:字符串

pid:产品编号, 类型为:字符串

sku:SKU编号, 类型为:字符串

sname:SKU标题. 类型为:字符串

pn:SKU型号, 类型为:字符串

opt:该产品对应的SKU组合数量, 类型为:字符串

price:SKU价格. 分别为最低价格和最高价. 错误价格值为0, 推荐在前端用js解析后显示. 类型为:字符串

pimg:产品图片. 类型为:字符串

simg:SKU图片. 类型为:字符串

sorts:产品排序. 类型为:字符串

使用提示

变量名pimg和simg的值包含有原始图和缩略图信息.判断规则为:图片名称末位为数字0表示该图片为缩略图片名称.为1表示原始图片(即不含缩略图)名称. 可在前端用js修改图片名称末位数字0为1,然后再加载修改后的图片名称即为原始图片尺寸.

首页评价数据

首页产品数据变量名为: backfeed,数据类型为: 对象, 参考例子数据如下:

{
 "21":{
 "bfid":"21",
 "mkdt":1576264574,
 "icon":"1F497",
 "nickname":"Anonymous",
 "iso":"xx",
 "comments":"thanks you i love my good"
 },
 "5":{
 "bfid":"5",
 "mkdt":1576263694,
 "icon":"1F4AC",
 "nickname":"Julia",
 "iso":"au",
 "comments":"thanks you very much let go"
 },
 "2":{
 "bfid":"2",
 "mkdt":1575652792,
 "icon":"1F30A",
 "nickname":"wang",
 "iso":"jp",
 "comments":"this is candbox shopping cart home page comment"
 }
}

变量名称解释:

bfid:评论内容编号, 也是数据排序key. 仅用于参考. 类型为:字符串

mkdt:评论调用时间,注:此时间是创建首页评论时的创建时间. 按需格式化后显示. 类型为:整数

icon:用户icon图标内容, 未创建icon则为内置值.类型为:字符串

nickname:用户昵称. 未创建或错误时为Anonymous,类型为:字符串

iso:用户ISO, 未创建或错误时为xx. 类型为:字符串

comments:评论内容. 类型为:字符串

使用提示

评论内容可根据模板布局需要而显示或不显示部分内容. iso字段可结合前端css图标库显示国旗.

首页展示数据

展示数据变量名为: promo,类型为: 对象, 参考例子数据如下:

{
"poid":"2",
"title":"start your business store",
"links":"online-payment-manual-html",
"img":"7gwzi/200320/5r80r29r1.png",
"grp":8
},
{
"poid":"19",
"title":"The World's #1 Shopping Cart",
"links":"about-html",
"img":"7gwzi/200401/gzgvq6i31.png",
"grp":1
}

变量名称解释:

poid:内容编号, 仅用于参考. 类型为:字符串

links:文字内容, 无数据值时为0. 类型为:字符串

links:内页链接内容, 无数据值时为0. 仅支持网站内页链接.不支持http开头的链接.类型为:字符串

img:图片内容. 无数据值时为0. 类型为:字符串

grp:分组编号, 值范围为:0~9. 类型为:整数

目录数据数据

...

全目录数据

全目录数据变量名为: catalog,类型为: 数组, 参考例子数据如下:

{
 "272":{
 "cid":"272",
 "pid":"0",
 "mods":"0",
 "cpath":"clothes",
 "cimg":"c5ur.jpg",
 "pnum":"0",
 "cname":"Clothes",
 "ckey":"clothes,man",
 "cdesc":"New clothes 2020",
 "sorts":"0",
  "sub":{
   "156":{
   "cid":"156",
   "pid":"272",
   "mods":"0",
   "cpath":"shirts",
   "cimg":"cg55.jpg",
   "pnum":"5",
   "cname":"Shirts",
   "ckey":"0",
   "cdesc":"Shirts",
   "sorts":"0"
   },
   "151":{
   "cid":"151",
   "pid":"272",
   "mods":"0",
   "cpath":"t-shirt",
   "cimg":"c4kw.jpg",
   "pnum":"9",
   "cname":"T-shirt",
   "ckey":"0ddgffgd",
   "cdesc":"T-shirt",
   "sorts":"0"
   }
  }
 }
}

变量名称解释:

cid:主目录编号, 也是数据Key值. 类型为:字符串

pid:子目录编号, 为0时表示一级目录, 类型为:字符串

mods:目录模板编号, 值为0-9. 可根据该值设置目录内容排列布局或其他需求. 类型为:字符串

cpath:目录显示路径. 类型为:字符串

cimg:目录图片. 类型为:字符串

pnum:该目录下的产品数量, 仅参考用途. 注: 是产品数量而不是SKU数量. 类型为:字符串

cname:目录名称, 类型为:字符串

ckey:目录关键字. 类型为:字符串

cdesc:目录描述, 类型为:字符串

sorts:目录排序编号, 仅参考用途. 默认已排序. 类型为:字符串

sub:子目录key, 需判断sub是否存在. 默认已排序. 类型为:字符串

导航目录数据

导航目录数据变量名为:topnav,类型为: 数组, 参考例子数据如下:

导航目录数据与全目录数据的内容结构是完全相同. 使用可直接参考全目录数据.

导航目录数据是需要先在后端设置的一级目录，且最多可显示10组。对应的子目录数量无限制。

全局提示

变量topnav为全局变量, 即所有前端页面都可调用. 可在配置文件中的list组,设置topnav = false进行关闭. 关闭后该变量值为空.

子目录列表数据

子目录列表数据包含三组数据, 分别为:导航栏数据,子目录列表数据,展示数据,以下将分别说明.

导航栏数据

导航栏数据变量名称为navbar, 类型为: 数组, 参考例子数据如下:

{
"a":"clothes",
"b":"Clothes"
}

变量名称解释:

a:主目录路径, 类型为:字符串

b:主目录名称, 类型为:字符串

使用提示

多语言环境时,变量名b会显示不同语言的目录名称内容.

子目录列表数据

子目录列表数据变量名称为:subcatg, 类型为: 数组, 参考例子数据如下:

{
 "272":{
 "cid":"272",
 "pid":"0",
 "mods":"0",
 "cpath":"clothes",
 "cimg":"c5ur.jpg",
 "pnum":"0",
 "cname":"Clothes",
 "ckey":"clothes,man",
 "cdesc":"New clothes 2020",
 "sorts":"0",
  "sub":{
   "156":{
   "cid":"156",
   "pid":"272",
   "mods":"0",
   "cpath":"shirts",
   "cimg":"cg55.jpg",
   "pnum":"5",
   "cname":"Shirts",
   "ckey":"0",
   "cdesc":"Shirts",
   "sorts":"0"
   },
   "151":{
   "cid":"151",
   "pid":"272",
   "mods":"0",
   "cpath":"t-shirt",
   "cimg":"c4kw.jpg",
   "pnum":"9",
   "cname":"T-shirt",
   "ckey":"0ddgffgd",
   "cdesc":"T-shirt",
   "sorts":"0"
   }
  }
 }
}

变量名称解释:

cid:主目录编号, 类型为:字符串

pid:子目录编号, 为0时表示一级目录, 类型为:字符串

mods:子目录模版编号, 值为0-9. 类型为:字符串

cpath:目录显示路径. 类型为:字符串

cimg:目录图片. 类型为:字符串

pnum:该目录下的产品数量, 仅参考用途. 注: 是产品数量而不是SKU数量. 类型为:字符串

cname:目录名称, 类型为:字符串

ckey:目录关键字. 类型为:字符串

cdesc:目录描述, 类型为:字符串

sorts:目录排序编号, 仅参考用途. 默认已排序. 类型为:字符串

sub:子目录key, 需判断sub是否存在. 默认已排序. 类型为:字符串

使用提示

多语言环境时,变量名cname,ckey,cdesc会显示不同名称或内容. 子目录列表数据的数据结构与全目录数据完全相同.

展示数据

展示数据变量名为:promo,类型为: 对象, 参考例子数据如下:

{
"poid":"2",
"title":"start your business store",
"links":"online-payment-manual-html",
"img":"7gwzi/200320/5r80r29r1.png",
"grp":8
},
{
"poid":"19",
"title":"The World's #1 Shopping Cart",
"links":"about-html",
"img":"7gwzi/200401/gzgvq6i31.png",
"grp":1
}

与首页数据栏的首页展示的内容结构是完全相同. 使用可直接参考首页展示.

子目录产品列表数据

子目录产品列表数据包含四组数据, 分别为:导航栏数据,子目录列表数据,子目录产品列表数据,展示数据以下将分别说明.

导航栏数据

导航栏数据变量名称为navbar, 类型为: 数组, 参考例子数据如下:

{
"a":"clothes",
"b":"Clothes",
"c":"275",
"d":"t-shirts",
"e":"2020-T-Shirts",
"f":0
}

变量名称解释:

a:主目录路径, 类型为:字符串

b:主目录名称, 类型为:字符串

c:子目录编号, 类型为:字符串

d:子目录路径, 类型为:字符串

e:子目录名称, 类型为:字符串

f:模版编号值, 值为: 0 - 9 类型为:整数

使用提示

多语言环境时,变量名b,e会显示不同语言的目录名称. 可根据f的值在模板中调整布局.

子目录列表数据

子目录列表数据变量名称为:subcatg, 类型为: 数组, 参考例子数据如下:

{
"cid":"272",
"pid":"0",
"mods":"0",
"cpath":"clothes",
"cimg":"c5ur.jpg",
"pnum":"0",
"cname":"Clothes",
"ckey":"0ddd",
"cdesc":"aaaaa",
"sorts":"0",
 "sub":{
  "275":{
  "cid":"275",
  "pid":"272",
  "mods":"0",
  "cpath":"shirts",
  "cimg":"cg55.jpg",
  "pnum":"5",
  "cname":"Shirts",
  "ckey":"0",
  "cdesc":"Shirts",
  "sorts":"0"
  },
  "273":{
  "cid":"273",
  "pid":"272",
  "mods":"0",
  "cpath":"t-shirt",
  "cimg":"c4kw.jpg",
  "pnum":"9",
  "cname":"T-shirt",
  "ckey":"0ddgffgd",
  "cdesc":"T-shirt",
  "sorts":"0"
  }
 }
}

变量名称解释:

cid:主目录编号, 类型为:字符串

pid:子目录编号, 为0时表示一级目录, 类型为:字符串

mods:目录展示模式值, 值为0,1. 可根据该值设置目录内容排列布局或其他需求. 类型为:字符串

cpath:目录显示路径. 类型为:字符串

cimg:目录图片. 类型为:字符串

pnum:该目录下的产品数量, 仅参考用途. 注: 是产品数量而不是SKU数量. 类型为:字符串

cname:目录名称, 类型为:字符串

ckey:目录关键字. 类型为:字符串

cdesc:目录描述, 类型为:字符串

sorts:目录排序编号, 仅参考用途. 默认已排序. 类型为:字符串

sub:子目录key, 需判断sub是否存在. 默认已排序. 类型为:字符串

使用提示

多语言环境时,变量名cname,ckey,cdesc会显示不同名称或内容. 子目录列表数据的数据结构与全目录数据完全相同.

子目录产品列表数据

子目录产品列表数据变量名称为:listdata, 类型为: 数组, 参考例子数据如下:

{
"items":[
 {
  "item":{
   "cid":"273",
   "pid":"50051",
   "sku":"60190",
   "pname":"Hello candbox this is chinglish 混合标题",
   "sname":"Color Red Copper AC 12V Yellow 10mm",
   "pn":"FDG",
   "opt":5,
   "price":"{"5":"2.00","100":"1.78","500":"1.55","5000":"1.22"}",
   "stock":"78",
   "pimg":"14kwt/191115/abcde1780.jpg",
   "simg":"14kwt/191115/abcde2430.jpg",
   "url":1,
   "min":1,
   "max":100,
   "mult":2,
  },
  "attr":
   [{
   "title":"Color",
   "val":"Yellow",
   "aimg":"adg3.jpg",
   "atk":"12",
   "atv":"225"
   },
   {
   "title":"Length",
   "val":"10mm",
   "aimg":"0",
   "atk":"17",
   "atv":"152"
   }]
 },
 {
  "item":{
   "cid":"273",
   "pid":"50053",
   "sku":"60162",
   "pname":"mmmmm dfgdfgdgd dfg dfg df",
   "sname":"Color Red Copper DC5V2 Red 12mm",
   "pn":"SDDFSDFS",
   "opt":3,
   "price":"{"1":"2.59","5":"2.25"}",
   "stock":"56",
   "pimg":"14kwt/191115/abcde0080.jpg",
   "simg":"14kwt/191118/4h6u54g31.jpg",
   "url":1,
   "min":2,
   "max":100,
   "mult":5,
  },
  "attr":
  [{
   "title":"Color",
   "val":"Red",
   "aimg":"0",
   "atk":"11",
   "atv":"155"
   },
   {
   "title":"Length",
   "val":"12mm",
   "aimg":"0",
   "atk":"13",
   "atv":"128"
   }]
 },
 {
  "item":{
  "cid":"273",
  "pid":"50056",
  "sku":"60068",
  "pname":"笔记本充电器",
  "sname":"X牌电脑充电器,12V/5A USB-C,黑色,1米,袋装",
  "pn":"CVBDFG-FGD",
  "opt":5,
  "price":"{"1":"87.00","100":"69.00"}",
  "stock":"778",
  "pimg":"14kwt/191115/abcde0800.jpg",
  "simg":"14kwt/191115/abcde2480.jpg",
  "url":1,
  "min":1,
  "max":100,
  "mult":2
  },
  "attr":
  [{
  "title":"Lenght",
  "val":"1m",
  "aimg":"0",
  "atk":"9",
  "atv":"51"
  },
  {
  "title":"Color",
  "val":"Black",
  "aimg":"0",
  "atk":"17",
  "atv":"102"
  }]
 }
],
"first":1,
"prev":1,
"current":1,
"last":1,
"next":1,
"page":1,
"item":10,
"limit":10
}

变量名称解释:

items:内容编号, 仅用于参考. 类型为:字符串

item:items内的item,表示单组物品key. 类型为:字符串

cid:目录编号, 类型为:字符串

pid:产品编号, 类型为:字符串

sku:SKU编号. 类型为:字符串

pname:产品标题. 类型为:字符串

sname:SKU标题. 类型为:字符串

pn:SKU型号. 类型为:字符串

opt:SKU组合数. 类型为:字符串

price:SKU价格组. 需前端js解析后显示, 错误数据为0. 类型为:整数或字符串

stock:SKU库存数量. 类型为:字符串

pimg:产品图片. 类型为:字符串

simg:SKU图片. 类型为:字符串

url:附加链接标志, 值为: 0,1. 当存在正确的外部链接是url的值为1. 类型为:整数

min:最小订购数. 类型为:整数

max:最大订购数. 类型为:整数

mult:订购倍数. 类型为:整数

attr:附加属性key. 类型为:字符串

title:附加属性名称. 类型为:字符串

val:附加属性内容. 类型为:字符串

aimg:附加属性图片内容. 类型为:字符串

atk:附加属性名称编号(用于经典模式布局排版). 类型为:字符串

atv:附加属性内容编号(用于经典模式布局排版). 类型为:字符串

first:第一页数. 类型为:整数

prev:前一页数. 类型为:整数

current:当前页数. 类型为:整数

next:下一页数. 类型为:整数

last:最后一页数. 类型为:整数

item:总页数. 类型为:整数

limit:每页显示数. 类型为:整数

使用提示

当url值为1时,使用AJAX发起POST请求调用链接数据,请求数据须包含pid和sku值.可参考默认模板例子.

多语言环境时,变量名title会显示不同语言的附加属性名称. 其他可输入数据不存在多语言显示功能.

展示数据

展示数据变量名为: promo,类型为: 对象, 参考例子数据如下:

[
{
"poid":"23",
"title":"展示文字内容",
"links":"items-275-50045",
"img":"7gwzi/200401/rhqj6shp1.png",
"grp":1
},
{
"poid":"24",
"title":"fsdf sdf sdf sdf",
"links":"items-275-50064",
"img":"7gwzi/200401/0ruz2m3r1.png",
"grp":3
},
{
"poid":"25",
"title":"items name",
"links":"items-275-50064",
"img":"7gwzi/200401/2hm52u8u1.png",
"grp":7
}
]

变量名称解释:

poid:内容编号, 仅用于参考. 类型为:字符串

title:文字内容, 类型为:字符串

links:内页链接内容, 仅支持网站内页链接.不支持http开头的链接.类型为:字符串

img:图片内容. 类型为:字符串

grp:分组编号, 值范围为:0~9. 类型为:整数

子目录产品列表筛选数据

子目录产品列表筛选数据是用于用户筛选参数查找产品用途的数据. 返回结果集为json. 类型为: 字符串, 参考例子数据如下:

{
 "ack":"ok",
 "code":"112",
 "msg":{
  "217":{
   "top":"Tolerance",
   "sub":{
    "39":"Puppy",
    "38":"kitty",
    "41":"Pony",
    "43":"Chicken",
    "40":"Cattle",
    "42":"Lamb"
   }
  },
  "5":{
   "top":"Length",
   "sub":{
    "1095":"10mm",
    "1099":"25mm",
    "1096":"15mm",
    "1094":"1mm",
    "1097":"12mm",
    "1098":"20mm",
    "1100":"35mm"
   }
  },
  "101":{
   "top":"Testname",
   "sub":{
    "1078":"test value 1",
    "1080":"test value 2"
   }
  }
 }
}

使用提示

仅在产品列表页加载完成后,使用AJAX以POST方式向{url}/categories/assemble发起调用可显示. 以POST调用时的参数须含有当前子目录编号. 子目录编号可从url路径中或从页面数据获取. 可参考默认模板例子.

多语言环境时,变量名top会显示不同语言的筛选标题名称. 其他可输入数据不存在多语言显示功能.

子目录产品列表筛选返回数据

{
  "ack":"ok",
  "code":"212",
  "msg":[
    {
    "item":{
    "cid":"16",
    "pid":"14",
    "sku":"20",
    "pname":"Hot pepper",
    "sname":"State of origin India Red 5cm hot pepper",
    "pn":"TEST-PN-NAME-C",
    "price":"{"5":"0.39","20":"0.32","100":"0.28"}",
    "stock":"20000",
    "pimg":"it2r7/200424/3w8hy83i0.jpg",
    "simg":"it2r7/200424/w5q2j5wp0.jpg",
    "url":0,
    "min":"1",
    "max":"10",
    "mult":"1"
    },
    "attr":[
      {"title":"Color","val":"Red","aimg":"0","atk":"12","atv":"152"},
      {"title":"State of origin","val":"India","aimg":"0","atk":"5","atv":"36"},
      {"title":"Size","val":"6cm","aimg":"0","atk":"11","atv":"82"},
      {"title":"Length","val":"5cm","aimg":"0","atk":"16","atv":"17"}
    ]
    },
    {
    "item":{
    "cid":"16",
    "pid":"15",
    "sku":"28",
    "pname":"bell pepper",
    "sname":"State of origin India Red bell pepper 5cm",
    "pn":"INDIA-BP-5A",
    "price":"{"1":"0.89","5":"0.78","100":"0.69"}",
    "stock":"987520",
    "pimg":"it2r7/200424/qks9yrgj0.jpg",
    "simg":"it2r7/200424/hq03yu030.png",
    "url":0,
    "min":"1",
    "max":"10",
    "mult":"10"
    },
    "attr":[
      {"title":"Color","val":"Red","aimg":"0","atk":"19","atv":"51"},
      {"title":"State of origin",“val":"India","aimg":"0","atk":"15","atv":"68"},
      {"title":"Length","val":"5cm","aimg":"0","atk":"36","atv":"19"}
    ]
    }
]
}

变量名称解释:

ack:查询返回状态值,仅包含:ok,error两种值且为小写. 类型为:字符串

code:查询返回状态消息码,可根据需求显示消息码对应的消息内容. 类型为:字符串

msg:查询返回的数据内容. 类型为:字符串

item:单组物品key. 类型为:字符串

cid:目录编号, 类型为:字符串

pid:产品编号, 仅支持网站内页链接.不支持http开头的链接.类型为:字符串

sku:SKU编号. 类型为:字符串

pname:产品标题. 类型为:字符串

sname:SKU标题. 类型为:字符串

pn:SKU型号. 类型为:字符串

price:SKU价格组. 需前端js解析后显示, 错误数据为0. 类型为:整数或字符串

stock:SKU库存数量. 类型为:字符串

pimg:产品图片. 类型为:字符串

simg:SKU图片. 类型为:字符串

url:附加链接标志, 值为: 0,1. 当存在正确的外部链接是url的值为1. 类型为:整数

min:最小订购数. 类型为:字符串

max:最大订购数. 类型为:字符串

mult:订购倍数. 类型为:字符串

attr:附加属性key. 类型为:字符串

title:附加属性名称. 类型为:字符串

aimg:附加属性图片内容. 类型为:字符串

atk:附加属性名称编号(用于经典模式布局排版). 类型为:字符串

atv:附加属性内容编号(用于经典模式布局排版). 类型为:字符串

使用提示

当url值为1时,使用AJAX发起POST请求调用链接数据,请求数据须包含pid和sku值.可参考默认模板例子.

多语言环境时,变量名title会显示不同语言的附加属性名称. 其他可输入数据不存在多语言显示功能.

数据AJAX查询帮助

Candbox购物车全站数据查询均为AJAX并以POST方式递交数据. 仅少查询为GET方式,比如搜索功能. 以下是使用AJAX递交POST查询的规则:

1), 请求数据头(Request Headers)必需含有: XMLHttpRequest

2), 请求数据必需含有: token值. token来源有两个,分别为页面:
<meta name="token" content="eUQxdUt3Q1pWcjVvQnZwcFY0R1d0Zz09-cUlTZjgzYXVlMDZxSjA1VkdESU5mdz09">
以及ajax请求后响应头(Response Headers)中,例如: Token: MTlENG1QZi9pVy9EVDYrUkZTWlR5UT09-MVJrMm5qUTBPMkIrZjY1ekVpanFrZz09.

3), 每次AJAX请求的token值不相同. 使用中横线分组token值, 分别赋值给变量:tk,cs.

首次使用请参考官方的默认模板例子.

产品数据

产品数据可理解为产品详情. Candbox购物车的产品数据是基于SKU模型展示产品细节. 需正确了解Candbox购物车的产品数据,以帮助用户定制个性化模板非常重要.

Candbox购物车的产品数据是以单个产品ID基础. 并列出产品ID对应的所有SKU物品. 产品ID是唯一的. 产品ID对应的SKU编号也是唯一的. 以下例子可帮助用户理解Candbox购物车中的产品与SKU关系.

产品名称(ID:120):IBM笔记本电脑充电器--->SKU名称(ID:10): Thinkpad x21,充电器,2009,黑色,65w

产品名称(ID:120):IBM笔记本电脑充电器--->SKU名称(ID:11): Thinkpad x22,充电器,2010,黑色,65w

产品名称(ID:120):IBM笔记本电脑充电器--->SKU名称(ID:15): Thinkpad x23,充电器,2011,黑色,65w

产品名称(ID:125):TOSHIBA笔记本电脑充电器--->SKU名称(ID:17): M200,充电器,2015,黑色,65w

以上例子展示了Candbox购物车的目录->产品->SKU关系, 而在线支付时会充分使用以上数据帮助顾客理解购买的产品. 避免含糊不清的产品销售问题.

在线支付时,产品名称, SKU名称会出现在支付端和顾客账单记录中.

Candbox购物车的产品数据是一次性展示全部产品在前端, 无需额外查询单个SKU细节或属性选项. 解决了模板布局及升级的兼容性问题.

默认模板以扁平化展示产品对应的SKU物品信息. 用户可根据需要重新布局实现传统购物车的展示风格.

产品细节数据

产品细节数据包含三组数据, 分别为:导航栏数据,子目录列表数据,产品细节数据,以下将分别说明.

导航栏数据

导航栏数据变量名称为navbar, 类型为: 数组, 参考例子数据如下:

{
"a":"discrete-semiconductors",
"b":"Discrete Semiconductors",
"c":"163",
"d":"diodes-esd",
"e":"ESD Diodes",
"f":"Voltage 1500PF SMD, RoHS",
"g":0
}

变量名称解释:

a:主目录路径, 类型为:字符串

b:主目录名称, 类型为:字符串

c:子目录编号, 类型为:字符串

d:子目录路径, 类型为:字符串

e:子目录名称, 类型为:字符串

f:当前产品名称, 类型为:字符串

g:模版编号值, 值为0 - 9 类型为:整数

使用提示

多语言环境时,变量名b,e会显示不同语言的目录名称. 可根据g的值在模板中调整SKU列表布局. 例如格子或列表模式.

子目录列表数据

子目录列表数据变量名称为subcatg, 类型为: 数组, 参考例子数据如下:

{
"cid":"272",
"pid":"0",
"mods":"0",
"cpath":"clothes",
"cimg":"c5ur.jpg",
"pnum":"0",
"cname":"Clothes",
"ckey":"0ddd",
"cdesc":"aaaaa",
"sorts":"0",
 "sub":{
  "275":{
  "cid":"275",
  "pid":"272",
  "mods":"0",
  "cpath":"shirts",
  "cimg":"cg55.jpg",
  "pnum":"5",
  "cname":"Shirts",
  "ckey":"0",
  "cdesc":"Shirts",
  "sorts":"0"
  },
  "273":{
  "cid":"273",
  "pid":"272",
  "mods":"0",
  "cpath":"t-shirt",
  "cimg":"c4kw.jpg",
  "pnum":"9",
  "cname":"T-shirt",
  "ckey":"0ddgffgd",
  "cdesc":"T-shirt",
  "sorts":"0"
  }
 }
}

变量名称解释:

cid:主目录编号, 类型为:字符串

pid:子目录编号, 为0时表示一级目录, 类型为:字符串

mods:目录展示模式值, 值为0,1. 可根据该值设置目录内容排列布局或其他需求. 类型为:字符串

cpath:目录显示路径. 类型为:字符串

cimg:目录图片. 类型为:字符串

pnum:该目录下的产品数量, 仅参考用途. 注: 是产品数量而不是SKU数量. 类型为:字符串

cname:目录名称, 类型为:字符串

ckey:目录关键字. 类型为:字符串

cdesc:目录描述, 类型为:字符串

sorts:目录排序编号, 仅参考用途. 默认已排序. 类型为:字符串

sub:子目录key, 需判断sub是否存在. 默认已排序. 类型为:字符串

使用提示

多语言环境时,变量名cname,ckey,cdesc会显示不同名称或内容. 子目录列表数据的数据结构与全目录数据完全相同.

产品细节数据

产品细节数据变量名称为items, 类型为: 数组, 参考例子数据如下:

{
 "cid":"160",
 "pid":"10195",
 "item":{
 "pname":"Voltage Test product name 1500PF SMD,RoHS",
 "pimg":"14kwt/191115/abcde0830.jpg",
 "mods":"1",
 "pdesc":"more and more about product desc.",
 "min":2,
 "max":150,
 "mult":1
 },
 "alt":{
 "10195":{"sku":"27382","img":"14kwt/191115/abcde0840.jpg"},
 "74331":{"sku":"27382","img":"14kwt/191115/abcde0720.jpg"},
 "74332":{"sku":"0","img":"14kwt/191115/abcde1830.jpg"},
 "74333":{"sku":"0","img":"14kwt/191115/abcde0380.jpg"},
 "74334":{"sku":"0","img":"14kwt/191115/abcde2890.jpg"},
 "74335":{"sku":"45259","img":"14kwt/191115/abcde3000.jpg"},
 "74336":{"sku":"45259","img":"14kwt/191115/abcde0680.jpg"},
 "74337":{"sku":"45259","img":"14kwt/191115/abcde1290.jpg"}
 },
  "sku":{
  "45259":{
  "sub":{
  "sku":"45259",
  "sname":"SINGLE Expander Resistor,4R7,SMD,0.125W",
  "stock":"4800",
  "url":1,
  "pn":"W5rc7mOrC5Tfs7z4uRkb",
  "wt":"28.98",
  "simg":"14kwt/191115/abcde2600.jpg"},
  "price":"{"1":5.68,"100":3.16,"500":1.89}",
  "attr":{
   "54742":{"title":"Package","val":"SOIC-16_150mil","aimg":"chicken_43.jpg","atk":"109","atv":"222"},
   "54743":{"title":"Tolerance","val":"Lamb","aimg":"chicken_43.jpg","atk":"12","atv":"75"}
  },
  "sort":0
 },
 "27382":{
 "sub":{
  "sku":"27382",
  "sname":"SINGLE Expander Resistor,4R7,SMD,0.125W",
  "stock":"1960",
  "url":1,
  "pn":"3lpyb0DO5t1S",
  "wt":"79.64",
  "simg":"14kwt/191115/abcde2350.jpg"
  },
  "price":"{"1":1.2,"100":0.67,"500":0.4}",
  "attr":{
   "54737":{"title":"Package","val":"LQFP64","aimg":"0","atk":"22","atv":"152"},
   "54738":{"title":"Tolerance","val":"kitty","aimg":"puppy_39.jpg","atk":"61","atv":"39"}
  },
  "sort":2
  }
}
}

变量名称解释:

产品细节数据分为5个子类别key,分别为cid,pid,item,alt,sku以下按可用顺序分别介绍,以避免重复字母含义不清晰问题.

--cid

cid:当前产品所属目录编号, 仅用于参考. 类型为:字符串

--pid

pid:当前产品编号, 仅用于参考. 类型为:字符串

--item

item:当前产品的通用信息,内容如下. 类型为:数组

pname:产品名称(标题), 类型为:字符串

pimg:产品主图片, 类型为:字符串

mods:产品细节页模版编号, 值为0-9, 类型为:整数

pdesc:产品描述内容, 类型为:字符串

min:最小订购数量, 对当前产品范围内的所有SKU有效, 类型为:整数

max:最大订购数量, 对当前产品范围内的所有SKU有效, 类型为:整数

mult:订购倍数, 类型为:整数

--alt

alt:当前产品附加图片集合. 内容如下. 类型为:数组

sku:附加图片关联的SKU编号, 若未关联SKU编号则为0, 类型为:字符串

img:附加图片内容, 类型为:字符串

--sku

sku:当前产品对应的所有在线SKU物品集合. 内容如下, 类型为:数组

sub:当前SKU物品参数集合, 内容如下. 类型为:字符串

sku:SKU编号. 类型为:字符串

sname:SKU名称(标题). 类型为:字符串

stock:SKU物品库存数量. 类型为:整数

url:SKU是否存在外部链接标志,值为0,1. 类型为:整数

pn:SKU物品型号. 类型为:字符串

wt:SKU物品重量,以最小单位计数,例如克(g). 类型为:字符串

simg:SKU物品图片内容. 类型为:字符串

price:SKU物品价格, 需前端使用JS解析后显示,解析成多组订单数量和价格关系, 若无价格数据或错误格式时是不能添加到购物车, 可显示询价提示按键. 类型为:字符串

attr:SKU物品附加属性, 内容如下. 类型为:数组

title:SKU物品属性名称. 类型为:字符串

val:SKU物品属性内容. 类型为:字符串

aimg:SKU编号属性图片. 类型为:字符串

atk:SKU物品属性名称编号. 类型为:字符串

atv:SKU物品属性内容编号. 类型为:字符串

sort:SKU物品排序编号, 仅参考用途. 类型为:整数

使用提示

Candbox购物车的产品数据为一次加载完成, 可根据产品特点以及模板风格显示全部数据或部分数据.

产品添加到购物车

添加产品到购物车仅在三个页面操作有效,分别为: 子目录产品列表页,产品细节页,搜索结果页. 其他页面不支持添加产品到购物车.

添加产品到购物车需以AJAX递交POST数据到以下地址:{url}/add-{目录ID}-{产品ID}

展示数据

展示数据用于在网站页面指定位置插入展示内容. 展示内容可包含信息有: 图片,文字,链接以及分组编号. 以下是Candbox购物车内置promo功能的示意图:

每一组promo展示数据至少包含有0到9的分组编号. 内容可根据需要在模板中调用显示或不显示.

展示数据变量名为: promo,类型为: 对象, 参考例子数据如下:

{
"poid":"2",
"title":"start your business store",
"links":"online-payment-manual-html",
"img":"7gwzi/200320/5r80r29r1.png",
"grp":8
},
{
"poid":"19",
"title":"The World's #1 Shopping Cart",
"links":"about-html",
"img":"7gwzi/200401/gzgvq6i31.png",
"grp":1
}

变量名称解释:

poid:内容编号, 仅用于参考. 类型为:字符串

title:文字内容, 类型为:字符串

links:内页链接内容, 仅支持网站内页链接.不支持http开头的链接.类型为:字符串

img:图片内容. 类型为:字符串

grp:分组编号, 值范围为:0~9. 类型为:整数

导航栏单页菜单数据

定制菜单数据是全局变量。即在所有页面都可显示。通常显示在顶部或底部位置。

定制菜单数据

定制菜单数据变量名称为pagenav, 类型为: 数组, 参考例子数据如下:

{
 "1":{
  "pgid":"1",
   "grpid":"0",
   "tpid":"0",
   "paths":"0",
   "pname":"Navigation",
   "sorts":"0",
   "ps":1,
   "cpath":"html",
    "sub":{
    "4":{
    "pgid":"4",
    "grpid":"1",
    "tpid":"0",
    "paths":"0",
    "pname":"Home",
    "sorts":"0",
    "ps":1},
    "7":{
    "pgid":"7",
    "grpid":"1",
    "tpid":"1",
    "paths":"register",
    "pname":"Register",
    "sorts":"1",
    "ps":1},
    "5":{
    "pgid":"5",
    "grpid":"1",
    "tpid":"1",
    "paths":"categories-small-tool-gadgetry",
    "pname":"Gadgetry",
    "sorts":"2",
    "ps":1}
    }
    },
 "2":{
    "pgid":"2",
    "grpid":"0",
    "tpid":"0",
    "paths":"0",
    "pname":"Help",
    "sorts":"1",
    "ps":1,
    "cpath":"html",
     "sub":{
     "12":{
     "pgid":"12",
     "grpid":"2",
     "tpid":"2",
     "paths":"privacy-policy",
     "pname":"Privacy policy",
     "sorts":"0",
     "ps":0},
     "11":{
     "pgid":"11",
     "grpid":"2",
     "tpid":"2",
     "d":"terms-of-use",
     "pname":"Terms of use",
     "sorts":"0",
     "ps":0},
     "9":{
     "pgid":"9",
     "grpid":"2",
     "tpid":"2",
     "paths":"how-to-buy",
     "pname":"How to buy",
     "sorts":"1",
     "ps":1
     },
     "10":{
     "pgid":"10",
     "grpid":"2",
     "tpid":"2",
     "paths":"faq",
     "pname":"FAQ",
     "sorts":"2",
     "ps":1
     }
     }
    },
 "3":{
    "pgid":"3",
    "grpid":"0",
    "tpid":"0",
    "paths":"0",
    "pname":"More",
    "sorts":"2",
    "ps":1,
    "cpath":"html",
    "sub":{
   "8":{
    "pgid":"8",
    "grpid":"3",
    "tpid":"2",
    "paths":"about",
    "pname":"About",
    "sorts":"0",
    "ps":1},
    "6":{
    "pgid":"6",
    "grpid":"3",
    "tpid":"2",
    "paths":"contact",
    "pname":"Contact Us",
    "sorts":"0",
    "ps":1
    }
    }
    }
}

变量名称解释:

pgid导航菜单数据编号,仅参考用途. 类型为字符串

grpid导航菜单分组id. 类型为字符串

tpid导航菜单类型,值为0,1,2.类型值为0表示首页导航菜单,为1表示内页导航菜单,为2表示单页导航菜单. 类型为字符串

paths导航菜单单页路径名称.该值可能是内链路径或定制单页路径. 类型为字符串

pname导航菜单标题名称. 类型为字符串

cpath导航菜单固定识别路径名称. 该值是在配置文件config.ini中设置. 类型为字符串

sorts导航菜单排序,值为数值. 类型为字符串

ps导航菜单标题是否隐藏,值为0,1. 类型为整数

使用提示

定制的单页导航路径的格式为:{url}/paths-cpath

导航菜单分组应根据模版布局进行设置。可结合参数ps来分成顶部栏和底部栏显示。

由于模版编号是以数值0-9表示。在后端操作界面不便于用户理解数值对应的模版用途。此时，可在模版或语言文件中创建固定的标签文字对应编号0-9。方便记忆或管理操作。

购物车数据

Candbox购物车数据是按目录进行分组显示。未登录用户可保存最多100个物品到购物车。登录用户最多可保存200个物品到购物车。

购物车数据变量名称为carts, 类型为: 对象, 参考例子数据如下:

{
  "160":{
  "42399":{
   "top":{
   "pid":"42659",
   "pname":"CODEC Remote 28-Pin Mini-Fit",
   "sname":"CONN 0.010 Receptacle",
   "pn":"p63FIEiJAxk1fuk",
   "qty":1,
   "price":"{"1":3.52,"10":3.12,"100":2.71,"1000":2.3}",
   "simg":"14kwt/191115/abcde0030.jpg",
   "status":"1",
   "url":1,
   "min":1,
   "max":1400,
   "mult":1
   },
   "atr":{
   "537525":{"title":"Thickness","val":"df3trop table ami","aimg":"0"},
   "537516":{"title":"CAP-Value","val":"1.8M","aimg":"0"}}
   }
  },
  "275":{
   "60062":{
   "top":{
   "pid":"50043",
   "pname":"thksjlsk fjslkf jsdlfksf dgkj otio45jyl4j6hth6788n878879",
   "sname":"Length 15mm Blue u6211u662fu6d4bu8bd5u5440asf",
   "pn":"SFGGFDG",
   "qty":1,
   "price":"{"1":"5.00","5":"4.00","100":"3.00"}",
   "simg":"14kwt/191115/abcde0510.jpg",
   "status":"1",
   "url":1,
   "min":5,
   "max":100000,
   "mult":3
   },
   "atr":{"686111":{"title":"test","val":"ggag","aimg":"0"}}
   }
  }
}

candbox购物车数据是以目录编号和SKU为分组。一个SKU产品分为两组数据，分别:top,atr.

变量名称解释:

pid:产品名称编号, 仅用于参考. 类型为:字符串

pname: 产品名称, 类型为:字符串

sname:SKU名称(标题). 类型为:字符串

pn:SKU物品型号. 类型为:字符串

qty:订购数量. 类型为:整数

simg:SKU物品图片内容. 类型为:字符串

status:sku物品是否有效,值为0,1.当后端下线产品时,会在购物车显示值为0，表示下线且不能完成支付。类型为:整数

url:SKU是否存在外部链接标志,值为0,1. 类型为:整数

min:最小订购数量. 类型为:整数

max:最大订购数量. 类型为:整数

mult:订购倍数. 类型为:整数

atr:SKU属性, 可能为空. 类型为:对象

使用提示

pname和sname的差异。pname是一个产品大类别名称。sname是产品对应的具体型号的名称。该名称应该是详细对单个SKU的表达，包括产品细节。例如颜色，尺寸等内容特点。记载主要属性。方便顾客理解而避免错误购买。

sname,sku,pn,qty,price会作为在线交易时的数据记录在订购支付结果中。

sname标题在后端是基于属性选择时而自动填写。也可用手工修正标题。

搜索数据

Candbox购物车搜索结果最多返回100条数据。支持分页输出。搜索数据主要来源型号和SKU标题两个部分的内容.

关键字搜索结果数据变量名称为search, 类型为: 数组, 参考例子数据如下:

{
  "items":[
  {
  "top":{
  "cid":"53",
  "pid":"39892",
  "sname":"Solder 8KB Right",
  "sku":"18468",
  "url":1,
  "pn":"iZrEEo79kowPh0rEdc1mI",
  "stock":"5100",
  "price":"{"1":8.14,"10":7.05,"50":6.87,"100":5.88,"500":4.88,"1000":3.16}",
  "simg":"14kwt/191115/abcde2300.jpg",
  "min":1,
  "max":600,
  "mult":1
  },
  "att":[
  {"title":"Thickness","val":"This test ~name","aimg":"thiscode_31.jpg"}
  ]
  },
  {
  "top":{
  "cid":"57",
  "pid":"9676",
  "sname":"-36V/90V, Crystal Dual",
  "sku":"44637",
  "url":1,
  "pn":"MtF28XhbDWreDtUlHJ",
  "stock":"4960",
  "price":"{"1":8.24,"100":4.58,"500":2.75}",
  "simg":"14kwt/191115/abcde0470.jpg",
  "min":1,
  "max":1900,
  "mult":1
  },
  "att":[
  {"title":"CAP-Value","val":"360R","aimg":"0"}
  ]
  },
  {
  "top":{
  "cid":"273",
  "pid":"50052",
  "sname":"gfdgff Blue DC 3.3V Silver Red 15mm",
  "sku":"60196",
  "url":1,"pn":"YJGHJ7997",
  "stock":"7",
  "price":"{"1":"8.00",
  "5":"7.50",
  "100":"6.20",
  "500":"5.50"}",
  "simg":"14kwt/191115/abcde2810.jpg",
  "min":1,
  "max":50000,
  "mult":1
  },
  "att":[
  {"title":"Color","val":"Red","aimg":"red_1.jpg"},
  {"title":"Length","val":"15mm","aimg":"0"}
  ]
  }
  ],
  "first":1,
  "prev":1,
  "current":1,
  "last":1,
  "next":1,
  "page":1,
  "item":3,
  "limit":30
}

搜索结果数据的解释与产品列表数据相同。

Candbox前端模板数据手册

Candbox软件模版设计

数据规范

首页数据

首页目录数据

首页产品数据

首页评价数据

首页展示数据

目录数据数据

全目录数据

导航目录数据

子目录列表数据

子目录产品列表数据

子目录产品列表筛选数据

子目录产品列表筛选返回数据

数据AJAX查询帮助

产品数据

产品细节数据

产品添加到购物车

展示数据

导航栏单页菜单数据

展示分类

购物车数据

搜索数据