List Offers

GET

vendor

offers

curl 'http://localhost:9000/vendor/offers?variant_id=variant_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { offers, count } = await client.vendor.offers.query({
  variant_id: "variant_01HXYZ",
})

{
  "offers": [
    {
      "id": "offer_01HXYZ",
      "seller_id": "sel_01HXYZ",
      "variant_id": "variant_01HXYZ",
      "product_id": "prod_01HXYZ",
      "shipping_profile_id": "sp_01HXYZ",
      "sku": "ACME-SHIRT-M",
      "manage_inventory": true,
      "allow_backorder": false,
      "prices": [
        { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
      ],
      "inventory_items": [
        { "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

Returns the seller’s offers with variant, shipping profile, prices, and linked inventory items.

Query parameters

number

default:"50"

The maximum number of offers to return.

number

default:"0"

The number of offers to skip before returning results.

string

The field to sort by, e.g. created_at or -created_at for descending.

string

Comma-separated fields to include in the response. Prefix with +/- to add to or remove from the defaults.

string

Search term matched against offer fields.

string | string[]

Filter by offer ID(s).

string | string[]

Filter by product variant ID(s).

string | string[]

Filter by shipping profile ID(s).

string | string[]

Filter by seller SKU(s).

string | string[]

Filter by EAN(s).

string | string[]

Filter by UPC(s).

object

Filter by creation date using operators like $gt, $lt, $gte, $lte.

object

Filter by update date using operators like $gt, $lt, $gte, $lte.

Response

object[]

Show properties

string

The offer’s ID.

string

ID of the owning seller.

string

ID of the listed product variant.

string

ID of the parent product.

string

ID of the shipping profile used to fulfill the offer.

string

The seller’s SKU for this listing.

string

EAN barcode.

string

UPC barcode.

boolean

Whether stock is tracked for the offer.

boolean

Whether the offer can be purchased when it is out of stock.

object

The seller with id, name, and handle.

object

The variant with id, title, and sku.

object

The shipping profile with id and name.

object[]

Offer prices with id, amount, currency_code, min_quantity, max_quantity, and price_rules.

object[]

Linked inventory items with id, inventory_item_id, required_quantity, and sku.

number

Total number of matching offers.

number

Number of skipped offers.

number

Maximum number of returned offers.

curl 'http://localhost:9000/vendor/offers?variant_id=variant_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { offers, count } = await client.vendor.offers.query({
  variant_id: "variant_01HXYZ",
})

{
  "offers": [
    {
      "id": "offer_01HXYZ",
      "seller_id": "sel_01HXYZ",
      "variant_id": "variant_01HXYZ",
      "product_id": "prod_01HXYZ",
      "shipping_profile_id": "sp_01HXYZ",
      "sku": "ACME-SHIRT-M",
      "manage_inventory": true,
      "allow_backorder": false,
      "prices": [
        { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
      ],
      "inventory_items": [
        { "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

curl 'http://localhost:9000/vendor/offers?variant_id=variant_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { offers, count } = await client.vendor.offers.query({
  variant_id: "variant_01HXYZ",
})

{
  "offers": [
    {
      "id": "offer_01HXYZ",
      "seller_id": "sel_01HXYZ",
      "variant_id": "variant_01HXYZ",
      "product_id": "prod_01HXYZ",
      "shipping_profile_id": "sp_01HXYZ",
      "sku": "ACME-SHIRT-M",
      "manage_inventory": true,
      "allow_backorder": false,
      "prices": [
        { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
      ],
      "inventory_items": [
        { "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response