ClawHub
Skill flagged — suspicious patterns detected

ClawHub Security flagged this skill as suspicious. Review the scan results before using.

品氪 OpenApi 开放平台 Skill

v1.0.1

品氪提供的OpenApi开放平台，支持门店、导购、会员、订单、退单、库存、商品、积分、储值、卡券、销售等全链路CRM/SCRM数据同步与管理。通过安全认证的API接口实现第三方系统与品氪平台的数据互通。

⭐ 0· 96·0 current·0 all-time
by@ikaijian

Install

OpenClaw Prompt Flow

Install with OpenClaw

Best for remote or guided setup. Copy the exact prompt, then paste it into OpenClaw for ikaijian/pinkr-openapi-skill.

Previewing Install & Setup.
Prompt PreviewInstall & Setup
Install the skill "品氪 OpenApi 开放平台 Skill" (ikaijian/pinkr-openapi-skill) from ClawHub.
Skill page: https://clawhub.ai/ikaijian/pinkr-openapi-skill
Keep the work scoped to this skill only.
After install, inspect the skill metadata and help me finish setup.
Use only the metadata you can verify from ClawHub; do not invent missing requirements.
Ask before making any broader environment changes.

Command Line

CLI Commands

Use the direct CLI path if you want to install manually and keep every step visible.

OpenClaw CLI

Bare skill slug

openclaw skills install pinkr-openapi-skill

ClawHub CLI

Package manager switcher

npx clawhub@latest install pinkr-openapi-skill
Security Scan
VirusTotalVirusTotal
Suspicious
View report →
OpenClawOpenClaw
Suspicious
medium confidence
ℹ
Purpose & Capability
The skill's name, description, SKILL.md, and the Python code all align: they call Pinkr OpenAPI endpoints for CRM/SCRM operations. Declared API usage (method, appid, data, v) and endpoints in code match the described purpose. However the registry-level metadata (shown earlier) indicates no required env vars/primary credential while SKILL.md and the code require PK_APPKEY (and optionally PK_API_URL) — an inconsistency between manifest and SKILL.md.
✓
Instruction Scope
Runtime instructions and the implemented code focus on making POST requests to the configured PK_API_URL using PK_APPKEY and formatting/saving results. The SKILL.md does not instruct the agent to read unrelated files, system credentials, or exfiltrate data to other endpoints. The code writes results to an 'output' directory under the skill — this is scope-consistent but should be noted.
✓
Install Mechanism
No install spec is provided (instruction-only plus a small Python script). The included requirements.txt only lists 'requests' which is a common dependency. No unusual downloads, URL shorteners, or archive extraction were observed.
!
Credentials
The SKILL.md and script legitimately require a single secret (PK_APPKEY) and an optional PK_API_URL — proportionate to the stated functionality. However the registry metadata at the top of the package incorrectly lists 'Required env vars: none' and 'Primary credential: none', creating an inconsistency about credential needs. This mismatch could confuse users and automated permission checks; confirm that PK_APPKEY is the only credential the skill needs and verify it is sent only to the expected PK_API_URL.
✓
Persistence & Privilege
The skill does not request always:true and is user-invocable. It does not modify other skills or system-wide settings. It does write output files into an 'output' directory under the skill — local persistence limited to that folder.
What to consider before installing
Before installing: (1) Verify the PK_API_URL value points to an official Pinkr endpoint (production vs dev) and that you trust that host. (2) Expect to provide a secret PK_APPKEY — confirm the registry-level metadata omission is just an error and not an attempt to hide credential use. (3) Review the included Python script yourself (it posts form data to the configured URL and writes results to a local 'output' folder); run it in an isolated environment if possible. (4) Avoid supplying unrelated credentials; the skill only needs one app key and an API base URL. (5) If you need higher assurance, ask the publisher for a canonical homepage/source or signed releases, or request the skill be repackaged so registry metadata matches the SKILL.md.

Like a lobster shell, security has layers — review code before you run it.

latestvk973w5wkjp1q3w8hpb6cx329a583tpm0
96downloads
0stars
2versions
Updated 4w ago
v1.0.1
MIT-0
@ikaijian
latest
Download

pinkr_openapi 品氪 OpenApi 开放平台 Skill

本 Skill 由品氪提供 OpenApi 开放平台，支持门店管理、导购管理、会员管理、订单管理、退单管理、库存管理、商品管理、积分管理、储值管理、卡券管理、销售数据同步、营销数据分析、分销管理等全链路 CRM/SCRM 功能。通过调用品氪后端相关原生接口，实现第三方系统与品氪平台的数据互通，所有操作均通过安全认证的 API 接口完成。

tags: ["SCRM", "CRM", "openAPI", "api", "会员管理", "订单管理", "商品管理"]
use_when:
  - 用户需要同步门店、导购基础数据到品氪平台
  - 用户需要管理会员信息（查询/新增/更新会员）
  - 用户需要同步订单、退单、发货信息
  - 用户需要管理商品、库存数据
  - 用户需要同步积分、储值、卡券数据
  - 用户需要同步销售小票数据
  - 用户需要查询营销统计数据
  - 用户需要查询分销订单数据
not_for:
  - 非授权的第三方数据访问
  - 商业数据倒卖、非法数据爬取
