Response [200 Ok]

Uri /api/v2/catalog/printvendor/LoxleyConsumer?ApplyColorCorrection=false&PriceType=Base
UriDescription Catalog Print Vendor by ID
EndpointType CatalogPrintVendor
Locator CatalogPrintVendor
LocatorType Object

CatalogPrintVendor [1 of 1] - Loxley Colour Consumer
/api/v2/catalog/printvendor/LoxleyConsumer?ApplyColorCorrection=false&PriceType=Base

Uri /api/v2/catalog/printvendor/LoxleyConsumer?ApplyColorCorrection=false&PriceType=Base
UriDescription Catalog Print Vendor by ID
Country GB
Description Based in the UK, Loxley Colour is renowned for their superb quality and service
Name Loxley Colour Consumer
SortIndex 6

Uris

CatalogPrintVendorProducts
/api/v2/catalog/printvendor/LoxleyConsumer!products

Uri /api/v2/catalog/printvendor/LoxleyConsumer!products
UriDescription Catalog Vendor Products
EndpointType CatalogPrintVendorProducts
Locator CatalogProduct
LocatorType Objects

Timing

Total

cycles 1
objects 0
time 0.03068

Config

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

Options

Path

  • /api
  • /v2
  • /catalog
  • /printvendor
  • /

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

Add in the cost of color correction when obtaining the base price
Which type of base price to obtain

Output Fields

Country text
Description text
Name text
SortIndex integer

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/catalog/printvendor/LoxleyConsumer?ApplyColorCorrection=false&PriceType=Base"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Boolean": "For true return type true or 1, for false type false or 0",
            "Select": "Select one option. Options should pass only the \"Value\"."
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "ApplyColorCorrection",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": false,
                    "Description": "Add in the cost of color correction when obtaining the base price",
                    "Type": "Boolean",
                    "Value": "false"
                },
                {
                    "Name": "PriceType",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Base",
                    "Description": "Which type of base price to obtain",
                    "Type": "Select",
                    "OPTIONS": [
                        "Base",
                        "Pro",
                        "Wholesale"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1,
                    "Value": "Base"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "Description",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Name",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "Country",
                "Type": "Varchar",
                "MIN_CHARS": 2,
                "MAX_CHARS": 2
            },
            {
                "Name": "SortIndex",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            }
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "catalog"
            },
            {
                "type": "path",
                "text": "printvendor"
            },
            {
                "type": "singleparam",
                "param_name": "vendorId",
                "param_value": "LoxleyConsumer",
                "param_validator": {}
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/catalog/printvendor/LoxleyConsumer?ApplyColorCorrection=false&PriceType=Base",
        "Locator": "CatalogPrintVendor",
        "LocatorType": "Object",
        "CatalogPrintVendor": {
            "Description": "Based in the UK, Loxley Colour is renowned for their superb quality and service",
            "Name": "Loxley Colour Consumer",
            "Country": "GB",
            "SortIndex": 6,
            "Uri": "/api/v2/catalog/printvendor/LoxleyConsumer?ApplyColorCorrection=false&PriceType=Base",
            "UriDescription": "Catalog Print Vendor by ID",
            "Uris": {
                "CatalogPrintVendorProducts": {
                    "Uri": "/api/v2/catalog/printvendor/LoxleyConsumer!products",
                    "Locator": "CatalogProduct",
                    "LocatorType": "Objects",
                    "UriDescription": "Catalog Vendor Products",
                    "EndpointType": "CatalogPrintVendorProducts"
                },
                "CatalogPrintVendorSkuPrices": {
                    "Uri": "/api/v2/catalog/printvendor/LoxleyConsumer!prices?ApplyColorCorrection=false&PriceType=Base",
                    "Locator": "CatalogSkuPrice",
                    "LocatorType": "Objects",
                    "UriDescription": "Priced Skus for Print Vendor",
                    "EndpointType": "CatalogPrintVendorSkuPrices"
                }
            }
        },
        "UriDescription": "Catalog Print Vendor by ID",
        "EndpointType": "CatalogPrintVendor",
        "Timing": {
            "Total": {
                "time": 0.03068,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}