Ad events

Retail events

Models

Collect API

Connector Schema Management

Connector Management​

Connect API

Organisation

User

Permissions

Roles

Invitations

Media API

Catalogs

Products

Place

Override

Search API

Channels and Features of ALL Potential Integration Methods


Steps to Lowest Technical Lift Integration Method

Grant Zitcha access to Meta Product Catalogs

Grant Zitcha access to Google Tag Manager

Steps to provide Zitcha with META Catalogs Access

For Zitcha to create Facebook and Sponsored Product Ads on behalf of your business, your assets (Business Page, Ad Account, Instagram & Catalogs) must be shared with the Zitcha Facebook Business Manager and granted ‘Full Control’. *Please only share your main Business Page (usually at a national level).

To do this please follow the below steps:

Select Give a partner access to your assets.

On this screen, you can add partners to multiple assets.a. Choose a type of asset in the first column (Page, Ad Account, Instagram & Catalogs.)b. Select the assets you want to add your partner to in the second column.c. Assign the Admin role/Full control for your partner in the third column. Repeat these steps until you've chosen roles for all of the assets you want to assign.

Steps to provide Zitcha with Google Tag Manager Access

In order for Zitcha to generate and run ads on your website the below users will require standard access to your Google Tag Manager on your production site. Additionally, please grant the same Zitcha users ‘admin’ access to the GTM account linked to your staging environment:

please contact your solutions lead for these email addresses.

To grant access to the users, follow these steps:

In the Account column, select User Management.

Click Invite. Each invited user will receive an invitation to use the container.

Credit Lines: Single line of credit in the Facebook account is required.

Facebook Feeds are required for product related campaigns used in Meta.

Facebook Products that aren't split by brand may delay onboarding

Keep this guide at hand for a smooth integration. We're here to help every step of the way!

This Onsite guide ensures a smooth integration with all offsite assets, covering all essential steps from account setup to understanding integration challenges for a successful partnership.

Onsite Integration Guide

The Zitcha Search API is designed to enhance product search capabilities, offering a comprehensive way to search, filter, and sort through products based on various attributes. Below is a detailed overview of the product fields, the type of data stored in each, and how these fields interact with the search endpoint and query method.

The product data schema is designed to be flexible and versatile, allowing for a wide range of product types and attributes. The schema is based on Meta’s Data Catalog and includes the following fields:

: An int32 integer. This field can be used to rank products in search results by default, which is useful for prioritising products based on metrics like popularity or relevance.

: An int32 integer. This identifies the specific store or location associated with the product, allowing for filtering and sorting by store.

: A string. Acts as a unique identifier for each product, critical for search operations and unique product retrieval.

: A string. The name or title of the product, is searchable and can be used to display in search results.

: A string. Offers a detailed description of the product, useful for full-text search to match on product features or specifications.

: A string. Indicates the product's price, including currency symbols or additional text, making it versatile for various formats but may require parsing for numerical comparison.

: A string. URL pointing to the product's image, useful for visual representation in search results.

: A string. A direct URL to the product's page on the website, enabling direct access to the product's detailed page.

: A string. Shows whether the product is in stock, out of stock, or available for pre-order, essential for filtering based on availability.

: A string. Describes categories or types the product belongs to, allowing for categorization in search.

: A string with faceting enabled. Specifies the product's condition (new, used, refurbished, etc.), useful for filtering search results based on condition.

: A string with faceting enabled. The brand or manufacturer of the product, important for brand-specific searches.

: A string with faceting enabled. Describes the product's color(s), offering a way to filter search results by color.

: A string. The size of the product, which could vary in meaning (e.g., clothing size, bottle size), important for searches requiring size specificity.

: A float. Represents a bidding amount for sponsored products or ads, influencing their position in search results based on the bid amount.

The Zitcha Search API provides a specific endpoint for a retail domain for querying these product fields, allowing for a flexible and powerful search experience. The endpoint supports complex queries against one or more text fields (e.g., title, description) and allows filtering against numerical or facet fields (e.g., store_id, brand, condition). The results can be sorted and faceted to provide a highly customised search experience.

To search for products, the API could be queried with parameters like q for the search query, query_by to specify which fields to search against, filter_by to apply filters such as availability or store_id, and sort_by to define the order of the results, using _text_match

,bidto prioritise by text match quality and bid amount for sponsored products.

The search query method involves sending these parameters to the Zitcha Search API's search endpoint will look like this:

