POST
/
api
/
ext
/
v1
/
collection
Create a new collection
curl --request POST \
  --url https://staging-api.covver.io/api/ext/v1/collection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "files": {
    "buffer": "<any>",
    "mimetype": "image/png",
    "encoding": "<string>",
    "filename": "<string>"
  }
}'
{
  "companyId": "<string>",
  "companySlug": "<string>",
  "collectionId": "<string>"
}

Use this API if you want to create the collections via API. If you want to let the admin user create them inside the iframe see the Embedded Catalog Manager

Store creation takes about 30 seconds. Use the Get collection status API to poll for the status

Omit companyId if you want to create a new company as well

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
companyId
string
​
logoUrl
string

Use this field instead of a multipart file to specify a URL to pull the Logo from. This should be a high-res PNG or SVG

​
storeType
enum<string>
default:Coins

Credit/points stores display prices in credits/points (1 c/p = 1 USD). Every user is allocated with credits/points to spend in the store. Gift stores hide prices, and each user is allocated with an amount of items they can order

Available options:
Coins,
Gifts
​
theme
enum<string>
default:GENERAL
Available options:
GENERAL,
BACK TO SCHOOL,
ECO,
SPORT,
SUMMER,
HATS,
WINTER_SNOW,
HOLIDAYS_SNOW,
PRIDE,
SNAPPY
​
allowPaymentCheckout
enum<string>

Payment checkout allows store users to top-up missing store credits/points with a credit card during checkout. This option is only availble in Credit/Points stores

Available options:
true,
false

Body

application/json

Response

200
application/json

Default Response

The response is of type object.