1.1. 入库单查询接口
post {HTTP(S)地址}/api/{version}/asn
1.1.1. SERVICE_TYPE
QUERY_ASN_LIST
1.1.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| warehouseName | N | String | 马来仓库 | 仓库名称 |
| type | N | String | PURCHASE | 入库单类型，见枚举 |
| status | N | String | NEW | 入库单状态，见枚举 |
| tag | N | AsnTag(Object) | 下发状态对象，见AsnTag | |
| skuKeyWord | N | String | S90/花露水 | 多字段检索，商品sku/名称 |
| number | N | String | 2011asd | 多字段检索，入库单号，业务单号，参考号 |
| trackNumber | N | String | 2011asd | 跟踪号 |
| page | Y | Number | 1 | 页码，默认1 |
| pageSize | Y | Number | 100 | 每页条数.不超过200条; 默认100 |
| timeType | N | String | CREATE_TIME timeFrom、timeEnd、timeType任一字段有值其余字段必须有值 | 时间类型: 创建时间CREATE_TIME、 入库时间STOCK_IN_TIME、 完成时间FINISH_TIME、 更新时间UPDATE_TIME |
| timeFrom | N | String | 2022-09-26 | 开始日期 |
| timeEnd | N | String | 2022-09-26 | 结束日期 |
AsnTag(入库单下发状态)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| sendWms | N | int | 1 | 已下发 |
| sendFailed | N | int | 1 | 下发失败 |
| receiveException | N | int | 1 | 收货异常 |
1.1.3. 返回参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码 |
| errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
| state | Y | String | success | 请求结果 |
| total | Y | Number | 100 | 总条数 |
| result | Y | List<Asn> | 详见 Asn |
Asn(入库单)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| asnNumber | Y | String | A20220905 | 入库单号 |
| businessNumber | Y | String | B20220905 | 业务单号 |
| customNumber | N | String | C20220905 | 参考号 |
| trackNumber | N | String | T20220905 | 跟踪号 |
| warehouseName | Y | String | 马来仓库 | 收货仓库名称 |
| type | Y | String | PURCHASE | 入库单类型见枚举 |
| status | Y | String | NEW | 入库单状态见枚举 |
| remark | N | String | Quick | 备注 |
| createTime | Y | String | 2022-09-05 15:27:18 | 创建时间 |
| updateTime | N | String | 2022-09-05 15:27:18 | 修改时间 |
| stockInTime | N | String | 2022-09-05 15:27:18 | 最近入库时间 |
| finishTime | N | String | 2022-09-05 15:27:18 | 完成时间 |
| purchasePriceCurrency | Y | String | CNY | 采购价币种，见枚举 |
| firstLegPriceCurrency | Y | String | CNY | 头程费用币种，见枚举 |
| transferPriceCurrency | Y | String | CNY | 调拨费用币种，见枚举 |
| asnSkuVOList | Y | List<AsnSku> | 见AsnSku | |
| asnCustomFieldValueVOList | N | List<SkuCustomFieldValueVO> |
SkuCustomFieldValueVO(自定义栏位信息)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| tableName | Y | String | SYS_ITEM | SYS_ITEM：系统商品自定义栏位； SYS_ORDER：订单自定义栏位； SYS_ODO：出库单自定义栏位； SYS_ASN：入库单自定义栏位。 |
| columType | Y | String | NUMBER | 筛选不同填入类型的自定义栏位 NUMBER：数字； DATE：日期； STRING：字符串； SELECT：下拉框。 |
| columName | Y | String | 生产日期 | 用户自己定义的栏位名称 |
| defaultValue | N | String | "1970/01/01"(无双引号) | 自定义栏位默认值 |
| candidateValue | N | String | ["1970/01/01","1970/01/02"] | 下拉框的候选值 |
| remark | N | String | 上架日期区分于出厂日期 | 备注 |
| required | N | Integer | 1 | 是否只查询必填栏位 1:true;0:false |
| isQuery | N | Integer | 1 | 是否只查询支持查询的栏位 1:true;0:false |
| isShow | N | Integer | 1 | 是否只查询支持列配置的栏位 1:true;0:false |
AsnSku(入库单商品)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| sku | Y | String | S90 | 商品sku |
| title | Y | String | 商品标题 | 商品标题 |
| purchasePrice | Y | BigDecimal | 100.0000 | 采购价，4位小数 |
| firstLegPrice | Y | BigDecimal | 100.00 | 头程费用，2位小数 |
| transferPrice | Y | BigDecimal | 100.0000 | 调拨费用，4位小数 |
| expectQuantity | Y | Long | 100 | 采购数量 |
| receiveQuantity | Y | Long | 10 | 已收数量 |
| goodNum | Y | Long | 10 | 良品数量 |
| damageNum | Y | Long | 0 | 不良品数量 |
1.2. 入库单创建接口
1.2.1. SERVICE_TYPE
CREATE_ASN_ORDER
1.2.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| warehouseName | Y | String | 马来仓库 | 仓库名称 |
| customNumber | N | String | C20220905 | 参考号(无值: 可重复创建入库单， 有值: 通过该值绑定入库单号保证唯一性) |
| trackNumber | N | String | T20220905 | 跟踪号 |
| remark | N | String | Quick | 备注 |
| purchasePriceCurrency | Y | String | CNY | 采购价币种，见枚举 |
| firstLegPriceCurrency | Y | String | CNY | 头程费用币种，见枚举 |
| transferPriceCurrency | Y | String | CNY | 调拨费用币种，见枚举 |
| asnSkuVOList | Y | List<AsnSku> | 见AsnSku | |
| sendWarehouseFlag | N | String | Y | 是否下发仓库。（Y：下发，空值或N：不下发。不区分大小写） |
| preArriveTime | N | Date | 预计到货时间 | |
| shippingType | N | String | 01 | 运输方式 可选值如下：01（海运）、02（空运）、03（快递）、04（陆运）、05（专车）、06（铁运）、07（字体）、08（其他） 传数字代码 |
| containerModel | N | String | 20DC | 集装箱柜型 可选值如下：20’, 20DC, 20FR, 20GP, 20HQ, 20OT, 40‘, 40DC, 40FR, 40GOH, 40HC, 40HQ, 40HR, 40OT, 40RQ, 45‘, 45HC, 45HQ, 53HQ, 53 DRY VAN, 40GP, 45GP |
| packageType | N | String | ASSEMBLY | 产品装箱方式 可选值如下：ASSEMBLY（整装）、MIXING（混装） |
| boxCount | N | Int | 5 | 总箱数 |
| type | N | String | SALE_RETURN | 入库单类型见枚举 |
| asnCustomFieldValueVOList | N | SkuCustomFieldValueVO | ||
| AsnSku(入库单商品) |
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| sku | Y | String | S90 | 商品sku |
| purchasePrice | Y | BigDecimal | 100.0000 | 采购价，4位小数 |
| firstLegPrice | Y | BigDecimal | 100.00 | 头程费用，2位小数 |
| transferPrice | Y | BigDecimal | 100.0000 | 调拨费用，4位小数 |
| expectQuantity | Y | Long | 100 | 采购数量 |
| perBoxQuantity | N | Int | 3 | 箱规 |
| apiCustom | N | String |
SkuCustomFieldValueVO(自定义栏位)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| customFieldId | Y | Long | 3 | SERVICE_TYPE中的CUSTOMER_FIELD_QUERY接口返回的id |
| value | Y | String | “张三” | 自定义栏位对应的值 |
1.3. 入库单取消接口
1.3.1. SERVICE_TYPE
1.3.2. CANCEL_ASN_ORDER
1.3.3. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| asnNumber | Y | String | 入库单号 | A230109129883 |
1.3.4. 返回参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码 |
| errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
| state | Y | String | success | 请求结果 |
1.4. 入库反馈推送接口
1.4.1. SERVICE_TYPE
1.4.2. PUSH_ASN_ORDER
1.4.3. 推送消息内容
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| asnNumber | Y | String | “A230109129883” | 入库单号 |
| trackNumber | N | String | 跟踪单号 | |
| skuList | Y | List<Sku> | Sku收货数据 | |
| status | Y | String | 入库单状态 FINISHED 已完成 CLOSED 已关闭 | |
| finishedTime | Y | Date | 入库单完成时间条件必传，仅当status=FINISHED时传值 | |
| customNumber | N | String | 参考号 |
Sku
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| quantity | Y | Number | 100 | 收货数量 |
| sku | Y | String | Sku | 商品sku |