Retailer Feed Documentation
Introduction
GunNabber supports two methods for retailers to share their product listings: Data Feed Imports in XML or JSON and a RESTful Retailer API. This documentation focuses on the XML and JSON Feed methods, which allows retailers to provide their product data in a structured format that we can automatically parse and update on our platform.
A data feed in XML or JSON is a structured data file that contains your product listings in a standardized format. It allows you (a retailer) to automatically share up-to-date inventory, pricing, and product details with the GunNabber platform. By using a data feed, you can ensure your listings stay current without manual updates, making it easy to manage large catalogs and keep customers informed about your latest offerings.
The data feed supports managing your product listings, including creating, updating, and deleting products based on scheduled parsing of a XML or JSON file that you host on your website.
Intended Use
The data feed is intended to provide GunNabber with accurate, up-to-date product information directly from a retailer’s inventory system. Retailers should use this feed to automate the sharing of product details such as price, availability, descriptions, etc. This ensures that customers always see current and reliable listings on the GunNabber platform, reducing manual data entry and improving the overall shopping experience. It is one of two supported integration methods:
- Data Feed Import – Retailers expose a publicly accessible XML or JSON file, which we periodically parse to update product listings.
- Retailer API – Retailers integrate directly with our platform via a RESTful API, enabling real-time, fine-grained control over product data.
Why Use the Data Feed?
A data feed is often the simpler choice for retailers who want an easy, low-maintenance way to keep their product listings up to date. Unlike API integration, which may require custom development and ongoing code changes, a data feed can typically be exported directly from your existing system and scheduled for regular updates. It's ideal for retailers with a stable or moderately changing catalog who want to automate updates without complex programming.
Depending on the e-commerce platform you use, generating an XML or JSON feed may be as simple as configuring a plugin or exporting a file from your inventory management system. This makes it accessible even for retailers with limited technical resources. You would need to consult with your e-commerce platform documentation or support team to set up the XML or JSON feed correctly.
Requirements to Use a Data Feed
To successfully provide an XML or JSON feed to GunNabber, your feed must be publicly accessible via a stable URL, structured in valid XML or JSON format, and include all required product details such as title, description, price, quantity, SKU, and image links. The feed should be updated regularly to ensure accurate inventory and pricing. For best results, follow GunNabber’s recommended data specifications to ensure compatibility and minimize errors during parsing.
To provide us with an data feed, you will need:
- An online store or e-commerce platform with URL-accessible product data.
- Product details such as URL, Name, Price, Quantity, MPN for each product listing. (view GunNabber Feed Format for more information)
- A paid retailer account.
- A person or technical team capable of generating and hosting a publicly accessible feed document that includes all of your product listings.
- Ability to:
- Host the data feed on a publicly accessible URL.
- Ensure the data feed is well-formed and adheres to our schema, or a schema from another data provider that we can parse.
- Update the feed regularly to reflect current inventory and pricing. We will parse the feed every 5-15 minutes to keep listings current. We ask that you generate the data feed as frequently as possible, ideally every 5 minutes, to ensure the most up-to-date information is available.
Testing Your Feed
You can use our Feed Validator to test your data feed. This tool checks for common issues and provides feedback to help you get your feed working smoothly. Simply enter the URL and format of your feed, and the validator will attempt to access and parse it, returning a success message or a list of errors if any are found.
Who Can Help You Set Up the data feed?
In general, you would want to consult with your e-commerce platform documentation or support team to set up the feed correctly. Many platforms have built-in features or plugins that can help you generate the required data format without needing extensive coding knowledge.
As plugins and tools for generating XML and JSON feeds are developed, we will update this documentation to include more information on how to set up the data feed for your specific platform.
Why Choose the Data Feed?
Data Feed vs Retailer API
| Feature | Data Feed Advantage | Retailer API Trade-Off |
|---|---|---|
| Setup Complexity | ✅ Easy to set up | ❌ Requires coding effort |
| Integration Needs | ✅ Low technical requirements | ❌ Developer resources needed |
| Update Frequency | ✅ Scheduled automation | ❌ Requires manual triggers or app logic |
| Maintenance | ✅ Minimal ongoing work | ❌ Needs version management and error handling |
| Feature | Data Feed Trade-Off | Retailer API Advantage |
|---|---|---|
| Real-Time Updates | ❌ No (scheduled) | ✅ Yes (instant) |
| Field-Level Control | ❌ Limited | ✅ Full |
| Requires Development Effort | ❌ Minimal | ✅ Yes |
If you prefer a “set it and forget it” solution, the data feed may suffice. If you want full control and real-time integration, the Retailer API is your best option.
If you have questions or need help getting started, please reach out to us - we're here to help make integration smooth and successful!