商家订单列表 - 铱云开放API 2.0

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

createTimeBegin

string <date-time>

可选

订单创建时间(开始时间)

createTimeEnd

string <date-time>

可选

订单创建时间(结束时间)

currentPage

integer <int32>

当前页，默认：1

可选

modifyTimeBegin

string <date-time>

可选

订单修改时间(开始时间)

modifyTimeEnd

string <date-time>

可选

订单修改时间(结束时间)

orderAuditTimeBegin

string <date-time>

可选

订单审核时间(开始时间)

orderAuditTimeEnd

string <date-time>

可选

订单审核时间(结束时间)

orderCodes

array[string]

可选

code列表，最多支持50个

orderStatus

array[string]

可选

订单状态，如果不指定就是全查

枚举值:

ALLOTMENT_AUDIT_PENDINGALLOTMENT_IN_CANCELLEDALLOTMENT_OUT_CANCELLEDAUDITEDCANCELLEDFINANCE_AUDIT_PENDINGFINISHEDINITIALIZEDINVISIBLESORDER_AUDIT_PENDINGSUBMIT_PENDINGSUPERIOR_AUDIT_PENDINGSUPERIOR_CANCELLED

pageSize

integer <int32>

可选

每页大小，默认：20，最大100

<= 100

paymentStatus

array[string]

可选

付款状态，如果不指定就是全查

枚举值:

FAILIN_PAYPAIDPAID_CHECKINGPART_PAIDUN_PAID

sellerIds

array[integer <int64>]

可选

商家id列表，如果不指定就是全查

signStatus

array[string]

可选

发货状态，如果不指定就是全查

枚举值:

FULLNONEPART

withAttachments

boolean

可选

是否附带查询订单附件列表

withDetails

boolean

可选

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

withRemarks

boolean

可选

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

yjdfRelatedCodes

array[string]

被代发单号列表

可选

示例

{
  "createTimeBegin": "2019-08-24T14:15:22Z",
  "createTimeEnd": "2019-08-24T14:15:22Z",
  "currentPage": 0,
  "modifyTimeBegin": "2019-08-24T14:15:22Z",
  "modifyTimeEnd": "2019-08-24T14:15:22Z",
  "orderAuditTimeBegin": "2019-08-24T14:15:22Z",
  "orderAuditTimeEnd": "2019-08-24T14:15:22Z",
  "orderCodes": [
    "string"
  ],
  "orderStatus": [
    "ALLOTMENT_AUDIT_PENDING"
  ],
  "pageSize": 100,
  "paymentStatus": [
    "FAIL"
  ],
  "sellerIds": [
    0
  ],
  "signStatus": [
    "FULL"
  ],
  "withAttachments": true,
  "withDetails": true,
  "withRemarks": true,
  "yjdfRelatedCodes": [
    "string"
  ]
}

返回响应

🟢200OK

application/json

Body

currentPage

integer <int32>

可选

items

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

可选

addressDetail

string

收货地址-详细地址

可选

buyer

object

可选

cityId

integer <int64>

可选

收货地址-地级市区域id

contactName

string

收货联系人

可选

contactPhone

string

收货联系人联系电话

可选

countryId

integer <int64>

可选

收货地址-国家级区域id

createId

integer <int64>

制单人id

可选

createName

string

制单人姓名

可选

createTime

string <date-time>

创建时间

可选

deliveryAddress

string

可选

收货地址，保持与BO字段名称一致

districtId

integer <int64>

可选

收货地址-县级区域id

dxMode

enum<string>

可选

代销模式 1：商家直送 2：平台代送

枚举值:

DELIVER_BY_CURRENT_ORGDELIVER_BY_MERCHANT

integer <int64>

可选

isClose

boolean

订单是否关闭

可选

modifyTime

string <date-time>

修改时间

可选

orderAuditTime

string <date-time>

订单审核时间

可选

orderAuditor

string

订单审核人

可选

orderAuditorId

integer <int64>

订单审核人id

可选

orderCode

string

订单号

可选

orderDetails

array[object (开放接口-商家订单商品信息) {51}]

可选

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

orderRemarks

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

可选

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

orderSource

enum<string>

订单来源

可选

枚举值:

APPPOSWEBWECHAT

orderStatus

enum<string>

可选

商家订单状态限制在 ORDER_AUDIT_PENDING：待订单审核 AUDITED：已审核 FINISHED：已完成 CANCELLED：已作废

枚举值:

orderTotalAmount

number

结算总额

