post https://www.coohom.com/api/saas/openapi/commodity/search
You can call this operation to search for the products that you want.
Request Body
Currently, this operation only supports the following scenarios.
- Specifies catId, start, and num to retrieve the products in the specified category. Specifies lastModifiedStart and lastModifiedEnd to retrieve the products that have been updated in the specified time range. Specifies includeStyleItems to retrieve products in collections. Default value: false. A true value indicates that all collection products are returned.
Note: Currently, each collection has a default product. A collection is in the category which the default product is in. We recommend that you set all products of the same collection in the same category to avoid ambiguity. - Specifies q, start, and num to search for products based on keywords.
- Specifies code to search for the products with the specified product code.
Note: Multiple products are supported to use the same code. We recommend that you avoid using one code for multiple products. To fuzzy match products with product codes, use the q parameter.
Response
Name | Required | Type | Description |
---|---|---|---|
id | true | string | The ID of the product. |
name | true | string | The name of the product. |
description | false | string | The description of the product. |
type | true | string | The type of the product. For more information, see the value of the subType parameter. |
subType | true | int | The subtype of the product. For more information, see the appendix at the end of the page. |
size | false | json | The size of the product. Not empty only when the value of subType is 1. x, y, and z represent the length, width, and height of a product. |
largeImgUrl | false | string | The URL of the large preview image of the product. |
imgUrl | true | string | The URL of the preview image of the product. |
brandName | false | string | The brand name of the product. |
brandLogo | false | string | The URL of the brand logo image of the product. |
unitPrice | false | string | The unit price of the product. For interior finish products, unit: yuan/square meter. For furnishing products, unit: yuan. |
customTexture | false | string | The texture of the product. |
prodUrl | false | string | The purchase link of the product. |
code | false | string | The code of the product. The product code is the GUID set by a merchant account. |
styleName | false | string | The style name of the product. |
styleId | false | string | The style ID of the product. |
tags.name | false | string | The tag name of the product. |
tags.tagId | false | string | The tag ID of the product. |
created | false | long | The creation timestamp of the product. |
lastModified | false | long | The last update timestamp of the product. |
Appendix
subType enumerations
Enumerator | Description |
---|---|
1 | Model |
3 | Interior finish |
4 | Buckle |
5 | Baseboard |
8 | Hardware |
9 | Parameterized model |
10 | Floor tile |
11 | Boundary |
12 | Floor tile style |
13 | Integrated wallboard |
14 | Parameterized line |
15 | Parameterized composition model |
16 | Composition model |
17 | Outline |
18 | Water jet-cut parquet |
19 | Insubstantial model |