List Offers

GET

admin

offers

curl 'http://localhost:9000/admin/offers?seller_id=sel_01HXYZ&limit=20' \
  -H 'Authorization: Bearer <token>'

const { offers, count } = await client.admin.offers.query({
  seller_id: "sel_01HXYZ",
  limit: 20,
})

{
  "offers": [
    {
      "id": "offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
      "seller_id": "sel_01HXYZ",
      "variant_id": "variant_01HXYZ",
      "product_id": "prod_01HXYZ",
      "shipping_profile_id": "sp_01HXYZ",
      "sku": "SHIRT-M-BLUE",
      "ean": null,
      "upc": null,
      "created_by": "user_01HXYZ",
      "variant_count": 3,
      "metadata": null,
      "seller": { "id": "sel_01HXYZ", "name": "Acme Store", "handle": "acme-store" },
      "product_variant": { "id": "variant_01HXYZ", "title": "M / Blue", "sku": "SHIRT-M-BLUE" },
      "shipping_profile": { "id": "sp_01HXYZ", "name": "Default" },
      "prices": [
        { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd", "min_quantity": null, "max_quantity": null }
      ],
      "inventory_items": [
        { "id": "iitem_01HXYZ", "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1, "sku": "SHIRT-M-BLUE" }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns offers with their seller, variant, shipping profile, prices, and inventory items.

Query parameters

number

default:"50"

Maximum number of records to return.

number

default:"0"

Number of records to skip.

string

Field to sort by, prefix with - for descending order.

string

Comma-separated fields to include in the response.

string

Search term matched against offers.

string | string[]

Filter by offer ID(s).

string | string[]

Filter by seller ID(s).

string | string[]

Filter by product variant ID(s).

string | string[]

Filter by shipping profile ID(s).

string | string[]

Filter by SKU(s).

string | string[]

Filter by EAN(s).

string | string[]

Filter by UPC(s).

boolean

Group results by seller.

string | string[]

Filter by the offered product’s status.

string | string[]

Filter by product category ID(s).

string | string[]

Filter by product collection ID(s).

string | string[]

Filter by product type ID(s).

string | string[]

Filter by product tag ID(s).

object

Filter by creation date using operators like $gte and $lte.

object

Filter by update date using operators like $gte and $lte.

Response

object[]

Show properties

string

The offer’s ID.

string

ID of the seller who owns the offer.

string

ID of the offered product variant.

string

ID of the offered product.

string

ID of the offer’s shipping profile.

string

The offer’s SKU.

string | null

The offer’s EAN.

string | null

The offer’s UPC.

string

ID of the actor who created the offer.

number

Number of variants on the offered product.

object | null

Custom key-value data.

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, each with id, amount, currency_code, min_quantity, max_quantity, and price_rules.

object[]

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

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching offers.

number

Number of records skipped.

number

Maximum number of records returned.

curl 'http://localhost:9000/admin/offers?seller_id=sel_01HXYZ&limit=20' \
  -H 'Authorization: Bearer <token>'

const { offers, count } = await client.admin.offers.query({
  seller_id: "sel_01HXYZ",
  limit: 20,
})

{
  "offers": [
    {
      "id": "offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
      "seller_id": "sel_01HXYZ",
      "variant_id": "variant_01HXYZ",
      "product_id": "prod_01HXYZ",
      "shipping_profile_id": "sp_01HXYZ",
      "sku": "SHIRT-M-BLUE",
      "ean": null,
      "upc": null,
      "created_by": "user_01HXYZ",
      "variant_count": 3,
      "metadata": null,
      "seller": { "id": "sel_01HXYZ", "name": "Acme Store", "handle": "acme-store" },
      "product_variant": { "id": "variant_01HXYZ", "title": "M / Blue", "sku": "SHIRT-M-BLUE" },
      "shipping_profile": { "id": "sp_01HXYZ", "name": "Default" },
      "prices": [
        { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd", "min_quantity": null, "max_quantity": null }
      ],
      "inventory_items": [
        { "id": "iitem_01HXYZ", "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1, "sku": "SHIRT-M-BLUE" }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/admin/offers?seller_id=sel_01HXYZ&limit=20' \
  -H 'Authorization: Bearer <token>'

const { offers, count } = await client.admin.offers.query({
  seller_id: "sel_01HXYZ",
  limit: 20,
})

{
  "offers": [
    {
      "id": "offer_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
      "seller_id": "sel_01HXYZ",
      "variant_id": "variant_01HXYZ",
      "product_id": "prod_01HXYZ",
      "shipping_profile_id": "sp_01HXYZ",
      "sku": "SHIRT-M-BLUE",
      "ean": null,
      "upc": null,
      "created_by": "user_01HXYZ",
      "variant_count": 3,
      "metadata": null,
      "seller": { "id": "sel_01HXYZ", "name": "Acme Store", "handle": "acme-store" },
      "product_variant": { "id": "variant_01HXYZ", "title": "M / Blue", "sku": "SHIRT-M-BLUE" },
      "shipping_profile": { "id": "sp_01HXYZ", "name": "Default" },
      "prices": [
        { "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd", "min_quantity": null, "max_quantity": null }
      ],
      "inventory_items": [
        { "id": "iitem_01HXYZ", "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1, "sku": "SHIRT-M-BLUE" }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response