order-create

创建订单(terminus.wms.outbound.order.create)

业务场景：

创建Shippergrid订单用于三方用户进行打单履约

系统入参：

参数名称	类型	是否必填	说明
channelCode	String	是	请传入固定参数【SHIPPER_GRID】，参考请求示例

业务入参

参数名称	类型	是否必填	说明
outBoundOrderCode	String	是	出库单号
shippingCode	String	否	物流商编码目前支持USPS、UPS、FedEx GOFO、YWE
distributionType	String	是	配送类型必填 GCWL表示使用平台物流进行打单 KLWL_ZT表示已经购买过面单distributionType=KLWL_ZT时必须传入物流单号、面单url、物流商
trackingNumber	String	否	物流单号
labelUrl	String	否	可访问的面单地址格式必须为pdf 备注：如果传入面单url则ShipperGrid平台不会再次购买面单且面单发货地址必须和仓相同，当labelUrl不为空的时候shippingCode和trackingNumber必填
docTime	LocalDateTime	否	购买面单时间
platform	String	否	订单来源平台如：TIKTOK、TEMU、SHEIN、SHOPIFY AMAZON
platformOrderCode	String	否	订单来源平台订单号
platformShopId	String	否	订单来源店铺ID
lastDeliverTime	LocalDateTime	否	最晚发货时间
placementTime	LocalDateTime	否	订单来源平台下单时间
warehouseCode	String	是	仓库编码
shipperAddress	ShipperAddress	是	收件人信息
isAutoSubmitAudit	Boolean	否	是否自动提交审核，默认否
items	List	是	出库单明细
estimatedArrivalDate	String	否	预计到货日期，格式例如：2021-03-01
remark	String	否	备注

ShipperAddress - 收件人信息

参数名称	类型	是否必填	说明
state	String	是	州或省
city	String	是	城市
region	String	否	区
countryCode	String	是	国家代码
companyName	String	否	公司名称
contacter	String	是	收件人名
lastName	String	否	收件人姓
phone	String	是	手机号
email	String	否	邮箱
streetAddress1	String	是	详情地址1
streetAddress2	String	否	详细地址2
streetNumber	String	否	门牌号
zipCode	String	是	邮编

Item - 出库单明细

参数名称	类型	是否必填	说明
skuCode	String	是	sku编码
quantity	Integer	是	数量
tradeCode	String	否	交易平台单号
itemId	String	否	交易平台商品id
hsCode	String	否	海关编码
productDeclared	BigDecimal	否	申报价值(USD)，最多保留2位小数

请求示例

   public static void main(String[] args) {
        String appKey = "28cd819d0305402bb02e7d01091160c8";
        String secret = "xj1CnrTho1Bc1YSxaZa8ghdqRxwn079prFHqkjGXzdO64TQuy4aIzs06qv5htyXk";
        String url = "https://channelhub-uat.shippergrid.com/terminus/channelhub/api";
        ChannelClient client = new DefaultChannelClient( url, appKey, secret);
        //必填字段
        WmsOutboundCreateRequest wmsRequest = new WmsOutboundCreateRequest();
        wmsRequest.setChannelCode(OpenChannel.SHIPPER_GRID);
        // 假设这些属性必填
        wmsRequest.setOutBoundOrderCode("TEST4688401070580004");
        wmsRequest.setWarehouseCode("SH202408280003");
        wmsRequest.setPlatform("TIKTOK");
        wmsRequest.setPlatformOrderCode("576947880701497410");
        //销售平台的下单时间
        wmsRequest.setPlacementTime(LocalDateTime.now());
        // 示例：设置 ShipperAddress
        WmsOutboundCreateRequest.ShipperAddress address = new WmsOutboundCreateRequest.ShipperAddress();
        address.setState("California");
        address.setCity("Culver City");
        address.setCountryCode("US");
        address.setContacter("buyer open sandbox");
        // address.setLastName("Doe");
        address.setPhone("(+1)1234567890");
        address.setStreetAddress1("5800 Bristol Pkwy Ste 100");
        wmsRequest.setShipperAddress(address);
        // 示例：设置 items
        WmsOutboundCreateRequest.Item wmsItem = new WmsOutboundCreateRequest.Item();
        wmsItem.setSkuCode("2504UN0019");
        wmsItem.setQuantity(1);
        // 设置其他属性...
        wmsRequest.setItems(Collections.singletonList(wmsItem)); // 假定只有一个商品
        //使用ShipperGrid打单 则传入GCWL
     //   wmsRequest.setDistributionType(WmsOutboundCreateRequest.DistributionTypeEnum.GCWL);

        //不使用ShipperGrid打单 则传入KLWL_ZT 并且传入trackingNumber labelUrl shippingCode等字段
        wmsRequest.setDistributionType(WmsOutboundCreateRequest.DistributionTypeEnum.KLWL_ZT);
        wmsRequest.setTrackingNumber("9400150899563001119310");
        wmsRequest.setLabelUrl("https://millgrid-private.oss-cn-hongkong.aliyuncs.com/millgrid/order_label/SHIP_ENGINE_LABEL_9400150899563001119319252730963704832.pdf");
        wmsRequest.setShippingCode("USPS");
        wmsRequest.setDocTime(LocalDateTime.now());

        wmsRequest.setRemark("备注");
        WmsOutboundCreateResponse channelResult = client.execute(wmsRequest);
        System.out.println(JSON.toJSONString(channelResult));

    }

成功响应示例

{
    "code": 200,
    "headerContent": {
        "traceId": "2025-05-08-10-49-51-404000000-0d46e742-e8b5-457b-aa98-5fd9d602be46",
        "sign": "c098783b6481d0ca6a725894da8b2e7cfbd854608376ec0099183a657636ef22",
        "methodName": "terminus.wms.outbound.order.create",
        "appKey": "28cd819d0305402bb02e7d01091160c8",
        "Accept-Language": "zh_CN",
        "version": "1.0.0",
        "channelCode": "SHIPPER_GRID",
        "timestamp": "1746672591406"
    },
    "message": "success",
    "requestId": "2025-05-08-10-49-51-404000000-0d46e742-e8b5-457b-aa98-5fd9d602be46",
    "requestUrl": "https://channelhub-uat.shippergrid.com/terminus/channelhub/api",
    "success": true,
    "thirdOutboundOrderCode": "OB20250508565966"
}

返回参数说明

参数名	类型	说明
success	boolean	true为成功
message	string	提示信息
thirdInboundOrderCode	string	平台入库单号

异常响应示例

{
    "code": 500,
    "headerContent": {
        "traceId": "2025-05-08-10-41-32-945000000-f73596e5-d354-4aa3-ae9a-9ff17c1d0db6",
        "sign": "2d6a8ff2a873a7d50b958f1b5f6c93c9d64c6406198cff6dbba9d995a72d7e6a",
        "methodName": "terminus.wms.outbound.order.create",
        "appKey": "28cd819d0305402bb02e7d01091160c8",
        "Accept-Language": "zh_CN",
        "version": "1.0.0",
        "channelCode": "SHIPPER_GRID",
        "timestamp": "1746672092981"
    },
    "message": "物料不存在，物料编码: [2531300CO0001]",
    "requestId": "2025-05-08-10-41-32-945000000-f73596e5-d354-4aa3-ae9a-9ff17c1d0db6",
    "requestUrl": "https://channelhub-uat.shippergrid.com/terminus/channelhub/api",
    "success": false
}

创建订单(terminus.wms.outbound.order.create)​

创建订单(terminus.wms.outbound.order.create)