Catalog Endpoints
Endpoints used for setting up the product catalog are described here.
Currently, the endpoints under the v2/connection controller are used for maintaining products and their prices.
The most common scenario for a retailer is to understand which products are made available to them by their connections and what are the prices. The following list describes the minimal set of calls that is required to get that information.
The steps are described in detail below. A retailer gets all their connections. Then, for a specific connection, a retailer gets all the shared price lists. Finally, a retailer iterates through a price list to completion to list all the products (regions & prices as well) shared by that publisher. This is the complete catalog of products shared.
Catalog sharing in VaultN stands out as an important concept here. A brief explanation of the concept helps understanding the flow of these calls.
A connection is made in between vaults when a connection invitation is accepted. This connection uniquely identifies the vaults connected. A publisher is then able to compile a selection of products (along with their regions and pricing) in a price list and then share this price list with the retailer over the specified connection. Catalog sharing here enables the retailer to obtain keys from the publisher via VaultN API without the keys being have to reside in the retailer's vault.
In short, catalog sharing enables publishers to give access to their assets they choose to the publishers over shared price lists defined over the connections. The shared price lists hold the details of the arrangement.
Lists all the active connections for your vault. The relevant connection in the results is the connection with the publisher whose catalog is of concern here.
Returns all the active price lists shared in between the connected vaults for the specified connection. Price lists, what kind of information they have and their importance is described in detail under catalog sharing page. A price list, in essence defines which products are shared, their regions and their prices per region / country.
For the specified price list, this endpoint paginates all the records in that price list. A record defines the product, the region and the price for a country. Potentially there are thousands of records in any price list. Page size limit here is 1000 records, therefore an incomplete iteration of the price list will result in incomplete results.
- It is essential here to make sure a complete iteration is made. As long as the page is full, next page must be called for consistent information.
Updated 15 days ago