SellApp API (1.0.0)

Download OpenAPI specification:Download

Introduction

SellApp provides a simple and powerful REST API to integrate our platform into your business or application and build on top of it. This API reference provides information on available endpoints and how to interact with it.

Authentication

SellApp offers only one form of authentication:

  • API Key: SellApp's API uses Bearer authentication with your API Key. You will have to send your API Key via the Authorization header. You can generate an unlimited amount of API keys for your account by clicking here.

Please note - All API requests must be made over HTTPS.

BearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

You can additionally pass an X-STORE variable in the header to specify which store you want to access. By default this will be the store you own, otherwise it will default to the first store you joined. If you're part of multiple stores, you can pass the store's slug in the HTTP header.

Blacklists

Returns a list of all the blacklists created.

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Creates a blacklist and returns the created blacklist.

Authorizations:
Request Body schema: application/json
type
required
string

One of the following - "EMAIL", "IP", or "COUNTRY"

data
required
string

Depending on the type you chose, you can enter an IP address, email address, or country code here.

description
required
string

A description that will help you remember why this blacklist rule was created.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieves a blacklist by the entered ID.

Authorizations:
path Parameters
blacklist
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates a blacklist by the entered ID.

Authorizations:
path Parameters
blacklist
required
integer
Request Body schema: application/json
type
required
string

One of the following - "EMAIL", "IP", or "COUNTRY"

data
required
string

Depending on the type you chose, you can enter an IP address, email address, or country code here.

description
required
string

A description that will help you remember why this blacklist rule was created.

Responses

Request samples

Content type
application/json
{
  • "type": "IP",
  • "data": "1.3.3.7",
  • "description": "Block hackers"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes a blacklist by the entered ID.

Authorizations:
path Parameters
blacklist
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Coupons

Returns a list of all the coupons created.

Authorizations:
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Creates a coupon and returns the created coupon.

Authorizations:
Request Body schema: application/json
code
required
string

The coupon code the customer enters during checkout.

type
required
string

This can be either "PERCENTAGE" or "AMOUNT".

discount
required
string

The discount value in percentage or cents.

limit
integer or null

The maximum amount of times a coupon code can be used, across all customers.

store_wide
required
boolean

Whether the coupon applies to all products within your store or not.

expires_at
string or null

The coupon's expiry date.

Responses

Request samples

Content type
application/json
{
  • "code": "51OFF",
  • "type": "PERCENTAGE",
  • "discount": "50",
  • "store_wide": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieves a coupon by the entered ID.

Authorizations:
path Parameters
coupon
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates a coupon by the entered ID.

Authorizations:
path Parameters
coupon
required
integer
Request Body schema: application/json
code
required
string

The coupon code the customer enters during checkout.

type
required
string

This can be either "PERCENTAGE" or "AMOUNT".

discount
required
string

The discount value in percentage or cents.

limit
integer or null

The maximum amount of times a coupon code can be used, across all customers.

store_wide
required
boolean

Whether the coupon applies to all products within your store or not.

expires_at
string or null

The coupon's expiry date.

Responses

Request samples

Content type
application/json
{
  • "code": "50OFF",
  • "type": "PERCENTAGE",
  • "discount": "50",
  • "limit": 10,
  • "store_wide": true,
  • "expires_at": "2024-04-20T13:37:00.000000Z"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes a coupon by the entered ID.

Authorizations:
path Parameters
coupon
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Products (v1)

Returns a list of all the products created.

Authorizations:
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [