> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Product Collection Object

<div class="prose dark:prose-invert custom-html">
  <h2 id="product-collection-base">Product Collection Base</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            id

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Product collection ID.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            name

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Unique user-defined product collection name.</p>

          <p>
            <strong>Example:</strong>
            All Products
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            type

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Describes whether the product collection is dynamic (products come in and leave based on set criteria) or static (manually selected products).</p>

          <p>
            Available values:
            <code>STATIC</code>,
            <code>AUTO\_UPDATE</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            filter

            <br />

            <code>object</code>
          </p>
        </td>

        <td>
          <p>
            Defines a set of criteria and boundary conditions for an
            <code>AUTO\_UPDATE</code>
            product collection type.
          </p>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>junction</p>
                </td>

                <td>
                  See:
                  <a href="#junction">Junction</a>
                </td>
              </tr>

              <tr>
                <td>
                  <p>\[propertyName]</p>
                </td>

                <td>
                  <p>
                    Valid keys:
                    <code>id</code>,
                    <code>product\_id</code>,
                    <code>source\_id</code>,
                    <code>name</code>,
                    <code>price</code>,
                    <code>object</code>,
                    <code>attributes</code>,
                    <code>image\_url</code>,
                    <code>skus</code>,
                    <code>created\_at</code>,
                    <code>updated\_at</code>
                    and
                    <code>metadata.\*</code>
                  </p>

                  <a href="#field-conditions">Field Conditions</a>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            products

            <br />

            <code>array</code>
          </p>
        </td>

        <td>
          <p>
            Defines a set of products for a
            <code>STATIC</code>
            product collection type.
          </p>

          Array of:
          <h3>Product Collections Item Products Item</h3>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>
                    id

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>The product ID.</p>

                  <p>
                    <strong>Example:</strong>
                    prod\_0a41bcf807c5fcaaf6
                  </p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    product\_id

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Product ID for SKUs.</p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    object

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Denotes the type of the object represented by the ID.</p>

                  <p>
                    Available values:
                    <code>sku</code>,
                    <code>product</code>
                  </p>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            created\_at

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Timestamp representing the date and time when the product collection was created. The value is shown in the ISO 8601 format.</p>

          <p>
            <strong>Example:</strong>
            2021-12-09T12:51:29.898Z
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            object

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>The type of the object represented by JSON. This object stores information about the static product collection.</p>

          <p>
            Available values:
            <code>products\_collection</code>
          </p>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="junction">Junction</h2>

  <p>
    Logical Operator Between Filters. Filter by conditions set on the
    <code>junction</code>
    parameter indicating how the
    <code>conditions</code>
    should be accounted for in the query. An
    <code>AND</code>
    is an all-inclusive logical operator, meaning the
    <code>AND</code>
    operator displays a record if
    <strong>ALL</strong>
    the conditions separated by AND are TRUE, while an
    <code>OR</code>
    operator displays a record if
    <strong>ANY</strong>
    of the conditions separated by OR is TRUE.
  </p>

  <p>
    Available values:
    <code>and</code>,
    <code>or</code>
  </p>

  <h2 id="field-conditions">Field Conditions</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>conditions</p>
        </td>

        <td>
          <p>Data filters used to narrow down the data records to be returned in the result.</p>
          <a href="#filters-condition">Filters Condition</a>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="filters-condition">Filters Condition</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>\$in</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$not\_in</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$is</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$is\_days\_ago</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$is\_days\_in\_future</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$is\_not</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$has\_value</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$is\_unknown</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$contains</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$not\_contain</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$starts\_with</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$ends\_with</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$more\_than</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$less\_than</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$more\_than\_ago</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$less\_than\_ago</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$more\_than\_future</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$less\_than\_future</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$more\_than\_equal</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$less\_than\_equal</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$after</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$before</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$count</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$count\_less</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>

      <tr>
        <td>
          <p>\$count\_more</p>
        </td>

        <td>
          See:
          <a href="#any">Any</a>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="any">Any</h2>
  <p>Array any of:</p>

  <ol>
    <li>string</li>
    <li>string</li>
    <li>string</li>
    <li>number</li>
    <li>object</li>
  </ol>
</div>