Skip to content
Products
/
/
/
P31 - Get products for a...

P31 - Get products for a list of product references

Request

Description

Note: this resource returns 100 products maximum
Results are sorted by product sku asc, then by product identifier type asc and then by product identifier asc

Call Frequency
Recommended usage: At each product page display
Maximum usage: At each product page display
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_PRODUCT_READ)
Query
product_referencesstringrequired

List of the product's identifiers with type, (structure: "product_references=<productIdType>|<productId>,<productIdType>|<productId>, ...") where accepted <productIdType> are operator’s product references, like EAN or UPC for example.

Note that SHOP_SKU or SKU are invalid <productIdType> for this API.

productsstringdeprecated

List of the product's identifiers with type, (structure: "products=<productId>|<productIdType>,<productId>|<productIdType>, ...") where accepted <productIdType> are operator’s product references, like EAN or UPC for example.

Note that SHOP_SKU or SKU are invalid <productIdType> for this API.

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/products?product_references=string&products=string&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
productsArray of objectsrequired

Products list

total_countinteger, (int32)requireddeprecated

Total count

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