Starter Kit

Dashboard

rnd@covver.io

Covver's API gives you full power to create engaging experiences, branded and personalized gifts, and custom gifting workflows

Getting Started

Authentication

Create an access token and a refresh token

Create OAuth Tokens

Uses a refresh token to create an access token

Refresh the access token

Embed the swag catalog manager iframe inside your platform. This will allow your customers to automatically create and customize their company swag catalog.

Swag catalog manager

Personalization

Get information about collections, products, variants and images to display in an eCommerce store

Company Swag Catalog Overview

Create a new company

List Collections

List a collection products by collection ID

List a Collection Products

Get Product

Update Product

Automatically create a branded collection from a logo

Create a new collection

Store creation takes about 30 seconds. Poll this API every few seconds to know when the collection is ready with all products and images

Get the status of a collection

Personalize an existing collection for a specific store user (deprecated)

Personalize a collection

Orders Overview

Validate an order

Place Order

Order status

List Orders

Manage people who have access to the store, and manage their gifts and credits

People Overview

List People

Create People

Delete People

Reward Credits/Gifts

Withdraw credits or gifts from your people

Withdraw Credits/Gifts

Receive webhook notifications about events in the Covver backend

Webhook overview

Webhook data sent for order placed events

Order placed webhook event

Webhook data sent when the order is confirmed

Order confirmed webhook event

Webhook data sent when the order is sent to the shipping company

Order fulfilled webhook event

Webhook data sent when a new collection is created

Collection created webhook event

Webhook data sent when a new collection is updated

Collection updated webhook event

Webhook data sent when a new collection is deleted

Collection deleted webhook event

Webhook data sent when a new product is created

Product created webhook event

Webhook data sent when a product is updated

Product updated webhook event

Webhook data sent when a product is hidden from a store

Product hidden webhook event

Webhook data sent when a product is added back to a store

Introduction

Auth

Guides

API Reference

API Changelog

List shipping regions

Response