# 环境变量配置
parameters:
  - name: PK_APPKEY
    description: 品氪开放平台分配的APPKEY
    required: true
    type: secret
    default: process.env.PK_APPKEY
  - name: PK_API_URL
    description: 品氪API基础地址
    required: false
    type: string
    default: process.env.PK_API_URL || "http://dev.openapi.pinkr.com"

功能说明

根据用户问句自动识别意图并调用对应接口，支持以下功能模块：

  1. 门店管理：上传门店基础数据。
  2. 导购管理：上传导购基础数据，支持所属门店绑定。
  3. 会员标签：上传标签分类、标签、会员标签明细，获取标签资料。
  4. 订单管理：获取订单列表及商品明细，更新发货信息，接收第三方订单，更新仓库发货状态。
  5. 退单管理：获取退货退款单、退款单，更新退货退款状态和退款状态，接收第三方退货单。
  6. 库存管理：获取仓库清单和商品清单，批量更新/获取商品库存。
  7. 商品管理：上传商品尺码、颜色、SPU属性，上传商品，上传商品价格（千店千面），全量上传商品。
  8. 会员管理：获取/更新会员信息，更新会员等级，新增会员卡，获取品氪会员信息，新增会员收货地址。
  9. 积分管理：新增会员积分流水。
  10. 储值管理：新增会员储值流水，绑定储值卡，储值卡变动消息推送。
  11. 卡券管理：批量核销卡券。
  12. 销售数据：接收小票（同步第三方订单明细）。
  13. 营销数据：获取会员统计、目标管理、分组信息、标签会员等数据。
  14. 分销管理：获取付费订单列表。
  15. 订阅消息服务：接收品氪端推送的会员、积分、储值、卡券、商品、库存、订单等变更消息。

配置

  • PK_APPKEY：品氪开放平台分配的 APPKEY，需保密。
  • PK_API_URL：品氪 API 基础 URL，测试环境为 http://dev.openapi.pinkr.com。
  • 正式环境每接口每秒并发数上限默认为 10。

在使用前，请确保已配置以下环境变量：

// 导出APPKEY和API地址
export PK_APPKEY= ${PK_APPKEY} || process.env.PK_APPKEY
export PK_API_URL= process.env.PK_API_URL || "http://dev.openapi.pinkr.com"

使用方式

  1. 在品氪开放平台申请商户号和接口接入 IP 地址。
  2. 开放平台分配接入的 APPKEY。
  3. 使用 POST 请求接口，所有请求均使用 Content-Type: application/json。

数据请求格式

所有接口使用统一的 POST 表单方式提交：

{
  "method": "接口名称",
  "appid": "pinkr",
  "data": "请求数据实体(JSON格式字符串)",
  "v": "1"
}
参数名类型说明
methodstringAPI 接口名称
appidstring商户的 appid
datastring请求数据实体（JSON 格式字符串）
vstringAPI 协议版本，默认为 1

公共响应参数

参数名类型说明
codestring状态码
messagestring信息
datastring数据

状态码

代码说明
200成功
400失败
1001参数非法
1101类不存在
1102方法不存在
1104商户状态未开启
10001APPID 不存在
10002当前 API 未配置
10101请求接口错误
19001订单已存在
19002原订单不存在
19003原订单商品明细不存在
19004不符合拆单条件
20001退单已存在
20002退单不存在
20003退单状态非法

功能概览

功能模块接口名称说明状态
获取快递列表common.express.get获取支持的快递公司列表已完成
上传门店store.upload上传门店基础数据，重复上传覆盖已完成
上传导购guide.upload上传导购基础数据，支持所属门店绑定已完成
上传标签分类tag.category.upload上传标签分类主数据已完成
上传标签tag.tag.upload上传标签主数据已完成
上传会员标签明细tag.memberTag.upload更新品氪端会员的标签明细已完成
获取标签资料tag.tag.get获取商户定义的标签基础资料已完成
获取订单列表order.order.get获取线上订单列表（分页）已完成
获取订单商品明细order.orderGoods.get获取订单商品明细已完成
更新订单发货信息order.delivery.update更改线上订单发货状态已完成
接收第三方订单order.order.add接收第三方商城订单到品氪端已完成
更新订单仓库状态order.storage.updateStatus更改订单仓库提交状态已完成
获取退货退款单refund.returnRefund.get获取退货退款单列表（分页）已完成
更新退货退款状态refund.returnRefund.status.update商家同意退货/已收货等已完成
获取退款单refund.refund.get获取申请退款/退款完成列表（分页）已完成
更新退款状态refund.status.update商家同意退款已完成
接收第三方退货单refund.returnRefund.add接收第三方退货单到品氪端已完成
获取换货单(弃用)exchange.get获取换货单列表（分页）已弃用
更新换货单状态(弃用)exchange.status.update更新换货单状态已弃用
获取仓库清单stock.storageList.get获取需要同步库存的仓库清单已完成
获取商品清单stock.goodsList.get获取需要同步库存的商品清单已完成
批量更新商品库存stock.goodsStock.batchUpdate批量同步商品库存到品氪端已完成
批量获取商品库存warehouse.goodsStock.get批量获取商品库存（分页）已完成
上传商品尺码goods.size.upload上传商品 SKU 绑定的尺码已完成
上传商品颜色goods.color.upload上传商品 SKU 绑定的颜色已完成
上传商品SPU父级属性goods.attributeName.upload上传商品 SPU 父级属性已完成
上传商品SPU子属性goods.attributeValue.upload上传商品 SPU 子属性已完成
上传商品goods.goods.upload上传商品已完成
上传商品价格goods.price.upload上传商品价格（千店千面）已完成
全量上传商品goods.goods.fullUpload全量上传商品（含颜色/尺码/属性自动创建）已完成
获取会员信息member.info.get获取品氪端会员信息已完成
更新会员等级member.level.update更新品氪端会员等级已完成
更新会员信息member.info.update更新品氪端会员信息已完成
新增会员卡member.add第三方会员开卡后同步至品氪已完成
获取品氪会员信息pinkrMember.info.get获取品氪端会员信息（缓存60秒）已完成
新增会员收货地址member.address.add新增会员收货地址已完成
新增会员积分流水integral.add新增会员积分流水已完成
新增会员储值流水deposit.add新增会员储值流水已完成
新增储值卡绑定deposit.card.bind新增会员与储值卡绑定信息已完成
储值卡消息推送deposit.card.sendTemplateMessage储值卡流水变动发送消息开发中
批量核销卡券coupon.status.batchUse批量核销品氪端会员卡券已完成
接收小票sale.order.add同步第三方订单明细到品氪端已完成
获取会员统计data.member.count获取会员相关统计数据已完成
获取目标管理data.target.get获取商户目标管理（销售/开卡目标）已完成
获取会员分组资料data.member.group.groupInfo.get获取会员分组基础资料已完成
获取预设分组类型data.member.group.config.get获取预设会员分组类型已完成
获取分组下会员data.member.group.get获取对应会员分组下的会员已完成
获取标签基础资料data.Tag.get获取商户标签基础资料已完成
获取标签下会员data.Tag.Member.get获取商户标签下的会员已完成
获取付费订单distribution.paidOrder.get获取分销付费订单列表（分页）已完成