GET /api/products/search/?q=panadol&query_by=brand:_text_match

,bid&query_by=title,description,bid&page=1

The exact syntax for the query would depend on the implementation details of the Zitcha Search API and the programming language or framework being used to make the request.

This approach ensures that users can find products that closely match their search terms while also allowing brands to promote certain products through bidding.

Search Request Modification: Modify the search request logic to include calls to both the existing search API and the Zitcha Search API. This dual request approach ensures that both regular and sponsored products are retrieved during a search query.

 Implement logic to merge the results from the existing search API and the Zitcha Search API. Since the Zitcha Search API can return either just the promoted product IDs or the entire product details, ensure this logic can handle both response types seamlessly.

 Apply a sorting mechanism that incorporates the bid value for sponsored products. Use the sort_by parameter with the value "_text_match

,bid" to prioritize sponsored products in the search results based on their bid amounts.

Ensure the front-end logic can differentiate between regular and sponsored products, perhaps by highlighting sponsored products or marking them with a "Sponsored" label to maintain user transparency.

Pagination and Filters: Adjust the pagination and filter logic to accommodate the inclusion of sponsored products in the search results. This may involve recalculating the number of pages or adjusting filters to include or exclude sponsored products as needed.

Testing and Optimization: Conduct thorough testing to ensure that sponsored products are correctly integrated and displayed as expected. This includes testing for various search queries, filter combinations, and pagination scenarios. Optimisation may be required to ensure the performance of the search feature remains high.

When a search query is initiated, make simultaneous requests to the existing search API and the Zitcha Search API.

For the Zitcha Search API, construct the search request similar to the existing search but include the sort_by parameter with "_text_match

Parse the response from the Zitcha Search API to extract either the product IDs or the full product details of sponsored products.

If only product IDs are returned, retrieve the full product details from the existing product database or API as needed.

Merge the results from the existing search API and the Zitcha Search API. Ensure sponsored products are correctly interleaved within the search results based on the sort_by logic.

Sponsored products with higher bids should appear higher in the search results, followed by regular products sorted by relevance to the search query.

Update the UI to distinguish sponsored products from regular products. This could involve adding a special badge, changing the background color, or using any other visual indicator.

Ensure that the UI updates dynamically to reflect the correct mixture of sponsored and regular products based on the search query and filters applied.

Test the integrated search feature extensively to ensure that sponsored products are displayed correctly and do not disrupt the user experience.

Monitor the performance impact of adding sponsored products to the search results and optimize as necessary.

Monitoring and Analytics: Implement tracking for interactions with sponsored products to gauge their performance and adjust bidding strategies accordingly. The recommended approach on client-side is to implement Zitcha's Collect API to track user interactions with sponsored products.

Feedback Loop: Establish a feedback mechanism to refine the display and ranking of sponsored products based on user engagement and conversion rates.

By following these implementation notes, the engineering team can effectively integrate sponsored products into the pharmacy's website search feature, enhancing the visibility of sponsored products and the overall search experience for users.

Leveraging the Zitcha Search API for Onsite Retail Media Experiences.

Offsite Integration Guide

In the competitive world of retail media, standing out is essential for driving sales and brand awareness. One effective strategy is investing in sponsored products and always-on campaigns. This article will explore the benefits of these approaches and how they can enhance your marketing efforts on the Zitcha platform.

Sponsored Products: Maximising Visibility and Engagement

 Sponsored products are ads that appear alongside organic search results, often placed in prominent positions to capture the attention of potential customers. These ads are typically shown based on relevance to the user's search query and bidding strategy.

Sponsored products appear at the top of search results, ensuring that your products are seen by a larger audience.

They are prominently displayed, making it more likely for users to notice and click on them.

These ads target users actively searching for products similar to yours, leading to higher engagement rates.

By being relevant to user queries, sponsored products can drive more qualified traffic to your listings.

Increased visibility and engagement often translate into higher conversion rates.

Sponsored products can help move inventory faster and increase overall sales performance.

Consistent presence in search results helps build brand recognition.

Even if users do not click immediately, repeated exposure can influence future purchasing decisions.

Always-On Campaigns: Sustained Impact and Consistency

 Always-on campaigns are advertising strategies that run continuously over an extended period, rather than being limited to specific time frames or events. These campaigns ensure a constant presence in the market, maintaining ongoing visibility and engagement.

