{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"ClientIdHeader":{"description":"The identifier of a client associated with a \u0027Login with Amazon\u0027 account.","in":"header","name":"Amazon-Ads-ClientId","required":true,"schema":{"type":"string"}},"ScopeHeader":{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"BadGatewayResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BrandStoreEditionPublishVersion":{"properties":{"editionId":{"description":"Reference to the store edition","type":"string"},"pages":{"description":"Collection of page versions included in this publish version","items":{"$ref":"#/components/schemas/StorePageVersion"},"maxItems":5000,"minItems":0,"type":"array"},"publishState":{"$ref":"#/components/schemas/StorePublishState"},"publishStatus":{"$ref":"#/components/schemas/StorePublishStatus"},"storeEditionPublishId":{"description":"Unique identifier for the publish version","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["editionId","publishState","publishStatus","storeEditionPublishId","storeId"],"type":"object"},"BrandStoreEditionPublishVersionBrandStoreEditionIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionBrandStoreIdFilter":{"properties":{"include":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionMultiStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorsIndex"},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionMultiStatusSuccess"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"BrandStoreEditionPublishVersionMultiStatusSuccess":{"properties":{"brandStoreEditionPublishVersion":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersion"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["brandStoreEditionPublishVersion","index"],"type":"object"},"BrandStoreEditionPublishVersionStorePublishStatusFilter":{"properties":{"include":{"description":"**PublishStatus Enum:**\n| PublishStatus | Description |\n| --- | --- |\n| `DRAFT` | Content is in draft state |\n| `REVIEW_IN_PROGRESS` | Content is pending publication for review |","items":{"$ref":"#/components/schemas/StorePublishStatus"},"maxItems":1,"minItems":1,"type":"array"}},"required":["include"],"type":"object"},"BrandStoreEditionPublishVersionSuccessResponse":{"properties":{"brandStoreEditionPublishVersions":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersion"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"BrandStoreEditionPublishVersionUpdate":{"properties":{"editionId":{"description":"Reference to the store edition","type":"string"},"publishState":{"$ref":"#/components/schemas/StorePublishState"},"storeEditionPublishId":{"description":"Unique identifier for the publish version","type":"string"},"storeId":{"description":"Identifier of the associated store","type":"string"}},"required":["storeEditionPublishId"],"type":"object"},"ContentTooLargeResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"Error":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"fieldLocation":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ErrorCode":{"description":"**ErrorCode Enum:**\n\n| ErrorCode | Description |\n|------|------|\n| `BAD_REQUEST` | The request is not valid considering the documented schema. |\n| `CONFLICT` | Operation could not be completed due to a conflict. Please retry your request. |\n| `DUPLICATE_RESOURCE_ID_FOUND` | Multiple resources share the same ID. Remove the duplicate ID. |\n| `FORBIDDEN` | The caller is not authorized to make the given request. |\n| `INTERNAL_ERROR` | The server encountered an unexpected condition that prevented it from fulfilling the request. |\n| `NOT_FOUND` | The requested resource does not exist. |\n| `TOO_MANY_REQUESTS` | There have been too many requests, please slow down your call rate. |\n| `UNAUTHORIZED` | The request lacks the necessary credentials. |\n","enum":["BAD_REQUEST","CONFLICT","DUPLICATE_RESOURCE_ID_FOUND","FORBIDDEN","INTERNAL_ERROR","NOT_FOUND","TOO_MANY_REQUESTS","UNAUTHORIZED"],"type":"string"},"ErrorsIndex":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/Error"},"maxItems":20,"minItems":1,"type":"array"},"index":{"format":"int32","maximum":0,"minimum":0,"type":"integer"}},"required":["errors","index"],"type":"object"},"ForbiddenResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"GatewayTimeoutResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"InternalServerErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"NotFoundResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"QueryBrandStoreEditionPublishVersionRequest":{"properties":{"editionIdFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionBrandStoreEditionIdFilter"},"maxResults":{"default":50,"format":"int32","maximum":50,"minimum":1,"type":"integer"},"nextToken":{"type":"string"},"publishStatusFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionStorePublishStatusFilter"},"storeIdFilter":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionBrandStoreIdFilter"}},"required":["editionIdFilter","publishStatusFilter","storeIdFilter"],"type":"object"},"ServiceUnavailableErrorResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"StorePageVersion":{"description":"Version information for a store page","properties":{"pageId":{"description":"Identifier of the page","type":"string"},"version":{"description":"Version number of the page","format":"int32","type":"integer"}},"required":["pageId","version"],"type":"object"},"StorePublishState":{"description":"User State for content\n**StorePublishState Enum:**\n\n| StorePublishState | Description |\n|------|------|\n| `DRAFT` | Content is in draft form |\n| `PUBLISH` | Submit Content to Publish to LIVE / SCHEDULED |\n","enum":["DRAFT","PUBLISH"],"type":"string"},"StorePublishStatus":{"description":"Status of content publish\n**StorePublishStatus Enum:**\n\n| StorePublishStatus | Description |\n|------|------|\n| `DRAFT` | Content is in draft state |\n| `REVIEW_IN_PROGRESS` | Content is pending publication for review |\n","enum":["DRAFT","REVIEW_IN_PROGRESS"],"type":"string"},"TooManyRequestsResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedResponseContent":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"UpdateBrandStoreEditionPublishVersionRequest":{"properties":{"brandStoreEditionPublishVersions":{"items":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionUpdate"},"maxItems":1,"minItems":1,"type":"array"}},"required":["brandStoreEditionPublishVersions"],"type":"object"}},"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://www.amazon.com/ap/oa","scopes":{"advertising::audiences":"Grants access to data provider APIs","advertising::campaign_management":"Grants write access to campaign management.","advertising::test:create_account":"Grants write access to create test accounts functionality","cpc_advertising:campaign_management":"Grants write access to campaign management. Legacy name (no difference from advertising::campaign_management)"},"tokenUrl":"https://api.amazon.com/auth/o2/token"}},"type":"oauth2"}}},"info":{"description":"Amazon Ads API v1 is a reimagined approach to our Ads API, built to provide a seamless experience across all Amazon advertising products through a common model. [Learn more about Ads API v1.](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/overview) To learn about prerequisites and header values, see [Getting started with Amazon Ads API v1](https://advertising.amazon.com/API/docs/en-us/reference/amazon-ads/getting-started).\n\n**Download Amazon Ads API V1 OpenAPI Spec** ([All Products](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLMerged_prod_3p.json) | [SP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPMerged_prod_3p.json) | [SP Global](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISPGLOBALMerged_prod_3p.json) | [SB](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISBMerged_prod_3p.json) | [DSP](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIDSPMerged_prod_3p.json) | [ST](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISTMerged_prod_3p.json) | [SD](https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPISDMerged_prod_3p.json))","title":"BrandStoreEditionPublishVersions API","version":"3.0"},"openapi":"3.0.1","paths":{"/adsApi/v1/query/brandStoreEditionPublishVersions":{"post":{"description":"Query store edition publish versions\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"QueryBrandStoreEditionPublishVersion","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBrandStoreEditionPublishVersionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionSuccessResponse"}}},"description":"QueryBrandStoreEditionPublishVersion 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["BrandStoreEditionPublishVersions"]}},"/adsApi/v1/update/brandStoreEditionPublishVersions":{"post":{"description":"Update store edition publish versions\n\n**Requires one of these permissions**:\n[\"amazon_stores_edit\"]","operationId":"UpdateBrandStoreEditionPublishVersion","parameters":[{"$ref":"#/components/parameters/ClientIdHeader"},{"$ref":"#/components/parameters/ScopeHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrandStoreEditionPublishVersionRequest"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandStoreEditionPublishVersionMultiStatusResponse"}}},"description":"UpdateBrandStoreEditionPublishVersion 207 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponseContent"}}},"description":"BadRequest 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponseContent"}}},"description":"Unauthorized 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponseContent"}}},"description":"Forbidden 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponseContent"}}},"description":"NotFound 404 response"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTooLargeResponseContent"}}},"description":"ContentTooLarge 413 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponseContent"}}},"description":"TooManyRequests 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorResponseContent"}}},"description":"InternalServerError 500 response"},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayResponseContent"}}},"description":"BadGateway 502 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorResponseContent"}}},"description":"ServiceUnavailableError 503 response"},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutResponseContent"}}},"description":"GatewayTimeout 504 response"}},"security":[{"OAuth2":["advertising::campaign_management"]}],"tags":["BrandStoreEditionPublishVersions"]}}},"servers":[{"description":"Production server for NA","url":"https://advertising-api.amazon.com"},{"description":"Production server for EU","url":"https://advertising-api-eu.amazon.com"},{"description":"Production server for FE","url":"https://advertising-api-fe.amazon.com"}]}