Skip to content

Reset a variant's metafields

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

POST/preorders/product_variants/{shopify_variant_id}/reset_metafields

Costs 2 rate-limit points · Rate limits

Reset a variant's preorder counts (its preorder orders stop counting, the recounted count of its live offer is republished, and the count is cleared when it has none) and rebuild its shipping text and limit metafields from its live offers. Keeps the variant attached to its offers.

Doesn't detach. Shipping text and limit are cleared only where no live offer sets them.

Also searched asclear preorder metafieldswipe variant preorder datareset variant metafieldsclear variant metafields

Path parameters

  • shopify_variant_idstringRequired

    The variant, as gid://shopify/ProductVariant/<id> or the numeric ID.

Headers

  • Idempotency-Keystring

    A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Returns

  • variantobject
    Show 9 child attributesHide child attributes
    • idstring
      Example: b81d4e2a-6c3f-4a95-9e07-1f5c8d2b6a34
    • shopify_variant_idstring
      Example: gid://shopify/ProductVariant/47284734455864
    • productobject
      Show 3 child attributesHide child attributes
      • shopify_product_idstring
        Example: gid://shopify/Product/8784906035384
      • titlestring
        Example: Classic Sneaker
      • statusnull
        Example: active
    • variant_titlestring
      Example: Red / Large
    • skustring
      Example: CS-RED-L
    • image_urlstring
      Example: https://cdn.shopify.com/s/files/1/0712/3456/7890/files/cl…
    • offersarray of objects
      Show 6 child attributesHide child attributes
      • idstring
        Example: 73a74948-2b57-4cc3-971f-2b441828c977
      • shipping_textstring
        Example: Ships in early August
      • max_countinteger
        Example: 100
      • quantity_limitinteger
        Example: 100
      • preorder_countinteger
        Example: 12
      • quantity_limit_reachedboolean
        Example: false
    • preorder_units_soldinteger
      Example: 31
    • line_item_revenuestring
      Example: 3410.00
  • offersarray of objects
    Show 8 child attributesHide child attributes
    • idstring
      Example: 73a74948-2b57-4cc3-971f-2b441828c977
    • internal_namestring
      Example: summer-2026
    • current_statusstring
      Example: live
    • inventoryobject
      Show 1 child attributeHide child attributes
      • stock_conditionstring
        Example: out_of_stock
    • marketsobject
      Show 1 child attributeHide child attributes
      • scopestring
        Example: all
    • shippingobject
      Show 1 child attributeHide child attributes
      • timelineobject
        Show 1 child attributeHide child attributes
        • scopestring
          Example: per_variant
    • widgetobject
      Show 1 child attributeHide child attributes
      • disclaimerobject
        Show 1 child attributeHide child attributes
        • disclaimer_textstring
          Example: Ships in August. You're charged today.
    • paymentsobject
      Show 1 child attributeHide child attributes
      • options_offeredstring
        Example: full

Errors

404
not_found

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

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

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.

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.

POST/preorders/product_variants/{shopify_variant_id}/reset_metafields
curl -X POST "https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/reset_metafields" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "variant": {
    "id": "b81d4e2a-6c3f-4a95-9e07-1f5c8d2b6a34",
    "shopify_variant_id": "gid://shopify/ProductVariant/47284734455864",
    "product": {
      "shopify_product_id": "gid://shopify/Product/8784906035384",
      "title": "Classic Sneaker",
      "status": "active"
    },
    "variant_title": "Red / Large",
    "sku": "CS-RED-L",
    "image_url": "https://cdn.shopify.com/s/files/1/0712/3456/7890/files/classic-sneaker-red.jpg",
    "offers": [
      {
        "id": "73a74948-2b57-4cc3-971f-2b441828c977",
        "shipping_text": "Ships in early August",
        "max_count": 100,
        "quantity_limit": 100,
        "preorder_count": 12,
        "quantity_limit_reached": false
      }
    ],
    "preorder_units_sold": 31,
    "line_item_revenue": "3410.00"
  },
  "offers": [
    {
      "id": "73a74948-2b57-4cc3-971f-2b441828c977",
      "internal_name": "summer-2026",
      "current_status": "live",
      "inventory": {
        "stock_condition": "out_of_stock"
      },
      "markets": {
        "scope": "all"
      },
      "shipping": {
        "timeline": {
          "scope": "per_variant"
        }
      },
      "widget": {
        "disclaimer": {
          "disclaimer_text": "Ships in August. You're charged today."
        }
      },
      "payments": {
        "options_offered": "full"
      }
    }
  ]
}