getVasSpuList – Tuya MiniApp

getVasSpuList(data: GetVasSpuListParams)

Requires:

@tuya-miniapp/cloud-api≥1.5.0

Description

Retrieve the list of value-added service commodities for the specified business, filter by bound target and tags, and optionally return SKU, pricing, and capability information.

Parameters

Parameter	Type	Required	Description
		Yes	Request parameters

Return Value

Type: Promise<GetVasSpuListResult>

Array of value-added service commodities; each item includes commodity information, redirect link, order parameters, and an optional SKU list

Referenced Types

typeGetVasSpuListResultResult of querying the value-added service product list

VasCommodity[]

enumVasBindingObjectType

Value	Actual Value	Description
`VasBindingObjectType.PID`	`0`	PID
`VasBindingObjectType.MINI_APP`	`1`	Mini App
`VasBindingObjectType.APP`	`2`	APP

enumVasPaymentScope

Value	Actual Value	Description
`VasPaymentScope.ALL`	`0`	All
`VasPaymentScope.ONLY_IAP`	`1`	IAP only
`VasPaymentScope.ONLY_NON_IAP`	`2`	Non-IAP only
`VasPaymentScope.AUTO_IAP`	`99`	Auto-select whether to use IAP

Valid Values

`VasBindingObjectType`

Value	Description	Since
`0`	PID	-
`1`	Mini App	-
`2`	APP	-

`VasPaymentScope`

Value	Description	Since
`0`	All	-
`1`	IAP only	-
`2`	Non-IAP only	-
`99`	Auto-select whether to use IAP	-

Examples

Request example

import { getVasSpuList, VasBindingObjectType } from '@tuya-miniapp/cloud-api';

getVasSpuList({
  bindingObjectType: VasBindingObjectType.APP,
  bindingObjectCode: 'your_app_id',
  catalogCode: 'your_catalog_code',
  bindingTags: ['your_binding_tag'],
  needSkuList: true,
  clientInfo: {
    appScheme: 'your_app_scheme',
    osSystem: 'iOS',
  },
})
  .then(products => {
    console.log('Value-added service products:', products);
  })
  .catch(error => {
    console.error('Failed to query value-added service products:', error);
  });

Response example

[
  {
    "commodityCode": "your_commodity_code",
    "title": "Value-added service products",
    "subTitle": "",
    "mainPicture": "https://example.com/product.png",
    "mallCode": "your_mall_code",
    "siteCode": "your_site_code",
    "bindingTag": "your_binding_tag",
    "commodityUrl": "your_app_scheme://miniApp?uniqueCode=entryxnoib655wnyms&commodityCode=your_commodity_code&mallCode=your_mall_code&siteCode=your_site_code",
    "targetUrlType": 1,
    "requiredCheckoutParams": [
      {
        "code": "your_param_group_code",
        "paramGroup": "your_param_group",
        "paramNames": ["your_param_name"]
      }
    ],
    "skuList": [
      {
        "commodityCode": "your_commodity_code",
        "skuCode": "your_sku_code",
        "extendSkuCode": "",
        "skuName": "Yearly",
        "priceList": [
          {
            "optionType": 0,
            "optionNo": 0,
            "periodType": 0,
            "periodUnit": 1,
            "periodValue": 1,
            "currency": "CNY",
            "price": 99,
            "originalPrice": 199,
            "marketingStrategy": {
              "periodNo": 1,
              "periodUnit": 1,
              "periodValue": 1,
              "orderNo": 0,
              "discountType": 0,
              "discount": 0,
              "appleIapId": ""
            }
          }
        ],
        "capability": {
          "catalogCode": "your_catalog_code",
          "externalCode": "your_external_code",
          "capabilityType": 1,
          "meteringRule": {},
          "performanceRule": {
            "consumeType": 2,
            "consumeInCurrentMonth": false
          }
        },
        "subCapabilities": []
      }
    ]
  }
]