Cova API Developers Portal

 

 

 

 

 

Quickstart - Products, pricing, availability, and sales orders


 

E-commerce websites, menu boards, and in-store kiosks share a commonality—they all require comprehensive product information. This includes attributes, specifications, images, location-specific pricing, and real-time inventory stock levels. The following outlines a set of steps to efficiently gather and maintain this essential data, allowing retailers to seamlessly manage their operations and cater to the needs of their customers.

 

Obtain Cova retailer credentials

  • See Getting Started for more information about obtaining an onboarding package.

Initial company sync

  • Get an Auth Bearer Token
    • cache and reuse the token for ~12 hours
  • Get and persist Detailed Product Data
    • store the information you need to display to an end user
  • Location information
    • optionally interact with the retailer's list of locations

Poll for Detailed Product Data Modifications

 

Online Orders

Does your solution support online ordering for pickup or delivery?

  • Get and persist Tax pricing configuration
  • Maintain Customer/Patient relationship (optional)
    • Search for a customer
    • Create a customer
    • persist the customerId in your system as a cross-reference
  • Submit TIP or TEP Orders according to the tax configuration discussed above.
    • for a delivery order, set property IsDelivery = true
    • persist the orderId in your system as a cross-reference
  • Poll for order Status
    • every few seconds until the status is ReadyForPayment (see below) or a failure status is returned.
    • every few minutes until Completed or Cancelled
    • on-demand once the order ages beyond a week
  • Mark the order as Paid (optional)
    • if your solution accepts payment and the order is in a state of ReadyForPayment

 

For a comprehensive listing of all available APIs

API Documentation »