{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AuthorizationExceptionResponse":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"BadRequestExceptionResponse":{"description":"Invalid input values. Ex bad marketplaceId, missing required inputs, or requester does not have permission for API and/or resource.","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ConflictExceptionResponse":{"description":"Conflict detected","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ForbiddenExceptionResponse":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"IdentifierType":{"description":"Identifier type for requested entity/resource","enum":["ASIN","BRAND_AID_ID","ENTITY_ID","GCOR","NODE","STORE"],"type":"string"},"ListPagesRequest":{"description":"Request Object for ListPages API","properties":{"identifier":{"description":"Identifier for requested store. Currently supported: store\u0027s brand-/sub-entityId and storeId.","type":"string"},"identifierType":{"$ref":"#/components/schemas/IdentifierType"},"maxResults":{"description":"Optional: Max number of entries returned in a call. Supported values are 1-30 inclusive. Defaults to 30.","maximum":30,"minimum":1,"type":"integer"},"nextToken":{"description":"Optional: Pagination input token. If provided, returns the next paginated result of size \u003c\u003d `maxResults`.","type":"string"}},"required":["identifier","identifierType"],"type":"object"},"ListPagesResponse":{"description":"Response Object for ListPages API","properties":{"nextToken":{"description":"Optional: Pagination input token. If provided, returns the next paginated result of size \u003c\u003d `maxResults`.","type":"string"},"storePages":{"description":"Paginated list of `StorePageInfos`\u0027s. Result list size \u003c\u003d maxResults.","items":{"$ref":"#/components/schemas/StorePageInfo"},"type":"array"}},"type":"object"},"ListStoresRequest":{"description":"Request Object for ListStores API","properties":{"identifier":{"description":"Optional: Identifier for requested entity. Currently supported: Advertiser entityId.","type":"string"},"identifierType":{"$ref":"#/components/schemas/IdentifierType"},"maxResults":{"description":"Optional: Max number of entries returned in a call. Supported values are 1-30 inclusive. Defaults to 30.","maximum":30,"minimum":1,"type":"integer"},"nextToken":{"description":"Optional: Pagination input token. If provided, returns the next paginated result of size \u003c\u003d `maxResults`.","type":"string"}},"type":"object"},"ListStoresResponse":{"description":"Response Object for ListStores API","properties":{"nextToken":{"description":"Nullable. The next token to be used for paginated querying.","type":"string"},"stores":{"description":"Paginated list of `StoreInfo`\u0027s. Result list size \u003c\u003d maxResults. If advertiser has no stores, returns empty list.","items":{"$ref":"#/components/schemas/StoreInfo"},"type":"array"}},"required":["stores"],"type":"object"},"NotFoundExceptionResponse":{"description":"Requested resource not found","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"State":{"description":"Status of a resource","enum":["APPROVED","CANCELED","DRAFT","LIVE","PENDING","REJECTED","SCHEDULED"],"type":"string"},"StoreId":{"description":"The Store Identifier.","maxLength":36,"minLength":36,"pattern":"[0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}","type":"string"},"StoreInfo":{"properties":{"brandEntityId":{"description":"The ID of the Brand Entity associated with the store","type":"string"},"storeId":{"$ref":"#/components/schemas/StoreId"},"storeName":{"description":"The name of the store","type":"string"},"storeStatus":{"$ref":"#/components/schemas/State"}},"type":"object"},"StorePageInfo":{"properties":{"storePageId":{"description":"The ID of the store page","type":"string"},"storePageName":{"description":"The name of the store page","type":"string"},"storePageStatus":{"$ref":"#/components/schemas/State"},"storePageUrl":{"description":"The URL of the store page","type":"string"}},"type":"object"},"ThrottlingExceptionResponse":{"description":"Throttling","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"}},"securitySchemes":{}},"info":{"description":"Brand Home API Service","title":"Brand Home","version":"3.0"},"openapi":"3.0.1","paths":{"/brand/stores/v1/storePages/list":{"post":{"description":"List all Store pages for Advertiser\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\",\"amazon_stores_edit\",\"amazon_stores_view\"]\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Advertising-GlobalAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\",\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"ListPages","parameters":[],"requestBody":{"content":{"application/brandStore.ListPages.v1+json":{"schema":{"$ref":"#/components/schemas/ListPagesRequest"}},"application/vnd.bhstorepageslist.v1+json":{"schema":{"$ref":"#/components/schemas/ListPagesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPagesResponse"}},"application/vnd.bhstorepageslist.v1+json":{"schema":{"$ref":"#/components/schemas/ListPagesResponse"}}},"description":"ListPages 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponse"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationExceptionResponse"}}},"description":"AuthorizationException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponse"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponse"}}},"description":"NotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictExceptionResponse"}}},"description":"ConflictException 409 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponse"}}},"description":"ThrottlingException 429 response"}},"tags":["BrandHomeAPIService"]}},"/brand/stores/v1/stores/list":{"post":{"description":"Lists all Stores for Advertiser\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\",\"amazon_stores_edit\",\"amazon_stores_view\"]\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Advertising-GlobalAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\",\"amazon_stores_edit\",\"amazon_stores_view\"]","operationId":"ListStores","parameters":[],"requestBody":{"content":{"application/brandStores.ListStores.v1+json":{"schema":{"$ref":"#/components/schemas/ListStoresRequest"}},"application/vnd.bhstoreslist.v1+json":{"schema":{"$ref":"#/components/schemas/ListStoresRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStoresResponse"}},"application/vnd.bhstoreslist.v1+json":{"schema":{"$ref":"#/components/schemas/ListStoresResponse"}}},"description":"ListStores 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponse"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationExceptionResponse"}}},"description":"AuthorizationException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponse"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponse"}}},"description":"NotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingExceptionResponse"}}},"description":"ThrottlingException 429 response"}},"tags":["BrandHomeAPIService"]}}}}