创建销售订单(带附件的 ) - OPEN-API-客户对接【外】

请求参数

Header 参数

x-api-key

string

必需

示例值:

abc123(认证信息)

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

orderNo

string

来源单号

必需

carrier

string

可选

承运商(如 Fedex ,Ups等)

carrierCode

string

物流商服务Code

可选

warehouseCode

string

可选

仓库code (要在cope系统中维护此code 与cope系统中仓库的对应关系 )

currency

string

可选

币种 (不填默认USD)

paidAt

string

可选

支付时间 (不填默认当前时间)

shipToCountry

string

必需

目的国家规范2位字符

shipToState

string

必需

目的州（美国,加拿大：规范2位编码）

shipToCity

string

目的城市

必需

shipToPostal

string

发运邮编

必需

shipToAddress1

string

发运地址1

必需

shipToAddress2

string

发运地址2

可选

shipToContact

string

发运联系人

必需

buyerName

string

客户姓名

可选

buyerEmail

string

客户邮箱

可选

shipToTelephone

string

发运联系电话

必需

thirdPartyAccount

string

可选

third party 账号

shipServiceLevel

string

可选

'Standard-48 Hours' ：标准（48小时发货）；'Same Day Ship Out' :（加急当日发货）;'Outbound First Class' : 头等车；不填为标准

poNumber

string

可选

订单产生的平台订单号

channelAccount

string

可选

店铺名称，此名称若传入则会验证在系统中是否存在

isPrime

integer

可选

是否 prime（sfp）订单 0 否 1 是不填默认否

latestShipDate

string

可选

最晚发货时间（2024-03-10 00:00:00）

estimatedDeliveryTime

string

可选

最晚送达时间（2024-03-10 00:00:00）

salesPlatform

integer

必需

销售平台类型1:Amazon 2:Walmart 3:Bestbuy 4:Costco 5:Wayfair 6:Target 7:Overstock 8:HomeDepot 9:Temu 10:TikTok 11:EBAY

erpPlatform

integer

可选

erp来源类型1:领星 2:马帮 3:店小秘 4:易仓OMS 5:积加 6:千易 7:鲸汇 8:赛狐 9:赛盒 10:易仓WMS 11:Other 12:星商 13:通途 14:潮货通 15

remark

string

可选

productItems

array [object {12}]

(产品行)

必需

sku

string

发货产品

可选

quantity

integer

发货数量

可选

isInsure

integer

可选

是否保价 0否 1是不填时从产品中心取

isSignature

integer

可选

签收类型 0 不签收 1 直接签收 2 成人签收 3 间接签收不填时从产品中心取

skuAmount

number

当前sku总金额

可选

insureAmount

number

可选

投保金额 (保价情况下必填)

articleNo

string

可选

ean

string

可选

supplierArticleNo

string

可选

lineNo

string

可选

行号-当前订单下唯一

skuOrderSn

string

可选

产品订单序列号，ebay平台对应ebayItemID，temu平台对应orderSn

skuTransactionSn

string

可选

产品交易序列号，ebay 平台对应ebayTransactionId ,temu平台对应parentOrderSn

attachInfoItems

array [object {5}]

可选

附件信息 (非必填，如传入的话，下面的必填项请必填 )

name

string

可选

附件名称(最好以 TrackingNo,不带后缀 )

url

string

必需

附件url 和下面的file字段至少填写一个

file

string

必需

base64 字符串,如果填写，则不认上面url里面的内容 ( url 与 file必填其一 )

type

integer

必需

订单附件类型 Shippinglabel：0； Packinglist：1； BOL：2； Other：3； CartonLabel：4； PalletLabel：5； ItemLabel：6； INVOICE：7； SHIPPING_PLAN：8；

remark

string

备注

可选

packageItems

array [object {7}]

可选

发货包裹数据（支持多包裹）

refNo

string

包裹参考号-非必填

可选

length

number

包裹长（cm）

必需

width

number

包裹宽（cm）

必需

height

number

包裹高（cm）

必需

weight

number

包裹重量（g）

必需

skuInfo

array [object {2}]

可选

包裹sku数据-当包裹数为1时，可以不填，默认所有sku在一个包裹

