Skip to content

GetMasterProductDetail

Use this api to get the specified product details.

GET /openapi/product/master/v1/get

Request Parameters

Parameter Type Required Description
productId string true The product id in Ginee

Response Parameters

Name Type Description
productId string Product id in Ginee
name string Product name
fullCategoryId array(string) Full category id
fullCategoryName array(string) Full category name
masterVariationType string Master variation type (NORMAL,BUNDLE)
masterProductStatus string Master product status,please refer to Product Status for details
images array(string) images
delivery Delivery Delivery info
costInfo CostInfo Cost info
shortDescription string Short description
description string Description
brand string brand
saleStatus string Product sale status,please refer to Sale Status for details
genieProductCondition string Ginee product Condition (NEW,USED)
variantOptions array(object) Variant options,See VariantOption Info
variations array(object) Master variation Detail,See MasterVariation Info
extraInfo object Extra Info,See Extra Info
createDatetime UTC timestamp Create date time
updateDatetime UTC timestamp Update date time
minPurchase integer Minimum purchase quantity
skusDeletable boolean Whether the SKU can be deleted
spu string spu

Variant Option

Parameter Type Required Description
name string true Variant name, such as color, size
values array(string) true The value of the variant, such as red and yellow and size

Master Variation

Parameter Type Required Description
optionValues array(string) false Variant value, such as red code and L code
sellingPrice object true The sellingPrice is required and less than 1000000000,See Price
averageCostPrice object false Average Cost Price,See Price
sku string true Sku is required and less than 200
images array(string) false Picture of the SKU
stock object true See StockDetail Info
purchasePrice object false The purchase Price is required when type is not a BUNDLE and is less than 1000000000,See Price
bundleVariations object false If it is a combination of goods, information about the SKUS bundled with the combination SKUS is displayed,See BundleVariation Info
barcode string false Barcode only supports letters, numbers and -_ ,Barcode is optional, but the unique value will be verified,Less than 128 characters in length
status string true Available values: ACTIVE、DISABLED、DELETED

Bundle Variation

Parameter Type Required Description
quantity integer false Variation quantity
bundleVariationId string false Bundle Variation Id,Obtained via ListMasterProduct endpoint

Stock Detail

Parameter Type Required Description
availableStock integer true Available stock,between 1 and 999999
safetyStock integer false Safety Stock
safetyAlert boolean false Safety Alert

Product Extra

Parameter Type Required Description
preOrder object false See PreOrder Info
hasShelfLife boolean false Has Shelf Life,true or false
shelfLifePeriod integer false Shelf Life Period
additionInfo object false Additional information See Additional Info

Additional

Parameter Type Required Description
remark1 string false remark
remark2 string false remark
remark3 string false remark

Pre Order

Parameter Type Required Description
settingType string false Pre order setting type (PRODUCT_ON,INHERIT_SHOP,PRODUCT_OFF)
timeToShip integer false Number of hours, for example 12
timeUnit string false Purchasing time unit (HOUR,DAY,WORK_DAY,WEEK,MONTH)

Price

Parameter Type Required Description
amount bigDecimal true Amount,less than 1000000000
currencyCode string true Currency code,For example: ID,please refer to Country Abbreviation for details

Request Example

Example

curl --location --request GET '{Ginee Host}/openapi/product/master/v1/get?productId=MP60C1F538EE3588000147F0D2' \
--header 'Content-Type: application/json' \
--header 'X-Advai-Country: ID' \
--header 'Authorization: 2aedf7919e5e6cb4:n0IECNXloTKCTSSxeBEYhzmeVClHmgvw4ruI3W2f9eY=' \

Success

{
    "code": "SUCCESS",
    "message": "成功",
    "data": {
        "productId": "MP60C1F538EE3588000147F0D2",
        "name": "test00222222222222222222",
        "fullCategoryId": [],
        "fullCategoryName": [],
        "masterVariationType": "NORMAL",
        "masterProductStatus": "PENDING_REVIEW",
        "images": [
            "https://cf.shopee.ph/file/9baef621c406c447c82d3f3f42bd8a03"
        ],
        "delivery": {
            "length": 1,
            "width": 1,
            "height": 1,
            "lengthUnit": "cm",
            "weight": 1000,
            "weightUnit": "g",
            "barcode": null
        },
        "costInfo": {
            "sourceUrl": null,
            "purchasingTime": null,
            "purchasingTimeUnit": null,
            "salesTax": {
                "amount": 0,
                "currencyCode": "IDR"
            }
        },
        "shortDescription": null,
        "description": "1test002222222222222",
        "brand": null,
        "saleStatus": "FOR_SALE",
        "genieProductCondition": "NEW",
        "variantOptions": [],
        "variations": [
            {
                "id": "MV60C1F538EE3588000147F0D3",
                "productName": "test00222222222222222222",
                "optionValues": [
                    "-"
                ],
                "sellingPrice": {
                    "amount": 100.000000,
                    "currencyCode": "IDR"
                },
                "averageCostPrice": {
                    "amount": 0.000000,
                    "currencyCode": "IDR"
                },
                "sku": "SHP5454",
                "images": [
                    "https://cf.shopee.ph/file/9baef621c406c447c82d3f3f42bd8a03"
                ],
                "status": "ACTIVE",
                "createFrom": null,
                "variationSkusToBind": [],
                "stock": {
                    "warehouseStock": 0,
                    "spareStock": 0,
                    "availableStock": 110,
                    "safetyStock": 0,
                    "safetyAlert": false
                },
                "purchasePrice": null,
                "type": "NORMAL",
                "bundleVariations": null,
                "barcode": null,
                "stockTagStatus": {
                    "warehouseStatus": false,
                    "bundleStatus": null,
                    "stockSyncStatus": true
                },
                "boundChannelVariationCount": 1
            }
        ],
        "extraInfo": {
            "warranty": {
                "type": null,
                "period": null
            },
            "preOrder": {
                "settingType": "PRODUCT_OFF",
                "timeToShip": null,
                "timeUnit": null
            },
            "hasShelfLife": false,
            "shelfLifePeriod": null,
            "storageRestriction": null,
            "deliveryRestriction": null
        },
        "createDatetime": "2021-06-10T11:19:20Z",
        "updateDatetime": "2021-06-10T11:19:20Z",
        "minPurchase": null,
        "skusDeletable": false,
        "spu": "sga"
    },
    "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.