前置要求

  • 用户需在品氪开放平台申请商户号并获取 PK_APPKEY。
  • 接入前需在品氪开放平台配置接口接入 IP 地址。
  • 正式环境每接口每秒并发数上限默认为 10。
  • 请求使用 POST 表单方式提交，appid 字段传 pinkr。

接口说明

1. 获取支持的快递列表

  • 功能：获取支持的快递列表
  • 接口名称：common.express.get
  • 请求参数：无
  • 返回数据：
参数名称参数类型参数说明
express_namestring快递公司名称
express_codestring快递公司代码

2. 上传门店

  • 功能：上传门店基础数据，重复上传会覆盖上一次数据
  • 接口名称：store.upload
  • 请求参数：
参数名称参数类型必须参数说明示例值
store_nostring是门店代码
store_namestring是门店名称
addressstring否详细地址
telephonestring是电话号码
business_modelint否经营模式：0 直营店 / 1 联营店 / 2 加盟店

3. 上传导购

  • 功能：上传导购基础数据，重复上传会覆盖上一次数据
  • 接口名称：guide.upload
  • 请求参数：
参数名称参数类型必须参数说明
guide_nostring是导购编号
guide_namestring是导购名称
store_nostring是门店代码
positionint是职位：0 店长 / 1 导购
sexint是性别：1 男 / 2 女
guide_statusint是状态：0 在职 / 2 离职
phonestring否手机号码
entry_datedate否入职日期（格式：2019-03-21）
birthdaydate否生日（格式：2019-03-21）
belonging_storeobject[]否所属的门店
>> store_nostring是门店代码

4. 上传标签分类

  • 功能：上传标签分类主数据
  • 接口名称：tag.category.upload
  • 请求参数：
参数名称参数类型必须参数说明
category_codestring是标签分类代码
category_namestring是标签分类名

5. 上传标签

  • 功能：上传标签主数据
  • 接口名称：tag.tag.upload
  • 请求参数：
参数名称参数类型必须参数说明
category_codestring是标签分类代码
tag_codestring是标签代码
tag_namestring是标签名

6. 上传会员标签明细

  • 功能：更新品氪端会员的标签明细
  • 接口名称：tag.memberTag.upload
  • 请求参数：
参数名称参数类型必须参数说明
card_nostring是品氪端会员唯一识别卡号ID
tagsobject[]是标签数组
tags.*.category_codestring是标签分类代码
tags.*.tag_codestring是标签代码

7. 获取标签资料

  • 功能：获取商户定义的标签基础资料
  • 接口名称：tag.tag.get
  • 请求参数：无
  • 返回数据：
参数名称参数类型参数说明
category_namestring标签分类名（如果为空，则是一级标签分类）
tag_namestring二级标签名

8. 获取订单列表（分页）

  • 功能：获取线上订单列表，被拆单生成的新子订单不会显示
  • 接口名称：order.order.get
  • 请求参数：
参数名称参数类型必须参数说明
order_time_startdatetime否下单开始时间
order_time_enddatetime否下单结束时间
update_time_startdatetime否更新开始时间
update_time_enddatetime否更新结束时间
order_statusstring是订单状态：-2 已拆单 / 1 待发货 / 4 已发货
express_typeint否物流类型：0 自提
order_nosstring否订单号，多个用逗号分隔

返回数据主要字段：

