storefront

Resolve a single variant by id (price, availability, options, product) — for cart re-validation

get/api/v1/storefront/variants/{id}

Request

  • Base URL: https://api.foundryims.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.foundryims.com/api/v1/storefront/variants/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

idstring required
skustring required
namestring required
pricenumber required

What the buyer pays now — the sale price while a sale is on.

regularPricenumber required

The regular price; equals price when not on sale.

onSaleboolean required

True while a sale window is open on this listing.

saleEndsAtstring nullable required

ISO timestamp the sale ends, when one is set.

compareAtPricenumber nullable required

"Was"/MSRP price. While on sale this is the regular price.

mapnumber nullable required

Minimum advertised price.

upcstring nullable required
gtinstring nullable required
mpnstring nullable required
weightnumber nullable required
inStockboolean required
availableQuantitynumber required
currencystring required

Example response

{
  "price": 19.99,
  "regularPrice": 24.99,
  "compareAtPrice": 24.99,
  "availableQuantity": 14,
  "optionValues": [
    {
      "name": "Color",
      "value": "Red"
    }
  ],
  "images": [
    {
      "url": "https://cdn.example.com/img/abc.jpg"
    }
  ],
  "customFields": [
    {
      "key": "cooling_capacity",
      "label": "Cooling Capacity",
      "unit": "BTU/h",
      "type": "number",
      "group": "Performance",
      "displayOrder": 10
    }
  ],
  "currency": "USD"
}

Changes

No recorded changes to this operation across all 1 revision of this API.