Bagbutik Reference

Generated Swift code for the App Store Connect API based on the official OpenAPI spec.

What is Bagbutik?

Bag·bu·tik (noun) /ˈb̥a̝w-ˌb̥u-tiːk/ - (Danish) A room behind a store

Bagbutik is two things, a command line tool for generating Swift code, and a library with the generated code for the App Store Connect API. The command line tool decodes the official OpenAPI spec for Apple’s App Store Connect API.

While generating the code, the command line tool also downloads the official documentation from Apple’s Documentation site for the App Store Connect API and applies it to the generated code, so you can get documentation right in Xcode.

The command line tool is only needed, when Apple publishes a new version of the spec. A GitHub Action automatically checks for new versions of the spec and creates a pull request with the changes.

How to use Bagbutik

Bagbutik uses JSON Web Tokens (JWT) for authorization. You obtain the required keys from your organization’s App Store Connect account.

See Creating API Keys for App Store Connect API for how to create your keys.

Here is a basic example for fetching all bundle IDs for iOS apps including related profiles sorted by seed ID and the bundle ID itself descending.

import Bagbutik_Core
import Bagbutik_Provisioning

let service = BagbutikService(jwt: try .init(
    keyId: "P9M252746H",
    issuerId: "82067982-6b3b-4a48-be4f-5b10b373c5f2",
    privateKey: """
    -----BEGIN PRIVATE KEY-----
    MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgevZzL1gdAFr88hb2
    OF/2NxApJCzGCEDdfSp6VQO30hyhRANCAAQRWz+jn65BtOMvdyHKcvjBeBSDZH2r
    1RTwjmYSi9R/zpBnuQ4EiMnCqfMPWiZqB4QdbAd0E7oH50VpuZ1P087G
    -----END PRIVATE KEY-----
    """
))
let response = try await service.request(
    .listBundleIdsV1(filters: [.platform([.iOS])],
                     includes: [.profiles],
                     sorts: [.seedIdDescending, .idDescending])
)
print(response)

How to get Bagbutik into a project

Bagbutik is primarily distributed as a source-based Swift package using Swift Package Manager.

For advanced use cases, a prebuilt XCFramework is also provided. Using the XCFramework is optional and does not replace the source-based package.

Using Bagbutik as a source package

The library of generated code consists of multiple libraries, allowing consumers to depend only on the API areas they need.

Add Bagbutik as a dependency in your Package.swift:

dependencies: [
    .package(url: "https://github.com/MortenGregersen/Bagbutik", from: "19.0.0"),
]

Then add the required products to your target:

.target(
    name: "Awesome",
    dependencies: [
        .product(name: "Bagbutik-AppStore", package: "Bagbutik"),
        .product(name: "Bagbutik-TestFlight", package: "Bagbutik"),
    ]
)

If you need access to all APIs, you can depend on the umbrella library:

.target(
    name: "Awesome",
    dependencies: [
        .product(name: "Bagbutik", package: "Bagbutik"),
    ]
)

Available modules

Each module corresponds to a specific area of the App Store Connect API:

Bagbutik-AppStore: Manage all aspects of your app, App Clips, in-app purchases, and customer reviews in the App Store.
Bagbutik-GameCenter: Manage Game Center data and configurations for your apps.
Bagbutik-Marketplaces: Manage keys, packages, and search for the marketplace distribution of your app.
Bagbutik-Provisioning: Manage the bundle IDs, certificates, devices and provisioning profiles for your app.
Bagbutik-Reporting: Download your sales and financial reports and get power and performance metrics, logs, and signatures.
Bagbutik-TestFlight: Manage your beta testing program, including beta testers and groups, apps, App Clips, and builds.
Bagbutik-Users: Manage users and email invitations to join your App Store Connect team.
Bagbutik-Webhooks: Manage notifications from App Store about your apps and their statuses.
Bagbutik-XcodeCloud: Automate reading Xcode Cloud data, managing workflows, and starting builds.

Remember to replace hyphens with underscores when importing modules. For example, when importing Bagbutik-TestFlight:

import Bagbutik_TestFlight

Using the XCFramework

Bagbutik releases also include a prebuilt XCFramework for cases where you prefer a binary dependency, such as:

Faster CI builds
Tooling or plugin projects
Avoiding recompilation of all Bagbutik modules

The XCFramework contains the umbrella Bagbutik module.

Option 1: Use the XCFramework via URL and checksum (recommended)

Add a binary target in your Package.swift:

.binaryTarget(
    name: "Bagbutik",
    url: "https://github.com/MortenGregersen/Bagbutik/releases/download/<VERSION>/Bagbutik.xcframework.zip",
    checksum: "<CHECKSUM>"
)

The exact checksum for each version is listed in the corresponding GitHub Release.

Then add Bagbutik as a dependency:

.target(
    name: "Awesome",
    dependencies: [
        "Bagbutik"
    ]
)

Import Bagbutik in your source files:

import Bagbutik

Option 2: Use a downloaded XCFramework (local path)