参数名称参数类型参数说明
order_nostring订单号
crm_card_nostringCRM卡号
erp_card_nostringERP卡号
bind_guide_nostring绑定导购编号
bind_store_nostring绑定门店编号
order_moneydecimal订单金额
order_fact_moneydecimal实付金额
customer_pricestring会员折扣优惠金额
coupon_pricedecimal卡券优惠金额
promotion_pricedecimal促销活动优惠金额
bonus_pricedecimal积分抵现优惠金额
postage_pricedecimal运费金额
consume_numberint订单商品数量
order_statusstring订单状态
express_typeint物流类型
express_namestring快递公司名称
express_nostring快递单号
usernamestring收货人
mobilestring收货人手机
order_timedatetime下单时间
pay_timedatetime付款时间
delivery_timedatetime发货时间
paymentsarray[object]支付方式列表

订单金额计算逻辑：order_fact_money = order_money - customer_price - promotion_price - coupon_price - bonus_price + postage_price + wipe_off_price + change_price

9. 获取订单商品明细

  • 功能：获取订单商品明细
  • 接口名称：order.orderGoods.get
  • 请求参数：
参数名称参数类型必须参数说明
order_nostring是订单号

返回数据主要字段：

参数名称参数类型参数说明
order_nostring订单号
order_goodsarray[object]订单商品明细
order_goods.*.goods_snstring商品编号
order_goods.*.goods_namestring商品名称
order_goods.*.sku_codestringSKU代码
order_goods.*.color_codestring颜色代码
order_goods.*.size_codestring尺码代码
order_goods.*.numberint数量
order_goods.*.goods_tag_pricedecimal吊牌单价
order_goods.*.goods_real_pricedecimal现售单价
order_goods.*.goods_fact_moneydecimal商品实付总金额

商品实付单价 = goods_fact_money / number

10. 更新订单发货信息

  • 功能：更改线上订单发货状态
  • 接口名称：order.delivery.update
  • 请求参数：
参数名称参数类型必须参数说明
order_nostring是原订单号
channel_order_nostring是渠道订单号
express_namestring是快递公司名称
express_codestring是快递公司编号
express_nostring是物流单号
is_splitint是是否拆单：0 否
delivery_goodsarray[object]是商品明细

delivery_goods 商品明细：

必须传商品『款 goods_sn、外部编码 sku_code』或『款 goods_sn、色 color_code、码 size_code』参数，两种方式二选一。

参数名称参数类型必须参数说明
goods_snstring是商品编号
color_codestring否颜色代码，与外部编码方式二选一
size_codestring否尺码代码，与外部编码方式二选一
sku_codestring否SKU外部编码，与款色码方式二选一
deliver_storage_codestring是发货仓库编号

11. 接收第三方订单

  • 功能：接收第三方商城订单到品氪端
  • 接口名称：order.order.add
  • 注意事项：
    • 拆单后只传子单，但订单金额、优惠等都需要相应拆分
    • 所属门店代码为第三方商城在品氪的虚拟门店代码
    • 明细的合计金额必须等于主数据的金额，明细的合计数量必须等于主数据的数量
    • 订单金额计算逻辑：order_fact_money = order_money - customer_price - promotion_price - coupon_price - bonus_price + postage_price

请求参数：

参数名称参数类型必须参数说明
channel_order_nostring是第三方单号
channel_delivery_nostring是第三方发货单号（子单号）
sourcestring是来源：douyin 抖音
order_statusstring是订单状态：2 已发货
store_nostring是所属门店代码
guide_nostring否所属导购代码
delivery_store_nostring是发货门店代码
card_nostring否品氪端会员唯一识别卡号
order_mobilestring否下单手机号
channel_card_nostring否渠道卡号
coupon_codesstring[]否优惠券
order_timedatetime否下单时间（Y-m-d H:i:s）
pay_timedatetime否付款时间
delivery_timedatetime否发货时间
finish_timedatetime否完成时间
express_namestring否快递公司名称
express_codestring否快递公司代码
express_nostring否快递单号
usernamestring否收货人
mobilestring否收货人手机
provincestring否省份名称
citystring否城市名称
districtstring否地区名称
addressstring否详细地址
consume_numberint是订单商品数量
order_moneydecimal是订单吊牌总金额
order_fact_moneydecimal是实付金额
customer_pricedecimal否会员折扣优惠金额
coupon_pricedecimal否卡券优惠金额
promotion_pricedecimal否促销活动优惠金额
bonus_pricedecimal否积分抵现优惠金额
postage_pricedecimal否运费金额
remarkstring否备注
goodsobject[]是订单商品明细
>> goods_snstring是商品款号
>> goods_namestring否商品名称
>> sku_codestring否外部SKU代码
>> color_codestring是颜色代码
>> size_codestring是尺码代码
>> numberint是商品数量（退单为负）
>> goods_tag_pricefloat是单个商品吊牌价
>> goods_real_pricefloat是单个商品现售价
>> goods_discountint是商品折扣（0.9代表9折）
>> goods_fact_moneyfloat是总商品实际价
paymentsobject[]是结算方式
>> payment_codestring是支付代码：wechat / alipay / coupon / deposit / integral / cash / union_pay / other
>> amountdecimal是金额

12. 更新订单仓库发货状态

  • 功能：更改订单仓库提交状态
  • 接口名称：order.storage.updateStatus
  • 请求参数：
参数名称参数类型必须参数说明
order_nostring是原订单号
statusstring是状态：0 未转单

