Get offer products
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/productsCosts 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
idstringRequiredThe offer's ID, from
GET /preorders/offers.
Returns
selectionstringRule that puts variants on the offer: all (every variant in the shop, minus exclusions), collection, custom (variants added by hand) or tags.
One ofallcollectioncustomtagsshopify_collection_idstring, nullableCollection driving the variant list, as gid://shopify/Collection/<id>. Null unless selection is collection.
tagsarray of anysProduct tags; products carrying any of them are on the offer. Empty unless selection is tags.
eligible_inventory_policystringcontinue_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 ofcontinue_sellingallexcluded_shopify_variant_idsarray of stringsVariants held back from the rule, as gid://shopify/ProductVariant/<id>.
exclusion_tagnullVariants of products carrying this tag are held back. Null when none is set.
variant_countintegerNumber of variants on the offer, leaving out variants deleted from the catalog.
collection_namestring, nullableTitle of the collection when selection is collection. Null otherwise, or when Shopify does not return it.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe request failed validation.
shopify_errorA Shopify call the operation needs failed after the operation had started.
upstream_unavailableA 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.
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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"
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}