Get new product information based on material

Description

According to the product ID and the material replacement information returned in the viewer, get the detailed information of the product that belongs to you. If the product does not belong to you, no data will be returned.
Product information can be edited on the product details page of the merchant backend

API

POST  https://openapi.kujiale.com/v2/commodity/viewer/detail
Content-Type: application/json;x-qh-id: null;

Participate

Request Body

{
	"replaceConfigList":[
		{
			"newMaterialId":"",
			"srcMaterialId":""
		}
	],
	"obsBrandGoodId":""
}

Request body parameter description：

parameter	required option or not	Parameter Type	Parameter Description
obsBrandGoodId	no	string	Original product Id（current viewer id）
replaceConfigList	no	list&object	null
replaceConfigList.srcMaterialId	no	string	part id
replaceConfigList.newMaterialId	no	string	material id

response

data structure

{
	"d":{
		"imgs":"",
		"customerTexture":"",
		"brandGoodName":"",
		"brandName":"",
		"currencyPrices":[
			{
				"currencyId":"",
				"price":0
			}
		],
		"description":"",
		"obsSeriesTagId":"",
		"productNumber":"",
		"customTags":[
			{
				"name":"",
				"obsKeyId":"",
				"obsTagId":""
			}
		],
		"buyLink":"",
		"brandGoodCode":"",
		"seriesTagName":"",
		"obsBrandId":"",
		"dimensions":""
	},
	"c":""
}

Field description

parameter	required option or not	Parameter Type	Parameter Description
c	no	string	null
d	no	object	null
d.description	no	string	size
d.dimensions	no	string	description
d.customTags	no	list&object	Commodity label
d.customTags.obsTagId	Yes	string	label id
d.customTags.obsKeyId	Yes	string	Label class Id
d.customTags.name	is	string	Label name
d.obsBrandId	No	string	brand id
d.brandGoodName	No	string	product name
d.brandName	No	string	brand name
d.productNumber	No	string	Model
d.seriesTagName	No	string	Series name
d.brandGoodCode	No	string	Product Code
d.imgs	No	string	Physical image (divided by',')
d.buyLink	No	string	Buy Link
d.obsSeriesTagId	No	string	Series id
d.customerTexture	No	string	Material
d.currencyPrices	No	list&object	Multi-currency
d.currencyPrices.price	Yes	number	Current currency price
d.currencyPrices.currencyId	Yes	string	Currency Id

Get product viewer status in bulk

Description

The rendering status of the viewer generated by the corresponding brandgood will be obtained according to the total account information of the authenticated merchant and the brandgoodid information entered in the body.
If the brandgood does not belong to this user (including sub-accounts), the returned object of the corresponding brandgoodid will not appear in the returned d.list list.
If the brandgood does not generate a viewer, the returned object of the corresponding brandgoodid will not appear in the returned d.list list.

API

POST https://openapi.kujiale.com/v2/commodity/viewer/status
Content-Type: application/json;

Entry

Request Body

The number of obsbgid should not be more than 50

[
"3FO4KKRRWIXR"
]

Request body parameter description:
Join the list of brandgoodid

Response

data structure

{
"d":[
{
"obsBrandGoodId":"3FO4KKRRWIXR",
"status":0
}
],
"c":""
}

Field Description

Parameter	Do you need to	Parameter type	Parameter description
d	No	list&object	Returned products generate viewer status object list
d.status	No	number	Corresponding viewer generation status, please refer to appendix 1 for status enumeration
d.obsBrandGoodId	No	string	Brandgoodid of the entry

Appendix

Appendix 1: Viewer Status Enumeration

status	Chinese progress
5	Successful rendering
6	Rendering failed
0	Building

Get product details

Description

According to the product ID to obtain the detailed information of the product under the account system, if the product does not belong to the current account system, no data will be returned. Product information can be edited on the product details page of the merchant backend

API

GET  https://openapi.kujiale.com/v2/commodity/detail

Entry

URL Query Param

Parameter	Is it necessary	Parameter type	Parameter description
obsbgid	yes	string	ProductID

Response

data structure

{
    “d”:{
        “customerTexture”:“”,
        “imgs”:“”,
        “brandGoodName”:“”,
        “brandName”:“”,
        “currencyPrices”:[
            {
                “currencyId”:“”,
                “price”:0
            }
        ],
        “description”:“”,
        “obsSeriesTagId”:“”,
        “productNumber”:“”,
        “customTags”:[
            {
                “name”:“”,
                “obsKeyId”:“”,
                “obsTagId”:“”
            }
        ],
        “buyLink”:“”,
        “brandGoodCode”:“”,
        “seriesTagName”:“”,
        “obsBrandId”:“”,
        “dimensions”:“”
    },
    “c”:“”
}

