Skip to content

Stocks (GET)#

Available stocks can be retrieved to confirm, if a product can be dispatched within 2-3 working days. A generic GET-request against the /stocks endpoint will return a list of all currently available products (meaning that products with insufficient stock will be left out of the result).

  • GET api/stocks

Note

Contrary to the more static data like products or categories, stocks are updated multiple times per day.

To be precise: stocks will be updated every hour from 08:30 until 20:30 from Monday - Saturday.

Parameters#

NAME TYPE DESCRIPTION
threshold integer Optional - allows to set a custom threshold to retrieve only products with a stock of this and above

Response#

{
    "@context": "/v2/api/contexts/Stock",
    "@id": "/v2/api/stocks",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/v2/api/stocks/11395",
            "@type": "Stock",
            "stock": 21,
            "product": {
                "@id": "/v2/api/products/9643",
                "@type": "Product",
                "id": 9643,
                "sku": 383,
                "manufacturerId": "12718",
                "upc": "4004293127181",
                "brand": "RÖSLE",
                "netCost": 21.74,
                "rrp": 26.95,
                "logoUrl": "https://static.mitarbeiterportal.com/data/image/cbd8684482be7e1607878ae99dd6a1d6_38.jpg",
                "isBulkCarrier": false,
                "isEuPlug": false,
                "isSchukoPlug": false,
                "category": "/v2/api/categories/491",
                "images": [
                    {
                        "@id": "/v2/api/product_images/594506",
                        "@type": "ProductImage",
                        "url": "https://static.mitarbeiterportal.com/data/image/5b53f48326cd0a7316946a3faeb3e223_10.jpg"
                    },
                    {
                        "@id": "/v2/api/product_images/594507",
                        "@type": "ProductImage",
                        "url": "https://static.mitarbeiterportal.com/data/image/11a8817221d931c9e7d4c9c234660281_10.jpg"
                    }
                ],
                "stock": "/v2/api/stocks/11395",
                "details": [
                    {
                        "@id": "/v2/api/product_details/2753974",
                        "@type": "ProductDetails",
                        "name": "Pizzaschneider",
                        "description": "Großes, stabil gelagertes Rad<br>Einfach und sauber Pizza und Blechkuchen zerteilen<br>Funktioniert auch wenn der Teig dick ist<br>Mit Rundgriff und Öse zum griffbereiten Aufhängen<br><br>Grifflänge: 10 cm<br>Material: Edelstahl 18/10<br>Maße: H1,9 x B7 x L20 cm<br>Gewicht: 0,15 kg",
                        "lang": "DE"
                    },
                    {
                        "@id": "/v2/api/product_details/2753975",
                        "@type": "ProductDetails",
                        "name": "Pizza cutter",
                        "description": "Large, stably mounted wheel<br>Easily and cleanly cut pizza and sheet cakes<br>Works even when the dough is thick<br>With round handle and eyelet for hanging up ready to hand<br><br>Handle length: 10 cm<br>Material: 18/10 stainless steel<br>Dimensions: H1,9 x W7 x L20 cm<br>Weight: 0,15 kg",
                        "lang": "EN"
                    }
                ]
            }
        }
    ],
    "hydra:totalItems": 5702,
    "hydra:view": {
        "@id": "/v2/api/stocks?page=1",
        "@type": "hydra:PartialCollectionView",
        "hydra:first": "/v2/api/stocks?page=1",
        "hydra:last": "/v2/api/stocks?page=191",
        "hydra:next": "/v2/api/stocks?page=2"
    }
}