updateProductOrder(byID:)

Declaration

static func updateProductOrder(byID order: some Collection<String>) async throws

Parameters

• order:

  A collection of product identifiers (Id) in the order that you want the promoted in-app purchases to appear, from first to last. Use an empty list to cancel previous changes.

Mentioned in

• Supporting promoted In-App Purchases in your app

Discussion

Call this static method to override the default order of promoted in-app purchases on the current device. You provide the product identifiers of the promoted in-app purchases to set their order.

To hide a promoted in-app purchase so it doesn’t display in the App Store for the user, don’t include its product identifier when calling this method. You may want to do this, for example, if the user has already purchased the product, or if it isn’t relevant to them for some other reason.

To set the order using Product.PromotionInfo objects instead of product identifiers, see updateAll(_:).

Cancel overrides

To cancel the order and visibility changes you make, send an empty collection in the order parameter. All in-app purchases then display in the default order.

// Cancel overrides by using an empty collection.
do {
    try await Product.PromotionInfo.updateProductOrder(byID: [])
}
catch {
    <#Handle error.#>
}