---
title: "Find an offer"
description: "Resolve one preorder offer from an exact id or a fuzzy name match. Returns the full offer (same shape as GET /preorders/offers/:id) on a unique match. If name matches more than one offer, returns {ambiguous: true, candid"
url: https://docs.stoqapp.com/v2-reference/preorders-offer-lookup/find-an-offer/
api: "API v2 reference"
method: GET
path: "/preorders/offer_lookup"
---

# Find an offer

`GET https://app.stoqapp.com/api/v2/external/preorders/offer_lookup`

Resolve one preorder offer from an exact id or a fuzzy name match. Returns the full offer (same shape as [`GET /preorders/offers/:id`](https://docs.stoqapp.com/v2-reference/preorders-offers/get-an-offer/)) on a unique match. If `name` matches more than one offer, returns {ambiguous: true, candidates: [...]} instead of guessing -- re-call with the chosen id. Omit both id and name for the most recently created offer.

**Note:** `name` is compared without regard to case against both the offer's `name` and its `internal_name`. An exact match wins over partial ones, so `name=Preorder` returns the offer called exactly that even when other offers contain the word. Otherwise any offer whose name contains the text, or is contained in it, matches. Deleted offers are never returned. An offer id passed as `name` also works. No match returns 404 `not_found`; an empty `name` returns 422 `validation_failed`.

## Query parameters

- `id` (string): Exact offer ID to return. Wins over name when both are sent.
- `name` (string): Text matched against each offer's name and internal name, exact first, then partial. Omit both id and name for the most recently created offer.

## Returns

- `id` (string): e.g. `string`
- `shopify_selling_plan_group_id` (string): e.g. `string`
- `name` (string): e.g. `string`
- `internal_name` (string): e.g. `string`
- `widget` (object)
  - `button` (object)
    - `button_text` (string): e.g. `string`
    - `custom_colors_enabled` (boolean): e.g. `true`
    - `text_color` (string): e.g. `string`
    - `background_color` (string): e.g. `string`
  - `disclaimer` (object)
    - `show_disclaimer` (boolean): e.g. `true`
    - `disclaimer_text` (string): e.g. `string`
    - `text_color` (string): e.g. `string`
    - `background_color` (string): e.g. `string`
    - `border_radius` (integer): e.g. `1`
  - `badge` (object)
    - `show_badge` (boolean): e.g. `true`
    - `badge_text` (string): e.g. `string`
    - `text_color` (string): e.g. `string`
    - `background_color` (string): e.g. `string`
- `inventory` (object)
  - `stock_condition` (string): e.g. `string`
  - `reserve` (string): e.g. `string`
- `products` (object)
  - `selection` (string): e.g. `string`
  - `shopify_collection_id` (null)
  - `tags` (array of anys)
  - `eligible_inventory_policy` (string): e.g. `string`
  - `excluded_shopify_variant_ids` (array of anys)
  - `exclusion_tag` (null)
  - `variant_count` (integer): e.g. `1`
- `shipping` (object)
  - `timeline` (object)
    - `scope` (string): e.g. `string`
    - `show_shipping_text` (boolean): e.g. `true`
    - `shipping_text` (string): e.g. `string`
    - `variant_shipping_text` (string): e.g. `string`
  - `delivery_timing` (string): e.g. `string`
  - `ships_at` (null)
  - `days_after_checkout` (null)
  - `fulfillment` (object)
    - `handling` (string): e.g. `string`
    - `hold_reason` (string): e.g. `string`
    - `separate_orders` (object)
      - `grouping` (string): e.g. `string`
      - `number_format` (string): e.g. `string`
      - `suffix` (string): e.g. `string`
      - `hold_fulfillments` (boolean): e.g. `true`
      - `tag` (string): e.g. `string`
      - `transaction_gateway` (string): e.g. `string`
      - `original_order_hold_tag` (null)
      - `original_order_split_tag` (null)
  - `on_hold` (object)
    - `release_schedule` (string): e.g. `string`
    - `release_at` (null)
    - `require_payment` (boolean): e.g. `true`
- `payments` (object)
  - `options_offered` (string): e.g. `string`
  - `default_option` (string): e.g. `string`
  - `full` (object)
    - `selling_plan_id` (null)
    - `checkout_charge` (object)
      - `charge_type` (string): e.g. `string`
      - `charge_amount` (integer): e.g. `1`
    - `remaining_balance` (object)
      - `charge_trigger` (string): e.g. `string`
      - `charge_exact_time` (null)
      - `days_after_checkout` (null)
    - `price_adjustment` (object)
      - `adjustment_type` (null)
      - `adjustment_amount` (null)
    - `option_title` (string): e.g. `string`
    - `option_description` (string): e.g. `string`
    - `discount_text` (string): e.g. `string`
  - `collection_schedule` (string): e.g. `string`
  - `show_payment_widget` (boolean): e.g. `true`
  - `show_discounted_price` (null)
  - `currency_code` (null)
- `availability` (object)
  - `schedule` (string): e.g. `string`
  - `starts_at` (null)
  - `ends_at` (null)
  - `current_status` (string): e.g. `string`
  - `time_zone` (string): e.g. `string`
- `limits` (object)
  - `default_per_variant` (null)
  - `display_style` (string): e.g. `string`
  - `limit_text` (string): e.g. `string`
  - `show_icons` (boolean): e.g. `true`
  - `progress_bar` (object)
    - `progress_text` (string): e.g. `string`
    - `fill_color` (string): e.g. `string`
    - `background_color` (string): e.g. `string`
    - `box_background_color` (null)
    - `text_color` (string): e.g. `string`
    - `border_radius` (integer): e.g. `1`
    - `show_percentage` (boolean): e.g. `true`
  - `order_tags` (array of strings)
  - `terms` (object)
    - `require_acceptance` (boolean): e.g. `true`
    - `terms_text` (string): e.g. `string`
    - `disable_button_until_accepted` (boolean): e.g. `true`
    - `record_acceptance` (boolean): e.g. `true`
    - `acceptance_label` (string): e.g. `string`
  - `cart` (object)
    - `allowed_items` (string): e.g. `string`
    - `error_message` (string): e.g. `string`
  - `order_quantity` (object)
    - `minimum` (null)
    - `maximum` (null)
- `countdown` (object)
  - `show_when` (string): e.g. `string`
  - `date_source` (string): e.g. `string`
  - `starts_at` (null)
  - `ends_at` (null)
  - `starts_text` (null)
  - `ends_text` (null)
  - `labels` (object)
    - `days` (string): e.g. `string`
    - `hours` (string): e.g. `string`
    - `minutes` (string): e.g. `string`
    - `seconds` (string): e.g. `string`
  - `text_color` (string): e.g. `string`
  - `background_color` (string): e.g. `string`
  - `border_radius` (integer): e.g. `1`
  - `units` (array of strings)
  - `current` (object)
    - `visible_phase` (string): e.g. `string`
    - `target_at` (null)
    - `heading_text` (null)
    - `starts_at` (null)
    - `ends_at` (null)
- `markets` (object)
  - `scope` (string): e.g. `string`
  - `shopify_market_ids` (array of anys)
- `advanced` (object)
  - `checkout_method` (string): e.g. `string`
  - `cart_attributes` (object)
    - `show_payment` (boolean): e.g. `true`
    - `show_shipping` (boolean): e.g. `true`
    - `custom_text` (null)
- `integrations` (object)
  - `pos` (object)
    - `enable_pos` (boolean): e.g. `true`
    - `inventory_check` (string): e.g. `string`
  - `b2b` (object)
    - `enable_b2b` (boolean): e.g. `true`
- `batches` (object)
  - `release_strategy` (string): e.g. `string`
  - `advance_schedule` (string): e.g. `string`
  - `label_format` (string): e.g. `string`
  - `status_text` (object)
    - `past` (string): e.g. `string`
    - `live` (string): e.g. `string`
    - `upcoming` (string): e.g. `string`
  - `widget` (object)
    - `style` (string): e.g. `string`
    - `progress` (string): e.g. `string`
    - `show_other_ship_dates` (boolean): e.g. `true`
    - `show_names` (boolean): e.g. `true`
  - `items` (array of anys)
- `translations` (object)
- `line_item_revenue` (string): e.g. `string`
- `order_revenue` (string): e.g. `string`
- `created_at` (string): e.g. `2026-01-15T09:30:00Z`
- `updated_at` (string): e.g. `2026-01-15T09:30:00Z`
- `ambiguous` (boolean): e.g. `true`
- `query` (string): e.g. `string`
- `candidates` (array of objects)
  - `id` (string): e.g. `string`
  - `name` (string): e.g. `string`
  - `internal_name` (string): e.g. `string`
  - `current_status` (string): e.g. `string`
  - `line_item_revenue` (string): e.g. `string`
  - `order_revenue` (string): e.g. `string`
  - `created_at` (string): e.g. `2026-01-15T09:30:00Z`
  - `updated_at` (string): e.g. `2026-01-15T09:30:00Z`

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

## Examples

### Find an offer

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/offer_lookup" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Find an offer filtered by name

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/offer_lookup?name=Summer%20Sneaker%20Drop" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "id": "string",
  "shopify_selling_plan_group_id": "string",
  "name": "string",
  "internal_name": "string",
  "widget": {
    "button": {
      "button_text": "string",
      "custom_colors_enabled": true,
      "text_color": "string",
      "background_color": "string"
    },
    "disclaimer": {
      "show_disclaimer": true,
      "disclaimer_text": "string",
      "text_color": "string",
      "background_color": "string",
      "border_radius": 1
    },
    "badge": {
      "show_badge": true,
      "badge_text": "string",
      "text_color": "string",
      "background_color": "string"
    }
  },
  "inventory": {
    "stock_condition": "string",
    "reserve": "string"
  },
  "products": {
    "selection": "string",
    "shopify_collection_id": null,
    "tags": [
      null
    ],
    "eligible_inventory_policy": "string",
    "excluded_shopify_variant_ids": [
      null
    ],
    "exclusion_tag": null,
    "variant_count": 1
  },
  "shipping": {
    "timeline": {
      "scope": "string",
      "show_shipping_text": true,
      "shipping_text": "string",
      "variant_shipping_text": "string"
    },
    "delivery_timing": "string",
    "ships_at": null,
    "days_after_checkout": null,
    "fulfillment": {
      "handling": "string",
      "hold_reason": "string",
      "separate_orders": {
        "grouping": "string",
        "number_format": "string",
        "suffix": "string",
        "hold_fulfillments": true,
        "tag": "string",
        "transaction_gateway": "string",
        "original_order_hold_tag": null,
        "original_order_split_tag": null
      }
    },
    "on_hold": {
      "release_schedule": "string",
      "release_at": null,
      "require_payment": true
    }
  },
  "payments": {
    "options_offered": "string",
    "default_option": "string",
    "full": {
      "selling_plan_id": null,
      "checkout_charge": {
        "charge_type": "string",
        "charge_amount": 1
      },
      "remaining_balance": {
        "charge_trigger": "string",
        "charge_exact_time": null,
        "days_after_checkout": null
      },
      "price_adjustment": {
        "adjustment_type": null,
        "adjustment_amount": null
      },
      "option_title": "string",
      "option_description": "string",
      "discount_text": "string"
    },
    "collection_schedule": "string",
    "show_payment_widget": true,
    "show_discounted_price": null,
    "currency_code": null
  },
  "availability": {
    "schedule": "string",
    "starts_at": null,
    "ends_at": null,
    "current_status": "string",
    "time_zone": "string"
  },
  "limits": {
    "default_per_variant": null,
    "display_style": "string",
    "limit_text": "string",
    "show_icons": true,
    "progress_bar": {
      "progress_text": "string",
      "fill_color": "string",
      "background_color": "string",
      "box_background_color": null,
      "text_color": "string",
      "border_radius": 1,
      "show_percentage": true
    },
    "order_tags": [
      "string"
    ],
    "terms": {
      "require_acceptance": true,
      "terms_text": "string",
      "disable_button_until_accepted": true,
      "record_acceptance": true,
      "acceptance_label": "string"
    },
    "cart": {
      "allowed_items": "string",
      "error_message": "string"
    },
    "order_quantity": {
      "minimum": null,
      "maximum": null
    }
  },
  "countdown": {
    "show_when": "string",
    "date_source": "string",
    "starts_at": null,
    "ends_at": null,
    "starts_text": null,
    "ends_text": null,
    "labels": {
      "days": "string",
      "hours": "string",
      "minutes": "string",
      "seconds": "string"
    },
    "text_color": "string",
    "background_color": "string",
    "border_radius": 1,
    "units": [
      "string"
    ],
    "current": {
      "visible_phase": "string",
      "target_at": null,
      "heading_text": null,
      "starts_at": null,
      "ends_at": null
    }
  },
  "markets": {
    "scope": "string",
    "shopify_market_ids": [
      null
    ]
  },
  "advanced": {
    "checkout_method": "string",
    "cart_attributes": {
      "show_payment": true,
      "show_shipping": true,
      "custom_text": null
    }
  },
  "integrations": {
    "pos": {
      "enable_pos": true,
      "inventory_check": "string"
    },
    "b2b": {
      "enable_b2b": true
    }
  },
  "batches": {
    "release_strategy": "string",
    "advance_schedule": "string",
    "label_format": "string",
    "status_text": {
      "past": "string",
      "live": "string",
      "upcoming": "string"
    },
    "widget": {
      "style": "string",
      "progress": "string",
      "show_other_ship_dates": true,
      "show_names": true
    },
    "items": [
      null
    ]
  },
  "translations": {},
  "line_item_revenue": "string",
  "order_revenue": "string",
  "created_at": "2026-01-15T09:30:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "ambiguous": true,
  "query": "string",
  "candidates": [
    {
      "id": "string",
      "name": "string",
      "internal_name": "string",
      "current_status": "string",
      "line_item_revenue": "string",
      "order_revenue": "string",
      "created_at": "2026-01-15T09:30:00Z",
      "updated_at": "2026-01-15T09:30:00Z"
    }
  ]
}
```

## 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
    }
  ]
}
```

## 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
    }
  ]
}
```