Field Description

Parameter	Is it necessary	Parameter type	Parameter description
d	no	list&object	The returned products generate a list of viewer state objects
d.status	no	number	Corresponding viewer generation status, please refer to appendix 1 for status enumeration
d.obsBrandGoodId	no	string	Brandgoodid of the parameter
d.published	no	boolean	Whether it’s published or not, the unlisted products will not be displayed on the external page
c	no	string	error code
d	no	object	Returned data object
d.dimensions	no	string	size
d.description	no	string	description
d.brandGoodName	no	string	product name
d.brandName	no	string	brand name
d.obsBrandId	no	string	Brand id
d.seriesTagName	no	string	Series name
d.obsSeriesTagId	no	string	Series id
d.productNumber	no	string	model
d.brandGoodCode	no	string	product code
d.customerTexture	no	string	material
d.currencyPrices	no	list&object	Multi-currency
d.currencyPrices.price	no	number	Current currency price
d.currencyPrices.currencyId	no	string	Currency Id
d.buyLink	no	string	Purchase link
d.customTags	no	list&object	Commodity label
d.customTags.obsTagId	yes	string	Tag id
d.customTags.obsKeyId	yes	string	Tag class Id
d.customTags.name	yes	string	Label name
d.imgs	no	string	Physical map (use ’,’ to separate)

Send 3DViewer rendering request

Description

Initiate 3dviewer request by product id
The request will be intercepted in the following situations

The product creation time is before June 30, 2017
The product is not a model
The product has been deleted
The product has not been rendered
The product has already generated 3DViewer resources

If the product meets the above conditions, it will be placed in failed.
Failure to send a request will also be included in failed.

API

POST  https://openapi.kujiale.com/v2/commodity/viewer/render/tasks
Content-Type: application/json;

Entry

Request Body

{
	"obsBgIds":[
		""
	]
}

Request body parameter description:

Parameter	Is it necessary	Parameter type	Parameter description
obsBgIds	yes	list&string	product id and list

Response

data structure

{
	"d":{
		"estimatedTime":0,
		"failed":[
			{
				"reason":[
					""
				],
				"brandGoodName":"",
				"obsBrandGoodId":"",
				"previewImg":""
			}
		],
		"pass":[
			{
				"obsBrandGoodId":"",
				"brandGoodName":"",
				"previewImg":""
			}
		],
		"pending":""
	},
	"c":""
}

Field Description

Parameter	Is it necessary	Parameter type	Parameter description
d	no	object	null
d.pass	no	list&object	Send success list
d.pass.obsBrandGoodId	no	string	product Id
d.pass.brandGoodName	no	string	product name
d.pass.previewImg	no	string	Preview image of the product
d.failed	no	list&object	Send failure list
d.failed.reason	no	list&string	Reason for failure
d.failed.brandGoodName	no	string	product name
d.failed.obsBrandGoodId	no	string	product Id
d.failed.previewImg	no	string	Preview image of the product
d.estimatedTime	no	number	Estimated queuing time (hours)
d.pending	no	boolean	Whether to queue
c	no	string	null

Kooviewer Search for Goods

Description

Product search api dedicated to Kooviewer business

API

POST https://openapi.kujiale.com/v2/modelviewer/commodity/search

Entry

Request Body

{
	"q":"string",
	"code":"string",
	"lastModifiedStart":"",
	"num":"",
	"start":"",
	"catGroup":"",
	"lastModifiedEnd":""
}

Request body parameter description:

Parameter	Is it necessary	Parameter type	Parameter description
catGroup	yes	int	The industry to which the product belongs.
start	no	int	The offset of the pull list, starting from 0.
num	no	int	The upper limit of the number of pulls at one time. Considering data security and performance, the maximum value of num is limited to 50. If you need to pull more data, please initiate multiple requests. If the amount of remaining data is less than num, all remaining data will be returned. For example, start=0&num=10 means to pull the 1st to 10th data, start=10&num=10 means to pull the 11th to 20th data.
q	no	string	The query term will be used to fuzzy match the product name.
code	no	string	Commodity code is an identification field set by merchants for commodities under their own account system.
lastModifiedStart	no	long	The starting value in the time range of the most recent product update, accurate to milliseconds. The default is to start from the beginning of the product creation.
lastModifiedEnd	no	long	The end value in the time range of the most recent product update, accurate to milliseconds. The default is the current time.

