Data Platform
The Data Platform simplifies, combines, and streamlines many repetitive API calls for catalog products, pricing, and inventory. Its endpoints let you choose the level of detail returned for each product in a single paged call:
- Product Properties
- Specifications
- Images and other assets
- Stock levels (Availability)
- Pricing
- Taxes
- Cannabis Package Details
Where to go next
- Syncing Product Data: how to perform an initial sync, keep it up to date, and re-sync individual products.
- Endpoints: request and response reference for each
DetailedProductDataendpoint.
Definitions
Company: A business, firm, or corporation that may operate one or many locations as physical brick-and-mortar stores and/or virtual ecommerce presence. Most calls to Cova APIs require a CompanyId, which is included in every integration onboarding package we supply.
Location: A physical store or dispensary customers can visit to purchase cannabis and accessories. A company may have many locations. Each location has its own inventory and may define its own prices. Many Cova API endpoints require a location id, commonly represented as EntityId. The Data Platform APIs use LocationId.
Room: A way to segregate inventory within a location. A typical setup has a "Back Room" where new stock is unboxed and received into the system, and a "Sales Floor" used to fulfill sales to end customers. A location can have any number of rooms, but only one room can be designated for processing sales. Rooms do not support different pricing.
Paging
The initial DetailedProductData and incremental DetailedProductData/UpdatedAsOf/{updatedAsOfUTC} endpoints support and require paging in the request body. Call these endpoints once for each page of data. The targeted DetailedProductData/ByProductIdList endpoint does not use paging; split larger ID lists into batches of at most 500 product IDs. Paging is controlled by two integer properties:
Skip: how many results to ignore before returning theTopN results.Top: how many results to return. The maximum, and the maximum accepted value, is 500.
To retrieve all the paged data, begin with Skip = 0 and for each subsequent call increment Skip by the value of Top, until no more results are returned.
Top controls the count of products returned, but the collections within each product (such as pricing and availability) are not restricted. For a company with many locations, a large catalog, and complex pricing, the response can be very large if you always request 500 products. Make Top configurable in your integration so you can balance call volume against response size.
Empty arrays
An empty JSON array property under a product means one of two things:
- Your request body excluded the data. For example,
"IncludeProductAssets": falsereturns an empty array in theAssetsproperty:"Assets": []. - There is no data for that property, possibly because records were deleted or went out of stock. This may signify that you should remove the data from your system, hide products, and so on.
Before removing data from your cache, make sure you requested that data be returned.
Lifecycles and archived products
By default only Active products are returned. Set IncludeAllLifecycles to include products in other lifecycles (Coming Soon, Inactive, Discontinued) and IncludeArchived to include archived products. Only products with a LifeCycle of Active should be shown to consumers for sale.