开放平台API - densen2014/docs GitHub Wiki

API说明:

tips: 如果id包含 / 这种类似特殊符号要转义, 比如 / 为 %2F

Demo

1. 联系客服获取

densenID

2. 获取 api token

https://mp.app1.es/api/getProduct/{densenID}

https://mp.app1.es/api/getProduct?id={densenID}

返回一串数字token, 例如 1080384599

token有效期截至到当前自然月,或者api更新版本等原因也会导致需要重新获取.

当api返回token时,需要把token重新附加到api进行查询

返回格式 json

  1. message: 附带信息,错误信息
  2. token: 查询令牌
{
    "message": "new token",
    "token": 838140214
}

3. 获取商品列表

使用token获取商品资料, 缓存5分钟. 意思是5分钟内都是同一份数据.降低客户数据主机压力

https://mp.app1.es/api/getProduct/{densenID}/{token}

https://mp.app1.es/api/getProduct?id={densenID}&token={token}

返回格式 json

  1. message: 附带信息,错误信息
  2. expiration: 数据过期时间
  3. items: 商品列表
{
    "expiration": "2025-03-12T11:50:47.2024497",
    "items": [
        {
            "productID": 6,
            "userCode": "1",
            "barCode": "9002490100070",
            "productName": "红牛",
            "unitsInStock": 81,
            "pricePurchase": 0,
            "unitPrice": 0.0100,
            "tax": 0.21,
            "discount": 0,
            "lastModify": "2025-03-12",
            "storageLocation": "二楼走廊A",
            "quantityPerUnit": 12,
            "quantityPerUnit2nd": 240,
            "marketingNO": "Normal"
        },
        {
            "productID": 4,
            "userCode": "18",
            "barCode": "8410412490061",
            "productName": "太阳油",
            "unitsInStock": 61,
            "pricePurchase": 0.0000,
            "unitPrice": 10.0000,
            "tax": 0.21,
            "discount": 0
        }
    ]
}

字段说明

最新版直接参考链接

https://mp.app1.es/api/help

https://mp.app1.es/api/getProduct/Field

ProductsApi 商品属性说明
字段名 说明 数据类型
MarketingNO 状态 商品状态
LastModify 编辑日期 String
StorageLocation 存放位置 String
ProductID ID Int32
UserCode 编号 String
BarCode 条码 String
ProductName 名称 String
UnitsInStock 库存 Double?
PricePurchase 进价 Decimal?
UnitPrice 售价 Decimal
Tax 税% Single?
Discount 折扣 Int32
Quantity 数量 Int32
ProductNameIn 名称 String
UnitPriceIn 售价 Int32?
DiscountIn 折扣 Int32?
Inventory 数量 Int32?
QuantityPerUnit 小包 Int32
QuantityPerUnit2nd 大包 Int32
UnitsOnPurchase 进货量 Double?
JSON 示例
{
  "productID": 0,
  "userCode": "001",
  "barCode": "001",
  "productName": "阿香婆 人头牛马炸酱面",
  "unitsInStock": 0,
  "pricePurchase": 0,
  "unitPrice": 10.99,
  "tax": null,
  "discount": 0,
  "quantity": 1,
  "productNameIn": null,
  "unitPriceIn": null,
  "discountIn": null,
  "inventory": null,
  "unitsOnPurchase": 0,
  "lastModify": null,
  "storageLocation": null,
  "quantityPerUnit": 1,
  "quantityPerUnit2nd": 1,
  "marketingNO": "Normal"
}

QuantityPerUnit: 小包
QuantityPerUnit2nd: 大包
MarketingNO: 状态
LastModify: 编辑日期
StorageLocation: 存放位置
ProductID: ID
UserCode: 编号
BarCode: 条码
ProductName: 名称
UnitsInStock: 库存
PricePurchase: 进价
UnitPrice: 售价
Tax: 税%
Discount: 折扣

4. 查询商品

https://mp.app1.es/api/getProduct/{densenID}/{token}/{barcode}

https://mp.app1.es/api/getProduct?id={densenID}&token={token}&barcode={barcode}

可选参数

  • take 获取商品记录
  • skip 跳过商品记录

https://mp.app1.es/api/getProduct?id={densenID}&token={token}&barcode={barcode}&take={take}&skip={skip}

返回格式 json (同上)

5. 盘点库存

https://mp.app1.es/api/changeQuantity/{densenID}/{int:token}/{barcode}/{int:quantity}

参数

  • densenID 数据点ID
  • token 令牌
  • barcode 商品条码
  • quantity 盘点后的库存

返回信息

  • 商品不存在
  • 数量未改变
  • 数量不合法
  • 进货成功 添加数量 xxx 添加数量=现有库存-盘点后的库存
  • 进货失败 计划添加数量 xxx

6. 添加商品 POST

https://mp.app1.es/api/addProduct/{densenID}/{int:token}

Body json 格式提交 item

https://mp.app1.es/api/help

item 商品添加/编辑属性说明
字段名 说明 数据类型
UserCode 编号 String
BarCode 条码 String
ProductName 名称 String
PricePurchase 进价 Decimal?
UnitPrice 售价 Decimal
Tax 税% Single?
Discount 折扣 Int32
QuantityPerUnit 小包 Int32
QuantityPerUnit2nd 大包 Int32
JSON 示例
{
  "userCode": "001",
  "barCode": "001",
  "productName": "阿香婆 人头牛马炸酱面",
  "pricePurchase": 0,
  "unitPrice": 10.99,
  "tax": null,
  "discount": 0,
  "quantityPerUnit": 1,
  "quantityPerUnit2nd": 1
}

7. 编辑商品 POST

https://mp.app1.es/api/updateProduct/{densenID}/{int:token}

Body json 格式提交 item, 当 ProductID 不提交, 系统会根据 BarCode 关联商品更新资料

https://mp.app1.es/api/help

ProductUpdateDto 商品添加/编辑属性说明
字段名 说明 数据类型
ProductID ID Int32
UserCode 编号 String
BarCode 条码 String
ProductName 名称 String
PricePurchase 进价 Decimal?
UnitPrice 售价 Decimal
Tax 税% Single?
Discount 折扣 Int32
QuantityPerUnit 小包 Int32
QuantityPerUnit2nd 大包 Int32
JSON 示例
{
  "productID": 0,
  "userCode": "001",
  "barCode": "001",
  "productName": "阿香婆 人头牛马炸酱面",
  "pricePurchase": 0,
  "unitPrice": 10.99,
  "tax": null,
  "discount": 0,
  "quantityPerUnit": 1,
  "quantityPerUnit2nd": 1
}

⚠️ **GitHub.com Fallback** ⚠️