Overview

Tebex Headless API allows integration of your store directly into your own frontend or in-game.

The Headless API works with your existing packages, coupons, sales & creator codes.

If you haven't already done so, we recommend having a read of our quick start guide before beginning integration.

You can query the Headless API to retrieve your packages/categories, build a basket for a user, and direct them to checkout - all from within your own frontend implementation (be that a website or in-game).

The Headless API can be used with Tebex.js for a fully embedded checkout experience without the user ever leaving your own website.

Headless API Flow

Below is the expected flow your application should follow when utilizing the Headless API. For a list of all endpoints, please see the Endpoints page.

Packages & Listings

You can retrieve your store's listings in JSON format and display them however you wish:

Gets all categories available in the webstore.

Gets all categories from a webstore. This does not include package information. To include package information, add ?includePackages=1 to the URL.

GEThttps://headless.tebex.io/api/accounts/{token}/categories

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

200

Successful response returns a list of category information.

Body

application/json

dataarray of Category (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "description": "text",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "category": {
            "id": 2678660,
            "name": "Packages"
          },
          "base_price": 5,
          "sales_tax": 0,
          "total_price": 5,
          "currency": "USD",
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list"
    }
  ]
}

Gets a store's categories including all package information with them.

Gets all categories from a webstore including packages.

GEThttps://headless.tebex.io/api/accounts/{token}/categories?includePackages=1

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

200

Successful response returns a list of category information.

Body

application/json

dataarray of Category (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/categories?includePackages=1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "description": "text",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "category": {
            "id": 2678660,
            "name": "Packages"
          },
          "base_price": 5,
          "sales_tax": 0,
          "total_price": 5,
          "currency": "USD",
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list"
    }
  ]
}

Gets information about a specific category

Gets information about a category and returns the packages in that category.

GEThttps://headless.tebex.io/api/accounts/{token}/categories/{categoryId}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

categoryId*string

The ID of the category to fetch.

Example: 127244343

Response

200

Successful response returns the category without package information.

Body

application/json

dataarray of Category (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/categories/{categoryId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "description": "text",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "category": {
            "id": 2678660,
            "name": "Packages"
          },
          "base_price": 5,
          "sales_tax": 0,
          "total_price": 5,
          "currency": "USD",
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list"
    }
  ]
}

Gets information about a specific category, including all the packages in the category

Gets information about a category and returns the packages in that category.

GEThttps://headless.tebex.io/api/accounts/{token}/categories/{categoryId}?includePackages=1

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

categoryId*string

The ID of the category to fetch.

Example: 127244343

Response

200

Successful response returns the category with package information.

Body

application/json

dataarray of Category (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/categories/{categoryId}?includePackages=1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "description": "text",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "category": {
            "id": 2678660,
            "name": "Packages"
          },
          "base_price": 5,
          "sales_tax": 0,
          "total_price": 5,
          "currency": "USD",
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list"
    }
  ]
}

Fetch a package from a webstore by its identifier

Gets a package from a webstore by ID.

GEThttps://headless.tebex.io/api/accounts/{token}/packages/{packageId}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

packageId*number

The package's ID.

Example: 1272441812

Response

200

Successful response returns the package information.

Body

application/json

