订单列表 - 铱云开放API 2.0

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

buyerIds

array[integer <int64>]

买方机构id，数组

可选

orderCodes

array[string]

订单号集合，数值

可选

createTimeBegin

integer

可选

订单创建时间(开始时间)，毫秒时间戳，开始时间及结束时间不能超1年,默认查询一个月内数据

createTimeEnd

integer

可选

订单创建时间(结束时间)，毫秒时间戳

modifyTimeBegin

integer

可选

订单修改时间(开始时间)，毫秒时间戳，开始时间及结束时间不能超1年

modifyTimeEnd

integer

可选

订单修改时间(结束时间)，毫秒时间戳

orderAuditTimeBegin

integer

可选

订单审核时间(开始时间)，毫秒时间戳，开始时间及结束时间不能超1年

orderAuditTimeEnd

integer

可选

订单审核时间(结束时间)，毫秒时间戳

financeAuditTimeBegin

integer

可选

财务审核时间(开始时间)，毫秒时间戳，开始时间及结束时间不能超1年

financeAuditTimeEnd

integer

可选

财务审核时间(结束时间)，毫秒时间戳

orderStatus

array[string]

可选

订单状态，ORDER_AUDIT_PENDING:待订单审核 FINANCE_AUDIT_PENDING:待财务审核 AUDITED:已审核 FINISHED:已完成 CANCELLED:已作废 SUBMIT_PENDING:待提交 SUPERIOR_AUDIT_PENDING:待上级审核 ALLOTMENT_AUDIT_PENDING:待调出审核

枚举值:

ORDER_AUDIT_PENDINGFINANCE_AUDIT_PENDINGAUDITEDFINISHEDCANCELLEDSUBMIT_PENDINGSUPERIOR_AUDIT_PENDING

currentPage

integer <int32>

当前页，默认：1

可选

pageSize

integer <int32>

可选

每页大小，默认：20，最大支持50

sort

string

可选

排序列名:排序方式 column1:asc,column2:desc，支持：createTime:desc|createTime:asc

withDetails

boolean

可选

是否附带查询订单商品列表

withOtherInfo

boolean

可选

是否附带查询订单其它信息

withRemarks

boolean

可选

是否附带查询订单备注列表

withIrObjects

boolean

是否返回元数据

可选

示例

{
  "currentPage": 10,
  "withOtherInfo": false,
  "withDetails": false,
  "createTimeEnd": 880555168408,
  "buyerIds": [
    38,
    32
  ],
  "pageSize": 81,
  "orderCodes": [
    "40",
    "53"
  ],
  "withRemarks": true,
  "sort": "labore nisi",
  "modifyTimeEnd": 1416253288895,
  "createTimeBegin": 1571577315942,
  "orderStatus": [
    "ALLOTMENT_IN_CANCELLED",
    "SUPERIOR_AUDIT_PENDING"
  ],
  "modifyTimeBegin": 535816562634,
  "withIrObjects": false
}

返回响应

🟢200OK

application/json

Body

currentPage

integer <int32>

可选

items

array[object (开放接口-订单信息) {46}]

可选

addressId

integer <int64>

地址id

可选

buyer

object

可选

cityId

integer <int64>

可选

收货地址-地级市区域id

contactName

string

收货联系人

可选

contactPhone

string

联系电话

可选

countryId

integer <int64>

可选

收货地址-国家级区域id

couponAmount

number

优惠券金额

可选

createId

integer <int64>

制单人id

可选

createName

string

制单人姓名

可选

createRole

enum<string>

可选

创建订单的角色，用来判断是否代下单：SELLER: 卖方，BUYER：买方

枚举值:

SELLERBUYER

createTime

string <date-time>

创建时间

可选

deliveryAddress

string

收货地址

可选

deliveryDate

string <date-time>

交货日期

可选

deliveryMethodId

integer <int32>

配送方式id

可选

deliveryMethodName

string

配送方式名称

可选

districtId

integer <int64>

可选

收货地址-县级区域id

financeAuditTime

string <date-time>

财务审核时间

可选

financeAuditor

string

财务审核人

可选

financeAuditorId

integer <int64>

财务审核人id

可选

freightPricingWay

enum<string>

可选

运费计价方式CONFIRMED_AT_CREATE_ORDER: 下单时确定; CONFIRMED_AT_DELIVERY: 发货时确定; 默认CONFIRMED_AT_CREATE_ORDER

枚举值:

CONFIRMED_AT_CREATE_ORDERCONFIRMED_AT_DELIVERY

integer <int64>

可选

irObjects

object

元数据信息

可选

isClose

boolean

订单是否关闭

可选

modifyTime

string <date-time>

修改时间

可选

orderAuditTime

string <date-time>

订单审核时间

可选

orderAuditor

string

订单审核人

可选

orderAuditorId

integer <int64>

订单审核人id

可选

orderCode

string

订单号，唯一标识

可选

orderDetails

array[object (开放接口-订单商品详情) {32}]

可选

订单详情，如果不指明查询便不会返回

orderDiscountAmount

number

可选

整单优惠金额(修改订单金额产生优惠)

orderRemarks

