Skip to content

Get offer products

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/preorders/offers/{id}/products

Costs 1 rate-limit point · Rate limits

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.

custom is a hand-picked list, changed with POST /preorders/offers/:id/products/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.

Also searched asget productsshow linked productsview variants on offerview product sourcewhat's on this offer

Path parameters

Returns

  • selectionstring

    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 allcollectioncustomtags
  • shopify_collection_idstring, nullable

    Collection driving the variant list, as gid://shopify/Collection/<id>. Null unless selection is collection.

  • tagsarray of anys

    Product tags; products carrying any of them are on the offer. Empty unless selection is tags.

  • eligible_inventory_policystring

    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_sellingall
  • excluded_shopify_variant_idsarray of strings

    Variants held back from the rule, as gid://shopify/ProductVariant/<id>.

  • exclusion_tagnull

    Variants of products carrying this tag are held back. Null when none is set.

  • variant_countinteger

    Number of variants on the offer, leaving out variants deleted from the catalog.

  • collection_namestring, nullable

    Title of the collection when selection is collection. Null otherwise, or when Shopify does not return it.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The request failed validation.

502
shopify_error

A Shopify call the operation needs failed after the operation had started.

503
upstream_unavailable

A service the answer depends on did not respond in time.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/preorders/offers/{id}/products
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "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"
}