---
title: "Get offer products"
description: "Read the products configuration for a preorder offer: the selection rule, its collection or tags, exclusions, the eligible inventory policy, the attached variant count and the collection's name."
url: https://docs.stoqapp.com/v2-reference/preorders-offers/get-offer-products/
api: "API v2 reference"
method: GET
path: "/preorders/offers/{id}/products"
---

# Get offer products

`GET https://app.stoqapp.com/api/v2/external/preorders/offers/{id}/products`

Read the products configuration for a preorder offer: the selection rule, its collection or tags, exclusions, the eligible inventory policy, the attached variant count and the collection's name.

**Note:** `custom` is a hand-picked list, changed with [`POST /preorders/offers/:id/products/add_variants`](https://docs.stoqapp.com/v2-reference/preorders-offers/add-variants/) and .../remove_variants; `collection`, `tags` and `all` fill themselves from the rule. `eligible_inventory_policy` only applies to those rules: `continue_selling` has STOQ turn Continue selling on for out-of-stock variants, `all` sells only variants that already have it. `collection_name` is read live from Shopify and is null when the collection is gone or Shopify fails. List the variants with [`GET /preorders/offers/:id/products/variants`](https://docs.stoqapp.com/v2-reference/preorders-offers/list-an-offers-variants/).

## Path parameters

- `id` (string, required): The offer's ID, from [`GET /preorders/offers`](https://docs.stoqapp.com/v2-reference/preorders-offers/list-offers/).

## Returns

- `selection` (string): Rule that puts variants on the offer: all (every variant in the shop, minus exclusions), collection, custom (variants added by hand) or tags. One of: `all`, `collection`, `custom`, `tags`.
- `shopify_collection_id` (string, nullable): Collection driving the variant list, as gid://shopify/Collection/&lt;id&gt;. Null unless selection is collection.
- `tags` (array of anys): Product tags; products carrying any of them are on the offer. Empty unless selection is tags.
- `eligible_inventory_policy` (string): continue_selling: STOQ turns Continue selling on for the rule's out-of-stock variants so all take preorders. all: only variants that already have Continue selling on take preorders. One of: `continue_selling`, `all`.
- `excluded_shopify_variant_ids` (array of strings): Variants held back from the rule, as gid://shopify/ProductVariant/&lt;id&gt;.
- `exclusion_tag` (null): Variants of products carrying this tag are held back. Null when none is set.
- `variant_count` (integer): Number of variants on the offer, leaving out variants deleted from the catalog.
- `collection_name` (string, nullable): Title of the collection when selection is collection. Null otherwise, or when Shopify does not return it.

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: example response shown.

```json
{
  "selection": "collection",
  "shopify_collection_id": "gid://shopify/Collection/412345678901",
  "tags": [],
  "eligible_inventory_policy": "continue_selling",
  "excluded_shopify_variant_ids": [
    "gid://shopify/ProductVariant/44712349909269"
  ],
  "exclusion_tag": null,
  "variant_count": 24,
  "collection_name": "Summer Sneakers"
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