materialType

array[integer]

必需

tags

array[integer]

可选

业务标签 100 售后卡 110 贴发票 20不使用耗材 21纸箱打包 22快递袋打包 150采集SN

示例

{
  "orderNo": "string",
  "carrier": "string",
  "carrierCode": "string",
  "warehouseCode": "string",
  "currency": "string",
  "paidAt": "string",
  "shipToCountry": "string",
  "shipToState": "string",
  "shipToCity": "string",
  "shipToPostal": "string",
  "shipToAddress1": "string",
  "shipToAddress2": "string",
  "shipToContact": "string",
  "buyerName": "string",
  "buyerEmail": "string",
  "shipToTelephone": "string",
  "thirdPartyAccount": "string",
  "shipServiceLevel": "string",
  "poNumber": "string",
  "channelAccount": "string",
  "isPrime": 0,
  "latestShipDate": "string",
  "estimatedDeliveryTime": "string",
  "salesPlatform": 0,
  "erpPlatform": 0,
  "remark": "string",
  "productItems": [
    {
      "sku": "string",
      "quantity": 0,
      "isInsure": 0,
      "isSignature": 0,
      "skuAmount": 0,
      "insureAmount": 0,
      "articleNo": "string",
      "ean": "string",
      "supplierArticleNo": "string",
      "lineNo": "string",
      "skuOrderSn": "string",
      "skuTransactionSn": "string"
    }
  ],
  "attachInfoItems": [
    {
      "name": "string",
      "url": "string",
      "file": "string",
      "type": 0,
      "remark": "string"
    }
  ],
  "packageItems": [
    {
      "refNo": "string",
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "skuInfo": [
        {
          "sku": "string",
          "qty": 0
        }
      ],
      "materialType": [
        0
      ]
    }
  ],
  "tags": [
    0
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://hwc-open-api.yqn.com/v1/saleOrder/create' \
--header 'x-api-key: abc123(认证信息)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderNo": "string",
    "carrier": "string",
    "carrierCode": "string",
    "warehouseCode": "string",
    "currency": "string",
    "paidAt": "string",
    "shipToCountry": "string",
    "shipToState": "string",
    "shipToCity": "string",
    "shipToPostal": "string",
    "shipToAddress1": "string",
    "shipToAddress2": "string",
    "shipToContact": "string",
    "buyerName": "string",
    "buyerEmail": "string",
    "shipToTelephone": "string",
    "thirdPartyAccount": "string",
    "shipServiceLevel": "string",
    "poNumber": "string",
    "channelAccount": "string",
    "isPrime": 0,
    "latestShipDate": "string",
    "estimatedDeliveryTime": "string",
    "salesPlatform": 0,
    "erpPlatform": 0,
    "remark": "string",
    "productItems": [
        {
            "sku": "string",
            "quantity": 0,
            "isInsure": 0,
            "isSignature": 0,
            "skuAmount": 0,
            "insureAmount": 0,
            "articleNo": "string",
            "ean": "string",
            "supplierArticleNo": "string",
            "lineNo": "string",
            "skuOrderSn": "string",
            "skuTransactionSn": "string"
        }
    ],
    "attachInfoItems": [
        {
            "name": "string",
            "url": "string",
            "file": "string",
            "type": 0,
            "remark": "string"
        }
    ],
    "packageItems": [
        {
            "refNo": "string",
            "length": 0,
            "width": 0,
            "height": 0,
            "weight": 0,
            "skuInfo": [
                {
                    "sku": "string",
                    "qty": 0
                }
            ],
            "materialType": [
                0
            ]
        }
    ],
    "tags": [
        0
    ]
}'

返回响应

🟢200成功

application/json

Body

statusCode

number

必需

http 状态码 200 标识成功，其余为错误代码

status

number

处理结果类型

必需

code

number

必需

处理结果代码 200 标识成功，其余为错误代码

message

string

具体返回信息

必需

data

object

必需

orderId

integer

必需

返回订单id (此id可在列表查询时作为订单的查询条件 )

示例

{
  "statusCode": 200,
  "status": 0,
  "code": 200,
  "message": "创建订单成功",
  "data": {
    "orderId": 193252852
  }
}