Skip to content

Fetch Departments

Departments are the highest level of catalog organization in Fynd Commerce, representing broad product categories such as Men's Clothing, Accessories, Footwear, Grocery, or Bottomwear. They serve as the foundation for structuring your product catalog and enabling efficient product discovery across your commerce platform.

The Fetch Departments endpoint retrieves all departments configured for your company, with optional filtering capabilities. Use this API to access department metadata (including IDs, names, slugs, and active status) which is essential when creating products or syncing catalog data between systems. The endpoint supports flexible querying by name, slug, or active status, along with pagination for handling large department lists.

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

Try out Fynd Konnect's Fetch Departments Endpoint


Common Request Headers

HeaderMandatoryDescription
x-access-tokenYesAccess token used for authenticating API requests to Fynd Konnect
Content-TypeYesapplication/json
Use Cases
  • Retrieve the complete list of departments to populate product creation forms
  • Filter departments by name or slug to find specific catalog groupings
  • Check active vs. inactive departments to ensure product assignment accuracy
  • Build department hierarchies for navigation and catalog organization

Query Parameters

namestring

Filter departments by name (partial match supported)

slugstring

Filter departments by slug (exact match)

is_activeboolean

Filter by active (true) or inactive (false) status

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 name for fuzzy searching across department names
  • Use slug when you need an exact match for a specific department
  • Set is_active=true to retrieve only departments currently in use
  • Combine filters to narrow down results (e.g., name=Clothing&is_active=true)

Success Response

itemsArray of objects

List of departments

page_numberinteger

Current page number

page_sizeinteger

Page size used for this response

totalinteger

Total number of records available

API Call Example

curl -i -X GET \
  'https://fyndkonnect.konnect.uat.fyndx1.de/v3/catalog/departments?name=string&slug=string&is_active=true&page_number=1&page_size=1' \
  -H 'x-access-token: YOUR_API_KEY_HERE'

Example Response

{
  "items": [
    {
      "id": 5956,
      "name": "Electronics",
      "slug": "electronics",
      "is_active": true,
      "description": "Electronics department",
      "logo": "https://example.com/electronics.png",
      "created_at": "2023-09-25T10:17:29Z",
      "updated_at": "2023-10-03T09:30:24Z"
    },
    {
      "id": 5957,
      "name": "Men's Clothing",
      "slug": "mens-clothing",
      "is_active": true,
      "description": "Men's apparel and accessories",
      "logo": "https://example.com/mens-clothing.png",
      "created_at": "2023-09-25T10:17:29Z",
      "updated_at": "2023-10-03T09:30:24Z"
    }
  ],
  "page_number": 1,
  "page_size": 10,
  "total": 2
}

Best Practices

  1. Cache department data: Departments rarely change, so cache the response to reduce API calls
  2. Use is_active filter: Always filter by is_active=true when assigning products to departments
  3. Store department IDs: Save department IDs (UIDs) in your system for product creation requests
  4. Handle pagination: For companies with 50+ departments, implement proper pagination logic
  5. Validate before product creation: Always verify the department exists and is active before creating products
Next Steps