dataarray of Package (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/packages/{packageId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": 6276316,
      "name": "test package 101",
      "description": "<p>this is just a test. only a test. nothing more.</p>",
      "image": null,
      "type": "single",
      "category": {
        "id": 2678660,
        "name": "Packages"
      },
      "base_price": 5,
      "sales_tax": 0,
      "total_price": 5,
      "currency": "USD",
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

Fetch all packages from a webstore

Gets all packages from a webstore.

GEThttps://headless.tebex.io/api/accounts/{token}/packages

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

200

Successful response returns a list of package information.

Body

application/json

dataarray of Package (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/packages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": 6276316,
      "name": "test package 101",
      "description": "<p>this is just a test. only a test. nothing more.</p>",
      "image": null,
      "type": "single",
      "category": {
        "id": 2678660,
        "name": "Packages"
      },
      "base_price": 5,
      "sales_tax": 0,
      "total_price": 5,
      "currency": "USD",
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

Creating Baskets

In order to purchase items, a basket must be created for the customer. Create a basket and allow the customer to login with their username or other OAuth login mechanism (e.g Steam or FiveM).

Create a new basket

Creates a new basket for use during checkout.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Body

application/json

complete_urlstring

A URL the user can return to when checkout is completed.

Example: "https://example.tebex.io/thank-you"

cancel_urlstring

A URL the user can return to when cancelling checkout.

Example: "https://tebex.io/"

customobject

Custom data you wish to associate with the basket. This data will be included with webhook responses and GET requests associated with the Basket.

complete_auto_redirectboolean

True if the user should automatically be redirected to the relevant complete/cancel URL

Example: true

Response

200422

Successful response returns the basket information.

Body

application/json

dataBasket (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

Get authentication links for a basket.

Fetches a basket's auth URL.

GEThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

returnUrl*string

The URL you would like to redirect the user to after successful basket authentication.

Example: "https://example.tebex.io/"

Response

200422

Successful response returns the basket auth information.

Body

application/json

namestring

Example: "FiveM"

urlstring

Example: "https://ident.tebex.io/"

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "name": "FiveM",
    "url": "https://ident.tebex.io/"
  }
]

Adding and Removing Packages

You can add or remove packages programmatically to the created basket via the API as needed when the user interacts with your application.

Add a package to a basket

Add a package with the given ID to the basket.

POSThttps://headless.tebex.io/api/baskets/{basketIdent}/packages

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

application/json

package_idstring

Example: 6276316

quantitynumber

Example: 1

Response

200422

Successful response.

Body

application/json

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "[e-mail]"

usernamenullable string

couponsarray of Coupon (object)

giftcardsarray of GiftCard (object)

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

customnullable object

linksBasketLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/baskets/{basketIdent}/packages', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "[e-mail]",
  "username": null,
  "coupons": [
    {
      "coupon_code": "Academy10"
    }
  ],
  "giftcards": [
    {
      "card_number": "0127 0244 7210 1111"
    }
  ],
  "creator_code": "text",
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "country": "US",
  "ip": "127.0.0.1",
  "username_id": 127244,
  "base_price": 1.27,
  "sales_tax": 0.11,
  "total_price": 1.38,
  "currency": "USD",
  "packages": [
    {
      "qty": 2,
      "type": "single",
      "revenue_share": [
        {
          "wallet_ref": "some_wallet_reference",
          "amount": 0.5,
          "gateway_fee_percent": 50
        }
      ]
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}

Remove a package from a basket

Remove the given package ID from the basket.

POSThttps://headless.tebex.io/api/baskets/{basketIdent}/packages/remove

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

application/json

package_idstring

Example: 6276316

Response

200422

Successful response returns the basket.

Body

application/json

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "[e-mail]"

usernamenullable string

couponsarray of Coupon (object)

giftcardsarray of GiftCard (object)

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

customnullable object

linksBasketLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/baskets/{basketIdent}/packages/remove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "[e-mail]",
  "username": null,
  "coupons": [
    {
      "coupon_code": "Academy10"
    }
  ],
  "giftcards": [
    {
      "card_number": "0127 0244 7210 1111"
    }
  ],
  "creator_code": "text",
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "country": "US",
  "ip": "127.0.0.1",
  "username_id": 127244,
  "base_price": 1.27,
  "sales_tax": 0.11,
  "total_price": 1.38,
  "currency": "USD",
  "packages": [
    {
      "qty": 2,
      "type": "single",
      "revenue_share": [
        {
          "wallet_ref": "some_wallet_reference",
          "amount": 0.5,
          "gateway_fee_percent": 50
        }
      ]
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}

Coupons, Gift Cards, and Creator Codes

Once all packages and quantities are selected, apply any relevant coupons, gift cards, or creator codes with these endpoints.

Apply a creator code to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

application/json

Provide a creator_code to apply to the basket.

creator_codestring

Example: "Academy10"

Response

200422

Successful response returns the basket.

Body

application/json

dataBasket (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

Remove a creator code from the basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

200422

Creator code removed successfully.

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes/remove', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Apply a gift card to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

application/json

Provide a card_number to apply to the basket.

card_numberstring

Example: "0127 0244 7210 1111"

Response

200

Successful response returns the basket.

Body

application/json

dataBasket (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

Remove a gift card from the basket.

Removes a gift card from the basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

application/json

Provide the card_number to remove from the basket.

card_numberstring

Example: "0127 0244 7210 1111"

Response

200422

Gift card removed successfully.

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards/remove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Apply a coupon to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

application/json

Provide a coupon_code to apply to the basket.

coupon_codestring

Example: "Academy10"

Response

200

Successful response returns the basket.

Body

application/json

dataBasket (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

Remove a coupon from the basket.

Removes a coupon code from a basket

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

200422

Successful response.

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons/remove', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Checkout

When the user is ready to checkout, fetch the basket and direct the user to the links.checkout URL.

Fetch a basket from a webstore by its identifier

Gets a basket associated with the provided identifier.

GEThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

200

Successful response returns the basket information.

Body

application/json

dataBasket (object)

Request

JavaScriptCurlPython

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

Starter Template

To get started with your own integration of the Headless API you're able to use our example integration built upon Nuxt.js, Vue & Typescript. Take a look at the tebexio/Headless-Template GitHub repo to begin.

Examples

The following websites are built using the Headless API - hosted via our customers own infrastructure, using frontend frameworks such as Vue or React.

MCC Island

https://store.mccisland.net

Power Scripts

https://power-scripts.com