title: Query Material List
permalink: /pages/open-api/collection/other/materiall/query/

Description

Query material list

Request Specification

Request Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/material/queryMaterial?thirdTraceId=${Random String}

Request Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data MAP
materialType	Int	Yes	Material type: 1-Product (currently only supports product)
productQueryArg	Map	Yes	Material type ID collection
status	Int	Yes	Status: 1-Enabled 2-Disabled 3-Not enabled (query all if not provided)
keyword	String	Yes	Search keyword
groupId	String	Yes	Product group ID
pageNum	Int	Yes	Page number
pageSize	Int	Yes	Page size

Request Example

{  
  "data": {  
    "materialType": 1,  
    "productQueryArg": {  
      "groupId": "groupID",  
      "keyword": "keyword",  
      "status": 1  
    },  
    "pageSize": 20,  
    "pageNum": 1  
  }  
}  

Response Parameters

Parameter	Type	Description
traceId	string	Request unique ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	View error codes

Response Example

{  
  "traceId": "E-O.827xxxxxx",  
  "errorDescription": "success",  
  "errorMessage": "OK",  
  "errorCode": 0  
}  

Notes

• Do not use the message field in the response for logical judgments, as errorMessage may change;