GuidesPPCGet Available Locations

How to get all available locations

Function getAvailableLocations

In order to get all the available decoration locations for a particular product we need to use Product, Pricing and Configuration service (PPC). Our API allows easy access by a GET request to our available-locations endpoint.

Decoration locations represent where on a product you can apply an imprint (e.g., Front, Back, Left Sleeve).

HTTP VERB: GET

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

Query Parameters

ParameterTypeRequiredDescription
localization_countrystringNoCountry code (default: US)
localization_languagestringNoLanguage code (default: en)
environmentstringNoEnvironment: PROD or STAGING (default: PROD)

Example Request

curl -X GET "https://api.psrestful.com/v1.0.0/suppliers/HIT/available-locations/7746/" \
  -H "X-API-Key: your-api-key"

Example Response

This is the response from calling with: SUPPLIER_CODE = HIT PRODUCT_ID = 7746

{
    "AvailableLocationArray": {
        "AvailableLocation": [
            {
                "locationId": 8,
                "locationName": "FRONT"
            },
            {
                "locationId": 9,
                "locationName": "BACK"
            }
        ]
    },
    "ErrorMessage": null
}

Response Structure

FieldDescription
AvailableLocationArrayArray of available decoration locations
locationIdUnique identifier for the location (used in other PPC calls)
locationNameHuman-readable name of the location

Common Location Names

LocationDescription
FRONTFront of the product
BACKBack of the product
LEFT SLEEVELeft sleeve (apparel)
RIGHT SLEEVERight sleeve (apparel)
POCKETPocket area
WRAPFull wrap around product

Use Cases

  • Decoration planning: Determine where imprints can be placed on a product
  • Quote generation: Know available locations before getting pricing
  • Order placement: Use locationId when placing decorated orders

Typical Workflow

  1. Call this endpoint to get available locations for a product
  2. Use locationId when calling Get Decoration Colors
  3. Use location information when getting Pricing and Configuration