ForSURE.categorylist

Category List API

The category list forms the core of our software, enabling you to input and manage detailed product information such as WEEE categories, weights, and packaging usage. This data is crucial for accurately calculating Extended Producer Responsibility (EPR) costs, and any inaccuracies could significantly impact compliance and financial outcomes.

Overview

The Category List API provides a comprehensive system for managing product data organized into a hierarchical structure:

  • Versions: Major iterations of your categorylist
  • Revisions: Working copies where you make changes before publishing
  • Labels: Column definitions that structure your data
  • Items: Individual products with their data
  • Features: Additional metadata attached to items

Core Capabilities

Data Management

  • Upload Category List: Upload new categories using predefined labels, ensuring data consistency and accuracy
  • Retrieve Category Details: Fetch detailed information from existing category lists
  • Edit Category Entries: Update specific entries within the category list, maintaining data integrity
  • Bulk Update: Perform mass updates to the category list for efficient data management
  • Delete Category List: Remove entire category lists when data needs to be refreshed

Version Control

  • Version Management: Create and manage multiple versions of your categorylist
  • Revision System: Work on draft revisions before publishing
  • Change Tracking: Track who made changes and when

Data Structure

  • Flexible Columns: Define custom columns based on your needs
  • Label System: Use labels to structure columns with metadata (country, report type, PRO)
  • Column Ordering: Customize how columns are displayed (organization and user preferences)

Maintaining Data Integrity

To ensure the highest standards of data integrity and compliance:

  • Validation Checks: The API includes checks such as verifying the chemical composition of batteries, ensuring all entries meet regulatory standards
  • Data Correction: Spelling discrepancies or formatting errors are flagged and need correction to prevent data from being ignored during processing
  • Status Management: Track item approval status and lifecycle
  • Soft Deletes: Items are marked as deleted, not permanently removed, preserving data history

Importance of Accurate Data Entry

Accurate data entry in the category list is not just about compliance; it directly impacts the EPR costs and overall environmental footprint reporting. Mismanagement of this data could lead to significant financial and reputational damage.

Getting Started

  1. Create a Version: Start by creating a new version (POST /versions)
  2. Define Structure: Set up your labels/columns (PUT /revisions/{revision_uuid}/labels)
  3. Add Data: Upload items via API or CSV (POST /items or POST /revisions/{revision_uuid}/upload)
  4. Publish: When ready, publish your revision (POST /revisions/{revision_uuid}/publish)

Permissions

  • CATEGORYLIST_SUGGEST-EDIT: Required for most operations (viewing, editing items, managing columns)
  • CATEGORYLIST_ADMIN: Required for administrative operations (creating versions)
  • CATEGORYLIST_VIEW: Required for read-only access to some features

Conclusion

The Category List API is designed to empower your business to manage product data effectively and comply with regulatory requirements seamlessly. By leveraging these API endpoints, you can ensure that your product data is accurate, up-to-date, and aligned with the latest compliance standards, supporting sustainable business practices.