POST/v1/outboundOrder/create

Create Parcel Outbound Order

创建小包出库单

Overview

Create a parcel (small package) outbound order in the WMS system.

Request Body

json
{
  "appKey": "YOUR_OMS_APP_KEY",
  "reqTime": "1700000000000",
  "data": {
    "thirdOrderNo": "ERP-OUT-001",
    "whCode": "US-NJ-01",
    "channelCode": "USPS_PM",
    "isBattery": 0,
    "orderType": 1,
    "receiverInfo": {
      "receiverName": "John Smith",
      "receiverPhone": "2129999999",
      "receiverEmail": "[email protected]",
      "receiverCountryCode": "US",
      "receiverState": "NY",
      "receiverCity": "New York",
      "receiverAddress1": "1000 6th Ave",
      "receiverAddress2": "",
      "receiverPostCode": "10018"
    },
    "senderInfo": {
      "senderName": "NIWO Warehouse",
      "senderPhone": "8486661668",
      "senderCountryCode": "US",
      "senderState": "NJ",
      "senderCity": "Carteret",
      "senderAddress1": "120 Raskulinecz Road",
      "senderPostCode": "07008"
    },
    "productList": [
      {
        "sku": "SKU-001",
        "quantity": 2,
        "declareNameEn": "T-Shirt",
        "declareNameCn": "T恤",
        "declarePrice": 15.99,
        "currencyCode": "USD"
      }
    ]
  }
}

Parameters

ParameterTypeRequiredDescription
appKeyStringYesOMS APP KEY
reqTimeStringYesTimestamp (milliseconds)
data.thirdOrderNoStringYesExternal order number
data.whCodeStringYesWarehouse code
data.channelCodeStringYesLogistics channel code
data.isBatteryIntegerNoBattery flag: 0-No, 1-Built-in, 2-Detachable, 3-Pure battery
data.orderTypeIntegerNoOrder type: 1-Normal, 2-FBA transfer
data.receiverInfoObjectYesReceiver information
data.senderInfoObjectNoSender information (uses warehouse default if omitted)
data.productListArrayYesProduct list

Receiver Info Fields

ParameterTypeRequiredDescription
receiverNameStringYesReceiver name
receiverPhoneStringNoReceiver phone
receiverEmailStringNoReceiver email
receiverCountryCodeStringYesCountry code (e.g., US)
receiverStateStringYesState/Province
receiverCityStringYesCity
receiverAddress1StringYesAddress line 1
receiverAddress2StringNoAddress line 2
receiverPostCodeStringYesPostal code

Product List Fields

ParameterTypeRequiredDescription
skuStringYesProduct SKU
quantityIntegerYesQuantity
declareNameEnStringYesEnglish declaration name
declareNameCnStringNoChinese declaration name
declarePriceNumberYesDeclared price
currencyCodeStringYesCurrency code (e.g., USD)

Response Example

json
{
  "code": 200,
  "msg": "success",
  "data": {
    "outboundOrderNo": "OB20231201001",
    "thirdOrderNo": "ERP-OUT-001",
    "success": true,
    "msg": ""
  }
}

NIWO AI Assistant

Online

Hi! How can I help you?

Ask me anything about NIWO's logistics services, warehousing, freight, or e-commerce fulfillment.

AI-powered assistant. For urgent matters, email [email protected]