Skip to content

OF26 - Get the quantity of stock available for an offer.
⚠️ No Integration Allowed ⚠️
deprecated

Request

Description

Quantity return rules:

  • 0: if quantity = 0 or the offer is not available
  • x: quantity available

Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)
Path
offerinteger, (int64)required

Offer ID

Query
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}/quantity?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
offer_idinteger, (int64)required

Offer identifier

quantityinteger, (int32)required

Get the quantity of stock available for this offer.
Quantity return rules:

  • 0: if quantity = 0 or the offer is not available
  • x: quantity available

Response
{ "offer_id": 2087, "quantity": 7 }