Retrieve abstract product availability

Last updated:
Edit on GitHub

This endpoint allows retrieving information about availability of abstract products.

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see Install the Inventory Management Glue API

Retrieve availability of an abstract product

To retrieve availability of an abstract product, send the request:

GET /abstract-products/{{abstract_product_sku}}/abstract-product-availabilities

PATH PARAMETER DESCRIPTION
{{abstract_product_sku}} SKU of an abstract product to get availability for.

Request

Request sample: retrieve availability of an abstract product

GET http://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities

Response

Response sample: retrieve availability of an abstract product

{
    "data": [{
        "type": "abstract-product-availabilities",
        "id": "001",
        "attributes": {
            "availability": true,
            "quantity": 10
        },
        "links": {
            "self": "http://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities"
        }
    }],
    "links": {
        "self": "http://glue.mysprykershop.com/abstract-products/001/abstract-product-availabilities"
    }
}
FIELD TYPE DESCRIPTION
availability Boolean Boolean to inform about the availability
quantity Integer Available stock (all warehouses aggregated)

Possible errors

CODE REASON
305 Availability is not found.
311 Abstract product SKU is not specified.

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