13. 获取退货退款单（分页）

  • 功能：获取退货退款单列表
  • 接口名称：refund.returnRefund.get
  • 请求参数：
参数名称参数类型必须参数说明
refund_time_startdatetime否退货单开始时间
refund_time_enddatetime否退货单结束时间
update_time_startdatetime否更新开始时间
update_time_enddatetime否更新结束时间
refund_statusint否退货单状态：0 申请退货 / 1 同意退货
express_typeint否物流类型：0 自提 / 1 快递
refund_nostring否退货单号
order_nosstring否订单号，多个用逗号分隔
refund_typeint否退货类型：1 退货单 / 2 换货单

14. 更新退货退款单状态

  • 功能：商家同意退货、商家已收货
  • 接口名称：refund.returnRefund.status.update
  • 请求参数：
参数名称参数类型必须参数说明
refund_nostring是退款单号
refund_statusint是退款状态：1 同意退货 / 2 关闭退货 / 5 确认收货 / 6 确认退款
return_wechat_moneydecimal否微信支付返还
return_deposit_moneydecimal否储值金额返还
return_deposit_gift_moneydecimal否储值金额赠送返还
usernamestring否收货人（同意退货必填）
mobilestring否手机号（同意退货必填）
addressstring否商家收货地址（同意退货必填）

15. 获取退款单（分页）

  • 功能：获取申请退款（仅退款）、退款完成退款单列表
  • 接口名称：refund.refund.get
  • 请求参数：
参数名称参数类型必须参数说明
refund_time_startdatetime否退单开始时间
refund_time_enddatetime否退单结束时间
update_time_startdatetime否更新开始时间
update_time_enddatetime否更新结束时间
refund_statusint否退款状态：0 申请退款 / 1 同意退款 / 3 退款完成 / 4 退款关闭
refund_nostring否退单号
order_nosstring否订单号，多个用逗号分隔

16. 更新退款状态

  • 功能：商家同意退款
  • 接口名称：refund.status.update
  • 请求参数：
参数名称参数类型必须参数说明
refund_nostring是退款单号
refund_statusint是退款状态：1 同意退款 / 6 确认退款
return_wechat_moneydecimal否微信支付返还
return_deposit_moneydecimal否储值金额返还
return_deposit_gift_moneydecimal否储值金额赠送返还

17. 接收第三方退货单

  • 功能：接收第三方退货单到品氪端
  • 接口名称：refund.returnRefund.add
  • 注意事项：明细的合计金额必须等于主数据的金额，明细的合计数量必须等于主数据的数量
  • 请求参数：
参数名称参数类型必须参数说明
channel_refund_nostring是第三方退货单号
channel_delivery_nostring否第三方发货单号（子单号）
channel_origin_order_nostring否关联第三方订单号
sourcestring是来源：douyin 抖音
refund_statusstring是退单状态：2 顾客退货给商家
card_nostring否品氪端会员唯一识别卡号
channel_card_nostring否渠道卡号
application_timedatetime是申请退货时间
agreement_timedatetime否同意退货时间
delivery_timedatetime是买家退货时间
confirm_timedatetime否确认收货时间
express_namestring是快递公司名称
express_codestring是快递公司代码
express_nostring是快递单号
usernamestring是收货人
mobilestring是收货人手机
provincestring是省份代码（商家收货地址）
citystring是城市代码（商家收货地址）
districtstring是地区代码（商家收货地址）
addressstring是详细地址（商家收货地址）
consume_numberint是订单商品数量
order_moneydecimal是订单吊牌总金额
refund_moneydecimal否退款金额（负数）
refund_bonusint否退款积分
refund_reasonstring否退款原因
goodsobject[]是订单商品明细
>> goods_snstring是商品款号
>> goods_namestring是商品名称
>> sku_codestring是外部SKU代码
>> color_codestring是颜色代码
>> size_codestring是尺码代码
>> numberint是商品数量（负数）
>> goods_refund_moneyfloat是退款金额（负数）

18. 获取仓库清单

  • 功能：获取需要同步商品库存的仓库清单
  • 接口名称：stock.storageList.get
  • 请求参数：无
  • 返回数据：
参数名称参数类型参数说明
storage_codestring仓库代码
storage_namestring仓库名称

19. 获取商品清单

  • 功能：获取需要同步商品库存的商品清单
  • 接口名称：stock.goodsList.get
  • 请求参数：无
  • 返回数据：
参数名称参数类型参数说明
goods_snstring商品代码
goods_namestring商品名称
skusobject[]SKU列表
>> color_codestring颜色代码
>> size_codestring尺码代码
>> sku_codestringSKU代码

20. 批量更新商品库存

  • 功能：批量同步商品库存到品氪端
  • 接口名称：stock.goodsStock.batchUpdate
  • 注意事项：goods_stocks 数组限制数量为 300
  • 请求参数：
参数名称参数类型必须参数说明
is_summaryint否是否汇总仓方式：0 否 / 1 是
goods_stocksobject[]是商品库存数组
>> storage_codestring是仓库代码
>> goods_snstring否商品款号
>> color_codestring否颜色代码
>> size_codestring否尺码代码
>> sku_codestring否外部SKU代码，存在时不取款色码字段
>> stock_numberint是库存数量

