开发平台

电话咨询 400-000-7749

QQ咨询

1. 分页查询全部商品分类


接口地址 http://host:port/pospal-api2/openapi/v1/productOpenApi/queryProductCategoryPages
请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "postBackParameter": {,
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • }
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    postBackParameter Json 查询首页时可以不传,之后的内容从返回结果中取出
    parameterType String 从返回结果中取出
    parameterValue String 从返回结果中取出
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data": {
  • "postBackParameter": {
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • },
  • "result": [
  • {
  • "uid": 813701230071893827,
  • "parentUid": 0,
  • "name": "工艺品"
  • }
  • ],
  • "pageSize": 100
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    pageSize int 本次查询预期从库存取出记录数,如果结果集的长度小于pageSize,不需要进行下一页查询
    postBackParameter Json 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页
    parameterType String 从返回结果中直接取出用于回传,不能变其值
    parameterValue String 从返回结果中直接取出用于回传,不能变其值
    result List 商品分类实体
    uid Long 当前商品分类唯一标识
    parentUid Long 当前商品分类的父分类的唯一标识
    name String 商品分类名称

    2. 分页查询全部商品图片


    接口地址 http://host:port/pospal-api2/openapi/v1/productOpenApi/queryProductImagePages
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "postBackParameter": {
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • }
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    postBackParameter Json 查询首页时可以不传,之后的内容从返回结果中取出
    parameterType String 从返回结果中取出
    parameterValue String 从返回结果中取出
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data": {
  • "postBackParameter": {
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • },
  • "result": [
  • {
  • "productUid": 1366004607492564649,
  • "productName": "翠玉白菜",
  • "productBarcode": "100",
  • "imageUrl": "http://order.dev.pospal.cn:12080
  • /productImages/35096/1332771854373.jpg",
  • }
  • ],
  • "pageSize":100
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    pageSize int 本次查询预期从数据库中取出记录数,如果结果集的长度小于pageSize,不需要进行下一页查询
    postBackParameter json 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页
    parameterType String 从返回结果中直接取出用于回传,不能变其值
    parameterValue String 从返回结果中直接取出用于回传,不能变其值
    result List 商品图片实体
    productUid Long 商品的唯一标识
    productName String 商品名称
    productBarcode String 商品的条形码
    imageUrl String 商品图片的url

    3. 根据条形码查询商品信息


    接口地址 http://host:port/pospal-api2/openapi/v1/productOpenApi/queryProductByBarcode
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "barcode":"1001" {
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    barcode String 商品条码
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data":{
  • "uid": 1366004607492564649,
  • "categoryUid": 813701230071893827,
  • "name": "翠玉白菜"{
  • "barcode": "1001",
  • "buyPrice": 10000,
  • "sellPrice": 15000,
  • "stock": 0,
  • "pinyin": "CYBC",
  • "customerPrice": 15000,
  • "isCustomerDiscount": 1,
  • "description": "尺寸:长18.7公分,宽9.1公分,厚5.07公分"
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data Json 商品实体信息
    uid Long 商品实体唯一标识
    categoryUid Long 商品分类的唯一标识
    name String 商品名称
    barcode String 商品条形码
    buyPrice BigDecimal 商品进货价
    sellPrice BigDecimal 商品销售价
    stock BigDecimal 商品库存
    pinyin String 商品名称拼音
    customerPrice BigDecimal 商品会员价
    isCustomerDiscount Integer 是否开启会员折扣支持,为0或null不开启;1开启
    description String[长度6000] 商品描述

    4. 分页查询全部商品信息


    接口地址 http://host:port/pospal-api2/openapi/v1/productOpenApi/queryProductPages
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "postBackParameter": {
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • }
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    postBackParameter Json 查询首页时可以不传,之后的内容从返回结果中取出
    parameterType Json 从返回结果中取出
    parameterValue String 从返回结果中取出
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data":{
  • "postBackParameter": {
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • },
  • "result": [
  • {
  • "uid": 1366004607492564649,
  • "categoryUid": 813701230071893827,
  • "name": "翠玉白菜"{
  • "barcode": "1001",
  • "buyPrice": 10000,
  • "sellPrice": 15000,
  • "stock": 0,
  • "pinyin": "CYBC",
  • "customerPrice": 15000,
  • "isCustomerDiscount": 1,
  • "description": "尺寸:长18.7公分,宽9.1公分,厚5.07公分"
  • }
  • ],
  • "pageSize": 100
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    pageSize int 本次查询预期从库存取出记录数,如果结果集的长度小于pageSize,不需要进行下一页查询
    postBackParameter Json 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页
    parameterType String 从返回结果中直接取出用于回传,不能变其值
    parameterValue String 从返回结果中直接取出用于回传,不能变其值
    result List 商品实体信息,字段信息参照3

    5. 修改商品信息


    接口地址 http://host:port/pospal-api2/openapi/v1/productOpenApi/updateProductInfo
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "productInfo":{
  • "uid": 1366004607492564649,
  • "buyPrice": 10000,
  • "sellPrice": 15000,
  • "stock": 100,
  • "customerPrice": 15000,
  • "isCustomerDiscount": 1
  • }
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    productInfo Json
    uid Long 商品在银豹系统的唯一标识
    buyPrice BigDecimal 进货价,传空或不传不做修改操作
    sellPrice BigDecimal 销售价,传空或不传不做修改操作
    stock BigDecimal 库存,传空或不传不做修改操作
    customerPrice BigDecimal 会员价,传空或不传不做修改操作
    isCustomerDiscount Integer 传1表示使用会员折扣计算商品价格传0表示使用商品的会员价
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "errorCode":null
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表

    6. 根据唯一标识查询商品信息


    接口地址 http://host:port/pospal-api2/openapi/v1/productOpenApi/queryProductByUid
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "productUid":1366004607492564649
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    productUid Long 商品在银豹系统的唯一标识
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data":{
  • "uid": 1366004607492564649,
  • "categoryUid": 813701230071893827,
  • "name": "翠玉白菜"{
  • "barcode": "1001",
  • "buyPrice": 10000,
  • "sellPrice": 15000,
  • "stock": 0,
  • "pinyin": "CYBC",
  • "customerPrice": 15000,
  • "isCustomerDiscount": 1,
  • "description": "尺寸:长18.7公分,宽9.1公分,厚5.07公分"
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data Json 商品实体信息
    uid Long 商品实体唯一标识
    categoryUid Long 商品分类的唯一标识
    name String 商品名称
    barcode String 商品条形码
    buyPrice BigDecimal 商品进货价
    sellPrice BigDecimal 商品销售价
    stock BigDecimal 商品库存
    pinyin String 商品名称拼音
    customerPrice BigDecimal 商品会员价
    isCustomerDiscount Integer 是否开启会员折扣支持,为0或null不开启;1开启
    description String[长度6000] 商品描述

    7. 新增加商品信息


    接口地址 http://host:port/pospal-api2/openapi/v1/productOpenApi/addProductInfo
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "productInfo":{
  • "categoryUid": 1,
  • "name": "彪哥商品",
  • "barcode": "bgtssp004",
  • "buyPrice": 10,
  • "sellPrice": 15,
  • "stock": 100,
  • "pinyin": "bgtssp",
  • "description": "openApi增加商品测试",
  • "isCustomerDiscount": 1,
  • "supplierUid": 1,
  • "enable": 1,
  • },
  • "appId": "abcdefghijklmn"
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    categoryUid Long 商品分类的唯一标识
    name String 商品名称
    barcode String 商品条形码
    buyPrice BigDecimal 商品进货价,不可为0
    sellPrice BigDecimal 商品销售价,不可为0
    stock BigDecimal 商品库存
    pinyin String 商品名称拼音
    customerPrice BigDecimal 商品会员价
    isCustomerDiscount Integer 是否开启会员折扣支持,为0或null不开启;1开启
    description String[长度6000] 商品描述
    supplierUid Long 供应商唯一标识
    enable Int 0禁用,1可用
    返回结果
  • {
  • "status": "success",
  • "data": {
  • "id": 0,
  • "uid": 287518801523242326,
  • "name": "商品测试",
  • "barcode": " spcs ",
  • "buyPrice": 10,
  • "sellPrice": 15,
  • "stock": 100,
  • "pinyin": "bgtssp",
  • "enable": 1,
  • "description": "openApi增加商品测试"
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data Json 商品实体信息, 商品实体信息,字段信息参照2.2.3