List Offers - MercurJS Documentation

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

{
  "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
}

GET

admin

offers

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

{
  "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

limit

number

default:"50"

Maximum number of records to return.

offset

number

default:"0"

Number of records to skip.

order

string

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

fields

string

Comma-separated fields to include in the response.

string

Search term matched against offers.

string | string[]

Filter by offer ID(s).

seller_id

string | string[]

Filter by seller ID(s).

variant_id

string | string[]

Filter by product variant ID(s).

shipping_profile_id

string | string[]

Filter by shipping profile ID(s).

sku

string | string[]

Filter by SKU(s).

ean

string | string[]

Filter by EAN(s).

upc

string | string[]

Filter by UPC(s).

group_by_seller

boolean

Group results by seller.

status

string | string[]

Filter by the offered product’s status.

category_id

string | string[]

Filter by product category ID(s).

collection_id

string | string[]

Filter by product collection ID(s).

type_id

string | string[]

Filter by product type ID(s).

tag_id

string | string[]

Filter by product tag ID(s).

created_at

object

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

updated_at

object

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

Response

offers

object[]

Show properties

string

The offer’s ID.

seller_id

string

ID of the seller who owns the offer.

variant_id

string

ID of the offered product variant.

product_id

string

ID of the offered product.

shipping_profile_id

string

ID of the offer’s shipping profile.

sku

string

The offer’s SKU.

ean

string | null

The offer’s EAN.

upc

string | null

The offer’s UPC.

created_by

string

ID of the actor who created the offer.

variant_count

number

Number of variants on the offered product.

metadata

object | null

Custom key-value data.

seller

object

The seller, with id, name, and handle.

product_variant

object

The variant, with id, title, and sku.

shipping_profile

object

The shipping profile, with id and name.

prices

object[]

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

inventory_items

object[]

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

created_at

string

Creation timestamp.

updated_at

string

Last update timestamp.

count

number

Total number of matching offers.

offset

number

Number of records skipped.

limit

number

Maximum number of records returned.

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

{
  "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
}

Retrieve Payout

Retrieve Offer

​Query parameters

​Response

Query parameters

Response