{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"ProductMetadataModel":{"properties":{"asin":{"description":"ASIN of the item","example":"B0018OFKJS","type":"string"},"availability":{"description":"Stock availability: \n * IN_STOCK - The item is in stock. \n * IN_STOCK_SCARCE - The item is in stock, but stock levels are limited. \n * OUT_OF_STOCK - The item is currently out of stock. \n * PREORDER - The item is not yet available, but can be pre-ordered. \n * LEADTIME - The item is only available after some amount of lead time. \n * AVAILABLE_DATE - The item is not available, but will be available on a future date.","example":"IN_STOCK","type":"string"},"basisPrice":{"$ref":"#/components/schemas/basisPrice"},"bestSellerRank":{"description":"Best seller rank position in the category","example":"36","type":"string"},"brand":{"description":"Brand name of the item","example":"Levi\u0027s","type":"string"},"category":{"description":"Category (browse node) name of the ASIN","example":"Men\u0027s Jeans","type":"string"},"createdDate":{"description":"Date the item was first available on Amazon","example":"Jul 1, 2021","type":"string"},"eligibilityStatus":{"description":"Eligibility status for advertising: \n * ELIGIBLE - Eligible for advertising \n * INELIGIBLE - Ineligible for advertising","example":"ELIGIBLE","type":"string"},"globalStoreSetting":{"description":"This denotes the fields related to [GlobalStore Program](https://sellercentral.amazon.com/help/hub/reference/external/202139180).","properties":{"catalogSourceCountryCode":{"description":"Country code of source marketplace where seller has listed the product. Possible source country codes include US, UK, DE, JP, AE, and TR.","example":"US","maxLength":2,"minLength":2,"type":"string"}},"type":"object"},"imageUrl":{"description":"Url to the product image","example":"https://m.media-amazon.com/images/I/51s3ut4zPxL._SS60_.jpg","type":"string"},"ineligibilityCodes":{"description":"List of ineligible status identifier","example":["INELIGIBLE_CONDITION","MISSING_TITLE"],"items":{"type":"string"},"maxItems":12,"minItems":0,"type":"array"},"ineligibilityReasons":{"description":"List of reasons that made this item ineligible to be advertised","example":["This product is missing basic information to be advertised","This product is unsafe to be advertised"],"items":{"type":"string"},"maxItems":12,"minItems":0,"type":"array"},"priceToPay":{"$ref":"#/components/schemas/priceToPay"},"sku":{"description":"sku of the item","example":"SKU1","type":"string"},"title":{"description":"Product title of the item","example":"Wrangler Men\u0027s Classic 5-Pocket Regular Fit Flex Jean","type":"string"},"variationList":{"description":"List of ASIN variations of the current item","example":["ASIN_XL_size","ASIN_blue_color"],"items":{"type":"string"},"maxItems":1500,"minItems":0,"type":"array"}},"type":"object"},"ProductMetadataRequest":{"properties":{"adType":{"description":"Program type. Required if checks advertising eligibility: \n * SP - Sponsored Product \n * SB - Sponsored Brand \n * SD - Sponsored Display","enum":["SB","SD","SP"],"type":"string"},"asins":{"description":"Specific asins to search for in the advertiser\u0027s inventory. Cannot use together with skus or searchStr input types.","example":["B0018OFKJS","B01IR7S432"],"items":{"maxLength":10,"minLength":10,"type":"string"},"maxItems":300,"minItems":0,"type":"array"},"checkEligibility":{"default":"false","description":"Whether advertising eligibility info is required","type":"boolean"},"checkItemDetails":{"default":"false","description":"Whether item details such as name, image, and price is required.","type":"boolean"},"cursorToken":{"description":"Pagination token used for the suggested sort type or for author merchant","type":"string"},"isGlobalStoreSelection":{"default":"false","description":" This will return only GlobalStore listings related to [GlobalStore Program](https://sellercentral.amazon.com/help/hub/reference/external/202139180) and not local listings","type":"boolean"},"locale":{"description":"Optional locale for detail and eligibility response strings. Default to the marketplace locale.","example":"zh_CN","type":"string"},"pageIndex":{"description":"Index of the page to be returned; For author, this value will be ignored, should use cursorToken instead. For seller and vendor, results are capped at 10k ((pageIndex + 1) * pageSize).","example":"0","format":"int32","minimum":0,"type":"integer"},"pageSize":{"description":"Number of items to be returned on this page index.","example":"5","format":"int32","maximum":300,"minimum":1,"type":"integer"},"searchStr":{"description":"Specific string in the item title to search for in the advertiser\u0027s inventory. Case insensitive. Cannot use together with asins or skus input types.","example":"jean","maxLength":200,"type":"string"},"skus":{"description":"Specific SKUs to search for in the advertiser\u0027s inventory. Currently only support SP program type for sellers. Cannot use together with asins or searchStr input types.","example":["sku1","sku2"],"items":{"type":"string"},"maxItems":300,"minItems":0,"type":"array"},"sortBy":{"description":"Sort option for the result. Currently only support SP program type for sellers: \n * SUGGESTED - Suggested products are those most likely to engage customers, and have a higher chance of generating clicks if advertised. \n * CREATED_DATE - Date the item listing was created ","enum":["CREATED_DATE","SUGGESTED"],"type":"string"},"sortOrder":{"default":"DESC","description":"Sort order (has to be DESC for the suggested sort type): \n * ASC - Ascending, from A to Z \n * DESC - Descending, from Z to A","enum":["ASC","DESC"],"type":"string"}},"required":["pageIndex","pageSize"],"type":"object"},"ProductMetadataResponse":{"properties":{"ProductMetadataList":{"items":{"$ref":"#/components/schemas/ProductMetadataModel"},"maxItems":300,"minItems":0,"type":"array"},"cursorToken":{"description":"Pagination token for later requests with specific sort type to use as the page index instead. Empty cursorToken means no further data is present at Server side.","type":"string"}},"type":"object"},"basisPrice":{"description":"The basis price before the savings are calculated","properties":{"amount":{"description":"Price amount","example":"6.99","type":"number"},"currency":{"description":"Currency of the price","example":"USD","type":"string"}},"type":"object"},"error":{"description":"Error response object.","properties":{"code":{"description":"Enumerated error type.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"priceToPay":{"description":"The price customer would pay for the buying option","properties":{"amount":{"description":"Price amount","example":"3.99","type":"number"},"currency":{"description":"Currency of the price","example":"USD","type":"string"}},"type":"object"}},"securitySchemes":{}},"info":{"description":"AAPI-compatible product-details endpoint ported from `/v2/products/details` into PSS.","title":"Product Selector","version":"3.0"},"openapi":"3.0.1","paths":{"/product/metadata":{"post":{"description":"\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\",\"campaign_edit\",\"campaign_view\",\"ads_planner_internal_edit\",\"ads_planner_edit\"]","operationId":"ProductMetadata","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"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":false,"schema":{"type":"string"}},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.productmetadatarequest.v1+json":{"schema":{"$ref":"#/components/schemas/ProductMetadataRequest"}}},"required":true},"responses":{"200":{"content":{"application/vnd.productmetadataresponse.v1+json":{"schema":{"$ref":"#/components/schemas/ProductMetadataResponse"}}},"description":"Successful operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Internal Server Error."}},"summary":"Returns product metadata for the advertiser","tags":["Product Selector"]}}}}