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
| Parameter | Type | Required | Description |
|---|---|---|---|
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/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
| Field | Description |
|---|---|
AvailableLocationArray | Array of available decoration locations |
locationId | Unique identifier for the location (used in other PPC calls) |
locationName | Human-readable name of the location |
Common Location Names
| Location | Description |
|---|---|
| FRONT | Front of the product |
| BACK | Back of the product |
| LEFT SLEEVE | Left sleeve (apparel) |
| RIGHT SLEEVE | Right sleeve (apparel) |
| Pocket area | |
| WRAP | Full 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
locationIdwhen placing decorated orders
Typical Workflow
- Call this endpoint to get available locations for a product
- Use
locationIdwhen calling Get Decoration Colors - Use location information when getting Pricing and Configuration
Related Guides
- Get Decoration Colors - Get colors available at a location
- Get Available Charges - Get decoration charges
- Get Pricing and Configuration - Get full pricing details
- Get FOB Points - Get shipping origin points