C300-OpenAPI

查询物料编码集合

POST

/api/open/v2/items/codes/query

请求参数

Body 参数application/json

body

必需

Any of

ItemQueryParam

null

pagingParam

object

PagingParam

可选

code

string

编码完全匹配

可选

codes

array[string]

编码完全匹配

可选

codeLike

string

编码模糊匹配

可选

name

string

名称完全匹配

可选

nameLike

string

名称模糊匹配

可选

status

array[string]

物料状态多选

可选

枚举值:

DISABLEDENABLETO_BE_DISABLEDTO_BE_ENABLE

auditStatuses

array[string]

物料审核状态

可选

枚举值:

TO_BE_SUBMITAUDITINGAUDITED

attributeQueryParams

array[object (ItemAttributeQueryParam) {3}]

规格属性筛选

可选

示例

{
  "body": {
    "pagingParam": {
      "start": 0,
      "length": 0
    },
    "code": "string",
    "codes": [
      "string"
    ],
    "codeLike": "string",
    "name": "string",
    "nameLike": "string",
    "status": [
      "DISABLED"
    ],
    "auditStatuses": [
      "TO_BE_SUBMIT"
    ],
    "attributeQueryParams": [
      {
        "key": "string",
        "valueLike": "string",
        "values": [
          "string"
        ]
      }
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://c2.xinheyun.com/api/open/v2/items/codes/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": {
        "pagingParam": {
            "start": 0,
            "length": 0
        },
        "code": "string",
        "codes": [
            "string"
        ],
        "codeLike": "string",
        "name": "string",
        "nameLike": "string",
        "status": [
            "DISABLED"
        ],
        "auditStatuses": [
            "TO_BE_SUBMIT"
        ],
        "attributeQueryParams": [
            {
                "key": "string",
                "valueLike": "string",
                "values": [
                    "string"
                ]
            }
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

可选

message

string

可选

data

object (ListPagingResponseDataString)

可选

list

array[string]

可选

start

integer

可选

length

integer

可选

recordsTotal

integer

可选

示例

{
  "code": 0,
  "message": "",
  "data": {
    "list": [
      ""
    ],
    "start": 0,
    "length": 0,
    "recordsTotal": 0
  }
}

查询物料列表（精简物料格式）

物料图纸信息上传