Skip to content

Fetch Templates

Product templates are predefined blueprints that enforce structure and validation for product data in Fynd Commerce. They define the mandatory and optional attributes required for specific product types, ensuring uniformity, consistency, and compliance across your catalog listings. Each template is associated with specific departments and categories, streamlining the product creation process by providing a standardized format.

The Fetch Templates endpoint retrieves all product templates configured for your company, with optional filtering by department. Use this API to access template metadata (including names, slugs, associated departments, categories, and required attributes) which is essential when creating products or building product creation workflows. Understanding template structures ensures that your product data meets platform validation requirements and maintains catalog integrity.

Request Type: GET
Scheme: HTTPS
Endpoint: https://{{host}}/v3/catalog/product/template

Try out Fynd Konnect's Fetch Templates Endpoint


Common Request Headers

HeaderMandatoryDescription
x-access-tokenYesAccess token used for authenticating API requests to Fynd Konnect
Content-TypeYesapplication/json
Use Cases
  • Retrieve all available templates to populate product creation form dropdowns
  • Filter templates by department to show only relevant templates for specific product types
  • Identify required attributes for a template before creating products
  • Understand which categories are supported by each template
  • Validate product data against template requirements before submission

Query Parameters

departmentstring

Filter templates by department slug (e.g., electronics, fashion, grocery)

page_numberinteger>= 1

Page number for pagination (default: 1)

page_sizeinteger[ 1 .. 200 ]

Number of items to retrieve per page (default: 10)

Filtering Tips
  • Use department slug to retrieve only templates relevant to a specific department
  • Leave department empty to retrieve all templates across all departments
  • Cache template data as it changes infrequently
  • Cross-reference the attributes array with Fetch Attributes by Product to understand attribute requirements

Success Response

itemsArray of objects

List of product templates matching the query filters

page_numberinteger

Current page number in the paginated response

page_sizeinteger

Number of items returned in this page

totalinteger

Total number of templates available matching the query

API Call Example

curl -i -X GET \
  'https://fyndkonnect.konnect.uat.fyndx1.de/v3/catalog/product/template?department=string&page_number=1&page_size=1' \
  -H 'x-access-token: YOUR_API_KEY_HERE'

Example Response

{
  "items": [
    {
      "id": "tmpl_12345",
      "name": "Air Care",
      "slug": "air-care",
      "description": null,
      "is_active": true,
      "is_archived": false,
      "is_physical": true,
      "is_expirable": false,
      "departments": [
        "electronics"
      ],
      "categories": [
        "air-coolers",
        "air-purifiers",
        "split-air-conditioners",
        "window-air-conditioners"
      ],
      "attributes": [
        "category-l1",
        "category-l2",
        "category-l3",
        "model",
        "primary_color",
        "special-feature",
        "warranty-period",
        "energy-efficiency-ratio-eer"
      ],
      "created_on": "2024-09-02T08:36:12.126000",
      "modified_on": "2025-04-14T08:39:48.546000"
    }
  ],
  "page_number": 1,
  "page_size": 10,
  "total": 1
}

Best Practices

  1. Cache template data: Templates change infrequently, so implement caching to reduce API calls
  2. Use active templates only: Filter for is_active: true and is_archived: false templates when creating new products
  3. Store template slugs: Save template slugs in your system as they are required in product creation requests
  4. Validate categories: Ensure the L3 category you're assigning to a product is listed in the template's categories array
  5. Fetch attribute details: Use the attributes array with Fetch Attributes by Product to understand mandatory vs. optional fields
  6. Handle pagination: Some companies may have many templates; implement proper pagination logic
  7. Check template compatibility: Verify the template supports your target department and category before product creation
Next Steps