Retrieve a product variant

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

GET/preorders/product_variants/{shopify_variant_id}

Costs 1 rate-limit point · Rate limits

Read one Shopify variant as the Preorders > Products tab lists it: the offers it is in, with its shipping text, limit and count on each.

:shopify_variant_id is a Shopify variant gid (a numeric id also works). The response is GET /preorders/products for this one variant: variant is a row and offers the offers it is in. variant also has the lifetime preorder_units_sold and line_item_revenue across every offer, without units on cancelled orders or units refunded before they shipped. max_count is the variant's own limit (what PATCH /preorders/products writes); quantity_limit is the read-only limit that applies, which on a batch offer is the batches' total.

Also searched asshow preorder context for variantlook up variant preordersvariant preorder stateget preorder variantshow variant in preorderswhich offers is this variant inwhat offers contain this variant

Path parameters

shopify_variant_idstringRequired

Errors

401

Missing or invalid X-Auth-Token.

404

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

422

The request failed validation.

429

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

Every error has the same shape: see Errors.

GET/preorders/product_variants/{shopify_variant_id}

curl "https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}", {
  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/product_variants/{shopify_variant_id}",
    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/product_variants/{shopify_variant_id}")
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)

Response

No body

{
  "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
    }
  ]
}