Skip to main content
GET
Returns a paginated list of offers from visible sellers whose products are published.
Customer authentication is optional. When a customer token is provided, the customer’s group memberships enter the pricing context used for calculated_price. Prices are computed per offer (each offer scopes the variant’s price set by an offer_id rule) only when calculated_price is 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: either configured on the publishable key or passed as sales_channel_id.

Query parameters

number
default:"50"
Maximum number of offers to return.
number
default:"0"
Number of offers to skip before collecting results.
string
Field to sort by, prefixed with - for descending order.
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.
string
Free-text search term applied to offer fields.
string | string[]
Filter by one or more offer IDs.
string | string[]
Filter by one or more product IDs.
string | string[]
Filter by one or more variant IDs.
string | string[]
Filter by one or more seller IDs.
string | string[]
Filter by one or more offer SKUs.
object
Filter by creation date using operators like $gt, $gte, $lt, $lte.
object
Filter by update date using operators like $gt, $gte, $lt, $lte.

Response

object[]
number
Total number of matching offers.
number
Number of skipped offers.
number
Maximum number of returned offers.