1. Product catalogs

Product collections

Product collections enable buyer users to create and manage personalized product lists. This feature provides flexible list management capabilities that support various e-commerce scenarios and user experiences.

Use cases

Save for later

  • Move products from active orders
  • Preserve shopping intentions
  • Simplify future purchases
  • Track desired items

Favorite products

  • Mark preferred items
  • Quick access to frequent purchases
  • Personalized product lists
  • Simplified reordering

Custom wishlists

  • Create multiple lists
  • Organize by purpose
  • Share product selections
  • Track desired items

Key features

Visibility control

Product restrictions:

  • Only visible products can be added

    GET me/products

  • Follows standard visibility rules

  • Respects user permissions

  • Maintains data security

Access management

Current limitations:

  • Collections visible to creator only
  • No public list sharing
  • No organization-wide visibility
  • No user-to-user sharing

Future possibilities:

  • Public list functionality
  • Organization-wide sharing
  • User-specific sharing
  • Controlled visibility

Collection limits

System boundaries:

  • 500 products per collection
  • Unlimited collections per user
  • Efficient list management
  • Optimized performance

ProductCollection resource

Core collection definition:

json
{
  "ID": "",
  "Name": "",
  "xp": {}
}

Properties:

  • ID: Unique identifier
  • Name: Collection title
  • xp: Extended properties

API endpoints

Collection management

Basic operations:

  • GET v1/me/productcollections

    • List all collections
    • View collection details
    • Access personal lists

  • GET v1/me/productcollections/{productCollectionID}

    • Retrieve specific collection
    • View collection details
    • Access list contents

  • POST v1/me/productcollections

    • Create new collection
    • Set collection name
    • Configure properties

  • PUT v1/me/productcollections/{productCollectionID}

    • Update entire collection
    • Modify all properties
    • Replace configuration

  • PATCH v1/me/productcollections/{productCollectionID}

    • Partial collection updates
    • Modify specific properties
    • Preserve other settings

  • DELETE v1/me/productcollections/{productCollectionID}

    • Remove collection
    • Delete all entries
    • Clean up resources

Product management

List operations:

  • GET v1/me/productcollections/{productCollectionID}/products

Item operations:

  • PUT v1/me/productcollections/{productCollectionID}/{productID}

    • Add product to collection
    • Create new entry
    • Update list contents

  • DELETE v1/me/productcollections/{productCollectionID}/{productID}

    • Remove product from collection
    • Delete entry
    • Update list contents

Collection entries

New capabilities

December 2024 enhancements:

  • Entry creation endpoint:

    POST v1/productcollections/{productCollectionID}/products

Required fields:

  • ProductID: Target product

Optional features:

  • ListOrder: Custom sorting
  • DateAdded: Automatic timestamp

Entry management

Sorting options:

  • Custom list order
  • Addition date
  • Product attributes
  • User preferences

Use cases:

  • Wishlist organization
  • Saved item management
  • Priority ordering
  • Custom arrangements

Implementation considerations

Collection design

Best practices:

  1. Plan collection structure
  2. Define naming conventions
  3. Consider xp requirements
  4. Document limitations

Product handling

Guidelines:

  1. Verify product visibility
  2. Check collection limits
  3. Manage entry ordering
  4. Handle removals

User experience

Recommendations:

  1. Clear collection naming
  2. Intuitive organization
  3. Easy product management
  4. Efficient navigation

Future enhancements

Planned capabilities:

  • Public list sharing
  • Organization visibility
  • User-specific sharing
  • Enhanced sorting

For additional features, see:

If you have suggestions for improving this article, let us know!