21. 批量获取商品库存（分页）

  • 功能：获取品氪端商品库存
  • 接口名称：warehouse.goodsStock.get
  • 请求参数：参数都不传时不做筛选，全部返回
参数名称参数类型必须参数说明
goods_snstring否商品款号代码，多款用逗号分隔
storage_codestring否仓库代码，多个用逗号分隔
change_begin_timedatetime否商品库存变更开始时间
change_end_timedatetime否商品库存变更结束时间

返回数据：

参数名称参数类型参数说明
goods_snstring商品款号
color_codestring颜色代码
size_codestring尺码代码
sku_codestring外部SKU代码
warehouse_codestring仓库代码
stock_numberint库存数量

22. 上传商品尺码

  • 功能：上传商品 SKU 绑定的尺码
  • 接口名称：goods.size.upload
  • 请求参数：
参数名称参数类型必须参数说明
size_codestring是尺码代码
size_namestring是尺码名称
sortint否商城排序，数字越大排序越前

23. 上传商品颜色

  • 功能：上传商品 SKU 绑定的颜色
  • 接口名称：goods.color.upload
  • 请求参数：
参数名称参数类型必须参数说明
color_codestring是颜色代码
color_namestring是颜色名称

24. 上传商品 SPU 父级属性

  • 功能：上传商品 SPU 父级属性
  • 接口名称：goods.attributeName.upload
  • 请求参数：
参数名称参数类型必须参数说明
attribute_namestring是父级属性名称
attribute_name_codestring是父级属性代码

25. 上传商品 SPU 子属性

  • 功能：上传商品 SPU 子属性
  • 接口名称：goods.attributeValue.upload
  • 请求参数：
参数名称参数类型必须参数说明
attribute_name_codestring是父级属性代码
attribute_valuestring是子属性名称
attribute_value_codestring是子属性代码

26. 上传商品

  • 功能：上传商品
  • 接口名称：goods.goods.upload
  • 请求参数：
参数名称参数类型必须参数说明
goods_snstring是商品款号
goods_namestring是商品名称
skusarray是商品SKU对象数组
>> color_codestring是颜色代码
>> size_codestring是尺码代码
>> sku_codestring否SKU代码
>> goods_real_pricestring是商品现售价
>> goods_tag_pricestring是商品吊牌价
>> goods_discountstring是商品折扣
attributesarray否商品属性对象数组
>> attribute_name_codestring是商品父级属性代码
>> attribute_value_codestring是商品子属性代码

27. 上传商品价格（千店千面）

  • 功能：上传商品价格作为千店千面商品价格调价单
  • 接口名称：goods.price.upload
  • 请求参数：
参数名称参数类型必须参数说明
goods_snstring是商品编号
color_codestring否颜色代码，与外部编码方式二选一
size_codestring否尺码代码，与外部编码方式二选一
sku_codestring否SKU外部编码，与款色码方式二选一
store_nostring是门店编号
goods_tag_pricedecimal是商城商品吊牌价
mall_goods_real_pricedecimal是商城商品现售价
goods_discountint是商品折扣，例：9折传90

28. 全量上传商品

  • 功能：全量上传商品，含颜色、尺码、属性基础资料自动创建
  • 接口名称：goods.goods.fullUpload
  • 请求参数：
参数名称参数类型必须参数说明
goods_snstring是商品款号
goods_namestring是商品名称
skusarray是商品SKU对象数组
>> color_codestring是颜色代码
>> color_namestring是颜色名称
>> size_codestring是尺码代码
>> size_namestring是尺码名称
>> sku_codestring否SKU代码
>> goods_real_pricestring是商品现售价
>> goods_tag_pricestring是商品吊牌价
>> goods_discountstring是商品折扣
attributesarray否商品属性对象数组
>> attribute_namestring是商品父级属性名称
>> attribute_name_codestring是商品父级属性代码
>> attribute_valuestring是商品子属性名称
>> attribute_value_codestring是商品子属性代码

29. 获取会员信息

  • 功能：获取品氪端的会员信息
  • 接口名称：member.info.get
  • 请求参数：
参数名称参数类型必须参数说明
card_nostring否，二选一品氪端会员唯一识别卡号ID
mobilestring否，二选一会员手机号

返回数据：

参数名称参数类型参数说明
card_nostring品氪端会员唯一识别卡号ID
customer_namestring会员姓名
ID_cardstring身份证（只对银联商户）
phonestring手机号
remaining_amountfloat用户余额
remaining_bonusfloat用户积分
open_card_store_nostring开卡门店
open_card_timestring开卡时间
bind_guide_nostring绑定导购
is_followedint公众号关注状态：-1 取关

30. 更新会员等级

  • 功能：更新品氪端会员等级
  • 接口名称：member.level.update
  • 请求参数：
参数名称参数类型必须参数说明
card_nostring是品氪端会员唯一识别卡号ID
level_codestring是等级代码

31. 更新会员信息

  • 功能：更新品氪端会员信息
  • 接口名称：member.info.update
  • 请求参数：
参数名称参数类型必填参数说明
card_nostring是品氪端会员唯一识别卡号ID
customer_namestring否会员姓名
sexint否性别：1 男 / 2 女
mobilearray否手机号码
birthdaystring否出生日期（格式：2019-03-06）
channel_card_nostring否第三方会员卡号，品氪端为空时补全
bind_guide_nostring否绑定导购代码

