商家订单发货记录 - 铱云开放API 2.0

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

商家订单发货查询参数

currentPage

integer <int32>

当前页，默认：1

可选

dispatchStatus

array[string]

可选

发货单状态 CONFIRMED：已发货 DISCARD：已作废

枚举值:

CONFIRMEDDISCARD

modifyTimeBegin

string <date-time>

可选

修改时间(开始时间),未提供是默认查询3个月内的数据，时间跨度不超1年

modifyTimeEnd

string <date-time>

可选

修改时间(结束时间)

orderCodes

array[string]

可选

商家订单号MAxxx，最多支持50个

pageSize

integer <int32>

可选

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

<= 100

relatedLowerOrderCodes

array[string]

可选

关联的出库下游订单单号集合，例如客户订单号CAxxx，最多支持50个

relatedStorageBillNums

array[string]

可选

关联的出库单号(发货触发下游订单出库),例如销售出库单COxxx

withDetails

boolean

可选

是否附带发货记录明细详情

示例

{
  "currentPage": 0,
  "dispatchStatus": [
    "CONFIRMED"
  ],
  "modifyTimeBegin": "2019-08-24T14:15:22Z",
  "modifyTimeEnd": "2019-08-24T14:15:22Z",
  "orderCodes": [
    "string"
  ],
  "pageSize": 100,
  "relatedLowerOrderCodes": [
    "string"
  ],
  "relatedStorageBillNums": [
    "string"
  ],
  "withDetails": true
}

返回响应

🟢200OK

application/json

Body

currentPage

integer <int32>

可选

items

array[object (开放接口-商家订单发货记录) {18}]

可选

createTime

string <date-time>

创建时间

可选

creatorId

integer <int64>

制单人

可选

creatorName

string

制单人

可选

details

array[object (开放接口-商家订单发货记录明细) {23}]

发货明细

可选

discardReason

string

作废备注

可选

dispatchBillNum

string

商家发货单号

可选

dispatchStatus

enum<string>

可选

发货单状态 DISCARD.作废 CONFIRMED.已发货

枚举值:

CONFIRMEDDISCARD

dispatchTime

string <date-time>

发货时间

可选

freightAmount

number

本次发货的运费

可选

integer <int64>

发货记录id

可选

modifyTime

string <date-time>

修改时间

可选

orderCode

string

商家订单编码

可选

relatedLowerOrderCode

string

可选

关联的下游订单号,销售订单，例如CAxxxx

relatedStorageBillNum

string

可选

关联的出库单号(发货触发下游订单出库)，销售出库单，例如COxxx

remark

string

备注

可选

sourceOrgCode

string

商家机构编码

可选

sourceOrgId

integer <int64>

商家ID

可选

sourceOrgName

string

商家名称

可选

pageSize

integer <int32>

可选

totalCount

integer <int64>

可选

totalPage

integer <int64>

可选

示例

{
  "currentPage": 0,
  "items": [
    {
      "createTime": "2019-08-24T14:15:22Z",
      "creatorId": 0,
      "creatorName": "string",
      "details": [
        {
          "auxUnitDispatchCount": 0,
          "auxUnitId": 0,
          "auxUnitName": "string",
          "baseUnitDispatchCount": 0,
          "baseUnitId": 0,
          "baseUnitName": "string",
          "baseUnitRefundableNumber": 0,
          "createTime": "2019-08-24T14:15:22Z",
          "dispatchCount": 0,
          "dispatchMoney": 0,
          "dispatchPrice": 0,
          "id": 0,
          "modifyTime": "2019-08-24T14:15:22Z",
          "originalMoney": 0,
          "originalPrice": 0,
          "productBarCode": "string",
          "productCode": "string",
          "productImageUrl": "string",
          "productName": "string",
          "productSku": 0,
          "productSpec": "string",
          "unitId": 0,
          "unitName": "string"
        }
      ],
      "discardReason": "string",
      "dispatchBillNum": "string",
      "dispatchStatus": "CONFIRMED",
      "dispatchTime": "2019-08-24T14:15:22Z",
      "freightAmount": 0,
      "id": 0,
      "modifyTime": "2019-08-24T14:15:22Z",
      "orderCode": "string",
      "relatedLowerOrderCode": "string",
      "relatedStorageBillNum": "string",
      "remark": "string",
      "sourceOrgCode": "string",
      "sourceOrgId": 0,
      "sourceOrgName": "string"
    }
  ],
  "pageSize": 0,
  "totalCount": 0,
  "totalPage": 0
}