Endpoints

Webstores

Fetch a webstore by its identifier

Gets the webstore associated with the provided identifier.

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

Path parameters

token*string

The webstore identifier.

Example: "some-uuid"

Response

200

Successful response returns the webstore's information.

Body

application/json

dataobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": {
    "schema": {
      "id": 1,
      "description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris fermentum eget tellus et cursus. Pellentesque vel vehicula velit, sit amet tincidunt diam. Aliquam sit amet fermentum lorem.</p>",
      "name": "Minecraft Store",
      "webstore_url": "https://example.tebex.io",
      "currency": "USD",
      "lang": "en",
      "logo": "https://example.com",
      "platform_type": "Minecraft: Java Edition",
      "platform_type_id": "minecraft",
      "created_at": "2023-05-25T09:49:37+00:00"
    }
  }
}

Fetch the custom pages associated with the store.

Gets a list of custom pages associated with the webstore. These contain a content variable with the HTML content of the page.

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

Path parameters

token*string

The webstore identifier.

Example: "some-uuid"

Response

200

Successful response returns the webstore's pages.

Body

application/json

dataarray of CMSPage (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "id": 127,
      "created_at": "2023-11-13T20:59:54.000000Z",
      "updated_at": "2023-11-13T20:59:54.000000Z",
      "account_id": 244,
      "title": "About",
      "slug": "about",
      "private": false,
      "hidden": false,
      "disabled": false,
      "sequence": false,
      "content": "<p>This is a custom page which you can add your own content to if you wish.</p>\n\n<p>You can modify your pages by going to <strong>Webstore</strong> &gt; <strong>Pages</strong> from within the\nTebex Store control panel.</p>\n\n<p>Make sure to take a look at our <a href=\"https://help.tebex.io\" rel=\"noreferrer\" target=\"_blank\">knowledgebase</a>\nfor helpful guides on getting started.</p>"
    }
  ]
}

Baskets

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"
    }
  }
}

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/"
  }
]

Categories

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"
    }
  ]
}

Package

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"
    }
  ]
}

Fetch a package from a webstore by its identifier

Gets all packages from a webstore.

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

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

ipAddress*string

An IP address can be provided with authenticated requests.

Example: "127.0.0.1"

Response

200422

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?ipAddress={ipAddress}', {
    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 a package from a webstore by its identifier

Gets all packages from a webstore.

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

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

200422

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?basketIdent={basketIdent}', {
    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 a package from a webstore by its identifier

Gets all packages from a webstore.

GEThttps://headless.tebex.io/api/accounts/{token}/packages?ipAddress={ipAddress}&basketIdent={basketIdent}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

ipAddress*string

An IP address can be provided with authenticated requests.

Example: "127.0.0.1"

Response

200422

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?ipAddress={ipAddress}&basketIdent={basketIdent}', {
    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"
    }
  ]
}

Creator Codes

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();

Gift Cards

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();

Coupons

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();

Adding / Removing Packages

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"
  }
}

Updating Quantities

Updates the quantity of the given package in the basket. The user must be logged in before the quantity can be changed.

Sets the quantity of the given item in the basket.

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

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

packageId*number

The package identifier.

Example: 6276316

Body

application/json

quantitynumber

Example: 1

Response

200422

Successful response.

Request

JavaScriptCurlPython

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