分批查询物料 - C300-OpenAPI

请求参数

Path 参数

viewKey

string

必需

Body 参数application/json

conditions

object (ITEM_filter)

可选

useBatch

object

可选

批次, true=是, false=否(支持集合查询)

type

object

可选

物料属性, PRODUCTS=产品, SEMI_PRODUCTS=半成品, MATERIALS=原料, WORK_IN_PROCESS=在制品(支持集合查询)

abcCategory

object

可选

ABC类, NON=无, A=A类, B=B类, C=C类(支持集合查询)

name

object

可选

物料名称(支持模糊、精确、集合查询)

status

object

可选

物料状态, DISABLED=已禁用, ENABLE=已启用, TO_BE_DISABLED=待禁用, TO_BE_ENABLE=待启用(支持集合查询)

code

object

可选

物料编号(支持模糊、精确、集合查询)

useBomVersion

object

可选

区分BOM版本, true=是, false=否(支持集合查询)

issueStatus

object

可选

下发状态, EDEN=未下发, INITIATIVE_ISSUE=已下发, PASSIVITY_ISSUE=被下发, NOT_ISSUED_AFTER_UPDATE=更新后未下发(支持集合查询)

useSn

object

可选

序列号管理, true=是, false=否(支持集合查询)

itemCategoryName

object

可选

物料分类名称(支持集合查询)

useLockInventory

object

可选

锁库, true=是, false=否(支持集合查询)

specification

object

可选

规格(支持模糊、精确、集合查询)

createTime

object

可选

创建时间, 时间戳（毫秒）(时间范围查询)

auditStatus

object

可选

审核状态, PENDING=待提交, RUNNING=审核中, FINISHED=已审核(支持集合查询)

sorts

object (ITEM_sort)

可选

createTime

enum<string>

可选

排序顺序：ASC=正序，DESC=倒序

枚举值:

ASCDESC

fieldKeys

array[string]

可选

查询字段：为空则返回所有字段

paging

object

必需

start

integer

分页开始

必需

>= 0

length

integer

分页大小

必需

>= 1<= 500

boundaryIds

array[string]

可选

起始id，首次查询值为null

length

integer

一次查询数量

可选

>= 1<= 2000

示例

{
  "conditions": {
    "useBatch": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "type": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "abcCategory": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "name": {
      "conditionType": "FUZZY",
      "value": "string",
      "filter": [
        "string"
      ]
    },
    "status": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "code": {
      "conditionType": "FUZZY",
      "value": "string",
      "filter": [
        "string"
      ]
    },
    "useBomVersion": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "issueStatus": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "useSn": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "itemCategoryName": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "useLockInventory": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    },
    "specification": {
      "conditionType": "FUZZY",
      "value": "string",
      "filter": [
        "string"
      ]
    },
    "createTime": {
      "conditionType": "TIME_RANGE",
      "timeRange": {
        "start": 0,
        "end": 0
      }
    },
    "auditStatus": {
      "conditionType": "FILTER",
      "filter": [
        "string"
      ]
    }
  },
  "sorts": {
    "createTime": "ASC"
  },
  "fieldKeys": [
    "string"
  ],
  "paging": {
    "start": 0,
    "length": 1
  },
  "boundaryIds": [
    "string"
  ],
  "length": 1
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://c2.xinheyun.com/api/open/v3/ITEM/searchAfter' \
--header 'Content-Type: application/json' \
--data-raw '{
    "conditions": {
        "useBatch": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "type": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "abcCategory": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "name": {
            "conditionType": "FUZZY",
            "value": "string",
            "filter": [
                "string"
            ]
        },
        "status": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "code": {
            "conditionType": "FUZZY",
            "value": "string",
            "filter": [
                "string"
            ]
        },
        "useBomVersion": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "issueStatus": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "useSn": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "itemCategoryName": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "useLockInventory": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        },
        "specification": {
            "conditionType": "FUZZY",
            "value": "string",
            "filter": [
                "string"
            ]
        },
        "createTime": {
            "conditionType": "TIME_RANGE",
            "timeRange": {
                "start": 0,
                "end": 0
            }
        },
        "auditStatus": {
            "conditionType": "FILTER",
            "filter": [
                "string"
            ]
        }
    },
    "sorts": {
        "createTime": "ASC"
    },
    "fieldKeys": [
        "string"
    ],
    "paging": {
        "start": 0,
        "length": 1
    },
    "boundaryIds": [
        "string"
    ],
    "length": 1
}'

返回响应

🟢200成功

application/json

Body

code

integer

可选

message

string

可选

data

object

可选

list

array[object (ITEM) {69}]

可选

start

integer

可选

length

integer

可选

recordsTotal

integer

可选

boundaryIds

array[string]

可选

本次查询结果boundaryIds，直接作为下次查询boundaryIds入参

示例

{
  "code": 0,
  "message": "string",
  "data": {
    "list": [
      {
        "fifoScanCheck": true,
        "procurementTax": 0,
        "itemCategoryCode": "string",
        "useBatch": true,
        "type": "string",
        "safetyInventory": 0,
        "allowPurchase": true,
        "overdueDays": 0,
        "abcCategory": "string",
        "defectiveRate": 0,
        "allowSale": true,
        "fifoRule": "string",
        "purchaser": 0,
        "planBatchSize": 0,
        "itemAlbum": {},
        "procurementPrice": 0,
        "blueprint": {},
        "itemBaseUnitName": "string",
        "name": "string",
        "incrementSize": 0,
        "batchType": "string",
        "integerWay": "string",
        "status": "string",
        "overDeliveryRate": 0,
        "code": "string",
        "itemProductionUnitName": "string",
        "snType": "string",
        "defaultWarehouseName": "string",
        "itemInventoryUnitName": "string",
        "useOverdue": true,
        "overdueAlertDays": 0,
        "useBomVersion": true,
        "issueStatus": "string",
        "attachment": {},
        "enableInteger": true,
        "reject": "string",
        "allowOutsource": true,
        "shelfLife": 0,
        "overReceiveRate": 0,
        "itemCategoryCycleDay": 0,
        "creator": 0,
        "maxInventory": 0,
        "comments": "string",
        "cost": 0,
        "fifo": "string",
        "itemJbkUnitName": "string",
        "useSn": true,
        "isConfigurable": true,
        "salePrice": 0,
        "itemSaleUnitName": "string",
        "itemCategoryName": "string",
        "dailyProduction": 0,
        "useLockInventory": true,
        "realCostPrice": 0,
        "specification": {},
        "specificationConfig": {},
        "updateTime": 0,
        "defaultWarehouseCode": "string",
        "useKey": true,
        "inventoryAccountType": "string",
        "createTime": 0,
        "saleTax": 0,
        "auditStatus": "string",
        "defaultWarehouseBinName": "string",
        "itemPurchaseUnitName": "string",
        "useSafetyInventory": true,
        "batchSize": 0,
        "allowProduction": true,
        "itemSpecification": {}
      }
    ],
    "start": 0,
    "length": 0,
    "recordsTotal": 0,
    "boundaryIds": [
      "string"
    ]
  }
}

🟢201成功

🟠401没有权限

🟠403禁止访问

🟠404记录不存在