Alternatively, you can download Bagbutik.xcframework.zip from the GitHub Release, unzip it, and commit Bagbutik.xcframework into your repository (for example in a Vendor/ directory).

Declare a local binary target:

.binaryTarget(
    name: "Bagbutik",
    path: "Vendor/Bagbutik.xcframework"
)

Add Bagbutik as a dependency:

.target(
    name: "Awesome",
    dependencies: [
        "Bagbutik"
    ]
)

Import Bagbutik in your source files:

import Bagbutik

Swift and Xcode compatibility

The XCFramework is built with a specific Xcode / Swift version, which is documented in the corresponding GitHub Release.

Binary Swift frameworks are only guaranteed to be compatible with the same or newer Swift compiler versions. If you need maximum compatibility or want to use a different Swift version, prefer using Bagbutik as a source package.

Manual patches applied to OpenAPI Spec

The OpenAPI Spec provided by Apple do not always align with the data received from the API. Whenever such mismatches are identified, feedback is submitted to Apple and a patch is applied. Whenever an issue is resolved, the patch is removed again.

Currently open feedback and applied patches

FB8977648: The “BundleIdPlatform” schema is missing “UNIVERSAL” and “SERVICES”

Submitted: January 21st 2021.
Updated: October 14th 2022 - the type “SERVICES” is also missing.
Partly resolved: November 12th 2024 (Spec version 3.7) - “UNIVERSAL” added.

Title: App Store Connect API is missing the “UNIVERSAL” type for the BundleIdPlatform schema

Description

In the OpenAPI spec for the App Store Connect API the “BundleIdPlatform” schema is said to only be “IOS” or “MAC_OS”. This is not right as universal apps (iOS and macOS) has a “UNIVERSAL” platform.

FB12292035: ErrorResponse.Errors has required optional “detail” and no “associatedErrors” in “meta”

Submitted: June 9th 2023.

In Apple’s OpenAPI spec the detail property on ErrorResponse.Errors is marked as required. On 12/1/23 some errors (with status code 409) has been observed, with no detail.

In Apple’s OpenAPI spec and documentation the associatedErrors is not mentioned in meta property (last checked 12/1/23). But it is observed when creating a ReviewSubmissionItem with an AppStoreVersion fails.

FB16908301: App Store Connect API Spec is missing list of possible “PurchaseRequirement” on AppEvent

Submitted: March 17th, 2025.

In the OpenAPI spec (and documentation) for the App Store Connect API the purchaseRequirement property on the “AppEvent” schema is a string. As a consumer of the API, we don’t know the possible values of this could be. After doing some research, it looks like there are two options NO_COST_ASSOCIATED and IN_APP_PURCHASE.

Closed feedback (removed patches)

FB9963088: The xcodeMetrics schema has no properties or attributes in the OpenAPI spec
- Submitted: March 21st 2022.
- Resolved: July 12th 2022 (Spec version 2.0).
FB10029609: Required ‘links’ property missing on included BuildBundle
- Submitted: May 27th 2022.
- Resolved: At least since May 23rd 2023.
FB13071298: App Store Connect API Spec is missing “VISION_OS” type for the Platform schema
- Submitted: August 28th 2023.
- Resolved: January 25th 2024 (Spec version 3.2).
FB13539766: App Store Connect API Spec is missing “APP_APPLE_VISION_PRO” type for the Screenshot Display Type schema
- Submitted: January 14th 2024.
- Resolved: January 25th 2024 (Spec version 3.2).
FB13540097: Almost all of the schemas ending in “WithoutIncludesResponse” has wrong “data” type
- Submitted: January 14th 2024.
- Resolved: July 11th 2024 (Spec version 3.5).
FB13701181: App Store Connect API Spec is missing “DEVELOPER_ID_APPLICATION_G2” type for the Certificate Type schema
- Submitted: March 28th 2024.
- Resolved: November 12th 2024 (Spec version 3.7).
FB15681740: App Store Connect API Spec is missing “APPLE_VISION_PRO” type for the Device class type schema
- Submitted: November 4th 2024.
- Resolved: June 10th 2025 (Spec version 4.0).
FB17874677: The “AgeRatingDeclaration.Attributes” properties is missing the values “INFREQUENT_OR_MILD” and “FREQUENT_OR_INTENSE”
- Submitted: June 10th 2025.
- Resolved: October 9th 2025 (Spec version 4.1).
FB17925890: The “ageRatingOverride” property of “AgeRatingDeclaration.Attributes” is missing
- Submitted: June 11th 2025.
- Resolved: October 9th 2025 (Spec version 4.1).
FB17932433: The “totalNumberOfCodes” property of “SubscriptionOfferCode.Attributes” is missing
- Submitted: June 11th 2025.
- Resolved: October 9th 2025 (Spec version 4.1).
FB16699896: App Store Connect API is missing “XKS” (Kosovo) for the TerritoryCode enum
- Submitted: March 3rd, 2025.
- Resolved: December 16th, 2025 (Spec version 4.2).