How to get decoration colors

Function getDecorationColors

In order to get possible decoration colors for a particular product at a specific location, we need to use Product, Pricing and Configuration service (PPC). Our API allows easy access by a GET request to our decoration-colors endpoint.

HTTP VERB: `GET`

URL: https://api.psrestful.com/v1.0.0/suppliers/{SUPPLIER_CODE}/decoration-colors/{PRODUCT_ID}/

Query Parameters

Parameter	Type	Required	Description
`location_id`	integer	Yes	Location ID (get from Available Locations)
`decoration_id`	integer	No	Filter by specific decoration method
`localization_country`	string	No	Country code (default: `US`)
`localization_language`	string	No	Language code (default: `en`)
`environment`	string	No	Environment: `PROD` or `STAGING` (default: `PROD`)

Example Request

curl -X GET "https://api.psrestful.com/v1.0.0/suppliers/HIT/decoration-colors/55414/?location_id=53" \
  -H "X-API-Key: your-api-key"

Example Response

This is the response from calling with: SUPPLIER_CODE = HIT PRODUCT_ID = 55414 location_id = 53

The response has been truncated to show 5 colors:

{
    "DecorationColors": {
        "productId": "55414",
        "locationId": "53",
        "pmsMatch": true,
        "fullColor": true,
        "ColorArray": {
            "Color": [
                {
                    "colorName": "Athletic Gold",
                    "hex": null,
                    "approximatePms": null,
                    "standardColorName": null
                },
                {
                    "colorName": "Black",
                    "hex": null,
                    "approximatePms": null,
                    "standardColorName": null
                },
                {
                    "colorName": "Navy Blue",
                    "hex": null,
                    "approximatePms": null,
                    "standardColorName": null
                },
                {
                    "colorName": "Red",
                    "hex": null,
                    "approximatePms": null,
                    "standardColorName": null
                },
                {
                    "colorName": "White",
                    "hex": null,
                    "approximatePms": null,
                    "standardColorName": null
                }
            ]
        },
        "DecorationMethodArray": {
            "DecorationMethod": [
                {
                    "decorationId": 3471228,
                    "decorationName": "Pad Print"
                },
                {
                    "decorationId": 3471229,
                    "decorationName": "Laser Engrave"
                }
            ]
        }
    },
    "ErrorMessage": null
}

Response Structure

Field	Description
`productId`	Product identifier
`locationId`	Location identifier for the decoration
`pmsMatch`	Whether PMS color matching is available
`fullColor`	Whether full-color printing is available
`ColorArray`	Array of available colors
`DecorationMethodArray`	Array of decoration methods available at this location

Color Fields

Field	Description
`colorName`	Name of the color
`hex`	Hex color code (if available)
`approximatePms`	Approximate PMS color match
`standardColorName`	Standardized color name

Typical Workflow

Get Available Locations to find decoration locations
Call this endpoint with the location_id to get available colors
Use color and decoration information when placing orders

Use Cases

Design mockups: Know what colors are available for decoration
Customer presentations: Show available imprint colors
Order placement: Specify valid colors when ordering

Get Available Locations - Get decoration locations (required for location_id)
Get Available Charges - Get decoration charges
Get Pricing and Configuration - Get full pricing details
Get FOB Points - Get shipping origin points

Get Available Charges Get Inventory Levels