Response

data structure

{
	"d":{
		"count":0,
		"hasMore":"",
		"result":[
			{
				"brandName":"酷家乐",
				"code":"12222",
				"created":0,
				"customTexture":"百叶按",
				"description":"经典级白叶桉面板，咖啡色金属支腿",
				"type":"软装",
				"imgUrl":"http://qhyxpic.oss.kujiale.com/rbet/2014/12/26/NUBRME6W7JALJTGFEY4BQXYO_240x240.jpg",
				"size":{
					"x":0,
					"y":0,
					"z":0
				},
				"name":"塔罗斯餐桌-180-90-k009",
				"subType":0,
				"id":"3FO4K4WE71VB",
				"lastModified":0,
				"brandLogo":"http://qhyxpic.oss.kujiale.com/rbet/2014/12/26/NUBRME6W7JALJTGFEY4BQXYO_240x240.jpg",
				"largeImgUrl":"http://qhyxpic.oss.kujiale.com/rbet/2014/12/26/NUBRMG6W7JALJTGFEY4BQXYO_800x800.jpg"
			}
		],
		"totalCount":0
	},
	"m":"",
	"c":"0"
}

Field Description

Parameter	Is it necessary	Parameter type	Parameter description
c	no	string	null
m	no	string	null
d	no	object	null
d.totalCount	no	number	null
d.count	no	number	null
d.hasMore	no	boolean	null
d.result	no	list&object	null
d.result.id	yes	string	Product ID
d.result.name	yes	string	Product name
d.result.description	no	string	product description
d.result.type	yes	string
Commodity type, the optional values are "hard outfit" and "soft outfit". When in doubt or inaccurate about this value, the more detailed subType shall prevail
d.result.subType	yes	number	For a more detailed classification of commodity types, see the enumeration in the appendix
d.result.size	no	object
Product size, the size information is only available when the subType of the product is 1. x, y, z represent the length, width, and height of the product
d.result.size.x	no	number	null
d.result.size.y	no	number	null
d.result.size.z	no	number	null
d.result.largeImgUrl	no	string	The URL of the product preview image
d.result.imgUrl	yes	string	Product preview URL.
d.result.brandName	no	string	Commodity brand name.
d.result.brandLogo	no	string	The URL of the product brand logo image
d.result.customTexture	no	string
product quality
d.result.code	no	string	Commodity code is an identification field set by merchants for commodities under their own account system
d.result.created	no	number
Creation timestamp
d.result.lastModified	no	number	Last modified timestamp

error code

code	name	description
21610000	Server Error	Server Error

appendix

catGroup enumeration value

Value	meaning
1	Model library
2	Post Gallery
3	Pave
4	Lines/wall panels
5	Cabinet tools
6	Wardrobe tools

subType enumeration value

value	meaning
1	model
3	hard outfit
4	Gusset
5	Skirting
8	Hardware
9	Parametric model
10	Brick
11	Wave line
12	Floor tile style
13	Integrated wall panel
14	Parametric lines
15	Parametric combination model
16	Combination model
17	contour line
18	Waterjet parquet
19	No physical model

Kooviewer obtains product replaceable materials

Description

Obtain product information about replaceable materials

API

GET https://openapi.kujiale.com/v2/modelviewer/commodity/replace

Entry

Query Param

Parameter	Is it necessary	Parameter type	Parameter description
brandgoodid	yes	string	Commodity id, only supports model type commodities

Request Body

{
	"d":[
		{
			"replaceDetailList":[
				{
					"materialId":"",
					"name":"",
					"srcImage":""
				}
			],
			"defualtReplaceInfo":{
				"materialId":"",
				"name":"",
				"srcImage":""
			},
			"componentName":"凳面"
		}
	],
	"m":"",
	"c":"0"
}

Field Description

Parameter	Is it necessary	Parameter type	Parameter description
c	no	string	null
m	no	string	null
d	no	list&object	null
d.defualtReplaceInfo	no	object	defualtReplaceInfo
d.defualtReplaceInfo.srcImage	no	string	image
d.defualtReplaceInfo.materialId	no	string	null
d.defualtReplaceInfo.name	no	string	name
d.replaceDetailList	no	list&object	null
d.replaceDetailList.srcImage	no	string	replace image
d.replaceDetailList.materialId	no	string	null
d.replaceDetailList.name	no	string	null
d.componentName	yes	string	null

error code

code	name	description
21610000	Server Error	Server Error