ListMasterProduct¶
Use this api to search products.
POST /openapi/product/master/v1/list
Request Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
createDateFrom |
string |
false |
Creation time(begin)， For example 2022-01-23T16:00:00.247Z |
createDateTo |
string |
false |
Creation time(end)， For example 2022-01-23T16:00:00.247Z, createDateFrom and createDateTo must exist at the same time or Don't exist at the same time |
productName |
string |
false |
Product name,Only one product Name and bar Code can be passed at the same time |
sku |
string |
false |
Main product sku, not case-sensitive |
barCode |
string |
false |
barCode,Only one product Name and bar Code can be passed at the same time |
categoryId |
string |
false |
category id, If there are multiple layers, pass one of the last layers |
page |
integer |
true |
page no, greater than or equal to 0 |
size |
integer |
true |
page size, greater than 0, less than 500 |
Response Parameters¶
| Name | Type | Description |
|---|---|---|
productId |
string |
Product id |
name |
string |
Product name |
fullCategoryId |
array(string) |
Full category id,Return in hierarchical order |
fullCategoryName |
array(string) |
Full category name,Return in hierarchical order |
masterVariationType |
string |
Master variation type,NORMAL or BUNDLE |
masterProductStatus |
string |
Master product status,please refer to Product Status for details |
images |
array(string) |
Image |
variationBriefs |
array(VariationBrief) |
Variation Briefs |
createDatetime |
UTC timestamp |
Create date time |
updateDatetime |
UTC timestamp |
Update date time |
page |
long |
The current page |
size |
long |
size |
total |
long |
The total number of |
VariationBrief¶
| Name | Type | Description |
|---|---|---|
id |
string |
|
sku |
string |
|
optionValues |
array(string) |
Option Values |
boundChannelVariationCount |
long |
Bound Channel Variation Count |
boundShopCount |
long |
Bound Shop Count |
stock |
StockDetail |
stock |
autoBindingRules |
array(string) |
Auto Binding Rules |
barcode |
string |
barcode |
stockTagStatus |
StockTagStatusVO |
Stock Tag Status |
StockDetail¶
| Name | Type | Description |
|---|---|---|
warehouseStock |
integer |
Warehouse Stock |
spareStock |
integer |
Spare Stock |
availableStock |
integer |
Available Stock |
safetyStock |
integer |
Safety Stock |
safetyAlert |
boolean |
Safety Alert |
StockTagStatusVO¶
| Name | Type | Description |
|---|---|---|
warehouseStatus |
boolean |
Whether the warehouse has been added and stored |
bundleStatus |
boolean |
Whether a composite type |
stockSyncStatus |
boolean |
Whether to enable the same increase and decrease of inventory |
Request Example¶
Example
curl --location --request POST 'localhost:9020/openapi/product/master/v1/list' \
--header 'Content-Type: application/json' \
--header 'X-Advai-Country: ID' \
--header 'Authorization: 2aedf7919e5e6cb4:n0IECNXloTKCTSSxeBEYhzmeVClHmgvw4ruI3W2f9eY=' \
--data-raw '{
"page":2,
"size":2
}'
Success
{
"code": "SUCCESS",
"message": "成功",
"data": {
"page": 2,
"size": 2,
"total": 11792,
"content": [
{
"productId": "MP617A8E2B7ECFE005666A54F2",
"name": "Joy-Con Controllers",
"fullCategoryId": [
"100634",
"100696"
],
"fullCategoryName": [
"Gaming & Consoles",
"Console Accessories"
],
"masterVariationType": "NORMAL",
"masterProductStatus": "PENDING_REVIEW",
"images": [
"https://cf.shopee.co.id/file/4bcfe9f364018a9267d6f71032ee47a6"
],
"variationBriefs": [
{
"id": "MV617A8E2B7ECFE005666A54F4",
"sku": "3Neon Red (L)/Blue(R) Joy-Con Controllers",
"optionValues": [
"Neon Red (L)/Blue(R)"
],
"boundChannelVariationCount": 0,
"boundShopCount": 0,
"stock": {
"warehouseStock": 0,
"spareStock": 0,
"availableStock": 231212,
"safetyStock": 0,
"safetyAlert": false
},
"autoBindingRules": [
"3Neon Red (L)/Blue(R) Joy-Con Controllers"
],
"barcode": "111112",
"stockTagStatus": {
"warehouseStatus": false,
"bundleStatus": false,
"stockSyncStatus": true
}
},
{
"id": "MV617A8E2B7ECFE005666A54F5",
"sku": "3Green(L)/Pink(R) Joy-Con Controllers",
"optionValues": [
"Green(L)/Pink(R)"
],
"boundChannelVariationCount": 0,
"boundShopCount": 0,
"stock": {
"warehouseStock": 0,
"spareStock": 0,
"availableStock": 333,
"safetyStock": 0,
"safetyAlert": false
},
"autoBindingRules": [
"3Green(L)/Pink(R) Joy-Con Controllers"
],
"barcode": "22223",
"stockTagStatus": {
"warehouseStatus": false,
"bundleStatus": false,
"stockSyncStatus": true
}
},
{
"id": "MV617A8E2B7ECFE005666A54F6",
"sku": "4Purple(L)/Orange(R) Joy-Con Controllers",
"optionValues": [
"Purple(L)/Orange(R)"
],
"boundChannelVariationCount": 0,
"boundShopCount": 0,
"stock": {
"warehouseStock": 0,
"spareStock": 0,
"availableStock": 2212,
"safetyStock": 0,
"safetyAlert": false
},
"autoBindingRules": [
"4Purple(L)/Orange(R) Joy-Con Controllers"
],
"barcode": "33334",
"stockTagStatus": {
"warehouseStatus": false,
"bundleStatus": false,
"stockSyncStatus": true
}
},
{
"id": "MV617A8E2B7ECFE005666A54F7",
"sku": "5Blue(L) / Yellow(R) Joy-Con Controllers",
"optionValues": [
"Blue(L) / Yellow(R)"
],
"boundChannelVariationCount": 0,
"boundShopCount": 0,
"stock": {
"warehouseStock": 0,
"spareStock": 0,
"availableStock": 5555,
"safetyStock": 0,
"safetyAlert": false
},
"autoBindingRules": [
"5Blue(L) / Yellow(R) Joy-Con Controllers"
],
"barcode": "54444",
"stockTagStatus": {
"warehouseStatus": false,
"bundleStatus": false,
"stockSyncStatus": true
}
}
],
"delivery": null,
"costInfo": null,
"shortDescription": null,
"description": null,
"brand": null,
"saleStatus": null,
"genieProductCondition": null,
"variantOptions": null,
"variations": null,
"extraInfo": null,
"createDatetime": "2021-10-28T11:48:59Z",
"updateDatetime": "2021-10-29T09:53:11Z",
"minPurchase": null,
"skusDeletable": null
},
{
"productId": "MP617A7C407ECFE0019A40C9BB",
"name": "Joy-Con Controllers",
"fullCategoryId": [
"100634",
"100696"
],
"fullCategoryName": [
"Gaming & Consoles",
"Console Accessories"
],
"masterVariationType": "NORMAL",
"masterProductStatus": "PENDING_REVIEW",
"images": [
"https://cf.shopee.co.id/file/4bcfe9f364018a9267d6f71032ee47a6"
],
"variationBriefs": [
{
"id": "MV617A7C407ECFE0019A40C9BD",
"sku": "2Neon Red (L)/Blue(R) Joy-Con Controllers",
"optionValues": [
"Neon Red (L)/Blue(R)"
],
"boundChannelVariationCount": 0,
"boundShopCount": 0,
"stock": {
"warehouseStock": 0,
"spareStock": 0,
"availableStock": 0,
"safetyStock": 0,
"safetyAlert": false
},
"autoBindingRules": [
"2Neon Red (L)/Blue(R) Joy-Con Controllers"
],
"barcode": "11111",
"stockTagStatus": {
"warehouseStatus": false,
"bundleStatus": false,
"stockSyncStatus": true
}
},
{
"id": "MV617A7C407ECFE0019A40C9BE",
"sku": "2Green(L)/Pink(R) Joy-Con Controllers",
"optionValues": [
"Green(L)/Pink(R)"
],
"boundChannelVariationCount": 0,
"boundShopCount": 0,
"stock": {
"warehouseStock": 0,
"spareStock": 0,
"availableStock": 0,
"safetyStock": 0,
"safetyAlert": false
},
"autoBindingRules": [
"2Green(L)/Pink(R) Joy-Con Controllers"
],
"barcode": "2222",
"stockTagStatus": {
"warehouseStatus": false,
"bundleStatus": false,
"stockSyncStatus": true
}
},
{
"id": "MV617A7C407ECFE0019A40C9BF",
"sku": "3Purple(L)/Orange(R) Joy-Con Controllers",
"optionValues": [
"Purple(L)/Orange(R)"
],
"boundChannelVariationCount": 0,
"boundShopCount": 0,
"stock": {
"warehouseStock": 0,
"spareStock": 0,
"availableStock": 0,
"safetyStock": 0,
"safetyAlert": false
},
"autoBindingRules": [
"3Purple(L)/Orange(R) Joy-Con Controllers"
],
"barcode": "3333",
"stockTagStatus": {
"warehouseStatus": false,
"bundleStatus": false,
"stockSyncStatus": true
}
},
{
"id": "MV617A7C407ECFE0019A40C9C0",
"sku": "4Blue(L) / Yellow(R) Joy-Con Controllers",
"optionValues": [
"Blue(L) / Yellow(R)"
],
"boundChannelVariationCount": 0,
"boundShopCount": 0,
"stock": {
"warehouseStock": 0,
"spareStock": 0,
"availableStock": 0,
"safetyStock": 0,
"safetyAlert": true
},
"autoBindingRules": [
"4Blue(L) / Yellow(R) Joy-Con Controllers"
],
"barcode": "4444",
"stockTagStatus": {
"warehouseStatus": false,
"bundleStatus": false,
"stockSyncStatus": true
}
}
],
"createDatetime": "2021-10-28T10:32:32Z",
"updateDatetime": "2021-10-28T10:44:09Z",
}
]
},
"extra": null,
"pricingStrategy": "PAY"
}
Invalid parameters
{
"code": "PARAMETER_ERROR",
"message": "error message",
"data": null,
"extra": null
}
Note
You need to check the code to see if the operation was successful. If failed, see message for detail reason.