Always-on campaigns ensure that your brand is consistently visible to potential customers.

This constant presence helps maintain brand awareness and keeps your products top-of-mind.

By being always active, these campaigns can capture users at various stages of their buying journey.

Continuous exposure increases the likelihood of user interaction and eventual conversion.

Long-term campaigns provide more data, allowing for better analysis and optimization.

Advertisers can fine-tune bidding strategies based on performance insights.

Always-on campaigns can quickly adapt to market changes, trends, and seasonal variations.

This flexibility ensures that your advertising efforts remain relevant and effective throughout the year.

Strategic Advantages of Combining Sponsored Products and Always-On Campaigns

Combining these strategies ensures that your brand is visible in both high-traffic moments and consistently throughout the year.

Sponsored products can capture immediate intent, while always-on campaigns build long-term brand loyalty.

The synergy between sponsored products and always-on campaigns can maximise your return on investment.

Sponsored products drive immediate sales, while always-on campaigns nurture customer relationships and repeat purchases.

Maintaining a consistent presence helps you stay ahead of competitors who may only advertise sporadically.

Continuous engagement with your audience strengthens your market position and brand equity.

Investing in sponsored products and always-on campaigns offers a strategic advantage in the retail media landscape. Sponsored products maximise visibility and drive immediate sales, while always-on campaigns ensure sustained brand presence and engagement. Together, these approaches can enhance your marketing efforts, boost sales performance, and build long-term customer loyalty on the Zitcha platform.

Maximise sales and brand awareness on Zitcha with sponsored products and always-on campaigns, ensuring both immediate impact and sustained visibility in the retail media landscape.

The Strategic Benefits of Sponsored Products and Always-On Campaigns


Placing a Sponsored Product Ad or a Web Banner Ad using keyword search enables Suppliers to promote their products on the Retailer’s website when end users are searching for specific keywords. This functionality allows Suppliers to get in front of high-intent consumers when they're looking for a specific item on the Retailer's site.

When placing an order for a Sponsored Product or Web Banner ad, Suppliers will be able to bid specific keywords so that when users are searching for that keyword, their ad will appear.

Suppliers can add positive or negative keywords to their targeting, and determine whether search terms will be an exact or broad match.

When two Suppliers bid on the same keywords with different amounts, the ad will be served based on which Supplier placed the highest bid. If both Suppliers have the same budget with the same keywords, the Ad will be served on a first-come, first-served basis. Ads are sorted based on their approval time.

Discover how to place Sponsored Product and Web Banner ads using keyword search to target high-intent consumers on the Retailer’s website, including how bidding and keyword matching work.

Placing ads based on keyword search

Depending on the monetization type, there are two possible outcomes when two or more Suppliers are looking to book the same Space during the same time period:

 The ad will appear in a carousel format alternating through the ads with the ad first purchased appearing first. If you would like to set which ad appears first you can apply weighting to each ad. Learn more about weighting 

 The highest bidder will be prioritized and will be served as a priority.

Please note that if the slot is already occupied, a warning message will appear. This is a "soft" warning but won't prevent users from creating or approving the order.

When multiple Suppliers seek the same Space simultaneously, the ad will display in a carousel for FIXED monetization, or prioritize the highest bidder for BIDDING, with a warning shown if the slot is already occupied.

What happens if two Suppliers want to purchase the same Space during the same time period?

A 'Sponsored Product' is an ad format that allows Suppliers to showcase and promote specific products on the Retailer's Website. Whether it's on the search results page or in a set category, Sponsored Product ads allow Suppliers to reach high-intent consumers at the point of purchase. Sponsored Products can be placed within the product grid, banners, etc.


A 'Sponsored Product' is an ad format that allows Suppliers to showcase and promote specific products on the Retailer's Website.

What are Sponsored Products?

A set, or Product Set in Facebook, is a group of items in your catalog that you can feature in ads.

A Catalog is a container in which the products or item information is held.

You can find all of your Product Sets in 

For more info on best practices for managing Facebook Products Sets, please refer to 

Facebook's best practice guide for managing sets in a Catalog

A Product Set in Facebook is a group of catalog items that can be featured in ads, while a Catalog holds the product information. Access your Product Sets in Facebook Commerce Manager under the Catalog tab, and refer to Facebook's best practice guide for managing sets.

What's the difference between a Facebook Product Catalog and a Facebook Product Set?

 that allows retailers to push their product catalog information to Zitcha's product feed. This guide will walk you through the steps to use the endpoint to update and add products to the Zitcha product feed.