可选

otherAmount

number

其他费用

可选

paidAmount

number

已支付金额

可选

payableAmount

number

应付金额

可选

paymentStatus

enum<string>

支付状态

可选

枚举值:

FAILIN_PAYPAIDPAID_CHECKINGPART_PAIDUN_PAID

productTotalAmount

number

商品小计总额

可选

provinceId

integer <int64>

可选

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

refundedAmount

number

退款金额

可选

seller

object

可选

signStatus

enum<string>

可选

签收状态，同时表示发货的状态 NONE：未发货 PART：部分发货 FULL：已发货

枚举值:

FULLNONEPART

sourceBuyerName

string

直发原订单买方名称

可选

sourceCreatorName

string

直发原订单制单人

可选

unPaidAmount

number

待付金额

可选

warehouseId

integer <int64>

源单发货仓库id

可选

warehouseName

string

源单的发货仓库

可选

yjdfRelatedCode

string

被代发/直发单号

可选

pageSize

integer <int32>

可选

totalCount

integer <int64>

可选

totalPage

integer <int64>

可选

示例

{
  "currentPage": 0,
  "items": [
    {
      "addressDetail": "string",
      "buyer": {
        "id": 0,
        "code": "string",
        "name": "string"
      },
      "cityId": 0,
      "contactName": "string",
      "contactPhone": "string",
      "countryId": 0,
      "createId": 0,
      "createName": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "deliveryAddress": "string",
      "districtId": 0,
      "dxMode": "DELIVER_BY_CURRENT_ORG",
      "id": 0,
      "isClose": true,
      "modifyTime": "2019-08-24T14:15:22Z",
      "orderAuditTime": "2019-08-24T14:15:22Z",
      "orderAuditor": "string",
      "orderAuditorId": 0,
      "orderCode": "string",
      "orderDetails": [
        {
          "auxUnitId": 0,
          "auxUnitName": "string",
          "auxUnitNumbers": 0,
          "baseUnitId": 0,
          "baseUnitName": "string",
          "baseUnitNumbers": 0,
          "brandId": 0,
          "brandName": "string",
          "categoryId": 0,
          "categoryIds": [
            0
          ],
          "categoryName": "string",
          "categoryNames": [
            "string"
          ],
          "combinationProductExt": "string",
          "combinationProductUnitId": 0,
          "createTime": "2019-08-24T14:15:22Z",
          "customPrice": true,
          "discountAmount": 0,
          "id": 0,
          "initialPrice": 0,
          "modifyTime": "2019-08-24T14:15:22Z",
          "orderCode": "string",
          "originalPrice": 0,
          "productBarCode": "string",
          "productCode": "string",
          "productImageUrl": "string",
          "productName": "string",
          "productNameWithCodeAndSpecText": "string",
          "productNameWithSpecText": "string",
          "productShortName": "string",
          "productSku": 0,
          "productSpec": "string",
          "productSpecText": "string",
          "productSpu": 0,
          "productType": "COMBO",
          "purchaseNumbers": 0,
          "rate": 0,
          "remark": "string",
          "salePrice": 0,
          "saleRate": 0,
          "shelfStatus": 0,
          "shortCode": "string",
          "signAuxNumber": 0,
          "signNumber": 0,
          "skuStatus": 0,
          "sortingTagId": 0,
          "sortingTagName": "string",
          "subtotal": 0,
          "type": "MANUAL_GIFT",
          "unitId": 0,
          "unitName": "string",
          "weight": 0
        }
      ],
      "orderRemarks": [
        {
          "content": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "id": 0,
          "modifyTime": "2019-08-24T14:15:22Z",
          "orderCode": "string"
        }
      ],
      "orderSource": "APP",
      "orderStatus": "ALLOTMENT_AUDIT_PENDING",
      "orderTotalAmount": 0,
      "otherAmount": 0,
      "paidAmount": 0,
      "payableAmount": 0,
      "paymentStatus": "FAIL",
      "productTotalAmount": 0,
      "provinceId": 0,
      "refundedAmount": 0,
      "seller": {
        "id": 0,
        "code": "string",
        "name": "string"
      },
      "signStatus": "FULL",
      "sourceBuyerName": "string",
      "sourceCreatorName": "string",
      "unPaidAmount": 0,
      "warehouseId": 0,
      "warehouseName": "string",
      "yjdfRelatedCode": "string"
    }
  ],
  "pageSize": 0,
  "totalCount": 0,
  "totalPage": 0
}