Skip to content

P11 - List offers for each given product

Request

Description

List offers for each given product

Call Frequency
Maximum usage: At each product page display
Read More
Pagination

This resource supports offset pagination (see documentation)

Sort fields

sort field can have the following values:

  • bestPrice (Default) - Sorts by product sku and then by total price, premium information, shop grade (asc by default)
  • bestEvaluation - Sorts by product sku and then by shop grade, total price, premium information (asc by default)

Localization

This resource supports locale parameter (see documentation)

Localized output fields will be highlighted with an icon:

Security
Operator-Bearer-Token or OAuth-2
Query
product_idsstring

List of product's skus separated with comma. Limited to 100 values.

One of the two is required product_ids or product_references.

product_referencesstring

List of the product's identifiers with type (structure: "product_references=<productIdType>|<productId>,<productIdType>|<productId>, ...").
Limited to 100 values. One of the two is required product_ids or product_references.

Example: /api/products/offers?product_references=EAN|3120201243238

offer_state_codesstring

List of offer state codes

premiumstring

If true, returns only offers of premium shops.
If false, returns only offers of shops that are not premium.

Default:"ALL"
Enum:"TRUE""FALSE""ALL"
all_offersboolean

If false returns only active offers. If true return all offers.

Default:false
channel_codesstring

List of the channel codes to filter with, using a comma (,) as a separator. If specified, only offers that can be sold on the specified channel(s) will be returned. If not, offers will be returned regardless of their channels.

all_channelsboolean

If false, filters the offers with the given channel_codes or the default channel if no channel_codes are given.
If true, does not filter the offers on channels and ignore the channel_codes.

Default:false
pricing_channel_codestring

Filter used to pick prices on a specific channel

pricing_customer_organization_idstring

For Customer Pricing users only. Customer identifier code the API will use to return all prices and applicable price for this organization. Ignored if value does not exist.

shop_idsstring

List of shop IDs separated with comma. Limited to 100 values.

Filter used to return only the offers of the listed shops.

shipping_zonesstring

List of shipping zones. Filter used to pick shipping prices on one or multiple shipping zones

all_shipping_zonesboolean

If false, filters the offers with the given shipping zones.
If true, selects all shop shipping zones and ignores the provided shipping_zones.

Default:false
modelsstring

A comma separated list of platform models to filter with.
Accepted values are MARKETPLACE, DROPSHIP, ONE_CREDITOR

curl -i -X GET \
  'https://your-instance.mirakl.net/api/products/offers?product_ids=string&product_references=string&offer_state_codes=string&premium=TRUE&all_offers=false&channel_codes=string&all_channels=false&pricing_channel_code=string&pricing_customer_organization_id=string&shop_ids=string&shipping_zones=string&all_shipping_zones=false&models=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
productsArray of objects

List of products information with their offers

Response
{ "products": [ { … } ] }