32. 新增会员卡

  • 功能：第三方会员开卡后同步至品氪
  • 接口名称：member.add
  • 注意事项：该会员卡对应积分、储值、小票需通过对应接口上传到品氪
  • 请求参数：
参数名称参数类型必填参数说明
channel_card_nostring是第三方会员唯一识别卡号ID
phonestring是手机号
nameint是会员名称
sexarray是性别：1 男 / 2 女
birthdaystring是生日（格式：2019-03-06）
series_codestring否系列代码
level_codestring是等级代码
bind_store_nostring否绑定门店代码
bind_guide_nostring否绑定导购代码
open_card_store_nostring否开卡门店代码
open_card_guide_nostring否开卡导购代码

返回数据：

参数名称参数类型参数说明
data.card_nostring品氪端会员唯一识别卡号ID

33. 获取品氪会员信息

  • 功能：获取品氪端的会员信息，缓存 60 秒更新一次
  • 接口名称：pinkrMember.info.get
  • 请求参数：
参数名称参数类型必须参数说明
update_time_startdatetime否更新开始时间
update_time_enddatetime否更新结束时间
page_sizeint否每页记录数

返回数据：

参数名称参数类型参数说明
pinkr_card_nostring品氪端会员唯一识别卡号ID
erp_card_nostringERP卡号
customer_namestring会员姓名
open_card_store_nostring开卡门店
open_card_timestring开卡时间
bind_guide_nostring绑定导购
is_followedint公众号关注状态：-1 取关
is_import_activeint是否导入激活：0 否 / 1 是
active_timedatetime激活时间
active_store_nostring激活门店代码
active_guide_nostring激活导购代码

34. 新增会员收货地址

  • 功能：新增会员收货地址
  • 接口名称：member.address.add
  • 请求参数：
参数名称参数类型必填参数说明
card_nostring是品氪端会员唯一识别卡号ID
customer_namestring是收货人姓名
mobilestring是收货人手机号码
province_namestring是收货省份名称
city_namestring是收货市级名称
area_namestring是收货区级名称
addressstring是详细地址

35. 新增会员积分流水

  • 功能：新增会员积分流水
  • 接口名称：integral.add
  • 请求参数：
参数名称参数类型必须参数说明
card_nostring否品氪端会员唯一识别卡号ID
channel_card_nostring否第三方会员卡号
channel_integral_nostring是第三方积分流水唯一标记
integral_codestring是积分来源代码（见下方说明）
integralint是变动积分，新增为正，减少为负
consume_nostring否关联订单号
change_timedatetime是业务发生时间

积分来源代码：

代码说明
order_offline消费新增
order_back退货
order_cancel订单作废
erp_generateERP生成
erp_expireERP积分到期
erp_adjustERP调整
failure_time_out积分过期
consumption_send_bonus单笔消费送积分
stored_amount充值活动
register注册送积分
order_bonus_online订单积分商品
from_openapi来自openapi

36. 新增会员储值流水

  • 功能：新增会员储值流水
  • 接口名称：deposit.add
  • 请求参数：
参数名称参数类型必须参数说明
card_nostring是品氪端会员唯一识别卡号ID
channel_card_nostring否第三方会员卡号
channel_deposit_nostring是第三方储值流水唯一标记
amount_typestring是储值类型：0 充值 / 1 消费
store_nostring否门店代码
guide_nostring否导购代码
amountdecimal是储值金额（正负数，见说明）
gift_amountdecimal是赠送金额
change_timedatetime是业务发生时间

储值金额说明：类型为 0、2、3、5 时为正数，类型为 1、4 时为负数。

37. 新增储值卡绑定

  • 功能：线下售卡绑定，传递储值卡与会员的绑定信息到品氪
  • 接口名称：deposit.card.bind
  • 请求参数：
参数名称参数类型必须参数说明
card_nostring是品氪端会员唯一识别卡号ID
deposited_card_nostring是储值卡号
store_nostring否销售绑定门店代码

38. 批量核销卡券

  • 功能：批量更改品氪端会员卡券状态
  • 接口名称：coupon.status.batchUse
  • 请求参数：
参数名称参数类型必须参数说明
coupon_codesstring[]是券号数组

39. 接收小票

  • 功能：同步第三方订单明细到品氪端
  • 接口名称：sale.order.add
  • 请求参数：
参数名称参数类型必须参数说明
order_nostring是第三方单号
order_typeint是订单类型：0 订单 / 1 退单
origin_order_nostring否原订单号，退单时存在
store_nostring是门店代码
delivery_store_nostring否发货门店
guide_nostring是导购代码
guide_performancesobject[]是导购业绩数组（退单为负）
>> guide_nostring是导购代码
>> performance_moneydecimal是导购业绩
>> numberint是销售件数
card_nostring否品氪端会员唯一识别卡号ID
channel_card_nostring否第三方会员卡号
coupon_codesstring[]否优惠券
order_timedatetime是订单时间
consume_numberint是订单商品数量（退单为负）
order_moneydecimal是订单吊牌总金额（退单为负）
goodsobject[]是订单商品明细
>> goods_snstring是商品款号
>> goods_namestring是商品名称
>> sku_codestring否外部SKU代码
>> color_codestring是颜色代码
>> size_codestring是尺码代码
>> numberint是商品数量（退单为负）
>> goods_tag_pricefloat是单个商品吊牌价
>> goods_real_pricefloat是单个商品现售价
>> goods_discountint是商品折扣（90代表9折）
>> goods_fact_moneyfloat是总商品实际价
paymentsobject[]是结算方式
>> payment_codestring是支付代码：wechat / alipay / coupon / deposit / integral / cash / other
>> codestring否关联代码（如卡券号）
>> amountdecimal是金额

