Response [200 Ok]

Uri /api/v2/album/xg6BNt/image/cChpprG-0!pricelistexclusions?_responseLevel=Public
UriDescription Pricelist information for an album image
EndpointType AlbumImagePricelistExclusions
Locator AlbumImagePricelistExclusions
LocatorType Object

AlbumImagePricelistExclusions [1 of 1]
/api/v2/album/xg6BNt/image/cChpprG-0!pricelistexclusions

Uri /api/v2/album/xg6BNt/image/cChpprG-0!pricelistexclusions
UriDescription Pricelist information for an album image
ResponseLevel Public
ColorCorrected true
ExcludeList

Uris

PricelistKey
/api/v2/pricelist/KHJSz

Uri /api/v2/pricelist/KHJSz
UriDescription Pricelist by PricelistKey
EndpointType PricelistKey
Locator PricelistKey
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.05009

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /album
  • /
  • /image
  • /
  • !pricelistexclusions

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Output Fields

ColorCorrected boolean Should color correction be applied
DiscountLevel text Level of discount applied to the expansions on this endpoint.
ExcludeList array CatalogSkus that are not available for this image

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/album/xg6BNt/image/cChpprG-0!pricelistexclusions?_responseLevel=Public"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "ExcludeList",
                "Description": "CatalogSkus that are not available for this image",
                "Type": "Array",
                "ITEM_TYPE": "Uri",
                "MIN_COUNT": 0,
                "MAX_COUNT": "INFINITY"
            },
            {
                "Name": "ColorCorrected",
                "Description": "Should color correction be applied",
                "Type": "Boolean"
            },
            {
                "Name": "DiscountLevel",
                "Description": "Level of discount applied to the expansions on this endpoint.",
                "Type": "Varchar",
                "MIN_CHARS": 255,
                "MAX_CHARS": "INFINITY"
            }
        ],
        "ResponseLevels": [
            "Full",
            "Public"
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "album"
            },
            {
                "type": "singleparam",
                "param_name": "albumkey",
                "param_value": "xg6BNt",
                "param_validator": {}
            },
            {
                "type": "path",
                "text": "image"
            },
            {
                "type": "singleparam",
                "param_name": "imagekey",
                "param_value": "cChpprG-0",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "pricelistexclusions"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/album/xg6BNt/image/cChpprG-0!pricelistexclusions?_responseLevel=Public",
        "Locator": "AlbumImagePricelistExclusions",
        "LocatorType": "Object",
        "AlbumImagePricelistExclusions": {
            "ExcludeList": [],
            "ColorCorrected": true,
            "Uri": "/api/v2/album/xg6BNt/image/cChpprG-0!pricelistexclusions",
            "UriDescription": "Pricelist information for an album image",
            "Uris": {
                "PricelistKey": {
                    "Uri": "/api/v2/pricelist/KHJSz",
                    "Locator": "PricelistKey",
                    "LocatorType": "Object",
                    "UriDescription": "Pricelist by PricelistKey",
                    "EndpointType": "PricelistKey"
                }
            },
            "ResponseLevel": "Public"
        },
        "UriDescription": "Pricelist information for an album image",
        "EndpointType": "AlbumImagePricelistExclusions",
        "Timing": {
            "Total": {
                "time": 0.05009,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}