array[object (开放接口-订单备注信息) {5}]

可选

订单备注，如果不指明查询便不会返回

orderStatus

enum<string>

可选

订单状态: ORDER_AUDIT_PENDING:待订单审核 FINANCE_AUDIT_PENDING:待财务审核 AUDITED:已审核 FINISHED:已完成 CANCELLED:已作废 SUBMIT_PENDING:待提交 SUPERIOR_AUDIT_PENDING:待上级审核 SUPERIOR_AUDIT_PENDING:待调出审核

枚举值:

ORDER_AUDIT_PENDINGFINANCE_AUDIT_PENDINGAUDITEDFINISHEDCANCELLEDSUBMIT_PENDINGSUPERIOR_AUDIT_PENDING

stockOutStatus

enum<string>

可选

出库状态：NONE: 未出库 PART:部分出库 FULL：已出库

枚举值:

NONEPARTFULL

deliveryStatus

enum<string>

可选

发货状态：NONE: 待发货 PART:部分发货 FULL：已发货

枚举值:

NONEPARTFULL

orderTotalAmount

number

订单金额

可选

refundedAmount

number

订单已退金额

可选

otherAmount

number

其它费用

可选

paymentStatus

enum<string>

可选

付款状态(UN_PAID:未付款 PART_PAID:部分付款 PAID:已付款)

枚举值:

UN_PAIDPART_PAIDPAID

productDiscountAmount

number

可选

商品优惠总额(商品的折扣额之和)

productTotalAmount

number

商品金额总计

可选

provinceId

integer <int64>

可选

收货地址-省级行政区域id

sourceOrderCode

string

订单导入专用源单号

可选

totalFreight

number

运费

可选

signStatus

string

可选

签收状态：NONE:未签收 PART:部分签收 FULL:已签收

warehouseId

number

可选

下单时的发货仓库id

warehouseName

string

可选

下单时的发货仓库名称

pageSize

integer <int32>

可选

totalCount

integer <int64>

可选

totalPage

integer <int64>

可选

示例

{
  "currentPage": 0,
  "items": [
    {
      "addressId": 0,
      "buyer": {
        "id": 0,
        "code": "string",
        "name": "string"
      },
      "cityId": 0,
      "contactName": "string",
      "contactPhone": "string",
      "countryId": 0,
      "couponAmount": 0,
      "createId": 0,
      "createName": "string",
      "createRole": "SELLER",
      "createTime": "2019-08-24T14:15:22Z",
      "deliveryAddress": "string",
      "deliveryDate": "2019-08-24T14:15:22Z",
      "deliveryMethodId": 0,
      "deliveryMethodName": "string",
      "districtId": 0,
      "financeAuditTime": "2019-08-24T14:15:22Z",
      "financeAuditor": "string",
      "financeAuditorId": 0,
      "freightPricingWay": "CONFIRMED_AT_CREATE_ORDER",
      "id": 0,
      "irObjects": {},
      "isClose": true,
      "modifyTime": "2019-08-24T14:15:22Z",
      "orderAuditTime": "2019-08-24T14:15:22Z",
      "orderAuditor": "string",
      "orderAuditorId": 0,
      "orderCode": "string",
      "orderDetails": [
        {
          "couponAmount": 0,
          "createTime": "2019-08-24T14:15:22Z",
          "discountAmount": 0,
          "id": 0,
          "irObjects": {},
          "modifyTime": "2019-08-24T14:15:22Z",
          "orderCode": "string",
          "originalPrice": 0,
          "productCode": "string",
          "productName": "string",
          "productSku": 0,
          "productSpu": 0,
          "purchaseNumbers": 0,
          "remark": "string",
          "salePrice": 0,
          "saleRate": 0,
          "subtotal": 0,
          "salePriceAfterFullDiscount": 0,
          "subtotalAfterFullDiscount": 0,
          "type": "NORMAL",
          "unitId": 0,
          "unitName": "string",
          "zfNumber": 0,
          "baseUnitId": 0,
          "baseUnitName": "string",
          "baseUnitNumbers": 0,
          "auxUnitId": 0,
          "auxUnitNumbers": 0,
          "auxUnitName": "string",
          "rate": 0,
          "combinationProductUnitId": 0,
          "combinationProductExt": "string"
        }
      ],
      "orderDiscountAmount": 0,
      "orderRemarks": [
        {
          "content": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "id": 0,
          "modifyTime": "2019-08-24T14:15:22Z",
          "orderCode": "string"
        }
      ],
      "orderStatus": "ORDER_AUDIT_PENDING",
      "stockOutStatus": "NONE",
      "deliveryStatus": "NONE",
      "orderTotalAmount": 0,
      "refundedAmount": 0,
      "otherAmount": 0,
      "paymentStatus": "UN_PAID",
      "productDiscountAmount": 0,
      "productTotalAmount": 0,
      "provinceId": 0,
      "sourceOrderCode": "string",
      "totalFreight": 0,
      "signStatus": "string",
      "warehouseId": 0,
      "warehouseName": "string"
    }
  ],
  "pageSize": 0,
  "totalCount": 0,
  "totalPage": 0
}