Skip to content
Products
/
/
/
OF21 - List offers of a s...

OF21 - List offers of a shop

Request

Call Frequency
Recommended usage: On each shop's offers page view
Maximum usage: On each shop's offers page view
Read More
Pagination

This resource supports offset pagination (see documentation)

Sort fields

sort field can have the following values:

  • totalPrice (Default) - Sort by total price (asc by default)
  • price - Sort by price, total price (asc by default)
  • productTitle - Sort by product title, total price (asc by default)

Localization

This resource supports locale parameter (see documentation)

Localized output fields will be highlighted with an icon:

Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_OFFER_READ)
Query
offer_state_codesstring

List of offer state codes

skustring

Offer's sku

product_idstring

Product's sku

favoriteboolean

Filter only favorite offers

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_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/offers?offer_state_codes=string&sku=string&product_id=string&favorite=false&pricing_channel_code=string&pricing_customer_organization_id=string&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
offersArray of objectsrequired

Offers for a shop

total_countinteger, (int32)required

Offer total count

Response
{
  "offers": [
    { … }
  ],
  "total_count": 1
}