探马OpenAPI

创建/更新订单

POST

/external/order/import

订单不存在则新增，存在则更新
更新时只支持更新订单状态（状态不能回退，比如不能从已支付改为待支付）、订单金额、订单自定义字段

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

order

object

订单信息

必需

channelId

string

平台id

必需

channelName

string

平台名称

必需

shopId

string

店铺id

必需

shopName

string

店铺名称

必需

unionId

string

unionId 如果不存在，采用mobile字段关联客户信息

可选

mobile

string

客户电话

必需

qwUserId

string

负责人企微id

可选

如果不指定负责人，会给该客户所有负责人分别创建订单

orderId

string

订单编号

必需

orderPrice

number

订单金额

可选

为空则通过订单中商品单价和数量计算

orderStatus

integer

订单状态

必需

1：待支付；2：已支付；3：已发货；4：已完成；5：售后中；6：已关闭；7：已取消

orderTime

string

下单时间

必需

格式：yyyy-MM-dd HH:mm:ss

payTime

string

支付时间

可选

格式：yyyy-MM-dd HH:mm:ss 不填默认使用orderTime

customDefine

array [object {2}]

自定义内容

可选

goods

array [object {4}]

商品列表

必需

goodName

string

商品名称

必需

imageUrl

string

商品图片连接

可选

goodPrice

number

商品单价

必需

num

integer

购买商品个数

必需

示例

{
  "order": {
    "channelId": "12306",
    "channelName": "12306",
    "shopId": "TEST",
    "shopName": "测试店铺",
    "unionId": "o9ATRwQFTGcc5oYonrcfQJdDTbI4",
    "mobile": "18188888888",
    "orderId": "TEST_12345678",
    "orderPrice": 0.01,
    "orderStatus": 2,
    "orderTime": "2021-12-10 15:53:29",
    "customDefine": [
      {
        "key": "1191",
        "value": "xxx"
      },
      {
        "key": "1190",
        "value": "1"
      }
    ]
  },
  "goods": [
    {
      "goodName": "测试商品",
      "imageUrl": "https://xxx",
      "goodPrice": 0.01,
      "num": 1
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/external/order/import' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "order": {
    "channelId": "12306",
    "channelName": "12306",
    "shopId": "TEST",
    "shopName": "测试店铺",
    "unionId": "o9ATRwQFTGcc5oYonrcfQJdDTbI4",
    "mobile": "18188888888",
    "orderId": "TEST_12345678",
    "orderPrice": 0.01,
    "orderStatus": 2,
    "orderTime": "2021-12-10 15:53:29",
    "customDefine": [
      {
        "key": "1191",
        "value": "xxx"
      },
      {
        "key": "1190",
        "value": "1"
      }
    ]
  },
  "goods": [
    {
      "goodName": "测试商品",
      "imageUrl": "https://xxx",
      "goodPrice": 0.01,
      "num": 1
    }
  ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

示例：0

必需

message

string

必需

示例：success

示例

成功示例异常示例

{
  "code": 0,
  "message": "success"
}

查询订单详情

批量创建/更新订单