Endpoints
Catalog Creation Request Attributes (for Brand accounts)
Data Type: stringDescription: Brand(s) ids used to filter down catalog results based on specified brandsValues: int64
Catalog Creation Request Attributes (for Seller accounts)
Data Type: stringValues: -Description: Seller id(s) in respective retailers’ catalogs, used to filter down catalog items
Catalog Status Response Attributes
Data Type: stringValues:
RetailMediaCatalogStatusDescription: Type definition of the following attributes structureData Type: stringValues: enum with possible values:
pending, success, failure, expired, unknownDescription: Status of the catalog creation requestData Type: stringValues:
USD, EUR, etcDescription: ISO-4217 currency of the items in the respective catalogData Type: integerValues: int32Description: Number of products contained in the catalog (available when creation reaches
success status)Data Type: integerValues: int32Description: Size of catalog, in bytes (available when creation reaches
success status)Data Type: stringValues: 32-char alpha-numeric stringsDescription: MD5 checksum of catalog’s content (available when creation reaches
success status)Catalog Output Response Attributes
Data Type: stringValues: 500 char limitDescription: Retailer product ID, established by the retailer
Data Type: stringValues: 120 char limitDescription: Brand name of the product; names are standardized across retailers
Data Type: numberValues: greater than 0Description: Minimum Cost-Per-Click (CPC) an advertiser must bid for the product, established by the retailer; any line item with this product must have targetBid meet this value
Data Type: stringValues: -Description: Global Trade Item Number (GTIN), if available; also known as European Article Number (EAN) or Universal Product Code (UPC)
Catalog Asynchronous Workflow: Step 1 of 3
- Create a request for the latest catalog of the specified account using the appropriate endpoint.
- This action generates a
catalogIdthat represents the account’s catalog. - Catalog requests are cached for 1 hour, meaning repeated requests within this timeframe will return the same
catalogIdand output.
Create a Catalog Request for Brand account
This endpoint creates a request for the latest available catalog for a specific accountBest Practice Tip!To speed up catalog downloads, you can narrow down the results by using the
brandIdFilter body parameter. This allows you to filter the catalog by specific brands, helping to return results faster.Catalog Asynchronous Workflow: Step 2 of 3After generating a
catalogId, use it to poll the catalog status endpoint to check the progress. Continue polling until the catalog is successfully created and ready for download.Create a Catalog Request for Seller account
This endpoint creates catalog for a particular Seller account: Sample RequestGet Status of a Specific Catalog
This endpoint retrieves the status of a specific catalog. Status can bepending, success, failure, or expired
Sample Request
Catalog Asynchronous Workflow: Step 3 of 3Once the catalog is successfully created, use the catalog output endpoint to download the collection of catalog products. Note that catalog outputs are typically available for 72 hours before they expire, so be sure to download them within this time frame.