> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.ordergroove.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ordergroove.com/_mcp/server.

# Product Feed

The Product Feed is a file sent to our platform via SFTP on a recurring basis to keep Ordergroove in sync with your product information. It should include all products, whether or not they're eligible for subscriptions. We check for new files every 30 minutes, so you can refresh as often as that.

If you're not sending the feed continuously throughout the day, we recommend running it before order placement to avoid rejections from out-of-stock items.

***

## Requirements

The product feed should be created with the following format:

* Filename: `<MERCHANT_ID>.Products.xml`
* Drop site location: `<SFTP_SITE>`

#### Note

Any applicable field containing special characters (e.g. &, trademark symbols, accents, etc.) must be wrapped in CDATA. Best practice is to always wrap product names and category names in CDATA at a minimum.

Fields labeled "Optional" should be excluded from the file if they do not contain a specific value, as we will attempt to validate them if they are included. Example: if not setting an `in_stock` boolean value, please remove `<in_stock></in_stock>` tagging entirely rather than adding empty tags or using self-closing XML tags (e.g. `<in_stock/>`).

***

## Example

```xml
<products>
...
<product>
  <name><![CDATA[Product XYZ]]></name>
  <product_id>AB4483902</product_id>
  <sku>45987234980</sku>
  <groups> // These fields are optional
    <group type="sku_swap"><![CDATA[Product Group A]]></group>
    <group type="incentive"><![CDATA[Incentive Group A]]></group>
  </groups>
  <price>19.99</price>
  <details_url>http://www.merchanturl.com/details/product.com</details_url>
  <image_url>https://www.merchanturl.com/images/product.jpg</image_url>
  <autoship_eligible>1</autoship_eligible> //Optional
  <in_stock>1</in_stock>
  <discontinued>0</discontinued> //Optional
  <extra_data> //Optional
    <field key="variant_name">Size X</field>
  </extra_data>
  <relationships> //These fields are optional
    <relationship>
      <name>discontinued_replacement</name>
        <related>
          <product_id>12</product_id>
        </related>
      </relationship>
    </relationships>
  <every>6</every> //Optional
  <every_period>2</every_period> //Optional
</product>
...
</products>
```

***

## Field Definitions

| Field                            | Description                                                                                                                                                                                                                                                                                                                                                                                                   | Data Type                     | Validation                                                                                                                                                                                         |
| :------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                           | The name of the product                                                                                                                                                                                                                                                                                                                                                                                       | String, up to 1024 characters | —                                                                                                                                                                                                  |
| `product_id`                     | The unique identifier of the product in your database                                                                                                                                                                                                                                                                                                                                                         | String, up to 64 characters   | —                                                                                                                                                                                                  |
| `sku`                            | The product's SKU                                                                                                                                                                                                                                                                                                                                                                                             | String, up to 64 characters   | —                                                                                                                                                                                                  |
| `groups` *(optional)*            | Used for SKU Swap and Incentives. All products assigned to the same group will be swappable between each other                                                                                                                                                                                                                                                                                                | String, up to 64 characters   | —                                                                                                                                                                                                  |
| `price`                          | The price of the product                                                                                                                                                                                                                                                                                                                                                                                      | Decimal up to 99999999.99     | Must be a decimal (not wrapped in quotation marks) with two digits after the decimal point. Should not be set to anything other than what the customer should be charged (e.g. do not set to \$0). |
| `details_url`                    | Fully qualified URL of the product details page                                                                                                                                                                                                                                                                                                                                                               | String, up to 400 characters  | —                                                                                                                                                                                                  |
| `image_url`                      | Fully qualified URL of the product's image file                                                                                                                                                                                                                                                                                                                                                               | String, up to 400 characters  | Must be HTTPS                                                                                                                                                                                      |
| `autoship_eligible` *(optional)* | A flag that marks the product as eligible for subscription. `0` = not eligible, `1` = eligible                                                                                                                                                                                                                                                                                                                | Tinyint(1)                    | Must be `1` or `0`, not wrapped in quotation marks                                                                                                                                                 |
| `in_stock`                       | A flag that marks the product as available in terms of inventory. `1` = In stock, `0` = Out of Stock. A product can become temporarily out of stock, which will temporarily stop orders from being placed with that product. No checkout flow offers will be served for out-of-stock products, but Instant Upsell offers will still be served as the product may come back in stock prior to order placement. | Tinyint(1)                    | Must be `1` or `0`, not wrapped in quotation marks                                                                                                                                                 |
| `discontinued` *(optional)*      | An optional flag that marks the product as no longer available. `0` = Not discontinued, `1` = Discontinued. When discontinued, all subscriptions with that product will be cancelled and the customer notified via email. A discontinued product must also be set to `autoship_eligible = 0` and `in_stock = 0`.                                                                                              | Tinyint(1)                    | Must be `1` or `0`, not wrapped in quotation marks. **NOTE:** To discontinue a product it must also be marked as Not Eligible and Out of Stock.                                                    |
| `extra_data` *(optional)*        | The value to be displayed in the SKU swap dropdown. Can be used to display a name other than the full product name                                                                                                                                                                                                                                                                                            | String, up to 1024 characters | —                                                                                                                                                                                                  |
| `relationships` *(optional)*     | Defines the related product ID for discontinued product replacement SKU swap. If relationship name = `discontinued_silent_replacement`, subscribers will NOT be notified of the swap. If relationship name = `discontinued_replacement`, an email will be sent to all subscribers informing them of the swap. The subscriber is only notified once the swap has been completed.                               | String, up to 64 characters   | —                                                                                                                                                                                                  |
| `every` *(optional)*             | The number of days, weeks, or months used to specify a product-specific default frequency                                                                                                                                                                                                                                                                                                                     | INT, up to 10 characters      | —                                                                                                                                                                                                  |
| `every_period` *(optional)*      | The frequency period for the product-specific default frequency. `1` = days, `2` = weeks, `3` = months, `4` = years                                                                                                                                                                                                                                                                                           | INT, up to 6 characters       | Example: `<every>4</every>` with `<every_period>2</every_period>` = every 4 weeks                                                                                                                  |
| `product_type`                   | The type of product. Default is `standard`. Options: `standard`, `static price bundle`, `dynamic price bundle`                                                                                                                                                                                                                                                                                                | String                        | Defaults to `standard` if not provided. **`product_type` cannot be changed after product creation.**                                                                                               |