POST
/
api
/
ext
/
v1
/
collection

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
headerrequired

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 (coin) stores display prices in credits (1 c = 1 USD). Every user is allocated with credits 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
allowPaymentCheckout
enum<string>

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

Available options:
true,
false

Body

application/json
files
object

Multipart file upload

Response

200 - application/json
companyId
string
required
companySlug
string
required
collectionId
string
required
Update ProductGet the status of a collection