Retrieve Offer

GET

store

offers

{id}

curl 'http://localhost:9000/store/offers/offer_01JB2K6G5H?region_id=reg_01JB2K4S1T&fields=%2Bcalculated_price' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { offer } = await client.store.offers.$id.query({
  $id: "offer_01JB2K6G5H",
  region_id: "reg_01JB2K4S1T",
  fields: "+calculated_price",
})

{
  "offer": {
    "id": "offer_01JB2K6G5H",
    "seller_id": "sel_01JB2K8A1B",
    "variant_id": "variant_01JB2K6E4F",
    "product_id": "prod_01JB2K5M8N",
    "shipping_profile_id": "sp_01JB2K9C2D",
    "sku": "NT-LINEN-M",
    "ean": null,
    "upc": null,
    "seller": { "id": "sel_01JB2K8A1B", "name": "Nordic Textiles", "handle": "nordic-textiles" },
    "product_variant": { "id": "variant_01JB2K6E4F", "title": "M", "sku": null, "price_set": { "id": "pset_01JB2K9E3F" } },
    "shipping_profile": { "id": "sp_01JB2K9C2D", "name": "Default" },
    "prices": [
      { "id": "price_01JB2K9G4H", "amount": 4500, "currency_code": "eur", "min_quantity": null, "max_quantity": null }
    ],
    "inventory_item_link": [],
    "calculated_price": {
      "calculated_amount": 4500,
      "original_amount": 4500,
      "currency_code": "eur"
    },
    "metadata": null,
    "created_at": "2026-05-01T10:00:00.000Z",
    "updated_at": "2026-05-01T10:00:00.000Z"
  }
}

Returns a single offer; offers from hidden sellers or on unpublished products return a 404.

Customer authentication is optional. calculated_price is computed per offer only when requested in fields and a pricing context (region_id, country_code, or cart_id) resolves; requesting inventory_quantity or in_stock requires a single sales channel on the publishable key or via sales_channel_id.

Path parameters

string

required

The offer’s ID.

Query parameters

string

Comma-separated fields and relations to include; add calculated_price, inventory_quantity, or in_stock to receive the computed fields.

string

Region used to build the pricing context for calculated_price.

string

Country used for the tax portion of the pricing context.

string

Province used for the tax portion of the pricing context.

string

Cart whose region and customer resolve the pricing context.

Response

object

Show properties

string

The offer’s ID.

string

ID of the selling seller.

string

ID of the offered product variant.

string

ID of the offered product.

string | null

ID of the offer’s shipping profile.

string | null

The offer’s SKU.

string | null

The offer’s EAN.

string | null

The offer’s UPC.

object

The seller’s id, name, and handle.

object

The variant’s id, title, sku, and price_set.

object | null

The shipping profile’s id and name.

object[]

Raw offer prices with amount, currency_code, min_quantity, and max_quantity.

object[]

Inventory items backing the offer, with location stock levels.

object | null

Per-offer calculated price with tax-adjusted amounts when a tax context resolves; only present when requested.

number

Available quantity in the sales channel’s stock locations; only present when requested.

boolean

Whether the offer has available inventory; only present when requested.

object | null

Custom key-value data.

string

Creation timestamp.

string

Last update timestamp.

curl 'http://localhost:9000/store/offers/offer_01JB2K6G5H?region_id=reg_01JB2K4S1T&fields=%2Bcalculated_price' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { offer } = await client.store.offers.$id.query({
  $id: "offer_01JB2K6G5H",
  region_id: "reg_01JB2K4S1T",
  fields: "+calculated_price",
})

{
  "offer": {
    "id": "offer_01JB2K6G5H",
    "seller_id": "sel_01JB2K8A1B",
    "variant_id": "variant_01JB2K6E4F",
    "product_id": "prod_01JB2K5M8N",
    "shipping_profile_id": "sp_01JB2K9C2D",
    "sku": "NT-LINEN-M",
    "ean": null,
    "upc": null,
    "seller": { "id": "sel_01JB2K8A1B", "name": "Nordic Textiles", "handle": "nordic-textiles" },
    "product_variant": { "id": "variant_01JB2K6E4F", "title": "M", "sku": null, "price_set": { "id": "pset_01JB2K9E3F" } },
    "shipping_profile": { "id": "sp_01JB2K9C2D", "name": "Default" },
    "prices": [
      { "id": "price_01JB2K9G4H", "amount": 4500, "currency_code": "eur", "min_quantity": null, "max_quantity": null }
    ],
    "inventory_item_link": [],
    "calculated_price": {
      "calculated_amount": 4500,
      "original_amount": 4500,
      "currency_code": "eur"
    },
    "metadata": null,
    "created_at": "2026-05-01T10:00:00.000Z",
    "updated_at": "2026-05-01T10:00:00.000Z"
  }
}

curl 'http://localhost:9000/store/offers/offer_01JB2K6G5H?region_id=reg_01JB2K4S1T&fields=%2Bcalculated_price' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { offer } = await client.store.offers.$id.query({
  $id: "offer_01JB2K6G5H",
  region_id: "reg_01JB2K4S1T",
  fields: "+calculated_price",
})

{
  "offer": {
    "id": "offer_01JB2K6G5H",
    "seller_id": "sel_01JB2K8A1B",
    "variant_id": "variant_01JB2K6E4F",
    "product_id": "prod_01JB2K5M8N",
    "shipping_profile_id": "sp_01JB2K9C2D",
    "sku": "NT-LINEN-M",
    "ean": null,
    "upc": null,
    "seller": { "id": "sel_01JB2K8A1B", "name": "Nordic Textiles", "handle": "nordic-textiles" },
    "product_variant": { "id": "variant_01JB2K6E4F", "title": "M", "sku": null, "price_set": { "id": "pset_01JB2K9E3F" } },
    "shipping_profile": { "id": "sp_01JB2K9C2D", "name": "Default" },
    "prices": [
      { "id": "price_01JB2K9G4H", "amount": 4500, "currency_code": "eur", "min_quantity": null, "max_quantity": null }
    ],
    "inventory_item_link": [],
    "calculated_price": {
      "calculated_amount": 4500,
      "original_amount": 4500,
      "currency_code": "eur"
    },
    "metadata": null,
    "created_at": "2026-05-01T10:00:00.000Z",
    "updated_at": "2026-05-01T10:00:00.000Z"
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Query parameters

Response

​Path parameters

​Query parameters

​Response

Path parameters

Query parameters

Response