openapi: 3.0.1 info: title: App Store Connect AccessibilityDeclarations AppStoreVersions API version: 4.3.1 x-platforms: app_store_connect_api: App Store Connect API description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles. It covers apps, builds, TestFlight, in-app purchases, subscriptions, Game Center, Xcode Cloud, provisioning, pricing and availability, and the full reporting surface (analytics, sales and trends, financial reports, power and performance). This spec is the official OpenAPI 3.0 document published by Apple at https://developer.apple.com/app-store-connect/api/ — mirrored here unmodified except for title-cased operation summaries. servers: - url: https://api.appstoreconnect.apple.com/ security: - itc-bearer-token: [] tags: - name: AppStoreVersions paths: /v1/appStoreVersions: post: tags: - AppStoreVersions operationId: appStoreVersions_createInstance requestBody: description: AppStoreVersion representation content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionCreateRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '201': description: Single AppStoreVersion content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Create App Store Versions /v1/appStoreVersions/{id}: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_getInstance parameters: - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false required: false - name: fields[apps] in: query description: the fields to include for returned resources of type apps schema: type: array items: type: string enum: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false required: false - name: fields[appStoreVersionLocalizations] in: query description: the fields to include for returned resources of type appStoreVersionLocalizations schema: type: array items: type: string enum: - description - locale - keywords - marketingUrl - promotionalText - supportUrl - whatsNew - appStoreVersion - appScreenshotSets - appPreviewSets - searchKeywords style: form explode: false required: false - name: fields[builds] in: query description: the fields to include for returned resources of type builds schema: type: array items: type: string enum: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false required: false - name: fields[appStoreVersionPhasedReleases] in: query description: the fields to include for returned resources of type appStoreVersionPhasedReleases schema: type: array items: type: string enum: - phasedReleaseState - startDate - totalPauseDuration - currentDayNumber style: form explode: false required: false - name: fields[gameCenterAppVersions] in: query description: the fields to include for returned resources of type gameCenterAppVersions schema: type: array items: type: string enum: - enabled - compatibilityVersions - appStoreVersion style: form explode: false required: false - name: fields[routingAppCoverages] in: query description: the fields to include for returned resources of type routingAppCoverages schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - uploadOperations - assetDeliveryState - appStoreVersion style: form explode: false required: false - name: fields[appStoreReviewDetails] in: query description: the fields to include for returned resources of type appStoreReviewDetails schema: type: array items: type: string enum: - contactFirstName - contactLastName - contactPhone - contactEmail - demoAccountName - demoAccountPassword - demoAccountRequired - notes - appStoreVersion - appStoreReviewAttachments style: form explode: false required: false - name: fields[appStoreVersionSubmissions] in: query description: the fields to include for returned resources of type appStoreVersionSubmissions schema: type: array items: type: string enum: - appStoreVersion style: form explode: false required: false deprecated: true - name: fields[appClipDefaultExperiences] in: query description: the fields to include for returned resources of type appClipDefaultExperiences schema: type: array items: type: string enum: - action - appClip - releaseWithAppStoreVersion - appClipDefaultExperienceLocalizations - appClipAppStoreReviewDetail style: form explode: false required: false - name: fields[appStoreVersionExperiments] in: query description: the fields to include for returned resources of type appStoreVersionExperiments schema: type: array items: type: string enum: - name - trafficProportion - state - reviewRequired - startDate - endDate - appStoreVersion - appStoreVersionExperimentTreatments - platform - app - latestControlVersion - controlVersions style: form explode: false required: false - name: fields[alternativeDistributionPackages] in: query description: the fields to include for returned resources of type alternativeDistributionPackages schema: type: array items: type: string enum: - sourceFileChecksum - versions style: form explode: false required: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - alternativeDistributionPackage style: form explode: false required: false - name: limit[appStoreVersionExperiments] in: query description: maximum number of related appStoreVersionExperiments returned (when they are included) schema: type: integer maximum: 50 style: form required: false deprecated: true - name: limit[appStoreVersionExperimentsV2] in: query description: maximum number of related appStoreVersionExperimentsV2 returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[appStoreVersionLocalizations] in: query description: maximum number of related appStoreVersionLocalizations returned (when they are included) schema: type: integer maximum: 50 style: form required: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AppStoreVersion content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get App Store Versions patch: tags: - AppStoreVersions operationId: appStoreVersions_updateInstance requestBody: description: AppStoreVersion representation content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionUpdateRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AppStoreVersion content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Update App Store Versions delete: tags: - AppStoreVersions operationId: appStoreVersions_deleteInstance responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Delete App Store Versions /v1/appStoreVersions/{id}/relationships/alternativeDistributionPackage: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_alternativeDistributionPackage_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAlternativeDistributionPackageLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / Alternative Distribution Package /v1/appStoreVersions/{id}/alternativeDistributionPackage: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_alternativeDistributionPackage_getToOneRelated parameters: - name: fields[alternativeDistributionPackages] in: query description: the fields to include for returned resources of type alternativeDistributionPackages schema: type: array items: type: string enum: - sourceFileChecksum - versions style: form explode: false - name: fields[alternativeDistributionPackageVersions] in: query description: the fields to include for returned resources of type alternativeDistributionPackageVersions schema: type: array items: type: string enum: - url - urlExpirationDate - version - fileChecksum - state - variants - deltas - alternativeDistributionPackage style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - versions style: form explode: false - name: limit[versions] in: query description: maximum number of related versions returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AlternativeDistributionPackage content: application/json: schema: $ref: '#/components/schemas/AlternativeDistributionPackageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / Alternative Distribution Package /v1/appStoreVersions/{id}/relationships/appClipDefaultExperience: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appClipDefaultExperience_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAppClipDefaultExperienceLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / App Clip Default Experience patch: tags: - AppStoreVersions operationId: appStoreVersions_appClipDefaultExperience_updateToOneRelationship requestBody: description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAppClipDefaultExperienceLinkageRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Update Related App Store Versions / App Clip Default Experience /v1/appStoreVersions/{id}/appClipDefaultExperience: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appClipDefaultExperience_getToOneRelated parameters: - name: fields[appClipDefaultExperiences] in: query description: the fields to include for returned resources of type appClipDefaultExperiences schema: type: array items: type: string enum: - action - appClip - releaseWithAppStoreVersion - appClipDefaultExperienceLocalizations - appClipAppStoreReviewDetail style: form explode: false - name: fields[appClips] in: query description: the fields to include for returned resources of type appClips schema: type: array items: type: string enum: - bundleId - app - appClipDefaultExperiences - appClipAdvancedExperiences style: form explode: false - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: fields[appClipDefaultExperienceLocalizations] in: query description: the fields to include for returned resources of type appClipDefaultExperienceLocalizations schema: type: array items: type: string enum: - locale - subtitle - appClipDefaultExperience - appClipHeaderImage style: form explode: false - name: fields[appClipAppStoreReviewDetails] in: query description: the fields to include for returned resources of type appClipAppStoreReviewDetails schema: type: array items: type: string enum: - invocationUrls - appClipDefaultExperience style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - appClip - releaseWithAppStoreVersion - appClipDefaultExperienceLocalizations - appClipAppStoreReviewDetail style: form explode: false - name: limit[appClipDefaultExperienceLocalizations] in: query description: maximum number of related appClipDefaultExperienceLocalizations returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AppClipDefaultExperience content: application/json: schema: $ref: '#/components/schemas/AppClipDefaultExperienceResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / App Clip Default Experience /v1/appStoreVersions/{id}/relationships/appStoreReviewDetail: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreReviewDetail_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAppStoreReviewDetailLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / App Store Review Detail /v1/appStoreVersions/{id}/appStoreReviewDetail: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreReviewDetail_getToOneRelated parameters: - name: fields[appStoreReviewDetails] in: query description: the fields to include for returned resources of type appStoreReviewDetails schema: type: array items: type: string enum: - contactFirstName - contactLastName - contactPhone - contactEmail - demoAccountName - demoAccountPassword - demoAccountRequired - notes - appStoreVersion - appStoreReviewAttachments style: form explode: false - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: fields[appStoreReviewAttachments] in: query description: the fields to include for returned resources of type appStoreReviewAttachments schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - uploadOperations - assetDeliveryState - appStoreReviewDetail style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - appStoreVersion - appStoreReviewAttachments style: form explode: false - name: limit[appStoreReviewAttachments] in: query description: maximum number of related appStoreReviewAttachments returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AppStoreReviewDetail content: application/json: schema: $ref: '#/components/schemas/AppStoreReviewDetailResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / App Store Review Detail /v1/appStoreVersions/{id}/relationships/appStoreVersionExperiments: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionExperiments_getToManyRelationship deprecated: true parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAppStoreVersionExperimentsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Versions / App Store Version Experiments /v1/appStoreVersions/{id}/appStoreVersionExperiments: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionExperiments_getToManyRelated deprecated: true parameters: - name: filter[state] in: query description: filter by attribute 'state' schema: type: array items: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - APPROVED - REJECTED - COMPLETED - STOPPED style: form explode: false - name: fields[appStoreVersionExperiments] in: query description: the fields to include for returned resources of type appStoreVersionExperiments schema: type: array items: type: string enum: - name - trafficProportion - state - reviewRequired - startDate - endDate - appStoreVersion - appStoreVersionExperimentTreatments style: form explode: false - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: fields[appStoreVersionExperimentTreatments] in: query description: the fields to include for returned resources of type appStoreVersionExperimentTreatments schema: type: array items: type: string enum: - name - appIcon - appIconName - promotedDate - appStoreVersionExperiment - appStoreVersionExperimentV2 - appStoreVersionExperimentTreatmentLocalizations style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - appStoreVersion - appStoreVersionExperimentTreatments style: form explode: false - name: limit[appStoreVersionExperimentTreatments] in: query description: maximum number of related appStoreVersionExperimentTreatments returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppStoreVersionExperiments content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Versions / App Store Version Experiments /v1/appStoreVersions/{id}/relationships/appStoreVersionExperimentsV2: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionExperimentsV2_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAppStoreVersionExperimentsV2LinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Versions / App Store Version Experiments V2 /v1/appStoreVersions/{id}/appStoreVersionExperimentsV2: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionExperimentsV2_getToManyRelated parameters: - name: filter[state] in: query description: filter by attribute 'state' schema: type: array items: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - APPROVED - REJECTED - COMPLETED - STOPPED style: form explode: false - name: fields[appStoreVersionExperiments] in: query description: the fields to include for returned resources of type appStoreVersionExperiments schema: type: array items: type: string enum: - name - platform - trafficProportion - state - reviewRequired - startDate - endDate - app - latestControlVersion - controlVersions - appStoreVersionExperimentTreatments style: form explode: false - name: fields[apps] in: query description: the fields to include for returned resources of type apps schema: type: array items: type: string enum: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: fields[appStoreVersionExperimentTreatments] in: query description: the fields to include for returned resources of type appStoreVersionExperimentTreatments schema: type: array items: type: string enum: - name - appIcon - appIconName - promotedDate - appStoreVersionExperiment - appStoreVersionExperimentV2 - appStoreVersionExperimentTreatmentLocalizations style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - app - latestControlVersion - controlVersions - appStoreVersionExperimentTreatments style: form explode: false - name: limit[controlVersions] in: query description: maximum number of related controlVersions returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[appStoreVersionExperimentTreatments] in: query description: maximum number of related appStoreVersionExperimentTreatments returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppStoreVersionExperiments content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentsV2Response' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Versions / App Store Version Experiments V2 /v1/appStoreVersions/{id}/relationships/appStoreVersionLocalizations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionLocalizations_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAppStoreVersionLocalizationsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Versions / App Store Version Localizations /v1/appStoreVersions/{id}/appStoreVersionLocalizations: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionLocalizations_getToManyRelated parameters: - name: filter[locale] in: query description: filter by attribute 'locale' schema: type: array items: type: string style: form explode: false - name: fields[appStoreVersionLocalizations] in: query description: the fields to include for returned resources of type appStoreVersionLocalizations schema: type: array items: type: string enum: - description - locale - keywords - marketingUrl - promotionalText - supportUrl - whatsNew - appStoreVersion - appScreenshotSets - appPreviewSets - searchKeywords style: form explode: false - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: fields[appScreenshotSets] in: query description: the fields to include for returned resources of type appScreenshotSets schema: type: array items: type: string enum: - screenshotDisplayType - appStoreVersionLocalization - appCustomProductPageLocalization - appStoreVersionExperimentTreatmentLocalization - appScreenshots style: form explode: false - name: fields[appPreviewSets] in: query description: the fields to include for returned resources of type appPreviewSets schema: type: array items: type: string enum: - previewType - appStoreVersionLocalization - appCustomProductPageLocalization - appStoreVersionExperimentTreatmentLocalization - appPreviews style: form explode: false - name: fields[appKeywords] in: query description: the fields to include for returned resources of type appKeywords schema: type: array items: type: string enum: [] style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - appStoreVersion - appScreenshotSets - appPreviewSets - searchKeywords style: form explode: false - name: limit[appScreenshotSets] in: query description: maximum number of related appScreenshotSets returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[appPreviewSets] in: query description: maximum number of related appPreviewSets returned (when they are included) schema: type: integer maximum: 50 style: form - name: limit[searchKeywords] in: query description: maximum number of related searchKeywords returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of AppStoreVersionLocalizations content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionLocalizationsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Versions / App Store Version Localizations /v1/appStoreVersions/{id}/relationships/appStoreVersionPhasedRelease: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionPhasedRelease_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAppStoreVersionPhasedReleaseLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / App Store Version Phased Release /v1/appStoreVersions/{id}/appStoreVersionPhasedRelease: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionPhasedRelease_getToOneRelated parameters: - name: fields[appStoreVersionPhasedReleases] in: query description: the fields to include for returned resources of type appStoreVersionPhasedReleases schema: type: array items: type: string enum: - phasedReleaseState - startDate - totalPauseDuration - currentDayNumber style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AppStoreVersionPhasedRelease with get content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionPhasedReleaseWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / App Store Version Phased Release /v1/appStoreVersions/{id}/relationships/appStoreVersionSubmission: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionSubmission_getToOneRelationship deprecated: true parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionAppStoreVersionSubmissionLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / App Store Version Submission /v1/appStoreVersions/{id}/appStoreVersionSubmission: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_appStoreVersionSubmission_getToOneRelated deprecated: true parameters: - name: fields[appStoreVersionSubmissions] in: query description: the fields to include for returned resources of type appStoreVersionSubmissions schema: type: array items: type: string enum: - appStoreVersion style: form explode: false - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - appStoreVersion style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single AppStoreVersionSubmission content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionSubmissionResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / App Store Version Submission /v1/appStoreVersions/{id}/relationships/build: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_build_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionBuildLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / Build patch: tags: - AppStoreVersions operationId: appStoreVersions_build_updateToOneRelationship requestBody: description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionBuildLinkageRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Update Related App Store Versions / Build /v1/appStoreVersions/{id}/build: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_build_getToOneRelated parameters: - name: fields[builds] in: query description: the fields to include for returned resources of type builds schema: type: array items: type: string enum: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single Build with get content: application/json: schema: $ref: '#/components/schemas/BuildWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / Build /v1/appStoreVersions/{id}/relationships/customerReviews: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_customerReviews_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionCustomerReviewsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Versions / Customer Reviews /v1/appStoreVersions/{id}/customerReviews: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_customerReviews_getToManyRelated parameters: - name: filter[territory] in: query description: filter by attribute 'territory' schema: type: array items: type: string enum: - ABW - AFG - AGO - AIA - ALB - AND - ANT - ARE - ARG - ARM - ASM - ATG - AUS - AUT - AZE - BDI - BEL - BEN - BES - BFA - BGD - BGR - BHR - BHS - BIH - BLR - BLZ - BMU - BOL - BRA - BRB - BRN - BTN - BWA - CAF - CAN - CHE - CHL - CHN - CIV - CMR - COD - COG - COK - COL - COM - CPV - CRI - CUB - CUW - CXR - CYM - CYP - CZE - DEU - DJI - DMA - DNK - DOM - DZA - ECU - EGY - ERI - ESP - EST - ETH - FIN - FJI - FLK - FRA - FRO - FSM - GAB - GBR - GEO - GGY - GHA - GIB - GIN - GLP - GMB - GNB - GNQ - GRC - GRD - GRL - GTM - GUF - GUM - GUY - HKG - HND - HRV - HTI - HUN - IDN - IMN - IND - IRL - IRQ - ISL - ISR - ITA - JAM - JEY - JOR - JPN - KAZ - KEN - KGZ - KHM - KIR - KNA - KOR - KWT - LAO - LBN - LBR - LBY - LCA - LIE - LKA - LSO - LTU - LUX - LVA - MAC - MAR - MCO - MDA - MDG - MDV - MEX - MHL - MKD - MLI - MLT - MMR - MNE - MNG - MNP - MOZ - MRT - MSR - MTQ - MUS - MWI - MYS - MYT - NAM - NCL - NER - NFK - NGA - NIC - NIU - NLD - NOR - NPL - NRU - NZL - OMN - PAK - PAN - PER - PHL - PLW - PNG - POL - PRI - PRT - PRY - PSE - PYF - QAT - REU - ROU - RUS - RWA - SAU - SEN - SGP - SHN - SLB - SLE - SLV - SMR - SOM - SPM - SRB - SSD - STP - SUR - SVK - SVN - SWE - SWZ - SXM - SYC - TCA - TCD - TGO - THA - TJK - TKM - TLS - TON - TTO - TUN - TUR - TUV - TWN - TZA - UGA - UKR - UMI - URY - USA - UZB - VAT - VCT - VEN - VGB - VIR - VNM - VUT - WLF - WSM - XKS - YEM - ZAF - ZMB - ZWE style: form explode: false - name: filter[rating] in: query description: filter by attribute 'rating' schema: type: array items: type: string style: form explode: false - name: filter[reviewTerritory] in: query description: filter by id(s) of related 'reviewTerritory' schema: type: array items: type: string style: form explode: false - name: exists[publishedResponse] in: query description: filter by publishedResponse schema: type: boolean style: form explode: false - name: sort in: query description: comma-separated list of sort expressions; resources will be sorted as specified schema: type: array items: type: string enum: - rating - -rating - createdDate - -createdDate style: form explode: false - name: fields[customerReviews] in: query description: the fields to include for returned resources of type customerReviews schema: type: array items: type: string enum: - rating - title - body - reviewerNickname - createdDate - territory - response - reviewTerritory style: form explode: false - name: fields[customerReviewResponses] in: query description: the fields to include for returned resources of type customerReviewResponses schema: type: array items: type: string enum: - responseBody - lastModifiedDate - state - review style: form explode: false - name: fields[territories] in: query description: the fields to include for returned resources of type territories schema: type: array items: type: string enum: - currency style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - response - reviewTerritory style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of CustomerReviews content: application/json: schema: $ref: '#/components/schemas/CustomerReviewsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Versions / Customer Reviews /v1/appStoreVersions/{id}/relationships/gameCenterAppVersion: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_gameCenterAppVersion_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionGameCenterAppVersionLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / Game Center App Version /v1/appStoreVersions/{id}/gameCenterAppVersion: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_gameCenterAppVersion_getToOneRelated parameters: - name: fields[gameCenterAppVersions] in: query description: the fields to include for returned resources of type gameCenterAppVersions schema: type: array items: type: string enum: - enabled - compatibilityVersions - appStoreVersion style: form explode: false - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - compatibilityVersions - appStoreVersion style: form explode: false - name: limit[compatibilityVersions] in: query description: maximum number of related compatibilityVersions returned (when they are included) schema: type: integer maximum: 50 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single GameCenterAppVersion content: application/json: schema: $ref: '#/components/schemas/GameCenterAppVersionResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / Game Center App Version /v1/appStoreVersions/{id}/relationships/routingAppCoverage: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_routingAppCoverage_getToOneRelationship parameters: [] responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Related linkage content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionRoutingAppCoverageLinkageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / Routing App Coverage /v1/appStoreVersions/{id}/routingAppCoverage: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersions operationId: appStoreVersions_routingAppCoverage_getToOneRelated parameters: - name: fields[routingAppCoverages] in: query description: the fields to include for returned resources of type routingAppCoverages schema: type: array items: type: string enum: - fileSize - fileName - sourceFileChecksum - uploadOperations - assetDeliveryState - appStoreVersion style: form explode: false - name: fields[appStoreVersions] in: query description: the fields to include for returned resources of type appStoreVersions schema: type: array items: type: string enum: - platform - versionString - appStoreState - appVersionState - copyright - reviewType - releaseType - earliestReleaseDate - usesIdfa - downloadable - createdDate - app - appStoreVersionLocalizations - build - appStoreVersionPhasedRelease - gameCenterAppVersion - routingAppCoverage - appStoreReviewDetail - appStoreVersionSubmission - appClipDefaultExperience - appStoreVersionExperiments - appStoreVersionExperimentsV2 - customerReviews - alternativeDistributionPackage style: form explode: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - appStoreVersion style: form explode: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single RoutingAppCoverage content: application/json: schema: $ref: '#/components/schemas/RoutingAppCoverageResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Related App Store Versions / Routing App Coverage components: schemas: AppClip: type: object title: AppClip properties: type: type: string enum: - appClips id: type: string attributes: type: object properties: bundleId: type: string relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type appClipDefaultExperiences: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type appClipAdvancedExperiences: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorSourceParameter: type: object title: Parameter properties: parameter: type: string required: - parameter AppVersionState: type: string enum: - ACCEPTED - DEVELOPER_REJECTED - IN_REVIEW - INVALID_BINARY - METADATA_REJECTED - PENDING_APPLE_RELEASE - PENDING_DEVELOPER_RELEASE - PREPARE_FOR_SUBMISSION - PROCESSING_FOR_DISTRIBUTION - READY_FOR_DISTRIBUTION - READY_FOR_REVIEW - REJECTED - REPLACED_WITH_NEW_VERSION - WAITING_FOR_EXPORT_COMPLIANCE - WAITING_FOR_REVIEW AppClipAction: type: string enum: - OPEN - VIEW - PLAY AppStoreVersionAppStoreVersionLocalizationsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appStoreVersionLocalizations id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AlternativeDistributionPackageResponse: type: object title: AlternativeDistributionPackageResponse properties: data: $ref: '#/components/schemas/AlternativeDistributionPackage' included: type: array items: $ref: '#/components/schemas/AlternativeDistributionPackageVersion' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppStoreVersionBuildLinkageRequest: type: object properties: data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type required: - data DocumentLinks: type: object properties: self: type: string format: uri-reference required: - self AlternativeDistributionPackage: type: object title: AlternativeDistributionPackage properties: type: type: string enum: - alternativeDistributionPackages id: type: string attributes: type: object properties: sourceFileChecksum: $ref: '#/components/schemas/Checksums' relationships: type: object properties: versions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - alternativeDistributionPackageVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type PhasedReleaseState: type: string enum: - INACTIVE - ACTIVE - PAUSED - COMPLETE AppStoreVersionPhasedRelease: type: object title: AppStoreVersionPhasedRelease properties: type: type: string enum: - appStoreVersionPhasedReleases id: type: string attributes: type: object properties: phasedReleaseState: $ref: '#/components/schemas/PhasedReleaseState' startDate: type: string format: date-time totalPauseDuration: type: integer currentDayNumber: type: integer links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionSubmission: type: object title: AppStoreVersionSubmission properties: type: type: string enum: - appStoreVersionSubmissions id: type: string relationships: type: object properties: appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true AppStoreVersionAppStoreVersionPhasedReleaseLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionPhasedReleases id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppClipDefaultExperience: type: object title: AppClipDefaultExperience properties: type: type: string enum: - appClipDefaultExperiences id: type: string attributes: type: object properties: action: $ref: '#/components/schemas/AppClipAction' relationships: type: object properties: appClip: type: object properties: data: type: object properties: type: type: string enum: - appClips id: type: string required: - id - type releaseWithAppStoreVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appClipDefaultExperienceLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClipDefaultExperienceLocalizations id: type: string required: - id - type appClipAppStoreReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appClipAppStoreReviewDetails id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ImageAsset: type: object properties: templateUrl: type: string width: type: integer height: type: integer PagedDocumentLinks: type: object properties: self: type: string format: uri-reference first: type: string format: uri-reference next: type: string format: uri-reference required: - self AppStoreVersionExperimentTreatment: type: object title: AppStoreVersionExperimentTreatment properties: type: type: string enum: - appStoreVersionExperimentTreatments id: type: string attributes: type: object properties: name: type: string appIcon: $ref: '#/components/schemas/ImageAsset' appIconName: type: string promotedDate: type: string format: date-time relationships: type: object properties: appStoreVersionExperiment: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type appStoreVersionExperimentV2: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type appStoreVersionExperimentTreatmentLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatmentLocalizations id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type TerritoryCode: type: string enum: - ABW - AFG - AGO - AIA - ALB - AND - ANT - ARE - ARG - ARM - ASM - ATG - AUS - AUT - AZE - BDI - BEL - BEN - BES - BFA - BGD - BGR - BHR - BHS - BIH - BLR - BLZ - BMU - BOL - BRA - BRB - BRN - BTN - BWA - CAF - CAN - CHE - CHL - CHN - CIV - CMR - COD - COG - COK - COL - COM - CPV - CRI - CUB - CUW - CXR - CYM - CYP - CZE - DEU - DJI - DMA - DNK - DOM - DZA - ECU - EGY - ERI - ESP - EST - ETH - FIN - FJI - FLK - FRA - FRO - FSM - GAB - GBR - GEO - GGY - GHA - GIB - GIN - GLP - GMB - GNB - GNQ - GRC - GRD - GRL - GTM - GUF - GUM - GUY - HKG - HND - HRV - HTI - HUN - IDN - IMN - IND - IRL - IRQ - ISL - ISR - ITA - JAM - JEY - JOR - JPN - KAZ - KEN - KGZ - KHM - KIR - KNA - KOR - KWT - LAO - LBN - LBR - LBY - LCA - LIE - LKA - LSO - LTU - LUX - LVA - MAC - MAR - MCO - MDA - MDG - MDV - MEX - MHL - MKD - MLI - MLT - MMR - MNE - MNG - MNP - MOZ - MRT - MSR - MTQ - MUS - MWI - MYS - MYT - NAM - NCL - NER - NFK - NGA - NIC - NIU - NLD - NOR - NPL - NRU - NZL - OMN - PAK - PAN - PER - PHL - PLW - PNG - POL - PRI - PRT - PRY - PSE - PYF - QAT - REU - ROU - RUS - RWA - SAU - SEN - SGP - SHN - SLB - SLE - SLV - SMR - SOM - SPM - SRB - SSD - STP - SUR - SVK - SVN - SWE - SWZ - SXM - SYC - TCA - TCD - TGO - THA - TJK - TKM - TLS - TON - TTO - TUN - TUR - TUV - TWN - TZA - UGA - UKR - UMI - URY - USA - UZB - VAT - VCT - VEN - VGB - VIR - VNM - VUT - WLF - WSM - XKS - YEM - ZAF - ZMB - ZWE AppStoreVersionGameCenterAppVersionLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - gameCenterAppVersions id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppClipDefaultExperienceResponse: type: object title: AppClipDefaultExperienceResponse properties: data: $ref: '#/components/schemas/AppClipDefaultExperience' included: type: array items: oneOf: - $ref: '#/components/schemas/AppClipAppStoreReviewDetail' - $ref: '#/components/schemas/AppClipDefaultExperienceLocalization' - $ref: '#/components/schemas/AppClip' - $ref: '#/components/schemas/AppStoreVersion' discriminator: propertyName: type mapping: appClipDefaultExperienceLocalizations: '#/components/schemas/AppClipDefaultExperienceLocalization' appStoreVersions: '#/components/schemas/AppStoreVersion' appClipAppStoreReviewDetails: '#/components/schemas/AppClipAppStoreReviewDetail' appClips: '#/components/schemas/AppClip' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppScreenshotSet: type: object title: AppScreenshotSet properties: type: type: string enum: - appScreenshotSets id: type: string attributes: type: object properties: screenshotDisplayType: $ref: '#/components/schemas/ScreenshotDisplayType' relationships: type: object properties: appStoreVersionLocalization: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionLocalizations id: type: string required: - id - type appCustomProductPageLocalization: type: object properties: data: type: object properties: type: type: string enum: - appCustomProductPageLocalizations id: type: string required: - id - type appStoreVersionExperimentTreatmentLocalization: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatmentLocalizations id: type: string required: - id - type appScreenshots: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appScreenshots id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionCreateRequest: type: object title: AppStoreVersionCreateRequest properties: data: type: object properties: type: type: string enum: - appStoreVersions attributes: type: object properties: platform: $ref: '#/components/schemas/Platform' versionString: type: string copyright: type: string nullable: true reviewType: type: string nullable: true enum: - APP_STORE - NOTARIZATION releaseType: type: string nullable: true enum: - MANUAL - AFTER_APPROVAL - SCHEDULED earliestReleaseDate: type: string format: date-time nullable: true usesIdfa: type: boolean deprecated: true nullable: true required: - versionString - platform relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type required: - data appStoreVersionLocalizations: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appStoreVersionLocalizations id: type: string required: - id - type build: type: object properties: data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type required: - app required: - relationships - attributes - type required: - data AppStoreVersionAppStoreVersionExperimentsV2LinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links ErrorResponse: type: object properties: errors: type: array items: type: object properties: id: type: string status: type: string code: type: string title: type: string detail: type: string source: oneOf: - $ref: '#/components/schemas/ErrorSourcePointer' - $ref: '#/components/schemas/ErrorSourceParameter' links: $ref: '#/components/schemas/ErrorLinks' meta: type: object additionalProperties: {} required: - code - detail - status - title AppClipDefaultExperienceLocalization: type: object title: AppClipDefaultExperienceLocalization properties: type: type: string enum: - appClipDefaultExperienceLocalizations id: type: string attributes: type: object properties: locale: type: string subtitle: type: string relationships: type: object properties: appClipDefaultExperience: type: object properties: data: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type appClipHeaderImage: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appClipHeaderImages id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type GameCenterAppVersionResponse: type: object title: GameCenterAppVersionResponse properties: data: $ref: '#/components/schemas/GameCenterAppVersion' included: type: array items: oneOf: - $ref: '#/components/schemas/AppStoreVersion' - $ref: '#/components/schemas/GameCenterAppVersion' discriminator: propertyName: type mapping: appStoreVersions: '#/components/schemas/AppStoreVersion' gameCenterAppVersions: '#/components/schemas/GameCenterAppVersion' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links ChecksumAlgorithm: type: string enum: - MD5 - SHA_256 CustomerReview: type: object title: CustomerReview properties: type: type: string enum: - customerReviews id: type: string attributes: type: object properties: rating: type: integer maximum: 5 minimum: 1 title: type: string body: type: string reviewerNickname: type: string createdDate: type: string format: date-time territory: $ref: '#/components/schemas/TerritoryCode' relationships: type: object properties: response: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - customerReviewResponses id: type: string required: - id - type reviewTerritory: type: object properties: data: type: object properties: type: type: string enum: - territories id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorSourcePointer: type: object title: JsonPointer properties: pointer: type: string required: - pointer RoutingAppCoverage: type: object title: RoutingAppCoverage properties: type: type: string enum: - routingAppCoverages id: type: string attributes: type: object properties: fileSize: type: integer fileName: type: string sourceFileChecksum: type: string uploadOperations: type: array items: $ref: '#/components/schemas/UploadOperation' assetDeliveryState: $ref: '#/components/schemas/AppMediaAssetState' relationships: type: object properties: appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type PagingInformation: type: object properties: paging: type: object properties: total: type: integer limit: type: integer nextCursor: type: string required: - limit required: - paging ScreenshotDisplayType: type: string enum: - APP_IPHONE_67 - APP_IPHONE_61 - APP_IPHONE_65 - APP_IPHONE_58 - APP_IPHONE_55 - APP_IPHONE_47 - APP_IPHONE_40 - APP_IPHONE_35 - APP_IPAD_PRO_3GEN_129 - APP_IPAD_PRO_3GEN_11 - APP_IPAD_PRO_129 - APP_IPAD_105 - APP_IPAD_97 - APP_DESKTOP - APP_WATCH_ULTRA - APP_WATCH_SERIES_10 - APP_WATCH_SERIES_7 - APP_WATCH_SERIES_4 - APP_WATCH_SERIES_3 - APP_APPLE_TV - APP_APPLE_VISION_PRO - IMESSAGE_APP_IPHONE_67 - IMESSAGE_APP_IPHONE_61 - IMESSAGE_APP_IPHONE_65 - IMESSAGE_APP_IPHONE_58 - IMESSAGE_APP_IPHONE_55 - IMESSAGE_APP_IPHONE_47 - IMESSAGE_APP_IPHONE_40 - IMESSAGE_APP_IPAD_PRO_3GEN_129 - IMESSAGE_APP_IPAD_PRO_3GEN_11 - IMESSAGE_APP_IPAD_PRO_129 - IMESSAGE_APP_IPAD_105 - IMESSAGE_APP_IPAD_97 GameCenterAppVersion: type: object title: GameCenterAppVersion properties: type: type: string enum: - gameCenterAppVersions id: type: string attributes: type: object properties: enabled: type: boolean relationships: type: object properties: compatibilityVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterAppVersions id: type: string required: - id - type appStoreVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AlternativeDistributionPackageVersion: type: object title: AlternativeDistributionPackageVersion properties: type: type: string enum: - alternativeDistributionPackageVersions id: type: string attributes: type: object properties: url: type: string format: uri urlExpirationDate: type: string format: date-time version: type: string fileChecksum: type: string state: type: string enum: - COMPLETED - REPLACED relationships: type: object properties: variants: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - alternativeDistributionPackageVariants id: type: string required: - id - type deltas: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - alternativeDistributionPackageDeltas id: type: string required: - id - type alternativeDistributionPackage: type: object properties: data: type: object properties: type: type: string enum: - alternativeDistributionPackages id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorLinks: type: object properties: about: type: string format: uri-reference associated: oneOf: - type: string format: uri-reference - type: object properties: href: type: string format: uri-reference meta: type: object properties: source: type: string RoutingAppCoverageResponse: type: object title: RoutingAppCoverageResponse properties: data: $ref: '#/components/schemas/RoutingAppCoverage' included: type: array items: $ref: '#/components/schemas/AppStoreVersion' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppMediaAssetState: type: object properties: errors: type: array items: $ref: '#/components/schemas/AppMediaStateError' warnings: type: array items: $ref: '#/components/schemas/AppMediaStateError' state: type: string enum: - AWAITING_UPLOAD - UPLOAD_COMPLETE - COMPLETE - FAILED AppStoreVersionAppStoreVersionSubmissionLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionSubmissions id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links deprecated: true Platform: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS Checksums: type: object properties: file: type: object properties: hash: type: string algorithm: $ref: '#/components/schemas/ChecksumAlgorithm' composite: type: object properties: hash: type: string algorithm: type: string enum: - MD5 AppStoreVersionAppStoreReviewDetailLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - appStoreReviewDetails id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppStoreVersionExperiment: type: object title: AppStoreVersionExperiment properties: type: type: string enum: - appStoreVersionExperiments id: type: string attributes: type: object properties: name: type: string trafficProportion: type: integer state: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - APPROVED - REJECTED - COMPLETED - STOPPED reviewRequired: type: boolean startDate: type: string format: date-time endDate: type: string format: date-time relationships: type: object properties: appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appStoreVersionExperimentTreatments: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatments id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type deprecated: true AppStoreVersionAppClipDefaultExperienceLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links App: type: object title: App properties: type: type: string enum: - apps id: type: string attributes: type: object properties: accessibilityUrl: type: string format: uri name: type: string bundleId: type: string sku: type: string primaryLocale: type: string isOrEverWasMadeForKids: type: boolean subscriptionStatusUrl: type: string format: uri subscriptionStatusUrlVersion: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' subscriptionStatusUrlForSandbox: type: string format: uri subscriptionStatusUrlVersionForSandbox: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' contentRightsDeclaration: type: string enum: - DOES_NOT_USE_THIRD_PARTY_CONTENT - USES_THIRD_PARTY_CONTENT streamlinedPurchasingEnabled: type: boolean relationships: type: object properties: accessibilityDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appEncryptionDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type appStoreIcon: type: object properties: data: type: object properties: type: type: string enum: - buildIcons id: type: string required: - id - type ciProduct: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - ciProducts id: type: string required: - id - type betaTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type appStoreVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appTags: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' preReleaseVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - preReleaseVersions id: type: string required: - id - type betaAppLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaAppLocalizations id: type: string required: - id - type builds: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type betaLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaLicenseAgreements id: type: string required: - id - type betaAppReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaAppReviewDetails id: type: string required: - id - type appInfos: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appInfos id: type: string required: - id - type appClips: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClips id: type: string required: - id - type appPricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' endUserLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - endUserLicenseAgreements id: type: string required: - id - type appPriceSchedule: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appAvailabilityV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' inAppPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type deprecated: true subscriptionGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type gameCenterEnabledVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterEnabledVersions id: type: string required: - id - type perfPowerMetrics: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appCustomProductPages: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appCustomProductPages id: type: string required: - id - type inAppPurchasesV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type promotedPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type appEvents: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEvents id: type: string required: - id - type reviewSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - reviewSubmissions id: type: string required: - id - type subscriptionGracePeriod: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionGracePeriods id: type: string required: - id - type customerReviews: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' customerReviewSummarizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' gameCenterDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type appStoreVersionExperimentsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type alternativeDistributionKey: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' analyticsReportRequests: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' marketplaceSearchDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' buildUploads: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' backgroundAssets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackScreenshotSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackCrashSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' searchKeywords: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' webhooks: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' androidToIosAppMappingDetails: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - androidToIosAppMappingDetails id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreReviewDetail: type: object title: AppStoreReviewDetail properties: type: type: string enum: - appStoreReviewDetails id: type: string attributes: type: object properties: contactFirstName: type: string contactLastName: type: string contactPhone: type: string contactEmail: type: string demoAccountName: type: string demoAccountPassword: type: string demoAccountRequired: type: boolean notes: type: string relationships: type: object properties: appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appStoreReviewAttachments: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreReviewAttachments id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type RelationshipLinks: type: object properties: self: type: string format: uri-reference related: type: string format: uri-reference AppStoreVersionExperimentV2: type: object title: AppStoreVersionExperimentV2 properties: type: type: string enum: - appStoreVersionExperiments id: type: string attributes: type: object properties: name: type: string platform: $ref: '#/components/schemas/Platform' trafficProportion: type: integer state: type: string enum: - PREPARE_FOR_SUBMISSION - READY_FOR_REVIEW - WAITING_FOR_REVIEW - IN_REVIEW - ACCEPTED - APPROVED - REJECTED - COMPLETED - STOPPED reviewRequired: type: boolean startDate: type: string format: date-time endDate: type: string format: date-time relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type latestControlVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type controlVersions: type: object properties: meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appStoreVersionExperimentTreatments: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatments id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppClipAppStoreReviewDetail: type: object title: AppClipAppStoreReviewDetail properties: type: type: string enum: - appClipAppStoreReviewDetails id: type: string attributes: type: object properties: invocationUrls: type: array items: type: string format: uri relationships: type: object properties: appClipDefaultExperience: type: object properties: data: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionUpdateRequest: type: object title: AppStoreVersionUpdateRequest properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string attributes: type: object properties: versionString: type: string nullable: true copyright: type: string nullable: true reviewType: type: string nullable: true enum: - APP_STORE - NOTARIZATION releaseType: type: string nullable: true enum: - MANUAL - AFTER_APPROVAL - SCHEDULED earliestReleaseDate: type: string format: date-time nullable: true usesIdfa: type: boolean deprecated: true nullable: true downloadable: type: boolean nullable: true relationships: type: object properties: build: type: object properties: data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type appClipDefaultExperience: type: object properties: data: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type required: - id - type required: - data AppStoreVersionAppStoreVersionExperimentsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links deprecated: true BuildAudienceType: type: string enum: - INTERNAL_ONLY - APP_STORE_ELIGIBLE AppStoreReviewDetailResponse: type: object title: AppStoreReviewDetailResponse properties: data: $ref: '#/components/schemas/AppStoreReviewDetail' included: type: array items: oneOf: - $ref: '#/components/schemas/AppStoreReviewAttachment' - $ref: '#/components/schemas/AppStoreVersion' discriminator: propertyName: type mapping: appStoreVersions: '#/components/schemas/AppStoreVersion' appStoreReviewAttachments: '#/components/schemas/AppStoreReviewAttachment' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppStoreVersionPhasedReleaseWithoutIncludesResponse: type: object title: AppStoreVersionPhasedReleaseWithoutIncludesResponse properties: data: $ref: '#/components/schemas/AppStoreVersionPhasedRelease' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppKeyword: type: object title: AppKeyword properties: type: type: string enum: - appKeywords id: type: string links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BuildWithoutIncludesResponse: type: object title: BuildWithoutIncludesResponse properties: data: $ref: '#/components/schemas/Build' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppStoreVersionRoutingAppCoverageLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - routingAppCoverages id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppStoreVersionSubmissionResponse: type: object title: AppStoreVersionSubmissionResponse properties: data: $ref: '#/components/schemas/AppStoreVersionSubmission' included: type: array items: $ref: '#/components/schemas/AppStoreVersion' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links deprecated: true HttpHeader: type: object properties: name: type: string value: type: string AppStoreVersionCustomerReviewsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - customerReviews id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links ResourceLinks: type: object properties: self: type: string format: uri-reference AppStoreVersionLocalizationsResponse: type: object title: AppStoreVersionLocalizationsResponse properties: data: type: array items: $ref: '#/components/schemas/AppStoreVersionLocalization' included: type: array items: oneOf: - $ref: '#/components/schemas/AppKeyword' - $ref: '#/components/schemas/AppPreviewSet' - $ref: '#/components/schemas/AppScreenshotSet' - $ref: '#/components/schemas/AppStoreVersion' discriminator: propertyName: type mapping: appScreenshotSets: '#/components/schemas/AppScreenshotSet' appStoreVersions: '#/components/schemas/AppStoreVersion' appKeywords: '#/components/schemas/AppKeyword' appPreviewSets: '#/components/schemas/AppPreviewSet' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppStoreReviewAttachment: type: object title: AppStoreReviewAttachment properties: type: type: string enum: - appStoreReviewAttachments id: type: string attributes: type: object properties: fileSize: type: integer fileName: type: string sourceFileChecksum: type: string uploadOperations: type: array items: $ref: '#/components/schemas/UploadOperation' assetDeliveryState: $ref: '#/components/schemas/AppMediaAssetState' relationships: type: object properties: appStoreReviewDetail: type: object properties: data: type: object properties: type: type: string enum: - appStoreReviewDetails id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type CustomerReviewResponseV1: type: object title: CustomerReviewResponseV1 properties: type: type: string enum: - customerReviewResponses id: type: string attributes: type: object properties: responseBody: type: string lastModifiedDate: type: string format: date-time state: type: string enum: - PUBLISHED - PENDING_PUBLISH relationships: type: object properties: review: type: object properties: data: type: object properties: type: type: string enum: - customerReviews id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type UploadOperation: type: object properties: method: type: string url: type: string length: type: integer offset: type: integer requestHeaders: type: array items: $ref: '#/components/schemas/HttpHeader' PreviewType: type: string enum: - IPHONE_67 - IPHONE_61 - IPHONE_65 - IPHONE_58 - IPHONE_55 - IPHONE_47 - IPHONE_40 - IPHONE_35 - IPAD_PRO_3GEN_129 - IPAD_PRO_3GEN_11 - IPAD_PRO_129 - IPAD_105 - IPAD_97 - DESKTOP - APPLE_TV - APPLE_VISION_PRO AppStoreVersionAppClipDefaultExperienceLinkageRequest: type: object properties: data: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type required: - data AppStoreVersionExperimentsResponse: type: object title: AppStoreVersionExperimentsResponse properties: data: type: array items: $ref: '#/components/schemas/AppStoreVersionExperiment' included: type: array items: oneOf: - $ref: '#/components/schemas/AppStoreVersionExperimentTreatment' - $ref: '#/components/schemas/AppStoreVersion' discriminator: propertyName: type mapping: appStoreVersionExperimentTreatments: '#/components/schemas/AppStoreVersionExperimentTreatment' appStoreVersions: '#/components/schemas/AppStoreVersion' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links deprecated: true Build: type: object title: Build properties: type: type: string enum: - builds id: type: string attributes: type: object properties: version: type: string uploadedDate: type: string format: date-time expirationDate: type: string format: date-time expired: type: boolean minOsVersion: type: string lsMinimumSystemVersion: type: string computedMinMacOsVersion: type: string computedMinVisionOsVersion: type: string iconAssetToken: $ref: '#/components/schemas/ImageAsset' processingState: type: string enum: - PROCESSING - FAILED - INVALID - VALID buildAudienceType: $ref: '#/components/schemas/BuildAudienceType' usesNonExemptEncryption: type: boolean relationships: type: object properties: preReleaseVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - preReleaseVersions id: type: string required: - id - type individualTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaTesters id: type: string required: - id - type betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type betaBuildLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaBuildLocalizations id: type: string required: - id - type appEncryptionDeclaration: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type betaAppReviewSubmission: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaAppReviewSubmissions id: type: string required: - id - type app: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type buildBetaDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - buildBetaDetails id: type: string required: - id - type appStoreVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type icons: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - buildIcons id: type: string required: - id - type buildBundles: type: object properties: meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - buildBundles id: type: string required: - id - type buildUpload: type: object properties: data: type: object properties: type: type: string enum: - buildUploads id: type: string required: - id - type perfPowerMetrics: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' diagnosticSignatures: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionExperimentsV2Response: type: object title: AppStoreVersionExperimentsV2Response properties: data: type: array items: $ref: '#/components/schemas/AppStoreVersionExperimentV2' included: type: array items: oneOf: - $ref: '#/components/schemas/AppStoreVersionExperimentTreatment' - $ref: '#/components/schemas/AppStoreVersion' - $ref: '#/components/schemas/App' discriminator: propertyName: type mapping: appStoreVersionExperimentTreatments: '#/components/schemas/AppStoreVersionExperimentTreatment' appStoreVersions: '#/components/schemas/AppStoreVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links SubscriptionStatusUrlVersion: type: string enum: - V1 - V2 AppStoreVersionLocalization: type: object title: AppStoreVersionLocalization properties: type: type: string enum: - appStoreVersionLocalizations id: type: string attributes: type: object properties: description: type: string locale: type: string keywords: type: string marketingUrl: type: string format: uri promotionalText: type: string supportUrl: type: string format: uri whatsNew: type: string relationships: type: object properties: appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appScreenshotSets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appScreenshotSets id: type: string required: - id - type appPreviewSets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appPreviewSets id: type: string required: - id - type searchKeywords: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appKeywords id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersion: type: object title: AppStoreVersion properties: type: type: string enum: - appStoreVersions id: type: string attributes: type: object properties: platform: $ref: '#/components/schemas/Platform' versionString: type: string appStoreState: deprecated: true $ref: '#/components/schemas/AppStoreVersionState' appVersionState: $ref: '#/components/schemas/AppVersionState' copyright: type: string reviewType: type: string enum: - APP_STORE - NOTARIZATION releaseType: type: string enum: - MANUAL - AFTER_APPROVAL - SCHEDULED earliestReleaseDate: type: string format: date-time usesIdfa: type: boolean deprecated: true downloadable: type: boolean createdDate: type: string format: date-time relationships: type: object properties: app: type: object properties: data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type appStoreVersionLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionLocalizations id: type: string required: - id - type build: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type appStoreVersionPhasedRelease: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersionPhasedReleases id: type: string required: - id - type gameCenterAppVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterAppVersions id: type: string required: - id - type routingAppCoverage: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - routingAppCoverages id: type: string required: - id - type appStoreReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreReviewDetails id: type: string required: - id - type appStoreVersionSubmission: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersionSubmissions id: type: string required: - id - type appClipDefaultExperience: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appClipDefaultExperiences id: type: string required: - id - type appStoreVersionExperiments: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type appStoreVersionExperimentsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type customerReviews: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' alternativeDistributionPackage: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - alternativeDistributionPackages id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionBuildLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - builds id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppStoreVersionResponse: type: object title: AppStoreVersionResponse properties: data: $ref: '#/components/schemas/AppStoreVersion' included: type: array items: oneOf: - $ref: '#/components/schemas/AlternativeDistributionPackage' - $ref: '#/components/schemas/AppClipDefaultExperience' - $ref: '#/components/schemas/AppStoreReviewDetail' - $ref: '#/components/schemas/AppStoreVersionExperiment' - $ref: '#/components/schemas/AppStoreVersionLocalization' - $ref: '#/components/schemas/AppStoreVersionPhasedRelease' - $ref: '#/components/schemas/AppStoreVersionSubmission' - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/Build' - $ref: '#/components/schemas/GameCenterAppVersion' - $ref: '#/components/schemas/RoutingAppCoverage' discriminator: propertyName: type mapping: alternativeDistributionPackages: '#/components/schemas/AlternativeDistributionPackage' appClipDefaultExperiences: '#/components/schemas/AppClipDefaultExperience' appStoreVersionLocalizations: '#/components/schemas/AppStoreVersionLocalization' routingAppCoverages: '#/components/schemas/RoutingAppCoverage' appStoreVersionPhasedReleases: '#/components/schemas/AppStoreVersionPhasedRelease' appStoreReviewDetails: '#/components/schemas/AppStoreReviewDetail' appStoreVersionExperiments: '#/components/schemas/AppStoreVersionExperiment' builds: '#/components/schemas/Build' appStoreVersionSubmissions: '#/components/schemas/AppStoreVersionSubmission' gameCenterAppVersions: '#/components/schemas/GameCenterAppVersion' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links CustomerReviewsResponse: type: object title: CustomerReviewsResponse properties: data: type: array items: $ref: '#/components/schemas/CustomerReview' included: type: array items: oneOf: - $ref: '#/components/schemas/CustomerReviewResponseV1' - $ref: '#/components/schemas/Territory' discriminator: propertyName: type mapping: territories: '#/components/schemas/Territory' customerReviewResponses: '#/components/schemas/CustomerReviewResponseV1' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppStoreVersionAlternativeDistributionPackageLinkageResponse: type: object properties: data: type: object properties: type: type: string enum: - alternativeDistributionPackages id: type: string required: - id - type links: $ref: '#/components/schemas/DocumentLinks' required: - data - links AppPreviewSet: type: object title: AppPreviewSet properties: type: type: string enum: - appPreviewSets id: type: string attributes: type: object properties: previewType: $ref: '#/components/schemas/PreviewType' relationships: type: object properties: appStoreVersionLocalization: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionLocalizations id: type: string required: - id - type appCustomProductPageLocalization: type: object properties: data: type: object properties: type: type: string enum: - appCustomProductPageLocalizations id: type: string required: - id - type appStoreVersionExperimentTreatmentLocalization: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatmentLocalizations id: type: string required: - id - type appPreviews: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appPreviews id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppMediaStateError: type: object properties: code: type: string description: type: string Territory: type: object title: Territory properties: type: type: string enum: - territories id: type: string attributes: type: object properties: currency: type: string links: $ref: '#/components/schemas/ResourceLinks' required: - id - type AppStoreVersionState: type: string enum: - ACCEPTED - DEVELOPER_REMOVED_FROM_SALE - DEVELOPER_REJECTED - IN_REVIEW - INVALID_BINARY - METADATA_REJECTED - PENDING_APPLE_RELEASE - PENDING_CONTRACT - PENDING_DEVELOPER_RELEASE - PREPARE_FOR_SUBMISSION - PREORDER_READY_FOR_SALE - PROCESSING_FOR_APP_STORE - READY_FOR_REVIEW - READY_FOR_SALE - REJECTED - REMOVED_FROM_SALE - WAITING_FOR_EXPORT_COMPLIANCE - WAITING_FOR_REVIEW - REPLACED_WITH_NEW_VERSION - NOT_APPLICABLE securitySchemes: itc-bearer-token: type: http scheme: bearer bearerFormat: JWT