1. 采购单模块API
API URL
post {HTTP(S)地址}/api/{version}/purchase
1.1. 采购单查询接口
1.1.1. SERVICE_TYPE
QUERY_PURCHASE_ORDER_LIST
1.1.2. 请求参数
参数 | 是否必须 | 类型 | 示例 | |
---|---|---|---|---|
purchaseNumber | N | String | P210819125115 | 采购单号,最大50个字符 |
customNumber | N | String | 210819125115 | 参考单号 |
status | N | String | NEW | 采购单状态 |
updateTimeFrom | N | String | 2021-08-31 | 更新时间(范围开始) |
updateTimeTo | N | String | 2021-08-31 | 更新时间(范围结束) |
page | Y | Number | 1 | 页码,默认1 |
pageSize | Y | Number | 100 | 每页条数.不超过200条; |
1.1.3. 返回参数
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码](commons/errors.md#_错误码) |
errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
state | Y | String | success | 请求结果 |
total | Y | Number | 100 | 总条数 |
result | Y | List | 详见PurchaseOrder |
PurchaseOrder(采购订单)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
purchaseNumber | Y | String | P210819125115 | 采购单号 |
asnNumber | Y | String | A210819125116 | 入库单号 |
customNumber | Y | String | 自定义参考号 | 参考号 |
warehouseName | Y | String | 采购仓 | 采购仓 |
transferWarehouseName | Y | String | 中转仓 | 中转仓 |
purchaseType | Y | String | TRANSFER | TRANSFER:海外仓采购 DIRECT:国内仓采购 |
supplierName | Y | String | 供应商 | 供应商 |
settlementType | Y | String | DELIVERY_ON_CASH | 结算方式 DELIVERY_ON_CASH:带款提货 FIXED_ACCOUNT_PERIOD:固定账期 DYNAMIC_ACCOUNT_PERIOD:动态账期 |
prepayRate | Y | Decimal | 30 | 预付比例百分比 30表示30% |
purchasePriceUnit | Y | String | CNY | 币种 |
paymentType | Y | Enum | CASH | 支付方式 CASH:现金 TRANSFER:转账 |
shippingCost | Y | Decimal | 1.0 | 运费 |
transportMode | Y | Enum | SELF | 运输方式 SELF:自提 EXPRESS:快递 LOGISTICS:物流 DELIVERY:送货 |
buyerTitle | Y | String | 张三 | 买方抬头 |
companyName | Y | String | 张三有限公司 | 公司抬头 |
transportParty | Y | String | SUPPLIER | 运输承担方 SUPPLIER:供应商 PURCHASER:采购方 |
createTime | Y | String | 2021-08-01 00:00:00 | 创建时间 |
updateTime | Y | String | 2021-08-01 00:00:00 | 更新时间 |
orderTime | N | String | 2021-08-01 00:00:00 | 下单时间 |
preReceiveTime | Y | String | 2021-08-02 00:00:00 | 预计到货日期 |
status | Y | String | NEW | 采购单状态 |
purchaseMode | Y | String | STANDARD | 采购模式 EASYWAY:简单模式 STANDARD:标准模式 |
remark | Y | String | 这是一段备注 | 备注 |
skuList | Y | List | 详见 PurchaseOrderSku |
PurchaseOrderSku 采购订单商品
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
sku | Y | String | SKU001 | 商品SKU |
title | Y | String | This a good title | 商品名称 |
purchasePrice | Y | Decimal | 998 | 采购价格 |
purchaseQuantity | Y | Number | 1 | 采购数量 |
packSpecification | Y | Number | 5 | 装箱率 |
taxRate | Y | Decimal | 0.1 | 采购税率 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/purchase' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_PURCHASE_ORDER_LIST"' \
--form 'bizParam="{
\"page\": 1,
\"pageSize\":3
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="c45cc9116eda46ae8dc4bc5cb016a6e0"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"companyName\":\"X跨境电商公司\",\"createTime\":\"2025-09-09 15:07:51\",\"isDeleted\":0,\"paymentType\":\"CASH\",\"prepayRate\":20.0000,\"purchaseDate\":1757376000000,\"purchaseMode\":\"EASYWAY\",\"purchaseNumber\":\"P250909149499\",\"purchasePriceUnit\":\"CNY\",\"purchaseType\":\"DIRECT\",\"settlementType\":\"DELIVERY_ON_CASH\",\"shippingCost\":0.0000,\"skuList\":[{\"purchasePrice\":10.0000,\"purchaseQuantity\":1,\"sku\":\"hmsku090901-2\",\"taxRate\":1.00,\"title\":\"黑咪测展示商品-2\"},{\"purchasePrice\":10.0000,\"purchaseQuantity\":1,\"sku\":\"hmsku090901-1\",\"taxRate\":1.00,\"title\":\"黑咪测展示商品-1\"}],\"status\":\"NEW\",\"supplierName\":\"supplier\",\"transferWarehouseName\":\"\",\"transportParty\":\"SUPPLIER\",\"updateTime\":\"2025-09-09 15:07:51\",\"warehouseName\":\"best warehouse(测试用)\"},{\"accountPeriodOpt\":\"MONTHLY\",\"asnNumber\":\"A250904149344\",\"billingDate\":5,\"companyName\":\"X跨境电商公司\",\"createTime\":\"2025-09-04 17:14:17\",\"effectiveNode\":\"RECEIVE\",\"isDeleted\":0,\"orderTime\":1756977290000,\"paymentType\":\"CASH\",\"prepayRate\":0.0000,\"purchaseDate\":1756944000000,\"purchaseMode\":\"EASYWAY\",\"purchaseNumber\":\"P250904149343\",\"purchasePriceUnit\":\"CAD\",\"purchaseType\":\"DIRECT\",\"remark\":\"测试9.4\",\"settlementType\":\"FIXED_ACCOUNT_PERIOD\",\"shippingCost\":0.0000,\"skuList\":[{\"purchasePrice\":0.0000,\"purchaseQuantity\":1,\"sku\":\"test leo\",\"taxRate\":0.00,\"title\":\"测试leo\"}],\"status\":\"ORDERED\",\"supplierName\":\"test供应商权限001\",\"transferWarehouseName\":\"\",\"transportParty\":\"SUPPLIER\",\"updateTime\":\"2025-09-04 17:14:50\",\"warehouseName\":\"best warehouse(测试用)\"},{\"asnNumber\":\"A250904149342\",\"companyName\":\"X跨境电商公司\",\"createTime\":\"2025-09-04 17:11:33\",\"customNumber\":\"\",\"isDeleted\":0,\"orderTime\":1756977116000,\"paymentType\":\"CASH\",\"preReceiveTime\":\"2025-10-04 08:00:00\",\"prepayRate\":20.0000,\"purchaseDate\":1754265600000,\"purchaseMode\":\"EASYWAY\",\"purchaseNumber\":\"P250904149340\",\"purchasePriceUnit\":\"CNY\",\"purchaseType\":\"DIRECT\",\"remark\":\"测试备注123\",\"settlementType\":\"DELIVERY_ON_CASH\",\"shippingCost\":0.0000,\"skuList\":[{\"packSpecification\":12,\"purchasePrice\":11.2300,\"purchaseQuantity\":1,\"sku\":\"070101\",\"taxRate\":0.00,\"title\":\"测试申报商品我\"}],\"status\":\"ORDERED\",\"supplierName\":\"supplier\",\"trackingNumber\":\"202509040003\",\"transferWarehouseName\":\"\",\"transportParty\":\"SUPPLIER\",\"updateTime\":\"2025-09-04 17:12:44\",\"warehouseName\":\"jst-test\"}],\"state\":\"success\",\"total\":2934}",
"requestId": "aad05dc0-c890-4dbc-8f6b-1b8d9ca4a36f"
}
1.2. 采购单创建/更新接口
1.2.1. SERVICE_TYPE
CREATE_PURCHASE_ORDER
1.2.2. 请求参数
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
purchaseNumber | N | String | PO223412451 | 采购单号,如果是更新采购单(isUpdate=true)则必填,否则不要填 |
isUpdate | N | Boolean | false | 是否是更新采购订单,默认false |
purchaseType | Y | String | DIRECT/TRANSFER | 采购类型,见枚举 |
customNumber | N | String | Xxxx111 | 参考号 |
warehouseName | Y | String | 采购仓名称 | 采购仓库名称 |
transferWarehouseName | N | String | 中转仓库名称(purchaseType=TRANSFER时必填) | 中转仓库名称 |
purchaserName | Y | String | 采购员用户名(非姓名) | 采购员名称 |
purchaseDate | Y | String | 2022-01-01 | 创建时间 |
preReceiveTime | N | String | 2022-01-01 | 预计到货时间 |
purchasePriceUnit | Y | String | CNY | 币种,见枚举 |
shippingCost | N | BigDecimal | 100.00 | 运费 |
companyName | N | String | Xxx111 | 公司抬头 |
buyerTitle | N | String | Xxx111 | 买方抬头 |
transportParty | Y | String | SUPPLIER | 运输承担方,见枚举 |
transportMode | Y | String | SELF | 运输方式,见枚举 |
trackingNumber | N | String | Xxx111 | 跟踪号 |
remark | N | String | Xxx111 | 备注 |
supplierName | Y | String | 供应商名称 | 供应商名称 |
paymentType | Y | String | CASH | 支付方式,见枚举 |
settlementType | Y | String | DELIVERY_ON_CASH | 结算方式,见枚举 |
prepayRate | N | BigDecimal | 15 | 预付比例 |
effectiveNode | N | String | RECEIVE | 当选择的结算方式是非带货提款方式时,DELIVERY_ON_CASH 时,参数必传,见枚举 |
accountPeriodList | N | String | [{"days":"1","percent":50},{"days":"2","percent":35}] | 当选择的结算方式是动态账期DYNAMIC_ACCOUNT_PERIOD时,参数必传。Percent+预付比例需要是100 |
accountPeriodOpt | N | String | MONTHLY | 当选择的结算方式是固定账期FIXED_ACCOUNT_PERIOD 时,参数必传。 |
billingDate | N | Long | 20 | 当选择的结算方式是固定账期FIXED_ACCOUNT_PERIOD 时,参数必传。范围1<=param<=31 |
skuList | Y | List< PurchaseOrderSku> | 采购单sku | |
purchaseExtVO | N | purchaseExtVO | 1688扩展字段,见purchaseExtVO |
PurchaseOrderSku(采购单商品列表)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
sku | Y | String | S90 | 商品sku |
purchasePrice | Y | BigDecimal | 100.00 | 商品采购价格 |
purchasePriceUnit | Y | String | CNY | 采购价币种 |
purchaseQuantity | Y | Long | 100 | 采购数量 |
remark | N | String | This is remark! | 采购备注 |
taxRate | Y | BigDecimal | 0 | 采购税率 |
purchaseExtVO(1688对象)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
open1688AccountName | Y | String | 1688下单账号 | 1688下单账号 |
open1688Address | Y | String | 1688 收货地址 | 1688 收货地址 |
open1688BuyerMsg | N | String | 买家留言 | 买家留言 |
open1688OrderType | Y | String | general | 1688订单类型,见枚举 |
open1688TradeType | N | String | FXASSURE | 交易方式,见枚举 |
1.2.3. 返回参数
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码](commons/errors.md#_错误码) |
errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
state | Y | String | success | 请求结果 |
total | Y | Number | 100 | 总条数 |
result | Y | Object | 详见PurchaseOrder |
PurchaseOrder(采购订单)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
purchaseNumber | Y | String | P210819125115 | 采购单号 |
warehouseName | Y | String | 采购仓 | 采购仓 |
transferWarehouseName | Y | String | 中转仓 | 中转仓 |
supplierName | Y | String | 供应商 | 供应商 |
purchasePriceUnit | Y | String | CNY | 币种 |
skuList | Y | List | 详见 PurchaseOrderSku |
PurchaseOrderSku(采购单商品列表)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
sku | Y | String | S90 | 商品sku |
purchasePrice | Y | BigDecimal | 100.00 | 商品采购价格 |
purchasePriceUnit | Y | String | CNY | 采购价币种 |
purchaseQuantity | Y | Long | 100 | 采购数量 |
taxRate | Y | BigDecimal | 0 | 采购税率 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/purchase' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_PURCHASE_ORDER_LIST"' \
--form 'bizParam="{
\"page\": 1,
\"pageSize\":3
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="c45cc9116eda46ae8dc4bc5cb016a6e0"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"companyName\":\"X跨境电商公司\",\"createTime\":\"2025-09-09 15:07:51\",\"isDeleted\":0,\"paymentType\":\"CASH\",\"prepayRate\":20.0000,\"purchaseDate\":1757376000000,\"purchaseMode\":\"EASYWAY\",\"purchaseNumber\":\"P250909149499\",\"purchasePriceUnit\":\"CNY\",\"purchaseType\":\"DIRECT\",\"settlementType\":\"DELIVERY_ON_CASH\",\"shippingCost\":0.0000,\"skuList\":[{\"purchasePrice\":10.0000,\"purchaseQuantity\":1,\"sku\":\"hmsku090901-2\",\"taxRate\":1.00,\"title\":\"黑咪测展示商品-2\"},{\"purchasePrice\":10.0000,\"purchaseQuantity\":1,\"sku\":\"hmsku090901-1\",\"taxRate\":1.00,\"title\":\"黑咪测展示商品-1\"}],\"status\":\"NEW\",\"supplierName\":\"supplier\",\"transferWarehouseName\":\"\",\"transportParty\":\"SUPPLIER\",\"updateTime\":\"2025-09-09 15:07:51\",\"warehouseName\":\"best warehouse(测试用)\"},{\"accountPeriodOpt\":\"MONTHLY\",\"asnNumber\":\"A250904149344\",\"billingDate\":5,\"companyName\":\"X跨境电商公司\",\"createTime\":\"2025-09-04 17:14:17\",\"effectiveNode\":\"RECEIVE\",\"isDeleted\":0,\"orderTime\":1756977290000,\"paymentType\":\"CASH\",\"prepayRate\":0.0000,\"purchaseDate\":1756944000000,\"purchaseMode\":\"EASYWAY\",\"purchaseNumber\":\"P250904149343\",\"purchasePriceUnit\":\"CAD\",\"purchaseType\":\"DIRECT\",\"remark\":\"测试9.4\",\"settlementType\":\"FIXED_ACCOUNT_PERIOD\",\"shippingCost\":0.0000,\"skuList\":[{\"purchasePrice\":0.0000,\"purchaseQuantity\":1,\"sku\":\"test leo\",\"taxRate\":0.00,\"title\":\"测试leo\"}],\"status\":\"ORDERED\",\"supplierName\":\"test供应商权限001\",\"transferWarehouseName\":\"\",\"transportParty\":\"SUPPLIER\",\"updateTime\":\"2025-09-04 17:14:50\",\"warehouseName\":\"best warehouse(测试用)\"},{\"asnNumber\":\"A250904149342\",\"companyName\":\"X跨境电商公司\",\"createTime\":\"2025-09-04 17:11:33\",\"customNumber\":\"\",\"isDeleted\":0,\"orderTime\":1756977116000,\"paymentType\":\"CASH\",\"preReceiveTime\":\"2025-10-04 08:00:00\",\"prepayRate\":20.0000,\"purchaseDate\":1754265600000,\"purchaseMode\":\"EASYWAY\",\"purchaseNumber\":\"P250904149340\",\"purchasePriceUnit\":\"CNY\",\"purchaseType\":\"DIRECT\",\"remark\":\"测试备注123\",\"settlementType\":\"DELIVERY_ON_CASH\",\"shippingCost\":0.0000,\"skuList\":[{\"packSpecification\":12,\"purchasePrice\":11.2300,\"purchaseQuantity\":1,\"sku\":\"070101\",\"taxRate\":0.00,\"title\":\"测试申报商品我\"}],\"status\":\"ORDERED\",\"supplierName\":\"supplier\",\"trackingNumber\":\"202509040003\",\"transferWarehouseName\":\"\",\"transportParty\":\"SUPPLIER\",\"updateTime\":\"2025-09-04 17:12:44\",\"warehouseName\":\"jst-test\"}],\"state\":\"success\",\"total\":2934}",
"requestId": "aad05dc0-c890-4dbc-8f6b-1b8d9ca4a36f"
}
1.3. 采购计划查询接口
1.3.1. SERVICE_TYPE
QUERY_PURCHASE_PLAN_LIST
1.3.2. 请求参数
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
statusList | N | List |
["NEW","AUDIT"] | 采购计划,见枚举 |
createTimeFrom | N | String | 格式:yyyy-MM-dd HH:mm:ss,例如:2021-08-01 00:00:00 | 创建时间(范围开始) |
createTimeTo | N | String | 格式:yyyy-MM-dd HH:mm:ss,例如:2021-08-01 23:00:00 | 创建时间(范围结束) |
supplierName | N | String | suppA | 供应商名称,精确查询 |
warehouseName | N | String | 菜鸟仓 | 采购仓库名称,精确查询 |
sku | N | String | SKU001 | 商品sku,精确查询 |
title | N | String | 100 | 商品名称,精确查询 |
planNumber | N | String | PP250522334336 | 采购计划单号 |
purchaseNumber | N | String | P210819125115 | 采购单号 |
page | Y | Number | 1 | 页码,默认1 |
pageSize | Y | Number | 100 | 每页条数,不超过200条 |
1.3.3. 返回参数
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
status | Y | String | AUDIT | 采购计划,见枚举 |
planNumber | Y | String | PP250522334336 | 采购计划单号 |
purchaseNumberList | N | List |
["P211119126531"] | 采购单号列表 |
createTime | Y | String | 格式:yyyy-MM-dd HH:mm:ss,例如:2021-08-01 00:00:00 | 创建时间 |
updateTime | Y | String | 格式:yyyy-MM-dd HH:mm:ss,例如:2021-08-01 23:00:00 | 更新时间 |
totalActualQuantity | Y | Number | 0 | 实际采购量 |
totalPlanQuantity | Y | Number | 100 | 计划采购量 |
purchasePlanSkuList | Y | List | 详见 采购计划商品类 | 采购计划商品列表 |
采购计划商品类
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
sku | Y | String | SKU001 | 商品sku |
title | Y | String | This a good title | 商品名称 |
actualQuantity | Y | Number | 0 | 实际采购量 |
planQuantity | Y | Number | 100 | 计划采购量 |
warehouseName | N | String | 越南仓 | 采购仓库 |
supplierName | N | String | 供应商 | 供应商名称 |
displayStatus | N | String | NO_ORDER | 采购单状态,见枚举 |
remark | N | String | 备注 | 备注 |
planDate | N | String | 格式:yyyy-MM-dd,例如:2021-08-01 | 计划交期时间 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/purchase' \
--form 'appId="TEST"' \
--form 'serviceType="CREATE_PURCHASE_ORDER"' \
--form 'bizParam="{
\"purchaseType\": \"DIRECT\",
\"warehouseName\":\"best warehouse(测试用)\",
\"purchaserName\":\"test主账号\",
\"purchaseDate\":\"2025-09-10\",
\"purchasePriceUnit\":\"CNY\",
\"transportParty\":\"SUPPLIER\",
\"transportMode\":\"SELF\",
\"supplierName\":\"supplier\",
\"paymentType\":\"CASH\",
\"settlementType\":\"DELIVERY_ON_CASH\",
\"skuList\":[{
\"sku\":\"sea003\",
\"purchasePrice\":10,
\"purchasePriceUnit\":\"CNY\",
\"purchaseQuantity\":1,
\"taxRate\":0.1
}]
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="4d0646b8f6875144f987f1a2b579cf57"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"errorMsg\":\"采购员不存在,请先到【系统-用户管理】处添加\",\"notSuccess\":true,\"state\":\"failure\"}",
"requestId": "653708f2-4cd6-4832-85e2-74997b4b3bf9"
}