Understanding Catalog Data in the SDK
The Entrupy Android SDK integrates a powerful Catalog Data feature, designed to provide rich, structured information about authenticated items. This data can significantly enhance your application by reducing manual data entry, offering detailed product insights to your users, and enabling more consistent item descriptions.
This guide explains what Catalog Data entails, how it's typically accessed or displayed within the SDK, and its potential benefits.
Overview of Catalog Data
Catalog Data is a comprehensive set of information compiled by Entrupy for items that undergo authentication. Its goal is to provide detailed attributes that can be used by integrators to build richer product experiences and streamline operations.
Key aspects of Catalog Data include:
- Source: Originates from an internal Entrupy catalog service that assesses authenticated items.
- Purpose: To augment authentication results with detailed product information, condition assessments, and potentially market context.
- Availability: Typically made available for display in the SDK's Detail View Controller and accessible programmatically via API for backend systems (as detailed in Catalog Data).
Structure of Catalog Data
While the exact structure can evolve, Catalog Data generally includes the following categories and fields:
1. Product Information
Detailed attributes to identify the specific item. Often contributes to what might be informally termed a "Style ID."
brand
: (e.g., "Louis Vuitton") - The brand of the item.category
: (e.g., "Tote Bag") - The general category of the item.style
: (e.g., "Neverfull MM") - The specific style name or model of the item.material
: (e.g., "Monogram Canvas") - The primary material(s) of the item.colorway
: (e.g., "Beige/Brown") - The color or combination of colors.description
: A detailed textual description of the item, potentially including unique features or characteristics.- Serial Number: Often captured during authentication (may be enhanced by server-side OCR).
2. Condition Assessment
An evaluation of the item's physical condition.
score
: A numerical score (e.g., on a 0-10 scale).rating
: A textual rating (e.g., "Excellent," "Very Good," "Fair").issues
: A list of identified condition issues (e.g., "Corner wear," "Handle darkening").details
: Potentially, component-specific assessment (e.g., ratings or notes for "exterior," "interior," "hardware").
3. Marketplace Listings (Contextual)
Information on relevant public listings for the same or similar items found on various platforms. This provides market context but should be treated as informational.
platform
: (e.g., "The RealReal," "eBay").title
: The title of the listing.price
: The listed price (formatted string).currency
: The currency code (e.g., "USD").link
: A URL to the listing.confidence
: An indicator of how confidently the listing is matched to the authenticated item.
Important Considerations for Catalog Data:
- Data Accuracy and Verification: Entrupy gathers and maintains this data. Formal responsibility for accuracy and specifics of data verification or cleanup processes are part of the evolving catalog product. Some internal condition results might have varying degrees of precision.
- Regional Pricing: For marketplace listings, factors like Incoterms or regional pricing variations can affect direct comparability. This is an area of ongoing consideration.
- Scope Limitations (Current Assessment):
- Detailed "Measurements" (e.g., bag dimensions, strap length) are generally not automatically captured.
- "Accessories" (e.g., presence of dustbag, box) are typically not part of the automated catalog data.
- Item Images: Complementing catalog data, the Entrupy API (v2.0) will also provide access to item images (thumbnails, high-resolution) captured during authentication, which can be used for listings.
Accessing and Displaying Catalog Data in the SDK
Within the Entrupy Android SDK, Catalog Data is primarily intended for display within the Detail View Controller.
- Automatic Display: When the Detail View Controller is loaded for an item, it will typically fetch and display the relevant Catalog Data alongside the authentication result and other information.
- Presentation: The SDK will format and present these details in a user-friendly manner. The specific elements of Catalog Data shown in the SDK's UI, and the extent of programmatic access to these data points via SDK methods, might be configurable by Entrupy per integrator or based on the service agreement.
Programmatic Access (Conceptual):
While the Detail View handles the UI, if the SDK provides programmatic access to Catalog Data (e.g., as part of a session details object fetched programmatically), you could potentially use it in custom UIs. This would likely be part of a larger data structure retrieved for an item.
// Kotlin - Conceptual: Accessing Catalog Data if part of a fetched session object
/*
// Assuming 'sessionDetails' is an object fetched programmatically that contains catalog info
sessionDetails.catalogData?.let { catalog ->
println("Brand: ${catalog.productInfo.brand ?: "N/A"}")
println("Style: ${catalog.productInfo.style ?: "N/A"}")
println("Condition Rating: ${catalog.condition.rating ?: "N/A"}")
// Update your custom UI elements with this information
// customBrandLabel.text = catalog.productInfo.brand
// customStyleLabel.text = catalog.productInfo.style
} ?: run {
println("No Catalog Data available for this item.")
}
*/
(Verify the actual data structures and access methods with the current SDK documentation.)
Benefits of Using Catalog Data
- Enhanced User Experience: Provides users with comprehensive information about their items directly within your app.
- Reduced Manual Entry: Can save significant time and effort by automatically populating item details for listings or internal records.
- Data Consistency: Helps maintain consistency in how items are described across your platform.
- Increased Trust: Detailed information, coupled with an Entrupy authentication, can increase buyer confidence.
Configurability and Availability
- The specific Catalog Data elements displayed within the SDK (e.g., in the Detail View) might be subject to configuration by Entrupy, potentially tied to your integration agreement or use case.
- Access to certain data, like detailed marketplace pricing, might be more geared towards backend API consumption by platforms, while the SDK might show a summarized or curated view.
- Error states from the internal catalog service are handled to provide clear feedback if data is partially available or unavailable.
Consult with Entrupy regarding the specific Catalog Data features and configurations available for your integration.
Next Steps
- Review the Detail View Controller guide to see how Catalog Data is typically presented.
- If building custom UIs, explore Programmatic Access to Session Data to understand how Catalog Data might be retrieved as part of a larger item data object.
- Refer to the Catalog Data solution page for more high-level product context.