入库委托新建

POST

/api/v1/inbound/create

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{token}}

Content-Type

string

可选

默认值:

application/json

Body 参数application/json

referenceNumber

string

参考单号

必需

参考单号需要是唯一值，可以是内部ERP唯一单号等，入库委托取消后，参考单号不可重复利用

businessCode

string

业务编码

必需

FBWS=仓储服务,FBTS=中转服务,FBRS=退件服务,FBDS=直发服务,FBSS=报废服务,FBPS=打单服务,FBLS=换标服务,FBCS=集运服务

warehouseCode

string

仓库编码

必需

channelCode

string

渠道编码

可选

confirmFlag

boolean

确认标识

必需

true=自动确认,false=手动确认(入库委托创建成功后，需要登录OMS系统手动确认)

remark

string

备注

可选

sender

object

发件信息

可选

name

string

姓名

必需

tag

string

标签

可选

Commercial=商业，Residential=住宅

company

string

公司

可选

phone

string

电话

必需

string

邮箱

可选

country

string

国家/地区

必需

province

string

省/州

必需

city

string

城市

必需

county

string

区/县

可选

address1

string

地址1

必需

address2

string

地址2

可选

address3

string

地址3(门牌号)

可选

zipCode

string

邮编

必需

packages

array [object {9}]

包裹信息

必需

packageIndex

integer

包裹序号

可选

packageWeight

integer

包裹重量

可选

packageLength

integer

包裹长度

可选

packageWidth

integer

包裹宽度

可选

packageHeight

integer

包裹高度

可选

originalNumber

string

原始单号

可选

对应客户原始包裹单号/原始分箱单号，不可重复

trackNumber

string

跟踪单号

可选

remark

string

备注

可选

products

array [object {6}]

产品信息

可选

示例

{
    "referenceNumber": "CG201014007-A78",
    "businessCode": "FBWS",
    "warehouseCode": "USNJ",
    "channelCode": "",
    "confirmFlag": true,
    "remark": "",
    "sender": {
        "name": "",
        "tag": "",
        "company": "",
        "phone": "",
        "email": "",
        "countryCode": "",
        "country": "",
        "provinceCode": "",
        "province": "",
        "city": "",
        "county": "",
        "address1": "",
        "address2": "",
        "address3": "",
        "zipCode": ""
    },
    "packages": [
        {
            "packageIndex": 1,
            "packageWeight": 10,
            "packageLength": 30,
            "packageWidth": 25,
            "packageHeight": 22,
            "originalNumber": "CG201014007-A78*001",
            "trackNumber": "",
            "remark": "",
            "products": [
                {
                    "productIndex": 1,
                    "productSku": "TEST-SKU-001",
                    "productFnsku": "TEST-SKU-001",
                    "productQuantity": 20,
                    "unitPrice": 10,
                    "currencyCode": "USD"
                }
            ]
        },
        {
            "packageIndex": 2,
            "packageWeight": 10,
            "packageLength": 30,
            "packageWidth": 25,
            "packageHeight": 22,
            "packageNumber": "CG201014007-A78*002",
            "trackNumber": "",
            "remark": "",
            "products": [
                {
                    "productIndex": 1,
                    "productSku": "TEST-SKU-001",
                    "productFnsku": "TEST-SKU-001",
                    "productQuantity": 20,
                    "unitPrice": 10,
                    "currencyCode": "USD"
                }
            ]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://webapi.fulfillment.keythus.com/api/v1/inbound/create' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referenceNumber": "CG201014007-A78",
    "businessCode": "FBWS",
    "warehouseCode": "USNJ",
    "channelCode": "",
    "confirmFlag": true,
    "remark": "",
    "sender": {
        "name": "",
        "tag": "",
        "company": "",
        "phone": "",
        "email": "",
        "countryCode": "",
        "country": "",
        "provinceCode": "",
        "province": "",
        "city": "",
        "county": "",
        "address1": "",
        "address2": "",
        "address3": "",
        "zipCode": ""
    },
    "packages": [
        {
            "packageIndex": 1,
            "packageWeight": 10,
            "packageLength": 30,
            "packageWidth": 25,
            "packageHeight": 22,
            "originalNumber": "CG201014007-A78*001",
            "trackNumber": "",
            "remark": "",
            "products": [
                {
                    "productIndex": 1,
                    "productSku": "TEST-SKU-001",
                    "productFnsku": "TEST-SKU-001",
                    "productQuantity": 20,
                    "unitPrice": 10,
                    "currencyCode": "USD"
                }
            ]
        },
        {
            "packageIndex": 2,
            "packageWeight": 10,
            "packageLength": 30,
            "packageWidth": 25,
            "packageHeight": 22,
            "packageNumber": "CG201014007-A78*002",
            "trackNumber": "",
            "remark": "",
            "products": [
                {
                    "productIndex": 1,
                    "productSku": "TEST-SKU-001",
                    "productFnsku": "TEST-SKU-001",
                    "productQuantity": 20,
                    "unitPrice": 10,
                    "currencyCode": "USD"
                }
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

success

boolean

成功标识

必需

code

integer

编码

必需

msg

string

消息

必需

language

string

语言

必需

data

string

数据

必需

内部单号

示例

成功示例异常示例

{
    "success": true,
    "code": 0,
    "msg": "成功",
    "language": "ZH",
    "data": "IC20091300001"
}

修改于 2025-01-14 09:02:30

批量库存查询

入库委托取消