Retrieve tax sets when retrieving abstract products

Last updated:
Edit on GitHub

This document describes how to retrieve tax sets of abstract products. To retrieve full information of abstract products, see Retrieve abstract products.

Installation

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

Retrieve tax sets of an abstract product

GET /abstract-products/{{abstract_product_sku}}?include=product-tax-sets

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

Request

GET https://glue.mysprykershop.com/abstract-products/001?include=product-tax-sets: Retrieve information about the abstract product with SKU 001 with its tax sets.

Response

Response sample: retrieve information about an abstract product with the details about tax sets 
{
    "data": {
        "type": "abstract-products",
        "id": "001",
        "attributes": {
            "sku": "001"
        },
        "links": {
            "self": "https://glue.mysprykershop.com/abstract-products/001?include=product-tax-sets"
        },
        "relationships": {
            "product-tax-sets": {
                "data": [
                    {
                        "type": "product-tax-sets",
                        "id": "0e93b0d4-6d83-5fc1-ac1d-d6ae11690406"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "product-tax-sets",
            "id": "0e93b0d4-6d83-5fc1-ac1d-d6ae11690406",
            "attributes": {
                "name": "Entertainment Electronics",
                "restTaxRates": [
                    {
                        "name": "Austria Standard",
                        "rate": "20.00",
                        "country": "AT"
                    },
                    {
                        "name": "Belgium Standard",
                        "rate": "21.00",
                        "country": "BE"
                    },
                    {
                        "name": "Denmark Standard",
                        "rate": "25.00",
                        "country": "DK"
                    },
                    {
                        "name": "France Standard",
                        "rate": "20.00",
                        "country": "FR"
                    },
                    {
                        "name": "Germany Standard",
                        "rate": "19.00",
                        "country": "DE"
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/abstract-products/001/product-tax-sets"
            }
        }
    ]
}
RESOURCE ATTRIBUTE TYPE DESCRIPTION
abstract-products sku String SKU of the abstract product.
abstract-products averageRating String Average rating of the product based on customer rating.
abstract-products reviewCount Integer Number of reviews left by customer for this abstract product.
abstract-products name String Name of the abstract product.
abstract-products description String Description of the abstract product.
abstract-products attributes Object List of attributes and their values.
abstract-products superAttributeDefinition String Attributes flagged as super attributes that are, however, not relevant to distinguish between the product variants.
abstract-products attributeMap Object Each super attribute / value combination and the corresponding concrete product IDs are listed here.
abstract-products attributeMap.super_attributes Object Applicable super attribute and its values for the product variants.
abstract-products attributeMap.attribute_variants Object List of super attributes with the list of values.
abstract-products attributeMap.product_concrete_ids String Product IDs of the product variants.
abstract-products metaTitle String Meta title of the product.
abstract-products metaKeywords String Meta keywords of the product.
abstract-products metaDescription String Meta description of the product.
abstract-products attributeNames Object All non-super attribute / value combinations for the abstract product.
ATTRIBUTE DESCRIPTION
name Tax set name
restTaxRates.name Tax rate name
restTaxRates.rate Tax rate
restTaxRates.country Applicable country for the tax rate

Possible errors

CODE REASON
301 Abstract product is not found.
311 Abstract product SKU is not specified.