Glue API: Retrieve product offer availability

Last updated:
Edit on GitHub

This document describes how to retrieve product offer availabilities via Glue API.

Installation

For detailed information about the modules that provide the API functionality and related installation instructions, see:

Retrieve availability of a product offer

To retrieve a availability of a product offer, send the request:

GET /product-offers/{{offerId}}/product-offer-availabilities

PATH PARAMETER DESCRIPTION
{{offerId}} Unique identifier of a product offer to retrieve the availability of. To get it, retrieve the offers of a concrete product.

Request

Request sample: retrieve availability of a product offer

GET https://glue.mysprykershop.com/product-offers/offer56/product-offer-availabilities

Response

Response sample: retrieve availability of a product offer

{
    "data": [
        {
            "type": "product-offer-availabilities",
            "id": "offer56",
            "attributes": {
                "isNeverOutOfStock": true,
                "availability": true,
                "quantity": "0.0000000000"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/product-offers/offer56/product-offer-availabilities"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/product-offers/offer56/product-offer-availabilities"
    }
}
ATTRIBUTE TYPE DESCRIPTION
isNeverOutOfStock Boolean Shows if the product offer is never out of stock.
availability Boolean Defines if the product offer is available.
quantity Integer Stock of the product offer.

Possible errors

CODE DESCRIPTION
3701 Product offer was not found.
3702 Product offer ID is not specified.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.