Skip to content

Commit ff708d1

Browse files
docs(purchases): update README.md
1 parent 9263869 commit ff708d1

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

packages/purchases/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ const restorePurchases = async () => {
9898
* [`getAllTransactions()`](#getalltransactions)
9999
* [`getCurrentTransactions()`](#getcurrenttransactions)
100100
* [`getProductById(...)`](#getproductbyid)
101+
* [`getProductsByIds(...)`](#getproductsbyids)
101102
* [`getUnfinishedTransactions()`](#getunfinishedtransactions)
102103
* [`isAvailable()`](#isavailable)
103104
* [`isIntroOfferAvailableForProduct(...)`](#isintroofferavailableforproduct)
@@ -191,6 +192,27 @@ Only available on Android and iOS (15.0+).
191192
--------------------
192193

193194

195+
### getProductsByIds(...)
196+
197+
```typescript
198+
getProductsByIds(options: GetProductsByIdsOptions) => Promise<GetProductsByIdsResult>
199+
```
200+
201+
Get product details for multiple products by their IDs.
202+
203+
Only available on Android and iOS (15.0+).
204+
205+
| Param | Type |
206+
| ------------- | --------------------------------------------------------------------------- |
207+
| **`options`** | <code><a href="#getproductsbyidsoptions">GetProductsByIdsOptions</a></code> |
208+
209+
**Returns:** <code>Promise&lt;<a href="#getproductsbyidsresult">GetProductsByIdsResult</a>&gt;</code>
210+
211+
**Since:** 7.2.0
212+
213+
--------------------
214+
215+
194216
### getUnfinishedTransactions()
195217

196218
```typescript
@@ -368,6 +390,20 @@ Represents an in-app product available for purchase.
368390
| **`productId`** | <code>string</code> | The product ID of the product to retrieve. On Android, this is the <a href="#product">Product</a> ID configured in Google Play Console. On iOS, this is the <a href="#product">Product</a> ID configured in App Store Connect. | 0.3.1 |
369391

370392

393+
#### GetProductsByIdsResult
394+
395+
| Prop | Type | Description | Since |
396+
| -------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
397+
| **`products`** | <code>Product[]</code> | The product details for the requested products. Note: If some products are not found, they will not be included in the array. The array may contain fewer products than requested. | 7.2.0 |
398+
399+
400+
#### GetProductsByIdsOptions
401+
402+
| Prop | Type | Description | Since |
403+
| ---------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
404+
| **`productIds`** | <code>string[]</code> | The product IDs of the products to retrieve. On Android, these are the <a href="#product">Product</a> IDs configured in Google Play Console. On iOS, these are the <a href="#product">Product</a> IDs configured in App Store Connect. | 7.2.0 |
405+
406+
371407
#### GetUnfinishedTransactionsResult
372408

373409
| Prop | Type | Description | Since |

0 commit comments

Comments
 (0)