Before you start using the Product Update Endpoint, ensure you have the following:

An API key or authentication credentials to access the Zitcha API.

The necessary libraries or tools to make HTTP requests to the API (e.g., Python with the 

You'll find implementation examples in Bash, Python, Go, Node.js, Ruby, CSharp, PHP, Java and PowerShell at our Product Update API documentation. The examples use dummy data to demonstrate how to structure the request. You can use the examples as a reference to build your own request.

To update or add a product to the Zitcha product feed, you need to send a POST request to the Product Update Endpoint with the relevant product information.

 variable with the actual information of the product you want to update or add. Let's break down the payload fields:

: The name of the event and corresponding schema, which should be set to "product_update".

: The version of the event and corresponding schema, which should be set to "1-0-0".

: A list containing a dictionary representing the product identifier, including its type, value, and system (e.g., product ID, SKU, etc.).

: An optional field representing the parent product's identifier, useful for linking variants to their parent product.

: A list of image URLs associated with the product.

: A list of dictionaries, each representing an attribute of the product, including its name, type, and value.

: A list of lists, where each inner list represents the category path of the product.

Upon making a product update request, you will receive a response from the Zitcha API. The response will indicate whether the product update was successful or if there were any errors. It's essential to handle the response appropriately and handle any potential errors or retries if needed.

The response will likely contain an HTTP status code, such as 200 for a successful request, 400 for a bad request, or 500 for server errors. Additionally, the response may include a JSON payload with more detailed information about the request's outcome.

By following this guide, you should now understand how to use the Zitcha Product Update Endpoint to push your product catalog information to the Zitcha product feed. If you encounter any issues, refer to the API documentation or reach out to Zitcha's support for further assistance.

Zitcha provides a Product Update Endpoint that allows retailers to push their product catalog information to Zitcha's product feed. This guide will walk you through the steps to use the endpoint to update and add products to the Zitcha product feed.

Native Product Feed

Whether you're part of a new organization using Zitcha, or you're already collaborating, to connect your Facebook Catalog to our Zitcha Business Manager, please follow these steps:

Select the catalog you want to share from the catalog list.

Select “Assign Partner by Business ID”

In the field “Enter Partner ID”, input 

Make sure that the “Manage Catalogs” options are toggled on.

Once shared, please contact your Customer Success Manager, or reach out to our friendly support team via support@zitcha.com.

Follow these steps to connect your Facebook Catalog to Zitcha Business Manager by assigning the catalog with the provided Partner ID and contacting support if needed.

How to Share Facebook Catalogues with Zitcha?

Ensure your product catalog stands out on Facebook and Instagram by adhering to the following specifications for images and videos. This guide will help you optimise your content for Meta’s advertising platforms, ensuring your products are showcased effectively.

These specifications are consistent with 

image feed requirements documented by Meta

 Each product must have at least one image.

 Acceptable formats include JPEG or PNG, with a maximum size of 8 MB.

 Images must accurately represent the product being sold.

 Refrain from including offensive content, such as nudity or violence.

 There is a limit of 20 product images per product.

Provide an assortment of images to display different angles and details of the product.

The primary image should be clear, showcasing the entire product.

Ensure your products stand out in Dynamic Product Ads

Integration Guides

Articles

Onsite Integration Guide

Sponsored Product Integration Guide

Offsite Integration Guide

The Strategic Benefits of Sponsored Products and Always-On Campaigns

Placing ads based on keyword search

What happens if two Suppliers want to purchase the same Space during the same time period?

What are Sponsored Products?

What's the difference between a Facebook Product Catalog and a Facebook Product Set?

Native Product Feed

How to Share Facebook Catalogues with Zitcha?

Meta Product Feed: Image and Video Specifications Guide

Retail Media Glossary

integrations-card - Articles Page

Integration Guides

Articles

Onsite Integration Guide

Sponsored Product Integration Guide

Offsite Integration Guide

The Strategic Benefits of Sponsored Products and Always-On Campaigns

Placing ads based on keyword search

What happens if two Suppliers want to purchase the same Space during the same time period?

What are Sponsored Products?

What's the difference between a Facebook Product Catalog and a Facebook Product Set?

Native Product Feed

How to Share Facebook Catalogues with Zitcha?

Meta Product Feed: Image and Video Specifications Guide

Retail Media Glossary