# Epsilon Retail Media Partner API Documentation > Documentation for Epsilon Retail Media Partner API ## Guides - [Getting Started with CitrusAd Partners](https://developers.citrusad.com/partner/docs/getting-started.md) - [User key authentication](https://developers.citrusad.com/partner/docs/user-key-authentication-1.md) - [Create/Update Campaign fields](https://developers.citrusad.com/partner/docs/createupdate-campaign-fields-1.md) - [Frequently asked questions](https://developers.citrusad.com/partner/docs/frequently-asked-questions-1.md) - [API Deprecation Policy](https://developers.citrusad.com/partner/docs/api-deprecation-policy-1.md) - [API Deprecation Schedule](https://developers.citrusad.com/partner/docs/api-deprecation-schedule-1.md) ## API Reference - [Epsilon Retail Media Partner APIs overview](https://developers.citrusad.com/partner/reference/epsilon-retail-media-partner-apis-overview-1.md) - [Onboarding Checklist](https://developers.citrusad.com/partner/reference/onboarding-checklist.md): This checklist provides a complete guide for onboarding and API integration. Ensure all steps are completed before moving to production. - [Error handling](https://developers.citrusad.com/partner/reference/error-handling.md) - [Frequently asked questions](https://developers.citrusad.com/partner/reference/frequently-asked-questions.md) - [Campaign field definitions](https://developers.citrusad.com/partner/reference/campaign-field-definitions.md) - [Authentication requests](https://developers.citrusad.com/partner/reference/authenticating-requests.md) - [Retrieve user key](https://developers.citrusad.com/partner/reference/getuserkey.md): This endpoint allows partners to get an authentication key by providing username and password. - [User key token](https://developers.citrusad.com/partner/reference/user-key-authentication.md) - [Product campaign](https://developers.citrusad.com/partner/reference/productcampaign-1.md) - [Create a product campaign](https://developers.citrusad.com/partner/reference/createproductcampaign.md): This endpoint creates a new product campaign with the marketing settings and product selections. Set up campaign details like budget, duration, and which products to promote. The campaign will be ready to launch once created. The following fields inside productCampaign are required: name, namespaceId, campaignState, teamId, walletId, placementId, catalogIds (at least one), and strategy (either strategy.auction or strategy.fixedTenancy). For search-targeted placements, targeting.searchTerms is also required, and each entry must include phrase and matchType. The caller's user must have the ROLE_CAMPAIGN_EDITOR permission on the campaign's teamId (or be an admin); otherwise the request will be rejected with PERMISSION_DENIED. - [Retrieve list of all product campaigns](https://developers.citrusad.com/partner/reference/listproductcampaigns.md): This endpoint shows all product campaigns with options to filter and sort them. Search by campaign name, team, approval status, and more. Results are shown in pages to make them easier to view and manage. - [Update product campaign](https://developers.citrusad.com/partner/reference/updateproductcampaign.md): This endpoint updates an existing product campaign settings. Modify campaign details like name, catalog assignments, and other campaign options. - [Approve or reject product campaign](https://developers.citrusad.com/partner/reference/approveproductcampaign-1.md): This endpoint allows approval or rejection of a product campaign. Change the approval status and provide rejection reasons if needed. - [Get product campaign for specified ID](https://developers.citrusad.com/partner/reference/getproductcampaign-1.md): This endpoint retrieves the complete details of a specific product campaign using its unique ID. View all campaign settings, performance data, and current status. Note: requestTeamId is required for supplier (advertiser) users and must match the team that owns the campaign. Retailer users may omit it. Requests from supplier users without a valid requestTeamId will fail with a 400 or 403 error. - [Check fixed tenancy campaign availability](https://developers.citrusad.com/partner/reference/checkfixedtenancyavailable-1.md): This endpoint checks if a fixed tenancy campaign can be booked for specified dates and placement. It shows any conflicts with existing campaigns and confirms availability. - [Banner X campaign](https://developers.citrusad.com/partner/reference/bannerxcampaign-1.md) - [Create a banner X campaign](https://developers.citrusad.com/partner/reference/createbannerxcampaign-1.md): Creates a new banner X campaign using the details provided in the request body. This endpoint allows you to define campaign parameters, targeting, strategy, and other configurations to launch a new campaign. - [Get banner X campaign details](https://developers.citrusad.com/partner/reference/getbannerxcampaign-1.md): Retrieves banner X campaign details for the specified campaign ID. - [Update Banner X campaign](https://developers.citrusad.com/partner/reference/updatebannerxcampaign.md): This endpoint allows you to update an existing Banner X campaign by providing the campaign ID and the updated campaign data in the request body. You can modify campaign properties such as name, targeting, strategy, and Banner X specific configurations. - [Update banner X campaign approval state](https://developers.citrusad.com/partner/reference/approvebannerxcampaign-1.md): Updates the approval state of a specified banner X campaign. You can approve or reject the campaign by setting the appropriate state and providing a rejection reason if necessary. - [Retrieve list of all banner X campaigns](https://developers.citrusad.com/partner/reference/listbannerxcampaigns.md): Retrieves a list of banner X campaigns based on specified filters and parameters, including campaign name, placement ID, team ID, approval state, and more. Supports pagination and sorting to manage large sets of data effectively. - [Banner campaign](https://developers.citrusad.com/partner/reference/bannercampaign.md) - [Create a banner campaign](https://developers.citrusad.com/partner/reference/createbannercampaign-1.md): Creates a new banner campaign using the details provided in the request body. This endpoint allows you to define campaign parameters, targeting, strategy, and other configurations to launch a new campaign. - [Get banner campaign details](https://developers.citrusad.com/partner/reference/getbannercampaign-1.md): Retrieves banner campaign details for the specified campaign ID. - [Update banner campaign](https://developers.citrusad.com/partner/reference/updatebannercampaign.md): This endpoint updates an existing banner campaign by its unique identifier. It allows partial updates to campaign properties including name, scheduling, targeting, budget settings, and banner configuration. - [Update banner campaign approval state](https://developers.citrusad.com/partner/reference/approvebannercampaign.md): Updates the approval state of a specified banner campaign. You can approve or reject the campaign by setting the appropriate state and providing a rejection reason if necessary. - [Campaign files](https://developers.citrusad.com/partner/reference/creativeassets.md) - [Upload a campaign file](https://developers.citrusad.com/partner/reference/uploadfile.md): Use this endpoint to upload different types of campaign files. You can upload images for banners and banner X in jpeg, jpg, png, gif, PDF, or SVG formats. You may also upload content standard PDF files and content standard display logos. Ensure that logo files are in jpeg, jpg, or png format. **New version available**: [Upload a campaign file - v4](https://citrusad-group.readme.io/partner/reference/uploadfile-2) is now available with enhanced features. - [Upload a campaign file - v4](https://developers.citrusad.com/partner/reference/uploadfile-2.md): This endpoint allows uploading different types of campaign files including banners, banner X, and brand pages. It includes support for hero image display modes and background positioning controls. Accepted formats include JPEG, JPG, PNG, GIF, PDF, and SVG for banners, banner X, and brand page campaigns, along with standard PDF files for content. Display logos must be in JPEG, JPG, or PNG format. - [Retrieve campaign file URL](https://developers.citrusad.com/partner/reference/getcampaignfileurl.md): This endpoint retrieves the URL for uploaded campaign assets for banners, banner X, and brand page campaigns. The URL is generated based on the specified file ID and file type. - [Content standard](https://developers.citrusad.com/partner/reference/bannerxcontentstandard.md) - [Get Banner X content standard details](https://developers.citrusad.com/partner/reference/getbannerxcontentstandard-1.md): Retrieves Banner X content standard details for the specified content standard ID. - [Retrieve list of content standards for Banner X campaigns](https://developers.citrusad.com/partner/reference/listbannerxcontentstandard.md): Retrieves the list of content standards for Banner X campaigns based on the specified parameters, such as namespace, name, and content standard ID. - [Get banner content standard details](https://developers.citrusad.com/partner/reference/getbannercontentstandard.md): Retrieves Banner content standard details for the specified content standard ID. - [Retrieve list of content standards for banner campaigns](https://developers.citrusad.com/partner/reference/listbannercontentstandard.md): Retrieves the list of content standards for banner campaigns based on the specified parameters, such as namespace, name, and content standard ID. - [Campaign](https://developers.citrusad.com/partner/reference/campaign.md) - [Retrieve list of all campaigns](https://developers.citrusad.com/partner/reference/listcampaigns-1.md): This endpoint retrieves a list of campaigns based on specified filters and parameters such as campaign name, campaign type, placement ID, team ID, approval state, and more. A date range (from and to) can be provided to narrow results based on the update time of the campaign. Pagination and sorting are supported to manage large datasets efficiently. - [Retrieve campaign history](https://developers.citrusad.com/partner/reference/getcampaignhistory.md): Retrieve a campaign's history using its campaign ID. You can access the entire campaign history or specify a date range by using the fromDate and toDate parameters. - [Retrieve minimum bid details for keywords](https://developers.citrusad.com/partner/reference/retrievekeywordsminbid.md): Retrieve individual minimum bid details and the overall campaign minimum bid for an array of specified keywords in Search and Category & Search placement type campaigns. - [Retrieve minimum bid details for category](https://developers.citrusad.com/partner/reference/retrievecategoryminbid.md): Retrieve individual minimum bid details and the overall campaign minimum bid for category placement type campaigns. - [Team](https://developers.citrusad.com/partner/reference/team.md) - [Create team](https://developers.citrusad.com/partner/reference/createteam-1.md): This endpoint creates a new team for an organization. It allows specifying team details, company information, and business settings to organize advertising campaigns and manage user access. - [Create team - v3](https://developers.citrusad.com/partner/reference/createteam.md): This endpoint enables the creation of teams within an organization to streamline campaign management and user access. In version 3, direct user assignment via userIds has been removed. Users must be invited through a dedicated invite flow, enhancing control and traceability. Use this endpoint to specify team details, company information, and business settings to organize advertising campaigns and manage access permissions effectively. - [Update a team](https://developers.citrusad.com/partner/reference/updateteam.md): This endpoint updates the details of a team specified by the team_id. It allows modification of various team attributes such as the team name, company details, phone number, website URL, address, and more. - [Lists all teams](https://developers.citrusad.com/partner/reference/listteams-1.md): Retrieve a list of teams by providing the parameters such as, name, namespace_id, and seller_id. Use the page_token to navigate through the pages and page_size to specify the number of teams returned per page. - [Get team for specified id](https://developers.citrusad.com/partner/reference/getteam-1.md) - [Join a team with invitation token](https://developers.citrusad.com/partner/reference/currentuserjointeam-1.md): This endpoint enables users to join a team using a valid and unexpired invitation token. Users send a POST request that includes the invitationToken to authenticate their request to join the specified team. This ensures only those with valid and unexpired tokens can join the team. - [User](https://developers.citrusad.com/partner/reference/user-1.md) - [Invite a user to the team](https://developers.citrusad.com/partner/reference/createuserteaminvite.md): Sends an invitation to a user to join a specified team. It requires parameters such as the team's unique identifier and the email address of the user to be invited. The retailer team, identified by a unique ID, manages access and can also invite suppliers. - [Retrieve current user detail](https://developers.citrusad.com/partner/reference/getuserprofile.md): Use this endpoint to retrieve the details of the user currently logged into the Epsilon Retail Media platform. The request relies on authentication, so no additional query parameters are needed. The endpoint returns detailed information about the user, including their user ID, email address, first name, and last name. It also provides details about any team invites that the user has not yet accepted, such as the email address of the sender, the team ID, and the team name associated with the invite. - [Retrieve user details](https://developers.citrusad.com/partner/reference/getusersforteam.md): Retrieve user details based on the provided team ID. The endpoint returns information such as user ID, email, first name, and last name for all users in the team. You can also fetch detail of a single user. To fetch details for an individual user, include their user ID to limit the response to that specific user. - [Update current user detail](https://developers.citrusad.com/partner/reference/updateuserprofile.md): Use this endpoint to modify the details of the currently logged in user on the Epsilon Retail Media platform. You can update the first name, last name, and a file ID for the user's logo. - [Modify user permission](https://developers.citrusad.com/partner/reference/modifyuserpermission.md): Use this endpoint to update a user's permissions by providing both user ID and team ID. To modify permissions for supplier teams, full supplier access is required, while full retailer access is necessary for retailer teams. Retailers can modify supplier permissions by specifying retailerTeamId. Ensure that API requests are authenticated with the retailer's bearer token. Users can be assigned either 'Retailer Full' and 'Retailer Report View' permissions or 'Supplier Full' and 'Supplier Report View' permissions. Combining retailer and supplier roles is not allowed. - [Upload a file](https://developers.citrusad.com/partner/reference/uploadfile-1.md): This endpoint allows you to upload logos for user profiles and teams. - [Retrieve file URL](https://developers.citrusad.com/partner/reference/getfileurl.md): Retrieve the URL for a team or user logo using the specified file ID. - [Remove a user](https://developers.citrusad.com/partner/reference/quitteam.md): This endpoint lets a retailer, supplier, or admin remove a user from the team. You must have the necessary permissions to perform this action. - [Bulk Operations overview](https://developers.citrusad.com/partner/reference/bulk-operation-overview.md) - [Campaign](https://developers.citrusad.com/partner/reference/bulkcampaignoperations.md) - [Create campaign in bulk](https://developers.citrusad.com/partner/reference/bulkcreatecampaign.md): This endpoint creates multiple campaigns simultaneously (up to 1,000) based on the specified campaign type. Use it to submit a single request containing different campaign types and configurations. The endpoint supports CAMPAIGN_TYPE_DISPLAY, CAMPAIGN_TYPE_BANNERX, and CAMPAIGN_TYPE_BANNER, each with its own type-specific validation. Note: For CAMPAIGN_TYPE_BANNER, the bannerConfig field must be provided. For CAMPAIGN_TYPE_BANNERX, the bannerXConfig field must be provided. - [Update campaigns in bulk](https://developers.citrusad.com/partner/reference/bulkupdatecampaign-1.md): This endpoint enables simultaneous updates to multiple campaigns in a single operation. It supports selective field updates using field masks to specify which campaign properties should be modified, while preserving unchanged fields. The operation is optimized for bulk modifications across campaigns of the same type, providing efficient batch processing for campaign management workflows. Field masks allow precise control over which attributes are updated (e.g., 'name,startTime,endTime') ensuring only intended changes are applied. - [Update campaign approval state](https://developers.citrusad.com/partner/reference/bulkcampaignapproval.md): Approve campaigns within a specified namespace. Campaign approval may take longer due to GCS rate-limiting during backend processing. - [Retrieve bulk operation status](https://developers.citrusad.com/partner/reference/bulkcampaignstatus-1.md): This endpoint retrieves the status and details of a bulk campaign operation using the bulk operation ID. It has been enhanced to support pagination (default: 20 items per page) and status-based filtering, for improved performance and targeted data retrieval. - [Wallet](https://developers.citrusad.com/partner/reference/bulkwalletoperations.md) - [Create wallets in bulk](https://developers.citrusad.com/partner/reference/bulkcreatewallet.md): This endpoint allows you to create multiple wallets at once within your organization (up to 1,000). You can set up wallet details including names, currency settings, spending limits, and team assignments. - [Retrieve bulk wallet operation status](https://developers.citrusad.com/partner/reference/bulkwalletstatus.md): This endpoint retrieves the status of a bulk wallet operation using its bulk ID. It has been enhanced to support pagination (default: 20 items per page) and status-based filtering, for improved performance and targeted data retrieval. Use this endpoint to check the progress and completion status of bulk update operations. - [Update wallets in bulk](https://developers.citrusad.com/partner/reference/bulkupdatewallet.md): This endpoint updates multiple wallets simultaneously. Use this endpoint to update name, external ID, archived status, daily budget, and credit limit. - [Team](https://developers.citrusad.com/partner/reference/bulkwalletoperations-1.md) - [Create teams in bulk](https://developers.citrusad.com/partner/reference/bulkcreateteam.md): This endpoint creates bulk team for an organization using new v3 version logic in the background. It allows specifying team details, company information, and business settings to organize advertising campaigns and manage user access. Note: When a supplier attempts to create records in bulk, the API allows a maximum of 50 records per request. If the request contains more than 50 records, the API returns an error message indicating that the limit has been exceeded. - [Update teams in bulk](https://developers.citrusad.com/partner/reference/bulkupdateteam.md): This endpoint updates bulk teams simultaneously based on the field mask. Note: When a supplier attempts to update records in bulk, the API allows a maximum of 50 records per request. If the request contains more than 50 records, the API returns an error message indicating that the limit has been exceeded. - [Retrieve bulk team operation status](https://developers.citrusad.com/partner/reference/bulkteamstatus.md): This endpoint retrieves the status of a bulk team operation using its bulk ID. It has been enhanced to support pagination (default: 20 items per page) and status-based filtering, for improved performance and targeted data retrieval. Use this endpoint to check the progress and completion status of bulk update operations. - [User](https://developers.citrusad.com/partner/reference/bulkteamoperations-1.md) - [Invite users to teams in bulk](https://developers.citrusad.com/partner/reference/bulkinviteusers.md): This endpoint sends invitations to multiple users to join specified teams in a single request. Each invitation includes the team ID, roles to assign, and the email address of the user to be invited. Optionally specify a custom invitation URL and language code for the email template. - [Remove users from teams in bulk](https://developers.citrusad.com/partner/reference/bulkremoveusers.md): This endpoint removes multiple users from their respective teams in a single request. Each removal specifies the team ID and user ID. Use the Retrieve bulk team operation status endpoint to check the status of the operation. - [Wallet](https://developers.citrusad.com/partner/reference/wallet.md) - [Create a wallet](https://developers.citrusad.com/partner/reference/createwallet.md): This endpoint creates a wallet within a specified namespace and associates it with a team using the team ID. The request body defines the wallet's attributes, including its name, currency, spending limits, and archival status. - [Update a wallet](https://developers.citrusad.com/partner/reference/updatewallet-1.md): This endpoint updates a wallet within a specified namespace and teamId. This endpoint allows you to modify attributes such as the wallet's name, credit limit, daily budget, external ID, and other relevant fields. - [Retrieve wallet by ID](https://developers.citrusad.com/partner/reference/getwallet-1.md): Fetches the details of a specific wallet using its unique identifier, {id}. This endpoint returns information such as the wallet's name, balance, currency, and associated team, providing a comprehensive view of the wallet's current state. - [List all wallets](https://developers.citrusad.com/partner/reference/listwallets.md): This endpoint retrieves a list of wallets based on specified filters and parameters, including team ID, wallet name, wallet ID, external ID, and more. Supports pagination and sorting to manage large sets of data effectively. - [Get the balance of a specific wallet](https://developers.citrusad.com/partner/reference/getwalletbalance.md) - [Manage funds to a specific wallet](https://developers.citrusad.com/partner/reference/managefunds.md): This endpoint allows you to add or remove funds from a specific wallet. You can top up wallet balances using a payment card or adjust funds as needed for your business operations. Each request includes safety features to prevent duplicate transactions. - [Retrieve campaign spend details](https://developers.citrusad.com/partner/reference/getcampaignspend.md): This endpoint calculates remaining campaign budget for specific campaigns based on their available balance and spending limits. It allows checking how much budget is left by different time periods (daily, hourly, or total) to manage campaign spending and budget allocation. - [Suggested Search Terms](https://developers.citrusad.com/partner/reference/suggestedsearchterm.md) - [Retrieve suggested search terms](https://developers.citrusad.com/partner/reference/listsuggestedsearchterms.md): This endpoint retrieves suggested search terms with options to filter by catalog, product code, and search term type. Results are shown in pages to make them easier to view and manage. - [Lists all segments (based on params provided)](https://developers.citrusad.com/partner/reference/listsegments.md): This endpoint retrieves a list of segments based on the provided query parameters, including pagination details. - [Create a segment](https://developers.citrusad.com/partner/reference/createsegment.md): This endpoint creates a new segment using the data provided in the request body. - [Get segment model for specified id](https://developers.citrusad.com/partner/reference/getsegment.md): This endpoint retrieves the segment object for the specified segment ID. - [Delete a segment](https://developers.citrusad.com/partner/reference/deletesegment.md): This endpoint deletes the segment for the specified segment ID. - [Manage access to a specific segment](https://developers.citrusad.com/partner/reference/manageaccess.md): This endpoint updates access permissions for a specific segment by managing allowed team IDs. - [Update a segment](https://developers.citrusad.com/partner/reference/updatesegment.md): This endpoint updates the details of an existing segment using the provided segment data. - [API Deprecation Policy](https://developers.citrusad.com/partner/reference/api-deprecation-policy.md) - [API Deprecation Schedule](https://developers.citrusad.com/partner/reference/api-deprecation-schedule.md) # Epsilon Retail Media Documentation > Documentation for Epsilon Retail Media ## Guides - [Integrate First Party Cookie](https://developers.citrusad.com/integration/docs/integrate-first-party-cookie.md): This document provides the steps to integrate your onsite activities with Epsilon’s First Party Cookie. - [Attribution on Epsilon Retail Media Platform](https://developers.citrusad.com/integration/docs/attribution-on-epsilon-retail-media-platform.md) - [Types of attribution models in Epsilon Retail Media](https://developers.citrusad.com/integration/docs/types-of-attribution-models-in-epsilon-retail-media.md) - [Direct platform attribution](https://developers.citrusad.com/integration/docs/direct-platform-attribution.md) - [Halo attribution](https://developers.citrusad.com/integration/docs/halo-attribution.md) - [In-store attribution](https://developers.citrusad.com/integration/docs/in-store-attribution.md) - [Introduction to Catalogs and Products](https://developers.citrusad.com/integration/docs/introduction-to-catalogs-and-products.md) - [Step 1: Create a Product Catalog](https://developers.citrusad.com/integration/docs/sync-your-products.md) - [Step 2: Add Product Details to Your Catalog](https://developers.citrusad.com/integration/docs/sync-your-catalogs.md) - [Option 1: Utilize APIs to Update Your Catalog](https://developers.citrusad.com/integration/docs/use-apis.md): Add product details to your catalog using APIs. - [Manage Product Details in Your Catalog Using APIs](https://developers.citrusad.com/integration/docs/update-product-details-using-apis.md) - [Option 2: Provide Product Data Files to Update Your Catalog](https://developers.citrusad.com/integration/docs/via-files.md): Add product details to your catalog using product data files. - [Campaign Editor](https://developers.citrusad.com/integration/docs/campaign-editor.md): Campaign Editor allows you to create campaigns. - [Create a Campaign for Retailers](https://developers.citrusad.com/integration/docs/create-campaign.md) - [Product Ad Campaigns](https://developers.citrusad.com/integration/docs/product-ad.md): This is for retailers creating a product ad campaign. - [Introduction to Ad Placement Types](https://developers.citrusad.com/integration/docs/introduction-to-placement-types.md) - [Generate Product Ads Using Search Placement](https://developers.citrusad.com/integration/docs/search-placements.md) - [Generate Product Ads Using Category Placements](https://developers.citrusad.com/integration/docs/generate-product-ads-using-category-placements.md) - [Optimize Ad Targeting](https://developers.citrusad.com/integration/docs/optimize-ad-targeting.md) ## API Reference - [Overview](https://developers.citrusad.com/integration/reference/overview.md) - [What ads can Epsilon Retail Media serve?](https://developers.citrusad.com/integration/reference/what-ads-can-citrusad-serve-1.md) - [Epsilon API Terms of Use](https://developers.citrusad.com/integration/reference/epsilon-api-terms-of-use.md) - [Acceptable Use Policy](https://developers.citrusad.com/integration/reference/acceptable-use-policy.md) - [API overview](https://developers.citrusad.com/integration/reference/api-overview.md) - [Ad Integration Workflow Options for Retailers](https://developers.citrusad.com/integration/reference/integration-workflow-options-1.md) - [Before you start](https://developers.citrusad.com/integration/reference/before-you-start.md) - [HTTP persistence & endpoints](https://developers.citrusad.com/integration/reference/http-persistence-ad-caching-endpoints-1.md) - [Reporting Impressions and Clicks](https://developers.citrusad.com/integration/reference/reporting-impressions-clicks.md): This document explains how to report impressions and clicks using Epsilon Retail Media APIs, with steps for integration and improved ad ID validation. - [Ad generation filtering](https://developers.citrusad.com/integration/reference/ad-generation-filtering-1.md) - [Timeouts and graceful fallback behaviour](https://developers.citrusad.com/integration/reference/timeouts-and-graceful-fallback-behaviour.md) - [OAuth 2.0 Authentication](https://developers.citrusad.com/integration/reference/oauth-20-authentication.md) - [Data overview](https://developers.citrusad.com/integration/reference/data-overview-1.md) - [Sync data via file protocols](https://developers.citrusad.com/integration/reference/syncing-data-via-file-protocols-1.md) - [Catalog & Products](https://developers.citrusad.com/integration/reference/catalog-products-2.md) - [Syncing catalog via API](https://developers.citrusad.com/integration/reference/syncing-catalog-via-api.md) - [Syncing products via API](https://developers.citrusad.com/integration/reference/syncing-products-via-api.md) - [Syncing catalog & products via file](https://developers.citrusad.com/integration/reference/syncing-catalog-products-via-file.md) - [Audience Targeting](https://developers.citrusad.com/integration/reference/audience-targeting-new.md) - [Option 1: Curated Unified Audiences](https://developers.citrusad.com/integration/reference/option-1-curated-unified-audiences.md) - [Option 2: Sync Customers & Audience](https://developers.citrusad.com/integration/reference/integration-option-2-sync-customers-audience.md) - [Option 3: Sync Audiences only](https://developers.citrusad.com/integration/reference/integration-option-3-sync-audiences-only.md) - [Order data](https://developers.citrusad.com/integration/reference/order-data-1.md) - [Syncing order data via API](https://developers.citrusad.com/integration/reference/syncing-order-data-via-api.md) - [Syncing order data via file](https://developers.citrusad.com/integration/reference/syncing-order-data-via-file.md) - [Location targeting](https://developers.citrusad.com/integration/reference/location-targeting.md) - [Pagination](https://developers.citrusad.com/integration/reference/pagination.md) - [Placement level product type blocking (HFSS support)](https://developers.citrusad.com/integration/reference/placement-level-product-type-blocking-hfss-support.md) - [Marketplace sellerId](https://developers.citrusad.com/integration/reference/marketplace-sellerid.md) - [Single Sign On for retailers](https://developers.citrusad.com/integration/reference/single-sign-on.md) - [Integrating Parent Products](https://developers.citrusad.com/integration/reference/integrating-parent-products.md) - [Suggested Keywords](https://developers.citrusad.com/integration/reference/suggested-keywords.md) - [Category Cross-sell](https://developers.citrusad.com/integration/reference/category-cross-sell.md) - [Difference Between Category and Category Cross-sell Placements](https://developers.citrusad.com/integration/reference/difference-between-category-and-category-cross-sell-placements.md) - [Integration requirements](https://developers.citrusad.com/integration/reference/integration-requirements.md) - [Digital Services Act](https://developers.citrusad.com/integration/reference/digital-services-act.md) - [Product ads](https://developers.citrusad.com/integration/reference/product-ads.md) - [Requesting product ads](https://developers.citrusad.com/integration/reference/requesting-product-ads-1.md) - [Banner ads (static)](https://developers.citrusad.com/integration/reference/banner-ads-static.md) - [Requesting banner ads](https://developers.citrusad.com/integration/reference/requesting-banner-ads.md) - [Banner content standard](https://developers.citrusad.com/integration/reference/banner-content-standard-1.md) - [Banner X](https://developers.citrusad.com/integration/reference/banner-x-responsive.md): Banner X ads are responsive, interactive banner ads with multiple components delivered to a retailer's frontend. - [Content standards](https://developers.citrusad.com/integration/reference/banner-x-content-standard-1.md) - [Banner X previewer](https://developers.citrusad.com/integration/reference/integrating-your-banner-x-previewer.md) - [Banner X video ads](https://developers.citrusad.com/integration/reference/video-ads-banner-x.md) - [Banner X video captions](https://developers.citrusad.com/integration/reference/bannerx-video-captions.md) - [Companion products](https://developers.citrusad.com/integration/reference/companion-products-banner-x.md) - [Generate banner X ads for different placements](https://developers.citrusad.com/integration/reference/requesting-banner-x-ads.md) - [Frequently asked questions (FAQs)](https://developers.citrusad.com/integration/reference/frequently-asked-questions-faqs.md) - [Go live checklist](https://developers.citrusad.com/integration/reference/go-live-checklist-1.md) - [UAT tests](https://developers.citrusad.com/integration/reference/uat-tests-1.md) - [Overview](https://developers.citrusad.com/integration/reference/overview-1.md) - [Prerequisites](https://developers.citrusad.com/integration/reference/prerequisites.md) - [Integration Architecture](https://developers.citrusad.com/integration/reference/integration-architecture.md) - [Authentication](https://developers.citrusad.com/integration/reference/authentication-1.md) - [Brand Page APIs](https://developers.citrusad.com/integration/reference/brand-page-apis.md) - [Module Capabilities](https://developers.citrusad.com/integration/reference/module-capabilities.md) - [Tracking & Attribution](https://developers.citrusad.com/integration/reference/tracking-attribution.md) - [Validation & Troubleshooting](https://developers.citrusad.com/integration/reference/validation-troubleshooting.md) - [Audience targeting reference](https://developers.citrusad.com/integration/reference/audience-targeting-reference.md) - [Product ad reference](https://developers.citrusad.com/integration/reference/product-ad-reference-1.md) - [Banner ad (static) reference](https://developers.citrusad.com/integration/reference/banner-ad-static-reference.md) - [Banner X reference](https://developers.citrusad.com/integration/reference/banner-x-reference-1.md) - [Catalog products reference](https://developers.citrusad.com/integration/reference/catalog-products-reference.md) - [Order reference](https://developers.citrusad.com/integration/reference/order-reference.md) - [Generate product and banner ads](https://developers.citrusad.com/integration/reference/generate.md) - [Generate banner X ads](https://developers.citrusad.com/integration/reference/bannerx.md) - [Report an order](https://developers.citrusad.com/integration/reference/report-an-order.md) - [Retrieve a list of orders](https://developers.citrusad.com/integration/reference/retrieve-a-list-of-orders.md) - [Retrieve an order](https://developers.citrusad.com/integration/reference/retrieve-an-order.md) - [Create or update a catalog](https://developers.citrusad.com/integration/reference/create-or-update-a-catalog.md) - [Create or update a product](https://developers.citrusad.com/integration/reference/create-or-update-a-product.md) - [Retrieve a list of products](https://developers.citrusad.com/integration/reference/retrieve-a-list-of-products.md) - [Retrieve a product](https://developers.citrusad.com/integration/reference/retrieve-a-product.md) - [Create or update a customer](https://developers.citrusad.com/integration/reference/create-or-update-a-customer.md) - [Retrieve a list of customers](https://developers.citrusad.com/integration/reference/retrieve-a-list-of-customers.md) - [Retrieve a customer](https://developers.citrusad.com/integration/reference/retrieve-a-customer.md) - [Manage customer-segment linkage](https://developers.citrusad.com/integration/reference/manage-customers-and-segments.md) - [filterMapping](https://developers.citrusad.com/integration/reference/filtermapping.md) - [create filter mapping](https://developers.citrusad.com/integration/reference/createfiltermapping-1.md) - [get list of filter mappings](https://developers.citrusad.com/integration/reference/listfiltermappings-1.md) - [update a filter mapping](https://developers.citrusad.com/integration/reference/updatefiltermapping-1.md) - [get a filter mapping](https://developers.citrusad.com/integration/reference/getfiltermapping-1.md) - [delete a filter mapping](https://developers.citrusad.com/integration/reference/deletefiltermapping-1.md) - [Lists all cross sell categories (based on params provided)](https://developers.citrusad.com/integration/reference/listcrosssellcategories.md) - [Create cross sell category](https://developers.citrusad.com/integration/reference/createcrosssellcategory.md) - [Get cross sell category for specified id](https://developers.citrusad.com/integration/reference/getcrosssellcategory.md) - [Delete cross sell category](https://developers.citrusad.com/integration/reference/deletecrosssellcategory.md) - [Overview](https://developers.citrusad.com/integration/reference/reporting-overview.md) - [Schema Definitions](https://developers.citrusad.com/integration/reference/reporting-schema-definitions.md) - [Reference](https://developers.citrusad.com/integration/reference/reporting-reference.md) - [Frequently Asked Questions](https://developers.citrusad.com/integration/reference/reporting-faq.md)