40. 获取会员统计数据

  • 功能：获取会员相关统计数据，默认缓存两个小时
  • 接口名称：data.member.count
  • 请求参数：无
  • 返回数据：
参数名称参数类型参数说明
customer_countint总会员数
followed_customer_countint关注会员数
opened_card_customer_countint开卡会员数
bind_customer_countint绑定会员数
consumed_customer_countint消费会员数
from_erp_customer_countintERP激活会员数

41. 获取商户目标管理

  • 功能：获取商户目标管理，包括销售目标和开卡目标，默认缓存两个小时
  • 接口名称：data.target.get
  • 请求参数：
参数名称参数类型必须参数说明
target_typeint是目标类型：1 销售目标
pageint是分页页数

42. 获取会员分组基础资料

  • 功能：获取会员分组基础资料，缓存时间 1 小时
  • 接口名称：data.member.group.groupInfo.get
  • 请求参数：
参数名称参数类型必须参数说明
typeint是分组类型：0 预设分组

43. 获取预设会员分组类型

  • 功能：获取预设会员分组类型
  • 接口名称：data.member.group.config.get
  • 请求参数：无

44. 获取对应会员分组下的会员

  • 功能：获取对应会员分组下的会员
  • 接口名称：data.member.group.get
  • 请求参数：
参数名称参数类型必须参数说明
group_idint是会员分组 id
config_idint否会员分组类型 id
pageint是分页页数

45. 获取标签基础资料

  • 功能：获取商户标签基础资料，缓存时间 1 小时
  • 接口名称：data.Tag.get
  • 请求参数：
参数名称参数类型必须参数说明
tag_typestring是标签类型：guide_tag 导购打标

46. 获取标签下的会员

  • 功能：获取商户标签下的会员
  • 接口名称：data.Tag.Member.get
  • 请求参数：
参数名称参数类型必须参数说明
tag_idint是标签 id

返回数据：

参数名称参数类型参数说明
card_nosarray会员品氪卡号数组

47. 获取付费订单（分页）

  • 功能：获取分销付费订单列表
  • 接口名称：distribution.paidOrder.get
  • 请求参数：
参数名称参数类型必须参数说明
update_time_startdatetime否更新开始时间
update_time_enddatetime否更新结束时间
distribute_statusint否分销状态：0 冻结期 / -1 不结算全额退款 / -2 不结算仅退款 / 1 待结算 / 2 已结算 / 3 不分佣

订阅消息服务

品氪开放平台提供主动推送服务，包括会员信息、积分、储值、卡券等消息订阅类型。第三方订阅后无需手动轮询调用。

验签算法

  1. 将 appid、appkey、data、method、nonce、timestamp 根据参数名称 ASCII 码表顺序排序，拼接成 query string
  2. 以 MD5(32) 算法计算签名字符串
  3. 对签名字符串所有字符大写化
  4. 将 sign 字段与其他参数一同放在请求中

重推机制

品氪开放平台对推送消息提供每 10 秒 1 次，共三次的重推机制。

订阅消息接口列表

类型接口名称说明
会员-开卡subscribe.member.info.add推送会员信息
会员-变更subscribe.member.info.update推送会员信息变更
会员-标签subscribe.member.tag.change推送会员标签变更
积分subscribe.integral.add推送会员积分流水
储值-流水subscribe.deposit.add推送会员储值流水
储值-卡片subscribe.deposit.card.add推送储值卡
储值-余额变动subscribe.deposit.card.change推送储值卡余额变动
卡券-信息subscribe.coupon.info.add推送卡券信息
卡券-明细subscribe.coupon.detail.add推送卡券明细
卡券-状态变更subscribe.coupon.detail.status.update推送卡券状态变更
商品-尺码subscribe.goods.size.upload推送商品尺码
商品-颜色subscribe.goods.color.upload推送商品颜色
商品-父属性subscribe.goods.attributeName.upload推送商品SPU父级属性
商品-子属性subscribe.goods.attributeValue.upload推送商品SPU子属性
商品-信息subscribe.goods.goods.upload推送商品信息
库存-变动subscribe.stock.goodsStock.change推送商品库存变动
订单-地址变更subscribe.order.address.update推送订单修改收货地址
退单-申请退款subscribe.refund.refund.apply推送申请仅退款

错误处理

错误码说明处理方式
10001APPID 不存在检查 PK_APPKEY 是否正确
10002当前 API 未配置联系品氪开放平台确认接口权限
1001参数非法检查请求参数格式和必填项
1104商户状态未开启联系品氪开放平台确认商户状态
10101请求接口错误检查 method 参数是否正确
网络错误连接超时等重试最多 3 次，仍失败则提示"网络异常，请稍后重试"

配置要求

  • PK_APPKEY：品氪开放平台分配的 APPKEY，需保密。
  • PK_API_URL：品氪 API 基础 URL。
  • 依赖工具：curl（用于发起请求）、jq（用于解析 JSON 响应）。

Comments

Loading comments...