openapi: 3.0.1 info: title: App Store Connect AccessibilityDeclarations AppStoreVersionExperiments 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: AppStoreVersionExperiments paths: /v2/appStoreVersionExperiments: post: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperimentsV2_createInstance requestBody: description: AppStoreVersionExperiment representation content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentV2CreateRequest' 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 AppStoreVersionExperiment content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentV2Response' '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 Version Experiments V2 /v2/appStoreVersionExperiments/{id}: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperimentsV2_getInstance parameters: - 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 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[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[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 required: false - 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 required: false - name: limit[appStoreVersionExperimentTreatments] in: query description: maximum number of related appStoreVersionExperimentTreatments returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[controlVersions] in: query description: maximum number of related controlVersions 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 AppStoreVersionExperiment content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentV2Response' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get App Store Version Experiments V2 patch: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperimentsV2_updateInstance requestBody: description: AppStoreVersionExperiment representation content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentV2UpdateRequest' 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 AppStoreVersionExperiment content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentV2Response' '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 Version Experiments V2 delete: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperimentsV2_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 Version Experiments V2 /v1/appStoreVersionExperiments: post: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperiments_createInstance deprecated: true requestBody: description: AppStoreVersionExperiment representation content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentCreateRequest' 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 AppStoreVersionExperiment content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentResponse' '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 Version Experiments /v1/appStoreVersionExperiments/{id}: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperiments_getInstance deprecated: true parameters: - 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 required: 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 required: 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 required: false - 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 required: false - name: limit[appStoreVersionExperimentTreatments] in: query description: maximum number of related appStoreVersionExperimentTreatments 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 AppStoreVersionExperiment content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get App Store Version Experiments patch: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperiments_updateInstance deprecated: true requestBody: description: AppStoreVersionExperiment representation content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentUpdateRequest' 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 AppStoreVersionExperiment content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentResponse' '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 Version Experiments delete: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperiments_deleteInstance deprecated: 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' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Delete App Store Version Experiments /v2/appStoreVersionExperiments/{id}/relationships/appStoreVersionExperimentTreatments: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_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/AppStoreVersionExperimentV2AppStoreVersionExperimentTreatmentsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Version Experiments V2 / App Store Version Experiment Treatments /v2/appStoreVersionExperiments/{id}/appStoreVersionExperimentTreatments: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperimentsV2_appStoreVersionExperimentTreatments_getToManyRelated parameters: - 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: 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 - name: fields[appStoreVersionExperimentTreatmentLocalizations] in: query description: the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations schema: type: array items: type: string enum: - locale - appStoreVersionExperimentTreatment - appScreenshotSets - appPreviewSets 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: - appStoreVersionExperiment - appStoreVersionExperimentV2 - appStoreVersionExperimentTreatmentLocalizations style: form explode: false - name: limit[appStoreVersionExperimentTreatmentLocalizations] in: query description: maximum number of related appStoreVersionExperimentTreatmentLocalizations 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 AppStoreVersionExperimentTreatments content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentTreatmentsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Version Experiments V2 / App Store Version Experiment Treatments /v1/appStoreVersionExperiments/{id}/relationships/appStoreVersionExperimentTreatments: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperiments_appStoreVersionExperimentTreatments_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/AppStoreVersionExperimentAppStoreVersionExperimentTreatmentsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Version Experiments / App Store Version Experiment Treatments /v1/appStoreVersionExperiments/{id}/appStoreVersionExperimentTreatments: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - AppStoreVersionExperiments operationId: appStoreVersionExperiments_appStoreVersionExperimentTreatments_getToManyRelated deprecated: true parameters: - 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: 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 - name: fields[appStoreVersionExperimentTreatmentLocalizations] in: query description: the fields to include for returned resources of type appStoreVersionExperimentTreatmentLocalizations schema: type: array items: type: string enum: - locale - appStoreVersionExperimentTreatment - appScreenshotSets - appPreviewSets 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: - appStoreVersionExperiment - appStoreVersionExperimentV2 - appStoreVersionExperimentTreatmentLocalizations style: form explode: false - name: limit[appStoreVersionExperimentTreatmentLocalizations] in: query description: maximum number of related appStoreVersionExperimentTreatmentLocalizations 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 AppStoreVersionExperimentTreatments content: application/json: schema: $ref: '#/components/schemas/AppStoreVersionExperimentTreatmentsResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related App Store Version Experiments / App Store Version Experiment Treatments components: schemas: 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 PagedDocumentLinks: type: object properties: self: type: string format: uri-reference first: type: string format: uri-reference next: type: string format: uri-reference required: - self ImageAsset: type: object properties: templateUrl: type: string width: type: integer height: type: integer ResourceLinks: type: object properties: self: type: string format: uri-reference ErrorSourceParameter: type: object title: Parameter properties: parameter: type: string required: - parameter 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 AppStoreVersionExperimentResponse: type: object title: AppStoreVersionExperimentResponse properties: data: $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/DocumentLinks' required: - data - links deprecated: true AppStoreVersionExperimentCreateRequest: type: object title: AppStoreVersionExperimentCreateRequest properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments attributes: type: object properties: name: type: string trafficProportion: type: integer required: - trafficProportion - name relationships: type: object properties: appStoreVersion: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type required: - data required: - appStoreVersion required: - relationships - attributes - type required: - data deprecated: true 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 Platform: type: string enum: - IOS - MAC_OS - TV_OS - VISION_OS DocumentLinks: type: object properties: self: type: string format: uri-reference required: - self AppStoreVersionExperimentV2Response: type: object title: AppStoreVersionExperimentV2Response properties: data: $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/DocumentLinks' required: - data - links AppStoreVersionExperimentUpdateRequest: type: object title: AppStoreVersionExperimentUpdateRequest properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string attributes: type: object properties: name: type: string nullable: true trafficProportion: type: integer nullable: true started: type: boolean nullable: true required: - id - type required: - data deprecated: true 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 AppStoreVersionExperimentTreatmentsResponse: type: object title: AppStoreVersionExperimentTreatmentsResponse properties: data: type: array items: $ref: '#/components/schemas/AppStoreVersionExperimentTreatment' included: type: array items: oneOf: - $ref: '#/components/schemas/AppStoreVersionExperimentTreatmentLocalization' - $ref: '#/components/schemas/AppStoreVersionExperiment' discriminator: propertyName: type mapping: appStoreVersionExperimentTreatmentLocalizations: '#/components/schemas/AppStoreVersionExperimentTreatmentLocalization' appStoreVersionExperiments: '#/components/schemas/AppStoreVersionExperiment' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppStoreVersionExperimentTreatmentLocalization: type: object title: AppStoreVersionExperimentTreatmentLocalization properties: type: type: string enum: - appStoreVersionExperimentTreatmentLocalizations id: type: string attributes: type: object properties: locale: type: string relationships: type: object properties: appStoreVersionExperimentTreatment: type: object properties: data: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatments 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 links: $ref: '#/components/schemas/ResourceLinks' required: - id - type 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 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 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 AppStoreVersionExperimentV2CreateRequest: type: object title: AppStoreVersionExperimentV2CreateRequest properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments attributes: type: object properties: name: type: string platform: $ref: '#/components/schemas/Platform' trafficProportion: type: integer required: - trafficProportion - name - 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 required: - app required: - relationships - attributes - type required: - data SubscriptionStatusUrlVersion: type: string enum: - V1 - V2 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 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 ErrorSourcePointer: type: object title: JsonPointer properties: pointer: type: string required: - pointer PagingInformation: type: object properties: paging: type: object properties: total: type: integer limit: type: integer nextCursor: type: string required: - limit required: - paging AppStoreVersionExperimentV2UpdateRequest: type: object title: AppStoreVersionExperimentV2UpdateRequest properties: data: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string attributes: type: object properties: name: type: string nullable: true trafficProportion: type: integer nullable: true started: type: boolean nullable: true required: - id - type required: - data AppStoreVersionExperimentV2AppStoreVersionExperimentTreatmentsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatments id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links AppStoreVersionExperimentAppStoreVersionExperimentTreatmentsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperimentTreatments id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links deprecated: true securitySchemes: itc-bearer-token: type: http scheme: bearer bearerFormat: JWT