Glue API: Retrieve abstract product list content items

Edit on GitHub

This endpoint allows retrieving information about abstract product list content items.

Installation

For details on the modules that provide the API functionality and how to install them, see Content Items API.

Retrieve Abstract Product List content item

To retrieve information about an abstract product list content item, send the request:


GET /content-product-abstract-lists/{{content_item_key}}


PATH PARAMETER DESCRIPTION
{{content_item_key}} Unique identifier of the content item to retrieve.

Request

HEADER KEY REQUIRED DESCRIPTION
locale Defines the locale to retrieve the content item information for. If not specified, the endpoint returns the information for the default locale.
QUERY PARAMETER DESCRIPTION POSSIBLE VALUES
include Adds resource relationships to the request. abstract-products
SAMPLE REQUEST USAGE
GET https://glue.mysprykershop.com/content-product-abstract-lists/apl-1 Retrieve information about the abstract product list with ID apl-1.
GET https://glue.mysprykershop.com/content-product-abstract-lists/apl-1?include=abstract-products Retrieve information about the abstract product list with id apl-1. Include information about its abstract products.
.
Response sample: retrieve Abstract Product List content item
{
    "data": {
        "type": "content-product-abstract-lists",
        "id": "apl-1",
        "links": {
            "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1"
        }
    }
}
Response sample: retrieve Abstract Product List content item with the details on its abstract products
{
    "data": {
        "type": "content-product-abstract-lists",
        "id": "apl-1",
        "links": {
            "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1?include=abstract-products"
        },
        "relationships": {
            "abstract-products": {
                "data": [
                    {
                        "type": "abstract-products",
                        "id": "204"
                    },
                    {
                        "type": "abstract-products",
                        "id": "205"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "abstract-products",
            "id": "204",
            "attributes": {
                "sku": "204",
                "averageRating": null,
                "reviewCount": 0,
                "name": "Sony PXW-FS5K",
                "description": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second. Add some power to your shots: Add an E-mount lens with a power zoom and smoothly focus in on your subject with up to 11x magnification. Capture it all in HD: Capture all the detail with Full HD 1920 x 1080 video shooting (AVCHD format) at 24mbs for increased detail and clarity. DSLR quality photos: Shoot stills with DSLR-like picture quality and shallow depth of field for professional looking shots.",
                "attributes": {
                    "iso_sensitivity": "3200",
                    "sensor_type": "CMOS",
                    "white_balance": "Auto",
                    "wi_fi": "yes",
                    "brand": "Sony",
                    "color": "Black"
                },
                "superAttributesDefinition": [
                    "color"
                ],
                "superAttributes": {
                    "color": [
                        "Black"
                    ]
                },
                "attributeMap": {
                    "product_concrete_ids": [
                        "204_29851280"
                    ],
                    "super_attributes": {
                        "color": [
                            "Black"
                        ]
                    },
                    "attribute_variants": []
                },
                "metaTitle": "Sony PXW-FS5K",
                "metaKeywords": "Sony,Smart Electronics",
                "metaDescription": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic vide",
                "attributeNames": {
                    "iso_sensitivity": "ISO sensitivity",
                    "sensor_type": "Sensor type",
                    "white_balance": "White balance",
                    "wi_fi": "Wi-Fi",
                    "brand": "Brand",
                    "color": "Color"
                },
                "url": "/en/sony-pxw-fs5k-204"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/abstract-products/204"
            }
        },
        {
            "type": "abstract-products",
            "id": "205",
            "attributes": {
                "sku": "205",
                "averageRating": null,
                "reviewCount": 0,
                "name": "Toshiba CAMILEO S30",
                "description": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to the new Pause feature button! Save the best moments of your life with your CAMILEO S30 camcorder. Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second.",
                "attributes": {
                    "total_megapixels": "8 MP",
                    "display": "LCD",
                    "self_timer": "10 s",
                    "weight": "118 g",
                    "brand": "Toshiba",
                    "color": "Black"
                },
                "superAttributesDefinition": [
                    "total_megapixels",
                    "color"
                ],
                "superAttributes": {
                    "color": [
                        "Grey"
                    ]
                },
                "attributeMap": {
                    "product_concrete_ids": [
                        "205_6350138"
                    ],
                    "super_attributes": {
                        "color": [
                            "Grey"
                        ]
                    },
                    "attribute_variants": []
                },
                "metaTitle": "Toshiba CAMILEO S30",
                "metaKeywords": "Toshiba,Smart Electronics",
                "metaDescription": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to",
                "attributeNames": {
                    "total_megapixels": "Total Megapixels",
                    "display": "Display",
                    "self_timer": "Self-timer",
                    "weight": "Weight",
                    "brand": "Brand",
                    "color": "Color"
                },
                "url": "/en/toshiba-camileo-s30-205"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/abstract-products/205"
            }
        }
    ]
}
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.

Retrieve Abstract Product List with its abstract products

To retrieve an Abstract Product List content item with its abstract products, you can retrieve Abstract Product List data and include abstract-products as the resource relation. Alternatively, you can run this request:


GET /content-product-abstract-lists/{{content_item_key}}/abstract-products


PATH PARAMETER DESCRIPTION
{{content_item_key}} Unique identifier of the content item to retrieve.

Request

HEADER KEY REQUIRED DESCRIPTION
locale Defines the locale to retrieve the content item information for. If not specified, the endpoint returns the information for the default locale.

Request sample: retrieve Abstract Product List with its abstract products

GET https://mysprykershop.com/content-product-abstract-lists/apl-1/abstract-products

Response

Response sample: retrieve Abstract Product List content item with the details on its abstract products
{
    "data": [
        {
            "type": "abstract-products",
            "id": "204",
            "attributes": {
                "sku": "204",
                "averageRating": null,
                "reviewCount": 0,
                "name": "Sony PXW-FS5K",
                "description": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second. Add some power to your shots: Add an E-mount lens with a power zoom and smoothly focus in on your subject with up to 11x magnification. Capture it all in HD: Capture all the detail with Full HD 1920 x 1080 video shooting (AVCHD format) at 24mbs for increased detail and clarity. DSLR quality photos: Shoot stills with DSLR-like picture quality and shallow depth of field for professional looking shots.",
                "attributes": {
                    "iso_sensitivity": "3200",
                    "sensor_type": "CMOS",
                    "white_balance": "Auto",
                    "wi_fi": "yes",
                    "brand": "Sony",
                    "color": "Black"
                },
                "superAttributesDefinition": [
                    "color"
                ],
                "superAttributes": {
                    "color": [
                        "Black"
                    ]
                },
                "attributeMap": {
                    "product_concrete_ids": [
                        "204_29851280"
                    ],
                    "super_attributes": {
                        "color": [
                            "Black"
                        ]
                    },
                    "attribute_variants": []
                },
                "metaTitle": "Sony PXW-FS5K",
                "metaKeywords": "Sony,Smart Electronics",
                "metaDescription": "Take control and shoot your way Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic vide",
                "attributeNames": {
                    "iso_sensitivity": "ISO sensitivity",
                    "sensor_type": "Sensor type",
                    "white_balance": "White balance",
                    "wi_fi": "Wi-Fi",
                    "brand": "Brand",
                    "color": "Color"
                },
                "url": "/en/sony-pxw-fs5k-204"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/abstract-products/204"
            }
        },
        {
            "type": "abstract-products",
            "id": "205",
            "attributes": {
                "sku": "205",
                "averageRating": null,
                "reviewCount": 0,
                "name": "Toshiba CAMILEO S30",
                "description": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to the new Pause feature button! Save the best moments of your life with your CAMILEO S30 camcorder. Real cinematic images and sound: Explore a new dimension in creative artistry. Capture beautifully detailed, cinematic video images plus high-quality audio in cinematic 24 frames per second.",
                "attributes": {
                    "total_megapixels": "8 MP",
                    "display": "LCD",
                    "self_timer": "10 s",
                    "weight": "118 g",
                    "brand": "Toshiba",
                    "color": "Black"
                },
                "superAttributesDefinition": [
                    "total_megapixels",
                    "color"
                ],
                "superAttributes": {
                    "color": [
                        "Grey"
                    ]
                },
                "attributeMap": {
                    "product_concrete_ids": [
                        "205_6350138"
                    ],
                    "super_attributes": {
                        "color": [
                            "Grey"
                        ]
                    },
                    "attribute_variants": []
                },
                "metaTitle": "Toshiba CAMILEO S30",
                "metaKeywords": "Toshiba,Smart Electronics",
                "metaDescription": "Reach out Reach out with your 10x digital zoom and control recordings on the large 3-inch touchscreen LCD monitor. Create multi-scene video files thanks to",
                "attributeNames": {
                    "total_megapixels": "Total Megapixels",
                    "display": "Display",
                    "self_timer": "Self-timer",
                    "weight": "Weight",
                    "brand": "Brand",
                    "color": "Color"
                },
                "url": "/en/toshiba-camileo-s30-205"
            },
            "links": {
                "self": "glue.mysprykershop.com/abstract-products/205"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/content-product-abstract-lists/apl-1/abstract-products"
    }
}
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.

Possible errors

CODE REASON
2201 Content item is not found.
2202 Content key is missing.
2203 Content type is invalid.

For generic Glue Application errors that can also occur, see Reference information: GlueApplication errors.